Introduce sId on User and MembershipInvitation (#4561)

* Introduce sId on User and MembershipInvitation

* lint

* imports

Author: spolu

front/lib/api/invitation.ts

@@ -11,6 +11,7 @@ import { sign } from "jsonwebtoken";
 import config from "@app/lib/api/config";
 import type { Authenticator } from "@app/lib/auth";
 import { MembershipInvitation } from "@app/lib/models";
+import { generateModelSId } from "@app/lib/utils";
 
 sgMail.setApiKey(config.getSendgridApiKey());
 
@@ -48,6 +49,7 @@ export async function updateOrCreateInvitation(
 
   return typeFromModel(
     await MembershipInvitation.create({
+      sId: generateModelSId(),
       workspaceId: owner.id,
       inviteEmail: sanitizeString(inviteEmail),
       status: "pending",

front/lib/iam/users.ts

@@ -6,6 +6,7 @@ import { trackSignup } from "@app/lib/amplitude/node";
 import type { ExternalUser, SessionWithUser } from "@app/lib/iam/provider";
 import { User } from "@app/lib/models/user";
 import { guessFirstandLastNameFromFullName } from "@app/lib/user";
+import { generateModelSId } from "@app/lib/utils";
 
 interface LegacyProviderInfo {
   provider: UserProviderType;
@@ -130,6 +131,7 @@ export async function createOrUpdateUser(
     );
 
     const u = await User.create({
+      sId: generateModelSId(),
       auth0Sub: externalUser.sub,
       provider: mapAuth0ProviderToLegacy(session)?.provider,
       username: externalUser.nickname,

front/lib/models/user.ts

@@ -17,6 +17,7 @@ export class User extends Model<
   declare createdAt: CreationOptional<Date>;
   declare updatedAt: CreationOptional<Date>;
 
+  declare sId: string;
   declare auth0Sub: string | null;
   declare provider: UserProviderType;
   declare providerId: string | null;
@@ -47,6 +48,10 @@ User.init(
       allowNull: false,
       defaultValue: DataTypes.NOW,
     },
+    sId: {
+      type: DataTypes.STRING,
+      allowNull: true,
+    },
     provider: {
       type: DataTypes.STRING,
       allowNull: true,
@@ -97,6 +102,7 @@ User.init(
       { fields: ["username"] },
       { fields: ["provider", "providerId"] },
       { fields: ["auth0Sub"], unique: true, concurrently: true },
+      { unique: true, fields: ["sId"] },
     ],
   }
 );

front/lib/models/workspace.ts

@@ -135,6 +135,7 @@ export class MembershipInvitation extends Model<
   declare createdAt: CreationOptional<Date>;
   declare updatedAt: CreationOptional<Date>;
 
+  declare sId: string;
   declare inviteEmail: string;
   declare status: "pending" | "consumed" | "revoked";
   declare initialRole: Exclude<RoleType, "none">;
@@ -159,6 +160,10 @@ MembershipInvitation.init(
       allowNull: false,
       defaultValue: DataTypes.NOW,
     },
+    sId: {
+      type: DataTypes.STRING,
+      allowNull: true,
+    },
     inviteEmail: {
       type: DataTypes.STRING,
       allowNull: false,
@@ -184,7 +189,10 @@ MembershipInvitation.init(
   {
     modelName: "membership_invitation",
     sequelize: frontSequelize,
-    indexes: [{ fields: ["workspaceId", "status"] }],
+    indexes: [
+      { fields: ["workspaceId", "status"] },
+      { unique: true, fields: ["sId"] },
+    ],
   }
 );
 Workspace.hasMany(MembershipInvitation, {

front/migrations/20240404_backfill_users_and_invitations_sid.ts

@@ -0,0 +1,63 @@
+import { MembershipInvitation, User } from "@app/lib/models";
+import { generateModelSId } from "@app/lib/utils";
+import logger from "@app/logger/logger";
+import { makeScript } from "@app/scripts/helpers";
+
+const backfillUsers = async (execute: boolean) => {
+  const users = await User.findAll({});
+
+  const chunks: User[][] = [];
+  for (let i = 0; i < users.length; i += 16) {
+    chunks.push(users.slice(i, i + 16));
+  }
+
+  for (let i = 0; i < chunks.length; i++) {
+    const chunk = chunks[i];
+    await Promise.all(
+      chunk.map((u) => {
+        return (async () => {
+          const sId = generateModelSId();
+          logger.info(
+            `Backfilling user ${u.id} with \`sId=${sId}\` [execute: ${execute}]`
+          );
+
+          if (execute) {
+            await u.update({ sId });
+          }
+        })();
+      })
+    );
+  }
+};
+
+const backfillInvitations = async (execute: boolean) => {
+  const invitations = await MembershipInvitation.findAll({});
+
+  const chunks: MembershipInvitation[][] = [];
+  for (let i = 0; i < invitations.length; i += 16) {
+    chunks.push(invitations.slice(i, i + 16));
+  }
+
+  for (let i = 0; i < chunks.length; i++) {
+    const chunk = chunks[i];
+    await Promise.all(
+      chunk.map((i) => {
+        return (async () => {
+          const sId = generateModelSId();
+          logger.info(
+            `Backfilling invitation ${i.id} with \`sId=${sId}\` [execute: ${execute}]`
+          );
+
+          if (execute) {
+            await i.update({ sId });
+          }
+        })();
+      })
+    );
+  }
+};
+
+makeScript({}, async ({ execute }) => {
+  await backfillUsers(execute);
+  await backfillInvitations(execute);
+});