@knowlearning/agents 0.9.179 → 0.9.181

package/agents/browser/initialize.js

@@ -48,6 +48,7 @@ function embed(environment, iframe) {
   const watchers = {}
   const postMessageQueue = []
   const listeners = {}
+  const responses = {}
   let frameLoaded = false
   let embeddedAgentInitialized = false
 
@@ -70,7 +71,10 @@ function embed(environment, iframe) {
   const handleMessage = async message => {
     const { requestId, type } = message
 
-    const sendDown = (response, error) => postMessage({ requestId, response, error })
+    const sendDown = (response, error) => {
+      if (responses[requestId]) responses[requestId](response, error)
+      postMessage({ requestId, response, error })
+    }
 
     if (type === 'error') {
       console.error(message)
@@ -103,7 +107,7 @@ function embed(environment, iframe) {
       const namespacedScope = getNamespacedScope(environment.namespace, scope)
       let before, after
       if (listeners.mutate) before = copy(await Agent.state(namespacedScope))
-      await Agent.interact(namespacedScope, patch, true, [environment.id, ...context])
+      const response = await Agent.interact(namespacedScope, patch, true, [environment.id, ...context])
       if (listeners.mutate) {
         const patchCopy = copy(patch)
         patchCopy.forEach(op => op.path.shift()) //  remove "active" path prefix
@@ -115,7 +119,7 @@ function embed(environment, iframe) {
             patch: patchCopy
           })
       }
-      sendDown({}) // TODO: might want to send down the interaction index
+      sendDown(response)
     }
     else if (type === 'metadata') {
       const { scope, user, domain } = message
@@ -146,7 +150,7 @@ function embed(environment, iframe) {
       Agent
         .query(query, params, domain, [environment.id, ...context])
         .then(sendDown)
-        .catch(error => sendDown(null, error.error))
+        .catch(error => sendDown(null, error))
     }
     else if (type === 'upload') {
       const { info } = message
@@ -163,8 +167,19 @@ function embed(environment, iframe) {
     else if (type === 'disconnect') sendDown(await Agent.disconnect())
     else if (type === 'reconnect') sendDown(await Agent.reconnect())
     else if (type === 'synced') sendDown(await Agent.synced())
+    else if (type === 'guarantee') {
+      const { script, namespaces=[], context=[] } = message
+      sendDown(await Agent.guarantee(script, [environment.namespace || '', ...namespaces], [environment.id, ...context]))
+    }
+    else if (type === 'response') {
+      const { id, requestId } = message
+      responses[id] = (response, error) => {
+        delete responses[id]
+        sendDown(response, error)
+      }
+    }
     else {
-      console.log('Unknown message type passed up...', message)
+      console.warn('Unknown message type passed up...', message)
       sendDown({})
     }
   }

package/agents/browser/root.js

@@ -2,19 +2,22 @@ import { v1 as uuid } from 'uuid'
 import { applyPatch } from 'fast-json-patch'
 import { getToken, login, logout } from './auth.js'
 import GenericAgent from '../generic/index.js'
+import { io } from 'socket.io-client'
 
 const TEST_DOMAIN = 'tests.knowlearning.systems'
 const LANGUAGES = [...navigator.languages]
 
 const API_HOST = localStorage.getItem('API_HOST') || 'api.knowlearning.systems'
-//  const API_HOST = 'api-test.knowlearning.systems'
-//const API_HOST = 'localhost:8765'
+// const API_HOST = 'api-test.knowlearning.systems'
+// const API_HOST = 'localhost:8765'
 
-//  TODO: remove this hack when we can set partitioned sid cookie through websocket handshake
-//        deno is partly in the way on teh set side, and browser support is in the way for
-//        the client side.
+// TODO: remove sid hack when partitioned cookies via WS handshakes are supported
 async function ensureSidEstablished() {
-  const response = await fetch(`https://${API_HOST}/_sid-check`, { method: 'GET', credentials: 'include' })
+  const response = await fetch(`https://${API_HOST}/_sid-check`, {
+    method: 'GET',
+    credentials: 'include'
+  })
+
   const hasLocalStorageSID = !!localStorage.getItem('sid')
   if (response.status === 201) {
     if (!hasLocalStorageSID) {
@@ -24,7 +27,6 @@ async function ensureSidEstablished() {
     }
   }
   else if (response.status === 200) {
-    //  if we reach here, assumably the server has seen an sid cookie
     if (hasLocalStorageSID) {
       localStorage.removeItem('sid')
       location.reload()
@@ -37,20 +39,44 @@ async function ensureSidEstablished() {
 
 export default options => {
   ensureSidEstablished()
+
   const Connection = function () {
+    const sid = localStorage.getItem('sid')
+
+    // socket.io client connection
+    const socket = io(`https://${API_HOST}`, {
+      withCredentials: true,
+      extraHeaders: sid ? { sid } : {}
+    })
 
-    const ws = new WebSocket(`wss://${API_HOST}`)
+    this.send = message => {
+      try {
+        socket.emit('message', message)
+      } catch (err) {
+        console.warn('Error sending via socket.io', err)
+      }
+    }
 
-    this.send = message => ws.send(JSON.stringify(message))
     this.close = info => {
       this.send({ type: 'close', info })
-      ws.close()
+      socket.disconnect()
     }
 
-    ws.onopen = () => this.onopen()
-    ws.onmessage = ({ data }) => this.onmessage(data.length === 0 ? null : JSON.parse(data))
-    ws.onerror = error => this.onerror && this.onerror(error)
-    ws.onclose = error => this.onclose && this.onclose(error)
+    socket.on('connect', () => {
+      if (this.onopen) this.onopen()
+    })
+
+    socket.on('message', (data) => {
+      if (this.onmessage) this.onmessage(data)
+    })
+
+    socket.on('error', (err) => {
+      if (this.onerror) this.onerror(err)
+    })
+
+    socket.on('disconnect', (reason) => {
+      if (this.onclose) this.onclose(reason)
+    })
 
     return this
   }

package/agents/embedded.js

@@ -12,8 +12,10 @@ export default function EmbeddedAgent(postMessage) {
 
   const [ watch, removeWatcher ] = watchImplementation({ metadata, state, watchers, synced, sentUpdates, environment })
 
+  let lastRequestId
+
   async function send(message) {
-    const requestId = message.requestId || uuid()
+    const requestId = lastRequestId = message.requestId || uuid()
 
     messageIndex += 1
     try {
@@ -202,6 +204,8 @@ export default function EmbeddedAgent(postMessage) {
   function reconnect() { return send({ type: 'reconnect' }) }
   function synced() { return send({ type: 'synced' }) }
   function close(info) { return send({ type: 'close', info }) }
+  function guarantee(script, namespaces, context) { return send({ type: 'guarantee', script, namespaces, context }) }
+  function response(id=lastRequestId) { return send({ type: 'response', id }) }
 
   return {
     embedded: true,
@@ -222,6 +226,7 @@ export default function EmbeddedAgent(postMessage) {
     reconnect,
     synced,
     close,
+    response,
     query
   }
 }

package/agents/generic/index.js

@@ -28,9 +28,10 @@ export default function Agent({ Connection, domain, token, sid, uuid, fetch, app
   ] = messageQueue({ token, sid, domain, Connection, watchers, states, applyPatch, log, login, interact, reboot, trigger, handleDomainMessage, variables })
 
   // initialize session
+  const initialSessionData = { queries: {}, subscriptions: {}, guarantees: {} }
   environment()
     .then(({ session }) => {
-      interact('sessions', [{ op: 'add', path: ['active', session], value: { queries: {}, subscriptions: {} } }], false)
+      interact('sessions', [{ op: 'add', path: ['active', session], value: initialSessionData }], false)
     })
 
   const internalReferences = {
@@ -157,23 +158,10 @@ export default function Agent({ Connection, domain, token, sid, uuid, fetch, app
     ], false)
     try {
       const response = await lastMessageResponse()
-      const { rows } = response
-
-      interact('sessions', [
-        {
-          op: 'add',
-          path: ['active', session, 'queries', id, 'agent_latency'],
-          value: Date.now() - requested
-        },
-        {
-          op: 'remove',
-          path: ['active', session, 'queries', id]
-        }
-      ], false)
-      return rows
+      return response.rows
     }
     catch (error) {
-      throw error
+      throw error.error
     }
   }
 
@@ -188,6 +176,37 @@ export default function Agent({ Connection, domain, token, sid, uuid, fetch, app
     reactions[event].forEach(f => f(data))
   }
 
+  async function guarantee(script, namespaces=[], context=[]) {
+    const { session } = await environment()
+    const id = uuid()
+
+    interact('sessions', [
+      {
+        op: 'add',
+        path: ['active', session, 'guarantees', id],
+        value: { script, namespaces, context }
+      }
+    ], false)
+
+    return {
+      execute() {
+        //  TODO: use simplified worker wrapper to execute script in restricted environment
+      },
+      cancel() {
+        interact('sessions', [
+          {
+            op: 'remove',
+            path: ['active', session, 'guarantees', id]
+          }
+        ], false)
+      }
+    }
+  }
+
+  function response() {
+    return lastMessageResponse()
+  }
+
   return {
     uuid,
     environment,
@@ -208,6 +227,8 @@ export default function Agent({ Connection, domain, token, sid, uuid, fetch, app
     disconnect,
     reconnect,
     debug,
+    guarantee,
+    response,
     on
   }
 }

package/agents/generic/message-queue.js

@@ -227,7 +227,11 @@ export default function messageQueue({ token, sid, domain, Connection, watchers,
     return syncPromise
   }
 
-  function lastMessageResponse() { return new Promise((res, rej) => responses[si].push([res, rej])) }
+  function lastMessageResponse() {
+    if (!responses[si]) throw new Error('A response must be requested before all outstanding responses have already returned')
+
+    return new Promise((res, rej) => responses[si].push([res, rej]))
+  }
 
   function disconnect() {
     log('DISCONNECTED AGENT!!!!!!!!!!!!!!!')

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@knowlearning/agents",
-  "version": "0.9.179",
+  "version": "0.9.181",
   "description": "API for embedding applications in KnowLearning systems.",
   "main": "node.js",
   "browser": "browser.js",
   "type": "module",
+  "types": "types.d.ts",
   "directories": {
     "example": "examples",
     "test": "test"
@@ -25,6 +26,7 @@
   "dependencies": {
     "@knowlearning/patch-proxy": "^1.3.4",
     "fast-json-patch": "^3.1.1",
+    "socket.io-client": "^4.8.1",
     "uuid": "^8.3.2"
   },
   "devDependencies": {

package/{browser.d.ts → types.d.ts}

@@ -19,12 +19,12 @@ export interface AgentEnvironment {
 }
 
 export interface AgentUploadInfo {
-  name?: string,
-  type?: string,
-  data?: string | ArrayBuffer,
-  id?: string,
-  browser?: boolean,
-  accept?: string,
+  name?: string;
+  type?: string;
+  data?: string | ArrayBuffer;
+  id?: string;
+  browser?: boolean;
+  accept?: string;
 }
 
 export interface Agent {
@@ -39,6 +39,7 @@ export interface Agent {
   environment(userId?: string): Promise<AgentEnvironment>;
   close(): void;
   reset(ns: string): Promise<void>;
+  //  TODO: add query function
   synced(): Promise<void>;
 }