move getPrimaryEmail to common and clean up

Author: AlexTugarev

components/dashboard/src/admin/UserSearch.tsx

@@ -16,6 +16,7 @@ import { AdminPageHeader } from "./AdminPageHeader";
 import UserDetail from "./UserDetail";
 import searchIcon from "../icons/search.svg";
 import Tooltip from "../components/Tooltip";
+import { getPrimaryEmail } from "@gitpod/public-api-common/lib/user-utils";
 
 export default function UserSearch() {
     const location = useLocation();
@@ -129,7 +130,7 @@ function UserEntry(p: { user: User }) {
     if (!p) {
         return <></>;
     }
-    const email = User.getPrimaryEmail(p.user) || "---";
+    const email = getPrimaryEmail(p.user) || "---";
     return (
         <Link key={p.user.id} to={"/admin/users/" + p.user.id} data-analytics='{"button_type":"sidebar_menu"}'>
             <div className="rounded-xl whitespace-nowrap flex space-x-2 py-6 px-6 w-full justify-between hover:bg-gray-100 dark:hover:bg-gray-800 focus:bg-kumquat-light group">

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

@@ -4,6 +4,7 @@
  * See License.AGPL.txt in the project root for license information.
  */
 
+import { getPrimaryEmail } from "@gitpod/public-api-common/lib/user-utils";
 import { useQuery } from "@tanstack/react-query";
 import { getExperimentsClient } from "../experiments/client";
 import { useCurrentProject } from "../projects/project-context";
@@ -40,7 +41,10 @@ export const useFeatureFlag = <K extends keyof FeatureFlags>(featureFlag: K): Fe
 
     const query = useQuery(queryKey, async () => {
         const flagValue = await getExperimentsClient().getValueAsync(featureFlag, featureFlags[featureFlag], {
-            user,
+            user: user && {
+                id: user.id,
+                email: getPrimaryEmail(user),
+            },
             projectId: project?.id,
             teamId: org?.id,
             teamName: org?.name,

components/gitpod-db/package.json

@@ -36,6 +36,7 @@
   ],
   "dependencies": {
     "@gitpod/gitpod-protocol": "0.1.5",
+    "@gitpod/public-api-common": "0.1.5",
     "@jmondi/oauth2-server": "^2.6.1",
     "mysql": "^2.18.1",
     "reflect-metadata": "^0.1.13",

components/gitpod-db/src/typeorm/team-db-impl.ts

@@ -10,7 +10,6 @@ import {
     TeamMemberInfo,
     TeamMemberRole,
     TeamMembershipInvite,
-    User,
 } from "@gitpod/gitpod-protocol";
 import { ErrorCodes, ApplicationError } from "@gitpod/gitpod-protocol/lib/messaging/error";
 import { randomBytes } from "crypto";
@@ -26,6 +25,7 @@ import { DBOrgSettings } from "./entity/db-team-settings";
 import { DBUser } from "./entity/db-user";
 import { TransactionalDBImpl } from "./transactional-db-impl";
 import { TypeORM } from "./typeorm";
+import { getPrimaryEmail } from "@gitpod/public-api-common/lib/user-utils";
 
 @injectable()
 export class TeamDBImpl extends TransactionalDBImpl<TeamDB> implements TeamDB {
@@ -101,7 +101,7 @@ export class TeamDBImpl extends TransactionalDBImpl<TeamDB> implements TeamDB {
             return {
                 userId: u.id,
                 fullName: u.fullName || u.name,
-                primaryEmail: User.getPrimaryEmail(u),
+                primaryEmail: getPrimaryEmail(u),
                 avatarUrl: u.avatarUrl,
                 role: m.role,
                 memberSince: m.creationTime,

components/gitpod-protocol/src/experiments/configcat.ts

@@ -7,7 +7,6 @@
 import { Attributes, Client } from "./types";
 import { User as ConfigCatUser } from "configcat-common/lib/RolloutEvaluator";
 import { IConfigCatClient } from "configcat-common/lib/ConfigCatClient";
-import { User } from "../protocol";
 
 export const USER_ID_ATTRIBUTE = "user_id";
 export const PROJECT_ID_ATTRIBUTE = "project_id";
@@ -37,7 +36,7 @@ export class ConfigCatClient implements Client {
 
 export function attributesToUser(attributes: Attributes): ConfigCatUser {
     const userId = attributes.user?.id || "";
-    const email = User.is(attributes.user) ? User.getPrimaryEmail(attributes.user) : attributes.user?.email || "";
+    const email = attributes.user?.email || "";
 
     const custom: { [key: string]: string } = {};
     if (userId) {

components/gitpod-protocol/src/experiments/types.ts

@@ -4,15 +4,15 @@
  * See License.AGPL.txt in the project root for license information.
  */
 
-import { BillingTier, User } from "../protocol";
+import { BillingTier } from "../protocol";
 
 export const Client = Symbol("Client");
 
 // Attributes define attributes which can be used to segment audiences.
 // Set the attributes which you want to use to group audiences into.
 export interface Attributes {
     // user.id is mapped to ConfigCat's "identifier" + "custom.user_id"
-    user?: User | { id: string; email?: string };
+    user?: { id: string; email?: string };
 
     // The BillingTier of this particular user
     billingTier?: BillingTier;

components/gitpod-protocol/src/protocol.ts

@@ -71,58 +71,6 @@ export namespace User {
         return user.identities.find((id) => id.authProviderId === authProviderId);
     }
 
-    /**
-     * Returns a primary email address of a user.
-     *
-     * For accounts owned by an organization, it returns the email of the most recently used SSO identity.
-     *
-     * For personal accounts, first it looks for a email stored by the user, and falls back to any of the Git provider identities.
-     *
-     * @param user
-     * @returns A primaryEmail, or undefined.
-     */
-    export function getPrimaryEmail(user: User): string | undefined {
-        // If the accounts is owned by an organization, use the email of the most recently
-        // used SSO identity.
-        if (User.isOrganizationOwned(user)) {
-            const compareTime = (a?: string, b?: string) => (a || "").localeCompare(b || "");
-            const recentlyUsedSSOIdentity = user.identities
-                .sort((a, b) => compareTime(a.lastSigninTime, b.lastSigninTime))
-                // optimistically pick the most recent one
-                .reverse()[0];
-            return recentlyUsedSSOIdentity?.primaryEmail;
-        }
-
-        // In case of a personal account, check for the email stored by the user.
-        if (!isOrganizationOwned(user) && user.additionalData?.profile?.emailAddress) {
-            return user.additionalData?.profile?.emailAddress;
-        }
-
-        // Otherwise pick any
-        // FIXME(at) this is still not correct, as it doesn't distinguish between
-        // sign-in providers and additional Git hosters.
-        const identities = user.identities.filter((i) => !!i.primaryEmail);
-        if (identities.length <= 0) {
-            return undefined;
-        }
-
-        return identities[0].primaryEmail || undefined;
-    }
-
-    export function getName(user: User): string | undefined {
-        const name = user.fullName || user.name;
-        if (name) {
-            return name;
-        }
-
-        for (const id of user.identities) {
-            if (id.authName !== "") {
-                return id.authName;
-            }
-        }
-        return undefined;
-    }
-
     export function isOrganizationOwned(user: User) {
         return !!user.organizationId;
     }
@@ -1396,12 +1344,6 @@ export interface CommitInfo {
     authorDate?: string;
 }
 
-export namespace Repository {
-    export function fullRepoName(repo: Repository): string {
-        return `${repo.host}/${repo.owner}/${repo.name}`;
-    }
-}
-
 export interface WorkspaceInstancePortsChangedEvent {
     type: "PortsChanged";
     instanceID: string;
@@ -1446,17 +1388,6 @@ export namespace WorkspaceCreationResult {
     }
 }
 
-export interface UserMessage {
-    readonly id: string;
-    readonly title?: string;
-    /**
-     * date from where on this message should be shown
-     */
-    readonly from?: string;
-    readonly content?: string;
-    readonly url?: string;
-}
-
 export interface AuthProviderInfo {
     readonly authProviderId: string;
     readonly authProviderType: string;

components/server/src/analytics.ts

@@ -9,6 +9,7 @@ import { IAnalyticsWriter, IdentifyMessage, PageMessage, TrackMessage } from "@g
 import * as crypto from "crypto";
 import { clientIp } from "./express-util";
 import { ctxTrySubjectId } from "./util/request-context";
+import { getPrimaryEmail } from "@gitpod/public-api-common/lib/user-utils";
 
 export async function trackLogin(user: User, request: Request, authHost: string, analytics: IAnalyticsWriter) {
     // make new complete identify call for each login
@@ -85,7 +86,7 @@ async function fullIdentify(user: User, request: Request, analytics: IAnalyticsW
         },
         traits: {
             ...resolveIdentities(user),
-            email: User.getPrimaryEmail(user) || "",
+            email: getPrimaryEmail(user) || "",
             full_name: user.fullName,
             created_at: user.creationDate,
             unsubscribed_onboarding: user.additionalData?.emailNotificationSettings?.allowsOnboardingMail === false,

components/server/src/api/verification-service-api.ts

@@ -20,6 +20,7 @@ import { ctxUserId } from "../util/request-context";
 import { UserService } from "../user/user-service";
 import { formatPhoneNumber } from "../user/phone-numbers";
 import { validate as uuidValidate } from "uuid";
+import { getPrimaryEmail } from "@gitpod/public-api-common/lib/user-utils";
 
 @injectable()
 export class VerificationServiceAPI implements ServiceImpl<typeof VerificationServiceInterface> {
@@ -42,7 +43,10 @@ export class VerificationServiceAPI implements ServiceImpl<typeof VerificationSe
             "phoneVerificationByCall",
             false,
             {
-                user,
+                user: {
+                    id: user.id,
+                    email: getPrimaryEmail(user),
+                },
             },
         );
         const channel = phoneVerificationByCall ? "call" : "sms";

components/server/src/auth/verification-service.ts

@@ -16,6 +16,7 @@ import { v4 as uuidv4, validate as uuidValidate } from "uuid";
 import { getExperimentsClientForBackend } from "@gitpod/gitpod-protocol/lib/experiments/configcat-server";
 import { IAnalyticsWriter } from "@gitpod/gitpod-protocol/lib/analytics";
 import { UserService } from "../user/user-service";
+import { getPrimaryEmail } from "@gitpod/public-api-common/lib/user-utils";
 
 interface VerificationEndpoint {
     sendToken(phoneNumber: string, channel: "sms" | "call"): Promise<string>;
@@ -134,7 +135,10 @@ export class VerificationService {
             "isPhoneVerificationEnabled",
             false,
             {
-                user,
+                user: {
+                    id: user.id,
+                    email: getPrimaryEmail(user),
+                },
             },
         );
         return isPhoneVerificationEnabled;

components/server/src/bitbucket-server/bitbucket-server-repository-provider.ts

@@ -11,6 +11,7 @@ import { RepositoryProvider } from "../repohost/repository-provider";
 import { BitbucketServerApi } from "./bitbucket-server-api";
 import { log } from "@gitpod/gitpod-protocol/lib/util/logging";
 import { getExperimentsClientForBackend } from "@gitpod/gitpod-protocol/lib/experiments/configcat-server";
+import { getPrimaryEmail } from "@gitpod/public-api-common/lib/user-utils";
 
 @injectable()
 export class BitbucketServerRepositoryProvider implements RepositoryProvider {
@@ -150,7 +151,10 @@ export class BitbucketServerRepositoryProvider implements RepositoryProvider {
             "repositoryFinderSearch",
             false,
             {
-                user,
+                user: {
+                    id: user.id,
+                    email: getPrimaryEmail(user),
+                },
             },
         );
 

components/server/src/ide-service.ts

@@ -12,6 +12,7 @@ import {
     IDEServiceDefinition,
     ResolveWorkspaceConfigResponse,
 } from "@gitpod/ide-service-api/lib/ide.pb";
+import { getPrimaryEmail } from "@gitpod/public-api-common/lib/user-utils";
 import { inject, injectable } from "inversify";
 import { AuthorizationService } from "./user/authorization-service";
 
@@ -87,7 +88,7 @@ export class IDEService {
             workspaceConfig: JSON.stringify(workspace.config),
             user: {
                 id: user.id,
-                email: User.getPrimaryEmail(user),
+                email: getPrimaryEmail(user),
             },
         };
         for (let attempt = 0; attempt < 15; attempt++) {

components/server/src/workspace/gitpod-server-impl.ts

@@ -144,6 +144,7 @@ import { ScmService } from "../scm/scm-service";
 import { ContextService } from "./context-service";
 import { runWithRequestContext, runWithSubjectId } from "../util/request-context";
 import { SubjectId } from "../auth/subject-id";
+import { getPrimaryEmail } from "@gitpod/public-api-common/lib/user-utils";
 
 // shortcut
 export const traceWI = (ctx: TraceContext, wi: Omit<LogContext, "userId">) => TraceContext.setOWI(ctx, wi); // userId is already taken care of in WebsocketConnectionManager
@@ -460,7 +461,10 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
             "phoneVerificationByCall",
             false,
             {
-                user,
+                user: {
+                    id: user.id,
+                    email: getPrimaryEmail(user),
+                },
             },
         );
 
@@ -2413,7 +2417,10 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
     private async guardWithFeatureFlag(flagName: string, user: User, teamId: string) {
         // Guard method w/ a feature flag check
         const isEnabled = await getExperimentsClientForBackend().getValueAsync(flagName, false, {
-            user: user,
+            user: {
+                id: user.id,
+                email: getPrimaryEmail(user),
+            },
             teamId,
         });
         if (!isEnabled) {
@@ -2498,7 +2505,7 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
 
     async getIDEOptions(ctx: TraceContext): Promise<IDEOptions> {
         const user = await this.checkUser("identifyUser");
-        const email = User.getPrimaryEmail(user);
+        const email = getPrimaryEmail(user);
         const ideConfig = await this.ideService.getIDEConfig({ user: { id: user.id, email } });
         return ideConfig.ideOptions;
     }
@@ -2620,7 +2627,7 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
         await this.auth.checkPermissionOnOrganization(user.id, "write_billing", attrId.teamId);
 
         //TODO billing email should be editable within the org
-        const billingEmail = User.getPrimaryEmail(user);
+        const billingEmail = getPrimaryEmail(user);
         const billingName = org.name;
 
         let customer: StripeCustomer | undefined;
@@ -2821,7 +2828,10 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
             throw new ApplicationError(ErrorCodes.NOT_FOUND, "Organization not found.");
         }
         const isMemberUsageEnabled = await getExperimentsClientForBackend().getValueAsync("member_usage", false, {
-            user: user,
+            user: {
+                id: user.id,
+                email: getPrimaryEmail(user),
+            },
             teamId: attributionId.teamId,
         });
         if (isMemberUsageEnabled && member.role !== "owner") {