revert cancel() on kbnUrlStateStorage

elastic · Feb 2, 2021 · 6e6c8c4 · 6e6c8c4
1 parent 76d6606
commit 6e6c8c4
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 2 deletions.
diff --git a/...ana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.cancel.md b/...ana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.cancel.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-kibana\_utils-public-state\_sync](./kibana-plugin-plugins-kibana_utils-public-state_sync.md) &gt; [IKbnUrlStateStorage](./kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.md) &gt; [cancel](./kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.cancel.md)
+
+## IKbnUrlStateStorage.cancel property
+
+Cancels any pending url updates
+
+<b>Signature:</b>
+
+```typescript
+cancel: () => void;
+```
diff --git a/...ync/kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.md b/...ync/kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.md
@@ -20,6 +20,7 @@ export interface IKbnUrlStateStorage extends IStateStorage
 
 |  Property | Type | Description |
 |  --- | --- | --- |
+|  [cancel](./kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.cancel.md) | <code>() =&gt; void</code> | Cancels any pending url updates |
 |  [change$](./kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.change_.md) | <code>&lt;State = unknown&gt;(key: string) =&gt; Observable&lt;State &#124; null&gt;</code> |  |
 |  [get](./kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.get.md) | <code>&lt;State = unknown&gt;(key: string) =&gt; State &#124; null</code> |  |
 |  [kbnUrlControls](./kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.kbnurlcontrols.md) | <code>IKbnUrlControls</code> | Lower level wrapper around history library that handles batching multiple URL updates into one history change |

diff --git a/src/plugins/kibana_utils/public/state_sync/public.api.md b/src/plugins/kibana_utils/public/state_sync/public.api.md
@@ -22,6 +22,7 @@ export const createSessionStorageStateStorage: (storage?: Storage) => ISessionSt
 
 // @public
 export interface IKbnUrlStateStorage extends IStateStorage {
+    cancel: () => void;
     // (undocumented)
     change$: <State = unknown>(key: string) => Observable<State | null>;
     // (undocumented)

diff --git a/src/plugins/kibana_utils/public/state_sync/state_sync.test.ts b/src/plugins/kibana_utils/public/state_sync/state_sync.test.ts
@@ -290,7 +290,7 @@ describe('state_sync', () => {
       expect(history.length).toBe(startHistoryLength);
       expect(getCurrentUrl()).toMatchInlineSnapshot(`"/"`);
 
-      urlSyncStrategy.kbnUrlControls.cancel();
+      urlSyncStrategy.cancel();
 
       expect(history.length).toBe(startHistoryLength);
       expect(getCurrentUrl()).toMatchInlineSnapshot(`"/"`);
@@ -303,6 +303,32 @@ describe('state_sync', () => {
       stop();
     });
 
+    it('cancels pending URL updates when sync stops', async () => {
+      const { stop, start } = syncStates([
+        {
+          stateContainer: withDefaultState(container, defaultState),
+          storageKey: key,
+          stateStorage: urlSyncStrategy,
+        },
+      ]);
+      start();
+
+      const startHistoryLength = history.length;
+      container.transitions.add({ id: 2, text: '2', completed: false });
+      container.transitions.add({ id: 3, text: '3', completed: false });
+      container.transitions.completeAll();
+
+      expect(history.length).toBe(startHistoryLength);
+      expect(getCurrentUrl()).toMatchInlineSnapshot(`"/"`);
+
+      stop();
+
+      await tick();
+
+      expect(history.length).toBe(startHistoryLength);
+      expect(getCurrentUrl()).toMatchInlineSnapshot(`"/"`);
+    });
+
     it("should preserve reference to unchanged state slices if them didn't change", async () => {
       const otherUnchangedSlice = { a: 'test' };
       const oldState = {

diff --git a/...ana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.test.ts b/...ana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.test.ts
@@ -51,7 +51,7 @@ describe('KbnUrlStateStorage', () => {
       const key = '_s';
       const pr = urlStateStorage.set(key, state);
       expect(getCurrentUrl()).toMatchInlineSnapshot(`"/"`);
-      urlStateStorage.kbnUrlControls.cancel();
+      urlStateStorage.cancel();
       await pr;
       expect(getCurrentUrl()).toMatchInlineSnapshot(`"/"`);
       expect(urlStateStorage.get(key)).toEqual(null);

diff --git a/...s/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts b/...s/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts
@@ -39,6 +39,11 @@ export interface IKbnUrlStateStorage extends IStateStorage {
   get: <State = unknown>(key: string) => State | null;
   change$: <State = unknown>(key: string) => Observable<State | null>;
 
+  /**
+   * Cancels any pending url updates
+   */
+  cancel: () => void;
+
   /**
    * Lower level wrapper around history library that handles batching multiple URL updates into one history change
    */
@@ -108,6 +113,9 @@ export const createKbnUrlStateStorage = (
         }),
         share()
       ),
+    cancel() {
+      url.cancel();
+    },
     kbnUrlControls: url,
   };
 };