feat(auth): Migrate auth module to DML (#10387)

* feat(auth): Migrate auth module to DML

* Create lazy-eagles-bow.md

.changeset/lazy-eagles-bow.md

@@ -0,0 +1,5 @@
+---
+"@medusajs/auth": minor
+---
+
+feat(auth): Migrate auth module to DML

packages/modules/auth/src/migrations/.snapshot-medusa-auth.json

@@ -1,5 +1,7 @@
 {
-  "namespaces": ["public"],
+  "namespaces": [
+    "public"
+  ],
   "name": "public",
   "tables": [
     {
@@ -43,14 +45,34 @@
           "length": 6,
           "default": "now()",
           "mappedType": "datetime"
+        },
+        "deleted_at": {
+          "name": "deleted_at",
+          "type": "timestamptz",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "length": 6,
+          "mappedType": "datetime"
         }
       },
       "name": "auth_identity",
       "schema": "public",
       "indexes": [
+        {
+          "keyName": "IDX_auth_identity_deleted_at",
+          "columnNames": [],
+          "composite": false,
+          "primary": false,
+          "unique": false,
+          "expression": "CREATE INDEX IF NOT EXISTS \"IDX_auth_identity_deleted_at\" ON \"auth_identity\" (deleted_at) WHERE deleted_at IS NULL"
+        },
         {
           "keyName": "auth_identity_pkey",
-          "columnNames": ["id"],
+          "columnNames": [
+            "id"
+          ],
           "composite": false,
           "primary": true,
           "unique": true
@@ -136,6 +158,16 @@
           "length": 6,
           "default": "now()",
           "mappedType": "datetime"
+        },
+        "deleted_at": {
+          "name": "deleted_at",
+          "type": "timestamptz",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "length": 6,
+          "mappedType": "datetime"
         }
       },
       "name": "provider_identity",
@@ -147,7 +179,15 @@
           "composite": false,
           "primary": false,
           "unique": false,
-          "expression": "CREATE INDEX IF NOT EXISTS \"IDX_provider_identity_auth_identity_id\" ON \"provider_identity\" (auth_identity_id)"
+          "expression": "CREATE INDEX IF NOT EXISTS \"IDX_provider_identity_auth_identity_id\" ON \"provider_identity\" (auth_identity_id) WHERE deleted_at IS NULL"
+        },
+        {
+          "keyName": "IDX_provider_identity_deleted_at",
+          "columnNames": [],
+          "composite": false,
+          "primary": false,
+          "unique": false,
+          "expression": "CREATE INDEX IF NOT EXISTS \"IDX_provider_identity_deleted_at\" ON \"provider_identity\" (deleted_at) WHERE deleted_at IS NULL"
         },
         {
           "keyName": "IDX_provider_identity_provider_entity_id",
@@ -155,11 +195,13 @@
           "composite": false,
           "primary": false,
           "unique": false,
-          "expression": "CREATE UNIQUE INDEX IF NOT EXISTS \"IDX_provider_identity_provider_entity_id\" ON \"provider_identity\" (entity_id, provider)"
+          "expression": "CREATE UNIQUE INDEX IF NOT EXISTS \"IDX_provider_identity_provider_entity_id\" ON \"provider_identity\" (entity_id, provider) WHERE deleted_at IS NULL"
         },
         {
           "keyName": "provider_identity_pkey",
-          "columnNames": ["id"],
+          "columnNames": [
+            "id"
+          ],
           "composite": false,
           "primary": true,
           "unique": true
@@ -169,9 +211,13 @@
       "foreignKeys": {
         "provider_identity_auth_identity_id_foreign": {
           "constraintName": "provider_identity_auth_identity_id_foreign",
-          "columnNames": ["auth_identity_id"],
+          "columnNames": [
+            "auth_identity_id"
+          ],
           "localTableName": "public.provider_identity",
-          "referencedColumnNames": ["id"],
+          "referencedColumnNames": [
+            "id"
+          ],
           "referencedTableName": "public.auth_identity",
           "deleteRule": "cascade",
           "updateRule": "cascade"

packages/modules/auth/src/migrations/Migration20241202100304.ts

@@ -0,0 +1,31 @@
+import { Migration } from "@mikro-orm/migrations"
+
+export class Migration20241202100304 extends Migration {
+  async up(): Promise<void> {
+    this.addSql(
+      'alter table if exists "auth_identity" add column if not exists "deleted_at" timestamptz null;'
+    )
+    this.addSql(
+      'CREATE INDEX IF NOT EXISTS "IDX_auth_identity_deleted_at" ON "auth_identity" (deleted_at) WHERE deleted_at IS NULL;'
+    )
+
+    this.addSql(
+      'alter table if exists "provider_identity" add column if not exists "deleted_at" timestamptz null;'
+    )
+    this.addSql(
+      'CREATE INDEX IF NOT EXISTS "IDX_provider_identity_deleted_at" ON "provider_identity" (deleted_at) WHERE deleted_at IS NULL;'
+    )
+  }
+
+  async down(): Promise<void> {
+    this.addSql('drop index if exists "IDX_auth_identity_deleted_at";')
+    this.addSql(
+      'alter table if exists "auth_identity" drop column if exists "deleted_at";'
+    )
+
+    this.addSql('drop index if exists "IDX_provider_identity_deleted_at";')
+    this.addSql(
+      'alter table if exists "provider_identity" drop column if exists "deleted_at";'
+    )
+  }
+}

packages/modules/auth/src/models/auth-identity.ts

@@ -1,45 +1,14 @@
-import {
+import { model } from "@medusajs/framework/utils"
-  BeforeCreate,
+import { ProviderIdentity } from "./provider-identity"
-  Collection,
-  Entity,
-  OneToMany,
-  OnInit,
-  PrimaryKey,
-  Property,
-} from "@mikro-orm/core"
 
-import { generateEntityId } from "@medusajs/framework/utils"
+export const AuthIdentity = model
-import ProviderIdentity from "./provider-identity"
+  .define("auth_identity", {
-
+    id: model.id({ prefix: "authid" }).primaryKey(),
-@Entity()
+    provider_identities: model.hasMany(() => ProviderIdentity, {
-export default class AuthIdentity {
+      mappedBy: "auth_identity",
-  @PrimaryKey({ columnType: "text" })
+    }),
-  id!: string
+    app_metadata: model.json().nullable(),
-
-  @OneToMany(() => ProviderIdentity, (o) => o.auth_identity)
-  provider_identities = new Collection<ProviderIdentity>(this)
-
-  @Property({ columnType: "jsonb", nullable: true })
-  app_metadata: Record<string, unknown> | null
-
-  @Property({
-    onCreate: () => new Date(),
-    columnType: "timestamptz",
-    defaultRaw: "now()",
   })
-  created_at: Date
+  .cascades({
-
+    delete: ["provider_identities"],
-  @Property({
-    onCreate: () => new Date(),
-    onUpdate: () => new Date(),
-    columnType: "timestamptz",
-    defaultRaw: "now()",
   })
-  updated_at: Date
-
-  @BeforeCreate()
-  @OnInit()
-  onCreate() {
-    this.id = generateEntityId(this.id, "authid")
-  }
-}

packages/modules/auth/src/models/index.ts

@@ -1,2 +1,2 @@
-export { default as AuthIdentity } from "./auth-identity"
+export { AuthIdentity } from "./auth-identity"
-export { default as ProviderIdentity } from "./provider-identity"
+export { ProviderIdentity } from "./provider-identity"

packages/modules/auth/src/models/provider-identity.ts

@@ -1,85 +1,21 @@
-import {
+import { model } from "@medusajs/framework/utils"
-  BeforeCreate,
+import { AuthIdentity } from "./auth-identity"
-  Entity,
-  ManyToOne,
-  OnInit,
-  PrimaryKey,
-  Property,
-  Rel,
-} from "@mikro-orm/core"
 
-import {
+export const ProviderIdentity = model
-  createPsqlIndexStatementHelper,
+  .define("provider_identity", {
-  generateEntityId,
+    id: model.id().primaryKey(),
-} from "@medusajs/framework/utils"
+    entity_id: model.text(),
-import AuthIdentity from "./auth-identity"
+    provider: model.text(),
-
+    auth_identity: model.belongsTo(() => AuthIdentity, {
-const providerEntityIdIndexName = "IDX_provider_identity_provider_entity_id"
+      mappedBy: "provider_identities",
-const providerEntityIdIndexStatement = createPsqlIndexStatementHelper({
+    }),
-  name: providerEntityIdIndexName,
+    user_metadata: model.json().nullable(),
-  tableName: "provider_identity",
+    provider_metadata: model.json().nullable(),
-  columns: ["entity_id", "provider"],
+  })
+  .indexes([
+    {
+      name: "IDX_provider_identity_provider_entity_id",
+      on: ["entity_id", "provider"],
       unique: true,
-})
+    },
-
+  ])
-const authIdentityIndexName = "IDX_provider_identity_auth_identity_id"
-const authIdentityIndexStatement = createPsqlIndexStatementHelper({
-  name: authIdentityIndexName,
-  tableName: "provider_identity",
-  columns: ["auth_identity_id"],
-})
-
-@Entity()
-@providerEntityIdIndexStatement.MikroORMIndex()
-@authIdentityIndexStatement.MikroORMIndex()
-export default class ProviderIdentity {
-  @PrimaryKey({ columnType: "text" })
-  id!: string
-
-  @Property({ columnType: "text" })
-  entity_id: string
-
-  @Property({ columnType: "text" })
-  provider: string
-
-  @ManyToOne(() => AuthIdentity, {
-    columnType: "text",
-    fieldName: "auth_identity_id",
-    mapToPk: true,
-    onDelete: "cascade",
-  })
-  auth_identity_id: string
-
-  @ManyToOne(() => AuthIdentity, {
-    persist: false,
-  })
-  auth_identity: Rel<AuthIdentity>
-
-  @Property({ columnType: "jsonb", nullable: true })
-  user_metadata: Record<string, unknown> | null
-
-  @Property({ columnType: "jsonb", nullable: true })
-  provider_metadata: Record<string, unknown> | null = null
-
-  @Property({
-    onCreate: () => new Date(),
-    columnType: "timestamptz",
-    defaultRaw: "now()",
-  })
-  created_at: Date
-
-  @Property({
-    onCreate: () => new Date(),
-    onUpdate: () => new Date(),
-    columnType: "timestamptz",
-    defaultRaw: "now()",
-  })
-  updated_at: Date
-
-  @BeforeCreate()
-  @OnInit()
-  onCreate() {
-    this.id = generateEntityId(this.id, "provid")
-    this.auth_identity_id ??= this.auth_identity?.id ?? null
-  }
-}

packages/modules/auth/src/services/auth-module.ts

@@ -5,6 +5,7 @@ import {
   AuthTypes,
   Context,
   DAL,
+  InferEntityType,
   InternalModuleDeclaration,
   Logger,
   ModuleJoinerConfig,
@@ -35,8 +36,12 @@ export default class AuthModuleService
   implements AuthTypes.IAuthModuleService
 {
   protected baseRepository_: DAL.RepositoryService
-  protected authIdentityService_: ModulesSdkTypes.IMedusaInternalService<AuthIdentity>
+  protected authIdentityService_: ModulesSdkTypes.IMedusaInternalService<
-  protected providerIdentityService_: ModulesSdkTypes.IMedusaInternalService<ProviderIdentity>
+    InferEntityType<typeof AuthIdentity>
+  >
+  protected providerIdentityService_: ModulesSdkTypes.IMedusaInternalService<
+    InferEntityType<typeof ProviderIdentity>
+  >
   protected readonly authProviderService_: AuthProviderService
 
   constructor(