Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove browser basePath service, move functionality into browser http service #36611

Merged
merged 5 commits into from
May 22, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

## CoreSetup.http property

[IHttpService](./kibana-plugin-public.ihttpservice.md)
[HttpSetup](./kibana-plugin-public.httpsetup.md)

<b>Signature:</b>

```typescript
http: IHttpService;
http: HttpSetup;
```
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export interface CoreSetup
| --- | --- | --- |
| [chrome](./kibana-plugin-public.coresetup.chrome.md) | <code>ChromeSetup</code> | [ChromeSetup](./kibana-plugin-public.chromesetup.md) |
| [fatalErrors](./kibana-plugin-public.coresetup.fatalerrors.md) | <code>FatalErrorsSetup</code> | [FatalErrorsSetup](./kibana-plugin-public.fatalerrorssetup.md) |
| [http](./kibana-plugin-public.coresetup.http.md) | <code>IHttpService</code> | [IHttpService](./kibana-plugin-public.ihttpservice.md) |
| [http](./kibana-plugin-public.coresetup.http.md) | <code>HttpSetup</code> | [HttpSetup](./kibana-plugin-public.httpsetup.md) |
| [i18n](./kibana-plugin-public.coresetup.i18n.md) | <code>I18nSetup</code> | [I18nSetup](./kibana-plugin-public.i18nsetup.md) |
| [notifications](./kibana-plugin-public.coresetup.notifications.md) | <code>NotificationsSetup</code> | [NotificationsSetup](./kibana-plugin-public.notificationssetup.md) |
| [uiSettings](./kibana-plugin-public.coresetup.uisettings.md) | <code>UiSettingsSetup</code> | [UiSettingsSetup](./kibana-plugin-public.uisettingssetup.md) |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

## CoreStart.http property

[IHttpService](./kibana-plugin-public.ihttpservice.md)
[HttpStart](./kibana-plugin-public.httpstart.md)

<b>Signature:</b>

```typescript
http: IHttpService;
http: HttpStart;
```
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export interface CoreStart
| --- | --- | --- |
| [application](./kibana-plugin-public.corestart.application.md) | <code>Pick&lt;ApplicationStart, 'capabilities'&gt;</code> | [ApplicationStart](./kibana-plugin-public.applicationstart.md) |
| [chrome](./kibana-plugin-public.corestart.chrome.md) | <code>ChromeStart</code> | [ChromeStart](./kibana-plugin-public.chromestart.md) |
| [http](./kibana-plugin-public.corestart.http.md) | <code>IHttpService</code> | [IHttpService](./kibana-plugin-public.ihttpservice.md) |
| [http](./kibana-plugin-public.corestart.http.md) | <code>HttpStart</code> | [HttpStart](./kibana-plugin-public.httpstart.md) |
| [i18n](./kibana-plugin-public.corestart.i18n.md) | <code>I18nStart</code> | [I18nStart](./kibana-plugin-public.i18nstart.md) |
| [notifications](./kibana-plugin-public.corestart.notifications.md) | <code>NotificationsStart</code> | [NotificationsStart](./kibana-plugin-public.notificationsstart.md) |
| [overlays](./kibana-plugin-public.corestart.overlays.md) | <code>OverlayStart</code> | [OverlayStart](./kibana-plugin-public.overlaystart.md) |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [IHttpService](./kibana-plugin-public.ihttpservice.md) &gt; [addLoadingCount](./kibana-plugin-public.ihttpservice.addloadingcount.md)
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpServiceBase](./kibana-plugin-public.httpservicebase.md) &gt; [addLoadingCount](./kibana-plugin-public.httpservicebase.addloadingcount.md)

## IHttpService.addLoadingCount() method
## HttpServiceBase.addLoadingCount() method

<b>Signature:</b>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [IHttpService](./kibana-plugin-public.ihttpservice.md) &gt; [addToPath](./kibana-plugin-public.ihttpservice.addtopath.md)
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpServiceBase](./kibana-plugin-public.httpservicebase.md) &gt; [appendToBasePath](./kibana-plugin-public.httpservicebase.appendtobasepath.md)

