address pr feedback

Author: mafredri

README.md

@@ -388,5 +388,6 @@ On MacOS or Windows systems, we recommend either using a VM or the provided `.de
 | `--coder-agent-subsystem` | `CODER_AGENT_SUBSYSTEM` |  | Coder agent subsystems to report when forwarding logs. The envbuilder subsystem is always included. |
 | `--push-image` | `ENVBUILDER_PUSH_IMAGE` |  | Push the built image to a remote registry. This option forces a reproducible build. |
 | `--get-cached-image` | `ENVBUILDER_GET_CACHED_IMAGE` |  | Print the digest of the cached image, if available. Exits with an error if not found. |
+| `--remote-repo-build-mode` | `ENVBUILDER_REMOTE_REPO_BUILD_MODE` | `false` | Use the remote repository as the source of truth when building the image. This means that the users changes to the local files that have been cloned will not be reflected in the image. This is useful as a way to improve cache utilization (get cached image). |
 | `--verbose` | `ENVBUILDER_VERBOSE` |  | Enable verbose logging. |
 <!--- END docsgen --->

envbuilder.go

@@ -130,22 +130,16 @@ func Run(ctx context.Context, opts options.Options) error {
 			opts.Logger(log.LevelError, "Falling back to the default image...")
 		}
 
-		// The repo wasn't cloned (i.e. may not be up-to-date with remote), so
-		// we need to clone it to get the right build context. This is only
-		// necessary when the repo is in remote build mode. If the repo is in
-		// local build mode, the build context is already available on the host
-		// filesystem.
-		//
-		// Skipping clone here if we believe workspace repo matches remote repo
-		// is a performance optimization.
-		if fallbackErr == nil && !cloned && opts.RepoBuildMode == options.RepoBuildModeRemote {
+		// Always clone the repo in remote repo build mode into a location that
+		// we control that isn't affected by the users changes.
+		if opts.RemoteRepoBuildMode {
 			cloneOpts, err := git.CloneOptionsFromOptions(opts)
 			if err != nil {
 				return fmt.Errorf("git clone options: %w", err)
 			}
 			cloneOpts.Path = constants.MagicRemoteRepoDir
 
-			endStage := startStage("📦 Remote build mode enabled, cloning %s to %s for build context...",
+			endStage := startStage("📦 Remote repo build mode enabled, cloning %s to %s for build context...",
 				newColor(color.FgCyan).Sprintf(opts.GitURL),
 				newColor(color.FgCyan).Sprintf(cloneOpts.Path),
 			)
@@ -895,22 +889,16 @@ func RunCacheProbe(ctx context.Context, opts options.Options) (v1.Image, error)
 			opts.Logger(log.LevelError, "Falling back to the default image...")
 		}
 
-		// The repo wasn't cloned (i.e. may not be up-to-date with remote), so
-		// we need to clone it to get the right build context. This is only
-		// necessary when the repo is in remote build mode. If the repo is in
-		// local build mode, the build context is already available on the host
-		// filesystem.
-		//
-		// Skipping clone here if we believe workspace repo matches remote repo
-		// is a performance optimization.
-		if opts.RepoBuildMode == options.RepoBuildModeRemote {
+		// Always clone the repo in remote repo build mode into a location that
+		// we control that isn't affected by the users changes.
+		if opts.RemoteRepoBuildMode {
 			cloneOpts, err := git.CloneOptionsFromOptions(opts)
 			if err != nil {
 				return nil, fmt.Errorf("git clone options: %w", err)
 			}
 			cloneOpts.Path = constants.MagicRemoteRepoDir
 
-			endStage := startStage("📦 Remote build mode enabled, cloning %s to %s for build context...",
+			endStage := startStage("📦 Remote repo build mode enabled, cloning %s to %s for build context...",
 				newColor(color.FgCyan).Sprintf(opts.GitURL),
 				newColor(color.FgCyan).Sprintf(cloneOpts.Path),
 			)

options/options.go

@@ -150,23 +150,15 @@ type Options struct {
 	// and if it is, to return it.
 	GetCachedImage bool
 
-	// RepoBuildMode is the mode to use when building the workspace from a
-	// repository. When set to `local`, the repository is cloned locally and
-	// built. If the repository is already present, it is used as the source of
-	// truth. When set to `remote`, the repository is cloned into a temporary
-	// directory and built. This is useful when the repository should act as the
-	// source of truth. Defaults to "local".
-	RepoBuildMode string
+	// RemoteRepoBuildMode uses the remote repository as the source of truth
+	// when building the image. This means that the users changes to the local
+	// files that have been cloned will not be reflected in the image. This is
+	// useful as a way to improve cache utilization (get cached image).
+	RemoteRepoBuildMode bool
 }
 
 const envPrefix = "ENVBUILDER_"
 
-// Available modes for repo build mode.
-const (
-	RepoBuildModeLocal  = "local"
-	RepoBuildModeRemote = "remote"
-)
-
 // Generate CLI options for the envbuilder command.
 func (o *Options) CLI() serpent.OptionSet {
 	options := serpent.OptionSet{
@@ -435,16 +427,15 @@ func (o *Options) CLI() serpent.OptionSet {
 				"Exits with an error if not found.",
 		},
 		{
-			Flag:    "repo-build-mode",
-			Env:     WithEnvPrefix("REPO_BUILD_MODE"),
-			Value:   serpent.EnumOf(&o.RepoBuildMode, RepoBuildModeLocal, RepoBuildModeRemote),
-			Default: RepoBuildModeLocal,
-			Description: "The mode to use when building the workspace from a " +
-				"repository. When set to `local`, the repository is cloned locally " +
-				"and built. If the repository is already present, it is used as the " +
-				"source of truth. When set to `remote`, the repository is cloned into " +
-				"a temporary directory and built. This is useful when the repository " +
-				"should act as the source of truth.",
+			Flag:    "remote-repo-build-mode",
+			Env:     WithEnvPrefix("REMOTE_REPO_BUILD_MODE"),
+			Value:   serpent.BoolOf(&o.RemoteRepoBuildMode),
+			Default: "false",
+			Description: "Use the remote repository as the source of truth " +
+				"when building the image. This means that the users changes to " +
+				"the local files that have been cloned will not be reflected in " +
+				"the image. This is useful as a way to improve cache utilization " +
+				"(get cached image).",
 		},
 		{
 			Flag:        "verbose",

options/testdata/options.golden

@@ -138,13 +138,11 @@ OPTIONS:
           Push the built image to a remote registry. This option forces a
           reproducible build.
 
-      --repo-build-mode local|remote, $ENVBUILDER_REPO_BUILD_MODE (default: local)
-          The mode to use when building the workspace from a repository. When
-          set to `local`, the repository is cloned locally and built. If the
-          repository is already present, it is used as the source of truth. When
-          set to `remote`, the repository is cloned into a temporary directory
-          and built. This is useful when the repository should act as the source
-          of truth.
+      --remote-repo-build-mode bool, $ENVBUILDER_REMOTE_REPO_BUILD_MODE (default: false)
+          Use the remote repository as the source of truth when building the
+          image. This means that the users changes to the local files that have
+          been cloned will not be reflected in the image. This is useful as a
+          way to improve cache utilization (get cached image).
 
       --setup-script string, $ENVBUILDER_SETUP_SCRIPT
           The script to run before the init script. It runs as the root user