Add the 3 system agents to seeds & create repositories

Author: CarsonF

dbschema/seeds/000.system-agents.ts

@@ -0,0 +1,27 @@
+import type { SeedFn } from '~/core/edgedb/seeds.run';
+
+const agents = [
+  { name: 'Ghost' },
+  { name: 'Anonymous' },
+  { name: 'External Mailing Group', roles: ['Leadership'] },
+];
+
+export default (async function ({ runAndPrint }) {
+  await runAndPrint(
+    `
+      with
+      agentsJson := json_array_unpack(<json>$agentsJson),
+      newAgents := (select agentsJson filter <str>agentsJson['name'] not in SystemAgent.name),
+      added := (
+        for entry in newAgents union (
+        insert SystemAgent {
+          name := <str>entry['name'],
+          roles := <str>json_array_unpack(json_get(entry, 'roles'))
+        })
+      )
+      select { \`Added System Agents\` := added.name }
+      filter count(added) > 0;
+    `,
+    { agentsJson: agents },
+  );
+} satisfies SeedFn);

src/components/user/actor.edgedb.repository.ts

@@ -0,0 +1,26 @@
+import { Injectable } from '@nestjs/common';
+import { Role } from '~/common';
+import { disableAccessPolicies, EdgeDB, edgeql } from '~/core/edgedb';
+import { ActorRepository } from './actor.repository';
+
+@Injectable()
+export class ActorEdgeDBRepository extends ActorRepository {
+  private readonly db: EdgeDB;
+  constructor(edgedb: EdgeDB) {
+    super();
+    this.db = edgedb.withOptions(disableAccessPolicies);
+  }
+
+  protected async upsertAgent(name: string, roles?: readonly Role[]) {
+    const query = edgeql(`
+      select (
+        (select SystemAgent filter .name = <str>$name) ??
+        (insert SystemAgent {
+          name := <str>$name,
+          roles := array_unpack(<optional array<Role>>$roles)
+        })
+      ) {*}
+    `);
+    return await this.db.run(query, { name, roles });
+  }
+}

src/components/user/actor.neo4j.repository.ts

@@ -0,0 +1,31 @@
+import { Injectable } from '@nestjs/common';
+import { node } from 'cypher-query-builder';
+import { ID, Role } from '~/common';
+import { DatabaseService } from '~/core';
+import { ActorRepository } from './actor.repository';
+
+@Injectable()
+export class ActorNeo4jRepository extends ActorRepository {
+  constructor(private readonly db: DatabaseService) {
+    super();
+  }
+
+  protected async upsertAgent(name: string, roles?: readonly Role[]) {
+    const res = await this.db
+      .query()
+      .merge(node('agent', 'SystemAgent', { name }))
+      .onCreate.set({
+        variables: {
+          'agent.id': 'apoc.create.uuid()',
+        },
+        values: {
+          'agent.roles': roles ?? [],
+        },
+      })
+      .return<{ agent: { id: ID; name: string; roles: readonly Role[] } }>(
+        'apoc.convert.toMap(agent) AS agent',
+      )
+      .first();
+    return res!.agent;
+  }
+}

src/components/user/actor.repository.ts

@@ -0,0 +1,26 @@
+import { Injectable } from '@nestjs/common';
+import { CachedByArg } from '@seedcompany/common';
+import { ID, Role } from '~/common';
+
+@Injectable()
+export abstract class ActorRepository {
+  @CachedByArg()
+  async getAnonymous() {
+    return await this.upsertAgent('Anonymous');
+  }
+
+  @CachedByArg()
+  async getGhost() {
+    return await this.upsertAgent('Ghost');
+  }
+
+  @CachedByArg()
+  async getExternalMailingGroup() {
+    return await this.upsertAgent('External Mailing Group', ['Leadership']);
+  }
+
+  protected abstract upsertAgent(
+    name: string,
+    roles?: readonly Role[],
+  ): Promise<{ id: ID; name: string; roles: readonly Role[] }>;
+}

src/components/user/user.module.ts

@@ -7,6 +7,9 @@ import { LocationModule } from '../location/location.module';
 import { OrganizationModule } from '../organization/organization.module';
 import { PartnerModule } from '../partner/partner.module';
 import { TimeZoneModule } from '../timezone';
+import { ActorEdgeDBRepository } from './actor.edgedb.repository';
+import { ActorNeo4jRepository } from './actor.neo4j.repository';
+import { ActorRepository } from './actor.repository';
 import { AssignableRolesResolver } from './assignable-roles.resolver';
 import { EducationModule } from './education/education.module';
 import { KnownLanguageRepository } from './known-language.repository';
@@ -38,7 +41,17 @@ import { UserService } from './user.service';
     UserService,
     splitDb(UserRepository, UserEdgeDBRepository),
     KnownLanguageRepository,
+    {
+      ...splitDb(ActorNeo4jRepository, ActorEdgeDBRepository),
+      provide: ActorRepository,
+    },
+  ],
+  exports: [
+    UserService,
+    UserRepository,
+    ActorRepository,
+    EducationModule,
+    UnavailabilityModule,
   ],
-  exports: [UserService, UserRepository, EducationModule, UnavailabilityModule],
 })
 export class UserModule {}

src/core/database/split-db.provider.ts

@@ -6,12 +6,13 @@ import { ConfigService } from '../config/config.service';
 export const splitDb = <T>(
   neo4jRepository: Type<T>,
   edgeDbRepository: Type<PublicOf<T>>,
-): Provider => ({
-  provide: neo4jRepository,
-  inject: [ModuleRef, ConfigService],
-  useFactory: async (moduleRef: ModuleRef, config: ConfigService) => {
-    const cls =
-      config.databaseEngine === 'edgedb' ? edgeDbRepository : neo4jRepository;
-    return await moduleRef.create<T>(cls);
-  },
-});
+) =>
+  ({
+    provide: neo4jRepository,
+    inject: [ModuleRef, ConfigService],
+    useFactory: async (moduleRef: ModuleRef, config: ConfigService) => {
+      const cls =
+        config.databaseEngine === 'edgedb' ? edgeDbRepository : neo4jRepository;
+      return await moduleRef.create<T>(cls);
+    },
+  } satisfies Provider);