@knowlearning/agents 0.9.127 → 0.9.129

package/agents/browser/embedded.js

@@ -1,6 +1,6 @@
 import { validate as isUUID, v1 as uuid } from 'uuid'
+import PatchProxy from '@knowlearning/patch-proxy'
 import watchImplementation from '../watch.js'
-import MutableProxy from '../../persistence/json.js'
 
 export default function EmbeddedAgent() {
   let messageIndex = 0
@@ -113,7 +113,7 @@ export default function EmbeddedAgent() {
     }
     tagIfNotYetTaggedInSession('subscribed', scope)
     const startState = await send({ type: 'state', scope, user, domain })
-    return new MutableProxy(startState, patch => {
+    return new PatchProxy(startState, patch => {
       //  TODO: reject updates if user is not owner
       const activePatch = structuredClone(patch)
       activePatch.forEach(entry => entry.path.unshift('active'))
@@ -199,7 +199,7 @@ export default function EmbeddedAgent() {
 
   async function metadata(scope, user, domain) {
     const md = await send({ type: 'metadata', scope, user, domain })
-    return new MutableProxy(md, patch => {
+    return new PatchProxy(md, patch => {
       const activePatch = structuredClone(patch)
       activePatch.forEach(entry => {
         if (!isValidMetadataMutation(entry)) throw new Error('You may only modify the type or name for a scope\'s metadata')

package/agents/browser/initialize.js

@@ -151,10 +151,6 @@ function embed(environment, iframe) {
     }
   })
 
-  //  write in a temporary loading notification while frame loads
-  const cw = iframe.contentWindow
-  if (cw) cw.document.body.innerHTML = 'Loading...'
-
   //  TODO: make sure content security policy headers for embedded domain always restrict iframe
   //        src to only self for embedded domain
   iframe.onload = () => {

package/agents/generic/index.js

@@ -1,5 +1,5 @@
 import { validate as isUUID } from 'uuid'
-import MutableProxy from '../../persistence/json.js'
+import PatchProxy from '@knowlearning/patch-proxy'
 import messageQueue from './message-queue.js'
 import stateImplementation from './state.js'
 import watchImplementation from '../watch.js'
@@ -154,7 +154,7 @@ export default function Agent({ Connection, domain, token, uuid, fetch, applyPat
   async function metadata(id=DEFAULT_SCOPE_NAME, user, domain) {
     const md = structuredClone(await state(id, user).metadata)
     delete md.active
-    return new MutableProxy(md, patch => {
+    return new PatchProxy(md, patch => {
       const activePatch = structuredClone(patch)
       if (!activePatch.every(isValidMetadataMutation)) {
         throw new Error("You may only modify the type or name for a scope's metadata")

package/agents/generic/message-queue.js

@@ -1,24 +1,13 @@
 import { validate as isUUID } from 'uuid'
+import { standardJSONPatch } from '@knowlearning/patch-proxy'
 
 const HEARTBEAT_TIMEOUT = 10000
 const DOMAIN_MESSAGES = { open: true, mutate: true, close: true }
 
-//  transform our custom path implementation to the standard JSONPatch path
-function standardJSONPatch(patch) {
-  return patch.map(p => {
-    return {...p, path: '/' + p.path.map(sanitizeJSONPatchPathSegment).join('/')}
-  })
-}
-
 function activePatch(patch) {
   return structuredClone(patch).filter(({ path }) => 'active' === path.shift())
 }
 
-function sanitizeJSONPatchPathSegment(s) {
-  if (typeof s === "string") return s.replaceAll('~', '~0').replaceAll('/', '~1')
-  else return s
-}
-
 export default function messageQueue({ token, domain, Connection, watchers, states, applyPatch, log, login, reboot, handleDomainMessage, trigger }) {
   let connection
   let user

package/agents/generic/state.js

@@ -1,5 +1,5 @@
 import { v4 as uuid, validate as isUUID } from 'uuid'
-import MutableProxy from '../../persistence/json.js'
+import PatchProxy from '@knowlearning/patch-proxy'
 
 export default function(scope='[]', user, domain, { keyToSubscriptionId, watchers, states, create, environment, lastMessageResponse, lastInteractionResponse, tagIfNotYetTaggedInSession, interact, log }) {
   let resolveMetadataPromise
@@ -34,7 +34,7 @@ export default function(scope='[]', user, domain, { keyToSubscriptionId, watcher
       const active = data.active
       delete data.active
       resolveMetadataPromise(data)
-      resolveState(new MutableProxy(active || {}, patch => {
+      resolveState(new PatchProxy(active || {}, patch => {
         const activePatch = structuredClone(patch)
         activePatch.forEach(entry => entry.path.unshift('active'))
         interact(scope, activePatch)

package/agents/watch.js

@@ -80,9 +80,13 @@ export default function({ metadata, environment, state, watchers, synced, sentUp
   }
 
   function removeWatcher(key, fn) {
+    if (!watchers[key]) {
+      console.warn('NO WATCHERS FOR KEY', key, fn)
+      return
+    }
     const watcherIndex = watchers[key].findIndex(x => x === fn)
     if (watcherIndex > -1) watchers[key].splice(watcherIndex, 1)
-    else console.warn('TRIED TO REMOVE WATCHER THAT DOES NOT EXIST')
+    else console.warn('TRIED TO REMOVE WATCHER THAT DOES NOT EXIST', key, fn)
   }
 
   return [ watch, removeWatcher ]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowlearning/agents",
-  "version": "0.9.127",
+  "version": "0.9.129",
   "description": "API for embedding applications in KnowLearning systems.",
   "main": "node.js",
   "browser": "browser.js",
@@ -23,6 +23,7 @@
   },
   "homepage": "https://github.com/knowlearning/platform#readme",
   "dependencies": {
+    "@knowlearning/patch-proxy": "^1.3.1",
     "fast-json-patch": "^3.1.1",
     "uuid": "^8.3.2",
     "vue": "^3.3.4",

package/vue/3/persist/vuex.js

@@ -1,5 +1,4 @@
-import MutableProxy from '../../../persistence/json.js'
-
+import PatchProxy from '@knowlearning/patch-proxy'
 //  TODO: consider path serialization approach. Also consider just using a mutable proxy from agent.state...
 
 const copy = x => JSON.parse(JSON.stringify(x))
@@ -29,7 +28,7 @@ export default async function (storeDefinition, scope) {
   const ephemeralPaths = {}
   Object.keys(scopedPaths).forEach(key => ephemeralPaths[key] = true)
 
-  stateAttachedStore.state = () => MutableProxy(state, handlePatch, ephemeralPaths)
+  stateAttachedStore.state = () => PatchProxy(state, handlePatch, ephemeralPaths)
   return stateAttachedStore
 }
 
@@ -70,7 +69,7 @@ async function attachModuleState(state, module, scopedPaths, path='') {
     }
     const initState = await Agent.state(scope)
     const ephemeralPaths = descendantPaths(path, scopedPaths)
-    state = MutableProxy(copy(initState), handlePatch, ephemeralPaths)
+    state = PatchProxy(copy(initState), handlePatch, ephemeralPaths)
     if (await scopeIsUninitialized(scope)) {
       Object.assign(state, module.state instanceof Function ? module.state() : module.state)
     }

package/persistence/json.js

@@ -1,95 +0,0 @@
-const proxies = new Set()
-
-// TODO make serialization more reliable... basically: handle if prop includes "
-function serializePath(path) {
-  return `/${path.join('/')}`
-}
-
-//  TODO: add extra argument for "ignorePrefixes" to ignore interactions at certain paths
-export default function MutableProxy(state, interact, ephemeralPaths={}, parentPath=[], rootState) {
-  if (ephemeralPaths[serializePath(parentPath)]) return state
-  if (!rootState) rootState = state
-  if (proxies.has(state)) {
-    //  TODO: simply return with no effect if redundantly setting state like a[x] = a[x]
-    throw new Error(`Cannot add mutable state to multiple mutable parents. Attempted Path: ${serializePath(parentPath)}`)
-  }
-
-  const isArray = Array.isArray(state)
-
-  const childMutableProxy = (prop, value) => MutableProxy(
-    value,
-    interact,
-    ephemeralPaths,
-    [...parentPath, prop],
-    rootState
-  )
-
-  //  recursively ensure child objects are converted to proxies (unless they are in an ephemeral path)
-  Object
-    .entries(state)
-    .filter(([, value]) => value instanceof Object)
-    .forEach(([key, value]) => {
-      if (isArray && /^\d+$/.test(key)) key = parseInt(key)
-      state[key] = childMutableProxy(key, value)
-    })
-
-  const traps = {
-    set(target, prop, value) {
-      if (isArray) {
-        if (!/^\d+$/.test(prop)) {
-          target[prop] = value
-          return true
-        }
-        else prop = parseInt(prop)
-      }
-
-      const path = [...parentPath, prop]
-      const serializedPath = serializePath(path)
-
-      if (ephemeralPaths[serializedPath]) {
-        target[prop] = value
-        return true
-      }
-
-      if (value === undefined) {
-        console.log('EXTRA ERROR INFO. target, prop, value', target, prop, value)
-        throw new Error(`Setting properties to undefined is not supported. Please use a delete statement. Attempted to set ${serializedPath}`)
-      }
-
-      //  TODO: probably want to batch interactions that represent array mutations... and/or do
-      //        something smart around insertions/deletions
-      //  TODO: if is array and prop is last element, consider passing -1 as prop
-      interact([{
-        op: target[prop] === undefined ? 'add' : 'replace',
-        value: JSON.parse(JSON.stringify(value)), //  TODO: more efficient sanitization
-        path
-      }])
-
-      if (value instanceof Object) target[prop] = childMutableProxy(prop, value)
-      else target[prop] = value
-
-      return true
-    },
-    deleteProperty(target, prop) {
-      if (prop in target) {
-        proxies.delete(proxy)
-        delete target[prop]
-
-        if (isArray) {
-          if (!/^\d+$/.test(prop)) return true
-          else prop = parseInt(prop)
-        }
-
-        //  TODO: if is array and prop is last element, consider passing -1 as prop
-        const path = [...parentPath, prop]
-        if (!ephemeralPaths[serializePath(path)]) interact([{ op: 'remove', path }])
-      }
-      return true
-    }
-  }
-
-  const proxy = new Proxy(state, traps)
-  proxies.add(proxy)
-
-  return proxy
-}