-
Notifications
You must be signed in to change notification settings - Fork 8.2k
/
plugin.ts
154 lines (141 loc) · 5.31 KB
/
plugin.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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the "Elastic License
* 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
* Public License v 1"; you may not use this file except in compliance with, at
* your election, the "Elastic License 2.0", the "GNU Affero General Public
* License v3.0 only", or the "Server Side Public License, v 1".
*/
import type { SerializableRecord } from '@kbn/utility-types';
import { CoreSetup, CoreStart, Plugin } from '@kbn/core/server';
import { identity } from 'lodash';
import {
PersistableStateService,
PersistableStateMigrateFn,
MigrateFunctionsObject,
} from '@kbn/kibana-utils-plugin/common';
import {
EmbeddableFactoryRegistry,
EnhancementsRegistry,
EnhancementRegistryDefinition,
EnhancementRegistryItem,
} from './types';
import {
getExtractFunction,
getInjectFunction,
getMigrateFunction,
getTelemetryFunction,
} from '../common/lib';
import {
EmbeddableStateWithType,
CommonEmbeddableStartContract,
EmbeddableRegistryDefinition,
} from '../common/types';
import { getAllMigrations } from '../common/lib/get_all_migrations';
export interface EmbeddableSetup extends PersistableStateService<EmbeddableStateWithType> {
registerEmbeddableFactory: (factory: EmbeddableRegistryDefinition) => void;
registerEnhancement: (enhancement: EnhancementRegistryDefinition) => void;
getAllMigrations: () => MigrateFunctionsObject;
}
export type EmbeddableStart = PersistableStateService<EmbeddableStateWithType>;
export class EmbeddableServerPlugin implements Plugin<EmbeddableSetup, EmbeddableStart> {
private readonly embeddableFactories: EmbeddableFactoryRegistry = new Map();
private readonly enhancements: EnhancementsRegistry = new Map();
private migrateFn: PersistableStateMigrateFn | undefined;
public setup(core: CoreSetup) {
const commonContract: CommonEmbeddableStartContract = {
getEmbeddableFactory: this
.getEmbeddableFactory as unknown as CommonEmbeddableStartContract['getEmbeddableFactory'],
getEnhancement: this.getEnhancement,
};
this.migrateFn = getMigrateFunction(commonContract);
return {
registerEmbeddableFactory: this.registerEmbeddableFactory,
registerEnhancement: this.registerEnhancement,
telemetry: getTelemetryFunction(commonContract),
extract: getExtractFunction(commonContract),
inject: getInjectFunction(commonContract),
getAllMigrations: () =>
getAllMigrations(
Array.from(this.embeddableFactories.values()),
Array.from(this.enhancements.values()),
this.migrateFn!
),
};
}
public start(core: CoreStart) {
const commonContract: CommonEmbeddableStartContract = {
getEmbeddableFactory: this
.getEmbeddableFactory as unknown as CommonEmbeddableStartContract['getEmbeddableFactory'],
getEnhancement: this.getEnhancement,
};
return {
telemetry: getTelemetryFunction(commonContract),
extract: getExtractFunction(commonContract),
inject: getInjectFunction(commonContract),
getAllMigrations: () =>
getAllMigrations(
Array.from(this.embeddableFactories.values()),
Array.from(this.enhancements.values()),
this.migrateFn!
),
};
}
public stop() {}
private registerEnhancement = (enhancement: EnhancementRegistryDefinition) => {
if (this.enhancements.has(enhancement.id)) {
throw new Error(`enhancement with id ${enhancement.id} already exists in the registry`);
}
this.enhancements.set(enhancement.id, {
id: enhancement.id,
telemetry: enhancement.telemetry || ((state, stats) => stats),
inject: enhancement.inject || identity,
extract:
enhancement.extract ||
((state: SerializableRecord) => {
return { state, references: [] };
}),
migrations: enhancement.migrations || {},
});
};
private getEnhancement = (id: string): EnhancementRegistryItem => {
return (
this.enhancements.get(id) || {
id: 'unknown',
telemetry: (state, stats) => stats,
inject: identity,
extract: (state: SerializableRecord) => {
return { state, references: [] };
},
migrations: {},
}
);
};
private registerEmbeddableFactory = (factory: EmbeddableRegistryDefinition) => {
if (this.embeddableFactories.has(factory.id)) {
throw new Error(
`Embeddable factory [embeddableFactoryId = ${factory.id}] already registered in Embeddables API.`
);
}
this.embeddableFactories.set(factory.id, {
id: factory.id,
telemetry: factory.telemetry || ((state, stats) => stats),
inject: factory.inject || identity,
extract: factory.extract || ((state: EmbeddableStateWithType) => ({ state, references: [] })),
migrations: factory.migrations || {},
});
};
private getEmbeddableFactory = (embeddableFactoryId: string) => {
return (
this.embeddableFactories.get(embeddableFactoryId) || {
id: 'unknown',
telemetry: (state, stats) => stats,
inject: (state: EmbeddableStateWithType) => state,
extract: (state: EmbeddableStateWithType) => {
return { state, references: [] };
},
migrations: {},
}
);
};
}