tinybase 5.0.0-beta.27 → 5.0.0-beta.28

package/synchronizers/synchronizer-broadcast-channel/index.js

@@ -0,0 +1,498 @@
+const EMPTY_STRING = '';
+
+const promise = Promise;
+const GLOBAL = globalThis;
+const math = Math;
+const mathFloor = math.floor;
+const isUndefined = (thing) => thing == void 0;
+const ifNotUndefined = (value, then, otherwise) =>
+  isUndefined(value) ? otherwise?.() : then(value);
+const isArray = (thing) => Array.isArray(thing);
+const size = (arrayOrString) => arrayOrString.length;
+const promiseNew = (resolver) => new promise(resolver);
+const errorNew = (message) => {
+  throw new Error(message);
+};
+
+const arrayForEach = (array, cb) => array.forEach(cb);
+const arrayMap = (array, cb) => array.map(cb);
+const arrayReduce = (array, cb, initial) => array.reduce(cb, initial);
+const arrayPush = (array, ...values) => array.push(...values);
+const arrayShift = (array) => array.shift();
+
+const object = Object;
+const getPrototypeOf = (obj) => object.getPrototypeOf(obj);
+const objEntries = object.entries;
+const isObject = (obj) =>
+  !isUndefined(obj) &&
+  ifNotUndefined(
+    getPrototypeOf(obj),
+    (objPrototype) =>
+      objPrototype == object.prototype ||
+      isUndefined(getPrototypeOf(objPrototype)),
+
+    /* istanbul ignore next */
+    () => true,
+  );
+const objIds = object.keys;
+const objFreeze = object.freeze;
+const objNew = (entries = []) => object.fromEntries(entries);
+const objHas = (obj, id) => id in obj;
+const objForEach = (obj, cb) =>
+  arrayForEach(objEntries(obj), ([id, value]) => cb(value, id));
+const objSize = (obj) => size(objIds(obj));
+const objIsEmpty = (obj) => isObject(obj) && objSize(obj) == 0;
+const objEnsure = (obj, id, getDefaultValue) => {
+  if (!objHas(obj, id)) {
+    obj[id] = getDefaultValue();
+  }
+  return obj[id];
+};
+
+const collHas = (coll, keyOrValue) => coll?.has(keyOrValue) ?? false;
+const collDel = (coll, keyOrValue) => coll?.delete(keyOrValue);
+
+const mapNew = (entries) => new Map(entries);
+const mapGet = (map, key) => map?.get(key);
+const mapSet = (map, key, value) =>
+  isUndefined(value) ? (collDel(map, key), map) : map?.set(key, value);
+const mapEnsure = (map, key, getDefaultValue, hadExistingValue) => {
+  if (!collHas(map, key)) {
+    mapSet(map, key, getDefaultValue());
+  }
+  return mapGet(map, key);
+};
+
+const Persists = {
+  StoreOnly: 1,
+  MergeableStoreOnly: 2,
+  StoreOrMergeableStore: 3,
+};
+const scheduleRunning = mapNew();
+const scheduleActions = mapNew();
+const getStoreFunctions = (persist = Persists.StoreOnly, store) =>
+  persist != Persists.StoreOnly && store.isMergeable()
+    ? [
+        1,
+        store.getMergeableContent,
+        store.getTransactionMergeableChanges,
+        ([[changedTables], [changedValues]]) =>
+          !objIsEmpty(changedTables) || !objIsEmpty(changedValues),
+        store.setDefaultContent,
+      ]
+    : persist != Persists.MergeableStoreOnly
+      ? [
+          0,
+          store.getContent,
+          store.getTransactionChanges,
+          ([changedTables, changedValues]) =>
+            !objIsEmpty(changedTables) || !objIsEmpty(changedValues),
+          store.setContent,
+        ]
+      : errorNew('Store type not supported by this Persister');
+const createCustomPersister = (
+  store,
+  getPersisted,
+  setPersisted,
+  addPersisterListener,
+  delPersisterListener,
+  onIgnoredError,
+  persist,
+  extra = {},
+  scheduleId = [],
+) => {
+  let loadSave = 0;
+  let loads = 0;
+  let saves = 0;
+  let action;
+  let autoLoadHandle;
+  let autoSaveListenerId;
+  mapEnsure(scheduleRunning, scheduleId, () => 0);
+  mapEnsure(scheduleActions, scheduleId, () => []);
+  const [
+    isMergeableStore,
+    getContent,
+    getChanges,
+    hasChanges,
+    setDefaultContent,
+  ] = getStoreFunctions(persist, store);
+  const run = async () => {
+    /* istanbul ignore else */
+    if (!mapGet(scheduleRunning, scheduleId)) {
+      mapSet(scheduleRunning, scheduleId, 1);
+      while (
+        !isUndefined((action = arrayShift(mapGet(scheduleActions, scheduleId))))
+      ) {
+        try {
+          await action();
+        } catch (error) {
+          /* istanbul ignore next */
+          onIgnoredError?.(error);
+        }
+      }
+      mapSet(scheduleRunning, scheduleId, 0);
+    }
+  };
+  const setContentOrChanges = (contentOrChanges) => {
+    (isMergeableStore && isArray(contentOrChanges?.[0])
+      ? contentOrChanges?.[2] === 1
+        ? store.applyMergeableChanges
+        : store.setMergeableContent
+      : contentOrChanges?.[2] === 1
+        ? store.applyChanges
+        : store.setContent)(contentOrChanges);
+  };
+  const load = async (initialContent) => {
+    /* istanbul ignore else */
+    if (loadSave != 2) {
+      loadSave = 1;
+      loads++;
+      await schedule(async () => {
+        try {
+          setContentOrChanges(await getPersisted());
+        } catch (error) {
+          onIgnoredError?.(error);
+          if (initialContent) {
+            setDefaultContent(initialContent);
+          }
+        }
+        loadSave = 0;
+      });
+    }
+    return persister;
+  };
+  const startAutoLoad = async (initialContent) => {
+    await stopAutoLoad().load(initialContent);
+    autoLoadHandle = addPersisterListener(async (content, changes) => {
+      if (changes || content) {
+        /* istanbul ignore else */
+        if (loadSave != 2) {
+          loadSave = 1;
+          loads++;
+          setContentOrChanges(changes ?? content);
+          loadSave = 0;
+        }
+      } else {
+        await load();
+      }
+    });
+    return persister;
+  };
+  const stopAutoLoad = () => {
+    if (autoLoadHandle) {
+      delPersisterListener(autoLoadHandle);
+      autoLoadHandle = void 0;
+    }
+    return persister;
+  };
+  const isAutoLoading = () => !isUndefined(autoLoadHandle);
+  const save = async (changes) => {
+    /* istanbul ignore else */
+    if (loadSave != 1) {
+      loadSave = 2;
+      saves++;
+      await schedule(async () => {
+        try {
+          await setPersisted(getContent, changes);
+        } catch (error) {
+          /* istanbul ignore next */
+          onIgnoredError?.(error);
+        }
+        loadSave = 0;
+      });
+    }
+    return persister;
+  };
+  const startAutoSave = async () => {
+    await stopAutoSave().save();
+    autoSaveListenerId = store.addDidFinishTransactionListener(() => {
+      const changes = getChanges();
+      if (hasChanges(changes)) {
+        save(changes);
+      }
+    });
+    return persister;
+  };
+  const stopAutoSave = () => {
+    ifNotUndefined(autoSaveListenerId, store.delListener);
+    autoSaveListenerId = void 0;
+    return persister;
+  };
+  const isAutoSaving = () => !isUndefined(autoSaveListenerId);
+  const schedule = async (...actions) => {
+    arrayPush(mapGet(scheduleActions, scheduleId), ...actions);
+    await run();
+    return persister;
+  };
+  const getStore = () => store;
+  const destroy = () => stopAutoLoad().stopAutoSave();
+  const getStats = () => ({loads, saves});
+  const persister = {
+    load,
+    startAutoLoad,
+    stopAutoLoad,
+    isAutoLoading,
+    save,
+    startAutoSave,
+    stopAutoSave,
+    isAutoSaving,
+    schedule,
+    getStore,
+    destroy,
+    getStats,
+    ...extra,
+  };
+  return objFreeze(persister);
+};
+
+new GLOBAL.TextEncoder();
+
+const newStamp = (value, time) => (time ? [value, time] : [value]);
+const getLatestTime = (time1, time2) =>
+  ((time1 ?? '') > (time2 ?? '') ? time1 : time2) ?? '';
+const stampNewObj = (time = EMPTY_STRING) => newStamp(objNew(), time);
+
+const MASK6 = 63;
+const ENCODE =
+  '-0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz'.split(
+    EMPTY_STRING,
+  );
+mapNew(arrayMap(ENCODE, (char, index) => [char, index]));
+const encode = (num) => ENCODE[num & MASK6];
+
+const getRandomValues = GLOBAL.crypto
+  ? (array) => GLOBAL.crypto.getRandomValues(array)
+  : /* istanbul ignore next */
+    (array) => arrayMap(array, () => mathFloor(math.random() * 256));
+const getUniqueId = (length = 16) =>
+  arrayReduce(
+    getRandomValues(new Uint8Array(length)),
+    (uniqueId, number) => uniqueId + encode(number),
+    '',
+  );
+
+const Message = {
+  Response: 0,
+  GetContentHashes: 1,
+  ContentHashes: 2,
+  ContentDiff: 3,
+  GetTableDiff: 4,
+  GetRowDiff: 5,
+  GetCellDiff: 6,
+  GetValueDiff: 7,
+};
+const createCustomSynchronizer = (
+  store,
+  send,
+  registerReceive,
+  destroyImpl,
+  requestTimeoutSeconds,
+  onIgnoredError,
+  extra = {},
+) => {
+  let persisterListener;
+  let sends = 0;
+  let receives = 0;
+  const pendingRequests = mapNew();
+  registerReceive((fromClientId, requestId, message, body) => {
+    receives++;
+    if (message == Message.Response) {
+      ifNotUndefined(
+        mapGet(pendingRequests, requestId),
+        ([toClientId, handleResponse]) =>
+          isUndefined(toClientId) || toClientId == fromClientId
+            ? handleResponse(body, fromClientId)
+            : /* istanbul ignore next */
+              0,
+      );
+    } else if (message == Message.ContentHashes && persister.isAutoLoading()) {
+      getChangesFromOtherStore(fromClientId, body).then((changes) => {
+        persisterListener?.(void 0, changes);
+      });
+    } else if (message == Message.ContentDiff && persister.isAutoLoading()) {
+      persisterListener?.(void 0, body);
+    } else {
+      ifNotUndefined(
+        message == Message.GetContentHashes && persister.isAutoSaving()
+          ? store.getMergeableContentHashes()
+          : message == Message.GetTableDiff
+            ? store.getMergeableTableDiff(body)
+            : message == Message.GetRowDiff
+              ? store.getMergeableRowDiff(body)
+              : message == Message.GetCellDiff
+                ? store.getMergeableCellDiff(body)
+                : message == Message.GetValueDiff
+                  ? store.getMergeableValueDiff(body)
+                  : void 0,
+        (response) => {
+          sends++;
+          send(fromClientId, requestId, Message.Response, response);
+        },
+      );
+    }
+  });
+  const request = async (toClientId, message, body = EMPTY_STRING) =>
+    promiseNew((resolve, reject) => {
+      const requestId = getUniqueId();
+      const timeout = setTimeout(() => {
+        collDel(pendingRequests, requestId);
+        reject(`No response from ${toClientId ?? 'anyone'} to '${message}'`);
+      }, requestTimeoutSeconds * 1e3);
+      mapSet(pendingRequests, requestId, [
+        toClientId,
+        (response, fromClientId) => {
+          clearTimeout(timeout);
+          collDel(pendingRequests, requestId);
+          resolve([response, fromClientId]);
+        },
+      ]);
+      sends++;
+      send(toClientId, requestId, message, body);
+    });
+  const mergeTablesStamps = (tablesStamp, [tableStamps2, tablesTime2]) => {
+    objForEach(tableStamps2, ([rowStamps2, tableTime2], tableId) => {
+      const tableStamp = objEnsure(tablesStamp[0], tableId, stampNewObj);
+      objForEach(rowStamps2, ([cellStamps2, rowTime2], rowId) => {
+        const rowStamp = objEnsure(tableStamp[0], rowId, stampNewObj);
+        objForEach(
+          cellStamps2,
+          ([cell2, cellTime2], cellId) =>
+            (rowStamp[0][cellId] = newStamp(cell2, cellTime2)),
+        );
+        rowStamp[1] = getLatestTime(rowStamp[1], rowTime2);
+      });
+      tableStamp[1] = getLatestTime(tableStamp[1], tableTime2);
+    });
+    tablesStamp[1] = getLatestTime(tablesStamp[1], tablesTime2);
+  };
+  const getChangesFromOtherStore = async (
+    otherClientId = null,
+    otherContentHashes,
+  ) => {
+    if (isUndefined(otherContentHashes)) {
+      [otherContentHashes, otherClientId] = await request(
+        otherClientId,
+        Message.GetContentHashes,
+      );
+    }
+    const [otherTablesHash, otherValuesHash] = otherContentHashes;
+    const [tablesHash, valuesHash] = store.getMergeableContentHashes();
+    let tablesChanges = stampNewObj();
+    if (tablesHash != otherTablesHash) {
+      const [newTables, differentTableHashes] = (
+        await request(
+          otherClientId,
+          Message.GetTableDiff,
+          store.getMergeableTableHashes(),
+        )
+      )[0];
+      tablesChanges = newTables;
+      if (!objIsEmpty(differentTableHashes)) {
+        const [newRows, differentRowHashes] = (
+          await request(
+            otherClientId,
+            Message.GetRowDiff,
+            store.getMergeableRowHashes(differentTableHashes),
+          )
+        )[0];
+        mergeTablesStamps(tablesChanges, newRows);
+        if (!objIsEmpty(differentRowHashes)) {
+          const newCells = (
+            await request(
+              otherClientId,
+              Message.GetCellDiff,
+              store.getMergeableCellHashes(differentRowHashes),
+            )
+          )[0];
+          mergeTablesStamps(tablesChanges, newCells);
+        }
+      }
+    }
+    return [
+      tablesChanges,
+      valuesHash == otherValuesHash
+        ? stampNewObj()
+        : (
+            await request(
+              otherClientId,
+              Message.GetValueDiff,
+              store.getMergeableValueHashes(),
+            )
+          )[0],
+      1,
+    ];
+  };
+  const getPersisted = async () => {
+    const changes = await getChangesFromOtherStore();
+    return !objIsEmpty(changes[0][0]) || !objIsEmpty(changes[1][0])
+      ? changes
+      : void 0;
+  };
+  const setPersisted = async (_getContent, changes) => {
+    sends++;
+    if (changes) {
+      send(null, null, Message.ContentDiff, changes);
+    } else {
+      send(
+        null,
+        null,
+        Message.ContentHashes,
+        store.getMergeableContentHashes(),
+      );
+    }
+  };
+  const addPersisterListener = (listener) => (persisterListener = listener);
+  const delPersisterListener = () => (persisterListener = void 0);
+  const startSync = async (initialContent) =>
+    await (await persister.startAutoLoad(initialContent)).startAutoSave();
+  const stopSync = () => persister.stopAutoLoad().stopAutoSave();
+  const destroy = () => {
+    destroyImpl();
+    return persister.stopSync();
+  };
+  const getSynchronizerStats = () => ({sends, receives});
+  const persister = createCustomPersister(
+    store,
+    getPersisted,
+    setPersisted,
+    addPersisterListener,
+    delPersisterListener,
+    onIgnoredError,
+    Persists.MergeableStoreOnly,
+    {startSync, stopSync, destroy, getSynchronizerStats, ...extra},
+  );
+  return persister;
+};
+
+const createBroadcastChannelSynchronizer = (
+  store,
+  channelName,
+  onIgnoredError,
+) => {
+  const clientId = getUniqueId();
+  const channel = new BroadcastChannel(channelName);
+  const send = (toClientId, requestId, message, body) =>
+    channel.postMessage([clientId, toClientId, requestId, message, body]);
+  const registerReceive = (receive) => {
+    channel.onmessage = ({
+      data: [fromClientId, toClientId, requestId, message, body],
+    }) =>
+      isUndefined(toClientId) || toClientId == clientId
+        ? receive(fromClientId, requestId, message, body)
+        : 0;
+  };
+  const destroy = () => {
+    channel.close();
+  };
+  return createCustomSynchronizer(
+    store,
+    send,
+    registerReceive,
+    destroy,
+    0.01,
+    onIgnoredError,
+    {getChannelName: () => channelName},
+  );
+};
+
+export {createBroadcastChannelSynchronizer};