Remove shared environment code & documentation
Signed-off-by: Philipp Hugenroth <philipph@spotify.com>
This commit is contained in:
@@ -19,10 +19,9 @@ import {
|
||||
createBackendPlugin,
|
||||
createServiceFactory,
|
||||
createServiceRef,
|
||||
createSharedEnvironment,
|
||||
} from '@backstage/backend-plugin-api';
|
||||
import { mockServices } from '@backstage/backend-test-utils';
|
||||
import { createBackend } from './CreateBackend';
|
||||
import { mockServices } from '@backstage/backend-test-utils';
|
||||
|
||||
const fooServiceRef = createServiceRef<string>({ id: 'foo', scope: 'root' });
|
||||
const barServiceRef = createServiceRef<string>({ id: 'bar', scope: 'root' });
|
||||
@@ -86,65 +85,34 @@ describe('createBackend', () => {
|
||||
).toThrow('The core.pluginMetadata service cannot be overridden');
|
||||
});
|
||||
|
||||
it('should throw if an unsupported InternalSharedEnvironment version is passed in', () => {
|
||||
expect(() =>
|
||||
createBackend({
|
||||
env: {} as any,
|
||||
}),
|
||||
).toThrow(
|
||||
"Shared environment version 'undefined' is invalid or not supported",
|
||||
);
|
||||
expect(() =>
|
||||
createBackend({
|
||||
env: { version: {} } as any,
|
||||
}),
|
||||
).toThrow(
|
||||
"Shared environment version '[object Object]' is invalid or not supported",
|
||||
);
|
||||
expect(() =>
|
||||
createBackend({
|
||||
env: { version: 'v2' } as any,
|
||||
}),
|
||||
).toThrow("Shared environment version 'v2' is invalid or not supported");
|
||||
});
|
||||
|
||||
it('should prioritize services correctly', async () => {
|
||||
const backend = createBackend({
|
||||
env: createSharedEnvironment({
|
||||
services: [
|
||||
createServiceFactory({
|
||||
service: coreServices.rootHttpRouter,
|
||||
deps: {},
|
||||
async factory() {
|
||||
return {
|
||||
use() {},
|
||||
};
|
||||
},
|
||||
}),
|
||||
mockServices.config.factory({
|
||||
data: { root: 'root-env' },
|
||||
}),
|
||||
createServiceFactory({
|
||||
service: fooServiceRef,
|
||||
deps: {},
|
||||
async factory() {
|
||||
return 'foo-env';
|
||||
},
|
||||
}),
|
||||
createServiceFactory({
|
||||
service: barServiceRef,
|
||||
deps: {},
|
||||
async factory() {
|
||||
return 'bar-env';
|
||||
},
|
||||
}),
|
||||
],
|
||||
})(),
|
||||
services: [
|
||||
createServiceFactory({
|
||||
service: coreServices.rootHttpRouter,
|
||||
deps: {},
|
||||
async factory() {
|
||||
return {
|
||||
use() {},
|
||||
};
|
||||
},
|
||||
}),
|
||||
mockServices.config.factory({
|
||||
data: { root: 'root-backend' },
|
||||
}),
|
||||
createServiceFactory({
|
||||
service: fooServiceRef,
|
||||
deps: {},
|
||||
factory: async () => 'foo-backend',
|
||||
async factory() {
|
||||
return 'foo-backend';
|
||||
},
|
||||
}),
|
||||
createServiceFactory({
|
||||
service: barServiceRef,
|
||||
deps: {},
|
||||
async factory() {
|
||||
return 'bar-backend';
|
||||
},
|
||||
}),
|
||||
],
|
||||
});
|
||||
@@ -161,9 +129,9 @@ describe('createBackend', () => {
|
||||
bar: barServiceRef,
|
||||
},
|
||||
async init({ config, foo, bar }) {
|
||||
expect(config.get('root')).toBe('root-env');
|
||||
expect(config.get('root')).toBe('root-backend');
|
||||
expect(foo).toBe('foo-backend');
|
||||
expect(bar).toBe('bar-env');
|
||||
expect(bar).toBe('bar-backend');
|
||||
},
|
||||
});
|
||||
},
|
||||
|
||||
@@ -36,13 +36,8 @@ import {
|
||||
import {
|
||||
ServiceFactory,
|
||||
ServiceFactoryOrFunction,
|
||||
SharedBackendEnvironment,
|
||||
} from '@backstage/backend-plugin-api';
|
||||
|
||||
// Internal import of the type to avoid needing to export this.
|
||||
// eslint-disable-next-line @backstage/no-forbidden-package-imports
|
||||
import type { InternalSharedBackendEnvironment } from '@backstage/backend-plugin-api/src/wiring/createSharedEnvironment';
|
||||
|
||||
export const defaultServiceFactories = [
|
||||
cacheServiceFactory(),
|
||||
configServiceFactory(),
|
||||
@@ -65,7 +60,6 @@ export const defaultServiceFactories = [
|
||||
* @public
|
||||
*/
|
||||
export interface CreateBackendOptions {
|
||||
env?: SharedBackendEnvironment;
|
||||
services?: ServiceFactoryOrFunction[];
|
||||
}
|
||||
|
||||
@@ -81,22 +75,6 @@ export function createBackend(options?: CreateBackendOptions): Backend {
|
||||
);
|
||||
services.push(...providedServices);
|
||||
|
||||
// Middle priority: Services from the shared environment
|
||||
if (options?.env) {
|
||||
const env = options.env as unknown as InternalSharedBackendEnvironment;
|
||||
if (env.version !== 'v1') {
|
||||
throw new Error(
|
||||
`Shared environment version '${env.version}' is invalid or not supported`,
|
||||
);
|
||||
}
|
||||
|
||||
const environmentServices =
|
||||
env.services?.filter(
|
||||
sf => !services.some(({ service }) => sf.service.id === service.id),
|
||||
) ?? [];
|
||||
services.push(...environmentServices);
|
||||
}
|
||||
|
||||
// Lowest priority: Default services that are not already provided by environment or directly to createBackend
|
||||
const defaultServices = defaultServiceFactories.filter(
|
||||
sf => !services.some(({ service }) => service.id === sf.service.id),
|
||||
|
||||
Reference in New Issue
Block a user