@rpcbase/client 0.227.0 → 0.231.0

package/rts/getUseQuery/index.js

@@ -1,233 +0,0 @@
-/* @flow */
-import {Platform} from "react-native"
-import {
-  useCallback,
-  useEffect,
-  useState,
-  useMemo,
-  useId,
-  useRef,
-} from "react"
-import debug from "debug"
-import _omit from "lodash/omit"
-import LZString from "lz-string"
-
-// TODO: remove this when stable
-import isEqual from "fast-deep-equal/react"
-
-import isEqualValues from "../../isEqualValues"
-import getUid from "../../auth/getUid"
-
-import useData from "./useData"
-
-
-const log = debug("rb:rts:useQuery")
-
-export const getUseQuery =
-  (registerQuery) =>
-    (model_name, query = {}, options = {}) => {
-      const id = useId()
-
-      // TODO: should the uid be gone here ? it's part of the auth layer, not this here
-      // TODO: retrieve this from future AuthContext in client
-      const uid = useMemo(() => {
-      // TODO: why is there a options.userId here?? (it was for mobile we need to unify this)
-        const _uid = Platform.OS === "web" ? getUid() : options.userId
-        return _uid
-      }, [])
-
-      // used to track if data was loaded synchronously (no need to show any loader)
-      const hasInitiallySetFromStorage = useRef(false)
-      const hasFirstReply = useRef(false)
-      const hasNetworkReply = useRef(false)
-      const lastDocRef = useRef(null)
-      // const [page, setPage] = useState(0)
-
-      const {
-        key = "",
-        projection = {},
-        sort = {},
-        useStorage = false,
-      } = options
-
-      const storageKey = useMemo(() => {
-        return `${uid}${key ? `.${key}` : ""}.${model_name}.${JSON.stringify(query)}.${JSON.stringify(projection)}.${JSON.stringify(sort)}`
-      }, [uid, key, model_name, query, projection, sort])
-
-      const [source, setSource] = useState()
-
-      const dataRef = useRef(null)
-      const [data, setData] = useData({
-        useStorage,
-        storageKey,
-        hasInitiallySetFromStorage,
-      })
-
-      const [error, setError] = useState()
-
-      const [loading, setLoading] = useState(() => {
-        if (hasInitiallySetFromStorage.current) {
-          return false
-        }
-        return true
-      })
-
-      useEffect(() => {
-        if (options.debug) {
-          console.log("use query", model_name, query, options)
-        }
-      }, [model_name, query, options])
-
-      const applyNewData = (newData, context) => {
-        setData(newData)
-        // set data in a ref so that it doesn't force re-rendering ie: unsubscribe / resubscribe
-        dataRef.current = newData
-
-        // useStorage currently used as a fast local cache, indexedDB
-        // we only save network queries
-        // TODO: use localstorage in react native and pouchdb everywhere
-        if (useStorage && context.source === "network") {
-          if (Platform.OS === "web") {
-            localStorage.setItem(
-              storageKey,
-              LZString.compressToUTF16(JSON.stringify(newData)),
-            )
-          } else {
-          // TODO: this is done in pouchDB nOW ?????
-          // TODO: RN MMKV
-            console.log("mmkv NYI")
-          }
-        }
-
-        if (newData?.length > 0) {
-          lastDocRef.current = newData[newData.length - 1]
-        }
-      }
-
-      const applyContext = (newContext) => {
-        if (newContext.source !== source) {
-          setSource(newContext.source)
-        }
-      }
-
-      useEffect(() => {
-        const queryKey = key || id
-
-        if (!model_name) {
-          console.warn(
-            "attempting to register query with empty collection, skipping",
-          )
-          return
-        }
-
-        if (options.debug) {
-          console.log("register query", model_name, query, options)
-        }
-
-        const start = Date.now()
-
-        log("will register query", model_name, query)
-
-        const unsubscribe = registerQuery(
-          model_name,
-          query,
-          {...options, key: queryKey, uid},
-          (err, queryResult, context) => {
-            log("callback answer with context", context, queryResult?.length)
-
-            // believe it or not, the network can be faster than indexeddb...
-            if (context.source === "cache" && hasNetworkReply.current) {
-              log("skipping cache arriving later than network")
-              return
-            }
-
-            // mark if we received from network
-            if (context.source === "network" && !hasNetworkReply.current) {
-              hasNetworkReply.current = true
-            }
-
-            if (options.debug) {
-              console.log("query took", Date.now() - start, model_name, query)
-            }
-
-            setLoading(false)
-            if (err) {
-              setError(err)
-              return
-            }
-
-            log("query callback", model_name, queryKey, JSON.stringify(query))
-
-            // return if no data (this should be handled already)
-            if (!queryResult) return
-
-            let newData
-            if (Array.isArray(queryResult)) {
-              newData = queryResult.map((o) => _omit(o, "__txn_id"))
-            } else {
-              newData = _omit(queryResult, "__txn_id")
-            }
-
-            // we return once in any case
-            if (!hasFirstReply.current) {
-              hasFirstReply.current = true
-
-              // skip if we already have the data
-              if (isEqualValues(data, newData)) {
-                applyContext(context)
-                return
-              }
-
-              applyContext(context)
-              applyNewData(newData, context)
-              return
-            }
-
-            // TODO: this should be handled by the consumer with the context (cache or network)
-            if (context.is_local && options.skipLocal && hasFirstReply.current) {
-              log("skipping local update", key)
-              return
-            }
-
-            if (
-              __DEV__ &&
-            isEqual(data, newData) &&
-            !isEqualValues(data, newData)
-            ) {
-              alert("EQUALITY MISMATCH THIS SHOULD NOT HAPPEN!", data, newData)
-            }
-
-            if (!isEqualValues(dataRef.current, newData)) {
-              applyContext(context)
-              applyNewData(newData, context)
-            } else {
-              applyContext(context)
-            }
-          },
-        )
-
-        return () => {
-          log && log("useQuery cleanup unsubscribe()")
-          typeof unsubscribe === "function" && unsubscribe()
-        }
-
-      // WARNING: do not change the hooks dependencies param or you risk creating infinite loops as it unsubscribes on cleanup
-      // TODO: this isnt right we need to update on options change too
-      }, [JSON.stringify(query), key])
-
-      const loadNextPage = useCallback(() => {
-        console.log("loadNextPage NYI")
-      }, [])
-
-      const result = useMemo(
-        () => ({data, source, error, loading, loadNextPage}),
-        [data, source, error, loading, loadNextPage],
-      )
-
-      // TODO:
-      // if (Array.isArray(result.data) && !result.source) {
-      //   console.warn("RESULT HAS NO SOURCE", {data, error, loading, source})
-      // }
-
-      return result
-    }

