wip useAuthenticatedUser

Author: AlexTugarev

components/dashboard/src/data/current-user/authenticated-user-query.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 { userClient } from "../../service/public-api";
+import { GetAuthenticatedUserRequest, User } from "@gitpod/public-api/lib/gitpod/v1/user_pb";
+
+export const useAuthenticatedUser = () => {
+    const query = useQuery<User>({
+        queryKey: getAuthenticatedUserQueryKey(),
+        queryFn: async () => {
+            const params = new GetAuthenticatedUserRequest();
+            const response = await userClient.getAuthenticatedUser(params);
+            return response.user!;
+        },
+    });
+    return query;
+};
+
+export const getAuthenticatedUserQueryKey = () => ["authenticated-user", {}];

components/dashboard/src/data/setup.tsx

@@ -26,11 +26,12 @@ import * as EnvVarClasses from "@gitpod/public-api/lib/gitpod/v1/envvar_pb";
 import * as PrebuildClasses from "@gitpod/public-api/lib/gitpod/v1/prebuild_pb";
 import * as SCMClasses from "@gitpod/public-api/lib/gitpod/v1/scm_pb";
 import * as SSHClasses from "@gitpod/public-api/lib/gitpod/v1/ssh_pb";
+import * as UserClasses from "@gitpod/public-api/lib/gitpod/v1/user_pb";
 
 // This is used to version the cache
 // If data we cache changes in a non-backwards compatible way, increment this version
 // That will bust any previous cache versions a client may have stored
