Function CheckUpdate

pkg/version/remote.go:212–257

CheckUpdate checks whether there is a version update available. If there is no update, or no new version is available, this function returns nil. The function uses cache.

(ctx context.Context, opts ...CheckOption)

// If there is no update, or no new version is available, this function returns nil.
// The function uses cache.
func CheckUpdate(ctx context.Context, opts ...CheckOption) (*Update, error) {
	current, err := semver.Parse(strings.TrimPrefix(TTN, "v"))
	if err != nil {
		return nil, err
	}
	if c, err := cachedCheck(); err == nil {
		if c.Timestamp.Add(versionCheckCacheTTL).After(time.Now()) && c.Result.Current.Compare(current) == 0 {
			return c.Result, nil
		}
	}
	o := &checkOptions{
		client:    http.DefaultClient,
		current:   current,
		sourceURL: TTSVersionCheckURL,
		docsURL:   TTSUpgradingDocsURL,
	}
	for _, opt := range opts {
		opt.apply(o)
	}
	latest, err := latest(ctx, o.client, o.sourceURL)
	if err != nil {
		return nil, err
	}
	var minor, patch bool
	switch {
	case o.current.Minor < latest.Minor:
		minor = true
	case o.current.Minor > latest.Minor:
		return nil, nil
	case o.current.Patch < latest.Patch:
		patch = true
	default:
		return nil, nil
	}
	update := &Update{
		Current: o.current,
		Latest:  latest,
		DocsURL: o.docsURL,
		Minor:   minor,
		Patch:   patch,
	}
	if err = saveCheck(update); err != nil {
		log.FromContext(ctx).WithError(err).Warn("Failed to write version check cache")
	}
	return update, nil
}

// LogUpdate logs an Warn level message when there is a newer minor, and a Log level message when there is a newer patch.
// When there is no new minor or patch version, this function does nothing.