Skip to content

[server] use owner and repo name for workspace id #7391

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 7, 2022
Merged

[server] use owner and repo name for workspace id #7391

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions components/gitpod-protocol/src/util/generate-workspace-id.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,21 @@ const expect = chai.expect
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-'],
]
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()
21 changes: 19 additions & 2 deletions components/gitpod-protocol/src/util/generate-workspace-id.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,25 @@
*/
import randomNumber = require("random-number-csprng");

export async function generateWorkspaceID(): Promise<string> {
return (await random(colors))+'-'+(await random(animals))+'-'+(await random(characters, 8));
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;
}
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> {
Expand Down
6 changes: 3 additions & 3 deletions components/gitpod-protocol/src/util/gitpod-host-url.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ export interface UrlChange {
}
export type UrlUpdate = UrlChange | Partial<URL>;

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}))";
const baseWorkspaceIDRegex = "(([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,11}))";

// this pattern matches v4 UUIDs as well as the new generated workspace ids (e.g. pink-panda-ns35kd21)
const workspaceIDRegex = RegExp(`^${basewoWkspaceIDRegex}$`);
const workspaceIDRegex = RegExp(`^${baseWorkspaceIDRegex}$`);

// this pattern matches URL prefixes of workspaces
const workspaceUrlPrefixRegex = RegExp(`^([0-9]{4,6}-)?${basewoWkspaceIDRegex}\\.`);
const workspaceUrlPrefixRegex = RegExp(`^([0-9]{4,6}-)?${baseWorkspaceIDRegex}\\.`);

export class GitpodHostUrl {
readonly url: URL;
Expand Down
2 changes: 1 addition & 1 deletion components/gitpod-protocol/src/util/parse-workspace-id.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* See License-AGPL.txt in the project root for license information.
*/

const REGEX_WORKSPACE_ID = /[0-9a-z]{2,16}-[0-9a-z]{2,16}-[0-9a-z]{8}/;
const REGEX_WORKSPACE_ID = /[0-9a-z]{2,16}-[0-9a-z]{2,16}-[0-9a-z]{8,11}/;
const REGEX_WORKSPACE_ID_EXACT = new RegExp(`^${REGEX_WORKSPACE_ID.source}$`);
// We need to parse the workspace id precisely here to get the case '<some-str>-<port>-<wsid>.ws.' right
const REGEX_WORKSPACE_ID_FROM_HOSTNAME = new RegExp(`(${REGEX_WORKSPACE_ID.source})\.ws`);
Expand Down
2 changes: 1 addition & 1 deletion components/local-app/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ func run(origin, sshConfig string, apiPort int, allowCORSFromPort bool, autoTunn
return err
}
wsHostRegex := "(\\.[^.]+)\\." + strings.ReplaceAll(originURL.Host, ".", "\\.")
wsHostRegex = "([0-9a-f]{8}-[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})" + wsHostRegex
wsHostRegex = "([0-9a-f]{8}-[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,11})" + wsHostRegex
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it mean that existing users of VS Code desktop and local companion shuold upgrade now? Or it is backard compatible?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is not compatible. If you start a new workspace and still have an old local companion app running this logic would not match.
How is the upgrade process for local companion app going for other incompatible changes or do we never have them?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We did not do incompatible changes so far. Giving that it is in Beta state, maybe it is fine to break. For VS Code Desktop we can switch easily from the local companion as soon as SSH gateway is deployed.

if allowCORSFromPort {
wsHostRegex = "([0-9]+)-" + wsHostRegex
}
Expand Down
3 changes: 1 addition & 2 deletions components/server/ee/src/workspace/workspace-factory.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ import { LicenseEvaluator } from '@gitpod/licensor/lib';
import { Feature } from '@gitpod/licensor/lib/api';
import { ResponseError } from 'vscode-jsonrpc';
import { ErrorCodes } from '@gitpod/gitpod-protocol/lib/messaging/error';
import { generateWorkspaceID } from '@gitpod/gitpod-protocol/lib/util/generate-workspace-id';
import { HostContextProvider } from '../../../src/auth/host-context-provider';
import { RepoURL } from '../../../src/repohost';

Expand Down Expand Up @@ -220,7 +219,7 @@ export class WorkspaceFactoryEE extends WorkspaceFactory {
}
}

