fix: ensure cachehandler responses are cast to documents (#9459)

packages/request/src/-private/utils.ts

@@ -1,11 +1,12 @@
 import { DEBUG } from '@warp-drive/build-config/env';
 import { getOrSetGlobal } from '@warp-drive/core-types/-private';
-import {
-  type RequestInfo,
-  STRUCTURED,
-  type StructuredDataDocument,
-  type StructuredErrorDocument,
+import type {
+  RequestInfo,
+  StructuredDataDocument,
+  StructuredDocument,
+  StructuredErrorDocument,
 } from '@warp-drive/core-types/request';
+import { STRUCTURED } from '@warp-drive/core-types/request';
 
 import { Context, ContextOwner } from './context';
 import { assertValidRequest } from './debug';
@@ -59,6 +60,28 @@ function isDoc<T>(doc: T | StructuredDataDocument<T>): doc is StructuredDataDocu
   return doc && (doc as StructuredDataDocument<T>)[STRUCTURED] === true;
 }
 
+function ensureDoc<T>(owner: ContextOwner, content: T | Error, isError: boolean): StructuredDocument<T> {
+  if (isDoc(content)) {
+    return content as StructuredDocument<T>;
+  }
+
+  if (isError) {
+    return {
+      [STRUCTURED]: true,
+      request: owner.request,
+      response: owner.getResponse(),
+      error: content as Error,
+    } as StructuredErrorDocument<T>;
+  }
+
+  return {
+    [STRUCTURED]: true,
+    request: owner.request,
+    response: owner.getResponse(),
+    content: content as T,
+  };
+}
+
 export type HttpErrorProps = {
   code: number;
   name: string;
@@ -151,7 +174,7 @@ export function executeNextHandler<T>(
     outcome = wares[i].request<T>(context, next);
     if (!!outcome && isCacheHandler(wares[i], i)) {
       if (!(outcome instanceof Promise)) {
-        setRequestResult(owner.requestId, { isError: false, result: outcome });
+        setRequestResult(owner.requestId, { isError: false, result: ensureDoc(owner, outcome, false) });
         outcome = Promise.resolve(outcome);
       }
     } else if (DEBUG) {
@@ -166,7 +189,7 @@ export function executeNextHandler<T>(
     }
   } catch (e) {
     if (isCacheHandler(wares[i], i)) {
-      setRequestResult(owner.requestId, { isError: true, result: e });
+      setRequestResult(owner.requestId, { isError: true, result: ensureDoc(owner, e, true) });
     }
     outcome = Promise.reject<StructuredDataDocument<T>>(e);
   }

packages/schema-record/eslint.config.mjs

@@ -11,7 +11,7 @@ export default [
   // browser (js/ts) ================
   typescript.browser({
     srcDirs: ['src'],
-    allowedImports: ['@ember/debug'],
+    allowedImports: ['@ember/debug', '@ember/-internals/metal'],
   }),
 
   // node (module) ================

packages/schema-record/src/record.ts

@@ -463,6 +463,10 @@ export class SchemaRecord {
           if (prop === 'constructor') {
             return SchemaRecord;
           }
+          // too many things check for random symbols
+          if (typeof prop === 'symbol') {
+            return undefined;
+          }
           throw new Error(`No field named ${String(prop)} on ${identifier.type}`);
         }
 

packages/store/src/-private/cache-handler.ts

@@ -507,9 +507,12 @@ export const CacheHandler: CacheHandlerType = {
       store.requestManager._pending.set(context.id, promise);
     }
 
+    assert(`Expected a peeked request to be present`, peeked);
+
     const shouldHydrate: boolean = context.request[EnableHydration] || false;
+    context.setResponse(peeked.response);
 
-    if ('error' in peeked!) {
+    if ('error' in peeked) {
       const content = shouldHydrate
         ? maybeUpdateUiObjects<T>(
             store,
@@ -529,10 +532,10 @@ export const CacheHandler: CacheHandlerType = {
           store,
           context.request,
           { shouldHydrate, identifier },
-          peeked!.content as ResourceDataDocument,
+          peeked.content as ResourceDataDocument,
           true
         )
-      : (peeked!.content as T);
+      : (peeked.content as T);
 
     return result;
   },

tests/warp-drive__ember/.mock-cache/733572b0/GET-0-users/1/res.meta.json → tests/warp-drive__ember/.mock-cache/99723d91/GET-0-users/2/res.meta.json

@@ -1,5 +1,5 @@
 {
-  "url": "users/1",
+  "url": "users/2",
   "status": 200,
   "statusText": "OK",
   "headers": {

tests/warp-drive__ember/.mock-cache/eea0d109/GET-0-users/1/res.meta.json → tests/warp-drive__ember/.mock-cache/a12647a9/GET-0-users/2/res.meta.json

@@ -1,5 +1,5 @@
 {
-  "url": "users/1",
+  "url": "users/2",
   "status": 200,
   "statusText": "OK",
   "headers": {

tests/warp-drive__ember/app/services/store.ts

@@ -7,6 +7,7 @@ import type { StableRecordIdentifier } from '@warp-drive/core-types';
 import type { Cache } from '@warp-drive/core-types/cache';
 import { instantiateRecord, teardownRecord } from '@warp-drive/schema-record/hooks';
 import type { SchemaRecord } from '@warp-drive/schema-record/record';
+import { SchemaService } from '@warp-drive/schema-record/schema';
 
 export default class Store extends DataStore {
   constructor(args: unknown) {
@@ -17,15 +18,19 @@ export default class Store extends DataStore {
     manager.useCache(CacheHandler);
   }
 
-  override createCache(capabilities: CacheCapabilitiesManager): Cache {
+  createSchemaService() {
+    return new SchemaService();
+  }
+
+  createCache(capabilities: CacheCapabilitiesManager): Cache {
     return new JSONAPICache(capabilities);
   }
 
-  override instantiateRecord(identifier: StableRecordIdentifier, createArgs?: Record<string, unknown>): SchemaRecord {
+  instantiateRecord(identifier: StableRecordIdentifier, createArgs?: Record<string, unknown>): SchemaRecord {
     return instantiateRecord(this, identifier, createArgs);
   }
 
-  override teardownRecord(record: SchemaRecord): void {
+  teardownRecord(record: SchemaRecord): void {
     return teardownRecord(record);
   }
 }

tests/warp-drive__ember/tests/integration/get-request-state-test.gts

@@ -3,6 +3,7 @@ import { rerender, settled } from '@ember/test-helpers';
 import type { CacheHandler, Future, NextFn, RequestContext, StructuredDataDocument } from '@ember-data/request';
 import RequestManager from '@ember-data/request';
 import Fetch from '@ember-data/request/fetch';
+import { buildBaseURL } from '@ember-data/request-utils';
 import type { RenderingTestContext } from '@warp-drive/diagnostic/ember';
 import { module, setupRenderingTest, test as _test } from '@warp-drive/diagnostic/ember';
 import { getRequestState } from '@warp-drive/ember';
@@ -77,7 +78,7 @@ async function mockGETSuccess(context: LocalTestContext): Promise<string> {
     }),
     { RECORD: RECORD }
   );
-  return 'https://localhost:1135/users/1';
+  return buildBaseURL({ resourcePath: 'users/1' });
 }
 async function mockGETFailure(context: LocalTestContext): Promise<string> {
   await mock(
@@ -102,7 +103,7 @@ async function mockGETFailure(context: LocalTestContext): Promise<string> {
     RECORD
   );
 
-  return 'https://localhost:1135/users/2';
+  return buildBaseURL({ resourcePath: 'users/2' });
 }
 
 module<LocalTestContext>('Integration | get-request-state', function (hooks) {
@@ -169,9 +170,11 @@ module<LocalTestContext>('Integration | get-request-state', function (hooks) {
         status: 404,
         name: 'NotFoundError',
         isRequestError: true,
-        error: '[404 Not Found] GET (cors) - https://localhost:1135/users/2?__xTestId=b830e11d&__xTestRequestNumber=0',
+        error: `[404 Not Found] GET (cors) - ${buildBaseURL({
+          resourcePath: 'users/2',
+        })}?__xTestId=b830e11d&__xTestRequestNumber=0`,
         statusText: 'Not Found',
-        message: '[404 Not Found] GET (cors) - https://localhost:1135/users/2',
+        message: `[404 Not Found] GET (cors) - ${buildBaseURL({ resourcePath: 'users/2' })}`,
         errors: [{ status: '404', title: 'Not Found', detail: 'The resource does not exist.' }],
         content: {
           errors: [{ status: '404', title: 'Not Found', detail: 'The resource does not exist.' }],
@@ -414,13 +417,13 @@ module<LocalTestContext>('Integration | get-request-state', function (hooks) {
     assert.true(state1!.error instanceof Error, 'error is an instance of Error');
     assert.equal(
       (state1!.error as Error | undefined)?.message,
-      '[404 Not Found] GET (cors) - https://localhost:1135/users/2',
+      `[404 Not Found] GET (cors) - ${buildBaseURL({ resourcePath: 'users/2' })}`,
       'error message is correct'
     );
     assert.equal(counter, 2, 'counter is 2');
     assert.equal(
       this.element.textContent?.trim(),
-      '[404 Not Found] GET (cors) - https://localhost:1135/users/2\n          Count:\n          2'
+      `[404 Not Found] GET (cors) - ${buildBaseURL({ resourcePath: 'users/2' })}\n          Count:\n          2`
     );
   });
 
@@ -463,26 +466,26 @@ module<LocalTestContext>('Integration | get-request-state', function (hooks) {
     assert.true(state1!.error instanceof Error, 'error is an instance of Error');
     assert.equal(
       (state1!.error as Error | undefined)?.message,
-      '[404 Not Found] GET (cors) - https://localhost:1135/users/2',
+      `[404 Not Found] GET (cors) - ${buildBaseURL({ resourcePath: 'users/2' })}`,
       'error message is correct'
     );
     assert.equal(counter, 1, 'counter is 1');
     assert.equal(
       this.element.textContent?.trim(),
-      '[404 Not Found] GET (cors) - https://localhost:1135/users/2\n          Count:\n          1'
+      `[404 Not Found] GET (cors) - ${buildBaseURL({ resourcePath: 'users/2' })}\n          Count:\n          1`
     );
     await rerender();
     assert.equal(state1!.result, null, 'after rerender result is still null');
     assert.true(state1!.error instanceof Error, 'error is an instance of Error');
     assert.equal(
       (state1!.error as Error | undefined)?.message,
-      '[404 Not Found] GET (cors) - https://localhost:1135/users/2',
+      `[404 Not Found] GET (cors) - ${buildBaseURL({ resourcePath: 'users/2' })}`,
       'error message is correct'
     );
     assert.equal(counter, 1, 'counter is 1');
     assert.equal(
       this.element.textContent?.trim(),
-      '[404 Not Found] GET (cors) - https://localhost:1135/users/2\n          Count:\n          1'
+      `[404 Not Found] GET (cors) - ${buildBaseURL({ resourcePath: 'users/2' })}\n          Count:\n          1`
     );
   });
 });