Migrate InstallationService GetInstallationWorkspaceDefaultImage method (#19221)

Author: mustard-mh

components/dashboard/src/data/installation/default-workspace-image-query.ts

@@ -0,0 +1,19 @@
+/**
+ * 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 { useQuery } from "@tanstack/react-query";
+import { installationClient } from "../../service/public-api";
+
+export const useInstallationDefaultWorkspaceImageQuery = () => {
+    return useQuery({
+        queryKey: ["installation-default-workspace-image"],
+        staleTime: 1000 * 60 * 10, // 10 minute
+        queryFn: async () => {
+            const response = await installationClient.getInstallationWorkspaceDefaultImage({});
+            return response.defaultWorkspaceImage;
+        },
+    });
+};

components/dashboard/src/data/workspaces/default-workspace-image-query.ts

@@ -5,22 +5,9 @@
  */
 
 import { useQuery } from "@tanstack/react-query";
-import { getGitpodService } from "../../service/service";
-import { GetDefaultWorkspaceImageResult } from "@gitpod/gitpod-protocol";
 import { GetWorkspaceDefaultImageResponse } from "@gitpod/public-api/lib/gitpod/v1/workspace_pb";
 import { workspaceClient } from "../../service/public-api";
 
-export const useDefaultWorkspaceImageQuery = (workspaceId?: string) => {
-    return useQuery<GetDefaultWorkspaceImageResult>({
-        queryKey: ["default-workspace-image", { workspaceId }],
-        staleTime: 1000 * 60 * 10, // 10 minute
-        queryFn: async () => {
-            // without `workspaceId` getDefaultWorkspaceImage will return org setting and if not set fallback to installation
-            return await getGitpodService().server.getDefaultWorkspaceImage({ workspaceId });
-        },
-    });
-};
-
 export const useWorkspaceDefaultImageQuery = (workspaceId: string) => {
     return useQuery<GetWorkspaceDefaultImageResponse>({
         queryKey: ["default-workspace-image-v2", { workspaceId }],

components/dashboard/src/service/json-rpc-installation-client.ts

@@ -18,13 +18,26 @@ import {
     ListBlockedEmailDomainsResponse,
     CreateBlockedEmailDomainRequest,
     CreateBlockedEmailDomainResponse,
+    GetInstallationWorkspaceDefaultImageRequest,
+    GetInstallationWorkspaceDefaultImageResponse,
 } from "@gitpod/public-api/lib/gitpod/v1/installation_pb";
 import { ApplicationError, ErrorCodes } from "@gitpod/gitpod-protocol/lib/messaging/error";
 import { getGitpodService } from "./service";
 import { converter } from "./public-api";
 import { PaginationResponse } from "@gitpod/public-api/lib/gitpod/v1/pagination_pb";
 
 export class JsonRpcInstallationClient implements PromiseClient<typeof InstallationService> {
+    async getInstallationWorkspaceDefaultImage(
+        _request: PartialMessage<GetInstallationWorkspaceDefaultImageRequest>,
+        _options?: CallOptions,
+    ): Promise<GetInstallationWorkspaceDefaultImageResponse> {
+        const result = await getGitpodService().server.getDefaultWorkspaceImage({});
+        if (result.source !== "installation") {
+            throw new ApplicationError(ErrorCodes.INTERNAL_SERVER_ERROR, "unexpected image source");
+        }
+        return new GetInstallationWorkspaceDefaultImageResponse({ defaultWorkspaceImage: result.image });
+    }
+
     async listBlockedRepositories(
         request: PartialMessage<ListBlockedRepositoriesRequest>,
         _options?: CallOptions | undefined,

components/dashboard/src/teams/TeamSettings.tsx

@@ -19,7 +19,6 @@ import { useOrgSettingsQuery } from "../data/organizations/org-settings-query";
 import { useCurrentOrg, useOrganizationsInvalidator } from "../data/organizations/orgs-query";
 import { useUpdateOrgMutation } from "../data/organizations/update-org-mutation";
 import { useUpdateOrgSettingsMutation } from "../data/organizations/update-org-settings-mutation";
-import { useDefaultWorkspaceImageQuery } from "../data/workspaces/default-workspace-image-query";
 import { useOnBlurError } from "../hooks/use-onblur-error";
 import { ReactComponent as Stack } from "../icons/Stack.svg";
 import { organizationClient } from "../service/public-api";
@@ -28,6 +27,7 @@ import { useCurrentUser } from "../user-context";
 import { OrgSettingsPage } from "./OrgSettingsPage";
 import { ErrorCode } from "@gitpod/gitpod-protocol/lib/messaging/error";
 import { Button } from "@podkit/buttons/Button";
+import { useInstallationDefaultWorkspaceImageQuery } from "../data/installation/default-workspace-image-query";
 
 export default function TeamSettingsPage() {
     const user = useCurrentUser();
@@ -176,7 +176,7 @@ export default function TeamSettingsPage() {
 function OrgSettingsForm(props: { org?: Organization; isOwner: boolean }) {
     const { org, isOwner } = props;
     const { data: settings, isLoading } = useOrgSettingsQuery();
-    const { data: imageInfo } = useDefaultWorkspaceImageQuery();
+    const { data: installationDefaultImage } = useInstallationDefaultWorkspaceImageQuery();
     const updateTeamSettings = useUpdateOrgSettingsMutation();
 
     const [showImageEditModal, setShowImageEditModal] = useState(false);
@@ -238,14 +238,14 @@ function OrgSettingsForm(props: { org?: Organization; isOwner: boolean }) {
             <WorkspaceImageButton
                 disabled={!isOwner}
                 settings={settings}
-                defaultWorkspaceImage={imageInfo?.image}
+                installationDefaultWorkspaceImage={installationDefaultImage}
                 onClick={() => setShowImageEditModal(true)}
             />
 
             {showImageEditModal && (
                 <OrgDefaultWorkspaceImageModal
                     settings={settings}
-                    globalDefaultImage={imageInfo?.image}
+                    installationDefaultWorkspaceImage={installationDefaultImage}
                     onClose={() => setShowImageEditModal(false)}
                 />
             )}
@@ -255,7 +255,7 @@ function OrgSettingsForm(props: { org?: Organization; isOwner: boolean }) {
 
 function WorkspaceImageButton(props: {
     settings?: OrganizationSettings;
-    defaultWorkspaceImage?: string;
+    installationDefaultWorkspaceImage?: string;
     onClick: () => void;
     disabled?: boolean;
 }) {
@@ -282,7 +282,7 @@ function WorkspaceImageButton(props: {
         };
     }
 
-    const image = props.settings?.defaultWorkspaceImage || props.defaultWorkspaceImage || "";
+    const image = props.settings?.defaultWorkspaceImage || props.installationDefaultWorkspaceImage || "";
 
     const descList = useMemo(() => {
         const arr: ReactNode[] = [<span>Default image</span>];
@@ -335,7 +335,7 @@ function WorkspaceImageButton(props: {
 }
 
 interface OrgDefaultWorkspaceImageModalProps {
-    globalDefaultImage: string | undefined;
+    installationDefaultWorkspaceImage: string | undefined;
     settings: OrganizationSettings | undefined;
     onClose: () => void;
 }
@@ -385,7 +385,7 @@ function OrgDefaultWorkspaceImageModal(props: OrgDefaultWorkspaceImageModalProps
                     <TextInputField
                         label="Default Image"
                         hint="Use any official or custom workspace image from Docker Hub or any private container registry that the Gitpod instance can access."
-                        placeholder={props.globalDefaultImage}
+                        placeholder={props.installationDefaultWorkspaceImage}
                         value={defaultWorkspaceImage}
                         onChange={setDefaultWorkspaceImage}
                     />

components/public-api/gitpod/v1/installation.proto

@@ -9,6 +9,10 @@ import "google/protobuf/timestamp.proto";
 option go_package = "github.com/gitpod-io/gitpod/components/public-api/go/v1";
 
 service InstallationService {
+  // GetInstallationWorkspaceDefaultImage returns the default image for current
+  // Gitpod Installation.
+  rpc GetInstallationWorkspaceDefaultImage(GetInstallationWorkspaceDefaultImageRequest) returns (GetInstallationWorkspaceDefaultImageResponse) {}
+
   // ListBlockedRepositories lists blocked repositories.
   rpc ListBlockedRepositories(ListBlockedRepositoriesRequest) returns (ListBlockedRepositoriesResponse) {}
 
@@ -25,6 +29,12 @@ service InstallationService {
   rpc CreateBlockedEmailDomain(CreateBlockedEmailDomainRequest) returns (CreateBlockedEmailDomainResponse) {}
 }
 
+message GetInstallationWorkspaceDefaultImageRequest {}
+
+message GetInstallationWorkspaceDefaultImageResponse {
+  string default_workspace_image = 1;
+}
+
 message ListBlockedRepositoriesRequest {
   // pagination contains the pagination options for listing blocked repositories
   PaginationRequest pagination = 1;