[dashboard][server] Make all project slugs unique within a team or user account by adding a unique suffix

[jankeromnes]

Description

Make all project slugs unique within a team or user account by adding a unique suffix.

Related Issue(s)

Fixes #6600

How to test

1. Create two repositories with the same name, but under different owners (or Git providers), e.g. username/test and org/test
2. Add the two repos as Projects (either under your personal account, or a team, but both Projects should be in the same location)
3. Verify the two Projects have different slugs (e.g. the first added should have the slug test, and the second one test-1)

Release Notes

[dashboard][server] Make all project slugs unique within a team or user account by adding a unique suffix

Documentation

/uncc

[jankeromnes]

Whoops, the build is currently broken (#6876) so no deployment yet.

Will give it another kick once the build is fixed. 🙂 EDIT: ✅

[jankeromnes]

Let's try this again. 🎰

/werft run

👍 started the job as gitpod-build-jx-unique-project-slug.2

[jankeromnes]

Platform got fixed by platform team, trying again:

/werft run

👍 started the job as gitpod-build-jx-unique-project-slug.3

[JanKoehnlein]

Maybe I am paranoid here, but wouldn't it be safer against collisions the other way around:

1. Create the project
2. Read user existing projects and increment the suffix and update until unique

[jankeromnes]

Are you worried about two projects with the same name being added at the exact same time?

[JanKoehnlein]

Kind of. As the slug yields the URI, a collision would not be nice. Maybe this is not so important for projects within teams, but more likely for teams

[jankeromnes]

For teams, team creation fails if there is a collision. The code is here:

gitpod/components/gitpod-db/src/typeorm/team-db-impl.ts

Lines 125 to 144 in 5d751e3

	if (!name) {
	throw new Error('Team name cannot be empty');
	}
	if (!/^[A-Za-z0-9 '_-]+$/.test(name)) {
	throw new Error('Please choose a team name containing only letters, numbers, -, _, \', or spaces.');
	}
	const slug = name.toLocaleLowerCase().replace(/[ ']/g, '-');
	if (FORBIDDEN_SLUGS.indexOf(slug) !== -1) {
	throw new Error('Creating a team with this name is not allowed');
	}
	const userRepo = await this.getUserRepo();
	const existingUsers = await userRepo.query('SELECT COUNT(id) AS count FROM d_b_user WHERE fullName LIKE ? OR name LIKE ?', [ name, slug ]);
	if (Number.parseInt(existingUsers[0].count) > 0) {
	throw new Error('A team cannot have the same name as an existing user');
	}
	const teamRepo = await this.getTeamRepo();
	const existingTeam = await teamRepo.findOne({ slug, deleted: false, markedDeleted: false });
	if (!!existingTeam) {
	throw new Error('A team with this name already exists');
	}

[JanKoehnlein]

/lgtm

[roboquat]

LGTM label has been added.

Git tree hash: 5fb471b813e84895f049501dfb87c99e5e9ba653

[roboquat]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: JanKoehnlein

Associated issue: #6600

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• components/dashboard/OWNERS [JanKoehnlein]
• components/server/OWNERS [JanKoehnlein]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment