@dittolive/ditto 4.4.4 → 4.5.0

package/react-native/scripts/ruby/include_local_boost.rb

@@ -0,0 +1,78 @@
+# By default, Cocoapods bundle development pod source files under one single 
+# folder. This forces us to change all the relative paths in the boost folder 
+# (which is used by multiple people). 
+#
+# In order not to do that, we will create a subspec for each folder in the 
+# relative path. In the end, we will be able to call boost files like this 
+# again:
+#
+# # main.cpp
+#
+# #include <boost/smart_ptr/intrusive_ref_counter.hpp>
+#
+# # instead of:
+#
+# #include "intrusive_ref_counter.hpp"
+#
+# Related: https://github.com/CocoaPods/CocoaPods/issues/8873
+def include_local_boost(s)
+  s.subspec 'boost' do |boost|
+    boost.source_files         = "react-native/boost/boost/**/*.{h,cpp,hpp}"
+    boost.public_header_files  = 'react-native/boost/boost/**/*.hpp'
+    boost.header_dir           = 'boost'
+
+    boost.subspec 'smart_ptr' do |smart_ptr|
+      smart_ptr.source_files         = "react-native/boost/boost/smart_ptr/**/*.{h,cpp,hpp}"
+      smart_ptr.public_header_files  = 'react-native/boost/boost/smart_ptr/**/*.hpp'
+      smart_ptr.header_dir           = 'boost/smart_ptr'
+
+      smart_ptr.subspec 'detail' do |detail|
+        detail.source_files         = "react-native/boost/boost/smart_ptr/detail/**/*.{h,cpp,hpp}"
+        detail.public_header_files  = 'react-native/boost/boost/smart_ptr/detail/**/*.hpp'
+        detail.header_dir           = 'boost/smart_ptr/detail'
+      end
+    end
+
+    boost.subspec 'config' do |config|
+      config.source_files         = "react-native/boost/boost/config/**/*.{h,cpp,hpp}"
+      config.public_header_files  = 'react-native/boost/boost/config/**/*.hpp'
+      config.header_dir           = 'boost/config'
+
+      config.subspec 'abi' do |abi|
+        abi.source_files         = "react-native/boost/boost/config/abi/**/*.{h,cpp,hpp}"
+        abi.public_header_files  = 'react-native/boost/boost/config/abi/**/*.hpp'
+        abi.header_dir           = 'boost/config/abi'
+      end
+
+      config.subspec 'compiler' do |compiler|
+        compiler.source_files         = "react-native/boost/boost/config/compiler/**/*.{h,cpp,hpp}"
+        compiler.public_header_files  = 'react-native/boost/boost/config/compiler/**/*.hpp'
+        compiler.header_dir           = 'boost/config/compiler'
+      end
+
+      config.subspec 'detail' do |detail|
+        detail.source_files         = "react-native/boost/boost/config/detail/**/*.{h,cpp,hpp}"
+        detail.public_header_files  = 'react-native/boost/boost/config/detail/**/*.hpp'
+        detail.header_dir           = 'boost/config/detail'
+      end
+
+      config.subspec 'no_tr1' do |no_tr1|
+        no_tr1.source_files         = "react-native/boost/boost/config/no_tr1/**/*.{h,cpp,hpp}"
+        no_tr1.public_header_files  = 'react-native/boost/boost/config/no_tr1/**/*.hpp'
+        no_tr1.header_dir           = 'boost/config/no_tr1'
+      end
+
+      config.subspec 'platform' do |platform|
+        platform.source_files         = "react-native/boost/boost/config/platform/**/*.{h,cpp,hpp}"
+        platform.public_header_files  = 'react-native/boost/boost/config/platform/**/*.hpp'
+        platform.header_dir           = 'boost/config/platform'
+      end
+
+      config.subspec 'stdlib' do |stdlib|
+        stdlib.source_files         = "react-native/boost/boost/config/stdlib/**/*.{h,cpp,hpp}"
+        stdlib.public_header_files  = 'react-native/boost/boost/config/stdlib/**/*.hpp'
+        stdlib.header_dir           = 'boost/config/stdlib'
+      end
+    end
+  end
+end

