Persisting mutation batch state in LocalStorage

Author: schmidt-sebastian

b/packages/firestore/src/local/shared_client_delegate.ts

@@ -0,0 +1,41 @@
+/**
+ * Copyright 2018 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { BatchId } from '../core/types';
+import { FirestoreError } from '../util/error';
+
+/**
+ * Callback methods invoked by SharedClientState for notifications received
+ * from Local Storage.
+ */
+export interface SharedClientDelegate {
+  /**
+   * Loads a pending batch from the persistence layer and updates all views.
+   */
+  loadPendingBatch(batchId: BatchId): Promise<void>;
+
+  /**
+   * Applies the result of a successful write of a mutation batch, updating all
+   * views and notifying all subscribers.
+   */
+  applySuccessfulWrite(batchId: BatchId): Promise<void>;
+
+  /**
+   * Rejects a failed mutation batch, updating all views and notifying all
+   * subscribers.
+   */
+  rejectFailedWrite(batchId: BatchId, err: FirestoreError): Promise<void>;
+}

packages/firestore/src/local/shared_client_delegate.ts

@@ -0,0 +1,41 @@
+/**
+ * Copyright 2018 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { BatchId } from '../core/types';
+import { FirestoreError } from '../util/error';
+
+/**
+ * Callback methods invoked by SharedClientState for notifications received
+ * from Local Storage.
+ */
+export interface SharedClientDelegate {
+  /**
+   * Loads a pending batch from the persistence layer and updates all views.
+   */
+  loadPendingBatch(batchId: BatchId): Promise<void>;
+
+  /**
+   * Applies the result of a successful write of a mutation batch, updating all
+   * views and notifying all subscribers.
+   */
+  applySuccessfulWrite(batchId: BatchId): Promise<void>;
+
+  /**
+   * Rejects a failed mutation batch, updating all views and notifying all
+   * subscribers.
+   */
+  rejectFailedWrite(batchId: BatchId, err: FirestoreError): Promise<void>;
+}