Experiment with no proxy for objects (#1031)

* Experiment with no proxy for objects reorder for diff reorder for diff reorder for diff reorder for diff update snapshot * Remove proxy for interface * Cleanup getDolloarLink * Changeset
palantir · Dec 9, 2024 · 720218d · 720218d
1 parent 5a4ebd7
commit 720218d
Show file tree

Hide file tree

Showing 14 changed files with 213 additions and 531 deletions.
diff --git a/.changeset/lucky-tomatoes-admire.md b/.changeset/lucky-tomatoes-admire.md
@@ -0,0 +1,5 @@
+---
+"@osdk/client": minor
+---
+
+OSDK Client no longer uses javascript proxies for its objects. This results in a 13% increase in construction time but at 1kb per object reduction in memory
diff --git a/packages/client/src/fetchMetadata.test.ts b/packages/client/src/fetchMetadata.test.ts
@@ -105,6 +105,13 @@ describe("FetchMetadata", () => {
         "primaryKeyApiName": "employeeId",
         "primaryKeyType": "integer",
         "properties": {
+          "class": {
+            "description": "",
+            "displayName": undefined,
+            "multiplicity": false,
+            "nullable": true,
+            "type": "string",
+          },
           "employeeId": {
             "description": undefined,
             "displayName": undefined,

diff --git a/packages/client/src/object/convertWireToOsdkObjects.test.ts b/packages/client/src/object/convertWireToOsdkObjects.test.ts
@@ -64,6 +64,7 @@ describe("convertWireToOsdkObjects", () => {
 
     expect(Object.keys(employee).sort()).toEqual([
       "employeeId",
+      "$title",
       "fullName",
       "office",
       "class",
@@ -227,128 +228,6 @@ describe("convertWireToOsdkObjects", () => {
     expect(prototypeBefore).not.toBe(prototypeAfter);
   });
 
-  it("updates interface when underlying changes - old", async () => {
-    const clientCtx = createMinimalClient(
-      { ontologyRid: $ontologyRid },
-      "https://stack.palantir.com",
-      async () => "myAccessToken",
-    );
-
-    let objectFromWire = {
-      __apiName: "Employee" as const,
-      __primaryKey: 0,
-      __title: "Steve",
-      fullName: "Steve",
-      employeeId: "5",
-    } satisfies OntologyObjectV2;
-
-    const [obj] = (await convertWireToOsdkObjects(
-      clientCtx,
-      [objectFromWire],
-      undefined,
-    )) as unknown as Osdk<Employee>[];
-
-    expect(obj.fullName).toEqual("Steve");
-    expect(Object.keys(obj).sort()).toEqual([
-      "$apiName",
-      "$objectType",
-      "$primaryKey",
-      "$title",
-      "employeeId",
-      "fullName",
-    ].sort());
-
-    const objAsFoo = obj.$as(FooInterface);
-    expect(objAsFoo).toMatchObject({
-      fooSpt: obj.fullName,
-      $apiName: FooInterface.apiName,
-      $primaryKey: obj.$primaryKey,
-      $objectType: obj.$objectType,
-      $title: obj.$title,
-    });
-
-    console.log(obj);
-    console.log(objAsFoo);
-
-    (obj as any).$updateInternalValues({
-      fullName: "Bob",
-    });
-    expect(obj.fullName).toEqual("Bob");
-    expect(objAsFoo.fooSpt).toEqual(obj.fullName);
-
-    expect(Object.keys(objAsFoo).sort()).toEqual([
-      "$apiName",
-      "$objectType",
-      "$primaryKey",
-      "$title",
-      "fooSpt",
-    ].sort());
-
-    expect(obj).toBe(objAsFoo.$as(Employee));
-    expect(objAsFoo).toBe(obj.$as(FooInterface));
-  });
-
-  it("updates interface when underlying changes - new", async () => {
-    const clientCtx = createMinimalClient(
-      { ontologyRid: $ontologyRid },
-      "https://stack.palantir.com",
-      async () => "myAccessToken",
-    );
-
-    let objectFromWire = {
-      __apiName: "Employee" as const,
-      __primaryKey: 0,
-      __title: "Steve",
-      fullName: "Steve",
-      employeeId: "5",
-    } satisfies OntologyObjectV2;
-
-    const [obj] = (await convertWireToOsdkObjects2(
-      clientCtx,
-      [objectFromWire],
-      undefined,
-    )) as unknown as Osdk<Employee>[];
-
-    expect(obj.fullName).toEqual("Steve");
-    expect(Object.keys(obj).sort()).toEqual([
-      "$apiName",
-      "$objectType",
-      "$primaryKey",
-      "$title",
-      "employeeId",
-      "fullName",
-    ].sort());
-
-    const objAsFoo = obj.$as(FooInterface);
-    expect(objAsFoo).toMatchObject({
-      fooSpt: obj.fullName,
-      $apiName: FooInterface.apiName,
-      $primaryKey: obj.$primaryKey,
-      $objectType: obj.$objectType,
-      $title: obj.$title,
-    });
-
-    console.log(obj);
-    console.log(objAsFoo);
-
-    (obj as any).$updateInternalValues({
-      fullName: "Bob",
-    });
-    expect(obj.fullName).toEqual("Bob");
-    expect(objAsFoo.fooSpt).toEqual(obj.fullName);
-
-    expect(Object.keys(objAsFoo).sort()).toEqual([
-      "$apiName",
-      "$objectType",
-      "$primaryKey",
-      "$title",
-      "fooSpt",
-    ].sort());
-
-    expect(obj).toBe(objAsFoo.$as(Employee));
-    expect(objAsFoo).toBe(obj.$as(FooInterface));
-  });
-
   it("reconstitutes interfaces properly without rid - old", async () => {
     const clientCtx = createMinimalClient(
       { ontologyRid: $ontologyRid },

diff --git a/packages/client/src/object/convertWireToOsdkObjects/InterfaceHolder.ts b/packages/client/src/object/convertWireToOsdkObjects/InterfaceHolder.ts
@@ -23,15 +23,9 @@ import type {
 import type { ObjectHolder } from "./ObjectHolder.js";
 
 /** @internal */
-export interface InterfaceHolderOwnProps<
+export interface InterfaceHolder<
   Q extends FetchedObjectTypeDefinition,
 > {
   [UnderlyingOsdkObject]: Osdk<Q> & ObjectHolder<Q>;
   [InterfaceDefRef]: InterfaceMetadata;
 }
-
-/** @internal */
-export interface InterfaceHolder<
-  Q extends FetchedObjectTypeDefinition,
-> extends InterfaceHolderOwnProps<Q> {
-}
diff --git a/packages/client/src/object/convertWireToOsdkObjects/InternalSymbols.ts b/packages/client/src/object/convertWireToOsdkObjects/InternalSymbols.ts
@@ -31,22 +31,11 @@ export const InterfaceDefRef = Symbol(
   process.env.MODE !== "production" ? "InterfaceDefinition" : undefined,
 );
 
-/** A symbol for getting the raw data object off of the holder an osdk object proxy points to */
-/** @internal */
-export const RawObject = Symbol(
-  process.env.MODE !== "production" ? "RawObject" : undefined,
-);
-
 /** @internal */
 export const ClientRef = Symbol(
   process.env.MODE !== "production" ? "ClientRef" : undefined,
 );
 
-/** @internal */
-export const CachedPropertiesRef = Symbol(
-  process.env.MODE !== "production" ? "CachedProperties" : undefined,
-);
-
 export interface HolderBase<T extends ObjectOrInterfaceDefinition> {
   [UnderlyingOsdkObject]: OsdkBase<any>;
   [ObjectDefRef]?: T;

diff --git a/packages/client/src/object/convertWireToOsdkObjects/ObjectHolder.ts b/packages/client/src/object/convertWireToOsdkObjects/ObjectHolder.ts
@@ -15,36 +15,21 @@
  */
 
 import type { Osdk } from "@osdk/api";
-import type { OntologyObjectV2 } from "@osdk/internal.foundry.core";
 import type { MinimalClient } from "../../MinimalClientContext.js";
 import type { FetchedObjectTypeDefinition } from "../../ontology/OntologyProvider.js";
 import type { DollarAsFn } from "./getDollarAs.js";
 import type { get$link } from "./getDollarLink.js";
 import type {
-  CachedPropertiesRef,
   ClientRef,
   ObjectDefRef,
-  RawObject,
   UnderlyingOsdkObject,
 } from "./InternalSymbols.js";
 
 /** @internal */
-export interface ObjectHolderPrototypeOwnProps {
+export interface ObjectHolder<Q extends FetchedObjectTypeDefinition> {
+  readonly [UnderlyingOsdkObject]: Osdk<Q>;
   readonly [ObjectDefRef]: FetchedObjectTypeDefinition;
   readonly [ClientRef]: MinimalClient;
   readonly "$as": DollarAsFn;
   readonly "$link": ReturnType<typeof get$link>;
-  readonly "$updateInternalValues": (newValues: Record<string, any>) => void;
-}
-/** @internal */
-export interface ObjectHolderOwnProperties {
-  [RawObject]: OntologyObjectV2;
-  [CachedPropertiesRef]: Map<string | symbol, any>;
-}
-
-/** @internal */
-export interface ObjectHolder<Q extends FetchedObjectTypeDefinition>
-  extends ObjectHolderPrototypeOwnProps, ObjectHolderOwnProperties
-{
-  [UnderlyingOsdkObject]: Osdk<Q>;
 }
diff --git a/packages/client/src/object/convertWireToOsdkObjects/createOsdkInterface.test.ts b/packages/client/src/object/convertWireToOsdkObjects/createOsdkInterface.test.ts
@@ -52,8 +52,7 @@ describe(createOsdkInterface, () => {
         status: "ACTIVE",
       } satisfies FetchedObjectTypeDefinition,
     };
-    // underlying: Osdk<Q> & ObjectHolder<Q>,
-    // interfaceDef: InterfaceMetadata,
+
     const iface = createOsdkInterface(underlying as any, {
       "apiName": "IFoo",
       displayName: "",
@@ -114,8 +113,7 @@ describe(createOsdkInterface, () => {
         status: "ACTIVE",
       } satisfies FetchedObjectTypeDefinition,
     };
-    // underlying: Osdk<Q> & ObjectHolder<Q>,
-    // interfaceDef: InterfaceMetadata,
+
     const iface = createOsdkInterface(underlying as any, {
       "apiName": "a.IFoo",
       displayName: "",
@@ -176,8 +174,7 @@ describe(createOsdkInterface, () => {
         status: "ACTIVE",
       } satisfies FetchedObjectTypeDefinition,
     };
-    // underlying: Osdk<Q> & ObjectHolder<Q>,
-    // interfaceDef: InterfaceMetadata,
+
     const iface = createOsdkInterface(underlying as any, {
       "apiName": "a.IFoo",
       displayName: "",