package/react-native/src/ditto.rn.ts

@@ -0,0 +1,91 @@
+import { NativeModules, Platform, type Permission } from 'react-native';
+import { FinalizationGroup } from '@ungap/weakrefs';
+import 'fastestsmallesttextencoderdecoder';
+
+interface JSSDKAPI {
+  ditto_sdk_transports_init(transportsErrorPointer: any): boolean;
+}
+interface PlatformSpecificAPI {
+  getRandomValues<T extends ArrayBufferView>(array: T): T;
+  ditto_tick(): void;
+  createDirectory(path: string): string;
+  checkDirectoryExists(path: string): string;
+  getDeviceName(): string;
+
+  ditto_sdk_transports_set_android_context(): boolean;
+  ditto_sdk_transports_android_missing_permissions(): string[];
+}
+
+type DittoCoreType = JSSDKAPI & PlatformSpecificAPI;
+
+const dittoCore = global as unknown as DittoCoreType;
+const isLoaded = typeof dittoCore.getDeviceName === 'function';
+if (!isLoaded) {
+  const result = NativeModules.DittoRNSDK?.install();
+
+  if (!result) {
+    throw new Error('JSI bindings were not installed for: DittoRNSDK Module');
+  }
+
+  setInterval(() => {
+    dittoCore.ditto_tick();
+  }, 50);
+
+  if (
+    typeof global.FinalizationRegistry === 'undefined' &&
+    typeof FinalizationGroup !== 'undefined'
+  ) {
+    global.FinalizationRegistry = FinalizationGroup;
+  }
+}
+
+Object.keys(dittoCore)
+  .filter((key) => key !== 'ditto_sdk_transports_init')
+  .forEach((key) => {
+    exports[key] = dittoCore[key as keyof DittoCoreType];
+  });
+
+export function ditto_sdk_transports_init(
+  transportsErrorPointer: any
+): boolean {
+  if (Platform.OS === 'android') {
+    const res = dittoCore.ditto_sdk_transports_set_android_context();
+    if (!res) {
+      throw new Error(
+        "Couldn't manage to set Android context with `ditto_sdk_transports_set_android_context()`"
+      );
+    }
+  }
+
+  return dittoCore.ditto_sdk_transports_init(transportsErrorPointer);
+}
+
+/**
+ * Get the list of missing Android permissions for syncing. The returned value
+ * can be passed directly to `PermissionsAndroid.requestMultiple()`.
+ *
+ * Returns an empty array on other platforms.
+ */
+export function getMissingAndroidPermissions(): Permission[] {
+  if (Platform.OS !== 'android') {
+    return [];
+  }
+  return dittoCore.ditto_sdk_transports_android_missing_permissions() as Permission[];
+}
+
+export function boxCStringIntoString(something: any) {
+  return something;
+}
+
+export function boxCBytesIntoBuffer(cborBytes: any) {
+  const bytes = dittoCore.sliceBoxedToUInt8Array(cborBytes);
+  return bytes ? new Uint8Array(bytes) : null;
+}
+
+export function getDeadlockTimeout(): number {
+  return 0;
+}
+
+export function setDeadlockTimeout(something: any) {
+  return something;
+}

package/react-native/src/environment/environment.fallback.ts

@@ -0,0 +1,4 @@
+export const isReactNativeBuild = true
+export const isNodeBuild = false
+export const isWebBuild = false
+

package/react-native/src/index.ts

