fix: don't rely on an environment when self updating (#511)

This was a regression I introduced in #507.

Author: alecthomas

.github/workflows/release.yml

@@ -1,9 +1,9 @@
 on:
   push:
     paths-ignore:
-      - 'docs/**'
+      - "docs/**"
     tags:
-      - 'v*'
+      - "v*"
 name: Release
 jobs:
   deployable:
@@ -14,7 +14,7 @@ jobs:
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
       - uses: actions/setup-go@d35c59abb061a4a6fb18e82ac0862c26744d6ab5 # v5
         with:
-          go-version: '^1.16.3'
+          go-version: "^1.16.3"
       - name: Build Hermit
         run: |
           make GOOS=linux GOARCH=amd64 CHANNEL=stable build

Makefile

@@ -23,7 +23,7 @@ test-integration: ## run integration tests
 	./bin/go test -count=1 -tags integration -v ./integration
 
 build: build-binary ## builds binary and gzips it
-	gzip -9 $(BIN)
+	gzip -f9 $(BIN)
 
 build-binary: ## builds binary
 	mkdir -p $(BUILD_DIR)

app/exec_cmd.go

@@ -56,7 +56,7 @@ func (e *execCmd) Run(
 	if err != nil {
 		return errors.WithStack(err)
 	}
-	err = maybeUpdateHermit(l, env, cli.getSelfUpdate(), false)
+	err = maybeUpdateHermit(l, sta, cli.getSelfUpdate(), false)
 	if err != nil {
 		return errors.WithStack(err)
 	}
@@ -103,7 +103,9 @@ func (e *execCmd) Run(
 
 // Upgrade hermit if necessary. We do this to ensure we can read the latest versions of manifests, otherwise they
 // might have configuration that is unavailable in older versions.
-func maybeUpdateHermit(l *ui.UI, env *hermit.Env, selfUpdate bool, force bool) error {
+//
+// If "selfUpdate" is false this will be a no-op under all circumstances.
+func maybeUpdateHermit(l *ui.UI, state *state.State, selfUpdate bool, force bool) error {
 	if !selfUpdate {
 		return nil
 	}
@@ -118,7 +120,7 @@ func maybeUpdateHermit(l *ui.UI, env *hermit.Env, selfUpdate bool, force bool) e
 	}
 
 	l.Tracef("Checking if %s needs to be updated", pkgRef)
-	pkg, err := env.Resolve(l, manifest.ExactSelector(manifest.ParseReference(pkgRef)), false)
+	pkg, err := state.Resolve(l, manifest.ExactSelector(manifest.ParseReference(pkgRef)))
 	if err != nil {
 		return errors.WithStack(err)
 	}
@@ -128,7 +130,7 @@ func maybeUpdateHermit(l *ui.UI, env *hermit.Env, selfUpdate bool, force bool) e
 	} else if pkg.UpdatedAt.IsZero() {
 		pkg.UpdatedAt = time.Now()
 	}
-	err = env.UpdateUsage(pkg)
+	err = state.WritePackageState(pkg)
 	if err != nil {
 		return errors.WithStack(err)
 	}
@@ -137,5 +139,5 @@ func maybeUpdateHermit(l *ui.UI, env *hermit.Env, selfUpdate bool, force bool) e
 		// set the update time to 0 to force an update check
 		pkg.UpdatedAt = time.Time{}
 	}
-	return errors.WithStack(env.EnsureChannelIsUpToDate(l, pkg))
+	return errors.WithStack(state.EnsureChannelIsUpToDate(l, pkg))
 }

app/update_cmd.go

@@ -24,7 +24,7 @@ func (s *updateCmd) Run(l *ui.UI, env *hermit.Env, state *state.State, cli cliIn
 		return errors.WithStack(err)
 	}
 	// Upgrade hermit if necessary
-	err = maybeUpdateHermit(l, env, cli.getSelfUpdate(), true)
+	err = maybeUpdateHermit(l, state, cli.getSelfUpdate(), true)
 	if err != nil {
 		return errors.WithStack(err)
 	}

env.go

@@ -1170,13 +1170,7 @@ func (e *Env) Search(l *ui.UI, pattern string) (manifest.Packages, error) {
 //
 // This should only be called for packages that have already been installed
 func (e *Env) EnsureChannelIsUpToDate(l *ui.UI, pkg *manifest.Package) error {
-	task := l.Task(pkg.Reference.String())
-	if pkg.UpdateInterval == 0 || pkg.UpdatedAt.After(time.Now().Add(-1*pkg.UpdateInterval)) {
-		task.Tracef("No updated required")
-		// No updates needed for this package
-		return nil
-	}
-	return errors.WithStack(e.state.UpgradeChannel(task, pkg))
+	return errors.WithStack(e.state.EnsureChannelIsUpToDate(l, pkg))
 }
 
 // AddSource adds a new source bundle and refreshes the packages from it

state/state.go

@@ -505,6 +505,21 @@ func (s *State) CleanCache(b ui.Logger) error {
 	return os.RemoveAll(s.cacheDir)
 }
 
+// EnsureChannelIsUpToDate updates the package if it has an update interval,
+// the required time since the last update check has passed,
+// and the etag in the source has changed from the last check.
+//
+// This should only be called for packages that have already been installed
+func (s *State) EnsureChannelIsUpToDate(l *ui.UI, pkg *manifest.Package) error {
+	task := l.Task(pkg.Reference.String())
+	if pkg.UpdateInterval == 0 || pkg.UpdatedAt.After(time.Now().Add(-1*pkg.UpdateInterval)) {
+		task.Tracef("No updated required")
+		// No updates needed for this package
+		return nil
+	}
+	return errors.WithStack(s.UpgradeChannel(task, pkg))
+}
+
 // UpgradeChannel checks if the given binary has changed in its channel, and if so, downloads it.
 //
 // If the channel is upgraded this will return a clone of the updated manifest.