Merge pull request #3075 from SeedCompany/edgedb/resource-association-v2

Author: CarsonF

src/common/resource.dto.ts

@@ -4,7 +4,8 @@ import { LazyGetter as Once } from 'lazy-get-decorator';
 import { DateTime } from 'luxon';
 import { keys as keysOf } from 'ts-transformer-keys';
 import { inspect } from 'util';
-import { $, abstractType, e } from '~/core/edgedb/reexports';
+import type { ResourceDBMap, ResourceMap } from '~/core';
+import { $ } from '~/core/edgedb/reexports';
 import { ScopedRole } from '../components/authorization';
 import { CalculatedSymbol } from './calculated.decorator';
 import { DataObject } from './data-object';
@@ -36,7 +37,6 @@ export const resolveByTypename =
 })
 @DbLabel('BaseNode')
 export abstract class Resource extends DataObject {
-  static readonly DB = abstractType(e.Resource);
   static readonly Props: string[] = keysOf<Resource>();
   static readonly SecuredProps: string[] = [];
 
@@ -61,7 +61,6 @@ export abstract class Resource extends DataObject {
 type Thunk<T> = T | (() => T);
 
 export type ResourceShape<T> = AbstractClassType<T> & {
-  DB?: $.$expr_PathNode;
   Props: string[];
   SecuredProps: string[];
   // An optional list of props that exist on the BaseNode in the DB.
@@ -84,6 +83,9 @@ export type ResourceRelationsShape = ResourceShape<any>['Relations'];
  * A helper class to query the static info of a resource in a typed way.
  */
 export class EnhancedResource<T extends ResourceShape<any>> {
+  /** @internal */
+  static readonly dbTypes = new WeakMap<ResourceShape<any>, $.$expr_PathNode>();
+
   private constructor(readonly type: T) {}
   private static readonly refs = new WeakMap<
     ResourceShape<any>,
@@ -128,8 +130,8 @@ export class EnhancedResource<T extends ResourceShape<any>> {
       : undefined;
   }
 
-  get name() {
-    return this.type.name;
+  get name(): ResourceName<T> {
+    return this.type.name as any;
   }
 
   /**
@@ -239,16 +241,16 @@ export class EnhancedResource<T extends ResourceShape<any>> {
     return new Set(props);
   }
 
-  get db(): T['DB'] & {} {
-    const type = this.type.DB;
+  get db(): DBType<T> {
+    const type = EnhancedResource.dbTypes.get(this.type);
     if (!type) {
       throw new ServerException(`No DB type defined for ${this.name}`);
     }
-    return type;
+    return type as any;
   }
 
-  get dbFQN(): (T['DB'] & {})['__element__']['__name__'] {
-    return this.db.__element__.__name__;
+  get dbFQN(): DBType<T>['__element__']['__name__'] {
+    return this.db.__element__.__name__ as any;
   }
 
   @Once()
@@ -282,6 +284,25 @@ export const isResourceClass = <T>(
 ): cls is ResourceShape<T> =>
   'Props' in cls && Array.isArray(cls.Props) && cls.Props.length > 0;
 
+export type ResourceName<TResourceStatic extends ResourceShape<any>> =
+  ResourceShape<any> extends TResourceStatic
+    ? string // short-circuit non-specific types
+    : {
+        [Name in keyof ResourceMap]: ResourceMap[Name] extends TResourceStatic // Only self or subclasses
+          ? TResourceStatic extends ResourceMap[Name] // Exclude subclasses
+            ? Name
+            : never
+          : never;
+      }[keyof ResourceMap] &
+        string;
+
+export type DBType<TResourceStatic extends ResourceShape<any>> =
+  ResourceName<TResourceStatic> extends keyof ResourceDBMap
+    ? ResourceDBMap[ResourceName<TResourceStatic>] extends infer T extends $.$expr_PathNode
+      ? T
+      : never
+    : never;
+
 export type MaybeUnsecuredInstance<TResourceStatic extends ResourceShape<any>> =
   MaybeSecured<InstanceType<TResourceStatic>>;
 

src/components/budget/dto/budget-record.dto.ts

@@ -18,12 +18,11 @@ import { ScopedRole } from '../../authorization';
 import { ChangesetAware } from '../../changeset/dto';
 import { Budget } from './budget.dto';
 
-@RegisterResource()
+@RegisterResource({ db: e.Budget.Record })
 @ObjectType({
   implements: [Resource, ChangesetAware],
 })
 export class BudgetRecord extends IntersectionType(ChangesetAware, Resource) {
-  static readonly DB = e.Budget.Record;
   static readonly Props = keysOf<BudgetRecord>();
   static readonly SecuredProps = keysOf<SecuredProps<BudgetRecord>>();
   static readonly Parent = import('./budget.dto').then((m) => m.Budget);
@@ -53,4 +52,7 @@ declare module '~/core/resources/map' {
   interface ResourceMap {
     BudgetRecord: typeof BudgetRecord;
   }
+  interface ResourceDBMap {
+    BudgetRecord: typeof e.Budget.Record;
+  }
 }

src/components/budget/dto/budget.dto.ts

@@ -20,12 +20,11 @@ import { IProject } from '../../project/dto';
 import { BudgetRecord } from './budget-record.dto';
 import { BudgetStatus } from './budget-status.enum';
 
-@RegisterResource()
+@RegisterResource({ db: e.Budget })
 @ObjectType({
   implements: [Resource, ChangesetAware],
 })
 export class Budget extends IntersectionType(ChangesetAware, Resource) {
-  static readonly DB = e.Budget;
   static readonly Props = keysOf<Budget>();
   static readonly SecuredProps = keysOf<SecuredProps<Budget>>();
   static readonly Relations = {
@@ -64,4 +63,7 @@ declare module '~/core/resources/map' {
   interface ResourceMap {
     Budget: typeof Budget;
   }
+  interface ResourceDBMap {
+    Budget: typeof e.default.Budget;
+  }
 }

src/components/ceremony/dto/ceremony.dto.ts

@@ -14,13 +14,12 @@ import {
 } from '../../../common';
 import { CeremonyType } from './ceremony-type.enum';
 
-@RegisterResource()
+@RegisterResource({ db: e.Engagement.Ceremony })
 @Calculated()
 @ObjectType({
   implements: [Resource],
 })
 export class Ceremony extends Resource {
-  static readonly DB = e.Engagement.Ceremony;
   static readonly Props = keysOf<Ceremony>();
   static readonly SecuredProps = keysOf<SecuredProps<Ceremony>>();
   static readonly Parent = import('../../engagement/dto').then(
@@ -54,4 +53,7 @@ declare module '~/core/resources/map' {
   interface ResourceMap {
     Ceremony: typeof Ceremony;
   }
+  interface ResourceDBMap {
+    Ceremony: typeof e.Engagement.Ceremony;
+  }
 }

src/components/engagement/dto/engagement.dto.ts

@@ -4,7 +4,7 @@ import { DateTime } from 'luxon';
 import { keys as keysOf } from 'ts-transformer-keys';
 import { MergeExclusive } from 'type-fest';
 import { BaseNode } from '~/core/database/results';
-import { abstractType, e } from '~/core/edgedb';
+import { e } from '~/core/edgedb';
 import { RegisterResource } from '~/core/resources';
 import {
   Calculated,
@@ -56,7 +56,7 @@ export const resolveEngagementType = (val: Pick<AnyEngagement, '__typename'>) =>
     ? LanguageEngagement
     : InternshipEngagement;
 
-@RegisterResource()
+@RegisterResource({ db: e.Engagement })
 @InterfaceType({
   resolveType: resolveEngagementType,
   implements: [Resource, ChangesetAware],
@@ -65,7 +65,6 @@ export const resolveEngagementType = (val: Pick<AnyEngagement, '__typename'>) =>
  * This should be used for GraphQL but never for TypeScript types.
  */
 class Engagement extends ChangesetAwareResource {
-  static readonly DB: any = abstractType(e.Engagement);
   static readonly Props: string[] = keysOf<Engagement>();
   static readonly SecuredProps: string[] = keysOf<SecuredProps<Engagement>>();
   static readonly Parent = import('../../project/dto').then((m) => m.IProject);
@@ -149,12 +148,11 @@ class Engagement extends ChangesetAwareResource {
 // export as different names to maintain compatibility with our codebase.
 export { Engagement as IEngagement, AnyEngagement as Engagement };
 
-@RegisterResource()
+@RegisterResource({ db: e.LanguageEngagement })
 @ObjectType({
   implements: [Engagement],
 })
 export class LanguageEngagement extends Engagement {
-  static readonly DB = e.LanguageEngagement;
   static readonly Props = keysOf<LanguageEngagement>();
   static readonly SecuredProps = keysOf<SecuredProps<LanguageEngagement>>();
   static readonly Relations = {
@@ -195,12 +193,11 @@ export class LanguageEngagement extends Engagement {
   readonly historicGoal: SecuredString;
 }
 
-@RegisterResource()
+@RegisterResource({ db: e.InternshipEngagement })
 @ObjectType({
   implements: [Engagement],
 })
 export class InternshipEngagement extends Engagement {
-  static readonly DB = e.InternshipEngagement;
   static readonly Props = keysOf<InternshipEngagement>();
   static readonly SecuredProps = keysOf<SecuredProps<InternshipEngagement>>();
   static readonly Parent = import('../../project/dto').then(
@@ -238,4 +235,9 @@ declare module '~/core/resources/map' {
     InternshipEngagement: typeof InternshipEngagement;
     LanguageEngagement: typeof LanguageEngagement;
   }
+  interface ResourceDBMap {
+    Engagement: typeof e.default.Engagement;
+    InternshipEngagement: typeof e.default.InternshipEngagement;
+    LanguageEngagement: typeof e.default.LanguageEngagement;
+  }
 }

src/components/ethno-art/dto/ethno-art.dto.ts

@@ -17,12 +17,11 @@ declare module '../../product/dto/producible.dto' {
   }
 }
 
-@RegisterResource()
+@RegisterResource({ db: e.EthnoArt })
 @ObjectType({
   implements: [Producible, Resource],
 })
 export class EthnoArt extends Producible {
-  static readonly DB = e.EthnoArt;
   static readonly Props = keysOf<EthnoArt>();
   static readonly SecuredProps = keysOf<SecuredProps<EthnoArt>>();
 
@@ -35,4 +34,7 @@ declare module '~/core/resources/map' {
   interface ResourceMap {
     EthnoArt: typeof EthnoArt;
   }
+  interface ResourceDBMap {
+    EthnoArt: typeof e.default.EthnoArt;
+  }
 }

src/components/field-region/dto/field-region.dto.ts

@@ -13,12 +13,11 @@ import {
 import { e } from '~/core/edgedb';
 import { LinkTo, RegisterResource } from '~/core/resources';
 
-@RegisterResource()
+@RegisterResource({ db: e.FieldRegion })
 @ObjectType({
   implements: [Resource],
 })
 export class FieldRegion extends Resource {
-  static readonly DB = e.FieldRegion;
   static readonly Props = keysOf<FieldRegion>();
   static readonly SecuredProps = keysOf<SecuredProps<FieldRegion>>();
 
@@ -45,4 +44,7 @@ declare module '~/core/resources/map' {
   interface ResourceMap {
     FieldRegion: typeof FieldRegion;
   }
+  interface ResourceDBMap {
+    FieldRegion: typeof e.default.FieldRegion;
+  }
 }

src/components/field-zone/dto/field-zone.dto.ts

@@ -12,12 +12,11 @@ import {
   SecuredString,
 } from '../../../common';
 
-@RegisterResource()
+@RegisterResource({ db: e.FieldZone })
 @ObjectType({
   implements: [Resource],
 })
 export class FieldZone extends Resource {
-  static readonly DB = e.FieldZone;
   static readonly Props = keysOf<FieldZone>();
   static readonly SecuredProps = keysOf<SecuredProps<FieldZone>>();
 
@@ -37,4 +36,7 @@ declare module '~/core/resources/map' {
   interface ResourceMap {
     FieldZone: typeof FieldZone;
   }
+  interface ResourceDBMap {
+    FieldZone: typeof e.default.FieldZone;
+  }
 }

src/components/file/dto/node.ts

@@ -6,7 +6,7 @@ import { Readable } from 'stream';
 import { keys as keysOf } from 'ts-transformer-keys';
 import { MergeExclusive, Opaque } from 'type-fest';
 import { BaseNode } from '~/core/database/results';
-import { abstractType, e } from '~/core/edgedb';
+import { e } from '~/core/edgedb';
 import { RegisterResource } from '~/core/resources';
 import {
   DateTimeField,
@@ -43,15 +43,14 @@ export const resolveFileNode = (val: AnyFileNode) => {
   return type;
 };
 
-@RegisterResource()
+@RegisterResource({ db: e.File.Node })
 @InterfaceType({
   resolveType: resolveFileNode,
 })
 /**
  * This should be used for GraphQL but never for TypeScript types.
  */
 abstract class FileNode extends Resource {
-  static readonly DB = abstractType(e.File.Node);
   static readonly Props: string[] = keysOf<FileNode>();
   static readonly SecuredProps: string[] = keysOf<SecuredProps<FileNode>>();
 
@@ -101,24 +100,22 @@ abstract class BaseFile extends FileNode {
   readonly size: number;
 }
 
-@RegisterResource()
+@RegisterResource({ db: e.File.Version })
 @ObjectType({
   implements: [FileNode, Resource],
 })
 export class FileVersion extends BaseFile {
-  static readonly DB = e.File.Version;
   static readonly Props = keysOf<FileVersion>();
   static readonly SecuredProps = keysOf<SecuredProps<FileVersion>>();
 
   declare readonly type: 'FileVersion';
 }
 
-@RegisterResource()
+@RegisterResource({ db: e.File })
 @ObjectType({
   implements: [FileNode, Resource],
 })
 export class File extends BaseFile {
-  static readonly DB = e.File;
   static readonly Props = keysOf<File>();
   static readonly SecuredProps = keysOf<SecuredProps<File>>();
 
@@ -132,12 +129,11 @@ export class File extends BaseFile {
   readonly modifiedAt: DateTime;
 }
 
-@RegisterResource()
+@RegisterResource({ db: e.Directory })
 @ObjectType({
   implements: [FileNode, Resource],
 })
 export class Directory extends FileNode {
-  static readonly DB = e.Directory;
   static readonly Props = keysOf<Directory>();
   static readonly SecuredProps = keysOf<SecuredProps<Directory>>();
 
@@ -218,4 +214,10 @@ declare module '~/core/resources/map' {
     FileNode: typeof FileNode;
     FileVersion: typeof FileVersion;
   }
+  interface ResourceDBMap {
+    Directory: typeof e.Directory;
+    File: typeof e.default.File;
+    FileNode: typeof e.File.Node;
+    FileVersion: typeof e.File.Version;
+  }
 }

src/components/film/dto/film.dto.ts

@@ -17,12 +17,11 @@ declare module '../../product/dto/producible.dto' {
   }
 }
 
-@RegisterResource()
+@RegisterResource({ db: e.Film })
 @ObjectType({
   implements: [Producible, Resource],
 })
 export class Film extends Producible {
-  static readonly DB = e.Film;
   static readonly Props = keysOf<Film>();
   static readonly SecuredProps = keysOf<SecuredProps<Film>>();
 
@@ -35,4 +34,7 @@ declare module '~/core/resources/map' {
   interface ResourceMap {
     Film: typeof Film;
   }
+  interface ResourceDBMap {
+    Film: typeof e.default.Film;
+  }
 }