Apply sane defaults for insert & hydrate for EdgeDB to reduce boilerplate in the concrete strategies

Author: CarsonF

src/components/comments/mention-notification/comment-via-mention-notification.strategy.ts

@@ -1,6 +1,5 @@
 import { node, Query, relation } from 'cypher-query-builder';
 import { createRelationships, exp } from '~/core/database/query';
-import { e } from '~/core/edgedb';
 import {
   INotificationStrategy,
   InputOf,
@@ -19,12 +18,6 @@ export class CommentViaMentionNotificationStrategy extends INotificationStrategy
       );
   }
 
-  insertForEdgeDB(input: InputOf<Mentioned>) {
-    return e.insert(e.Notification.CommentMentioned, {
-      comment: e.cast(e.Comments.Comment, e.uuid(input.comment)),
-    });
-  }
-
   hydrateExtraForNeo4j(outVar: string) {
     return (query: Query) =>
       query
@@ -39,10 +32,4 @@ export class CommentViaMentionNotificationStrategy extends INotificationStrategy
           }).as(outVar),
         );
   }
-
-  hydrateExtraForEdgeDB() {
-    return e.is(e.Notification.CommentMentioned, {
-      comment: true,
-    });
-  }
 }

src/components/notification-system/system-notification.strategy.ts

@@ -13,16 +13,4 @@ export class SystemNotificationStrategy extends INotificationStrategy<SystemNoti
   recipientsForEdgeDB() {
     return e.User; // all users
   }
-
-  insertForEdgeDB(input: SystemNotification) {
-    return e.insert(e.Notification.System, {
-      message: input.message,
-    });
-  }
-
-  hydrateExtraForEdgeDB() {
-    return e.is(e.Notification.System, {
-      message: true,
-    });
-  }
 }

src/components/notifications/notification.edgedb.repository.ts

@@ -1,7 +1,8 @@
 import { forwardRef, Inject, Injectable } from '@nestjs/common';
-import { Nil } from '@seedcompany/common';
-import { ID, PublicOf, ResourceShape } from '~/common';
+import { mapValues, Nil, setOf } from '@seedcompany/common';
+import { EnhancedResource, ID, PublicOf, ResourceShape } from '~/common';
 import { e, RepoFor, ScopeOf } from '~/core/edgedb';
+import { mapToSetBlock } from '~/core/edgedb/query-util/map-to-set-block';
 import {
   MarkNotificationReadArgs,
   Notification,
@@ -31,17 +32,30 @@ export class NotificationRepository
   async onModuleInit() {
     await this.service.ready.wait();
 
-    (this as any).hydrate = e.shape(e.Notification, (notification) => {
-      return Object.assign(
-        {
-          __typename: notification.__type__.name,
-        },
-        notification['*'],
-        ...[...this.service.strategyMap.values()].flatMap(
-          (strategy) => strategy.hydrateExtraForEdgeDB() ?? [],
-        ),
-      );
-    });
+    const basePointers = setOf(
+      Object.keys(this.resource.db.__element__.__pointers__),
+    );
+    const hydrateConcretes = Object.assign(
+      {},
+      ...[...this.service.strategyMap].flatMap(([type, strategy]) => {
+        if (strategy.hydrateExtraForEdgeDB) {
+          return strategy.hydrateExtraForEdgeDB();
+        }
+        const dbType = EnhancedResource.of(type as typeof Notification).db;
+        const ownPointers = Object.keys(dbType.__element__.__pointers__).filter(
+          (p) => !p.startsWith('<') && !basePointers.has(p),
+        );
+        return e.is(
+          dbType,
+          mapValues.fromList(ownPointers, () => true).asRecord,
+        );
+      }),
+    );
+    (this as any).hydrate = e.shape(e.Notification, (notification) => ({
+      __typename: notification.__type__.name,
+      ...notification['*'],
+      ...hydrateConcretes,
+    }));
   }
 
   async create(
@@ -51,7 +65,10 @@ export class NotificationRepository
   ) {
     const strategy = this.service.getStrategy(type);
 
-    const created = strategy.insertForEdgeDB(input);
+    const dbType = EnhancedResource.of(type as typeof Notification).db;
+    const created =
+      strategy.insertForEdgeDB?.(input) ??
+      e.insert(dbType, mapToSetBlock(dbType, input, false));
 
     const recipientsQuery = recipients
       ? e.cast(e.User, e.cast(e.uuid, e.set(...recipients)))

src/components/notifications/notification.strategy.ts

@@ -43,7 +43,19 @@ export abstract class INotificationStrategy<
     return (query: Query) => query.setValues({ node: input }, true);
   }
 
-  abstract insertForEdgeDB(
+  hydrateExtraForNeo4j(outVar: string): QueryFragment | undefined {
+    const _used = outVar;
+    return undefined;
+  }
+}
+
+/* eslint-disable @typescript-eslint/method-signature-style */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export interface INotificationStrategy<
+  TNotification extends Notification,
+  TInput = InputOf<TNotification>,
+> {
+  insertForEdgeDB?(
     input: TInput,
   ): $.Expression<
     $.TypeSet<
@@ -52,10 +64,5 @@ export abstract class INotificationStrategy<
     >
   >;
 
-  hydrateExtraForNeo4j(outVar: string): QueryFragment | undefined {
-    const _used = outVar;
-    return undefined;
-  }
-
-  abstract hydrateExtraForEdgeDB(): Record<string, any>;
+  hydrateExtraForEdgeDB?(): Record<string, any>;
 }