@rpcbase/client 0.60.0 → 0.62.0

package/package.json

@@ -1,20 +1,23 @@
 {
   "name": "@rpcbase/client",
-  "version": "0.60.0",
+  "version": "0.62.0",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 0"
+    "test": "jest"
   },
   "dependencies": {
     "axios": "1.4.0",
-    "i18next": "23.2.11",
+    "i18next": "23.4.1",
     "i18next-chained-backend": "4.4.0",
     "i18next-resources-to-backend": "1.1.4",
     "lodash": "4.17.21",
+    "posthog-js": "1.75.3",
     "pouchdb-adapter-indexeddb": "8.0.1",
     "pouchdb-core": "8.0.1",
     "pouchdb-find": "8.0.1",
-    "posthog-js": "1.70.0",
-    "react-i18next": "13.0.1",
-    "socket.io-client": "4.7.1"
+    "react-i18next": "13.0.3",
+    "socket.io-client": "4.7.2"
+  },
+  "devDependencies": {
+    "jest": "29.6.2"
   }
 }

package/rts/boot.js

@@ -1,5 +1,3 @@
 /* @flow */
 
-console.log("RTS BOOT, TODO: connect")
-
 import "./store"

package/rts/getUseDocument.js

@@ -0,0 +1,23 @@
+/* @flow */
+import getUseQuery from "./getUseQuery"
+
+
+const getUseDocument = (register_query) => (...args) => {
+
+  const useQuery = getUseQuery(register_query)
+
+  const res = useQuery(...args)
+
+  let data
+  // cache will always return [] when there are no matching documents, but we want null instead
+  if (Array.isArray(res.data) && res.data.length === 0 && res.source === "cache") {
+    data = null
+  } else if (Array.isArray(res.data) && res.data.length  > 0) {
+    // TODO: should we throw if res.data.length > 1 ? ie: there are more than one matching document
+    data = res.data[0]
+  }
+
+  return {...res, data}
+}
+
+export default getUseDocument

package/rts/getUseQuery.js

@@ -11,7 +11,8 @@ import get_uid from "../auth/get_uid"
 import cacheStorage from "./cacheStorage"
 
 