package/rts/getUseQuery/useData.js

@@ -1,55 +0,0 @@
-/* @flow */
-import {useState} from "react"
-import {Platform} from "react-native"
-import LZString from "lz-string"
-
-
-const useData = ({useStorage, storageKey, hasInitiallySetFromStorage}) => {
-  const [data, setData] = useState(() => {
-    if (!useStorage) {
-      return
-    }
-
-    if (Platform.OS === "web") {
-      const itemStr = localStorage.getItem(storageKey)
-      if (!itemStr) return
-
-      let decompressedItem
-      try {
-        decompressedItem = LZString.decompressFromUTF16(itemStr)
-      } catch (err) {
-        //
-      }
-
-      if (!decompressedItem) {
-        localStorage.removeItem(storageKey)
-        return
-      }
-
-
-      let parsedItem
-      try {
-        parsedItem = JSON.parse(decompressedItem)
-      } catch (err) {
-        //
-      }
-      //
-      if (!parsedItem) {
-        localStorage.removeItem(storageKey)
-        return
-      }
-
-      // success
-      hasInitiallySetFromStorage.current = true
-      return parsedItem
-
-    } else {
-      // TODO: fast storage not implemented on mobile
-      console.log("fast storage mobile nOT IMPLEMENTED")
-    }
-  })
-
-  return [data, setData]
-}
-
-export default useData

package/rts/index.js

@@ -1,10 +0,0 @@
-import {registerQuery, sendMessage, onMessage} from "./rts"
-import {getUseDocument} from "./getUseDocument"
-import {getUseQuery} from "./getUseQuery"
-
-
-export const useQuery = getUseQuery(registerQuery)
-
-export const useDocument = getUseDocument(registerQuery)
-
-export {registerQuery, sendMessage, onMessage}

package/rts/rts.js

