feat: 🎸 migrate locator params to the latest in redirect endp

elastic · Jun 24, 2021 · 81c6521 · 81c6521
1 parent e2973ff
commit 81c6521
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 7 deletions.
diff --git a/src/plugins/kibana_utils/common/persistable_state/index.ts b/src/plugins/kibana_utils/common/persistable_state/index.ts
@@ -7,3 +7,4 @@
  */
 
 export * from './types';
+export { migrateToLatest } from './migrate_to_latest';
diff --git a/src/plugins/share/common/url_service/locators/locator.ts b/src/plugins/share/common/url_service/locators/locator.ts
@@ -30,7 +30,7 @@ export interface LocatorDependencies {
   getUrl: (location: KibanaLocation, getUrlParams: LocatorGetUrlParams) => Promise<string>;
 }
 
-export class Locator<P extends SerializableState> implements PersistableState<P>, LocatorPublic<P> {
+export class Locator<P extends SerializableState> implements LocatorPublic<P> {
   public readonly migrations: PersistableState<P>['migrations'];
 
   constructor(

diff --git a/src/plugins/share/common/url_service/locators/locator_client.ts b/src/plugins/share/common/url_service/locators/locator_client.ts
@@ -41,7 +41,7 @@ export class LocatorClient implements ILocatorClient {
    * @param id ID of a URL locator.
    * @returns A public interface of a registered URL locator.
    */
-  public get<P>(id: string): undefined | LocatorPublic<P> {
+  public get<P extends SerializableState>(id: string): undefined | LocatorPublic<P> {
     return this.locators.get(id);
   }
 }
diff --git a/src/plugins/share/common/url_service/locators/types.ts b/src/plugins/share/common/url_service/locators/types.ts
@@ -25,7 +25,7 @@ export interface ILocatorClient {
    *
    * @param id Unique ID of the locator.
    */
-  get<P>(id: string): undefined | LocatorPublic<P>;
+  get<P extends SerializableState>(id: string): undefined | LocatorPublic<P>;
 }
 
 /**
@@ -50,7 +50,7 @@ export interface LocatorDefinition<P extends SerializableState>
 /**
  * Public interface of a registered locator.
  */
-export interface LocatorPublic<P> {
+export interface LocatorPublic<P extends SerializableState> extends PersistableState<P> {
   /**
    * Returns a reference to a Kibana client-side location.
    *

diff --git a/src/plugins/share/public/url_service/redirect/redirect_manager.ts b/src/plugins/share/public/url_service/redirect/redirect_manager.ts
@@ -8,8 +8,9 @@
 
 import type { CoreSetup } from 'src/core/public';
 import type { History } from 'history';
-import { i18n } from '@kbn/i18n';
 import type { SerializableState } from 'src/plugins/kibana_utils/common';
+import { migrateToLatest } from 'src/plugins/kibana_utils/common';
+import { i18n } from '@kbn/i18n';
 import { BehaviorSubject } from 'rxjs';
 import type { UrlService } from '../../../common/url_service';
 import { render } from './render';
@@ -67,10 +68,10 @@ export class RedirectManager {
       throw error;
     }
 
-    // TODO: Perform migration to the latest version.
+    const [migratedParams] = migrateToLatest(locator.migrations, [options.params, options.version]);
 
     locator
-      .navigate(options.params)
+      .navigate(migratedParams)
       .then()
       .catch((error) => {
         // eslint-disable-next-line no-console