## IHttpService.addToPath() method
## HttpServiceBase.appendToBasePath() method

<b>Signature:</b>

```typescript
addToPath(path: string): string;
appendToBasePath(path: string): string;
```

## Parameters
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [IHttpService](./kibana-plugin-public.ihttpservice.md) &gt; [delete](./kibana-plugin-public.ihttpservice.delete.md)
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpServiceBase](./kibana-plugin-public.httpservicebase.md) &gt; [delete](./kibana-plugin-public.httpservicebase.delete.md)

## IHttpService.delete property
## HttpServiceBase.delete property

<b>Signature:</b>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [IHttpService](./kibana-plugin-public.ihttpservice.md) &gt; [fetch](./kibana-plugin-public.ihttpservice.fetch.md)
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpServiceBase](./kibana-plugin-public.httpservicebase.md) &gt; [fetch](./kibana-plugin-public.httpservicebase.fetch.md)

## IHttpService.fetch property
## HttpServiceBase.fetch property

<b>Signature:</b>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [IHttpService](./kibana-plugin-public.ihttpservice.md) &gt; [get](./kibana-plugin-public.ihttpservice.get.md)
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpServiceBase](./kibana-plugin-public.httpservicebase.md) &gt; [get](./kibana-plugin-public.httpservicebase.get.md)

## IHttpService.get property
## HttpServiceBase.get property

<b>Signature:</b>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [IHttpService](./kibana-plugin-public.ihttpservice.md) &gt; [getBasePath](./kibana-plugin-public.ihttpservice.getbasepath.md)
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpServiceBase](./kibana-plugin-public.httpservicebase.md) &gt; [getBasePath](./kibana-plugin-public.httpservicebase.getbasepath.md)

## IHttpService.getBasePath() method
## HttpServiceBase.getBasePath() method

<b>Signature:</b>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [IHttpService](./kibana-plugin-public.ihttpservice.md) &gt; [getLoadingCount$](./kibana-plugin-public.ihttpservice.getloadingcount$.md)
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpServiceBase](./kibana-plugin-public.httpservicebase.md) &gt; [getLoadingCount$](./kibana-plugin-public.httpservicebase.getloadingcount$.md)

## IHttpService.getLoadingCount$() method
## HttpServiceBase.getLoadingCount$() method

<b>Signature:</b>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [IHttpService](./kibana-plugin-public.ihttpservice.md) &gt; [head](./kibana-plugin-public.ihttpservice.head.md)
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpServiceBase](./kibana-plugin-public.httpservicebase.md) &gt; [head](./kibana-plugin-public.httpservicebase.head.md)

## IHttpService.head property
## HttpServiceBase.head property

<b>Signature:</b>

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpServiceBase](./kibana-plugin-public.httpservicebase.md)

## HttpServiceBase interface


<b>Signature:</b>

