Migrate to SC metadata discovery (#3546)

Author: CarsonF

package.json

@@ -50,7 +50,7 @@
     "@seedcompany/cache": "^3.0.2",
     "@seedcompany/common": ">=0.19.1 <1",
     "@seedcompany/data-loader": "^2.0.1",
-    "@seedcompany/nest": "^1.8.0",
+    "@seedcompany/nest": "^1.12.0",
     "@seedcompany/nestjs-email": "^4.3.0",
     "@seedcompany/scripture": ">=0.8.0",
     "argon2": "^0.43.0",

src/common/discovery-unique-methods.ts

@@ -1,5 +1,4 @@
-import { type DiscoveryService } from '@golevelup/nestjs-discovery';
-import { SetMetadata } from '@nestjs/common';
+import { createMetadataDecorator } from '@seedcompany/nest';
 import { type EnhancedResource, type Many, type ResourceShape } from '~/common';
 import { type ResourceGranter } from './resource-granter';
 
@@ -27,25 +26,12 @@ import { type ResourceGranter } from './resource-granter';
  *   }
  * }
  */
-export const Granter = (
-  resources: GranterMetadata['resources'],
-  factory?: GranterMetadata['factory'],
-): ClassDecorator =>
-  SetMetadata<any, GranterMetadata>(GRANTER_FACTORY_METADATA_KEY, {
-    resources,
-    factory,
-  });
-
-export const discover = (discovery: DiscoveryService) =>
-  discovery.providersWithMetaAtKey<GranterMetadata>(
-    GRANTER_FACTORY_METADATA_KEY,
-  );
-
-const GRANTER_FACTORY_METADATA_KEY = Symbol('GranterFactory');
-
-interface GranterMetadata {
-  resources: Many<ResourceShape<any>>;
-  factory?: <TResourceStatic extends ResourceShape<any>>(
-    resource: EnhancedResource<TResourceStatic>,
-  ) => ResourceGranter<TResourceStatic>;
-}
+export const Granter = createMetadataDecorator({
+  setter: (
+    resources: Many<ResourceShape<any>>,
+    factory?: <TResourceStatic extends ResourceShape<any>>(
+      resource: EnhancedResource<TResourceStatic>,
+    ) => ResourceGranter<TResourceStatic>,
+  ) => ({ resources, factory }),
+  types: ['class'],
+});

src/components/authorization/policy/builder/granter.decorator.ts

@@ -1,4 +1,4 @@
-import { SetMetadata } from '@nestjs/common';
+import { createMetadataDecorator } from '@seedcompany/nest';
 import type { ValueOf } from 'type-fest';
 import { type Many, type Role } from '~/common';
 import type { ResourcesGranter } from '../granters';
@@ -7,18 +7,13 @@ type ResourceGranterFn = (
   resourcesGranter: ResourcesGranter,
 ) => Many<Many<ValueOf<ResourcesGranter>>>;
 
-export const POLICY_METADATA_KEY = Symbol('Policy');
-
-export const Policy = (
-  role: Many<Role> | 'all',
-  privilegesForResources: ResourceGranterFn,
-): ClassDecorator =>
-  SetMetadata<any, PolicyMetadata>(POLICY_METADATA_KEY, {
+export const Policy = createMetadataDecorator({
+  setter: (
+    role: Many<Role> | 'all',
+    privilegesForResources: ResourceGranterFn,
+  ) => ({
     role,
     def: privilegesForResources,
-  });
-
-export interface PolicyMetadata {
-  role: Many<Role> | 'all';
-  def: ResourceGranterFn;
-}
+  }),
+  types: ['class'],
+});

src/components/authorization/policy/builder/policy.decorator.ts

@@ -3,4 +3,4 @@ export * from './missing-context.exception';
 export * from './aggregate.condition';
 export * from './calculated.condition';
 export * from './eql.util';
-export * from './optimizer.interface';
+export { Optimizer } from './optimizer.interface';

src/components/authorization/policy/conditions/index.ts

