safing-portmaster/updates/helper/indexes.go

package helper

import (
	"github.com/safing/portbase/updater"
)

const (
	ReleaseChannelKey     = "core/releaseChannel"
	ReleaseChannelJSONKey = "core.releaseChannel"
	ReleaseChannelStable  = "stable"
	ReleaseChannelBeta    = "beta"
	ReleaseChannelStaging = "staging"
	ReleaseChannelSupport = "support"
)

// SetIndexes sets the update registry indexes and also configures the registry
// to use pre-releases based on the channel.
func SetIndexes(registry *updater.ResourceRegistry, releaseChannel string) {
	usePreReleases := false

	// Be reminded that the order is important, as indexes added later will
	// override the current release from earlier indexes.

	// Reset indexes before adding them (again).
	registry.ResetIndexes()

	// Always add the stable index as a base.
	registry.AddIndex(updater.Index{
		Path: ReleaseChannelStable + ".json",
	})

	// Add beta index if in beta or staging channel.
	if releaseChannel == ReleaseChannelBeta ||
		releaseChannel == ReleaseChannelStaging {
		registry.AddIndex(updater.Index{
			Path:       ReleaseChannelBeta + ".json",
			PreRelease: true,
		})
		usePreReleases = true
	}

	// Add staging index if in staging channel.
	if releaseChannel == ReleaseChannelStaging {
		registry.AddIndex(updater.Index{
			Path:       ReleaseChannelStaging + ".json",
			PreRelease: true,
		})
		usePreReleases = true
	}

	// Add support index if in support channel.
	if releaseChannel == ReleaseChannelSupport {
		registry.AddIndex(updater.Index{
			Path: ReleaseChannelSupport + ".json",
		})
	}

	// Add the intel index last, as it updates the fastest and should not be
	// crippled by other faulty indexes. It can only specify versions for its
	// scope anyway.
	registry.AddIndex(updater.Index{
		Path: "all/intel/intel.json",
	})

	// Set pre-release usage.
	registry.SetUsePreReleases(usePreReleases)
}