remove the parseAppUrl unused core API

pgayvallet · pgayvallet · commit 07cb1f50d324 · 2020-06-10T08:27:58.000+02:00
diff --git a/docs/development/core/public/kibana-plugin-core-public.applicationstart.md b/docs/development/core/public/kibana-plugin-core-public.applicationstart.md
@@ -26,6 +26,5 @@ export interface ApplicationStart
 |  [getUrlForApp(appId, options)](./kibana-plugin-core-public.applicationstart.geturlforapp.md) | Returns an URL to a given app, including the global base path. By default, the URL is relative (/basePath/app/my-app). Use the <code>absolute</code> option to generate an absolute url (http://host:port/basePath/app/my-app)<!-- -->Note that when generating absolute urls, the origin (protocol, host and port) are determined from the browser's location. |
 |  [navigateToApp(appId, options)](./kibana-plugin-core-public.applicationstart.navigatetoapp.md) | Navigate to a given app |
 |  [navigateToUrl(url)](./kibana-plugin-core-public.applicationstart.navigatetourl.md) | Navigate to given url, which can either be an absolute url or a relative path, in a SPA friendly way when possible.<!-- -->If all these criteria are true for the given url: - (only for absolute URLs) The origin of the URL matches the origin of the browser's current location - The pathname of the URL starts with the current basePath (eg. /mybasepath/s/my-space) - The pathname segment after the basePath matches any known application route (eg. /app/<id>/ or any application's <code>appRoute</code> configuration)<!-- -->Then a SPA navigation will be performed using <code>navigateToApp</code> using the corresponding application and path. Otherwise, fallback to a full page reload to navigate to the url using <code>window.location.assign</code> |
-|  [parseAppUrl(url)](./kibana-plugin-core-public.applicationstart.parseappurl.md) | Parse given url, which can either be an absolute url or a relative path including the basePath, and return the corresponding app info if available. |
 |  [registerMountContext(contextName, provider)](./kibana-plugin-core-public.applicationstart.registermountcontext.md) | Register a context provider for application mounting. Will only be available to applications that depend on the plugin that registered this context. Deprecated, use [CoreSetup.getStartServices](./kibana-plugin-core-public.coresetup.getstartservices.md)<!-- -->. |
 
diff --git a/docs/development/core/public/kibana-plugin-core-public.applicationstart.parseappurl.md b/docs/development/core/public/kibana-plugin-core-public.applicationstart.parseappurl.md
diff --git a/docs/development/core/public/kibana-plugin-core-public.md b/docs/development/core/public/kibana-plugin-core-public.md
@@ -100,7 +100,6 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [OverlayRef](./kibana-plugin-core-public.overlayref.md) | Returned by [OverlayStart](./kibana-plugin-core-public.overlaystart.md) methods for closing a mounted overlay. |
 |  [OverlayStart](./kibana-plugin-core-public.overlaystart.md) |  |
 |  [PackageInfo](./kibana-plugin-core-public.packageinfo.md) |  |
-|  [ParsedAppUrl](./kibana-plugin-core-public.parsedappurl.md) | Application info returned by [ApplicationStart.parseAppUrl()](./kibana-plugin-core-public.applicationstart.parseappurl.md) |
 |  [Plugin](./kibana-plugin-core-public.plugin.md) | The interface that should be returned by a <code>PluginInitializer</code>. |
 |  [PluginInitializerContext](./kibana-plugin-core-public.plugininitializercontext.md) | The available core services passed to a <code>PluginInitializer</code> |
 |  [SavedObject](./kibana-plugin-core-public.savedobject.md) |  |
diff --git a/docs/development/core/public/kibana-plugin-core-public.parsedappurl.app.md b/docs/development/core/public/kibana-plugin-core-public.parsedappurl.app.md
diff --git a/docs/development/core/public/kibana-plugin-core-public.parsedappurl.md b/docs/development/core/public/kibana-plugin-core-public.parsedappurl.md
diff --git a/docs/development/core/public/kibana-plugin-core-public.parsedappurl.path.md b/docs/development/core/public/kibana-plugin-core-public.parsedappurl.path.md
diff --git a/src/core/public/application/application_service.mock.ts b/src/core/public/application/application_service.mock.ts
@@ -54,7 +54,6 @@ const createStartContractMock = (): jest.Mocked<ApplicationStart> => {
     navigateToApp: jest.fn(),
     navigateToUrl: jest.fn(),
     getUrlForApp: jest.fn(),
-    parseAppUrl: jest.fn(),
     registerMountContext: jest.fn(),
   };
 };
@@ -90,7 +89,6 @@ const createInternalStartContractMock = (): jest.Mocked<InternalApplicationStart
     currentAppId$: currentAppId$.asObservable(),
     getComponent: jest.fn(),
     getUrlForApp: jest.fn(),
-    parseAppUrl: jest.fn(),
     navigateToApp: jest.fn().mockImplementation((appId) => currentAppId$.next(appId)),
     navigateToUrl: jest.fn(),
     registerMountContext: jest.fn(),
diff --git a/src/core/public/application/application_service.tsx b/src/core/public/application/application_service.tsx
@@ -310,7 +310,6 @@ export class ApplicationService {
         const relUrl = http.basePath.prepend(getAppUrl(availableMounters, appId, path));
         return absolute ? relativeToAbsolute(relUrl) : relUrl;
       },
