maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Use plugin version in its publicPath (#95945)

Browse source 
* Use plugin version in its publicPath

* remove useless comment

* fix types

* update generated doc
This commit is contained in:
Pierre Gayvallet 2021-04-05 18:00:13 +02:00 committed by GitHub
parent ea03eb1bab
commit 95e45ddebc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
10 changed files with 63 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
src/core/server/core_app/bundle_routes/register_bundle_routes.test.ts
View file

@ -10,7 +10,7 @@ import { registerRouteForBundleMock } from './register_bundle_routes.test.mocks'
import { PackageInfo } from '@kbn/config';
import { httpServiceMock } from '../../http/http_service.mock';
import { UiPlugins } from '../../plugins';
import { InternalPluginInfo, UiPlugins } from '../../plugins';
import { registerBundleRoutes } from './register_bundle_routes';
import { FileHashCache } from './file_hash_cache';
@ -29,9 +29,12 @@ const createUiPlugins = (...ids: string[]): UiPlugins => ({
internal: ids.reduce((map, id) => {
map.set(id, {
publicTargetDir: `/plugins/${id}/public-target-dir`,
publicAssetsDir: `/plugins/${id}/public-assets-dir`,
version: '8.0.0',
requiredBundles: [],
});
return map;
}, new Map()),
}, new Map<string, InternalPluginInfo>()),
});
describe('registerBundleRoutes', () => {
@ -86,16 +89,16 @@ describe('registerBundleRoutes', () => {
fileHashCache: expect.any(FileHashCache),
isDist: true,
bundlesPath: '/plugins/plugin-a/public-target-dir',
publicPath: '/server-base-path/42/bundles/plugin/plugin-a/',
routePath: '/42/bundles/plugin/plugin-a/',
publicPath: '/server-base-path/42/bundles/plugin/plugin-a/8.0.0/',
routePath: '/42/bundles/plugin/plugin-a/8.0.0/',
});
expect(registerRouteForBundleMock).toHaveBeenCalledWith(router, {
fileHashCache: expect.any(FileHashCache),
isDist: true,
bundlesPath: '/plugins/plugin-b/public-target-dir',
publicPath: '/server-base-path/42/bundles/plugin/plugin-b/',
routePath: '/42/bundles/plugin/plugin-b/',
publicPath: '/server-base-path/42/bundles/plugin/plugin-b/8.0.0/',
routePath: '/42/bundles/plugin/plugin-b/8.0.0/',
});
});
});

8
src/core/server/core_app/bundle_routes/register_bundle_routes.ts
View file

