History

Extract reusable slug collision retry helper

Rhys Sullivan committed 9 months ago

Commit ea91ac81 parent ed3e4e35 files · +36 −64Browse files

Unified · Split

5 files
  1. executor/convex/auth.ts +4 −16
  2. executor/convex/database.ts +4 −16
  3. executor/convex/lib/slug.ts +20 −0
  4. executor/convex/organizations.ts +4 −16
  5. executor/convex/workspaces.ts +4 −16
executor/convex/auth.ts+4−16
@@ -3,6 +3,7 @@ import { v } from "convex/values"; · 2 unmodified lines
33 import { components, internal } from "./_generated/api";
44 import type { DataModel, Doc, Id } from "./_generated/dataModel";
55 import { internalMutation, mutation, query } from "./_generated/server";
6+import { ensureUniqueSlug } from "./lib/slug";
67
78 const workosEnabled = Boolean(
89 process.env.WORKOS_CLIENT_ID && process.env.WORKOS_API_KEY && process.env.WORKOS_WEBHOOK_SECRET,
@@ -63,26 +64,13 @@ async function getOrganizationByWorkosOrgId(ctx: { db: any }, workosOrgId: strin · 54 unmodified lines
6364
6465 async function ensureUniqueOrganizationSlug(ctx: { db: any }, baseName: string): Promise<string> {
6566 const baseSlug = slugify(baseName);
66− const existing = await ctx.db
67− .query("organizations")
68− .withIndex("by_slug", (q: any) => q.eq("slug", baseSlug))
69− .unique();
70− if (!existing) {
71− return baseSlug;
72− }
73−
74− for (let i = 0; i < 20; i += 1) {
75− const candidate = `${baseSlug}-${crypto.randomUUID().slice(0, 6)}`;
67+ return await ensureUniqueSlug(baseSlug, async (candidate) => {
7668 const collision = await ctx.db
7769 .query("organizations")
7870 .withIndex("by_slug", (q: any) => q.eq("slug", candidate))
7971 .unique();
80− if (!collision) {
81− return candidate;
82− }
83− }
84−
85− return `${baseSlug}-${Date.now()}`;
72+ return collision !== null;
73+ });
8674 }
8775
8876 async function upsertOrganizationMembership(
executor/convex/database.ts+4−16
@@ -2,6 +2,7 @@ import { v } from "convex/values"; · 1 unmodified line
22 import type { Doc } from "./_generated/dataModel";
33 import type { MutationCtx, QueryCtx } from "./_generated/server";
44 import { mutation, query } from "./_generated/server";
5+import { ensureUniqueSlug } from "./lib/slug";
56
67 const DEFAULT_TIMEOUT_MS = 15_000;
78
@@ -30,26 +31,13 @@ function slugify(input: string): string { · 22 unmodified lines
3031
3132 async function ensureUniqueOrganizationSlug(ctx: Pick<MutationCtx, "db">, baseName: string): Promise<string> {
3233 const baseSlug = slugify(baseName);
33− const existing = await ctx.db
34− .query("organizations")
35− .withIndex("by_slug", (q) => q.eq("slug", baseSlug))
36− .unique();
37− if (!existing) {
38− return baseSlug;
39− }
40−
41− for (let i = 0; i < 20; i += 1) {
42− const candidate = `${baseSlug}-${crypto.randomUUID().slice(0, 6)}`;
34+ return await ensureUniqueSlug(baseSlug, async (candidate) => {
4335 const collision = await ctx.db
4436 .query("organizations")
4537 .withIndex("by_slug", (q) => q.eq("slug", candidate))
4638 .unique();
47− if (!collision) {
48− return candidate;
49− }
50− }
51−
52− return `${baseSlug}-${Date.now()}`;
39+ return collision !== null;
40+ });
5341 }
5442
5543 async function upsertOrganizationMembership(
executor/convex/lib/slug.ts+20−0
@@ -0,0 +1,20 @@
1+const DEFAULT_MAX_RANDOM_SLUG_ATTEMPTS = 20;
2+
3+export async function ensureUniqueSlug(
4+ baseSlug: string,
5+ hasCollision: (candidate: string) => Promise<boolean>,
6+ maxRandomAttempts = DEFAULT_MAX_RANDOM_SLUG_ATTEMPTS,
7+): Promise<string> {
8+ if (!(await hasCollision(baseSlug))) {
9+ return baseSlug;
10+ }
11+
12+ for (let attempt = 0; attempt < maxRandomAttempts; attempt += 1) {
13+ const candidate = `${baseSlug}-${crypto.randomUUID().slice(0, 6)}`;
14+ if (!(await hasCollision(candidate))) {
15+ return candidate;
16+ }
17+ }
18+
19+ return `${baseSlug}-${Date.now()}`;
20+}
executor/convex/organizations.ts+4−16
@@ -3,6 +3,7 @@ import type { Doc, Id } from "./_generated/dataModel"; · 2 unmodified lines
33 import type { MutationCtx, QueryCtx } from "./_generated/server";
44 import { optionalAccountQuery, authedMutation } from "./lib/functionBuilders";
55 import { getOrganizationMembership, slugify } from "./lib/identity";
6+import { ensureUniqueSlug } from "./lib/slug";
67
78 type WorkspaceSummary = {
89 id: Id<"workspaces">;
@@ -16,26 +17,13 @@ type WorkspaceSummary = { · 7 unmodified lines
1617
1718 async function ensureUniqueOrganizationSlug(ctx: Pick<MutationCtx, "db">, baseName: string): Promise<string> {
1819 const baseSlug = slugify(baseName);
19− const existing = await ctx.db
20− .query("organizations")
21− .withIndex("by_slug", (q) => q.eq("slug", baseSlug))
22− .unique();
23− if (!existing) {
24− return baseSlug;
25− }
26−
27− for (let i = 0; i < 20; i += 1) {
28− const candidate = `${baseSlug}-${crypto.randomUUID().slice(0, 6)}`;
20+ return await ensureUniqueSlug(baseSlug, async (candidate) => {
2921 const collision = await ctx.db
3022 .query("organizations")
3123 .withIndex("by_slug", (q) => q.eq("slug", candidate))
3224 .unique();
33− if (!collision) {
34− return candidate;
35− }
36− }
37−
38− return `${baseSlug}-${Date.now()}`;
25+ return collision !== null;
26+ });
3927 }
4028
4129 async function mapWorkspaceWithIcon(
executor/convex/workspaces.ts+4−16
@@ -3,6 +3,7 @@ import type { Doc, Id } from "./_generated/dataModel"; · 2 unmodified lines
33 import type { MutationCtx, QueryCtx } from "./_generated/server";
44 import { optionalAccountQuery, authedMutation } from "./lib/functionBuilders";
55 import { getOrganizationMembership, slugify } from "./lib/identity";
6+import { ensureUniqueSlug } from "./lib/slug";
67
78 type WorkspaceResult = {
89 id: Id<"workspaces">;
@@ -21,26 +22,13 @@ async function ensureUniqueWorkspaceSlug( · 12 unmodified lines
2122 baseName: string,
2223 ): Promise<string> {
2324 const baseSlug = slugify(baseName);
24− const existing = await ctx.db
25− .query("workspaces")
26− .withIndex("by_organization_slug", (q) => q.eq("organizationId", organizationId).eq("slug", baseSlug))
27− .unique();
28− if (!existing) {
29− return baseSlug;
30− }
31−
32− for (let i = 0; i < 20; i += 1) {
33− const candidate = `${baseSlug}-${crypto.randomUUID().slice(0, 6)}`;
25+ return await ensureUniqueSlug(baseSlug, async (candidate) => {
3426 const collision = await ctx.db
3527 .query("workspaces")
3628 .withIndex("by_organization_slug", (q) => q.eq("organizationId", organizationId).eq("slug", candidate))
3729 .unique();
38− if (!collision) {
39− return candidate;
40− }
41− }
42−
43− return `${baseSlug}-${Date.now()}`;
30+ return collision !== null;
31+ });
4432 }
4533
4634 async function toWorkspaceResult(

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t