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

package/src/util/generate-workspace-id.ts

@@ -0,0 +1,457 @@
+/**
+ * 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 randomNumber = require("random-number-csprng");
+
+export async function generateWorkspaceID(): Promise<string> {
+    return (await random(colors))+'-'+(await random(animals))+'-'+(await random(characters, 8));
+}
+
+async function random(array: string[], length: number = 1): Promise<string> {
+    var result = '';
+    for ( var i = 0; i < length; i++ ) {
+       result += array[await randomNumber(0, array.length-1)];
+    }
+    return result;
+}
+
+const characters = 'abcdefghijklmnopqrstuvwxyz0123456789'.split('');
+
+export const colors = [
+    'amaranth',
+    'amber',
+    'amethyst',
+    'apricot',
+    'aqua',
+    'aquamarine',
+    'azure',
+    'beige',
+    'black',
+    'blue',
+    'blush',
+    'bronze',
+    'brown',
+    'chocolate',
+    'coffee',
+    'copper',
+    'coral',
+    'crimson',
+    'cyan',
+    'emerald',
+    'fuchsia',
+    'gold',
+    'gray',
+    'green',
+    'harlequin',
+    'indigo',
+    'ivory',
+    'jade',
+    'kumquat',
+    'lavender',
+    'lime',
+    'magenta',
+    'maroon',
+    'moccasin',
+    'olive',
+    'orange',
+    'peach',
+    'pink',
+    'plum',
+    'purple',
+    'red',
+    'rose',
+    'salmon',
+    'sapphire',
+    'scarlet',
+    'silver',
+    'tan',
+    'teal',
+    'tomato',
+    'turquoise',
+    'violet',
+    'white',
+    'yellow',
+  ];
+
+  export const animals = [
+    'canidae',
+    'felidae',
+    'cat',
+    'cattle',
+    'dog',
+    'donkey',
+    'goat',
+    'horse',
+    'pig',
+    'rabbit',
+    'aardvark',
+    'aardwolf',
+    'albatross',
+    'alligator',
+    'alpaca',
+    'amphibian',
+    'anaconda',
+    'angelfish',
+    'anglerfish',
+    'ant',
+    'anteater',
+    'antelope',
+    'antlion',
+    'ape',
+    'aphid',
+    'armadillo',
+    'asp',
+    'baboon',
+    'badger',
+    'bandicoot',
+    'barnacle',
+    'barracuda',
+    'basilisk',
+    'bass',
+    'bat',
+    'bear',
+    'beaver',
+    'bedbug',
+    'bee',
+    'beetle',
+    'bird',
+    'bison',
+    'blackbird',
+    'boa',
+    'boar',
+    'bobcat',
+    'bobolink',
+    'bonobo',
+    'booby',
+    'bovid',
+    'bug',
+    'butterfly',
+    'buzzard',
+    'camel',
+    'canid',
+    'capybara',
+    'cardinal',
+    'caribou',
+    'carp',
+    'cat',
+    'catshark',
+    'caterpillar',
+    'catfish',
+    'cattle',
+    'centipede',
+    'cephalopod',
+    'chameleon',
+    'cheetah',
+    'chickadee',
+    'chicken',
+    'chimpanzee',
+    'chinchilla',
+    'chipmunk',
+    'clam',
+    'clownfish',
+    'cobra',
+    'cockroach',
+    'cod',
+    'condor',
+    'constrictor',
+    'coral',
+    'cougar',
+    'cow',
+    'coyote',
+    'crab',
+    'crane',
+    'crawdad',
+    'crayfish',
+    'cricket',
+    'crocodile',
+    'crow',
+    'cuckoo',
+    'cicada',
+    'damselfly',
+    'deer',
+    'dingo',
+    'dinosaur',
+    'dodo',
+    'dog',
+    'dolphin',
+    'donkey',
+    'dormouse',
+    'dove',
+    'dragonfly',
+    'dragon',
+    'duck',
+    'eagle',
+    'earthworm',
+    'earwig',
+    'echidna',
+    'eel',
+    'egret',
+    'elephant',
+    'elk',
+    'emu',
+    'ermine',
+    'falcon',
+    'ferret',
+    'finch',
+    'firefly',
+    'fish',
+    'flamingo',
+    'flea',
+    'fly',
+    'flyingfish',
+    'fowl',
+    'fox',
+    'frog',
+    'gamefowl',
+    'galliform',
+    'gazelle',
+    'gecko',
+    'gerbil',
+    'gibbon',
+    'giraffe',
+    'goat',
+    'goldfish',
+    'goose',
+    'gopher',
+    'gorilla',
+    'grasshopper',
+    'grouse',
+    'guan',
+    'guanaco',
+    'guineafowl',
+    'gull',
+    'guppy',
+    'haddock',
+    'halibut',
+    'hamster',
+    'hare',
+    'harrier',
+    'hawk',
+    'hedgehog',
+    'heron',
+    'herring',
+    'hippopotamus',
+    'hookworm',
+    'hornet',
+    'horse',
+    'hoverfly',
+    'hummingbird',
+    'hyena',
+    'iguana',
+    'impala',
+    'jackal',
+    'jaguar',
+    'jay',
+    'jellyfish',
+    'junglefowl',
+    'kangaroo',
+    'kingfisher',
+    'kite',
+    'kiwi',
+    'koala',
+    'koi',
+    'krill',
+    'ladybug',
+    'lamprey',
+    'landfowl',
+    'lark',
+    'leech',
+    'lemming',
+    'lemur',
+    'leopard',
+    'leopon',
+    'limpet',
+    'lion',
+    'lizard',
+    'llama',
+    'lobster',
+    'locust',
+    'loon',
+    'louse',
+    'lungfish',
+    'lynx',
+    'macaw',
+    'mackerel',
+    'magpie',
+    'mammal',
+    'manatee',
+    'mandrill',
+    'marlin',
+    'marmoset',
+    'marmot',
+    'marsupial',
+    'marten',
+    'mastodon',
+    'meadowlark',
+    'meerkat',
+    'mink',
+    'minnow',
+    'mite',
+    'mockingbird',
+    'mole',
+    'mollusk',
+    'mongoose',
+    'monkey',
+    'moose',
+    'mosquito',
+    'moth',
+    'mouse',
+    'mule',
+    'muskox',
+    'narwhal',
+    'newt',
+    'nightingale',
+    'ocelot',
+    'octopus',
+    'opossum',
+    'orangutan',
+    'orca',
+    'ostrich',
+    'otter',
+    'owl',
+    'ox',
+    'panda',
+    'panther',
+    'parakeet',
+    'parrot',
+    'parrotfish',
+    'partridge',
+    'peacock',
+    'peafowl',
+    'pelican',
+    'penguin',
+    'perch',
+    'pheasant',
+    'pig',
+    'pigeon',
+    'pike',
+    'pinniped',
+    'piranha',
+    'planarian',
+    'platypus',
+    'pony',
+    'porcupine',
+    'porpoise',
+    'possum',
+    'prawn',
+    'primate',
+    'ptarmigan',
+    'puffin',
+    'puma',
+    'python',
+    'quail',
+    'quelea',
+    'quokka',
+    'rabbit',
+    'raccoon',
+    'rat',
+    'rattlesnake',
+    'raven',
+    'reindeer',
+    'reptile',
+    'rhinoceros',
+    'roadrunner',
+    'rodent',
+    'rook',
+    'rooster',
+    'roundworm',
+    'sailfish',
+    'salamander',
+    'salmon',
+    'sawfish',
+    'scallop',
+    'scorpion',
+    'seahorse',
+    'shark',
+    'sheep',
+    'shrew',
+    'shrimp',
+    'silkworm',
+    'silverfish',
+    'skink',
+    'skunk',
+    'sloth',
+    'slug',
+    'smelt',
+    'snail',
+    'snake',
+    'snipe',
+    'sole',
+    'sparrow',
+    'spider',
+    'spoonbill',
+    'squid',
+    'squirrel',
+    'starfish',
+    'stingray',
+    'stoat',
+    'stork',
+    'sturgeon',
+    'swallow',
+    'swan',
+    'swift',
+    'swordfish',
+    'swordtail',
+    'tahr',
+    'takin',
+    'tapir',
+    'tarantula',
+    'tarsier',
+    'termite',
+    'tern',
+    'thrush',
+    'tick',
+    'tiger',
+    'tiglon',
+    'toad',
+    'tortoise',
+    'toucan',
+    'trout',
+    'tuna',
+    'turkey',
+    'turtle',
+    'tyrannosaurus',
+    'urial',
+    'vicuna',
+    'viper',
+    'vole',
+    'vulture',
+    'wallaby',
+    'walrus',
+    'wasp',
+    'warbler',
+    'weasel',
+    'whale',
+    'whippet',
+    'whitefish',
+    'wildcat',
+    'wildebeest',
+    'wildfowl',
+    'wolf',
+    'wolverine',
+    'wombat',
+    'woodpecker',
+    'worm',
+    'wren',
+    'xerinae',
+    'yak',
+    'zebra',
+    'alpaca',
+    'cat',
+    'cattle',
+    'chicken',
+    'dog',
+    'donkey',
+    'ferret',
+    'gayal',
+    'goldfish',
+    'guppy',
+    'horse',
+    'koi',
+    'llama',
+    'sheep',
+    'yak',
+    'unicorn',
+  ]

package/src/util/gitpod-cookie.ts

@@ -0,0 +1,39 @@
+/**
+ * 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 * as cookie from 'cookie';
+
+
+/**
+ * This cookie indicates whether the connected client is a Gitpod user (= "has logged in within the last year") or not.
+ * This is used by "gitpod.io" and "www.gitpod.io" to display different content/buttons.
+ */
+export const NAME = "gitpod-user";
+export const VALUE = "true";
+
+/**
+ * @param domain The domain the Gitpod installation is installed onto
+ * @returns
+ */
+export function options(domain: string): cookie.CookieSerializeOptions {
+    // Reference: https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies
+    return {
+        path: "/",                          // make sure we send the cookie to all sub-pages
+        httpOnly: false,
+        secure: false,
+        maxAge: 60 * 60 * 24 * 365,         // 1 year
+        sameSite: "lax",                    // default: true. "Lax" needed to ensure we see cookies from users that neavigate to gitpod.io from external sites
+        domain: `.${domain}`,               // explicilty include subdomains to not only cover "gitpod.io", but also "www.gitpod.io" or workspaces
+    };
+};
+
+export function generateCookie(domain: string): string {
+    return cookie.serialize(NAME, VALUE, options(domain));
+};
+
+export function isPresent(cookies: string): boolean {
+    // needs to match the old (gitpod-user=loggedIn) and new (gitpod-user=true) values to ensure a smooth transition during rollout.
+    return !!cookies.match(`${NAME}=`);
+};

