Merge branch 'master' into canvas-embeddables-refresh

CONTRIBUTING.md

@@ -490,6 +490,14 @@ module.exports = {
 };
 ```
 
+APM [Real User Monitoring agent](https://www.elastic.co/guide/en/apm/agent/rum-js/current/index.html) is not available in the Kibana distributables,
+however the agent can be enabled by setting `ELASTIC_APM_ACTIVE` to `true`.
+flags
+```
+ELASTIC_APM_ACTIVE=true yarn start
+// activates both Node.js and RUM agent
+```
+
 Once the agent is active, it will trace all incoming HTTP requests to Kibana, monitor for errors, and collect process-level metrics.
 The collected data will be sent to the APM Server and is viewable in the APM UI in Kibana.
 

docs/development/core/public/kibana-plugin-core-public.applicationstart.geturlforapp.md

@@ -6,7 +6,7 @@
 
 Returns an URL to a given app, including the global base path. By default, the URL is relative (/basePath/app/my-app). Use the `absolute` option to generate an absolute url (http://host:port/basePath/app/my-app)
 
-Note that when generating absolute urls, the protocol, host and port are determined from the browser location.
+Note that when generating absolute urls, the origin (protocol, host and port) are determined from the browser's location.
 
 <b>Signature:</b>
 

docs/development/core/public/kibana-plugin-core-public.applicationstart.md

@@ -22,7 +22,8 @@ export interface ApplicationStart
 
 | Method | Description |
 | --- | --- |
-| [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 protocol, host and port are determined from the browser location. |
+| [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> |
 | [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)<!-- -->. |
 

docs/development/core/public/kibana-plugin-core-public.applicationstart.navigatetourl.md

@@ -0,0 +1,45 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) &gt; [navigateToUrl](./kibana-plugin-core-public.applicationstart.navigatetourl.md)
+
+## ApplicationStart.navigateToUrl() method
+
+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 `appRoute` configuration)
+
+Then a SPA navigation will be performed using `navigateToApp` using the corresponding application and path. Otherwise, fallback to a full page reload to navigate to the url using `window.location.assign`
+
+<b>Signature:</b>
+
+```typescript
+navigateToUrl(url: string): Promise<void>;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| url | <code>string</code> | an absolute url, or a relative path, to navigate to. |
+
+<b>Returns:</b>
+
+`Promise<void>`
+
+## Example
+
+
+```ts
+// current url: `https://kibana:8080/base-path/s/my-space/app/dashboard`
+
+// will call `application.navigateToApp('discover', { path: '/some-path?foo=bar'})`
+application.navigateToUrl('https://kibana:8080/base-path/s/my-space/app/discover/some-path?foo=bar')
+application.navigateToUrl('/base-path/s/my-space/app/discover/some-path?foo=bar')
+
+// will perform a full page reload using `window.location.assign`
+application.navigateToUrl('https://elsewhere:8080/base-path/s/my-space/app/discover/some-path') // origin does not match
+application.navigateToUrl('/app/discover/some-path') // does not include the current basePath
+application.navigateToUrl('/base-path/s/my-space/app/unknown-app/some-path') // unknown application
+
+```
+

package.json

@@ -176,7 +176,7 @@
  "deep-freeze-strict": "^1.1.1",
  "deepmerge": "^4.2.2",
  "del": "^5.1.0",
- "elastic-apm-node": "^3.2.0",
+ "elastic-apm-node": "^3.6.0",
  "elasticsearch": "^16.7.0",
  "elasticsearch-browser": "^16.7.0",
  "execa": "^4.0.0",

src/core/public/application/application_service.mock.ts

@@ -50,6 +50,7 @@ const createStartContractMock = (): jest.Mocked<ApplicationStart> => {
  currentAppId$: currentAppId$.asObservable(),
  capabilities: capabilitiesServiceMock.createStartContract().capabilities,
  navigateToApp: jest.fn(),
+ navigateToUrl: jest.fn(),
  getUrlForApp: jest.fn(),
  registerMountContext: jest.fn(),
  };
@@ -65,6 +66,7 @@ const createInternalStartContractMock = (): jest.Mocked<InternalApplicationStart
  getComponent: jest.fn(),
  getUrlForApp: jest.fn(),
  navigateToApp: jest.fn().mockImplementation((appId) => currentAppId$.next(appId)),
+ navigateToUrl: jest.fn(),
  registerMountContext: jest.fn(),
  };
 };

src/core/public/application/application_service.test.mocks.ts

@@ -34,3 +34,9 @@ export const createBrowserHistoryMock = jest.fn().mockReturnValue(MockHistory);
 jest.doMock('history', () => ({
  createBrowserHistory: createBrowserHistoryMock,
 }));
+
+export const parseAppUrlMock = jest.fn();
+jest.doMock('./utils', () => ({
+ ...jest.requireActual('./utils'),
+ parseAppUrl: parseAppUrlMock,
+}));

src/core/public/application/application_service.test.ts

@@ -17,6 +17,12 @@
  * under the License.
  */
 
+import {
+ MockCapabilitiesService,
+ MockHistory,
+ parseAppUrlMock,
+} from './application_service.test.mocks';
+
 import { createElement } from 'react';
 import { BehaviorSubject, Subject } from 'rxjs';
 import { bufferCount, take, takeUntil } from 'rxjs/operators';
@@ -26,7 +32,6 @@ import { injectedMetadataServiceMock } from '../injected_metadata/injected_metad
 import { contextServiceMock } from '../context/context_service.mock';
 import { httpServiceMock } from '../http/http_service.mock';
 import { overlayServiceMock } from '../overlays/overlay_service.mock';
-import { MockCapabilitiesService, MockHistory } from './application_service.test.mocks';
 import { MockLifecycle } from './test_types';
 import { ApplicationService } from './application_service';
 import { App, AppNavLinkStatus, AppStatus, AppUpdater, LegacyApp } from './types';
@@ -61,6 +66,7 @@ describe('#setup()', () => {
  http,
  context: contextServiceMock.createSetupContract(),
  injectedMetadata: injectedMetadataServiceMock.createSetupContract(),
+ redirectTo: jest.fn(),
  };
  setupDeps.injectedMetadata.getLegacyMode.mockReturnValue(false);
  startDeps = { http, overlays: overlayServiceMock.createStartContract() };
@@ -174,6 +180,10 @@ describe('#setup()', () => {
  ).toThrowErrorMatchingInlineSnapshot(
  `"Cannot register an application route that includes HTTP base path"`
  );
+
+ expect(() =>
+ register(Symbol(), createApp({ id: 'app3', appRoute: '/base-path-i-am-not' }))
+ ).not.toThrow();
  });
  });
 
@@ -462,12 +472,14 @@ describe('#setup()', () => {
 describe('#start()', () => {
  beforeEach(() => {
  MockHistory.push.mockReset();
+ parseAppUrlMock.mockReset();
 
  const http = httpServiceMock.createSetupContract({ basePath: '/base-path' });
  setupDeps = {
  http,
  context: contextServiceMock.createSetupContract(),
  injectedMetadata: injectedMetadataServiceMock.createSetupContract(),
+ redirectTo: jest.fn(),
  };
  setupDeps.injectedMetadata.getLegacyMode.mockReturnValue(false);
  startDeps = { http, overlays: overlayServiceMock.createStartContract() };
@@ -775,7 +787,6 @@ describe('#start()', () => {
  });
 
  it('redirects when in legacyMode', async () => {
- setupDeps.redirectTo = jest.fn();
  setupDeps.injectedMetadata.getLegacyMode.mockReturnValue(true);
  service.setup(setupDeps);
 
@@ -881,7 +892,6 @@ describe('#start()', () => {
  it('sets window.location.href when navigating to legacy apps', async () => {
  setupDeps.http = httpServiceMock.createSetupContract({ basePath: '/test' });
  setupDeps.injectedMetadata.getLegacyMode.mockReturnValue(true);
- setupDeps.redirectTo = jest.fn();
  service.setup(setupDeps);
 
  const { navigateToApp } = await service.start(startDeps);
@@ -893,7 +903,6 @@ describe('#start()', () => {
  it('handles legacy apps with subapps', async () => {
  setupDeps.http = httpServiceMock.createSetupContract({ basePath: '/test' });
  setupDeps.injectedMetadata.getLegacyMode.mockReturnValue(true);
- setupDeps.redirectTo = jest.fn();
 
  const { registerLegacyApp } = service.setup(setupDeps);
 
@@ -905,6 +914,30 @@ describe('#start()', () => {
  expect(setupDeps.redirectTo).toHaveBeenCalledWith('/test/app/baseApp');
  });
  });
+
+ describe('navigateToUrl', () => {
+ it('calls `redirectTo` when the url is not parseable', async () => {
+ parseAppUrlMock.mockReturnValue(undefined);
+ service.setup(setupDeps);
+ const { navigateToUrl } = await service.start(startDeps);
+
+ await navigateToUrl('/not-an-app-path');
+
+ expect(MockHistory.push).not.toHaveBeenCalled();
+ expect(setupDeps.redirectTo).toHaveBeenCalledWith('/not-an-app-path');
+ });
+
+ it('calls `navigateToApp` when the url is an internal app link', async () => {
+ parseAppUrlMock.mockReturnValue({ app: 'foo', path: '/some-path' });
+ service.setup(setupDeps);
+ const { navigateToUrl } = await service.start(startDeps);
+
+ await navigateToUrl('/an-app-path');
+
+ expect(MockHistory.push).toHaveBeenCalledWith('/app/foo/some-path', undefined);
+ expect(setupDeps.redirectTo).not.toHaveBeenCalled();
+ });
+ });
 });
 
 describe('#stop()', () => {

src/core/public/application/application_service.tsx

@@ -46,17 +46,14 @@ import {
  Mounter,
 } from './types';
 import { getLeaveAction, isConfirmAction } from './application_leave';
-import { appendAppPath } from './utils';
+import { appendAppPath, parseAppUrl, relativeToAbsolute } from './utils';
 
 interface SetupDeps {
  context: ContextSetup;
  http: HttpSetup;
  injectedMetadata: InjectedMetadataSetup;
  history?: History<any>;
- /**
- * Only necessary for redirecting to legacy apps
- * @deprecated
- */
+ /** Used to redirect to external urls (and legacy apps) */
  redirectTo?: (path: string) => void;
 }
 
@@ -109,6 +106,7 @@ export class ApplicationService {
  private history?: History<any>;
  private mountContext?: IContextContainer<AppMountDeprecated>;
  private navigate?: (url: string, state: any) => void;
+ private redirectTo?: (url: string) => void;
 
  public setup({
  context,
@@ -131,7 +129,7 @@ export class ApplicationService {
  this.navigate = (url, state) =>
  // basePath not needed here because `history` is configured with basename
  this.history ? this.history.push(url, state) : redirectTo(basePath.prepend(url));
-
+ this.redirectTo = redirectTo;
  this.mountContext = context.createContextContainer();
 
  const registerStatusUpdater = (application: string, updater$: Observable<AppUpdater>) => {
@@ -179,7 +177,7 @@ export class ApplicationService {
  throw new Error(
  `An application is already registered with the appRoute "${app.appRoute}"`
  );
- } else if (basename && app.appRoute!.startsWith(basename)) {
+ } else if (basename && app.appRoute!.startsWith(`${basename}/`)) {
  throw new Error('Cannot register an application route that includes HTTP base path');
  }
 
@@ -208,7 +206,7 @@ export class ApplicationService {
  throw new Error('Applications cannot be registered after "setup"');
  } else if (this.apps.has(app.id)) {
  throw new Error(`An application is already registered with the id "${app.id}"`);
- } else if (basename && appRoute!.startsWith(basename)) {
+ } else if (basename && appRoute!.startsWith(`${basename}/`)) {
  throw new Error('Cannot register an application route that includes HTTP base path');
  }
 
@@ -278,6 +276,20 @@ export class ApplicationService {
  shareReplay(1)
  );
 
+ const navigateToApp: InternalApplicationStart['navigateToApp'] = async (
+ appId,
+ { path, state }: { path?: string; state?: any } = {}
+ ) => {
+ if (await this.shouldNavigate(overlays)) {
+ if (path === undefined) {
+ path = applications$.value.get(appId)?.defaultPath;
+ }
+ this.appLeaveHandlers.delete(this.currentAppId$.value!);
+ this.navigate!(getAppUrl(availableMounters, appId, path), state);
+ this.currentAppId$.next(appId);
+ }
+ };
+
  return {
  applications$,
  capabilities,
@@ -294,14 +306,13 @@ export class ApplicationService {
  const relUrl = http.basePath.prepend(getAppUrl(availableMounters, appId, path));
  return absolute ? relativeToAbsolute(relUrl) : relUrl;
  },
- navigateToApp: async (appId, { path, state }: { path?: string; state?: any } = {}) => {
- if (await this.shouldNavigate(overlays)) {
- if (path === undefined) {
- path = applications$.value.get(appId)?.defaultPath;
- }
- this.appLeaveHandlers.delete(this.currentAppId$.value!);
- this.navigate!(getAppUrl(availableMounters, appId, path), state);
- this.currentAppId$.next(appId);
+ navigateToApp,
+ navigateToUrl: async (url) => {
+ const appInfo = parseAppUrl(url, http.basePath, this.apps);
+ if (appInfo) {
+ return navigateToApp(appInfo.app, { path: appInfo.path });
+ } else {
+ return this.redirectTo!(url);
  }
  },
  getComponent: () => {
@@ -388,10 +399,3 @@ const updateStatus = <T extends AppBase>(app: T, statusUpdaters: AppUpdaterWrapp
  ...changes,
  };
 };
-
-function relativeToAbsolute(url: string) {
- // convert all link urls to absolute urls
- const a = document.createElement('a');
- a.setAttribute('href', url);
- return a.href;
-}

src/core/public/application/types.ts

@@ -659,12 +659,41 @@ export interface ApplicationStart {
  */
  navigateToApp(appId: string, options?: { path?: string; state?: any }): Promise<void>;
 
+ /**
+ * 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 `appRoute` configuration)
+ *
+ * Then a SPA navigation will be performed using `navigateToApp` using the corresponding application and path.
+ * Otherwise, fallback to a full page reload to navigate to the url using `window.location.assign`
+ *
+ * @example
+ * ```ts
+ * // current url: `https://kibana:8080/base-path/s/my-space/app/dashboard`
+ *
+ * // will call `application.navigateToApp('discover', { path: '/some-path?foo=bar'})`
+ * application.navigateToUrl('https://kibana:8080/base-path/s/my-space/app/discover/some-path?foo=bar')
+ * application.navigateToUrl('/base-path/s/my-space/app/discover/some-path?foo=bar')
+ *
+ * // will perform a full page reload using `window.location.assign`
+ * application.navigateToUrl('https://elsewhere:8080/base-path/s/my-space/app/discover/some-path') // origin does not match
+ * application.navigateToUrl('/app/discover/some-path') // does not include the current basePath
+ * application.navigateToUrl('/base-path/s/my-space/app/unknown-app/some-path') // unknown application
+ * ```
+ *
+ * @param url - an absolute url, or a relative path, to navigate to.
+ */
+ navigateToUrl(url: string): Promise<void>;
+
  /**
  * Returns an URL to a given app, including the global base path.
  * By default, the URL is relative (/basePath/app/my-app).
  * Use the `absolute` option to generate an absolute url (http://host:port/basePath/app/my-app)
  *
- * Note that when generating absolute urls, the protocol, host and port are determined from the browser location.
+ * Note that when generating absolute urls, the origin (protocol, host and port) are determined from the browser's location.
  *
  * @param appId
  * @param options.path - optional path inside application to deep link to
@@ -677,7 +706,6 @@ export interface ApplicationStart {
  * plugin that registered this context. Deprecated, use {@link CoreSetup.getStartServices}.
  *
  * @deprecated
- * @param pluginOpaqueId - The opaque ID of the plugin that is registering the context.
  * @param contextName - The key of {@link AppMountContext} this provider's return value should be attached to.
  * @param provider - A {@link IContextProvider} function
  */
@@ -696,7 +724,7 @@ export interface ApplicationStart {
 export interface InternalApplicationStart
  extends Pick<
  ApplicationStart,
- 'capabilities' | 'navigateToApp' | 'getUrlForApp' | 'currentAppId$'
+ 'capabilities' | 'navigateToApp' | 'navigateToUrl' | 'getUrlForApp' | 'currentAppId$'
  > {
  /**
  * Apps available based on the current capabilities.