Merge pull request #762 from gadget-inc/revert-754-record-reload

Revert "Give records a reference to the model manager which loaded them"

Author: garymardell

packages/api-client-core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gadgetinc/api-client-core",
-  "version": "0.15.39",
+  "version": "0.15.40",
   "files": [
     "Readme.md",
     "dist/**/*"

packages/api-client-core/spec/GadgetRecord.spec.ts

@@ -1,4 +1,3 @@
-import type { AnyPublicModelManager } from "../src/AnyModelManager.js";
 import { ChangeTracking, GadgetRecord } from "../src/GadgetRecord.js";
 interface SampleBaseRecord {
   id?: string;
@@ -39,8 +38,6 @@ const expectPersistedChanges = (record: GadgetRecord<SampleBaseRecord>, ...prope
   return _expectChanges(record, ChangeTracking.SinceLastPersisted, ...properties);
 };
 
-const mockModelManager: AnyPublicModelManager = {} as any;
-
 describe("GadgetRecord", () => {
   let productBaseRecord: SampleBaseRecord;
   beforeAll(() => {
@@ -51,16 +48,6 @@ describe("GadgetRecord", () => {
     };
   });
 
-  it("can be constructed with a base record and no model manager for backwards compatibility", () => {
-    const product = new GadgetRecord<SampleBaseRecord>(productBaseRecord);
-    expect(product.id).toEqual("123");
-    expect(product.name).toEqual("A cool product");
-  });
-
-  it("can be constructed with a base record and a model manager", () => {
-    new GadgetRecord<SampleBaseRecord>(productBaseRecord, mockModelManager);
-  });
-
   it("should respond toJSON, which returns the inner __gadget.fields properties", () => {
     const product = new GadgetRecord<SampleBaseRecord>(productBaseRecord);
     expect(product.toJSON()).toEqual({

packages/api-client-core/spec/operationRunners.spec.ts

@@ -4,7 +4,7 @@ import { diff } from "@n1ru4l/json-patch-plus";
 import { CombinedError } from "@urql/core";
 import nock from "nock";
 import { BackgroundActionHandle } from "../src/BackgroundActionHandle.js";
-import type { AnyPublicModelManager, GadgetErrorGroup, LimitToKnownKeys } from "../src/index.js";
+import type { AnyModelManager, GadgetErrorGroup, LimitToKnownKeys } from "../src/index.js";
 import {
   GadgetConnection,
   actionRunner,
@@ -48,7 +48,6 @@ describe("type checks", () => {
 // eslint-disable-next-line jest/no-export
 describe("operationRunners", () => {
   let connection: GadgetConnection;
-  let manager: AnyPublicModelManager;
   let query: string | undefined;
   let mockUrqlClient: MockUrqlClient;
 
@@ -61,26 +60,25 @@ describe("operationRunners", () => {
       },
     });
     jest.spyOn(connection, "currentClient" as any, "get").mockReturnValue(mockUrqlClient as any);
-    manager = { connection } as AnyPublicModelManager;
   });
 
   describe("findOneRunner", () => {
     test("can execute a findOne operation against a model", async () => {
       const promise = findOneRunner({ connection }, "widget", "123", { id: true, name: true }, "widget");
 
       expect(query).toMatchInlineSnapshot(`
-        "query widget($id: GadgetID!) {
-          widget(id: $id) {
-            id
-            name
-            __typename
-          }
-          gadgetMeta {
-            hydrations(modelName: 
-        "widget")
-          }
-        }"
-      `);
+              "query widget($id: GadgetID!) {
+                widget(id: $id) {
+                  id
+                  name
+                  __typename
+                }
+                gadgetMeta {
+                  hydrations(modelName: 
+              "widget")
+                }
+              }"
+            `);
 
       mockUrqlClient.executeQuery.pushResponse("widget", {
         data: {
@@ -318,32 +316,32 @@ describe("operationRunners", () => {
 
   describe("findManyRunner", () => {
     test("can execute a findMany operation against a model", async () => {
-      const promise = findManyRunner({ connection } as AnyPublicModelManager, "widgets", { id: true, name: true }, "widget");
+      const promise = findManyRunner({ connection } as AnyModelManager, "widgets", { id: true, name: true }, "widget");
 
       expect(query).toMatchInlineSnapshot(`
-        "query widgets($after: String, $first: Int, $before: String, $last: Int) {
-          widgets(after: $after, first: $first, before: $before, last: $last) {
-            pageInfo {
-              hasNextPage
-              hasPreviousPage
-              startCursor
-              endCursor
-            }
-            edges {
-              cursor
-              node {
-                id
-                name
-                __typename
-              }
-            }
-          }
-          gadgetMeta {
-            hydrations(modelName: 
-        "widget")
-          }
-        }"
-      `);
+              "query widgets($after: String, $first: Int, $before: String, $last: Int) {
+                widgets(after: $after, first: $first, before: $before, last: $last) {
+                  pageInfo {
+                    hasNextPage
+                    hasPreviousPage
+                    startCursor
+                    endCursor
+                  }
+                  edges {
+                    cursor
+                    node {
+                      id
+                      name
+                      __typename
+                    }
+                  }
+                }
+                gadgetMeta {
+                  hydrations(modelName: 
+              "widget")
+                }
+              }"
+            `);
 
       mockUrqlClient.executeQuery.pushResponse("widgets", {
         data: {
@@ -371,7 +369,7 @@ describe("operationRunners", () => {
 
     test("can execute a findMany operation against a namespaced model", async () => {
       const promise = findManyRunner(
-        { connection } as AnyPublicModelManager,
+        { connection } as AnyModelManager,
         "widgets",
         { id: true, name: true },
         "widget",
@@ -438,7 +436,7 @@ describe("operationRunners", () => {
 
     test("can execute a findMany operation against a namespaced model when the namespace is a string", async () => {
       const promise = findManyRunner(
-        { connection } as AnyPublicModelManager,
+        { connection } as AnyModelManager,
         "widgets",
         { id: true, name: true },
         "widget",
@@ -504,7 +502,9 @@ describe("operationRunners", () => {
   describe("actionRunner", () => {
     test("can run a single create action", async () => {
       const promise = actionRunner<{ id: string; name: string }>(
-        manager,
+        {
+          connection,
+        },
         "createWidget",
         { id: true, name: true },
         "widget",
@@ -544,7 +544,9 @@ describe("operationRunners", () => {
 
     test("can run a single update action", async () => {
       const promise = actionRunner<{ id: string; name: string }>(
-        manager,
+        {
+          connection,
+        },
         "updateWidget",
         { id: true, name: true },
         "widget",
@@ -589,7 +591,9 @@ describe("operationRunners", () => {
 
     test("can run a single action with an object result type", async () => {
       const promise = actionRunner(
-        manager,
+        {
+          connection,
+        },
         "upsertWidget",
         { id: true, name: true, eventAt: true },
         "widget",
@@ -642,7 +646,9 @@ describe("operationRunners", () => {
 
     test("can run a single action with an object result type that has an inner return type", async () => {
       const promise = actionRunner(
-        manager,
+        {
+          connection,
+        },
         "upsertWidget",
         { id: true, name: true, eventAt: true },
         "widget",
@@ -687,7 +693,9 @@ describe("operationRunners", () => {
 
     test("can run an action with hasReturnType", async () => {
       const promise = actionRunner(
-        manager,
+        {
+          connection,
+        },
         "createWidget",
         { id: true, name: true },
         "widget",
@@ -725,7 +733,9 @@ describe("operationRunners", () => {
 
     test("can throw the error returned by the server for a single action", async () => {
       const promise = actionRunner<{ id: string; name: string }>(
-        manager,
+        {
+          connection,
+        },
         "updateWidget",
         { id: true, name: true },
         "widget",
@@ -770,7 +780,9 @@ describe("operationRunners", () => {
 
     test("can run a bulk action by ids", async () => {
       const promise = actionRunner<{ id: string; name: string }>(
-        manager,
+        {
+          connection,
+        },
         "bulkFlipWidgets",
         { id: true, name: true },
         "widget",
@@ -818,7 +830,9 @@ describe("operationRunners", () => {
 
     test("can run a bulk action with params", async () => {
       const promise = actionRunner<{ id: string; name: string }>(
-        manager,
+        {
+          connection,
+        },
         "bulkCreateWidgets",
         { id: true, name: true },
         "widget",
@@ -866,7 +880,9 @@ describe("operationRunners", () => {
 
     test("can run a bulk action with a returnType", async () => {
       const promise = actionRunner(
-        manager,
+        {
+          connection,
+        },
         "bulkCreateWidgets",
         { id: true, name: true },
         "widget",
@@ -905,7 +921,9 @@ describe("operationRunners", () => {
 
     test("can run a bulk action with an object returnType", async () => {
       const promise = actionRunner(
-        manager,
+        {
+          connection,
+        },
         "bulkUpsertWidgets",
         { id: true, name: true },
         "widget",
@@ -952,7 +970,9 @@ describe("operationRunners", () => {
 
     test("throws a nice error when a bulk action returns errors", async () => {
       const promise = actionRunner<{ id: string; name: string }>(
-        manager,
+        {
+          connection,
+        },
         "bulkCreateWidgets",
         { id: true, name: true },
         "widget",
@@ -990,7 +1010,9 @@ describe("operationRunners", () => {
 
     test("throws a nice error when a bulk action returns errors and data", async () => {
       const promise = actionRunner<{ id: string; name: string }>(
-        manager,
+        {
+          connection,
+        },
         "bulkCreateWidgets",
         { id: true, name: true },
         "widget",
@@ -1035,7 +1057,9 @@ describe("operationRunners", () => {
 
     test("returns undefined when bulk action does not have a result", async () => {
       const promise = actionRunner<{ id: string; name: string }>(
-        manager,
+        {
+          connection,
+        },
         "bulkDeleteWidgets",
         null,
         "widget",
@@ -1934,7 +1958,7 @@ describe("operationRunners", () => {
       test("can run a live findMany", async () => {
         const iterator = asyncIterableToIterator(
           findManyRunner<{ id: string; name: string }, { live: true }>(
-            { connection } as AnyPublicModelManager,
+            { connection } as AnyModelManager,
             "widgets",
             { id: true, name: true },
             "widget",