-      parseAppUrl: (url) => parseAppUrl(url, http.basePath, this.apps),
       navigateToApp,
       navigateToUrl: async (url) => {
         const appInfo = parseAppUrl(url, http.basePath, this.apps);
diff --git a/src/core/public/application/index.ts b/src/core/public/application/index.ts
@@ -42,7 +42,6 @@ export {
   LegacyApp,
   PublicAppInfo,
   PublicLegacyAppInfo,
-  ParsedAppUrl,
   // Internal types
   InternalApplicationSetup,
   InternalApplicationStart,
diff --git a/src/core/public/application/types.ts b/src/core/public/application/types.ts
@@ -574,11 +574,7 @@ export type Mounter<T = App | LegacyApp> = SelectivePartial<
   T extends LegacyApp ? never : 'unmountBeforeMounting'
 >;
 
-/**
- * Application info returned by {@link ApplicationStart.parseAppUrl}
- *
- * @public
- */
+/** @internal */
 export interface ParsedAppUrl {
   app: string;
   path?: string;
@@ -726,26 +722,6 @@ export interface ApplicationStart {
    */
   navigateToUrl(url: string): Promise<void>;
 
-  /**
-   * Parse given url, which can either be an absolute url or a relative path including the basePath, and
-   * return the corresponding app info if available.
-   *
-   * @example
-   * ```ts
-   * // current url: `https://kibana:8080/base-path/s/my-space/app/dashboard`
-   *
-   * // will return `{ app: 'discover', path: '/some-path?foo=bar'}`
-   * application.parseAppUrl('https://kibana:8080/base-path/s/my-space/app/discover/some-path?foo=bar')
-   * application.parseAppUrl('/base-path/s/my-space/app/discover/some-path?foo=bar')
-   *
-   * // will return `undefined`
-   * application.parseAppUrl('https://elsewhere:8080/base-path/s/my-space/app/discover/some-path') // origin does not match
-   * application.parseAppUrl('/app/discover/some-path') // does not include the current basePath
-   * application.parseAppUrl('/base-path/s/my-space/app/unknown-app/some-path') // unknown application
-   * ```
-   */
-  parseAppUrl(url: string): ParsedAppUrl | undefined;
-
   /**
    * Returns an URL to a given app, including the global base path.
    * By default, the URL is relative (/basePath/app/my-app).
diff --git a/src/core/public/index.ts b/src/core/public/index.ts
@@ -122,7 +122,6 @@ export {
   AppNavLinkStatus,
   AppUpdatableFields,
   AppUpdater,
-  ParsedAppUrl,
   ScopedHistory,
   LegacyApp,
   PublicLegacyAppInfo,
diff --git a/src/core/public/legacy/legacy_service.ts b/src/core/public/legacy/legacy_service.ts
@@ -135,7 +135,6 @@ export class LegacyPlatformService {
         currentAppId$: core.application.currentAppId$,
         capabilities: core.application.capabilities,
         getUrlForApp: core.application.getUrlForApp,
-        parseAppUrl: core.application.parseAppUrl,
         navigateToApp: core.application.navigateToApp,
         navigateToUrl: core.application.navigateToUrl,
         registerMountContext: notSupported(`core.application.registerMountContext()`),
diff --git a/src/core/public/plugins/plugin_context.ts b/src/core/public/plugins/plugin_context.ts
@@ -141,7 +141,6 @@ export function createPluginStartContext<
       navigateToApp: deps.application.navigateToApp,
       navigateToUrl: deps.application.navigateToUrl,
       getUrlForApp: deps.application.getUrlForApp,
-      parseAppUrl: deps.application.parseAppUrl,
       registerMountContext: (contextName, provider) =>
         deps.application.registerMountContext(plugin.opaqueId, contextName, provider),
     },
diff --git a/src/core/public/public.api.md b/src/core/public/public.api.md
@@ -121,7 +121,6 @@ export interface ApplicationStart {
         state?: any;
     }): Promise<void>;
     navigateToUrl(url: string): Promise<void>;
-    parseAppUrl(url: string): ParsedAppUrl | undefined;
     // @deprecated
     registerMountContext<T extends keyof AppMountContext>(contextName: T, provider: IContextProvider<AppMountDeprecated, T>): void;
 }
@@ -980,14 +979,6 @@ export interface PackageInfo {
     version: string;
 }
 
-// @public
-export interface ParsedAppUrl {
-    // (undocumented)
-    app: string;
-    // (undocumented)
-    path?: string;
-}
-
 // @public
 export interface Plugin<TSetup = void, TStart = void, TPluginsSetup extends object = object, TPluginsStart extends object = object> {
     // (undocumented)
diff --git a/src/plugins/kibana_react/public/app_links/redirect_app_link.test.tsx b/src/plugins/kibana_react/public/app_links/redirect_app_link.test.tsx
@@ -30,7 +30,6 @@ describe('RedirectAppLinks', () => {
 
   beforeEach(() => {
     application = applicationServiceMock.createStartContract();
-    application.parseAppUrl.mockReturnValue({ app: 'targetApp' });
     application.currentAppId$ = new BehaviorSubject<string>('currentApp');
   });
 
