Merge pull request #3361 from SeedCompany/updates

Bump libs to be compatible with Nest 11 / tweak scalar metadata / improve changeset pipe

Author: CarsonF

package.json

@@ -48,12 +48,12 @@
     "@nestjs/graphql": "^12.0.9",
     "@nestjs/platform-fastify": "^10.4.3",
     "@patarapolw/prettyprint": "^1.0.3",
-    "@seedcompany/cache": "^2.0.0",
-    "@seedcompany/common": ">=0.16 <1",
-    "@seedcompany/data-loader": "^1.0.0",
-    "@seedcompany/nest": "^1.1.0",
-    "@seedcompany/nestjs-email": "^4.0.0",
-    "@seedcompany/scripture": "^0.3.0",
+    "@seedcompany/cache": "^3.0.2",
+    "@seedcompany/common": ">=0.17 <1",
+    "@seedcompany/data-loader": "^2.0.1",
+    "@seedcompany/nest": "^1.4.0",
+    "@seedcompany/nestjs-email": "^4.1.1",
+    "@seedcompany/scripture": ">=0.8.0",
     "argon2": "^0.31.1",
     "aws-xray-sdk-core": "^3.5.3",
     "chalk": "^5.3.0",

src/app.module.ts

@@ -42,6 +42,8 @@ import { TimeZoneModule } from './components/timezone';
 import { UserModule } from './components/user/user.module';
 import { CoreModule, LoggerModule } from './core';
 