@ -27,7 +27,7 @@ import { registerRouteForBundle } from './bundles_route';
*/
export function registerBundleRoutes({
router,
serverBasePath, // serverBasePath
serverBasePath,
uiPlugins,
packageInfo,
}: {
@ -57,10 +57,10 @@ export function registerBundleRoutes({
isDist,
});
[...uiPlugins.internal.entries()].forEach(([id, { publicTargetDir }]) => {
[...uiPlugins.internal.entries()].forEach(([id, { publicTargetDir, version }]) => {
registerRouteForBundle(router, {
publicPath: `${serverBasePath}/${buildNum}/bundles/plugin/${id}/`,
routePath: `/${buildNum}/bundles/plugin/${id}/`,
publicPath: `${serverBasePath}/${buildNum}/bundles/plugin/${id}/${version}/`,
routePath: `/${buildNum}/bundles/plugin/${id}/${version}/`,
bundlesPath: publicTargetDir,
fileHashCache,
isDist,

1
src/core/server/legacy/legacy_service.test.ts
View file

@ -91,6 +91,7 @@ beforeEach(() => {
'plugin-id',
{
requiredBundles: [],
version: '8.0.0',
publicTargetDir: 'path/to/target/public',
publicAssetsDir: '/plugins/name/assets/',
},

14
src/core/server/plugins/plugins_service.test.ts
View file

@ -562,12 +562,12 @@ describe('PluginsService', () => {
plugin$: from([
createPlugin('plugin-1', {
path: 'path-1',
version: 'some-version',
version: 'version-1',
configPath: 'plugin1',
}),
createPlugin('plugin-2', {
path: 'path-2',
version: 'some-version',
version: 'version-2',
configPath: 'plugin2',
}),
]),
@ -577,7 +577,7 @@ describe('PluginsService', () => {
});
describe('uiPlugins.internal', () => {
it('includes disabled plugins', async () => {
it('contains internal properties for plugins', async () => {
config$.next({ plugins: { initialize: true }, plugin1: { enabled: false } });
const { uiPlugins } = await pluginsService.discover({ environment: environmentSetup });
expect(uiPlugins.internal).toMatchInlineSnapshot(`
@ -586,15 +586,23 @@ describe('PluginsService', () => {
"publicAssetsDir": <absolute path>/path-1/public/assets,
"publicTargetDir": <absolute path>/path-1/target/public,
"requiredBundles": Array [],
"version": "version-1",
},
"plugin-2" => Object {
"publicAssetsDir": <absolute path>/path-2/public/assets,
"publicTargetDir": <absolute path>/path-2/target/public,
"requiredBundles": Array [],
"version": "version-2",
},
}
`);
});
it('includes disabled plugins', async () => {
config$.next({ plugins: { initialize: true }, plugin1: { enabled: false } });
const { uiPlugins } = await pluginsService.discover({ environment: environmentSetup });
expect([...uiPlugins.internal.keys()].sort()).toEqual(['plugin-1', 'plugin-2']);
});
});
describe('plugin initialization', () => {

1
src/core/server/plugins/plugins_service.ts
View file

@ -222,6 +222,7 @@ export class PluginsService implements CoreService<PluginsServiceSetup, PluginsS
if (plugin.includesUiPlugin) {
this.uiPluginInternalInfo.set(plugin.name, {
requiredBundles: plugin.requiredBundles,
version: plugin.manifest.version,
publicTargetDir: Path.resolve(plugin.path, 'target/public'),
publicAssetsDir: Path.resolve(plugin.path, 'public/assets'),
});

1
src/core/server/plugins/plugins_system.ts
View file

@ -16,6 +16,7 @@ import { PluginsServiceSetupDeps, PluginsServiceStartDeps } from './plugins_serv
import { PluginDependencies } from '.';
const Sec = 1000;
/** @internal */
export class PluginsSystem {
private readonly plugins = new Map<PluginName, PluginWrapper>();

13
src/core/server/plugins/types.ts
View file

@ -224,12 +224,15 @@ export interface DiscoveredPlugin {
*/
export interface InternalPluginInfo {
/**
* Bundles that must be loaded for this plugoin
* Version of the plugin
*/
readonly version: string;
/**
* Bundles that must be loaded for this plugin
*/
readonly requiredBundles: readonly string[];
/**
* Path to the target/public directory of the plugin which should be
* served
* Path to the target/public directory of the plugin which should be served
*/
readonly publicTargetDir: string;
/**
@ -250,7 +253,9 @@ export interface Plugin<
TPluginsStart extends object = object
> {
setup(core: CoreSetup, plugins: TPluginsSetup): TSetup;
start(core: CoreStart, plugins: TPluginsStart): TStart;
stop?(): void;
}
@ -267,7 +272,9 @@ export interface AsyncPlugin<
TPluginsStart extends object = object
> {
setup(core: CoreSetup, plugins: TPluginsSetup): TSetup | Promise<TSetup>;
start(core: CoreStart, plugins: TPluginsStart): TStart | Promise<TStart>;
stop?(): void;
}

21
src/core/server/rendering/bootstrap/get_plugin_bundle_paths.test.ts
View file

@ -6,7 +6,7 @@
* Side Public License, v 1.
*/
import { UiPlugins } from '../../plugins';
import { InternalPluginInfo, UiPlugins } from '../../plugins';
import { getPluginsBundlePaths } from './get_plugin_bundle_paths';
const createUiPlugins = (pluginDeps: Record<string, string[]>) => {
@ -16,12 +16,13 @@ const createUiPlugins = (pluginDeps: Record<string, string[]>) => {
browserConfigs: new Map(),
};
Object.entries(pluginDeps).forEach(([pluginId, deps]) => {
const addPlugin = (pluginId: string, deps: string[]) => {
uiPlugins.internal.set(pluginId, {
requiredBundles: deps,
version: '8.0.0',
publicTargetDir: '',
publicAssetsDir: '',
} as any);
} as InternalPluginInfo);
uiPlugins.public.set(pluginId, {
id: pluginId,
configPath: 'config-path',
@ -29,6 +30,12 @@ const createUiPlugins = (pluginDeps: Record<string, string[]>) => {
requiredPlugins: [],
requiredBundles: deps,
});
deps.forEach((dep) => addPlugin(dep, []));
};
Object.entries(pluginDeps).forEach(([pluginId, deps]) => {
addPlugin(pluginId, deps);
});
return uiPlugins;
@ -56,13 +63,13 @@ describe('getPluginsBundlePaths', () => {
});
expect(pluginBundlePaths.get('a')).toEqual({
bundlePath: '/regular-bundle-path/plugin/a/a.plugin.js',
publicPath: '/regular-bundle-path/plugin/a/',
bundlePath: '/regular-bundle-path/plugin/a/8.0.0/a.plugin.js',
publicPath: '/regular-bundle-path/plugin/a/8.0.0/',
});
expect(pluginBundlePaths.get('b')).toEqual({
bundlePath: '/regular-bundle-path/plugin/b/b.plugin.js',
publicPath: '/regular-bundle-path/plugin/b/',
bundlePath: '/regular-bundle-path/plugin/b/8.0.0/b.plugin.js',
publicPath: '/regular-bundle-path/plugin/b/8.0.0/',
});
});
});

10
src/core/server/rendering/bootstrap/get_plugin_bundle_paths.ts
View file

@ -25,9 +25,15 @@ export const getPluginsBundlePaths = ({
while (pluginsToProcess.length > 0) {
const pluginId = pluginsToProcess.pop() as string;
const plugin = uiPlugins.internal.get(pluginId);
if (!plugin) {
continue;
}
const { version } = plugin;
pluginBundlePaths.set(pluginId, {
publicPath: `${regularBundlePath}/plugin/${pluginId}/`,
bundlePath: `${regularBundlePath}/plugin/${pluginId}/${pluginId}.plugin.js`,
publicPath: `${regularBundlePath}/plugin/${pluginId}/${version}/`,
bundlePath: `${regularBundlePath}/plugin/${pluginId}/${version}/${pluginId}.plugin.js`,
});
const pluginBundleIds = uiPlugins.internal.get(pluginId)?.requiredBundles ?? [];

8
src/core/server/server.api.md
View file

@ -3259,9 +3259,9 @@ export const validBodyOutput: readonly ["data", "stream"];
//
// src/core/server/elasticsearch/client/types.ts:94:7 - (ae-forgotten-export) The symbol "Explanation" needs to be exported by the entry point index.d.ts
// src/core/server/http/router/response.ts:297:3 - (ae-forgotten-export) The symbol "KibanaResponse" needs to be exported by the entry point index.d.ts
// src/core/server/plugins/types.ts:286:3 - (ae-forgotten-export) The symbol "KibanaConfigType" needs to be exported by the entry point index.d.ts
// src/core/server/plugins/types.ts:286:3 - (ae-forgotten-export) The symbol "SharedGlobalConfigKeys" needs to be exported by the entry point index.d.ts
// src/core/server/plugins/types.ts:289:3 - (ae-forgotten-export) The symbol "SavedObjectsConfigType" needs to be exported by the entry point index.d.ts
// src/core/server/plugins/types.ts:394:5 - (ae-unresolved-link) The @link reference could not be resolved: The package "kibana" does not have an export "create"
// src/core/server/plugins/types.ts:293:3 - (ae-forgotten-export) The symbol "KibanaConfigType" needs to be exported by the entry point index.d.ts
// src/core/server/plugins/types.ts:293:3 - (ae-forgotten-export) The symbol "SharedGlobalConfigKeys" needs to be exported by the entry point index.d.ts
// src/core/server/plugins/types.ts:296:3 - (ae-forgotten-export) The symbol "SavedObjectsConfigType" needs to be exported by the entry point index.d.ts
// src/core/server/plugins/types.ts:401:5 - (ae-unresolved-link) The @link reference could not be resolved: The package "kibana" does not have an export "create"
```