package/src/util/gitpod-host-url.spec.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 * as chai from 'chai';
+import { suite, test } from 'mocha-typescript';
+import { GitpodHostUrl } from './gitpod-host-url';
+const expect = chai.expect;
+
+@suite
+export class GitpodHostUrlTest {
+
+    @test public parseWorkspaceId_pathBased() {
+        const actual = GitpodHostUrl.fromWorkspaceUrl("http://35.223.201.195/workspace/bc77e03d-c781-4235-bca0-e24087f5e472/").workspaceId;
+        expect(actual).to.equal("bc77e03d-c781-4235-bca0-e24087f5e472");
+    }
+
+    @test public parseWorkspaceId_hosts_withEnvVarsInjected() {
+        const actual = GitpodHostUrl.fromWorkspaceUrl("https://gray-grasshopper-nfbitfia.ws-eu02.gitpod-staging.com/#passedin=test%20value/https://github.com/gitpod-io/gitpod-test-repo").workspaceId;
+        expect(actual).to.equal("gray-grasshopper-nfbitfia");
+    }
+
+    @test public async testWithoutWorkspacePrefix() {
+        expect(GitpodHostUrl.fromWorkspaceUrl("https://3000-moccasin-ferret-155799b3.ws-eu02.gitpod-staging.com/").withoutWorkspacePrefix().toString()).to.equal("https://gitpod-staging.com/");
+    }
+
+    @test public async testWithoutWorkspacePrefix2() {
+        expect(GitpodHostUrl.fromWorkspaceUrl("https://gitpod-staging.com/").withoutWorkspacePrefix().toString()).to.equal("https://gitpod-staging.com/");
+    }
+
+    @test public async testWithoutWorkspacePrefix3() {
+        expect(GitpodHostUrl.fromWorkspaceUrl("https://gray-rook-5523v5d8.ws-dev.my-branch-1234.staging.gitpod-dev.com/").withoutWorkspacePrefix().toString()).to.equal("https://my-branch-1234.staging.gitpod-dev.com/");
+    }
+
+    @test public async testWithoutWorkspacePrefix4() {
+        expect(GitpodHostUrl.fromWorkspaceUrl("https://my-branch-1234.staging.gitpod-dev.com/").withoutWorkspacePrefix().toString()).to.equal("https://my-branch-1234.staging.gitpod-dev.com/");
+    }
+
+    @test public async testWithoutWorkspacePrefix5() {
+        expect(GitpodHostUrl.fromWorkspaceUrl("https://abc-nice-brunch-4224.staging.gitpod-dev.com/").withoutWorkspacePrefix().toString()).to.equal("https://abc-nice-brunch-4224.staging.gitpod-dev.com/");
+    }
+
+    @test public async testWithoutWorkspacePrefix6() {
+        expect(GitpodHostUrl.fromWorkspaceUrl("https://gray-rook-5523v5d8.ws-dev.abc-nice-brunch-4224.staging.gitpod-dev.com/").withoutWorkspacePrefix().toString()).to.equal("https://abc-nice-brunch-4224.staging.gitpod-dev.com/");
+    }
+}
+module.exports = new GitpodHostUrlTest()

