[PoC] persisted state service

src/plugins/share/public/index.ts

@@ -28,6 +28,13 @@ export {
   ShareContextMenuPanelItem,
 } from './types';
 
+export {
+  PersistableState,
+  PersistableStates,
+  PersistableStateDefinition,
+  SerializableState,
+} from './persistable_state';
+
 export {
   UrlGeneratorId,
   UrlGeneratorState,

src/plugins/share/public/mocks.ts

@@ -0,0 +1,67 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you 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 { identity } from 'lodash';
+import { SharePluginSetup, SharePluginStart } from './';
+import { SharePlugin } from './plugin';
+import { coreMock } from '../../../core/public/mocks';
+
+const createSetupContract = (): SharePluginSetup => ({
+  register: jest.fn(),
+  persistableState: {
+    register: jest.fn().mockResolvedValue(undefined),
+  },
+  urlGenerators: {
+    registerUrlGenerator: jest.fn(),
+  },
+});
+
+const createStartContract = (): SharePluginStart => ({
+  toggleShareContextMenu: jest.fn(),
+  persistableState: {
+    get: jest.fn().mockResolvedValue({
+      id: 'fooState',
+      extractReferences: (s: unknown) => [s, []],
+      injectReferences: identity,
+      migrate: identity,
+    }),
+  },
+  urlGenerators: {
+    getUrlGenerator: jest.fn(),
+  },
+});
+
+const createInstance = async () => {
+  const plugin = new SharePlugin();
+
+  const setup = plugin.setup(coreMock.createSetup());
+  const doStart = () => plugin.start(coreMock.createStart());
+
+  return {
+    plugin,
+    setup,
+    doStart,
+  };
+};
+
+export const sharePluginMock = {
+  createSetupContract,
+  createStartContract,
+  createInstance,
+};

src/plugins/share/public/persistable_state/index.ts

@@ -0,0 +1,21 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you 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.
+ */
+
+export * from './persistable_state_service';
+export * from './types';

src/plugins/share/public/persistable_state/persistable_state_service.ts

@@ -0,0 +1,72 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you 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 { CoreSetup, CoreStart, Plugin } from 'src/core/public';
+import { identity } from 'lodash';
+import { PersistableStateDefinition, PersistableStateContract } from './types';
+
+export interface PersistableStateSetup {
+  register: <Id extends string>(
+    id: Id,
+    definition: PersistableStateDefinition<Id>
+  ) => Promise<void>;
+}
+
+export interface PersistableStateStart {
+  get: <Id extends string>(definitionId: Id) => Promise<PersistableStateContract<Id>>;
+}
+
+export class PersistableStateService
+  implements Plugin<PersistableStateSetup, PersistableStateStart> {
+  private definitions = new Map();
+
+  public setup(core: CoreSetup): PersistableStateSetup {
+    return {
+      register: async (id, definition) => {
+        const { extractReferences, injectReferences, migrate } = definition;
+
+        this.definitions.set(id, {
+          id,
+          extractReferences: extractReferences || ((s: unknown) => [s, []]),
+          injectReferences: injectReferences || identity,
+          migrate: migrate || identity,
+        });
+      },
+    };
+  }
+
+  public start(core: CoreStart): PersistableStateStart {
+    return {
+      get: async (id: string) => {
+        const d = this.definitions.get(id);
+        if (!d) {
+          return {
+            id,
+            migrate: identity,
+            injectReferences: identity,
+            extractReferences: (s: unknown) => [s, []],
+          };
+        }
+        return d;
+      },
+    };
+  }
+
+  public stop() {}
+}

src/plugins/share/public/persistable_state/types.ts

@@ -0,0 +1,94 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you 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 { SavedObjectReference } from 'src/core/public';
+
+type State = string | number | boolean | null | undefined | SerializableState;
+
+export interface SerializableState {
+  [key: string]: State | State[];
+}
+
+type ExtractReferences<Id extends string> = (
+  state: PersistableStates[Id]['state']
+) => [PersistableStates[Id]['state'], SavedObjectReference[]];
+
+type InjectReferences<Id extends string> = (
+  state: PersistableStates[Id]['state'],
+  references: SavedObjectReference[]
+) => PersistableStates[Id]['state'];
+
+type MigrateState<Id extends string> = <T extends SerializableState>(
+  oldState: T
+) => PersistableStates[Id]['state'];
+
+/** @internal */
+export interface PersistableStateContract<Id extends string> {
+  id: Id;
+  extractReferences: ExtractReferences<Id>;
+  injectReferences: InjectReferences<Id>;
+  migrate: MigrateState<Id>;
+}
+
+/**
+ * Use this generic to wrap your persistable state interface before
+ * adding it to the PersistableStates interface via `declare module`.
+ *
+ * We are providing this as a generic to make things more flexible
+ * should we choose to add properties to the interface in the future.
+ *
+ * @public
+ * TODO: should be <S extends SerializableState>
+ */
+export interface PersistableState<S extends any> {
+  state: S;
+}
+
+/**
+ * Anybody registering persistable state should add a property to this
+ * interface so that any module importing PersistableStates can
+ * have the interfaces of all persistable states available to them.
+ *
+ *  declare module '../../plugins/share/public' {
+ *    interface PersistableStates {
+ *      myId: PersistableState<MySerializableStateInterface>;
+ *    }
+ *  }
+ *
+ * @public
+ */
+export interface PersistableStates {
+  // Fallback state for if someone forgets to use `declare module` to
+  // add their state to this interface.
+  // TODO: should be PersistableState<SerializableState>
+  [key: string]: PersistableState<any>;
+}
+
+/**
+ * These are options that can be added when registering persistable state.
+ * If they are not provided, default noop functions will be provided by
+ * the service.
+ *
+ * @public
+ */
+export interface PersistableStateDefinition<Id extends string> {
+  extractReferences?: ExtractReferences<Id>;
+  injectReferences?: InjectReferences<Id>;
+  migrate?: MigrateState<Id>;
+}

src/plugins/share/public/plugin.ts

@@ -28,34 +28,44 @@ import {
   UrlGeneratorsSetup,
   UrlGeneratorsStart,
 } from './url_generators/url_generator_service';
+import {
+  PersistableStateService,
+  PersistableStateSetup,
+  PersistableStateStart,
+} from './persistable_state';
 
 export class SharePlugin implements Plugin<SharePluginSetup, SharePluginStart> {
   private readonly shareMenuRegistry = new ShareMenuRegistry();
   private readonly shareContextMenu = new ShareMenuManager();
+  private readonly persistableStateService = new PersistableStateService();
   private readonly urlGeneratorsService = new UrlGeneratorsService();
 
   public setup(core: CoreSetup): SharePluginSetup {
     core.application.register(createShortUrlRedirectApp(core, window.location));
     return {
       ...this.shareMenuRegistry.setup(),
+      persistableState: this.persistableStateService.setup(core),
       urlGenerators: this.urlGeneratorsService.setup(core),
     };
   }
 
   public start(core: CoreStart): SharePluginStart {
     return {
       ...this.shareContextMenu.start(core, this.shareMenuRegistry.start()),
+      persistableState: this.persistableStateService.start(core),
       urlGenerators: this.urlGeneratorsService.start(core),
     };
   }
 }
 
 /** @public */
 export type SharePluginSetup = ShareMenuRegistrySetup & {
+  persistableState: PersistableStateSetup;
   urlGenerators: UrlGeneratorsSetup;
 };
 
 /** @public */
 export type SharePluginStart = ShareMenuManagerStart & {
+  persistableState: PersistableStateStart;
   urlGenerators: UrlGeneratorsStart;
 };

src/plugins/visualizations/kibana.json

@@ -3,5 +3,5 @@
   "version": "kibana",
   "server": true,
   "ui": true,
-  "requiredPlugins": ["data", "expressions", "uiActions", "embeddable", "usageCollection", "inspector"]
+  "requiredPlugins": ["data", "expressions", "uiActions", "embeddable", "usageCollection", "inspector", "share"]
 }

