Get ruleParams to the backend

Author: tonsky

client/packages/admin/src/index.ts

@@ -224,6 +224,11 @@ function init<
  */
 const init_experimental = init;
 
+function steps(inputChunks) {
+  const chunks = Array.isArray(inputChunks) ? inputChunks : [inputChunks];
+  return chunks.flatMap(getOps);
+}
+
 /**
  *
  * The first step: init your application!
@@ -340,7 +345,7 @@ class InstantAdmin<
     return jsonFetch(`${this.config.apiURI}/admin/transact`, {
       method: 'POST',
       headers: authorizedHeaders(this.config, this.impersonationOpts),
-      body: JSON.stringify({ steps: steps }),
+      body: JSON.stringify({ steps: steps(inputChunks) }),
     });
   };
 
@@ -419,7 +424,7 @@ class InstantAdmin<
       method: 'POST',
       headers: authorizedHeaders(this.config, this.impersonationOpts),
       body: JSON.stringify({
-        steps: steps,
+        steps: steps(inputChunks),
         'rules-override': opts?.rules,
         // @ts-expect-error because we're using a private API (for now)
         'dangerously-commit-tx': opts?.__dangerouslyCommit,
@@ -866,7 +871,7 @@ class InstantAdminDatabase<Schema extends InstantSchemaDef<any, any, any>> {
       method: 'POST',
       headers: authorizedHeaders(this.config, this.impersonationOpts),
       body: JSON.stringify({
-        steps: steps,
+        steps: steps(inputChunks),
         'throw-on-missing-attrs?': !!this.config.schema,
       }),
     });
@@ -947,7 +952,7 @@ class InstantAdminDatabase<Schema extends InstantSchemaDef<any, any, any>> {
       method: 'POST',
       headers: authorizedHeaders(this.config, this.impersonationOpts),
       body: JSON.stringify({
-        steps: steps,
+        steps: steps(inputChunks),
         'rules-override': opts?.rules,
         // @ts-expect-error because we're using a private API (for now)
         'dangerously-commit-tx': opts?.__dangerouslyCommit,

client/packages/core/src/instaml.js

@@ -175,7 +175,7 @@ function expandUnlink(attrs, [etype, eidA, obj]) {
 function expandUpdate(attrs, [etype, eid, obj]) {
   const lookup = extractLookup(attrs, etype, eid);
   // id first so that we don't clobber updates on the lookup field
-  const attrTuples = [['id', extractLookup(attrs, etype, eid)]]
+  const attrTuples = [['id', lookup]]
     .concat(Object.entries(obj))
     .map(([identName, value]) => {
       const attr = getAttrByFwdIdentName(attrs, etype, identName);
@@ -207,6 +207,12 @@ function expandDeepMerge(attrs, [etype, eid, obj]) {
   // id first so that we don't clobber updates on the lookup field
   return [idTuple].concat(attrTuples);
 }
+
+function expandRuleParams(attrs, [etype, eid, ruleParams]) {
+  const lookup = extractLookup(attrs, etype, eid);
+  return [['rule-params', lookup, etype, ruleParams]];
+}
+
 function removeIdFromArgs(step) {
   const [op, etype, eid, obj] = step;
   if (!obj) {
@@ -230,6 +236,8 @@ function toTxSteps(attrs, step) {
       return expandUnlink(attrs, args);
     case 'delete':
       return expandDelete(attrs, args);
+    case 'ruleParams':
+      return expandRuleParams(attrs, args);
     default:
       throw new Error(`unsupported action ${action}`);
   }
@@ -341,6 +349,7 @@ const SUPPORTS_LOOKUP_ACTIONS = new Set([
   'update',
   'merge',
   'delete',
+  'ruleParams'
 ]);
 
 const lookupProps = { 'unique?': true, 'index?': true };
@@ -481,21 +490,8 @@ function createMissingAttrs({ attrs: existingAttrs, schema }, ops) {
 
 export function transform(ctx, inputChunks) {
   const chunks = Array.isArray(inputChunks) ? inputChunks : [inputChunks];
-
   const ops = chunks.flatMap((tx) => getOps(tx));
   const [newAttrs, addAttrTxSteps] = createMissingAttrs(ctx, ops);
-
-  const txSteps = [];
-  for (const chunk of chunks) {
-    const ops = chunk.__ops;
-    const ruleParams = chunk.__ruleParams;
-    for (const op of ops) {
-      for (const txStep of toTxSteps(newAttrs, op)) {
-        const [op, a, b, c] = txStep;
-        txSteps.push(ruleParams ? [op, a, b, c, ruleParams] : txStep);
-      }
-    }
-  }
-
+  const txSteps = ops.flatMap((op) => toTxSteps(newAttrs, op));
   return [...addAttrTxSteps, ...txSteps];
 }

client/packages/core/src/instatx.ts

@@ -18,7 +18,6 @@ export interface TransactionChunk<
   EntityName extends keyof Schema['entities'],
 > {
   __ops: Op[];
-  __ruleParams: RuleParams;
   /**
    * Create and update objects:
    *
@@ -116,18 +115,13 @@ export type TxChunk<Schema extends IContainEntitiesAndLinks<any, any>> = {
 function transactionChunk(
   etype: EType,
   id: Id | LookupRef,
-  ruleParams: RuleParams,
   prevOps: Op[],
 ): TransactionChunk<any, any> {
   return new Proxy({} as TransactionChunk<any, any>, {
     get: (_target, cmd: keyof TransactionChunk<any, any>) => {
       if (cmd === '__ops') return prevOps;
-      if (cmd === '__ruleParams') return ruleParams;
-      if (cmd === 'ruleParams') {
-        return (args: Args) => transactionChunk(etype, id, {...ruleParams, ...args}, prevOps);
-      }
       return (args: Args) => {
-        return transactionChunk(etype, id, ruleParams, [...prevOps, [cmd, etype, id, args]]);
+        return transactionChunk(etype, id, [...prevOps, [cmd, etype, id, args]]);
       };
     },
   });
@@ -158,9 +152,9 @@ function etypeChunk(etype: EType): ETypeChunk<any, EType> {
     {
       get(_target, id: Id) {
         if (isLookup(id)) {
-          return transactionChunk(etype, parseLookup(id), undefined, []);
+          return transactionChunk(etype, parseLookup(id), []);
         }
-        return transactionChunk(etype, id, undefined, []);
+        return transactionChunk(etype, id, []);
       },
     },
   );
@@ -193,7 +187,3 @@ export const tx = txInit();
 export function getOps(x: TransactionChunk<any, any>): Op[] {
   return x.__ops;
 }
-
-export function getRuleParams(x: TransactionChunk<any, any>): RuleParams {
-  return x.__ruleParams;
-}

server/src/instant/admin/model.clj

@@ -168,6 +168,10 @@
   (let [lookup (extract-lookup attrs etype eid)]
     [[:delete-entity lookup etype]]))
 
+(defn expand-rule-params [attrs [etype eid params]]
+  (let [lookup (extract-lookup attrs etype eid)]
+    [[:rule-params lookup etype params]]))
+
 (defn expand-add-attr [_ [attr]]
   [[:add-attr (-> attr
                   w/keywordize-keys
@@ -188,6 +192,7 @@
       "link"   (expand-link attrs args)
       "unlink" (expand-unlink attrs args)
       "delete" (expand-delete attrs args)
+      "ruleParams" (expand-rule-params attrs args)
       "add-attr" (expand-add-attr attrs args)
       "delete-attr" (expand-delete-attr attrs args)
       (throw (ex-info (str "unsupported action " action) {})))))
@@ -376,6 +381,9 @@
 (s/def ::delete-op
   (s/cat :op #{"delete"} :args (s/cat :etype string? :eid ::lookup :remaining-args (s/* (constantly true)))))
 
+(s/def ::rule-params-op
+  (s/cat :op #{"ruleParams"} :args (s/cat :etype string? :eid ::lookup :args map?)))
+
 (s/def ::add-attr-op
   (s/cat :op #{"add-attr"} :attr map?))
 
@@ -394,6 +402,7 @@
              :link ::link-op
              :unlink ::unlink-op
              :delete ::delete-op
+             :rule-params ::rule-params-op
              :add-attr ::add-attr-op
              :update-attr ::update-attr-op
              :delete-attr ::delete-attr-op))

server/src/instant/db/transaction.clj

@@ -31,9 +31,10 @@
   (s/cat :op #{:add-attr} :attr ::attr-model/attr))
 
 (s/def ::delete-entity-step
-  (s/cat :op #{:delete-entity}
-         :lookup ::triple-model/lookup
-         :etype (s/? string?)))
+  (s/cat :op #{:delete-entity} :lookup ::triple-model/lookup :etype (s/? string?)))
+
+(s/def ::rule-params-step
+  (s/cat :op #{:rule-params} :lookup ::triple-model/lookup :etype (s/? string?) :params (s/map-of string? any?)))
 
 (s/def ::delete-attr-step
   (s/cat :op #{:delete-attr} :attr-id ::attr-model/id))
@@ -44,6 +45,7 @@
 (s/def ::tx-step (s/or :add-triple ::add-triple-step
                        :deep-merge-triple ::deep-merge-triple-step
                        :delete-entity ::delete-entity-step
+                       :rule-params ::rule-params-step
                        :retract-triple ::retract-triple-step
                        :add-attr ::add-attr-step
                        :update-attr ::update-attr-step