feat(database): add unique constraint on workspace subdomain #9084
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added a unique constraint to the "subdomain" column in the workspace entity to ensure no duplicate subdomains exist in the database. Included a TypeORM migration script to enforce this change at the database level.
Added a unique constraint to the "subdomain" column in the workspace entity to ensure no duplicate subdomains exist in the database. Included a TypeORM migration script to enforce this change at the database level.
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
Added a unique constraint to the workspace subdomain field to prevent duplicate subdomains across workspaces, with database-level enforcement through TypeORM.
- Added
{ unique: true }tosubdomaincolumn in/packages/twenty-server/src/engine/core-modules/workspace/workspace.entity.ts - Created migration
/packages/twenty-server/src/database/typeorm/core/migrations/common/1734355945585-add-unique-index-on-subdomain.tsto enforce uniqueness at database level - Potential risk: Migration could fail if duplicate subdomains exist in production database
2 file(s) reviewed, 3 comment(s)
Edit PR Review Bot Settings | Greptile
Comment on lines
+147
to
148
| @Column({ unique: true }) | ||
| subdomain: string; |
There was a problem hiding this comment.
logic: No default value provided for required unique field. Could cause issues during workspace creation if subdomain is not explicitly set.
Comment on lines
+147
to
148
| @Column({ unique: true }) | ||
| subdomain: string; |
There was a problem hiding this comment.
style: Consider adding a validation decorator to enforce subdomain format (e.g., alphanumeric, no spaces).
| name = 'AddUniqueIndexOnSubdomain1734355945585' | ||
|
|
||
| public async up(queryRunner: QueryRunner): Promise<void> { | ||
| await queryRunner.query(`ALTER TABLE "core"."workspace" ADD CONSTRAINT "UQ_cba6255a24deb1fff07dd7351b8" UNIQUE ("subdomain")`); |
There was a problem hiding this comment.
style: Consider adding a NOT NULL constraint if subdomain is required, since NULL values are allowed with UNIQUE constraints
|
I'm afraid this is too late and we have to create an upgrade command to cleanup? Or are we sure the database is clean already? |
I can't check in the prod database. There are probably no duplicate subdomains. But I can add a command to be sure. |
|
Yes if you don't mind adding a command (it will be version 0.40) that's the process we usually adopt, to be safe. See upgrade-version folder. Thanks! |
Weiko
approved these changes
Dec 16, 2024
Log |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added a unique constraint to the "subdomain" column in the workspace entity to ensure no duplicate subdomains exist in the database. Included a TypeORM migration script to enforce this change at the database level.