@@ -0,0 +1,26 @@
+
+export { getMissingAndroidPermissions } from './ditto.rn';
+
+export * from './sources/essentials';
+
+export * from './sources/logger';
+export * from './sources/document-id';
+export * from './sources/observer';
+
+export * from './sources/authenticator';
+export * from './sources/identity';
+export * from './sources/ditto';
+export * from './sources/store-observer';
+export * from './sources/sync';
+export * from './sources/sync-subscription';
+export * from './sources/error';
+export * from './sources/error-codes';
+export * from './sources/query-result-item';
+export * from './sources/query-result';
+
+export * from './sources/small-peer-info';
+export * from './sources/store';
+export * from './sources/presence';
+export * from './sources/transport-config';
+
+export * from './sources/epilogue';

package/react-native/src/sources/@cbor-redux.ts

@@ -0,0 +1,2 @@
+import * as CBOR from 'cbor-js';
+export {CBOR};

package/react-native/src/sources/@ditto.core.ts

@@ -0,0 +1 @@
+export * from '../ditto.rn';

package/react-native/src/sources/@environment.ts

@@ -0,0 +1,2 @@
+
+export * from '../environment/environment.fallback';

package/react-native/src/sources/attachment-fetch-event.ts

@@ -0,0 +1,54 @@
+//
+// Copyright © 2021 DittoLive Incorporated. All rights reserved.
+//
+
+import type { Attachment } from './attachment'
+
+/**
+ * The types of attachment fetch events that can be delivered to an attachment
+ * fetcher's `callback`.
+ */
+export type AttachmentFetchEventType = 'Completed' | 'Progress' | 'Deleted'
+
+/**
+ * An attachment fetch event used when the attachment's download has completed.
+ */
+export type AttachmentFetchEventCompleted = {
+  type: 'Completed'
+  attachment: Attachment
+}
+
+/**
+ * An attachment fetch event used when the attachment's download progressed but
+ * is not yet complete.
+ */
+export type AttachmentFetchEventProgress = {
+  type: 'Progress'
+  totalBytes: number | BigInt
+  downloadedBytes: number | BigInt
+}
+
+/**
+ * An attachment fetch event used when the attachment is deleted.
+ */
+export type AttachmentFetchEventDeleted = {
+  type: 'Deleted'
+}
+
+/**
+ * A representation of the events that can occur in relation to an attachment
+ * fetch.
+ *
+ * There are three different attachment fetch events: `Completed`, `Progress`,
+ * or `Deleted`.
+ *
+ * There will be at most one `Completed` or `Deleted` event per attachment
+ * fetch. There can be many `Progress` events delivered for each attachment
+ * fetch.
+ *
+ * Updates relating to an attachment fetch are delivered by registering an
+ * {@link AttachmentFetcher} through a call to
+ * {@link Collection.fetchAttachment | fetchAttachment()} on a
+ * {@link Collection} instance.
+ */
+export type AttachmentFetchEvent = AttachmentFetchEventCompleted | AttachmentFetchEventProgress | AttachmentFetchEventDeleted

package/react-native/src/sources/attachment-fetcher-manager.ts