package/src/util/gitpod-host-url.ts

@@ -1,5 +1,5 @@
 /**
- * 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.
  */
@@ -12,7 +12,13 @@ export interface UrlChange {
 }
 export type UrlUpdate = UrlChange | Partial<URL>;
 
-export const workspaceIDRegex = /([a-z0-9]{4,8}-)+([a-z0-9]{12})/;
+const basewoWkspaceIDRegex = "(([a-f][0-9a-f]{7}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})|([0-9a-z]{2,16}-[0-9a-z]{2,16}-[0-9a-z]{8}))";
+
+// this pattern matches v4 UUIDs as well as the new generated workspace ids (e.g. pink-panda-ns35kd21)
+const workspaceIDRegex = RegExp(`^${basewoWkspaceIDRegex}$`);
+
+// this pattern matches URL prefixes of workspaces
+const workspaceUrlPrefixRegex = RegExp(`^([0-9]{4,6}-)?${basewoWkspaceIDRegex}\\.`);
 
 export class GitpodHostUrl {
     readonly url: URL;
@@ -30,6 +36,10 @@ export class GitpodHostUrl {
         }
     }
 
+    static fromWorkspaceUrl(url: string) {
+        return new GitpodHostUrl(new URL(url));
+    }
+
     withWorkspacePrefix(workspaceId: string, region: string) {
         return this.withDomainPrefix(`${workspaceId}.ws-${region}.`);
     }
