git real time (#18323)

Author: akosyakov

components/common-go/experiments/flags.go

@@ -28,3 +28,10 @@ func SupervisorPersistServerAPIChannelWhenStart(ctx context.Context, client Clie
 func SupervisorUsePublicAPI(ctx context.Context, client Client, attributes Attributes) bool {
 	return client.GetBoolValue(ctx, SupervisorUsePublicAPIFlag, false, attributes)
 }
+
+func SupervisorLiveGitStatus(ctx context.Context, client Client, attributes Attributes) bool {
+	if client == nil {
+		return false
+	}
+	return client.GetBoolValue(ctx, "supervisor_live_git_status", false, attributes)
+}

components/dashboard/src/components/PendingChangesDropdown.tsx

@@ -4,12 +4,19 @@
  * See License.AGPL.txt in the project root for license information.
  */
 
-import { WorkspaceInstance } from "@gitpod/gitpod-protocol";
+import { WorkspaceInstance, WorkspaceInstanceRepoStatus } from "@gitpod/gitpod-protocol";
 import ContextMenu, { ContextMenuEntry } from "./ContextMenu";
 import CaretDown from "../icons/CaretDown.svg";
+import { useFeatureFlag } from "../data/featureflag-query";
 
 export default function PendingChangesDropdown(props: { workspaceInstance?: WorkspaceInstance }) {
-    const repo = props.workspaceInstance?.status?.repo;
+    const liveGitStatus = useFeatureFlag("supervisor_live_git_status");
+    let repo: WorkspaceInstanceRepoStatus | undefined;
+    if (liveGitStatus) {
+        repo = props.workspaceInstance?.gitStatus;
+    } else {
+        repo = props.workspaceInstance?.status?.repo;
+    }
     const headingStyle = "text-gray-500 dark:text-gray-400 text-left";
     const itemStyle = "text-gray-400 dark:text-gray-500 text-left -mt-5";
     const menuEntries: ContextMenuEntry[] = [];

components/dashboard/src/data/featureflag-query.ts

@@ -26,6 +26,7 @@ const featureFlags = {
     doRetryUserLoader: true,
     // Local SSH feature of VS Code Desktop Extension
     gitpod_desktop_use_local_ssh_proxy: false,
+    supervisor_live_git_status: false,
 };
 
 export const useFeatureFlag = (featureFlag: keyof typeof featureFlags) => {

components/dashboard/src/workspaces/WorkspaceEntry.tsx

@@ -4,7 +4,13 @@
  * See License.AGPL.txt in the project root for license information.
  */
 
-import { CommitContext, Workspace, WorkspaceInfo, ContextURL } from "@gitpod/gitpod-protocol";
+import {
+    CommitContext,
+    Workspace,
+    WorkspaceInfo,
+    ContextURL,
+    WorkspaceInstanceRepoStatus,
+} from "@gitpod/gitpod-protocol";
 import { GitpodHostUrl } from "@gitpod/gitpod-protocol/lib/util/gitpod-host-url";
 import { FunctionComponent, useMemo, useState } from "react";
 import { Item, ItemField, ItemFieldIcon } from "../components/ItemsList";
@@ -13,6 +19,7 @@ import Tooltip from "../components/Tooltip";
 import dayjs from "dayjs";
 import { WorkspaceEntryOverflowMenu } from "./WorkspaceOverflowMenu";
 import { WorkspaceStatusIndicator } from "./WorkspaceStatusIndicator";
+import { useFeatureFlag } from "../data/featureflag-query";
 
 type Props = {
     info: WorkspaceInfo;
@@ -22,9 +29,16 @@ type Props = {
 export const WorkspaceEntry: FunctionComponent<Props> = ({ info, shortVersion }) => {
     const [menuActive, setMenuActive] = useState(false);
 
+    const liveGitStatus = useFeatureFlag("supervisor_live_git_status");
+    let repo: WorkspaceInstanceRepoStatus | undefined;
+    if (liveGitStatus) {
+        repo = info.latestInstance?.gitStatus;
+    } else {
+        repo = info.latestInstance?.status.repo;
+    }
+
     const workspace = info.workspace;
-    const currentBranch =
-        info.latestInstance?.status.repo?.branch || Workspace.getBranchName(info.workspace) || "<unknown>";
+    const currentBranch = repo?.branch || Workspace.getBranchName(info.workspace) || "<unknown>";
     const project = getProjectPath(workspace);
     const normalizedContextUrl = ContextURL.getNormalizedURL(workspace)?.toString();
     const normalizedContextUrlDescription = normalizedContextUrl || workspace.contextURL; // Instead of showing nothing, we prefer to show the raw content instead

components/gitpod-db/src/typeorm/entity/db-workspace-instance.ts

@@ -12,6 +12,7 @@ import {
     WorkspaceInstancePhase,
     WorkspaceInstanceConfiguration,
     ImageBuildInfo,
+    WorkspaceInstanceRepoStatus,
 } from "@gitpod/gitpod-protocol";
 import { TypeORM } from "../typeorm";
 import { Transformer } from "../transformer";
@@ -76,6 +77,9 @@ export class DBWorkspaceInstance implements WorkspaceInstance {
     @Column("json")
     status: WorkspaceInstanceStatus;
 
+    @Column("simple-json", { nullable: true })
+    gitStatus?: WorkspaceInstanceRepoStatus;
+
     /**
      * This field is a databse-only copy of status.phase for the sole purpose of creating indexes on it.
      * Is replicated inside workspace-db-impl.ts/storeInstance.

components/gitpod-db/src/typeorm/migration/1690915807191-AddGitStatusColumnToWorkspaceInstance.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) 2023 Gitpod GmbH. All rights reserved.
+ * Licensed under the GNU Affero General Public License (AGPL).
+ * See License.AGPL.txt in the project root for license information.
+ */
+
+import { MigrationInterface, QueryRunner } from "typeorm";
+import { columnExists } from "./helper/helper";
+
+export class AddGitStatusColumnToWorkspaceInstance1690915807191 implements MigrationInterface {
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        if (!(await columnExists(queryRunner, "d_b_workspace_instance", "gitStatus"))) {
+            await queryRunner.query("ALTER TABLE d_b_workspace_instance ADD COLUMN `gitStatus` text NULL");
+        }
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {}
+}

components/gitpod-protocol/go/gitpod-service.go

@@ -59,6 +59,7 @@ type APIInterface interface {
 	GetOpenPorts(ctx context.Context, workspaceID string) (res []*WorkspaceInstancePort, err error)
 	OpenPort(ctx context.Context, workspaceID string, port *WorkspaceInstancePort) (res *WorkspaceInstancePort, err error)
 	ClosePort(ctx context.Context, workspaceID string, port float32) (err error)
+	UpdateGitStatus(ctx context.Context, workspaceID string, status *WorkspaceInstanceRepoStatus) (err error)
 	GetWorkspaceEnvVars(ctx context.Context, workspaceID string) (res []*EnvVar, err error)
 	GetEnvVars(ctx context.Context) (res []*EnvVar, err error)
 	SetEnvVar(ctx context.Context, variable *UserEnvVarValue) (err error)
@@ -1019,6 +1020,24 @@ func (gp *APIoverJSONRPC) ClosePort(ctx context.Context, workspaceID string, por
 	return
 }
 
+// UpdateGitStatus calls UpdateGitStatus on the server
+func (gp *APIoverJSONRPC) UpdateGitStatus(ctx context.Context, workspaceID string, status *WorkspaceInstanceRepoStatus) (err error) {
+	if gp == nil {
+		err = errNotConnected
+		return
+	}
+	var _params []interface{}
+	_params = append(_params, workspaceID)
+	_params = append(_params, status)
+
+	err = gp.C.Call(ctx, "updateGitStatus", _params, nil)
+	if err != nil {
+		return
+	}
+
+	return
+}
+
 // GetWorkspaceEnvVars calls GetWorkspaceEnvVars on the server
 func (gp *APIoverJSONRPC) GetWorkspaceEnvVars(ctx context.Context, workspaceID string) (res []*EnvVar, err error) {
 	if gp == nil {
@@ -1707,6 +1726,7 @@ type WorkspaceInstance struct {
 	Region         string                          `json:"region,omitempty"`
 	StartedTime    string                          `json:"startedTime,omitempty"`
 	Status         *WorkspaceInstanceStatus        `json:"status,omitempty"`
+	GitStatus      *WorkspaceInstanceRepoStatus    `json:"gitStatus,omitempty"`
 	StoppedTime    string                          `json:"stoppedTime,omitempty"`
 	WorkspaceID    string                          `json:"workspaceId,omitempty"`
 	WorkspaceImage string                          `json:"workspaceImage,omitempty"`

components/gitpod-protocol/go/mock.go

@@ -46,7 +46,12 @@ import {
 import { JsonRpcProxy, JsonRpcServer } from "./messaging/proxy-factory";
 import { Disposable, CancellationTokenSource } from "vscode-jsonrpc";
 import { HeadlessLogUrls } from "./headless-workspace-log";
-import { WorkspaceInstance, WorkspaceInstancePort, WorkspaceInstancePhase } from "./workspace-instance";
+import {
+    WorkspaceInstance,
+    WorkspaceInstancePort,
+    WorkspaceInstancePhase,
+    WorkspaceInstanceRepoStatus,
+} from "./workspace-instance";
 import { AdminServer } from "./admin-protocol";
 import { GitpodHostUrl } from "./util/gitpod-host-url";
 import { WebSocketConnectionProvider } from "./messaging/browser/connection";
@@ -131,6 +136,8 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     openPort(workspaceId: string, port: WorkspaceInstancePort): Promise<WorkspaceInstancePort | undefined>;
     closePort(workspaceId: string, port: number): Promise<void>;
 
+    updateGitStatus(workspaceId: string, status: Required<WorkspaceInstanceRepoStatus> | undefined): Promise<void>;
+
     // Workspace env vars
     getWorkspaceEnvVars(workspaceId: string): Promise<EnvVarWithValue[]>;
 

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

@@ -44,6 +44,9 @@ export interface WorkspaceInstance {
     // status is the latest status of the instance that we're aware of
     status: WorkspaceInstanceStatus;
 
+    // repo contains information about the Git working copy inside the workspace
+    gitStatus?: WorkspaceInstanceRepoStatus;
+
     // configuration captures the per-instance configuration variance of a workspace
     // Beware: this field was added retroactively and not all instances have valid
     //         values here.
@@ -89,7 +92,12 @@ export interface WorkspaceInstanceStatus {
     // exposedPorts is the list of currently exposed ports
     exposedPorts?: WorkspaceInstancePort[];
 
-    // repo contains information about the Git working copy inside the workspace
+    /**
+     * repo contains information about the Git working copy inside the workspace
+     * @deprecated use WorkspaceInstance.gitStatus instead if supervisor_live_git_status feature flag is enabled
+     *
+     * TODO(ak) remove after migration to live git status
+     */
     repo?: WorkspaceInstanceRepoStatus;
 
     // timeout is a non-default timeout value configured for a workspace
@@ -229,6 +237,42 @@ export interface WorkspaceInstanceRepoStatus {
     // the total number of unpushed changes
     totalUnpushedCommits?: number;
 }
+export namespace WorkspaceInstanceRepoStatus {
+    export function equals(
+        a: WorkspaceInstanceRepoStatus | undefined,
+        b: WorkspaceInstanceRepoStatus | undefined,
+    ): boolean {
+        if (!a && !b) {
+            return true;
+        }
+        if (!a || !b) {
+            return false;
+        }
+        return (
+            a.branch === b.branch &&
+            a.latestCommit === b.latestCommit &&
+            a.totalUncommitedFiles === b.totalUncommitedFiles &&
+            a.totalUnpushedCommits === b.totalUnpushedCommits &&
+            a.totalUntrackedFiles === b.totalUntrackedFiles &&
+            stringArrayEquals(a.uncommitedFiles, b.uncommitedFiles) &&
+            stringArrayEquals(a.untrackedFiles, b.untrackedFiles) &&
+            stringArrayEquals(a.unpushedCommits, b.unpushedCommits)
+        );
+    }
+    function stringArrayEquals(a: string[] | undefined, b: string[] | undefined): boolean {
+        if (a === undefined && b === undefined) return true;
+
+        if (a === undefined || b === undefined) return false;
+
+        if (a.length !== b.length) return false;
+
+        for (let i = 0; i < a.length; i++) {
+            if (a[i] !== b[i]) return false;
+        }
+
+        return true;
+    }
+}
 
 // ConfigurationIdeConfig ide config of WorkspaceInstanceConfiguration
 export interface ConfigurationIdeConfig {