+import '@seedcompany/nest/patches';
+
 assert(
   keys<{ foo: string }>().length === 1,
   'Sanity check for key transformer failed',

src/common/mask-secrets.ts

@@ -1,5 +1,4 @@
-import { isPlainObject } from '@nestjs/common/utils/shared.utils.js';
-import { mapValues } from '@seedcompany/common';
+import { isPlainObject, mapValues } from '@seedcompany/common';
 
 export const maskSecrets = (
   obj: Record<string, any>,

src/common/resource.dto.ts

@@ -1,9 +1,13 @@
 import { Field, InterfaceType } from '@nestjs/graphql';
-import { cached, FnLike, mapValues } from '@seedcompany/common';
+import {
+  cached,
+  FnLike,
+  mapValues,
+  setInspectOnClass,
+} from '@seedcompany/common';
 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 type {
   ResourceDBMap,
   ResourceLike,
@@ -118,10 +122,6 @@ export class EnhancedResource<T extends ResourceShape<any>> {
     return cached(EnhancedResource.refs, resource, factory);
   }
 
-  [inspect.custom]() {
-    return `${this.constructor.name} { ${this.name} }`;
-  }
-
   /**
    * Check if the given type is the same as this type.
    * A helper to narrow the type of enhanced resource.
@@ -292,6 +292,9 @@ export class EnhancedResource<T extends ResourceShape<any>> {
     ).asRecord;
   }
 }
+setInspectOnClass(EnhancedResource, (res) => ({ collapsed }) => {
+  return collapsed(res.name, 'Enhanced');
+});
 
 export interface EnhancedRelation<TResourceStatic extends ResourceShape<any>> {
   readonly name: RelKey<TResourceStatic>;

src/common/rich-text.scalar.ts

@@ -1,5 +1,7 @@
 import { applyDecorators } from '@nestjs/common';
 import { Field, FieldOptions, ObjectType } from '@nestjs/graphql';
+import { setToStringTag } from '@seedcompany/common';
+import { markSkipClassTransformation } from '@seedcompany/nest';
 import { IsObject } from 'class-validator';
 import { createHash } from 'crypto';
 import { GraphQLScalarType } from 'graphql';
@@ -71,6 +73,8 @@ export class RichTextDocument {
     return isEqual(aBlocks, bBlocks);
   }
 }
+setToStringTag(RichTextDocument, 'RichText');
+markSkipClassTransformation(RichTextDocument);
 
 export const RichTextField = (options?: FieldOptions) =>
   applyDecorators(

src/common/temporal/calendar-date.ts

@@ -1,3 +1,4 @@
+import { setInspectOnClass, setToStringTag } from '@seedcompany/common';
 import {
   DateObjectUnits,
   DateTime,
@@ -12,7 +13,6 @@ import {
   ZoneOptions,
 } from 'luxon';
 import type { DefaultValidity, IfValid } from 'luxon/src/_util';
-import { inspect } from 'util';
 import { DateInterval } from './date-interval';
 
 /**
@@ -271,9 +271,9 @@ export class CalendarDate<IsValid extends boolean = DefaultValidity>
   toPostgres() {
     return this.toSQLDate()!;
   }
-
-  [inspect.custom]() {
-    const str = this.toLocaleString(DateTime.DATE_SHORT);
-    return `[Date] ${str}`;
-  }
 }
+
+setInspectOnClass(CalendarDate, (date) => ({ collapsed }) => {
+  return collapsed(date.toLocaleString(DateTime.DATE_SHORT), 'Date');
+});
+setToStringTag(CalendarDate, 'CalendarDate');

src/common/temporal/date-interval.ts

@@ -1,3 +1,4 @@
+import { setInspectOnClass, setToStringTag } from '@seedcompany/common';
 import {
   DateInput,
   DateTimeOptions,
@@ -9,7 +10,6 @@ import {
   Interval,
   IntervalObject,
 } from 'luxon';
-import { inspect } from 'util';
 import { CalendarDate } from './calendar-date';
 import '@seedcompany/common/temporal/luxon';
 
@@ -176,13 +176,18 @@ export class DateInterval
   toString(): string {
     return `[${this.start.toISO()} – ${this.end.toISO()}]`;
   }
-  [inspect.custom]() {
-    return `[Dates ${this.start.toISO()} – ${this.end.toISO()}]`;
-  }
   expandToFull(unit: DateTimeUnit): DateInterval {
     return DateInterval.fromDateTimes(
       this.start.startOf(unit),
       this.end.endOf(unit),
     );
   }
 }
+
+setInspectOnClass(DateInterval, (i) => ({ collapsed }) => {
+  return collapsed(`${format(i.start)} – ${format(i.end)}`, 'Dates');
+});
+const format = (date: CalendarDate) =>
+  date.toLocaleString(CalendarDate.DATE_SHORT);
+
+setToStringTag(DateInterval, 'DateInterval');

src/common/temporal/date-time.ts

@@ -1,14 +1,14 @@
+import { setInspectOnClass, setToStringTag } from '@seedcompany/common';
+import { markSkipClassTransformation } from '@seedcompany/nest';
 import { DateTime } from 'luxon';
 import * as Neo from 'neo4j-driver';
-import { inspect } from 'util';
 
 /* eslint-disable @typescript-eslint/method-signature-style */
 declare module 'luxon/src/datetime' {
   interface DateTime {
     toNeo4JDate(this: DateTime): Neo.Date<number>;
     toNeo4JDateTime(this: DateTime): Neo.DateTime<number>;
     toPostgres(this: DateTime): string;
-    [inspect.custom](): string;
 
     // Compatibility with Gel's LocalDate which is a subset of Temporal.PlainDate
     get dayOfWeek(): number;
@@ -20,34 +20,40 @@ declare module 'luxon/src/datetime' {
 }
 /* eslint-enable @typescript-eslint/method-signature-style */
 
-DateTime.prototype.toNeo4JDate = function (this: DateTime) {
-  return new Neo.types.Date(this.year, this.month, this.day);
-};
-
-DateTime.prototype.toNeo4JDateTime = function (this: DateTime) {
-  return new Neo.types.DateTime(
-    this.year,
-    this.month,
-    this.day,
-    this.hour,
-    this.minute,
-    this.second,
-    this.millisecond * 1e6,
-    this.offset * 60,
-    undefined, // Neo4j doesn't recommend timezone names as they are ambiguous
-  );
-};
-
-DateTime.prototype.toPostgres = function (this: DateTime) {
-  return this.toSQL();
-};
-
-DateTime.prototype[inspect.custom] = function (this: DateTime) {
-  const str = this.toLocaleString(DateTime.DATETIME_SHORT_WITH_SECONDS);
-  return `[DateTime] ${str}`;
-};
+setInspectOnClass(DateTime, (dt) => ({ collapsed }) => {
+  return collapsed(dt.toLocaleString(DateTime.DATETIME_SHORT_WITH_SECONDS));
+});
+setToStringTag(DateTime, 'DateTime');
+markSkipClassTransformation(DateTime);
 
 Object.defineProperties(DateTime.prototype, {
+  toNeo4JDate: {
+    value: function toNeo4JDate(this: DateTime) {
+      return new Neo.types.Date(this.year, this.month, this.day);
+    },
+  },
+  toNeo4JDateTime: {
+    value: function toNeo4JDateTime(this: DateTime) {
+      return new Neo.types.DateTime(
+        this.year,
+        this.month,
+        this.day,
+        this.hour,
+        this.minute,
+        this.second,
+        this.millisecond * 1e6,
+        this.offset * 60,
+        undefined, // Neo4j doesn't recommend timezone names as they're ambiguous
+      );
+    },
+  },
+  toPostgres: {
+    value: function toPostgres(this: DateTime) {
+      return this.toSQL();
+    },
+  },
+  // These below are for compatibility with Gel's LocalDate
+  // which is a subset of Temporal.PlainDate
   dayOfWeek: {
     get(this: DateTime) {
       return this.weekday;

src/common/temporal/interval.ts

@@ -1,12 +1,11 @@
+import { setInspectOnClass, setToStringTag } from '@seedcompany/common';
+import { markSkipClassTransformation } from '@seedcompany/nest';
 import { DateTime, DateTimeUnit, Interval } from 'luxon';
 import { Writable as Mutable } from 'type-fest';
-import { inspect } from 'util';
 
 /* eslint-disable @typescript-eslint/method-signature-style */
 declare module 'luxon/src/interval' {
   interface Interval {
-    [inspect.custom](): string;
-
     /**
      * Expand this interval to the full duration unit given
      */
@@ -28,25 +27,40 @@ declare module 'luxon/src/interval' {
 }
 /* eslint-enable @typescript-eslint/method-signature-style */
 
-Interval.prototype[inspect.custom] = function (this: Interval) {
-  const format = (dt: DateTime) =>
-    dt.toLocaleString(DateTime.DATETIME_SHORT_WITH_SECONDS);
-  return `[Interval ${format(this.start)} – ${format(this.end)})`;
-};
+setInspectOnClass(Interval, (i: Interval) => ({ stylize }) => {
+  return (
+    stylize(`[Interval `, 'special') +
+    `${format(i.start)} – ${format(i.end)}` +
+    stylize(`)`, 'special')
+  );
+});
+const format = (dt: DateTime) =>
+  dt.toLocaleString(DateTime.DATETIME_SHORT_WITH_SECONDS);
 
-Interval.prototype.expandToFull = function (
-  this: Interval,
-  unit: DateTimeUnit,
-) {
-  return Interval.fromDateTimes(this.start.startOf(unit), this.end.endOf(unit));
-};
+setToStringTag(Interval, 'Interval');
+markSkipClassTransformation(Interval);
+
+Object.defineProperty(Interval.prototype, 'expandToFull', {
+  configurable: true,
+  value: function expandToFull(this: Interval, unit: DateTimeUnit) {
+    return Interval.fromDateTimes(
+      this.start.startOf(unit),
+      this.end.endOf(unit),
+    );
+  },
+});
 
-const IntervalStatic = Interval as Mutable<typeof Interval>;
+const IntervalStatic = new Proxy(Interval, {
+  set(target, p, value) {
+    Object.defineProperty(target, p, { value, configurable: true });
+    return true;
+  },
+}) as Mutable<typeof Interval>;
 
-IntervalStatic.compare = (
+IntervalStatic.compare = function compare(
   prev: Interval | null | undefined,
   now: Interval | null | undefined,
-) => {
+) {
   const removals = !prev ? [] : !now ? [prev] : prev.difference(now);
   const additions = !now ? [] : !prev ? [now] : now.difference(prev);
   return { removals, additions };

src/components/changeset/enforce-changeset-editable.pipe.ts

@@ -1,10 +1,17 @@
-import { Inject, Injectable, PipeTransform, Scope, Type } from '@nestjs/common';
+import {
+  ArgumentMetadata,
+  Inject,
+  Injectable,
+  PipeTransform,
+  Scope,
+  Type,
+} from '@nestjs/common';
 import { CONTEXT } from '@nestjs/graphql';
+import { hasCtor, isRegularObject } from '@seedcompany/common';
 import {
   DataLoaderContext,
   DataLoaderStrategy,
 } from '@seedcompany/data-loader';
-import { isPlainObject } from 'lodash';
 import {
   ID,
   InputException,
@@ -25,6 +32,10 @@ import { shouldValidateEditability } from './validate-editability.decorator';
  * This logic is more suited for a Guard or Interceptor, but we don't have that
  * information easily accessible at that point.
  * Though it could be possible with some work.
+ *
+ * Since this is registered as a global/app pipe,
+ * it is called for every argument of every resolver/controller.
+ * So we want to be careful to do as little work as possible.
  */
 @Injectable({ scope: Scope.REQUEST })
 export class EnforceChangesetEditablePipe implements PipeTransform {
@@ -36,12 +47,17 @@ export class EnforceChangesetEditablePipe implements PipeTransform {
     private readonly loaderContext: DataLoaderContext,
   ) {}
 
-  async transform(value: any) {
-    await this.validateRequest(value);
+  async transform(value: unknown, metadata: ArgumentMetadata) {
+    await this.validateRequest(value, metadata);
     return value;
   }
 
-  async validateRequest(value: any) {
+  async validateRequest(value: unknown, metadata: ArgumentMetadata) {
+    // "body" translates to GQL args
+    if (metadata.type !== 'body') {
+      return;
+    }
+
     const context = isGqlContext(this.context) ? this.context : undefined;
     if (context?.operation.operation !== 'mutation') {
       return;
@@ -64,8 +80,8 @@ export class EnforceChangesetEditablePipe implements PipeTransform {
     }
   }
 
-  findIdsToValidate(value: any) {
-    if (!isInstance(value)) {
+  findIdsToValidate(value: unknown) {
+    if (!isInputClassInstanceLike(value)) {
       return [];
     }
 
@@ -81,5 +97,5 @@ export class EnforceChangesetEditablePipe implements PipeTransform {
   }
 }
 
-const isInstance = (value: any) =>
-  value && typeof value === 'object' && !isPlainObject(value);
+const isInputClassInstanceLike = (value: unknown): value is object =>
+  isRegularObject(value) && hasCtor(value);

src/core/database/query-augmentation/pattern-formatting.ts

@@ -1,4 +1,4 @@
-import { isNotFalsy } from '@seedcompany/common';
+import { isNotFalsy, isPlainObject } from '@seedcompany/common';
 import { stripIndent } from 'common-tags';
 import {
   Clause,
@@ -16,7 +16,7 @@ import {
 } from 'cypher-query-builder';
 import type { Term } from 'cypher-query-builder/dist/typings/clauses/term-list-clause';
 import type { Parameter } from 'cypher-query-builder/dist/typings/parameter-bag';
-import { camelCase, isPlainObject } from 'lodash';
+import { camelCase } from 'lodash';
 import { isExp } from '../query';
 import { WhereAndList } from '../query/where-and-list';