Merge pull request #2195 from cardstack/gracefully-handle-null-last-modified

realm can tolerate a null last_modified date in index when serving a module

Author: habdelra

packages/realm-server/tests/realm-endpoints-test.ts

@@ -3037,7 +3037,7 @@ module(basename(__filename), function () {
     module('various other realm tests', function (hooks) {
       let testRealmHttpServer2: Server;
       let testRealm2: Realm;
-      let dbAdapter: PgAdapter;
+      let dbAdapter2: PgAdapter;
       let publisher: QueuePublisher;
       let runner: QueueRunner;
       let testRealmDir: string;
@@ -3077,13 +3077,13 @@ module(basename(__filename), function () {
 
       setupDB(hooks, {
         beforeEach: async (_dbAdapter, _publisher, _runner) => {
-          dbAdapter = _dbAdapter;
+          dbAdapter2 = _dbAdapter;
           publisher = _publisher;
           runner = _runner;
           testRealmDir = join(dir.name, 'realm_server_2', 'test');
           ensureDirSync(testRealmDir);
           copySync(join(__dirname, 'cards'), testRealmDir);
-          await startRealmServer(dbAdapter, publisher, runner);
+          await startRealmServer(dbAdapter2, publisher, runner);
         },
         afterEach: async () => {
           if (seedRealm) {
@@ -3139,6 +3139,18 @@ module(basename(__filename), function () {
         assert.strictEqual(person.firstName, 'Mango', 'card data is correct');
       });
 
+      test('can load a module when "last_modified" field in index is null', async function (assert) {
+        await dbAdapter.execute('update boxel_index set last_modified = null');
+        let response = await request
+          .get(`/person`)
+          .set('Accept', '*/*')
+          .set(
+            'Authorization',
+            `Bearer ${createJWT(testRealm, 'user', ['read', 'write'])}`,
+          );
+        assert.strictEqual(response.status, 200, 'HTTP 200 status');
+      });
+
       test('can instantiate a card that uses a code-ref field', async function (assert) {
         let adoptsFrom = {
           module: `${testRealm2Href}code-ref-test`,

packages/runtime-common/index-query-engine.ts

@@ -64,7 +64,7 @@ interface IndexedModule {
   executableCode: string;
   source: string;
   canonicalURL: string;
-  lastModified: number;
+  lastModified: number | null;
   resourceCreatedAt: number;
   deps: string[] | null;
 }
@@ -74,7 +74,7 @@ export interface IndexedInstance {
   instance: CardResource;
   source: string;
   canonicalURL: string;
-  lastModified: number;
+  lastModified: number | null;
   resourceCreatedAt: number;
   isolatedHtml: string | null;
   embeddedHtml: { [refURL: string]: string } | null;
@@ -225,7 +225,7 @@ export class IndexQueryEngine {
       canonicalURL,
       executableCode,
       source,
-      lastModified: parseInt(lastModified),
+      lastModified: lastModified != null ? parseInt(lastModified) : null,
       resourceCreatedAt: parseInt(resourceCreatedAt),
       deps: moduleEntry.deps,
     };
@@ -311,7 +311,10 @@ export class IndexQueryEngine {
       type: 'instance',
       instance,
       source: instanceEntry.source,
-      lastModified: parseInt(instanceEntry.last_modified),
+      lastModified:
+        instanceEntry.last_modified != null
+          ? parseInt(instanceEntry.last_modified)
+          : null,
       resourceCreatedAt: parseInt(instanceEntry.resource_created_at),
     };
   }
@@ -1158,7 +1161,7 @@ function assertIndexEntrySource<T>(obj: T): Omit<
   'source' | 'last_modified' | 'resource_created_at'
 > & {
   source: string;
-  last_modified: string;
+  last_modified: string | null;
   resource_created_at: string;
 } {
   if (!obj || typeof obj !== 'object') {
@@ -1167,7 +1170,7 @@ function assertIndexEntrySource<T>(obj: T): Omit<
   if (!('source' in obj) || typeof obj.source !== 'string') {
     throw new Error(`expected index entry to have "source" string property`);
   }
-  if (!('last_modified' in obj) || typeof obj.last_modified !== 'string') {
+  if (!('last_modified' in obj)) {
     throw new Error(`expected index entry to have "last_modified" property`);
   }
   if (

packages/runtime-common/realm.ts

@@ -1040,7 +1040,9 @@ export class Realm {
           body: source,
           init: {
             headers: {
-              'last-modified': formatRFC7231(lastModified * 1000),
+              ...(lastModified != null
+                ? { 'last-modified': formatRFC7231(lastModified * 1000) }
+                : {}),
             },
           },
           requestContext,
@@ -1082,7 +1084,7 @@ export class Realm {
   private async getSourceFromIndex(url: URL): Promise<
     | {
         source: string;
-        lastModified: number;
+        lastModified: number | null;
         canonicalURL: URL;
       }
     | undefined
@@ -1109,10 +1111,10 @@ export class Realm {
           ? module.lastModified
           : instance?.type === 'instance'
             ? instance.lastModified
-            : undefined;
-      if (canonicalURL == null || source == null || lastModified == null) {
+            : null;
+      if (canonicalURL == null || source == null) {
         throw new Error(
-          `missing 'canonicalURL', 'source', and/or 'lastModified' from index entry ${
+          `missing 'canonicalURL' and/or 'source' from index entry ${
             url.href
           }, where type is ${
             module?.type === 'module' ? 'module' : 'instance'