@gitpod/gitpod-protocol 0.1.5-test.9 → 0.1.5-tweak-workspaceconfig-origin-docs-fork.0

package/src/protocol.ts

@@ -1,13 +1,14 @@
 /**
- * Copyright (c) 2020 TypeFox GmbH. All rights reserved.
+ * Copyright (c) 2020 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 { WorkspaceInstance, PortVisibility } from "./workspace-instance";
 import { RoleOrPermission } from "./permission";
+import { Project } from "./teams-projects-protocol";
 
-export interface UserInfo {
+export interface UserInfo {
     name?: string
 }
 
@@ -27,19 +28,12 @@ export interface User {
 
     identities: Identity[]
 
-    allowsMarketingCommunication: boolean;
-
     /**
      * Whether the user has been blocked to use our service, because of TOS violation for example.
      * Optional for backwards compatibility.
      */
     blocked?: boolean;
 
-    /**
-     * whether this user can run workspaces in privileged mode
-     */
-    privileged?: boolean;
-
     /** A map of random settings that alter the behaviour of Gitpod on a per-user basis */
     featureFlags?: UserFeatureSettings;
 
@@ -61,6 +55,20 @@ export namespace User {
     export function getIdentity(user: User, authProviderId: string): Identity | undefined {
         return user.identities.find(id => id.authProviderId === authProviderId);
     }
+    export function censor(user: User): User {
+        const res = { ...user };
+        delete (res.additionalData);
+        res.identities = res.identities.map(i => {
+            delete (i.tokens);
+
+            // The user field is not in the Identity shape, but actually exists on DBIdentity.
+            // Trying to push this object out via JSON RPC will fail because of the cyclic nature
+            // of this field.
+            delete ((i as any).user);
+            return i;
+        });
+        return res;
+    }
     export function getPrimaryEmail(user: User): string {
         const identities = user.identities.filter(i => !!i.primaryEmail);
         if (identities.length <= 0) {
@@ -74,7 +82,7 @@ export namespace User {
         if (name) {
             return name;
         }
-        
+
         for (const id of user.identities) {
             if (id.authName !== "") {
                 return id.authName;
@@ -87,10 +95,27 @@ export namespace User {
 export interface AdditionalUserData {
     platforms?: UserPlatform[];
     emailNotificationSettings?: EmailNotificationSettings;
+    featurePreview?: boolean;
+    ideSettings?: IDESettings;
+    // key is the name of the news, string the iso date when it was seen
+    whatsNewSeen?: { [key: string]: string }
+    // key is the name of the OAuth client i.e. local app, string the iso date when it was approved
+    // TODO(rl): provide a management UX to allow rescinding of approval
+    oauthClientsApproved?: { [key: string]: string }
+    // to remember GH Orgs the user installed/updated the GH App for
+    knownGitHubOrgs?: string[];
 }
 
 export interface EmailNotificationSettings {
-    disallowTransactionalEmails?: boolean;
+    allowsChangelogMail?: boolean;
+    allowsDevXMail?: boolean;
+    allowsOnboardingMail?: boolean;
+}
+
+export type IDESettings = {
+    defaultIde?: string
+    useDesktopIde?: boolean
+    defaultDesktopIde?: string
 }
 
 export interface UserPlatform {
@@ -104,7 +129,7 @@ export interface UserPlatform {
      * Since when does the user have the browser extension installe don this device.
      */
     browserExtensionInstalledSince?: string;
-    
+
     /**
      * Since when does the user not have the browser extension installed anymore (but previously had).
      */
@@ -112,14 +137,6 @@ export interface UserPlatform {
 }
 
 export interface UserFeatureSettings {
-    /**
-     * This field is used as marker to grant users a free trial for using private repositories,
-     * independent of any subscription or Chargebee.
-     *  - it is set when the user uses their first private repo
-     *  - whether the trial is expired or not is juged by the UserService
-     */
-    privateRepoTrialStartDate?: string;
-
     /**
      * Permanent feature flags are added to each and every workspace instance
      * this user starts.
@@ -131,8 +148,8 @@ export interface UserFeatureSettings {
  * The values of this type MUST MATCH enum values in WorkspaceFeatureFlag from ws-manager/client/core_pb.d.ts
  * If they don't we'll break things during workspace startup.
  */
-export const WorkspaceFeatureFlags = { "privileged": undefined, "registry_facade": undefined, "full_workspace_backup": undefined, "fixed_resources": undefined };
-export type NamedWorkspaceFeatureFlag = keyof(typeof WorkspaceFeatureFlags);
+export const WorkspaceFeatureFlags = { "full_workspace_backup": undefined, "fixed_resources": undefined };
+export type NamedWorkspaceFeatureFlag = keyof (typeof WorkspaceFeatureFlags);
 
 export interface UserEnvVarValue {
     id?: string;
@@ -152,6 +169,28 @@ export namespace UserEnvVar {
         return pattern.toLocaleLowerCase();
     }
 
+    export function score(value: UserEnvVarValue): number {
+        // We use a score to enforce precedence:
+        //      value/value = 0
+        //      value/*     = 1
+        //      */value     = 2
+        //      */*         = 3
+        //      #/#         = 4 (used for env vars passed through the URL)
+        // the lower the score, the higher the precedence.
+        const [ownerPattern, repoPattern] = splitRepositoryPattern(value.repositoryPattern);
+        let score = 0;
+        if (repoPattern == "*") {
+            score += 1;
+        }
+        if (ownerPattern == '*') {
+            score += 2;
+        }
+        if (ownerPattern == "#" || repoPattern == "#") {
+            score = 4;
+        }
+        return score;
+    }
+
     export function filter<T extends UserEnvVarValue>(vars: T[], owner: string, repo: string): T[] {
         let result = vars.filter(e => {
             const [ownerPattern, repoPattern] = splitRepositoryPattern(e.repositoryPattern);
@@ -187,25 +226,7 @@ export namespace UserEnvVar {
             let minscore = 10;
             let bestCandidate: T | undefined;
             for (const e of candidates) {
-                // We use a score to enforce precedence:
-                //      value/value = 0
-                //      value/*     = 1
-                //      */value     = 2
-                //      */*         = 3
-                //      #/#         = 4 (used for env vars passed through the URL)
-                // the lower the score, the higher the precedence.
-                const [ownerPattern, repoPattern] = splitRepositoryPattern(e.repositoryPattern);
-                let score = 0;
-                if (repoPattern == "*") {
-                    score += 1;
-                }
-                if (ownerPattern == '*') {
-                    score += 2;
-                }
-                if (ownerPattern == "#" || repoPattern == "#") {
-                    score = 4;
-                }
-
+                const score = UserEnvVar.score(e);
                 if (!bestCandidate || score < minscore) {
                     minscore = score;
                     bestCandidate = e;
@@ -217,7 +238,7 @@ export namespace UserEnvVar {
         return result;
     }
 
-    function splitRepositoryPattern(repositoryPattern: string): string[] {
+    export function splitRepositoryPattern(repositoryPattern: string): string[] {
         const patterns = repositoryPattern.split('/');
         const repoPattern = patterns.pop() || "";
         const ownerPattern = patterns.join('/');
@@ -238,13 +259,13 @@ export interface GitpodToken {
 
     /** The user the token belongs to. */
     user: User
-    
+
     /** Scopes (e.g. limition to read-only) */
     scopes: string[]
 
     /** Created timestamp */
     created: string
-    
+
     // token is deleted on the database and about to be collected by db-sync
     deleted?: boolean
 }
@@ -351,11 +372,16 @@ export interface PendingGithubEvent {
 export interface Snapshot {
     id: string;
     creationTime: string;
+    availableTime?: string;
     originalWorkspaceId: string;
     bucketId: string;
     layoutData?: string;
+    state: SnapshotState;
+    message?: string;
 }
 
+export type SnapshotState = 'pending' | 'available' | 'error';
+
 export interface LayoutData {
     workspaceId: string;
     lastUpdatedTime: string;
@@ -368,9 +394,10 @@ export interface Workspace {
     contextURL: string;
     description: string;
     ownerId: string;
+    projectId?: string;
     context: WorkspaceContext;
     config: WorkspaceConfig;
-    
+
     /**
      * The source where to get the workspace base image from. This source is resolved
      * during workspace creation. Once a base image has been built the information in here
@@ -476,6 +503,7 @@ export interface PreparePluginUploadParams {
 export interface ResolvePluginsParams {
     config?: WorkspaceConfig
     builtins?: ResolvedPlugins
+    vsxRegistryUrl?: string
 }
 
 export interface InstallPluginsParams {
@@ -486,6 +514,24 @@ export interface UninstallPluginParams {
     pluginId: string;
 }
 
+export interface GuessGitTokenScopesParams {
+    host: string
+    repoUrl: string
+	gitCommand: string
+    currentToken: GitToken
+}
+
+export interface GitToken {
+    token: string
+    user: string
+    scopes: string[]
+}
+
+export interface GuessedGitTokenScopes {
+    message?: string
+    scopes?: string[]
+}
+
 export type ResolvedPluginKind = 'user' | 'workspace' | 'builtin';
 
 export interface ResolvedPlugins {
@@ -508,21 +554,24 @@ export interface WorkspaceConfig {
     tasks?: TaskConfig[];
     checkoutLocation?: string;
     workspaceLocation?: string;
-    privileged?: boolean;
     gitConfig?: { [config: string]: string };
     github?: GithubAppConfig;
     vscode?: VSCodeConfig;
-    ide?: 'theia' | 'code' | string;
+
+    /** tailscale demo */
+    experimentalNetwork?: boolean;
 
     /**
      * Where the config object originates from.
-     * 
-     * repo - from the repository
-     * definitly-gp - from github.com/gitpod-io/definitely-gp
-     * derived - computed based on analyzing the repository
-     * default - our static catch-all default config
+     *
+     * - repo - from the repository
+     * - project-db - from the "Project" stored in the database
+     * - definitly-gp - from github.com/gitpod-io/definitely-gp
+     * - derived - computed based on analyzing the repository
+     * - additional-content - config comes from additional content, usually provided through the project's configuration
+     * - default - our static catch-all default config
      */
-    _origin?: 'repo' | 'definitely-gp' | 'derived' | 'default';
+    _origin?: 'repo' | 'project-db' | 'definitely-gp' | 'derived' | 'additional-content' | 'default';
 
     /**
      * Set of automatically infered feature flags. That's not something the user can set, but
@@ -552,16 +601,13 @@ export namespace GithubAppPrebuildConfig {
 
 export type WorkspaceImageSource = WorkspaceImageSourceDocker | WorkspaceImageSourceReference;
 export interface WorkspaceImageSourceDocker {
-    // TODO: clean this up. We should have the commit and an ImageSource in here, not duplicate the whole thing again.
-    //       We have a ton of those objects in the database, thus cleaning this up means lengthy DB migrations. Yuck.
-    dockerFileHash: string
-    dockerFileSource: Commit
     dockerFilePath: string
+    dockerFileHash: string
+    dockerFileSource?: Commit
 }
 export namespace WorkspaceImageSourceDocker {
     export function is(obj: object): obj is WorkspaceImageSourceDocker {
         return 'dockerFileHash' in obj
-            && 'dockerFileSource' in obj
             && 'dockerFilePath' in obj;
     }
 }
@@ -590,6 +636,8 @@ export type PrebuiltWorkspaceState
 export interface PrebuiltWorkspace {
     id: string;
     cloneURL: string;
+    branch?: string;
+    projectId?: string;
     commit: string;
     buildWorkspaceId: string;
     creationTime: string;
@@ -599,6 +647,10 @@ export interface PrebuiltWorkspace {
 }
 
 export namespace PrebuiltWorkspace {
+    export function isDone(pws: PrebuiltWorkspace) {
+        return pws.state === "available" || pws.state === "timeout" || pws.state === 'aborted';
+    }
+
     export function isAvailable(pws: PrebuiltWorkspace) {
         return pws.state === "available" && !!pws.snapshot;
     }
@@ -655,7 +707,7 @@ export interface TaskConfig {
     init?: string;
     prebuild?: string;
     command?: string;
-    env?: { [env: string]: string };
+    env?: { [env: string]: any };
     openIn?: 'bottom' | 'main' | 'left' | 'right';
     openMode?: 'split-top' | 'split-left' | 'split-right' | 'split-bottom' | 'tab-before' | 'tab-after';
 }
@@ -719,8 +771,10 @@ export namespace ExternalImageConfigFile {
 
 export interface WorkspaceContext {
     title: string;
+    /** This contains the URL portion of the contextURL (which might contain other modifiers as well). It's optional because it's not set for older workspaces. */
     normalizedContextURL?: string;
     forceCreateNewWorkspace?: boolean;
+    forceImageBuild?: boolean;
 }
 
 export namespace WorkspaceContext {
@@ -754,13 +808,36 @@ export namespace WithPrebuild {
     }
 }
 
+/**
+ * WithDefaultConfig contexts disable the download of the gitpod.yml from the repository
+ * and fall back to the built-in configuration.
+ */
+export interface WithDefaultConfig {
+    withDefaultConfig: true;
+}
+
+export namespace WithDefaultConfig {
+    export function is(context: any): context is WithDefaultConfig {
+        return context
+            && 'withDefaultConfig' in context
+            && context.withDefaultConfig;
+    }
+
+    export function mark(ctx: WorkspaceContext): WorkspaceContext & WithDefaultConfig {
+        return {
+            ...ctx,
+            withDefaultConfig: true
+        }
+    }
+}
+
 export interface SnapshotContext extends WorkspaceContext, WithSnapshot {
     snapshotId: string;
 }
 
 export namespace SnapshotContext {
     export function is(context: any): context is SnapshotContext {
-        return context 
+        return context
             && WithSnapshot.is(context)
             && 'snapshotId' in context;
     }
@@ -768,6 +845,9 @@ export namespace SnapshotContext {
 
 export interface StartPrebuildContext extends WorkspaceContext {
     actual: WorkspaceContext;
+    commitHistory?: string[];
+    project?: Project;
+    branch?: string;
 }
 
 export namespace StartPrebuildContext {
@@ -837,6 +917,25 @@ export interface Commit {
     refType?: RefType
 }
 
+export interface AdditionalContentContext extends WorkspaceContext {
+
+    /**
+     * utf-8 encoded contents that will be copied on top of the workspace's filesystem
+     */
+    additionalFiles: {[filePath: string]: string};
+
+}
+
+export namespace AdditionalContentContext {
+    export function is(ctx: any): ctx is AdditionalContentContext {
+        return 'additionalFiles' in ctx;
+    }
+
+    export function hasDockerConfig(ctx: any, config: WorkspaceConfig): boolean {
+        return is(ctx) && ImageConfigFile.is(config.image) && !!ctx.additionalFiles[config.image.file];
+    }
+}
+
 export interface CommitContext extends WorkspaceContext, Commit {
     /** @deprecated Moved to .repository.cloneUrl, left here for backwards-compatibility for old workspace contextes in the DB */
     cloneUrl?: string
@@ -912,6 +1011,19 @@ export interface Repository {
         parent: Repository
     }
 }
+export interface Branch {
+    name: string;
+    commit: CommitInfo;
+    htmlUrl: string;
+}
+
+export interface CommitInfo {
+    author: string;
+    sha: string;
+    commitMessage: string;
+    authorAvatarUrl?: string;
+    authorDate?: string;
+}
 
 export namespace Repository {
     export function fullRepoName(repo: Repository): string {
@@ -939,6 +1051,12 @@ export interface WorkspaceInfo {
     latestInstance?: WorkspaceInstance
 }
 
+export namespace WorkspaceInfo {
+    export function lastActiveISODate(info: WorkspaceInfo): string {
+        return info.latestInstance?.creationTime || info.workspace.creationTime;
+    }
+}
+
 export type RunningWorkspaceInfo = WorkspaceInfo & { latestInstance: WorkspaceInstance };
 
 export interface WorkspaceCreationResult {
@@ -948,6 +1066,7 @@ export interface WorkspaceCreationResult {
     runningWorkspacePrebuild?: {
         prebuildID: string
         workspaceID: string
+        instanceID: string
         starting: RunningWorkspacePrebuildStarting
         sameCluster: boolean
     }
@@ -1038,8 +1157,17 @@ export interface OAuth2Config {
 export namespace AuthProviderEntry {
     export type Type = "GitHub" | "GitLab" | string;
     export type Status = "pending" | "verified";
-    export type NewEntry = Pick<AuthProviderEntry, "ownerId" | "host" | "type">;
+    export type NewEntry = Pick<AuthProviderEntry, "ownerId" | "host" | "type"> & { clientId?: string, clientSecret?: string };
     export type UpdateEntry = Pick<AuthProviderEntry, "id" | "ownerId"> & Pick<OAuth2Config, "clientId" | "clientSecret">;
+    export function redact(entry: AuthProviderEntry): AuthProviderEntry {
+        return {
+            ...entry,
+            oauth: {
+                ...entry.oauth,
+                clientSecret: "redacted"
+            }
+        }
+    }
 }
 
 export interface Branding {
@@ -1100,3 +1228,18 @@ export namespace TheiaPlugin {
         CheckinFailed = "checkin-failed",
     }
 }
+
+export interface TermsAcceptanceEntry {
+    readonly userId: string;
+    readonly termsRevision: string;
+    readonly acceptionTime: string;
+}
+
+export interface Terms {
+    readonly revision: string;
+    readonly activeSince: string;
+    readonly adminOnlyTerms: boolean;
+    readonly updateMessage: string;
+    readonly content: string;
+    readonly formElements?: object;
+}

package/src/snapshot-url.spec.ts

@@ -0,0 +1,25 @@
+/**
+ * Copyright (c) 2020 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 { suite, test } from "mocha-typescript"
+import * as chai from "chai"
+import { SnapshotUrl } from ".";
+
+const expect = chai.expect
+
+@suite class TestSnapshotUrlParser {
+
+    @test public testPositive() {
+        const actual = SnapshotUrl.parse("workspaces/c362d434-6faa-4ce0-9ad4-91b4a87c4abe/3f0556f7-4afa-11e9-98d5-52f8983b9279.tar@gitpod-prodcopy-user-e1e28f18-0354-4a5d-b6b4-8879a2ff73fd");
+
+        expect(actual).to.deep.equal(<SnapshotUrl>{
+            bucketId: "gitpod-prodcopy-user-e1e28f18-0354-4a5d-b6b4-8879a2ff73fd",
+            filename: "3f0556f7-4afa-11e9-98d5-52f8983b9279.tar",
+            fullPath: "workspaces/c362d434-6faa-4ce0-9ad4-91b4a87c4abe/3f0556f7-4afa-11e9-98d5-52f8983b9279.tar",
+        });
+    }
+}
+module.exports = new TestSnapshotUrlParser()   // Only to circumvent no usage warning :-/

package/src/snapshot-url.ts

@@ -0,0 +1,27 @@
+/**
+ * Copyright (c) 2021 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.
+ */
+
+export interface SnapshotUrl {
+    bucketId: string;
+    fullPath: string;
+    filename: string;
+}
+export namespace SnapshotUrl {
+    export function parse(url: string): SnapshotUrl {
+        const parts = url.split("@");
+        if (parts.length !== 2) {
+            throw new Error(`cannot parse snapshot URL: ${url}`);
+        }
+        const [fullPath, bucketId] = parts;
+
+        const pathParts = fullPath.split("/");
+        if (pathParts.length < 1) {
+            throw new Error(`cannot parse snapshot URL: ${url}`);
+        }
+        const filename = pathParts[pathParts.length - 1];
+        return { bucketId, fullPath, filename };
+    }
+}

package/src/team-subscription-protocol.ts

@@ -0,0 +1,113 @@
+/**
+ * Copyright (c) 2021 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 { v4 as uuidv4 } from 'uuid';
+import { Subscription } from "./accounting-protocol";
+
+export interface TeamSubscription {
+    id: string;
+    userId: string;
+    planId: string;
+    startDate: string;
+    endDate?: string;
+    quantity: number;
+    /** The Chargebee subscription id */
+    paymentReference: string;
+    cancellationDate?: string;
+    deleted?: boolean;
+}
+
+export namespace TeamSubscription {
+    export const create = (ts: Omit<TeamSubscription, 'id'>): TeamSubscription => {
+        const withId = ts as TeamSubscription;
+        withId.id = uuidv4();
+        return withId;
+    }
+    export const isActive = (ts: TeamSubscription, date: string): boolean => {
+        return ts.startDate <= date && (ts.endDate === undefined || date < ts.endDate);
+    }
+}
+
+/**
+ * A slot represents one unit of a TeamSubscription that gets assigned to one user at a time
+ */
+export interface TeamSubscriptionSlot {
+    id: string;
+    teamSubscriptionId: string;
+    assigneeId?: string;
+    assigneeIdentifier?: AssigneeIdentifier;
+    subscriptionId?: string;
+    cancellationDate?: string;
+}
+export type TeamSubscriptionSlotDeactivated = TeamSubscriptionSlot & { assigneeId: string, assigneeIdentifier: AssigneeIdentifier };
+export type TeamSubscriptionSlotAssigned = TeamSubscriptionSlot & TeamSubscriptionSlotDeactivated & { subscriptionId: string };
+
+export type TeamSubscriptionSlotState = 'unassigned' | 'assigned' | 'deactivated' | 'cancelled';
+
+export namespace TeamSubscriptionSlot {
+    export const create = (ts: Omit<TeamSubscriptionSlot, 'id'>): TeamSubscriptionSlot => {
+        const withId = ts as TeamSubscriptionSlot;
+        withId.id = uuidv4();
+        return withId;
+    }
+    export const assign = (slot: TeamSubscriptionSlot, assigneeId: string, subscriptionId: string, assigneeIdentifier: AssigneeIdentifier) => {
+        slot.assigneeId = assigneeId;
+        slot.subscriptionId = subscriptionId;
+        slot.assigneeIdentifier = assigneeIdentifier;
+    }
+    export const deactivate = (slot: TeamSubscriptionSlot, cancellationDate: string) => {
+        slot.subscriptionId = undefined;
+        slot.cancellationDate = cancellationDate;
+    }
+    export const reactivate = (slot: TeamSubscriptionSlot, subscriptionId?: string) => {
+        slot.subscriptionId = subscriptionId;
+        slot.cancellationDate = undefined;
+    }
+    export const status = (slot: TeamSubscriptionSlot, now: string): TeamSubscriptionSlotState => {
+        if (slot.cancellationDate) {
+            if (slot.cancellationDate < now) {
+                return 'cancelled';
+            } else {
+                return 'deactivated';
+            }
+        } else {
+            if (slot.subscriptionId) {
+                return 'assigned';
+            } else {
+                return 'unassigned';
+            }
+        }
+
+    }
+    export const isActive = (slot: TeamSubscriptionSlot): boolean => {
+        return !slot.cancellationDate;
+    }
+}
+
+/**
+ * The mapping between a TeamSubscription and a resulting Subscription, resolved
+ */
+export interface TeamSubscriptionSlotResolved {
+    id: string;
+    teamSubscription: TeamSubscription;
+    state: TeamSubscriptionSlotState;
+    assigneeId?: string;
+    assigneeIdentifier?: AssigneeIdentifier;
+    subscription?: Subscription;
+    cancellationDate?: string;
+    hoursLeft?: number;
+}
+
+/**
+ * Contains the data structure that the assigner used to identify the assignee.
+ */
+export type AssigneeIdentifier = AssigneeIdentityIdentifier;
+export interface AssigneeIdentityIdentifier {
+    identity: {
+        authHost: string,
+        authName: string
+    }
+}