Merge pull request #3416 from SeedCompany/refactor/db-labels

Author: CarsonF

src/common/db-label.decorator.ts

@@ -1,28 +1,9 @@
-import { cleanSplit, isNotFalsy } from '@seedcompany/common';
-import { uniq } from 'lodash';
-
-export const DbLabelSymbol = Symbol('DbLabelSymbol');
-
-export const DbLabel =
-  (...labels: string[] | [null]): PropertyDecorator & ClassDecorator =>
-  (target: any, key?: string | symbol) => {
-    const prev: string[] =
-      (key
-        ? Reflect.getMetadata(DbLabelSymbol, target, key)
-        : Reflect.getMetadata(DbLabelSymbol, target)) ?? [];
-
-    const now = uniq(
-      [
-        ...prev,
-        // Add labels split by `:`
-        ...labels.flatMap((l) => cleanSplit(l ?? '', ':')),
-      ].filter(isNotFalsy),
-    );
-
-    key
-      ? Reflect.defineMetadata(DbLabelSymbol, now, target, key)
-      : Reflect.defineMetadata(DbLabelSymbol, now, target);
-    if (!key) {
-      return target;
-    }
-  };
+import { cleanSplit, setOf } from '@seedcompany/common';
+import { createMetadataDecorator } from '@seedcompany/nest';
+
+export const DbLabel = createMetadataDecorator({
+  types: ['class', 'property'],
+  setter: (...labels: string[] | [null]) =>
+    setOf(labels.flatMap((label) => cleanSplit(label ?? '', ':'))),
+  merge: ({ previous, next }) => previous?.union(next) ?? next,
+});

src/common/db-label.helpers.ts

@@ -15,7 +15,6 @@ export * from './create-and-inject';
 export * from './data-object';
 export * from './date-filter.input';
 export { DbLabel } from './db-label.decorator';
-export * from './db-label.helpers';
 export { DbSort } from './db-sort.decorator';
 export * from './db-unique.decorator';
 export * from './disabled.decorator';

src/common/index.ts

@@ -1,11 +1,13 @@
-import { Field, InterfaceType } from '@nestjs/graphql';
+import { CLASS_TYPE_METADATA, Field, InterfaceType } from '@nestjs/graphql';
+import { type ClassType as ClassTypeVal } from '@nestjs/graphql/dist/enums/class-type.enum.js';
 import {
   cached,
   type FnLike,
   mapValues,
   setInspectOnClass,
   setToJson,
 } from '@seedcompany/common';
+import { createMetadataDecorator } from '@seedcompany/nest';
 import { LazyGetter as Once } from 'lazy-get-decorator';
 import { DateTime } from 'luxon';
 import { keys as keysOf } from 'ts-transformer-keys';
@@ -20,14 +22,18 @@ import { type ScopedRole } from '../components/authorization/dto';
 import { CalculatedSymbol } from './calculated.decorator';
 import { DataObject } from './data-object';
 import { DbLabel } from './db-label.decorator';
-import { getDbClassLabels, getDbPropertyLabels } from './db-label.helpers';
 import { ServerException } from './exceptions';
 import { type ID, IdField } from './id-field';
 import { DateTimeField } from './luxon.graphql';
 import { getParentTypes } from './parent-types';
 import { type MaybeSecured, type SecuredProps } from './secured-property';
 import { type AbstractClassType } from './types';
 
+const GqlClassType = createMetadataDecorator({
+  key: CLASS_TYPE_METADATA,
+  setter: (type: ClassTypeVal) => type,
+});
+
 const hasTypename = (value: unknown): value is { __typename: string } =>
   value != null &&
   typeof value === 'object' &&