@@ -0,0 +1,129 @@
+import * as FFI from './ffi'
+
+import { AttachmentFetcher } from './attachment-fetcher'
+import { AttachmentToken } from './attachment-token'
+import { Bridge } from './bridge'
+import { Ditto } from './ditto'
+
+import type { AttachmentFetchEvent } from './attachment-fetch-event'
+
+/** @internal */
+type AttachmentFetcherContextInfo = {
+  attachmentFetcher: WeakRef<AttachmentFetcher>
+  attachmentTokenID: Uint8Array
+  id: string
+  cancelTokenPromise: Promise<unknown | null> | null
+}
+
+/**
+ * Manages attachment fetchers to make sure we free all resources when the
+ * fetcher is garbage collected and to allow us to wait for freeing of
+ * ressources to be finished before the ditto instance is closed.
+ *
+ * @internal */
+export class AttachmentFetcherManager {
+  readonly ditto: Ditto
+
+  /** @internal */
+  constructor(ditto: Ditto) {
+    this.ditto = ditto
+  }
+
+  /**
+   * Start an attachment fetcher.
+   *
+   * @internal */
+  startAttachmentFetcher(token: AttachmentToken, eventHandler?: (attachmentFetchEvent: AttachmentFetchEvent) => void): AttachmentFetcher {
+    return this.ditto.deferClose(() => {
+      const attachmentFetcher = new AttachmentFetcher(this.ditto, token, this, eventHandler)
+
+      const contextInfo: AttachmentFetcherContextInfo = {
+        id: attachmentFetcher.id,
+        attachmentTokenID: token.id,
+        cancelTokenPromise: attachmentFetcher.cancelTokenPromise,
+        attachmentFetcher: new WeakRef(attachmentFetcher),
+      }
+      this.finalizationRegistry.register(attachmentFetcher, contextInfo, attachmentFetcher)
+
+      this.contextInfoByID[attachmentFetcher.id] = contextInfo
+
+      const resetCancelToken = () => {
+        if (this.contextInfoByID[attachmentFetcher.id] != null) {
+          this.contextInfoByID[attachmentFetcher.id].cancelTokenPromise = null
+        }
+      }
+      attachmentFetcher.attachment.then(
+        (value) => {
+          resetCancelToken()
+          return value
+        },
+        (reason) => {
+          resetCancelToken()
+          return reason
+        },
+      )
+
+      this.ditto.keepAlive.retain(`AttachmentFetcher.${attachmentFetcher.id})`)
+
+      return attachmentFetcher
+    })
+  }
+
+  /**
+   * Stop an attachment fetcher and wait for it to be stopped.
+   *
+   * @internal */
+  async stopAttachmentFetcher(attachmentFetcher: AttachmentFetcher): Promise<void> {
+    this.finalizationRegistry.unregister(attachmentFetcher)
+    const contextInfo = this.contextInfoByID[attachmentFetcher.id]
+    if (contextInfo == null) {
+      throw new Error(`Internal inconsistency: cannot stop attachment fetcher ${attachmentFetcher.id}, which is not registered.`)
+    }
+    await this.stopWithContextInfo(contextInfo)
+  }
+
+  /**
+   * Closing the manager will cancel all attachment fetchers.
+   *
+   * @internal
+   */
+  close() {
+    this.ditto.deferCloseAsync(async () => {
+      const contextInfos = Object.values(this.contextInfoByID)
+      const stopped = contextInfos.map(async (contextInfo) => {
+        const attachmentFetcher = contextInfo.attachmentFetcher.deref()
+        if (attachmentFetcher != null) {
+          await this.stopAttachmentFetcher(attachmentFetcher)
+        }
+      })
+      await Promise.all(stopped)
+    })
+  }
+
+  // --- Private ---
+
+  private contextInfoByID: { [attachmentFetcherID: string]: AttachmentFetcherContextInfo } = {}
+
+  private finalizationRegistry: FinalizationRegistry<AttachmentFetcherContextInfo> = new FinalizationRegistry(this.stopWithContextInfo)
+
+  /**
+   * Stop the attachment fetcher without unregistering it from the finalization
+   * registry.
+   */
+  private stopWithContextInfo(contextInfo: AttachmentFetcherContextInfo): Promise<void> {
+    const dittoHandle = Bridge.ditto.handleFor(this.ditto)
+    return this.ditto.deferCloseAsync(async () => {
+      if (this.contextInfoByID[contextInfo.id] == null) {
+        throw new Error(`Internal inconsistency: attachment fetcher ${contextInfo.id} not found in active attachment fetchers.`)
+      }
+      delete this.contextInfoByID[contextInfo.id]
+
+      this.ditto.keepAlive.release(`AttachmentFetcher.${contextInfo.id})`)
+
+      const cancelToken = await contextInfo.cancelTokenPromise
+      if (cancelToken) {
+        FFI.dittoCancelResolveAttachment(dittoHandle.deref(), contextInfo.attachmentTokenID, cancelToken)
+      }
+    })
+  }
+}

