Merge pull request #2975 from SeedCompany/edgedb/fix-scalar-rendering

Author: CarsonF

.yarn/patches/edgedb-npm-1.4.0-902d833279.patch

@@ -0,0 +1,12 @@
+diff --git a/dist/datatypes/datetime.d.ts b/dist/datatypes/datetime.d.ts
+index 3f9300f558bca2a95988c2f356e0b19c504e00d1..241d7fa97e09bd47001dbaca66e8080e683117b9 100644
+--- a/dist/datatypes/datetime.d.ts
++++ b/dist/datatypes/datetime.d.ts
+@@ -35,7 +35,6 @@ export declare class LocalTime {
+     valueOf(): any;
+ }
+ export declare class LocalDate {
+-    private readonly _date;
+     constructor(isoYear: number, isoMonth: number, isoDay: number);
+     get year(): number;
+     get month(): number;

package.json

@@ -61,7 +61,7 @@
     "cypher-query-builder": "patch:[email protected]#.yarn/patches/cypher-query-builder.patch",
     "dotenv": "^16.3.1",
     "dotenv-expand": "^10.0.0",
-    "edgedb": "^1.4.0",
+    "edgedb": "patch:edgedb@npm%3A1.4.0#~/.yarn/patches/edgedb-npm-1.4.0-902d833279.patch",
     "execa": "^8.0.1",
     "express": "^4.18.2",
     "extensionless": "^1.7.0",

src/common/temporal/calendar-date.ts

@@ -92,6 +92,10 @@ export class CalendarDate
     return CalendarDate.fromDateTime(super.invalid(reason));
   }
 
+  static now() {
+    return CalendarDate.local();
+  }
+
   static local(
     year: number,
     month: number,
@@ -101,7 +105,7 @@ export class CalendarDate
     second: number,
     millisecond: number,
     opts?: DateTimeJSOptions,
-  ): DateTime;
+  ): CalendarDate;
   static local(
     year: number,
     month: number,
@@ -110,31 +114,35 @@ export class CalendarDate
     minute: number,
     second: number,
     opts?: DateTimeJSOptions,
-  ): DateTime;
+  ): CalendarDate;
   static local(
     year: number,
     month: number,
     day: number,
     hour: number,
     minute: number,
     opts?: DateTimeJSOptions,
-  ): DateTime;
+  ): CalendarDate;
   static local(
     year: number,
     month: number,
     day: number,
     hour: number,
     opts?: DateTimeJSOptions,
-  ): DateTime;
+  ): CalendarDate;
   static local(
     year: number,
     month: number,
     day: number,
     opts?: DateTimeJSOptions,
-  ): DateTime;
-  static local(year: number, month: number, opts?: DateTimeJSOptions): DateTime;
-  static local(year: number, opts?: DateTimeJSOptions): DateTime;
-  static local(opts?: DateTimeJSOptions): DateTime;
+  ): CalendarDate;
+  static local(
+    year: number,
+    month: number,
+    opts?: DateTimeJSOptions,
+  ): CalendarDate;
+  static local(year: number, opts?: DateTimeJSOptions): CalendarDate;
+  static local(opts?: DateTimeJSOptions): CalendarDate;
   static local(...args: any) {
     const dt = super.local(...args);
     return CalendarDate.fromDateTime(dt);

src/common/temporal/date-time.ts

@@ -9,6 +9,13 @@ declare module 'luxon/src/datetime' {
     toNeo4JDateTime(this: DateTime): Neo.DateTime<number>;
     toPostgres(this: DateTime): string;
     [inspect.custom](): string;
+
+    // Compatibility with EdgeDB's LocalDate which is a subset of Temporal.PlainDate
+    get dayOfWeek(): number;
+    get dayOfYear(): number;
+    get daysInWeek(): number;
+    get monthsInYear(): number;
+    get inLeapYear(): boolean;
   }
 }
 /* eslint-enable @typescript-eslint/method-signature-style */
@@ -39,3 +46,31 @@ DateTime.prototype[inspect.custom] = function (this: DateTime) {
   const str = this.toLocaleString(DateTime.DATETIME_SHORT_WITH_SECONDS);
   return `[DateTime] ${str}`;
 };
+
+Object.defineProperties(DateTime.prototype, {
+  dayOfWeek: {
+    get(this: DateTime) {
+      return this.weekday;
+    },
+  },
+  dayOfYear: {
+    get(this: DateTime) {
+      return this.ordinal;
+    },
+  },
+  daysInWeek: {
+    get(this: DateTime) {
+      return 7;
+    },
+  },
+  monthsInYear: {
+    get(this: DateTime) {
+      return 12;
+    },
+  },
+  inLeapYear: {
+    get(this: DateTime) {
+      return this.isInLeapYear;
+    },
+  },
+});