@@ -1,14 +1,17 @@
-import {
-  applyDecorators,
-  Injectable,
-  SetMetadata,
-  type Type,
-} from '@nestjs/common';
+import { Injectable, type Type } from '@nestjs/common';
+import { createMetadataDecorator } from '@seedcompany/nest';
 import { type Condition } from './condition.interface';
 
+export const OptimizerWatermark = createMetadataDecorator({
+  types: ['class'],
+  additionalDecorators: [Injectable()],
+});
+
 export abstract class Optimizer {
-  static register = () => (cls: Type<Optimizer>) =>
-    applyDecorators(Injectable(), SetMetadata(Optimizer, true))(cls);
+  static register =
+    () =>
+    <Cls extends Type<Optimizer>>(cls: Cls) =>
+      OptimizerWatermark()(cls);
 
   abstract optimize(condition: Condition): Condition;
 }

src/components/authorization/policy/conditions/optimizer.interface.ts

@@ -1,22 +1,25 @@
-import { DiscoveryService } from '@golevelup/nestjs-discovery';
 import { Injectable, type OnModuleInit } from '@nestjs/common';
+import { MetadataDiscovery } from '~/core/discovery';
 import {
   AggregateConditions,
   AndConditions,
   type Condition,
-  Optimizer,
+  type Optimizer,
   OrConditions,
 } from '../conditions';