package/react-native/src/sources/attachment-fetcher.ts

@@ -0,0 +1,124 @@
+//
+// Copyright © 2021 DittoLive Incorporated. All rights reserved.
+//
+
+import * as FFI from './ffi'
+import { Bridge } from './bridge'
+import { Attachment } from './attachment'
+import { AttachmentToken } from './attachment-token'
+import { generateEphemeralToken, step } from './internal'
+
+import type { AttachmentFetchEvent } from './attachment-fetch-event'
+import type { Ditto } from './ditto'
+import type { AttachmentFetcherManager } from './attachment-fetcher-manager'
+
+/**
+ * These objects are returned by calls to
+ * {@link Collection.fetchAttachment | fetchAttachment()} on {@link Collection}
+ * and allow you to stop an in-flight attachment fetch.
+ */
+export class AttachmentFetcher implements PromiseLike<Attachment | null> {
+  /**
+   * Returns a promise for the attachment that you can `await`. The promise
+   * resolves to either an attachment or `null` if the attachment has been
+   * deleted meanwhile. The promise is rejected if an error occurs during
+   * the fetch. Note that the `AttachmentFetcher` itself implementes
+   * `PromiseLike`, so you can `await` it directly.
+   */
+  readonly attachment: Promise<Attachment | null>
+
+  /**
+   * Stops fetching the associated attachment and cleans up any associated
+   * resources.
+   *
+   * Note that you are not required to call `stop()` once your attachment fetch
+   * operation has finished. The method primarily exists to allow you to cancel
+   * an attachment fetch request while it is ongoing if you no longer wish for
+   * the attachment to be made available locally to the device.
+   */
+  stop() {
+    step(async () => {
+      await this.manager.stopAttachmentFetcher(this)
+      if (this.rejectPendingFetch != null) {
+        this.rejectPendingFetch()
+      }
+    })
+  }
+
+  // --------------------------------------- Internal ------------------------
+
+  /** @internal */
+  readonly cancelTokenPromise: Promise<unknown | null> | null = null
+
+  /** @internal */
+  readonly ditto: Ditto
+
+  /** @internal */
+  readonly id: string
+
+  /** @internal */
+  readonly manager: AttachmentFetcherManager
+
+  /** @internal */
+  readonly token: AttachmentToken
+
+  /** @internal */
+  then<TResult1 = any, TResult2 = never>(onfulfilled?: ((value: any) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined): PromiseLike<TResult1 | TResult2> {
+    return this.attachment.then(onfulfilled, onrejected)
+  }
+
+  /** @internal */
+  constructor(ditto: Ditto, token: AttachmentToken, manager: AttachmentFetcherManager, eventHandler?: (attachmentFetchEvent: AttachmentFetchEvent) => void) {
+    this.ditto = ditto
+    this.token = token
+    this.manager = manager
+    this.id = generateEphemeralToken()
+
+    const eventHandlerOrNoOp = eventHandler || function () {}
+    const dittoHandle = Bridge.ditto.handleFor(ditto)
+
+    this.attachment = new Promise((resolve, reject) => {
+      const onComplete = (attachmentHandlePointer: FFI.Pointer<FFI.AttachmentHandle>) => {
+        const attachment = new Attachment(this.ditto, this.token)
+        Bridge.attachment.bridge(attachmentHandlePointer, () => attachment)
+
+        eventHandlerOrNoOp({ type: 'Completed', attachment })
+
+        this.rejectPendingFetch = null
+        resolve(attachment)
+      }
+
+      const onProgress = (downloaded: number | BigInt, toDownload: number | BigInt) => {
+        eventHandlerOrNoOp({ type: 'Progress', totalBytes: toDownload, downloadedBytes: downloaded })
+      }
+
+      const onDelete = () => {
+        eventHandlerOrNoOp({ type: 'Deleted' })
+
+        this.rejectPendingFetch = null
+        resolve(null)
+      }
+
+      const onError = () => {
+        ;(err: any) => {
+          this.rejectPendingFetch = null
+          reject(err)
+        }
+      }
+
+      this.rejectPendingFetch = () => {
+        reject(new Error('Attachment fetch was canceled'))
+      }
+
+      this.cancelTokenPromise = FFI.dittoResolveAttachment(dittoHandle.deref(), token.id, { onComplete, onProgress, onDelete }, onError)
+    })
+  }
+
+  /**
+   * This function is defined while a fetch is in progress and is used to reject
+   * the promise `this.attachment` when the fetch is canceled.
+   *
+   * @internal
+   */
+  private rejectPendingFetch: (() => void) | null = null
+}

package/react-native/src/sources/attachment-token.ts

@@ -0,0 +1,48 @@
+//
+// Copyright © 2021 DittoLive Incorporated. All rights reserved.
+//
+
+import * as FFI from './ffi'
+
+/**
+ * Serves as a token for a specific attachment that you can pass to a call to
+ * {@link Collection.fetchAttachment | fetchAttachment()} on a
+ * {@link Collection}.
+ */
+export class AttachmentToken {
+  /** @internal */
+  readonly id: Uint8Array
+
+  /** @internal */
+  readonly len: number
+
+  /** @internal */
+  readonly metadata: { [key: string]: string }
+
+  /** @internal */
+  constructor(jsObj: object) {
+    const type = jsObj[FFI.DittoCRDTTypeKey]
+    if (type !== FFI.DittoCRDTType.attachment) {
+      throw new Error('Invalid attachment token')
+    }
+
+    const id = jsObj['_id']
+    if (!(id instanceof Uint8Array)) {
+      throw new Error('Invalid attachment token id')
+    }
+
+    const len = jsObj['_len']
+    if (typeof len !== 'number' || len < 0) {
+      throw new Error('Invalid attachment token length')
+    }
+
+    const meta = jsObj['_meta']
+    if (typeof meta !== 'object') {
+      throw new Error('Invalid attachment token meta')
+    }
+
+    this.id = id
+    this.len = len
+    this.metadata = meta
+  }
+}

package/react-native/src/sources/attachment.ts

@@ -0,0 +1,59 @@
+//
+// Copyright © 2021 DittoLive Incorporated. All rights reserved.
+//
+
+import * as FFI from './ffi'
+import { Bridge } from './bridge'
+import * as Environment from './@environment'
+
+import type { Ditto } from './ditto'
+import type { AttachmentToken } from './attachment-token'
+
+/**
+ * Represents an attachment and can be used to insert the associated attachment
+ * into a document at a specific key-path. You can't instantiate an attachment
+ * directly, please use the {@link Collection.newAttachment | newAttachment()}
+ * method of {@link Collection} instead.
+ */
+export class Attachment {
+  /** @internal */
+  readonly ditto: Ditto
+
+  /** @internal */
+  readonly token: AttachmentToken
+
+  /** The attachment's metadata. */
+  get metadata(): { [key: string]: string } {
+    return this.token.metadata
+  }
+
+  /**
+   * Returns the attachment's data.
+   */
+  getData(): Promise<Uint8Array> {
+    const ditto = this.ditto
+    const dittoHandle = Bridge.ditto.handleFor(ditto)
+    return this.ditto.deferCloseAsync(async () => {
+    })
+  }
+
+  /**
+   * Copies the attachment to the specified file path. Node-only,
+   * throws in the browser.
+   *
+   * @param path The path that the attachment should be copied to.
+   */
+  copyToPath(path: string): Promise<void> {
+    const ditto = this.ditto
+    const dittoHandle = Bridge.ditto.handleFor(ditto)
+    return this.ditto.deferCloseAsync(async () => {
+
+    })
+  }
+
+  /** @internal */
+  constructor(ditto: Ditto, token: AttachmentToken) {
+    this.ditto = ditto
+    this.token = token
+  }
+}