@dittolive/ditto 4.5.1-experimental.aarch64-linux.1.aarch64 → 4.5.2-rc.2

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

@@ -0,0 +1,89 @@
+//
+// Copyright © 2021 DittoLive Incorporated. All rights reserved.
+//
+
+import * as FFI from './ffi'
+import { generateEphemeralToken } from './internal'
+
+import type { Collection } from './collection'
+import type { SubscriptionManager, SubscriptionContextInfo } from './subscription-manager'
+
+/**
+ * Used to subscribe to receive updates from remote peers about matching
+ * documents.
+ *
+ * While {@link Subscription} objects remain in scope they ensure that
+ * documents in the collection specified and that match the query provided will
+ * try to be kept up-to-date with the latest changes from remote peers.
+ */
+export class Subscription {
+  /**
+   * The query that the subscription is based on.
+   */
+  readonly query: string
+
+  /**
+   * Returns `true` if subscription has been explicitly cancelled, `false`
+   * otherwise.
+   */
+  get isCancelled(): boolean {
+    return this._isCancelled
+  }
+
+  /**
+   * The name of the collection that the subscription is based on.
+   */
+  get collectionName() {
+    return this.collection.name
+  }
+
+  /**
+   * Cancels a subscription and releases all associated resources.
+   */
+  cancel() {
+    if (!this.isCancelled) {
+      this._isCancelled = true
+      this.manager.remove(this)
+    }
+  }
+
+  // ----------------------------------------------------------- Internal ------
+
+  /** @internal */
+  constructor(collection: Collection, query: string, queryArgsCBOR: Uint8Array | null, orderBys: FFI.OrderBy[], limit: number, offset: number) {
+    // Query should be validated at this point.
+    this.query = query
+    this.queryArgsCBOR = queryArgsCBOR
+    this.collection = collection
+    this.contextInfo = {
+      id: generateEphemeralToken(),
+      collectionName: collection.name,
+      query,
+      queryArgsCBOR,
+      orderBys,
+      limit,
+      offset,
+    }
+    this.manager = collection.store.ditto.subscriptionManager
+    this.manager.add(this)
+  }
+
+  /**
+   * The collection this subscription belongs to.
+   * @internal Because not exposed in any of the other SDKs (yet?).
+   */
+  readonly collection: Collection
+
+  /**
+   * The corresponding named arguments for {@link query}, if any.
+   * @internal Because not exposed in any of the other SDKs (yet?).
+   */
+  readonly queryArgsCBOR: Uint8Array | null
+
+  /** @internal */
+  readonly contextInfo: SubscriptionContextInfo
+
+  private readonly manager: SubscriptionManager
+
+  private _isCancelled = false
+}

package/react-native/src/sources/sync-subscription.ts

@@ -0,0 +1,90 @@
+//
+// Copyright © 2023 DittoLive Incorporated. All rights reserved.
+//
+
+import { DittoError } from './error'
+
+import type { DQLQueryArguments } from './essentials'
+import type { Ditto } from './ditto'
+import type { Sync } from './sync'
+
+/**
+ * A sync subscription configures Ditto to receive updates from remote peers
+ * about documents matching the subscription's query.
+ *
+ * The sync subscription will remain active until it is
+ * {@link SyncSubscription.cancel | cancelled}, or the Ditto instance managing
+ * the subscription has been {@link Ditto.close | closed}.
+ *
+ * Create a sync subscription by calling
+ * {@link Sync.registerSubscription | `ditto.sync.registerSubscription()`}.
+ */
+export class SyncSubscription {
+  /**
+   * Documents matching this query will be included in the sync subscription.
+   */
+  readonly queryString: string
+
+  /**
+   * The query arguments of the sync subscription (as passed when
+   * adding it to the store).
+   */
+  readonly queryArguments?: Readonly<DQLQueryArguments>
+
+  /**
+   * The {@link Ditto} instance this sync subscription belongs to.
+   */
+  readonly ditto: Ditto
+
+  /**
+   * `true` when the sync subscription has been cancelled or the {@link Ditto}
+   * instance managing this subscription has been closed.
+   */
+  get isCancelled() {
+    return this._isCancelled
+  }
+
+  /**
+   * Cancels the sync subscription and unregisters it. No-op
+   * if the sync subscription has already been cancelled or the {@link Ditto}
+   * instance managing this subscription has been closed.
+   */
+  cancel() {
+    if (this._isCancelled) return
+    this._isCancelled = true
+    this.ditto.sync.unregisterSubscription(this)
+  }
+
+  // --------------------------- Internal --------------------------------------
+
+  /** @internal */
+  constructor(ditto: Ditto, query: string, queryArguments: DQLQueryArguments | null, queryArgumentsCBOR: Uint8Array | null) {
+    if ((queryArguments == null) !== (queryArgumentsCBOR == null)) {
+      throw new DittoError('internal', 'Internal inconsistency, query arguments and query arguments CBOR must be both null or both non-null', { queryArguments, queryArgumentsCBOR })
+    }
+
+    this.ditto = ditto
+    this.queryString = query
+    this.queryArguments = queryArguments ? Object.freeze({ ...queryArguments }) : undefined
+    this.queryArgumentsCBOR = queryArgumentsCBOR
+  }
+
+  /**
+   * The CBOR-encoded query arguments, or `null` if no query arguments were
+   * passed in.
+   *
+   * @internal
+   */
+  readonly queryArgumentsCBOR: Uint8Array | null
+
+  // --------------------------- Private --------------------------------------
+
+  /**
+   * `true` when the ssync ubscription has been cancelled.
+   *
+   * We mark the sync subscription as cancelled here as an optimization to avoid
+   * a scan of all subscriptions in the store whenever the `isCancelled`
+   * property is checked.
+   */
+  private _isCancelled = false
+}