@@ -1,243 +0,0 @@
-/* @flow */
-import assert from "assert"
-import {Platform} from "react-native"
-import {io} from "socket.io-client"
-import _get from "lodash/get"
-import _set from "lodash/set"
-import debug from "debug"
-
-import getBaseUrl from "../getBaseUrl"
-
-import store from "./store"
-
-
-const log = debug("rb:socket")
-
-const TENANT_ID_HEADER = "rb-tenant-id"
-
-// how many local transaction ids are we keeping, ?it doesn't really need to be that big
-const MAX_TXN_BUF = 2048
-
-let _socket
-const _callbacks = {}
-const _queries_store = {}
-const _local_txn = []
-
-// TODO: when server disconnects / crashes and loses all server side stored queries
-// the clients must reconnect and re-register those queries, or the page will need to be hard refreshed
-
-// add_local_txn
-// when a request is made to the server, we generate (or send if provided) the txn_id
-// if the array becomes longer than the default buffer length we shift the array
-export const add_local_txn = (txn_id) => {
-  assert(txn_id, "add_local_txn trying to add an invalid txn_id")
-  _local_txn.push(txn_id)
-  if (_local_txn.length > MAX_TXN_BUF) {
-    _local_txn.shift()
-  }
-}
-
-
-// TODO: add compression / decompression
-const dispatchQueryPayload = (payload, uid) => {
-  log("dispatchQueryPayload", payload)
-
-  const {model_name, query_key} = payload
-  // const cb = _get(_callbacks, `${model_name}.${query_key}`)
-  const callbacks = _callbacks[`${model_name}.${query_key}`]
-
-  if (!callbacks || !Array.isArray(callbacks)) {
-    log("dispatchQueryPayload", "unable to find callback for query payload", payload)
-    console.error("dispatchQueryPayload", "unable to find callback for query payload", payload)
-    return
-  }
-
-  if (payload.error) {
-    console.warn("rts-client, payload error:", payload.error)
-    console.warn("rts-client", "in:", model_name, "query_key:", query_key)
-    callbacks.forEach((cb) => cb(payload.error, undefined, {source: "network"}))
-    return
-  }
-
-  let data
-  try {
-    // TODO: zstd decompression here
-    data = JSON.parse(payload.data_buf)
-  } catch (err) {
-    console.log("Error", err)
-    log("dispatchQueryPayload", "unable to parse or send data from payload:", payload.data_buf)
-  }
-
-  if (!data) {
-    // skipping if data parsing failed
-    return
-  }
-
-  const context = {
-    source: "network",
-    is_local: _local_txn.includes(payload.txn_id),
-    txn_id: payload.txn_id,
-  }
-
-  callbacks.forEach((cb) => cb(null, data, context))
-
-  // TODO: pouchdb on react native
-  if (Platform.OS === "web") {
-    store.update_docs(model_name, data, uid)
-  }
-}
-
-
-export const connect = (tenant_id, user_id) => new Promise((resolve) => {
-  if (!tenant_id) {
-    log("missing tenant_id, skipping")
-    return
-  }
-  assert(user_id, "missing user_id")
-
-  log("rts client will connect")
-
-  _socket = io(getBaseUrl(), {
-    forceNew: true,
-    transports: ["websocket", "polling"],
-    withCredentials: true,
-    query: {
-      [TENANT_ID_HEADER]: tenant_id,
-    },
-    // https://socket.io/docs/v4/client-options/#reconnection
-    reconnection: true,
-    reconnectionAttempts: 128,
-    reconnectionDelay: 400, // ms
-    reconnectionDelayMax: 10 * 1000, // 10s
-  })
-
-  _socket.on("connect", () => {
-    log("socket connected")
-    resolve()
-  })
-
-  _socket.io.on("reconnect", (e) => {
-    log("socked reconnected", e)
-  })
-
-  _socket.on("error", (err) => {
-    log("socket error", err)
-  })
-
-  _socket.on("query_payload", (payload) => {
-    // console.log("socket:query_payload", payload)
-    dispatchQueryPayload(payload, user_id)
-  })
-
-  _socket.on("delete_doc", (payload) => {
-    log("document deleted", payload)
-  })
-
-  _socket.on("disconnect", (arg) => {
-    log("socket disconnected", arg)
-  })
-})
-
-
-export const disconnect = () => {
-  if (_socket) {
-    try {
-      _socket.disconnect()
-    } catch (e) {
-      // TODO: should we be swallowing this error
-    }
-    _socket = null
-  }
-}
-
-
-export const reconnect = (tenant_id, user_id) => {
-  log("socket will force reconnect")
-
-  // destroy current socket if exists
-  disconnect()
-
-  connect(tenant_id, user_id)
-}
-
-// register a query
-export const registerQuery = (model_name, query, _options, _callback) => {
-  // left shift args if _options is undefined
-  let options
-  let callback
-  if (_callback) {
-    assert(typeof _callback === "function")
-    options = _options
-    callback = _callback
-  } else {
-    options = {}
-    callback = _options
-  }
-
-  log("registerQuery", {model_name, query, options, callback})
-
-  if (!_socket) {
-    log("registerQuery: trying to use null socket", {model_name, query})
-    return
-  }
-
-  const key = options.key || ""
-  const query_key = `${key}${JSON.stringify(query)}${options.projection ? JSON.stringify(options.projection) : ""}`
-  log("registering query with key", key, model_name, query, query_key)
-
-  // save callback to update hooks
-  const cb_key = `${model_name}.${query_key}`
-  if (!_callbacks[cb_key] || !Array.isArray(_callbacks[cb_key])) {
-    _callbacks[cb_key] = []
-  }
-  _callbacks[cb_key].push(callback)
-
-  // save query for reconnections and retries
-  if (!_queries_store[model_name]) {
-    _queries_store[model_name] = {}
-  }
-  _queries_store[model_name][query]
-
-  // TODO: why both run and register query here ? the run_query should come straight from register ?
-  _socket.emit("run_query", {model_name, query, query_key, options})
-  _socket.emit("registerQuery", {model_name, query, query_key, options})
-
-  if (Platform.OS === "web") {
-    // run the query from the cache a first time
-    store.run_query({model_name, query, options}, callback)
-  }
-
-  return () => {
-    _socket.emit("remove_query", {model_name, query, query_key, options})
-    // remove callback
-    const cb_index = _callbacks[cb_key].indexOf(callback)
-    if (cb_index > -1) {
-      _callbacks[cb_key].splice(cb_index, 1)
-    } else {
-      console.warn("warning, trying to remove a callback that doesn't exist")
-    }
-  }
-}
-
-
-export const sendMessage = (message, payload) => {
-  if (!_socket) {
-    console.error("attempting to send message without socket", {message, payload})
-    return
-  }
-
-  _socket.emit(message, payload)
-}
-
-
-export const onMessage = (message, callback) => {
-  if (!_socket) {
-    throw new Error("registering socket message listener without socket")
-  }
-
-  _socket.on(message, callback)
-
-  return () => {
-    _socket.off(message, callback)
-  }
-}