@@ -282,7 +288,20 @@ export class EnhancedResource<T extends ResourceShape<any>> {
 
   @Once()
   get dbLabels() {
-    return getDbClassLabels(this.type);
+    const labels = getParentTypes(this.type).flatMap((cls) => {
+      if (
+        // Is declared as some gql object. i.e. avoids DataObject.
+        !GqlClassType.get(cls) ||
+        // Avoid intersected classes.
+        // getParentTypes will give us the intersect-ees directly.
+        cls.name.startsWith('Intersection')
+      ) {
+        return [];
+      }
+      const declared = DbLabel.getOwn(cls);
+      return declared ? [...declared] : [cls.name];
+    });
+    return [...new Set([...labels, 'BaseNode'])];
   }
   get dbLabel() {
     return this.dbLabels[0];
@@ -291,9 +310,10 @@ export class EnhancedResource<T extends ResourceShape<any>> {
   get dbPropLabels(): {
     readonly [K in keyof T['prototype'] & string]?: readonly string[];
   } {
-    return mapValues.fromList(this.props, (prop) =>
-      getDbPropertyLabels(this.type, prop),
-    ).asRecord;
+    return mapValues.fromList(this.props, (prop) => {
+      const declared = DbLabel.get(this.type, prop as unknown as string);
+      return [...new Set([...(declared ?? []), 'Property'])];
+    }).asRecord;
   }
 }
 setInspectOnClass(EnhancedResource, (res) => ({ collapsed }) => {

src/common/resource.dto.ts

@@ -1,6 +1,6 @@
 import { Field, InterfaceType } from '@nestjs/graphql';
 import { stripIndent } from 'common-tags';
-import { type ID, IdField } from '~/common';
+import { DbLabel, type ID, IdField } from '~/common';
 import { type BaseNode } from '~/core/database/results';
 import { Changeset } from './changeset.dto';
 
@@ -11,6 +11,9 @@ import { Changeset } from './changeset.dto';
     returned.
   `,
 })
+// Maintaining previous functionality.
+// This could be removed (and data migrated) to query it.
+@DbLabel(null)
 export abstract class ChangesetAware {
   @IdField({
     description: "The object's ID",

src/components/changeset/dto/changeset-aware.dto.ts

@@ -1,9 +1,12 @@
 import { Field, InterfaceType } from '@nestjs/graphql';
-import { type ID, IdField } from '~/common';
+import { DbLabel, type ID, IdField } from '~/common';
 
 @InterfaceType({
   description: 'An item that can be pinned',
 })
+// Maintaining previous functionality.
+// This could be removed (and data migrated) to query it.
+@DbLabel(null)
 export class Pinnable {
   @IdField()
   readonly id: ID;

src/components/pin/dto/pinnable.dto.ts

@@ -3,8 +3,8 @@ import { stripIndent } from 'common-tags';
 import { node, type Query, relation } from 'cypher-query-builder';
 import { DateTime } from 'luxon';
 import {
+  EnhancedResource,
   generateId,
-  getDbClassLabels,
   type ID,
   NotFoundException,
   type Session,
@@ -25,15 +25,18 @@ import { PeriodicReportService } from '../periodic-report';
 import { ReportType } from '../periodic-report/dto';
 import { type ProductStep } from '../product/dto';
 import {
-  ProductProgress,
   type ProductProgressInput,
   type ProgressVariant,
   type ProgressVariantByProductInput,
   type ProgressVariantByReportInput,
-  StepProgress,
+  ProductProgress as RawProductProgress,
+  StepProgress as RawStepProgress,
   type UnsecuredProductProgress,
 } from './dto';
 
+const ProductProgress = EnhancedResource.of(RawProductProgress);
+const StepProgress = EnhancedResource.of(RawStepProgress);
+
 @Injectable()
 export class ProductProgressRepository {
   constructor(
@@ -169,7 +172,7 @@ export class ProductProgressRepository {
         .optionalMatch([
           node('report'),
           relation('out', '', 'progress', ACTIVE),
-          node('progress', 'ProductProgress', {
+          node('progress', ProductProgress.dbLabel, {
             variant: variable('variant'),
           }),
           relation('in', '', 'progress', ACTIVE),
@@ -191,7 +194,7 @@ export class ProductProgressRepository {
                 .match([
                   node('progress'),
                   relation('out', '', 'step', ACTIVE),
-                  node('stepNode', 'StepProgress'),
+                  node('stepNode', StepProgress.dbLabel),
                 ])
                 .apply(matchProps({ nodeName: 'stepNode', outputVar: 'step' }))
                 .return(collect('step').as('steps')),
@@ -249,7 +252,7 @@ export class ProductProgressRepository {
           .merge([
             node('product'),
             relation('out', 'productProgressRel', 'progress', ACTIVE),
-            node('progress', 'ProductProgress', {
+            node('progress', ProductProgress.dbLabel, {
               variant: variable('variant'),
             }),
             relation('in', 'reportProgressRel', 'progress', ACTIVE),
@@ -258,7 +261,7 @@ export class ProductProgressRepository {
           .onCreate.set(
             {
               labels: {
-                progress: getDbClassLabels(ProductProgress),
+                progress: ProductProgress.dbLabels,
               },
               values: {
                 progress: { id: tempProgressId, createdAt },
@@ -282,14 +285,14 @@ export class ProductProgressRepository {
               .merge([
                 node('progress'),
                 relation('out', 'progressStepRel', 'step', ACTIVE),
-                node('stepNode', 'StepProgress', {
+                node('stepNode', StepProgress.dbLabel, {
                   step: variable('stepInput.step'),
                 }),
               ])
               .onCreate.set(
                 {
                   labels: {
-                    stepNode: getDbClassLabels(StepProgress),
+                    stepNode: StepProgress.dbLabels,
                   },
                   values: {
                     stepNode: { createdAt },

src/components/product-progress/product-progress.repository.ts

@@ -12,7 +12,7 @@ import { DateTime } from 'luxon';
 import { type Except, type Merge } from 'type-fest';
 import {
   CreationFailed,
-  getDbClassLabels,
+  EnhancedResource,
   type ID,
   type Range,
   type Session,
@@ -36,7 +36,7 @@ import {
 } from '~/core/database/query';
 import { ScriptureReferenceRepository } from '../scripture';
 import {
-  ScriptureRange,
+  ScriptureRange as RawScriptureRange,
   type ScriptureRangeInput,
   type UnspecifiedScripturePortion,
   type UnspecifiedScripturePortionInput,
@@ -60,6 +60,8 @@ import {
   type UpdateDirectScriptureProduct,
 } from './dto';
 
+const ScriptureRange = EnhancedResource.of(RawScriptureRange);
+
 export type HydratedProductRow = Merge<
   Omit<
     DbTypeOf<
@@ -109,7 +111,7 @@ export class ProductRepository extends CommonRepository {
           .match([
             node('node'),
             relation('out', '', 'scriptureReferences', ACTIVE),
-            node('scriptureRanges', 'ScriptureRange'),
+            node('scriptureRanges', ScriptureRange.dbLabel),
           ])
           .return(
             collect('scriptureRanges { .start, .end }').as('scriptureRanges'),
@@ -332,8 +334,8 @@ export class ProductRepository extends CommonRepository {
             [
               node('node'),
               relation('out', '', label, ACTIVE),
-              node('', getDbClassLabels(ScriptureRange), {
-                ...ScriptureRange.fromReferences(range),
+              node('', ScriptureRange.dbLabels, {
+                ...ScriptureRange.type.fromReferences(range),
                 createdAt,
               }),
             ];

src/components/product/product.repository.ts

@@ -2,6 +2,7 @@ import { Field, ObjectType } from '@nestjs/graphql';
 import { DateTime } from 'luxon';
 import {
   DateTimeField,
+  DbLabel,
   type ID,
   IdField,
   type MadeEnum,
@@ -18,6 +19,7 @@ export function WorkflowEvent<State extends string>(
   transitionType: ReturnType<typeof WorkflowTransition>,
 ) {
   @ObjectType({ isAbstract: true })
+  @DbLabel('WorkflowEvent')
   abstract class WorkflowEventClass {
     @IdField()
     readonly id: ID;

src/components/workflow/dto/workflow-event.dto.ts

@@ -5,7 +5,6 @@ import { DateTime } from 'luxon';
 import {
   DbUnique,
   EnhancedResource,
-  getDbClassLabels,
   type ID,
   InputException,
   isIdLike,
@@ -170,9 +169,10 @@ export class CommonRepository {
   }
 
   protected getConstraintsFor(resource: ResourceShape<any>) {
+    const { dbLabel } = EnhancedResource.of(resource);
     return [
       ...(resource.Props.includes('id')
-        ? [createUniqueConstraint(getDbClassLabels(resource)[0], 'id')]
+        ? [createUniqueConstraint(dbLabel, 'id')]
         : []),
       ...resource.Props.flatMap((prop) => {
         const label = DbUnique.get(resource, prop);