@@ -39,7 +49,7 @@ export class GitpodHostUrl {
     }
 
     withoutWorkspacePrefix(): GitpodHostUrl {
-        if (!this.url.host.match(workspaceIDRegex)) {
+        if (!this.url.host.match(workspaceUrlPrefixRegex)) {
             // URL has no workspace prefix
             return this;
         }
@@ -75,29 +85,40 @@ export class GitpodHostUrl {
     }
 
     asDashboard(): GitpodHostUrl {
-        return this.with(url => ({ pathname: '/workspaces/' }));
+        return this.with(url => ({ pathname: '/' }));
     }
 
     asLogin(): GitpodHostUrl {
-        return this.with(url => ({ pathname: '/login/' }));
+        return this.with(url => ({ pathname: '/login' }));
     }
 
     asUpgradeSubscription(): GitpodHostUrl {
-        return this.with(url => ({ pathname: '/upgrade-subscription/' }));
+        return this.with(url => ({ pathname: '/plans' }));
     }
 
     asAccessControl(): GitpodHostUrl {
-        return this.with(url => ({ pathname: '/access-control/' }));
+        return this.with(url => ({ pathname: '/integrations' }));
     }
 
     asSettings(): GitpodHostUrl {
-        return this.with(url => ({ pathname: '/settings/' }));
+        return this.with(url => ({ pathname: '/settings' }));
+    }
+
+    asPreferences(): GitpodHostUrl {
+        return this.with(url => ({ pathname: '/preferences' }));
     }
 
     asGraphQLApi(): GitpodHostUrl {
         return this.with(url => ({ pathname: '/graphql/' }));
     }
 
+    asStart(workspaceId = this.workspaceId): GitpodHostUrl {
+        return this.withoutWorkspacePrefix().with({
+            pathname: '/start/',
+            hash: '#' + workspaceId
+        });
+    }
+
     asWorkspaceAuth(instanceID: string, redirect?: boolean): GitpodHostUrl {
         return this.with(url => ({ pathname: `/api/auth/workspace-cookie/${instanceID}`, search: redirect ? "redirect" : "" }));
     }
@@ -114,18 +135,41 @@ export class GitpodHostUrl {
         return result;
     }
 
-    get workspaceId(): string | undefined {
-        const hostSegs = window.location.host.split(".");
-        if (hostSegs.length > 1 && hostSegs[0].match(workspaceIDRegex)) {
-            // URL has a workspace prefix
-            return hostSegs[0];
+    get workspaceId(): string | undefined {
+        const hostSegs = this.url.host.split(".");
+        if (hostSegs.length > 1) {
+            const matchResults = hostSegs[0].match(workspaceIDRegex);
+            if (matchResults) {
+                // URL has a workspace prefix
+                // port prefixes are excluded
+                return matchResults[0];
+            }
         }
 
-        const pathSegs = window.location.pathname.split("/")
+        const pathSegs = this.url.pathname.split("/")
         if (pathSegs.length > 3 && pathSegs[1] === "workspace") {
             return pathSegs[2];
         }
 
         return undefined;
     }
+
+    get blobServe(): boolean {
+        const hostSegments = this.url.host.split(".");
+        if (hostSegments[0] === 'blobserve') {
+            return true;
+        }
+
+        const pathSegments = this.url.pathname.split("/")
+        return pathSegments[0] === "blobserve";
+    }
+
+    asSorry(message: string) {
+        return this.with({ pathname: '/sorry', hash: message });
+    }
+
+    asApiLogout(): GitpodHostUrl {
+        return this.withApi(url => ({ pathname: '/logout/' }));
+    }
+
 }

package/src/util/grpc.ts

@@ -0,0 +1,15 @@
+/**
+ * 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 const defaultGRPCOptions = {
+    "grpc.keepalive_timeout_ms": 10000,
+    "grpc.keepalive_time_ms": 60000,
+    "grpc.http2.min_time_between_pings_ms": 10000,
+    "grpc.keepalive_permit_without_calls": 1,
+    "grpc-node.max_session_memory": 50,
+    "grpc.max_reconnect_backoff_ms": 5000,
+    "grpc.max_receive_message_length": 1024 * 1024 * 16,
+};

package/src/util/jaeger-client.d.ts

@@ -1,5 +1,5 @@
 /**
- * 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.
  */