-
Notifications
You must be signed in to change notification settings - Fork 8.1k
/
base_path_service.ts
105 lines (92 loc) · 3.02 KB
/
base_path_service.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
/*
* 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 { ensureRawRequest, KibanaRequest, LegacyRequest } from './router';
import { modifyUrl } from '../../utils';
/**
* Access or manipulate the Kibana base path
*
* @public
*/
export class BasePath {
private readonly basePathCache = new WeakMap<LegacyRequest, string>();
/**
* returns the server's basePath
*
* See {@link BasePath.get} for getting the basePath value for a specific request
*/
public readonly serverBasePath: string;
/** @internal */
constructor(serverBasePath: string = '') {
this.serverBasePath = serverBasePath;
}
/**
* returns `basePath` value, specific for an incoming request.
*/
public get = (request: KibanaRequest | LegacyRequest) => {
const requestScopePath = this.basePathCache.get(ensureRawRequest(request)) || '';
return `${this.serverBasePath}${requestScopePath}`;
};
/**
* sets `basePath` value, specific for an incoming request.
*
* @privateRemarks should work only for KibanaRequest as soon as spaces migrate to NP
*/
public set = (request: KibanaRequest | LegacyRequest, requestSpecificBasePath: string) => {
const rawRequest = ensureRawRequest(request);
if (this.basePathCache.has(rawRequest)) {
throw new Error(
'Request basePath was previously set. Setting multiple times is not supported.'
);
}
this.basePathCache.set(rawRequest, requestSpecificBasePath);
};
/**
* Prepends `path` with the basePath.
*/
public prepend = (path: string): string => {
if (this.serverBasePath === '') return path;
return modifyUrl(path, (parts) => {
if (!parts.hostname && parts.pathname && parts.pathname.startsWith('/')) {
parts.pathname = `${this.serverBasePath}${parts.pathname}`;
}
});
};
/**
* Removes the prepended basePath from the `path`.
*/
public remove = (path: string): string => {
if (this.serverBasePath === '') {
return path;
}
if (path === this.serverBasePath) {
return '/';
}
if (path.startsWith(`${this.serverBasePath}/`)) {
return path.slice(this.serverBasePath.length);
}
return path;
};
}
/**
* Access or manipulate the Kibana base path
*
* {@link BasePath}
* @public
*/
export type IBasePath = Pick<BasePath, keyof BasePath>;