const id = await generateWorkspaceID();
const id = await this.generateWorkspaceID(context);
const newWs: Workspace = {
id,
type: "regular",
Expand Down
21 changes: 17 additions & 4 deletions components/server/src/workspace/workspace-factory.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,14 @@
*/

import { DBWithTracing, TracedWorkspaceDB, WorkspaceDB, ProjectDB, TeamDB } from '@gitpod/gitpod-db/lib';
import { AdditionalContentContext, CommitContext, IssueContext, PullRequestContext, Repository, SnapshotContext, User, Workspace, WorkspaceConfig, WorkspaceContext, WorkspaceProbeContext } from '@gitpod/gitpod-protocol';
import { AdditionalContentContext, CommitContext, IssueContext, PrebuiltWorkspaceContext, PullRequestContext, Repository, SnapshotContext, User, Workspace, WorkspaceConfig, WorkspaceContext, WorkspaceProbeContext } from '@gitpod/gitpod-protocol';
import { ErrorCodes } from '@gitpod/gitpod-protocol/lib/messaging/error';
import { generateWorkspaceID } from '@gitpod/gitpod-protocol/lib/util/generate-workspace-id';
import { log } from '@gitpod/gitpod-protocol/lib/util/logging';
import { TraceContext } from '@gitpod/gitpod-protocol/lib/util/tracing';
import { inject, injectable } from 'inversify';
import { ResponseError } from 'vscode-jsonrpc';
import { RepoURL } from '../repohost';
import { ConfigProvider } from './config-provider';
import { ImageSourceProvider } from './image-source-provider';

Expand Down Expand Up @@ -55,7 +56,7 @@ export class WorkspaceFactory {
// Basically we're using the raw alpine image bait-and-switch style without adding the GP layer.
const imageSource = await this.imageSourceProvider.getImageSource(ctx, user, null as any, config);

const id = await generateWorkspaceID();
const id = await this.generateWorkspaceID(context);
const date = new Date().toISOString();
const newWs: Workspace = {
id,
Expand Down Expand Up @@ -94,7 +95,7 @@ export class WorkspaceFactory {
throw new Error(`The original workspace has been deleted - cannot open this snapshot.`);
}

const id = await generateWorkspaceID();
const id = await this.generateWorkspaceID(context);
const date = new Date().toISOString();
const newWs = <Workspace>{
id,
Expand Down Expand Up @@ -169,7 +170,7 @@ export class WorkspaceFactory {
}
}

const id = await generateWorkspaceID();
const id = await this.generateWorkspaceID(context);
const newWs: Workspace = {
id,
type: "regular",
Expand Down Expand Up @@ -210,4 +211,16 @@ export class WorkspaceFactory {
return context.title;
}

protected async generateWorkspaceID(context: WorkspaceContext): Promise<string> {
let ctx = context;
if (PrebuiltWorkspaceContext.is(context)) {
ctx = context.originalContext;
}
if (CommitContext.is(ctx)) {
const parsed = RepoURL.parseRepoUrl(ctx.repository.cloneUrl);
return await generateWorkspaceID(parsed?.owner, parsed?.repo);
}
return await generateWorkspaceID();
}

}
2 changes: 1 addition & 1 deletion components/ws-proxy/pkg/proxy/workspacerouter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ const (
forwardedHostnameHeader = "x-wsproxy-host"

// This pattern matches v4 UUIDs as well as the new generated workspace ids (e.g. pink-panda-ns35kd21).
workspaceIDRegex = "(?P<" + workspaceIDIdentifier + ">[0-9a-f]{8}-[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})"
workspaceIDRegex = "(?P<" + workspaceIDIdentifier + ">[0-9a-f]{8}-[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,11})"
workspacePortRegex = "(?P<" + workspacePortIdentifier + ">[0-9]+)-"
)

Expand Down