src/plugins/visualizations/public/mocks.ts

@@ -24,6 +24,7 @@ import { coreMock } from '../../../core/public/mocks';
 import { embeddablePluginMock } from '../../../plugins/embeddable/public/mocks';
 import { expressionsPluginMock } from '../../../plugins/expressions/public/mocks';
 import { dataPluginMock } from '../../../plugins/data/public/mocks';
+import { sharePluginMock } from '../../../plugins/share/public/mocks';
 import { usageCollectionPluginMock } from '../../../plugins/usage_collection/public/mocks';
 import { uiActionsPluginMock } from '../../../plugins/ui_actions/public/mocks';
 import { inspectorPluginMock } from '../../../plugins/inspector/public/mocks';
@@ -57,6 +58,7 @@ const createInstance = async () => {
     embeddable: embeddablePluginMock.createSetupContract(),
     expressions: expressionsPluginMock.createSetupContract(),
     inspector: inspectorPluginMock.createSetupContract(),
+    share: sharePluginMock.createSetupContract(),
     usageCollection: usageCollectionPluginMock.createSetupContract(),
   });
   const doStart = () =>

src/plugins/visualizations/public/plugin.ts

@@ -64,7 +64,13 @@ import {
   convertFromSerializedVis,
   convertToSerializedVis,
 } from './saved_visualizations/_saved_vis';
-
+import { SharePluginSetup } from '../../share/public';
+import {
+  extractReferences,
+  injectReferences,
+} from './saved_visualizations/saved_visualization_references';
+// @ts-ignore
+import { updateOldState } from './legacy/vis_update_state';
 /**
  * Interface for this plugin's returned setup/start contracts.
  *
@@ -88,6 +94,7 @@ export interface VisualizationsSetupDeps {
   expressions: ExpressionsSetup;
   inspector: InspectorSetup;
   usageCollection: UsageCollectionSetup;
+  share: SharePluginSetup;
 }
 
 export interface VisualizationsStartDeps {
@@ -120,7 +127,7 @@ export class VisualizationsPlugin
 
   public setup(
     core: CoreSetup<VisualizationsStartDeps, VisualizationsStart>,
-    { expressions, embeddable, usageCollection, data }: VisualizationsSetupDeps
+    { expressions, embeddable, usageCollection, data, share }: VisualizationsSetupDeps
   ): VisualizationsSetup {
     const start = (this.getStartServicesOrDie = createStartServicesGetter(core.getStartServices));
 
@@ -132,6 +139,12 @@ export class VisualizationsPlugin
     expressions.registerFunction(rangeExpressionFunction);
     expressions.registerFunction(visDimensionExpressionFunction);
 
+    share.persistableState.register('visualization', {
+      injectReferences,
+      extractReferences,
+      migrate: updateOldState,
+    });
+
     const embeddableFactory = new VisualizeEmbeddableFactory({ start });
     embeddable.registerEmbeddableFactory(VISUALIZE_EMBEDDABLE_TYPE, embeddableFactory);