Also resolve the source code commit for IDEs in ide-service

Author: filiptronicek

components/gitpod-protocol/src/ide-protocol.ts

@@ -144,4 +144,14 @@ export interface IDEOption {
      * LatestImageVersion the semantic version of the latest IDE image.
      */
     latestImageVersion?: string;
+
+    /**
+     * ImageCommit the source code commit SHA of the IDE image.
+     */
+    imageCommit?: string;
+
+    /**
+     * LatestImageCommit the source code commit SHA of the latest IDE image.
+     */
+    latestImageCommit?: string;
 }

components/ide-service-api/go/config/ideconfig.go

@@ -61,6 +61,10 @@ type IDEOption struct {
 	ImageVersion string `json:"imageVersion,omitempty"`
 	// LatestImageVersion the semantic version of the latest IDE image.
 	LatestImageVersion string `json:"latestImageVersion,omitempty"`
+	// ImageCommit the source code commit SHA of the IDE image.
+	ImageCommit string `json:"imageCommit,omitempty"`
+	// LatestImageCommit the source code commit SHA of the latest IDE image.
+	LatestImageCommit string `json:"latestImageCommit,omitempty"`
 	// ImageLayers for additional ide layers and dependencies
 	ImageLayers []string `json:"imageLayers,omitempty"`
 	// LatestImageLayers for latest additional ide layers and dependencies

components/ide-service/pkg/ocitool/resolve.go

@@ -71,40 +71,44 @@ func interactiveFetchManifestOrIndex(ctx context.Context, res remotes.Resolver,
 	return "", nil, nil
 }
 
-func ResolveIDEVersion(ctx context.Context, ref string) (string, error) {
+func ResolveIDEVersion(ctx context.Context, ref string) (ManifestLabels, error) {
 	newCtx, cancel := context.WithTimeout(ctx, time.Second*30)
 	defer cancel()
 	res := docker.NewResolver(docker.ResolverOptions{})
 
 	name, mf, err := interactiveFetchManifestOrIndex(newCtx, res, ref)
 	if err != nil {
-		return "", err
+		return ManifestLabels{}, err
 	}
 
 	fetcher, err := res.Fetcher(ctx, name)
 	if err != nil {
-		return "", err
+		return ManifestLabels{}, err
 	}
 
 	cfgin, err := fetcher.Fetch(ctx, mf.Config)
 	if err != nil {
-		return "", err
+		return ManifestLabels{}, err
 	}
 	defer cfgin.Close()
 
 	var tmp ManifestJSON
 
 	err = json.NewDecoder(cfgin).Decode(&tmp)
 	if err != nil {
-		return "", nil
+		return ManifestLabels{}, err
 	}
-	return tmp.Config.Labels.Version, nil
+
+	return tmp.Config.Labels, nil
+}
+
+type ManifestLabels struct {
+	Version string  `json:"io.gitpod.ide.version"`
+	Commit  *string `json:"io.gitpod.ide.commit,omitempty"`
 }
 
 type ManifestJSON struct {
 	Config struct {
-		Labels struct {
-			Version string `json:"io.gitpod.ide.version"`
-		} `json:"Labels"`
+		Labels ManifestLabels `json:"Labels"`
 	} `json:"config"`
 }

components/ide-service/pkg/ocitool/resolve_test.go

@@ -43,7 +43,7 @@ func TestResolveIDEVersion(t *testing.T) {
 				t.Errorf("ResolveIDEVersion() error = %v, wantErr %v", err, tt.wantErr)
 				return
 			}
-			if got != tt.want {
+			if got.Version != tt.want {
 				t.Errorf("ResolveIDEVersion() = %v, want %v", got, tt.want)
 			}
 		})

components/ide-service/pkg/server/ideconfig.go

@@ -72,10 +72,13 @@ func ParseConfig(ctx context.Context, b []byte) (*config.IDEConfig, error) {
 				option.Image = resolved
 			}
 		}
-		if resolvedVersion, err := oci_tool.ResolveIDEVersion(ctx, option.Image); err != nil {
+		if resolvedLabels, err := oci_tool.ResolveIDEVersion(ctx, option.Image); err != nil {
 			log.WithError(err).Error("ide config: cannot get version from image")
 		} else {
-			option.ImageVersion = resolvedVersion
+			option.ImageVersion = resolvedLabels.Version
+			if resolvedLabels.Commit != nil {
+				option.ImageCommit = *resolvedLabels.Commit
+			}
 		}
 		if option.LatestImage != "" {
 			if resolved, err := oci_tool.Resolve(ctx, option.LatestImage); err != nil {
@@ -84,10 +87,13 @@ func ParseConfig(ctx context.Context, b []byte) (*config.IDEConfig, error) {
 				log.WithField("ide", id).WithField("image", option.LatestImage).WithField("resolved", resolved).Info("ide config: resolved latest image digest")
 				option.LatestImage = resolved
 			}
-			if resolvedVersion, err := oci_tool.ResolveIDEVersion(ctx, option.LatestImage); err != nil {
+			if resolvedLabels, err := oci_tool.ResolveIDEVersion(ctx, option.LatestImage); err != nil {
 				log.WithError(err).Error("ide config: cannot get version from image")
 			} else {
-				option.LatestImageVersion = resolvedVersion
+				option.LatestImageVersion = resolvedLabels.Version
+				if resolvedLabels.Commit != nil {
+					option.LatestImageCommit = *resolvedLabels.Commit
+				}
 			}
 		}
 		cfg.IdeOptions.Options[id] = option