+import { OptimizerWatermark } from '../conditions/optimizer.interface';
 
 @Injectable()
 export class ConditionOptimizer implements OnModuleInit {
   private optimizers: Optimizer[];
 
-  constructor(private readonly discovery: DiscoveryService) {}
+  constructor(private readonly discovery: MetadataDiscovery) {}
 
   async onModuleInit() {
-    const found = await this.discovery.providersWithMetaAtKey(Optimizer as any);
-    this.optimizers = found.map((p) => p.discoveredClass.instance as Optimizer);
+    this.optimizers = this.discovery
+      .discover(OptimizerWatermark)
+      .classes<Optimizer>()
+      .map((discovery) => discovery.instance);
   }
 
   optimize(condition: Condition) {

src/components/authorization/policy/executor/condition-optimizer.ts

@@ -1,10 +1,10 @@
-import { DiscoveryService } from '@golevelup/nestjs-discovery';
-import { Injectable } from '@nestjs/common';
+import { Injectable, type Type } from '@nestjs/common';
 import { many, mapEntries } from '@seedcompany/common';
 import { mapValues } from 'lodash';
-import { EnhancedResource } from '~/common';
+import { EnhancedResource, type ResourceShape } from '~/common';
+import { MetadataDiscovery } from '~/core/discovery';
 import { ResourcesHost } from '~/core/resources';
-import { discover } from './builder/granter.decorator';
+import { Granter } from './builder/granter.decorator';
 import {
   DefaultResourceGranter,
   ResourceGranter,
@@ -14,21 +14,23 @@ import { type ResourcesGranter } from './granters';
 @Injectable()
 export class GrantersFactory {
   constructor(
-    private readonly discovery: DiscoveryService,
+    private readonly discovery: MetadataDiscovery,
     private readonly resourcesHost: ResourcesHost,
   ) {}
 
   async makeGranters() {
-    const discoveredGranters = await discover(this.discovery);
+    const discoveredGranters = this.discovery
+      .discover(Granter)
+      .classes<ResourceGranter<ResourceShape<any>>>();
 
     const custom = Object.assign(
       {},
       ...discoveredGranters.map(
-        ({ meta: { resources, factory }, discoveredClass }) =>
+        ({ meta: { resources, factory }, instance }) =>
           mapEntries(many(resources), (raw) => {
             const res = EnhancedResource.of(raw);
-            const granter =
-              factory?.(res) ?? new discoveredClass.dependencyType(res);
+            const GranterImpl = instance.constructor as Type<ResourcesGranter>;
+            const granter = factory?.(res) ?? new GranterImpl(res);
             if (!(granter instanceof ResourceGranter)) {
               throw new Error(
                 `Granter for ${res.name} must extend ResourceGranter class`,

src/components/authorization/policy/granters.factory.ts

@@ -1,12 +1,9 @@
-import {
-  type DiscoveredClassWithMeta,
-  DiscoveryService,
-} from '@golevelup/nestjs-discovery';
 import { Injectable, type OnModuleInit } from '@nestjs/common';
 import { entries, mapEntries, mapValues, setOf } from '@seedcompany/common';
 import { pick, startCase } from 'lodash';
 import { type DeepWritable, type Writable } from 'ts-essentials';
 import { type EnhancedResource, many, type Role } from '~/common';
+import { type DiscoveredClass, MetadataDiscovery } from '~/core/discovery';
 import { ResourcesHost } from '~/core/resources';
 import { Power } from '../dto';
 import { ChildListAction, ChildSingleAction } from './actions';
@@ -15,10 +12,7 @@ import {
   type Permission,
   type Permissions,
 } from './builder/perm-granter';
-import {
-  POLICY_METADATA_KEY,
-  type PolicyMetadata,
-} from './builder/policy.decorator';
+import { Policy as PolicyMetadata } from './builder/policy.decorator';
 import { all, any, Condition } from './conditions';
 import { type ResourcesGranter } from './granters';
 import { GrantersFactory } from './granters.factory';
@@ -53,7 +47,7 @@ export class PolicyFactory implements OnModuleInit {
 
   constructor(
     private readonly grantersFactory: GrantersFactory,
-    private readonly discovery: DiscoveryService,
+    private readonly discovery: MetadataDiscovery,
     private readonly resourcesHost: ResourcesHost,
   ) {}
 
@@ -72,10 +66,9 @@ export class PolicyFactory implements OnModuleInit {
   }
 
   async onModuleInit() {
-    const discoveredPolicies =
-      await this.discovery.providersWithMetaAtKey<PolicyMetadata>(
-        POLICY_METADATA_KEY,
-      );
+    const discoveredPolicies = this.discovery
+      .discover(PolicyMetadata)
+      .classes();
 
     const resGranter = await this.grantersFactory.makeGranters();
 
@@ -99,9 +92,9 @@ export class PolicyFactory implements OnModuleInit {
 
   private buildPlainPolicy(
     resGranter: ResourcesGranter,
-    { meta, discoveredClass }: DiscoveredClassWithMeta<PolicyMetadata>,
+    { meta, instance }: DiscoveredClass<(typeof PolicyMetadata)['$value']>,
   ): PlainPolicy {
-    const name = startCase(discoveredClass.name.replace(/Policy$/, ''));
+    const name = startCase(instance.constructor.name.replace(/Policy$/, ''));
 
     const roles = meta.role === 'all' ? undefined : setOf(many(meta.role));
 

src/components/authorization/policy/policy.factory.ts

@@ -1,4 +1,3 @@
-import { DiscoveryService } from '@golevelup/nestjs-discovery';
 import {
   forwardRef,
   Inject,
@@ -13,6 +12,7 @@ import {
   ServerException,
   type UnsecuredDto,
 } from '~/common';
+import { MetadataDiscovery } from '~/core/discovery';
 import {
   type MarkNotificationReadArgs,
   type Notification,
@@ -62,7 +62,7 @@ export class NotificationServiceImpl
   >;
   readonly ready = new ((Event as any).default as typeof Event)();
 
-  constructor(private readonly discovery: DiscoveryService) {
+  constructor(private readonly discovery: MetadataDiscovery) {
     super();
   }
 
@@ -88,11 +88,8 @@ export class NotificationServiceImpl
   }
 
   async onModuleInit() {
-    const discovered = await this.discovery.providersWithMetaAtKey<
-      ResourceShape<Notification>
-    >(NotificationStrategy.KEY);
-    this.strategyMap = mapEntries(discovered, ({ meta, discoveredClass }) => {
-      const { instance } = discoveredClass;
+    const discovered = this.discovery.discover(NotificationStrategy).classes();
+    this.strategyMap = mapEntries(discovered, ({ meta, instance }) => {
       if (!(instance instanceof INotificationStrategy)) {
         throw new ServerException(
           `Strategy for ${meta.name} does not implement INotificationStrategy`,