Switch to git shallow clone and add unshallow feature

Author: aledbf

components/content-service/pkg/git/git.go

@@ -264,17 +264,13 @@ func (c *Client) Clone(ctx context.Context) (err error) {
 		log.WithError(err).Error()
 	}
 
-	args := make([]string, 0)
-	args = append(args, c.RemoteURI)
+	args := []string{"--depth=1", "--no-single-branch", c.RemoteURI}
 
 	for key, value := range c.Config {
 		args = append(args, "--config")
 		args = append(args, strings.TrimSpace(key)+"="+strings.TrimSpace(value))
 	}
 
-	// TODO(cw): re-introduce this when we have a better story for repo forking
-	// args = append(args, "--filter=blob:none")
-
 	args = append(args, ".")
 
 	return c.Git(ctx, "clone", args...)

components/gitpod-protocol/data/gitpod-schema.json

@@ -210,6 +210,10 @@
         "experimentalNetwork": {
             "type": "boolean",
             "description": "Experimental network configuration in workspaces"
+        },
+        "unshallowAfter": {
+            "type": "string",
+            "description": "Enable git unshallow after the initial load of the workspace"
         }
     },
     "additionalProperties": false

components/gitpod-protocol/src/protocol.ts

@@ -564,6 +564,14 @@ export interface WorkspaceConfig {
     /** tailscale demo */
     experimentalNetwork?: boolean;
 
+    /**
+     * Enable git unshallow after the initial load of the workspace
+     * Valid time units are "s", "m", "h". Example: 30s
+     *
+     * Minimum value: 60s
+     * */
+    unshallowAfter?: string
+
     /**
      * Where the config object originates from.
      *

components/server/src/workspace/workspace-starter.ts

@@ -659,6 +659,13 @@ export class WorkspaceStarter {
             envvars.push(useNetnsVar);
         }
 
+        if (workspace.config.unshallowAfter) {
+            const unshallow = new EnvironmentVariable();
+            unshallow.setName("GIT_UNSHALLOW_AFTER");
+            unshallow.setValue(workspace.config.unshallowAfter);
+            envvars.push(unshallow);
+        }
+
         const createGitpodTokenPromise = (async () => {
             const scopes = this.createDefaultGitpodAPITokenScopes(workspace, instance);
             const token = crypto.randomBytes(30).toString('hex');

components/workspacekit/cmd/rings.go

@@ -546,6 +546,40 @@ var ring1Cmd = &cobra.Command{
 			}
 		}()
 
+		if unshallowAfter := os.Getenv("GIT_UNSHALLOW_AFTER"); unshallowAfter != "" {
+			log := log.WithField("op", "unshallow")
+			log.Info("workspace configured with unshallow feature")
+
+			t, err := time.ParseDuration(unshallowAfter)
+			if err != nil {
+				log.WithError(err).Error("failed to parse GIT_UNSHALLOW_AFTER env variable")
+			} else {
+				// no less than five minutes before running unshallow
+				fiveMinutes := 5 * time.Minute
+				if t < fiveMinutes {
+					t = fiveMinutes
+				}
+
+				go func() {
+					log.Infof("waiting %v before running the unshallow script", t)
+					<-time.After(t)
+
+					start := time.Now()
+					defer func() {
+						log.Infof("unshallow of local repository took %v", time.Since(start))
+					}()
+
+					cmd := exec.Command("/bin/bash", "-c", `if git fetch --help | grep -c -- '--unshallow'; then git fetch --unshallow; else git fetch --depth 1000000000; fi`)
+					cmd.Env = os.Environ()
+					cmd.Dir = os.Getenv("GITPOD_REPO_ROOT")
+					out, err := cmd.CombinedOutput()
+					if err != nil {
+						log.WithError(err).WithField("reason", string(out)).Error("cannot run unshallow")
+					}
+				}()
+			}
+		}
+
 		err = cmd.Wait()
 		if err != nil {
 			if eerr, ok := err.(*exec.ExitError); ok {