package/rts/signout.ts

@@ -1,8 +0,0 @@
-import * as get_collection from "./store/get_collection"
-import {disconnect} from "./rts"
-
-
-export const signout = async() => {
-  get_collection.destroy_all()
-  disconnect()
-}

package/rts/store/constants.js

@@ -1,3 +0,0 @@
-/* @flow */
-
-export const UNDERSCORE_PREFIX = "$_"

package/rts/store/debug.js

@@ -1,24 +0,0 @@
-/* @flow */
-import debug from "debug"
-import PouchDB from "pouchdb-core"
-
-if (debug.enabled("rb:rts:store")) {
-
-  const log = debug("rb:store:pouch")
-
-  log("store debug is enabled")
-
-  const shouldLogAllPouch = debug.enabled("pouch")
-
-  PouchDB.on("debug", (args) => {
-    if (shouldLogAllPouch) {
-      log(...args)
-    }
-    // log find only when not loggin all pouch
-    else {
-      if (args[0] === "find") {
-        log(...args)
-      }
-    }
-  })
-}

package/rts/store/get_collection.js

@@ -1,55 +0,0 @@
-/* @flow */
-import debug from "debug"
-import PouchDB from "pouchdb-core"
-import IndexedDBAdapter from "pouchdb-adapter-indexeddb"
-import FindPlugin from "pouchdb-find"
-
-import {RB_TENANT_ID, RB_APP_NAME} from "env"
-
-
-const log = debug("rb:rts:store")
-
-let prefix = `rb/`
-
-if (RB_APP_NAME) prefix += `${RB_APP_NAME}/`
-
-prefix += `${RB_TENANT_ID}/`
-
-log("prefix:", prefix)
-
-PouchDB.prefix = prefix
-
-PouchDB.plugin(IndexedDBAdapter)
-PouchDB.plugin(FindPlugin)
-
-let _cols_store = Object.create(null)
-
-export const get_collection = (col_name, options) => {
-
-  if (!col_name) {
-    console.warn("supplied invalid / empty collection name to rts")
-  }
-  if (!options.uid) {
-    console.warn("rts: get_collection: missing options.uid")
-  }
-
-  const col_key = `${options.uid}/${col_name}`
-
-  if (_cols_store[col_key]) {
-    return _cols_store[col_key]
-  } else {
-    // https://pouchdb.com/api.html#create_database
-    const col = new PouchDB(col_key, {adapter: "indexeddb", revs_limit: 1})
-    _cols_store[col_key] = col
-
-    return col
-  }
-
-}
-
-
-export const destroy_all = async() => {
-  await Promise.map(Object.values(_cols_store), (db) => db.destroy())
-
-  _cols_store = Object.create(null)
-}