-const CACHE_VERSION = "8";
+const CACHE_VERSION = "9";
 
 export function noPersistence(queryKey: QueryKey): QueryKey {
     return [...queryKey, "no-persistence"];
@@ -154,6 +155,7 @@ function initializeMessages() {
         ...Object.values(PrebuildClasses),
         ...Object.values(SCMClasses),
         ...Object.values(SSHClasses),
+        ...Object.values(UserClasses),
     ];
     for (const c of constr) {
         if ((c as any).prototype instanceof Message) {

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

@@ -0,0 +1,24 @@
+/**
+ * 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 { UserService } from "@gitpod/public-api/lib/gitpod/v1/user_connect";
+
+import { PromiseClient } from "@connectrpc/connect";
+import { PartialMessage } from "@bufbuild/protobuf";
+import { GetAuthenticatedUserRequest, GetAuthenticatedUserResponse } from "@gitpod/public-api/lib/gitpod/v1/user_pb";
+import { getGitpodService } from "./service";
+import { converter } from "./public-api";
+
+export class JsonRpcUserClient implements PromiseClient<typeof UserService> {
+    async getAuthenticatedUser(
+        request: PartialMessage<GetAuthenticatedUserRequest>,
+    ): Promise<GetAuthenticatedUserResponse> {
+        const user = await getGitpodService().server.getLoggedInUser();
+        return new GetAuthenticatedUserResponse({
+            user: converter.toUser(user),
+        });
+    }
+}

components/dashboard/src/service/public-api.ts

@@ -35,7 +35,9 @@ import { ApplicationError, ErrorCodes } from "@gitpod/gitpod-protocol/lib/messag
 import { JsonRpcScmClient } from "./json-rpc-scm-client";
 import { SCMService } from "@gitpod/public-api/lib/gitpod/v1/scm_connect";
 import { SSHService } from "@gitpod/public-api/lib/gitpod/v1/ssh_connect";
+import { UserService } from "@gitpod/public-api/lib/gitpod/v1/user_connect";
 import { JsonRpcSSHClient } from "./json-rpc-ssh-client";
+import { JsonRpcUserClient } from "./json-rpc-user-client";
 
 const transport = createConnectTransport({
     baseUrl: `${window.location.protocol}//${window.location.host}/public-api`,
@@ -67,6 +69,8 @@ export const authProviderClient = createServiceClient(AuthProviderService, new J
 
 export const scmClient = createServiceClient(SCMService, new JsonRpcScmClient());
 
+export const userClient = createServiceClient(UserService, new JsonRpcUserClient());
+
 export const envVarClient = createServiceClient(EnvironmentVariableService, new JsonRpcEnvvarClient());
 
 export const sshClient = createServiceClient(SSHService, new JsonRpcSSHClient());

components/gitpod-protocol/src/protocol.ts

@@ -278,7 +278,7 @@ export interface AdditionalUserData extends Partial<WorkspaceTimeoutSetting> {
     workspaceAutostartOptions?: WorkspaceAutostartOption[];
 }
 
-interface WorkspaceAutostartOption {
+export interface WorkspaceAutostartOption {
     cloneURL: string;
     organizationId: string;
     workspaceClass?: string;

components/gitpod-protocol/src/public-api-converter.ts

@@ -4,7 +4,7 @@
  * See License.AGPL.txt in the project root for license information.
  */
 
-import { Timestamp, toPlainMessage } from "@bufbuild/protobuf";
+import { Timestamp, toPlainMessage, Duration } from "@bufbuild/protobuf";
 import { Code, ConnectError } from "@connectrpc/connect";
 import {
     FailedPreconditionDetails,
@@ -25,6 +25,15 @@ import {
     AuthProviderType,
     OAuth2Config,
 } from "@gitpod/public-api/lib/gitpod/v1/authprovider_pb";
+import {
+    Identity,
+    User,
+    User_EmailNotificationSettings,
+    User_RoleOrPermission,
+    User_UserFeatureFlag,
+    User_WorkspaceAutostartOption,
+    User_WorkspaceTimeoutSettings,
+} from "@gitpod/public-api/lib/gitpod/v1/user_pb";
 import {
     BranchMatchingStrategy,
     Configuration,
@@ -73,6 +82,8 @@ import {
     UnauthorizedRepositoryAccessError,
 } from "./messaging/error";
 import {
+    User as UserProtocol,
+    Identity as IdentityProtocol,
     AuthProviderEntry as AuthProviderProtocol,
     AuthProviderInfo,
     CommitContext,
@@ -89,6 +100,9 @@ import {
     Token,
     SuggestedRepository as SuggestedRepositoryProtocol,
     UserSSHPublicKeyValue,
+    NamedWorkspaceFeatureFlag,
+    WorkspaceAutostartOption,
+    IDESettings,
 } from "./protocol";
 import {
     OrgMemberInfo,
@@ -109,6 +123,8 @@ import {
 } from "./workspace-instance";
 import { Author, Commit } from "@gitpod/public-api/lib/gitpod/v1/scm_pb";
 import type { DeepPartial } from "./util/deep-partial";
+import { RoleOrPermission } from "./permission";
+import { parseGoDurationToMs } from "./util/timeutil";
 
 export type PartialConfiguration = DeepPartial<Configuration> & Pick<Configuration, "id">;
 
@@ -910,4 +926,151 @@ export class PublicAPIConverter {
         result.lastUsedTime = Timestamp.fromDate(new Date(sshKey.lastUsedTime || sshKey.creationTime));
         return result;
     }
+
+    toUser(from: UserProtocol): User {
+        const {
+            id,
+            name,
+            creationDate,
+            identities,
+            additionalData,
+            avatarUrl,
+            featureFlags,
+            organizationId,
+            rolesOrPermissions,
+            usageAttributionId,
+            blocked,
+            lastVerificationTime,
+            verificationPhoneNumber,
+        } = from;
+        const {
+            disabledClosedTimeout,
+            dotfileRepo,
+            emailNotificationSettings,
+            ideSettings,
+            profile,
+            workspaceAutostartOptions,
+            workspaceClasses,
+            workspaceTimeout,
+        } = additionalData || {};
+
+        return new User({
+            id,
+            name,
+            createdAt: this.toTimestamp(creationDate),
+            avatarUrl,
+            organizationId,
+            usageAttributionId,
+            blocked,
+            identities: identities?.map((i) => this.toIdentity(i)),
+            rolesOrPermissions: rolesOrPermissions?.map((rp) => this.toRoleOrPermission(rp)),
+            workspaceFeatureFlags: featureFlags?.permanentWSFeatureFlags?.map((ff) => this.toUserFeatureFlags(ff)),
+            workspaceTimeoutSettings: new User_WorkspaceTimeoutSettings({
+                inactivity: this.toDuration(workspaceTimeout),
+                disabledDisconnected: disabledClosedTimeout,
+            }),
+            dotfileRepo,
+            emailNotificationSettings: new User_EmailNotificationSettings({
+                allowsChangelogMail: emailNotificationSettings?.allowsChangelogMail,
+                allowsDevxMail: emailNotificationSettings?.allowsDevXMail,
+                allowsOnboardingMail: emailNotificationSettings?.allowsOnboardingMail,
+            }),
+            editorSettings: this.toEditorReference(ideSettings),
+            lastVerificationTime: this.toTimestamp(lastVerificationTime),
+            verificationPhoneNumber,
+            workspaceClass: workspaceClasses?.regular,
+            workspaceAutostartOptions: workspaceAutostartOptions?.map((o) => this.toWorkspaceAutostartOption(o)),
+            profile,
+        });
+    }
+
+    toDuration(from?: string): Duration | undefined {
+        if (!from) {
+            return undefined;
+        }
+        const millis = parseGoDurationToMs(from);
+        const seconds = BigInt(Math.floor(millis / 1000));
+        const nanos = (millis % 1000) * 1000000;
+        return new Duration({
+            seconds,
+            nanos,
+        });
+    }
+
+    toTimestamp(from?: string | undefined): Timestamp | undefined {
+        return from ? Timestamp.fromDate(new Date(from)) : undefined;
+    }
+
+    toIdentity(from: IdentityProtocol): Identity {
+        const { authId, authName, authProviderId, lastSigninTime, primaryEmail } = from;
+        return new Identity({
+            authProviderId,
+            authId,
+            authName,
+            lastSigninTime: this.toTimestamp(lastSigninTime),
+            primaryEmail,
+        });
+    }
+
+    toRoleOrPermission(from: RoleOrPermission): User_RoleOrPermission {
+        switch (from) {
+            case "admin":
+                return User_RoleOrPermission.ADMIN;
+            case "devops":
+                return User_RoleOrPermission.DEVOPS;
+            case "viewer":
+                return User_RoleOrPermission.VIEWER;
+            case "developer":
+                return User_RoleOrPermission.DEVELOPER;
+            case "registry-access":
+                return User_RoleOrPermission.REGISTRY_ACCESS;
+            case "admin-permissions":
+                return User_RoleOrPermission.ADMIN_PERMISSIONS;
+            case "admin-users":
+                return User_RoleOrPermission.ADMIN_USERS;
+            case "admin-workspace-content":
+                return User_RoleOrPermission.ADMIN_WORKSPACE_CONTENT;
+            case "admin-workspaces":
+                return User_RoleOrPermission.ADMIN_WORKSPACES;
+            case "admin-projects":
+                return User_RoleOrPermission.ADMIN_PROJECTS;
+            case "new-workspace-cluster":
+                return User_RoleOrPermission.NEW_WORKSPACE_CLUSTER;
+        }
+        return User_RoleOrPermission.UNSPECIFIED;
+    }
+
+    toUserFeatureFlags(from: NamedWorkspaceFeatureFlag): User_UserFeatureFlag {
+        switch (from) {
+            case "full_workspace_backup":
+                return User_UserFeatureFlag.FULL_WORKSPACE_BACKUP;
+            case "workspace_class_limiting":
+                return User_UserFeatureFlag.WORKSPACE_CLASS_LIMITING;
+            case "workspace_connection_limiting":
+                return User_UserFeatureFlag.WORKSPACE_CONNECTION_LIMITING;
+            case "workspace_psi":
+                return User_UserFeatureFlag.WORKSPACE_PSI;
+        }
+        return User_UserFeatureFlag.UNSPECIFIED;
+    }
+
+    toEditorReference(from?: IDESettings): EditorReference | undefined {
+        if (!from) {
+            return undefined;
+        }
+        return new EditorReference({
+            name: from.defaultIde,
+            version: from.useLatestVersion ? "latest" : "stable",
+        });
+    }
+
+    toWorkspaceAutostartOption(from: WorkspaceAutostartOption): User_WorkspaceAutostartOption {
+        return new User_WorkspaceAutostartOption({
+            cloneUrl: from.cloneURL,
+            editorSettings: this.toEditorReference(from.ideSettings),
+            organizationId: from.organizationId,
+            region: from.region,
+            workspaceClass: from.workspaceClass,
+        });
+    }
 }