@gitpod/gitpod-protocol 0.1.5-pd-timeout-16089.2 → 0.1.5-pd-timeout-16089.10

package/src/gitpod-service.ts

@@ -27,6 +27,7 @@ import {
     UserSSHPublicKeyValue,
     SSHPublicKeyValue,
     IDESettings,
+    EnvVarWithValue,
 } from "./protocol";
 import {
     Team,
@@ -153,6 +154,9 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     getUserStorageResource(options: GitpodServer.GetUserStorageResourceOptions): Promise<string>;
     updateUserStorageResource(options: GitpodServer.UpdateUserStorageResourceOptions): Promise<void>;
 
+    // Workspace env vars
+    getWorkspaceEnvVars(workspaceId: string): Promise<EnvVarWithValue[]>;
+
     // User env vars
     getEnvVars(): Promise<UserEnvVarValue[]>;
     getAllEnvVars(): Promise<UserEnvVarValue[]>;
@@ -305,11 +309,25 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     /**
      * Frontend notifications
      */
-    getNotifications(): Promise<string[]>;
+    getNotifications(): Promise<AppNotification[]>;
 
     getSupportedWorkspaceClasses(): Promise<SupportedWorkspaceClass[]>;
 }
 
+export interface AppNotification {
+    message: string;
+    action?: {
+        url: string;
+        label: string;
+    };
+    notClosable?: boolean;
+}
+export namespace AppNotification {
+    export function is(data: any): data is AppNotification {
+        return data && typeof data === "object" && data.hasOwnProperty("message");
+    }
+}
+
 export interface RateLimiterError {
     method?: string;
 

package/src/plans.ts

@@ -490,6 +490,22 @@ export namespace Plans {
         return chargebeeId === Plans.FREE_OPEN_SOURCE.chargebeeId;
     }
 
+    export function isPersonalPlan(planId: string | undefined): boolean {
+        const plan = Plans.getById(planId);
+        if (!plan) {
+            return false;
+        }
+        return !plan.team;
+    }
+
+    export function isTeamPlan(planId: string | undefined): boolean {
+        const plan = Plans.getById(planId);
+        if (!plan) {
+            return false;
+        }
+        return !!plan.team;
+    }
+
     export function getHoursPerMonth(plan: Plan): number {
         return plan.hoursPerMonth == "unlimited" ? ABSOLUTE_MAX_USAGE : plan.hoursPerMonth;
     }

package/src/protocol.ts

@@ -153,12 +153,21 @@ export namespace User {
         user.additionalData.ideSettings = newIDESettings;
     }
 
+    // TODO: make it more explicit that these field names are relied for our tracking purposes
+    // and decouple frontend from relying on them - instead use user.additionalData.profile object directly in FE
     export function getProfile(user: User): Profile {
         return {
             name: User.getName(user!) || "",
             email: User.getPrimaryEmail(user!) || "",
             company: user?.additionalData?.profile?.companyName,
             avatarURL: user?.avatarUrl,
+            companyWebsite: user?.additionalData?.profile?.companyName,
+            jobRole: user?.additionalData?.profile?.jobRole,
+            jobRoleOther: user?.additionalData?.profile?.jobRoleOther,
+            explorationReasons: user?.additionalData?.profile?.explorationReasons,
+            signupGoals: user?.additionalData?.profile?.signupGoals,
+            signupGoalsOther: user?.additionalData?.profile?.signupGoalsOther,
+            onboardedTimestamp: user?.additionalData?.profile?.onboardedTimestamp,
         };
     }
 
@@ -190,12 +199,21 @@ export namespace User {
         return AttributionId.create(user);
     }
 
+    // TODO: refactor where this is referenced so it's more clearly tied to just analytics-tracking
+    // Let other places rely on the ProfileDetails type since that's what we store
     // The actual Profile of a User
     export interface Profile {
         name: string;
         email: string;
         company?: string;
         avatarURL?: string;
+        companyWebsite?: string;
+        jobRole?: string;
+        jobRoleOther?: string;
+        explorationReasons?: string[];
+        signupGoals?: string[];
+        signupGoalsOther?: string;
+        onboardedTimestamp?: string;
     }
     export namespace Profile {
         export function hasChanges(before: Profile, after: Profile) {
@@ -203,7 +221,13 @@ export namespace User {
                 before.name !== after.name ||
                 before.email !== after.email ||
                 before.company !== after.company ||
-                before.avatarURL !== after.avatarURL
+                before.avatarURL !== after.avatarURL ||
+                before.companyWebsite !== after.companyWebsite ||
+                before.jobRole !== after.jobRole ||
+                before.jobRoleOther !== after.jobRoleOther ||
+                // not checking explorationReasons or signupGoals atm as it's an array - need to check deep equality
+                before.signupGoalsOther !== after.signupGoalsOther ||
+                before.onboardedTimestamp !== after.onboardedTimestamp
             );
         }
     }
@@ -257,6 +281,20 @@ export interface ProfileDetails {
     companyName?: string;
     // the user's email
     emailAddress?: string;
+    // the user's company website
+    companyWebsite?: string;
+    // type of role user has in their job
+    jobRole?: string;
+    // freeform entry for job role user works in (when jobRole is "other")
+    jobRoleOther?: string;
+    // Reasons user is exploring Gitpod when they signed up
+    explorationReasons?: string[];
+    // what user hopes to accomplish when they signed up
+    signupGoals?: string[];
+    // freeform entry for signup goals (when signupGoals is "other")
+    signupGoalsOther?: string;
+    // Set after a user completes the onboarding flow
+    onboardedTimestamp?: string;
 }
 
 export interface EmailNotificationSettings {
@@ -326,6 +364,8 @@ export namespace NamedWorkspaceFeatureFlag {
     }
 }
 
+export type EnvVar = UserEnvVar | ProjectEnvVarWithValue | EnvVarWithValue;
+
 export interface EnvVarWithValue {
     name: string;
     value: string;