-const log = debug("rb:useQuery")
+const log = debug("rb:rts:useQuery")
+
 
 const getUseQuery = (register_query) => (
   model_name,
@@ -44,10 +45,8 @@ const getUseQuery = (register_query) => (
     sort = {},
   } = options
 
-
   const storageKey = `${uid}.${key}.${model_name}.${JSON.stringify(query)}.${JSON.stringify(projection)}.${JSON.stringify(sort)}`
 
-
   useEffect(() => {
     if (options.debug) {
       console.log("use query", model_name, query, options)
@@ -57,9 +56,10 @@ const getUseQuery = (register_query) => (
   useEffect(() => {
     const load = async() => {
       const val = await cacheStorage.get(storageKey)
-      // console.log("got val from storage", val)
+      // TODO: rm this
       // always initially apply when first load here
       if (val) {
+        console.log("Will set val from cache storage")
         setData(val)
         setLoading(false)
       }
@@ -94,6 +94,7 @@ const getUseQuery = (register_query) => (
     }
 
     const start = Date.now()
+    log("will register query", model_name, query)
     const unsubscribe = register_query(model_name, query, {...options, key: queryKey}, (err, queryResult, context) => {
       log("callback answer with context", context, queryResult?.length)
 
@@ -170,6 +171,11 @@ const getUseQuery = (register_query) => (
 
   const result = useMemo(() => ({data, source, error, loading}), [data, source, error, loading])
 
+  // TODO: investigate this one
+  // if (Array.isArray(result.data) && !result.source) {
+  //   console.warn("RESULT HAS NO SOURCE", {data, error, loading, source})
+  // }
+
   return result
 }
 

package/rts/index.js

@@ -9,6 +9,7 @@ import BASE_URL from "../base_url"
 import {get_tenant_id} from "../auth"
 
 import store from "./store"
+import getUseDocument from "./getUseDocument"
 import getUseQuery from "./getUseQuery"
 
 const log = debug("rb:socket")
@@ -219,3 +220,5 @@ export const register_query = (model_name, query, _options, _callback) => {
 }
 
 export const useQuery = getUseQuery(register_query)
+
+export const useDocument = getUseDocument(register_query)

package/rts/store/debug.js

@@ -2,7 +2,7 @@
 import debug from "debug"
 import PouchDB from "pouchdb-core"
 
-if (debug.enabled("rb:store")) {
+if (debug.enabled("rb:rts:store")) {
 
   const log = debug("rb:store:pouch")
 

package/rts/store/get_collection.js

@@ -6,7 +6,7 @@ import FindPlugin from "pouchdb-find"
 
 import {TENANT_PREFIX, DATABASE_NAME} from "env"
 
-const log = debug("rb:store")
+const log = debug("rb:rts:store")
 
 let prefix = `rb/${TENANT_PREFIX}/`
 

package/rts/store/index.js

@@ -5,36 +5,15 @@ import "./debug"
 
 import get_collection from "./get_collection"
 import update_docs from "./update_docs"
+import satisfies_projection from "./satisfies_projection"
+
+const log = debug("rb:rts:store")
 
-const log = debug("rb:store")
 
-// import updateDocument from "./updateDocument"
-// import {DATABASE_NAME} from "env"
-// let prefix = "rb/"
-// if (DATABASE_NAME) prefix += `${DATABASE_NAME}/`
-//
-// PouchDB.prefix = prefix
-//
-// PouchDB.plugin(IndexedDBAdapter)
-// PouchDB.plugin(FindPlugin)
-//
-//
-// let db = new PouchDB(`db/items`, { adapter: "indexeddb" });
-//
-// // Create a new document
-// let doc = {
-//   _id: "001",
-//   message: "Hello, World!"
-// }
-// //
-//
-// const run = async() => {
 //   // https://github.com/pouchdb/pouchdb/tree/master/packages/node_modules/pouchdb-find#dbcreateindexindex--callback
 //   const res = await db.createIndex({
 //     index: {fields: ["name"]}
 //   })
-//
-//
 //   // Listen for changes on the database
 //   const fn = db.changes({
 //     since: "now",
@@ -53,78 +32,18 @@ const log = debug("rb:store")
 //   console.log("GOT FN", fn)
 //
 //   console.log("got res", res)
-//
-//   const doc = await db.find({
-//     selector: {name: "Mario"},
-//     sort: ["name"]
-//   })
-//
-//   console.log("GT doc", doc)
-//
-//   const {docs} = await db.find({selector: {}})
-//
-//   console.log("got all docs", docs)
-//
-//   db.put({
-//     _id: "001-" + Date.now(),
-//     message: "Hello, World!"
-//   })
-// }
-//
-//
-// run()
-
-// // Insert the document into the database
-// db.put(doc, function(err, response) {
-//   if (err) {
-//     return console.log(err);
-//   } else {
-//     console.log("Document created successfully");
-//   }
+// _cols_store[col_name].getIndexes().then(function (result) {
+//   console.log("got indexes", result)
 // })
-//
-//
-// // Insert the document into the database
-// db.put({
-//   _id: "hello world",
-//   fieldVal: 12,
-// }, {force: true}, async function(err, response) {
-//   if (err) {
-//     console.log("errrro", err);
-//     console.log("Stt", JSON.stringify(err))
-//     return
-//   } else {
-//     console.log("Document created successfully", response);
-//   }
-//
-//   console.log("will try to find:")
-//   const doc = await db.find({
-//     selector: {
-//       fieldVal: 10
-//     }
-//   })
-//   console.log("LEDOC", doc)
-//
-// });
-//
-// setInterval(() => {
-//   // Fetch the document
-//   db.get("001", function(err, doc) {
-//     if (err) {
-//       return console.log(err);
-//     } else {
-//       console.log(doc);
-//     }
-//   });
-// }, 2000)
-//
 
-// TODO: should the store be in a worker or the main thread ?
 
+// TODO: implement store in a shared worker
+// TODO: should we filter all docs by projection ? or just the ones where the projection isn't complete ?
 const run_query = async({model_name, query, query_key, options}, callback) => {
-  // console.log("ALAAARM")
   // console.log("run_query", {model_name, query, query_key, options})
   // console.time("store run_query")
+
+  // TODO: we should prefix model_name with tenant_prefix + env_id
   const col = get_collection(model_name)
 
   // https://github.com/pouchdb/pouchdb/tree/master/packages/node_modules/pouchdb-find#dbcreateindexindex--callback
@@ -136,18 +55,22 @@ const run_query = async({model_name, query, query_key, options}, callback) => {
     // fields: [""]
   })
 
-  const mapped_docs = docs.map(({_rev, ...doc}) => {
-    // TODO: handle projections here
-    const remapped_doc = Object.entries(doc).reduce((new_doc, [key, value]) => {
-      let new_key = key.startsWith('$_') ? key.replace(/^\$_/, "") : key
-      new_doc[new_key] = value
-      return new_doc
-    }, {})
+  let mapped_docs = docs
+    .map(({_rev, ...doc}) => {
+      // TODO: handle projections here
+      const remapped_doc = Object.entries(doc).reduce((new_doc, [key, value]) => {
+        let new_key = key.startsWith('$_') ? key.replace(/^\$_/, "") : key
+        new_doc[new_key] = value
+        return new_doc
+      }, {})
+
+      return remapped_doc
+    })
 
-    return remapped_doc
-  })
 
-  // console.timeEnd("store run_query")
+  if (options.projection) {
+    mapped_docs = mapped_docs.filter((doc) => satisfies_projection(doc, options.projection))
+  }
 
   callback(null, mapped_docs, {source: "cache"})
 }

package/rts/store/satisfies_projection.js

@@ -0,0 +1,32 @@
+/* @flow */
+
+const get_keys = (obj, parent_key = '') => {
+  return Object.keys(obj).reduce((acc, key) => {
+    const new_key = parent_key ? `${parent_key}.${key}` : key
+    if (typeof obj[key] === 'object' && obj[key] !== null && !Array.isArray(obj[key])) {
+      acc.push(...get_keys(obj[key], new_key))
+    } else {
+      acc.push(new_key)
+    }
+    return acc
+  }, [])
+}
+
+const set_contains_set = (set_a, set_b) => {
+  if (set_b.size > set_a.size) return false
+  for (const b of set_b) if (!set_a.has(b)) return false
+  return true
+}
+
+const satisfies_projection = (doc, projection) => {
+  const doc_keys = new Set(get_keys(doc))
+  const projection_keys = new Set(Object.keys(projection).filter(k => projection[k] === 1))
+
+  if (!projection_keys.has('_id')) {
+    doc_keys.delete('_id')
+  }
+
+  return set_contains_set(doc_keys, projection_keys)
+}
+
+module.exports = satisfies_projection

package/rts/store/satisfies_projection.test.js

@@ -0,0 +1,42 @@
+/* @flow */
+const satisfies_projection = require("./satisfies_projection")
+
+
+let doc = {
+  _id: '1',
+  field1: 'value1',
+  field2: {
+    subField1: 'value2',
+    subField2: 'value3'
+  }
+}
+
+let projection = {
+  field1: 1,
+  'field2.subField1': 1,
+  'field2.subField2': 1
+}
+
+
+
+test("simple", () => {
+  expect(satisfies_projection(doc, projection)).toBe(true)
+})
+
+test("missing field", () => {
+  expect(satisfies_projection(doc, {
+    missing_field: 1,
+    ...projection
+  })).toBe(false)
+})
+
+test("missing nested field", () => {
+  expect(satisfies_projection(doc, {
+    "missing_field.missing_nested": 1,
+    ...projection
+  })).toBe(false)
+})
+
+test("empty", () => {
+  expect(satisfies_projection(doc, {field1: 1})).toBe(true)
+})