@gitpod/gitpod-protocol 0.1.5-v0.6.0-beta4 → 0.1.5-vn-6525.75

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

@@ -0,0 +1,51 @@
+/**
+ * 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 { generateWorkspaceID, colors, animals } from "./generate-workspace-id";
+import { GitpodHostUrl } from "./gitpod-host-url";
+
+const expect = chai.expect;
+
+@suite
+class TestGenerateWorkspaceId {
+    @test public async testGenerateWorkspaceId() {
+        for (let i = 0; i < 100; i++) {
+            const id = await generateWorkspaceID();
+            expect(new GitpodHostUrl().withWorkspacePrefix(id, "eu").workspaceId).to.equal(id);
+        }
+    }
+
+    @test public testLongestName() {
+        const longestColor = colors.sort((a, b) => b.length - a.length)[0];
+        const longestAnimal = animals.sort((a, b) => b.length - a.length)[0];
+        const longestName = `${longestColor}-${longestAnimal}-12345678`;
+        expect(longestName.length <= 36, `"${longestName}" is longer than 36 chars (${longestName.length})`).to.be.true;
+    }
+
+    @test public async testCustomName() {
+        const data = [
+            ["foo", "bar", "foo-bar-"],
+            ["f", "bar", ".{2,16}-bar-"],
+            ["gitpod-io", "gitpod", "gitpodio-gitpod-"],
+            [
+                'this is rather long and has some "§$"% special chars',
+                "also here pretty long and needs abbreviation",
+                "thisisratherlon-alsohere-",
+            ],
+            ["breatheco-de", "python-flask-api-tutorial", "breathecode-pythonflaska-"],
+            ["UPPER", "CaSe", "upper-case-"],
+        ];
+        for (const d of data) {
+            const id = await generateWorkspaceID(d[0], d[1]);
+            expect(id).match(new RegExp("^" + d[2]));
+            expect(new GitpodHostUrl().withWorkspacePrefix(id, "eu").workspaceId).to.equal(id);
+            expect(id.length <= 36, `"${id}" is longer than 36 chars (${id.length})`).to.be.true;
+        }
+    }
+}
+module.exports = new TestGenerateWorkspaceId();

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

@@ -0,0 +1,475 @@
+/**
+ * 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(firstSegment?: string, secondSegment?: string): Promise<string> {
+    const firstSeg = clean(firstSegment) || (await random(colors));
+    const secSeg = clean(secondSegment, Math.min(15, 23 - firstSeg.length)) || (await random(animals));
+    return firstSeg + "-" + secSeg + "-" + (await random(characters, 11));
+}
+
+function clean(segment: string | undefined, maxChars: number = 15) {
+    if (!segment) {
+        return undefined;
+    }
+    segment = segment.toLowerCase();
+    let result = "";
+    for (let i = 0; i < segment.length; i++) {
+        if (characters.indexOf(segment[i]) !== -1) {
+            result += segment[i];
+        }
+    }
+    if (result.length >= 2) {
+        return result.substring(0, maxChars);
+    }
+}
+
+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,38 @@
+/**
+ * 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

@@ -1,20 +1,76 @@
 /**
- * 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 * as chai from 'chai';
-import { suite, test } from 'mocha-typescript';
-import { GitpodHostUrl } from './gitpod-host-url';
+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;
+        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()
+module.exports = new GitpodHostUrlTest();