```typescript
export interface HttpServiceBase
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [delete](./kibana-plugin-public.httpservicebase.delete.md) | <code>HttpHandler</code> | |
| [fetch](./kibana-plugin-public.httpservicebase.fetch.md) | <code>HttpHandler</code> | |
| [get](./kibana-plugin-public.httpservicebase.get.md) | <code>HttpHandler</code> | |
| [head](./kibana-plugin-public.httpservicebase.head.md) | <code>HttpHandler</code> | |
| [options](./kibana-plugin-public.httpservicebase.options.md) | <code>HttpHandler</code> | |
| [patch](./kibana-plugin-public.httpservicebase.patch.md) | <code>HttpHandler</code> | |
| [post](./kibana-plugin-public.httpservicebase.post.md) | <code>HttpHandler</code> | |
| [put](./kibana-plugin-public.httpservicebase.put.md) | <code>HttpHandler</code> | |

## Methods

| Method | Description |
| --- | --- |
| [addLoadingCount(count$)](./kibana-plugin-public.httpservicebase.addloadingcount.md) | |
| [appendToBasePath(path)](./kibana-plugin-public.httpservicebase.appendtobasepath.md) | |
| [getBasePath()](./kibana-plugin-public.httpservicebase.getbasepath.md) | |
| [getLoadingCount$()](./kibana-plugin-public.httpservicebase.getloadingcount$.md) | |
| [removeFromBasePath(path)](./kibana-plugin-public.httpservicebase.removefrombasepath.md) | |
| [stop()](./kibana-plugin-public.httpservicebase.stop.md) | |

Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [IHttpService](./kibana-plugin-public.ihttpservice.md) &gt; [options](./kibana-plugin-public.ihttpservice.options.md)
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpServiceBase](./kibana-plugin-public.httpservicebase.md) &gt; [options](./kibana-plugin-public.httpservicebase.options.md)

## IHttpService.options property
## HttpServiceBase.options property

<b>Signature:</b>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [IHttpService](./kibana-plugin-public.ihttpservice.md) &gt; [patch](./kibana-plugin-public.ihttpservice.patch.md)
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpServiceBase](./kibana-plugin-public.httpservicebase.md) &gt; [patch](./kibana-plugin-public.httpservicebase.patch.md)

## IHttpService.patch property
## HttpServiceBase.patch property

<b>Signature:</b>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [IHttpService](./kibana-plugin-public.ihttpservice.md) &gt; [post](./kibana-plugin-public.ihttpservice.post.md)
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpServiceBase](./kibana-plugin-public.httpservicebase.md) &gt; [post](./kibana-plugin-public.httpservicebase.post.md)

## IHttpService.post property
## HttpServiceBase.post property

<b>Signature:</b>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [IHttpService](./kibana-plugin-public.ihttpservice.md) &gt; [put](./kibana-plugin-public.ihttpservice.put.md)
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpServiceBase](./kibana-plugin-public.httpservicebase.md) &gt; [put](./kibana-plugin-public.httpservicebase.put.md)

## IHttpService.put property
## HttpServiceBase.put property

<b>Signature:</b>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [IHttpService](./kibana-plugin-public.ihttpservice.md) &gt; [removeFromPath](./kibana-plugin-public.ihttpservice.removefrompath.md)
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpServiceBase](./kibana-plugin-public.httpservicebase.md) &gt; [removeFromBasePath](./kibana-plugin-public.httpservicebase.removefrombasepath.md)

## IHttpService.removeFromPath() method
## HttpServiceBase.removeFromBasePath() method

<b>Signature:</b>

```typescript
removeFromPath(path: string): string;
removeFromBasePath(path: string): string;
```

## Parameters
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [IHttpService](./kibana-plugin-public.ihttpservice.md) &gt; [stop](./kibana-plugin-public.ihttpservice.stop.md)
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpServiceBase](./kibana-plugin-public.httpservicebase.md) &gt; [stop](./kibana-plugin-public.httpservicebase.stop.md)

## IHttpService.stop() method
## HttpServiceBase.stop() method

<b>Signature:</b>

Expand Down
12 changes: 12 additions & 0 deletions docs/development/core/public/kibana-plugin-public.httpsetup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpSetup](./kibana-plugin-public.httpsetup.md)

## HttpSetup type


<b>Signature:</b>

```typescript
export declare type HttpSetup = HttpServiceBase;
```
12 changes: 12 additions & 0 deletions docs/development/core/public/kibana-plugin-public.httpstart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpStart](./kibana-plugin-public.httpstart.md)

## HttpStart type


<b>Signature:</b>

```typescript
export declare type HttpStart = HttpServiceBase;
```
36 changes: 0 additions & 36 deletions docs/development/core/public/kibana-plugin-public.ihttpservice.md

This file was deleted.

4 changes: 3 additions & 1 deletion docs/development/core/public/kibana-plugin-public.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [CoreStart](./kibana-plugin-public.corestart.md) | Core services exposed to the <code>Plugin</code> start lifecycle |
| [FatalErrorInfo](./kibana-plugin-public.fatalerrorinfo.md) | Represents the <code>message</code> and <code>stack</code> of a fatal Error |
| [FatalErrorsSetup](./kibana-plugin-public.fatalerrorssetup.md) | FatalErrors stop the Kibana Public Core and displays a fatal error screen with details about the Kibana build and the error. |
| [HttpServiceBase](./kibana-plugin-public.httpservicebase.md) | |
| [I18nSetup](./kibana-plugin-public.i18nsetup.md) | I18nSetup.Context is required by any localizable React component from @<!-- -->kbn/i18n and @<!-- -->elastic/eui packages and is supposed to be used as the topmost component for any i18n-compatible React tree. |
| [IHttpService](./kibana-plugin-public.ihttpservice.md) | |
| [LegacyNavLink](./kibana-plugin-public.legacynavlink.md) | |
| [NotificationsSetup](./kibana-plugin-public.notificationssetup.md) | |
| [OverlayRef](./kibana-plugin-public.overlayref.md) | |
Expand All @@ -49,6 +49,8 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [ChromeHelpExtension](./kibana-plugin-public.chromehelpextension.md) | |
| [ChromeSetup](./kibana-plugin-public.chromesetup.md) | |
| [ChromeStart](./kibana-plugin-public.chromestart.md) | |
| [HttpSetup](./kibana-plugin-public.httpsetup.md) | |
| [HttpStart](./kibana-plugin-public.httpstart.md) | |
| [I18nStart](./kibana-plugin-public.i18nstart.md) | |
| [NotificationsStart](./kibana-plugin-public.notificationsstart.md) | |
| [PluginInitializer](./kibana-plugin-public.plugininitializer.md) | The <code>plugin</code> export at the root of a plugin's <code>public</code> directory should conform to this interface. |
Expand Down
3 changes: 1 addition & 2 deletions src/core/public/application/application_service.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,7 @@ describe('#start()', () => {
setup.registerApp({ id: 'app1' } as any);
setup.registerLegacyApp({ id: 'app2' } as any);
const injectedMetadata = injectedMetadataServiceMock.createStartContract();
expect((await service.start({ injectedMetadata })).availableApps)
.toMatchInlineSnapshot(`
expect((await service.start({ injectedMetadata })).availableApps).toMatchInlineSnapshot(`
Array [
Object {
"id": "app1",
Expand Down
4 changes: 2 additions & 2 deletions src/core/public/chrome/chrome_service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import { InjectedMetadataSetup } from '../injected_metadata';
import { NotificationsSetup } from '../notifications';
import { NavLinksService } from './nav_links/nav_links_service';
import { ApplicationStart } from '../application';
import { IHttpService } from '../http';
import { HttpStart } from '../http';

const IS_COLLAPSED_KEY = 'core.chrome.isCollapsed';

Expand Down Expand Up @@ -70,7 +70,7 @@ interface SetupDeps {

interface StartDeps {
application: ApplicationStart;
http: IHttpService;
http: HttpStart;
}

/** @internal */
Expand Down
2 changes: 1 addition & 1 deletion src/core/public/chrome/nav_links/nav_links_service.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ const mockAppService = {
} as any;

const mockHttp = {
addToPath: (url: string) => `wow${url}`,
appendToBasePath: (url: string) => `wow${url}`,
} as any;

describe('NavLinksService', () => {
Expand Down
6 changes: 3 additions & 3 deletions src/core/public/chrome/nav_links/nav_links_service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ import { BehaviorSubject, ReplaySubject } from 'rxjs';
import { map, takeUntil } from 'rxjs/operators';
import { NavLinkWrapper, NavLinkUpdateableFields } from './nav_link';
import { ApplicationStart } from '../../application';
import { IHttpService } from '../../http';
import { HttpStart } from '../../http';

interface StartDeps {
application: ApplicationStart;
http: IHttpService;
http: HttpStart;
}

export class NavLinksService {
Expand All @@ -42,7 +42,7 @@ export class NavLinksService {
new NavLinkWrapper({
...app,
// Either rootRoute or appUrl must be defined.
baseUrl: relativeToAbsolute(http.addToPath((app.rootRoute || app.appUrl)!)),
baseUrl: relativeToAbsolute(http.appendToBasePath((app.rootRoute || app.appUrl)!)),
}),
] as [string, NavLinkWrapper]
)
Expand Down
Loading