src/core/edgedb/generator/query-builder.ts

@@ -22,6 +22,8 @@ export async function generateQueryBuilder({
   });
   addJsExtensionDeepPathsOfEdgedbLibrary(qbDir);
   changeCustomScalars(qbDir);
+  updateEdgeQLRenderingForOurCustomScalars(qbDir);
+  updateCastMapsForOurCustomScalars(qbDir);
   changeImplicitIDType(qbDir);
   allowOrderingByEnums(qbDir);
   mergeDefaultTypesWithModuleNames(qbDir);
@@ -66,6 +68,57 @@ function changeImplicitIDType(qbDir: Directory) {
   );
 }
 
+function updateCastMapsForOurCustomScalars(qbDir: Directory) {
+  const file = qbDir.addSourceFileAtPath('castMaps.ts');
+  file.insertImportDeclaration(1, {
+    namedImports: ['DateTime'],
+    moduleSpecifier: 'luxon',
+  });
+  file.insertImportDeclaration(1, {
+    namedImports: ['CalendarDate'],
+    moduleSpecifier: '~/common',
+    leadingTrivia: '\n',
+  });
+  const updated = file
+    .getText()
+    // Update Luxon instances to point to correct scalar UUIDs
+    .replace(
+      '(type instanceof Date)',
+      '(type instanceof Date || (type instanceof DateTime && !(type instanceof CalendarDate)))',
+    )
+    .replace(
+      '(type instanceof edgedb.LocalDate)',
+      '(type instanceof edgedb.LocalDate || type instanceof CalendarDate)',
+    );
+  // Attempting to pick the right type based on shape.
+  // This doesn't fix any errors, and currently we are unable to distinguish
+  // CalendarDate from DateTime based on shape since they are the same.
+  // import * as _std from '../generated-client/modules/std';
+  // .replace(
+  //   '  T extends Date ? scalarWithConstType<_std.$datetime, T> :\n',
+  //   '  T extends CalendarDate ? scalarWithConstType<_cal.$local_date, T> :\n' +
+  //     '  T extends Date | DateTime ? scalarWithConstType<_std.$datetime, T> :\n',
+  // )
+  file.replaceWithText(updated);
+}
+
+function updateEdgeQLRenderingForOurCustomScalars(qbDir: Directory) {
+  const file = qbDir.addSourceFileAtPath('toEdgeQL.ts');
+  file.insertImportDeclaration(1, {
+    namedImports: ['DateTime'],
+    moduleSpecifier: 'luxon',
+    leadingTrivia: '\n',
+  });
+  const condition = '  } else if (val instanceof Date) {\n';
+  const updated = file.getText().replace(
+    condition,
+    `  } else if (val instanceof DateTime) {
+    stringRep = \`'\${val.toISO()}'\`;
+` + condition,
+  );
+  file.replaceWithText(updated);
+}
+
 function allowOrderingByEnums(qbDir: Directory) {
   const file = qbDir.getSourceFileOrThrow('select.ts');
   file

yarn.lock

@@ -5363,7 +5363,7 @@ __metadata:
     debugger-is-attached: "npm:^1.2.0"
     dotenv: "npm:^16.3.1"
     dotenv-expand: "npm:^10.0.0"
-    edgedb: "npm:^1.4.0"
+    edgedb: "patch:edgedb@npm%3A1.4.0#~/.yarn/patches/edgedb-npm-1.4.0-902d833279.patch"
     eslint: "npm:^8.52.0"
     eslint-plugin-no-only-tests: "npm:^3.1.0"
     eslint-plugin-typescript-sort-keys: "npm:^2.3.0"
@@ -5948,7 +5948,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"edgedb@npm:^1.4.0":
+"edgedb@npm:1.4.0":
   version: 1.4.0
   resolution: "edgedb@npm:1.4.0"
   bin:
@@ -5957,6 +5957,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"edgedb@patch:edgedb@npm%3A1.4.0#~/.yarn/patches/edgedb-npm-1.4.0-902d833279.patch":
+  version: 1.4.0
+  resolution: "edgedb@patch:edgedb@npm%3A1.4.0#~/.yarn/patches/edgedb-npm-1.4.0-902d833279.patch::version=1.4.0&hash=e71bbb"
+  bin:
+    edgeql-js: dist/cli.js
+  checksum: f6eabbf93a2e22a5b050daf7ac779eafc186297f75febbae0aa8ea2e17f09f176cee67adc937c89139082d09cf08227aec402c91a0c2f5168b677428d234425a
+  languageName: node
+  linkType: hard
+
 "editorconfig@npm:^1.0.3":
   version: 1.0.4
   resolution: "editorconfig@npm:1.0.4"