-
Notifications
You must be signed in to change notification settings - Fork 306
/
manage.ts
199 lines (176 loc) · 7.1 KB
/
manage.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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
import { noop } from 'lodash-es'
import { timeout } from '@masknet/kit'
import { Emitter } from '@servie/events'
import { BooleanPreference, ValueRefWithReady } from '@masknet/shared-base'
import { type Plugin } from '../types.js'
import { getPluginDefine, onNewPluginRegistered, registeredPlugins } from './store.js'
// Plugin state machine
// not-loaded => loaded
// loaded => activated (activatePlugin)
// activated => loaded (stopPlugin)
export function createManager<
T extends Plugin.Shared.DefinitionDeferred<Context>,
Context extends Plugin.Shared.SharedContext,
ManagedContext extends keyof Context = never,
>(
selectLoader: (plugin: Plugin.DeferredDefinition) => undefined | Plugin.Loader<T>,
getManagedContext: (pluginID: string, signal: AbortSignal) => Pick<Context, ManagedContext>,
) {
interface ActivatedPluginInstance {
instance: T
controller: AbortController
context: Context
minimalModeEnabled: ValueRefWithReady<boolean>
}
const resolved = new Map<string, T>()
const activated = new Map<string, ActivatedPluginInstance>()
let _host: Plugin.__Host.Host<T, Omit<Context, ManagedContext>> = undefined!
const events = new Emitter<{
activateChanged: [id: string, enabled: boolean]
minimalModeChanged: [id: string, enabled: boolean]
}>()
return {
configureHostHooks: (host: Plugin.__Host.Host<T, Omit<Context, ManagedContext>>) => (_host = host),
activatePlugin,
stopPlugin,
isActivated,
startDaemon,
activated: {
id: { [Symbol.iterator]: () => activated.keys() } as Iterable<string>,
plugins: {
*[Symbol.iterator]() {
for (const each of activated.values()) yield each.instance
},
} as Iterable<T>,
},
minimalMode: new Proxy(
{},
{
get(_, pluginID) {
if (typeof pluginID === 'symbol') return undefined
if (activated.has(pluginID)) return activated.get(pluginID)!.minimalModeEnabled
return undefined
},
},
) as Partial<Record<string, ValueRefWithReady<boolean>>>,
events,
}
async function updateCompositedMinimalMode(id: string) {
const definition = await __getDefinition(id)
if (!definition) return
const settings = await _host.minimalMode.isEnabled(id)
let result: boolean
if (settings === BooleanPreference.True) result = true
else if (settings === BooleanPreference.False) result = false
// plugin default minimal mode is false
else result = !!definition.inMinimalModeByDefault
const instance = activated.get(id)
if (instance) instance.minimalModeEnabled.value = result
}
function startDaemon(
host: Plugin.__Host.Host<T, Omit<Context, ManagedContext>>,
extraCheck?: (id: string) => boolean,
) {
_host = host
const { signal = new AbortController().signal, addI18NResource, minimalMode } = _host
const removeListener1 = minimalMode.events.on('enabled', (id) => updateCompositedMinimalMode(id))
const removeListener2 = minimalMode.events.on('disabled', (id) => updateCompositedMinimalMode(id))
const removeListener3 = onNewPluginRegistered((id, define) => {
define.i18n && addI18NResource(id, define.i18n)
checkRequirementAndStartOrStop()
})
signal.addEventListener(
'abort',
() => {
;[...activated.keys()].forEach(stopPlugin)
removeListener1()
removeListener2()
removeListener3()
},
{ once: true },
)
for (const [, plugin] of registeredPlugins.getCurrentValue()) {
plugin.i18n && addI18NResource(plugin.ID, plugin.i18n)
}
checkRequirementAndStartOrStop().then().catch(console.error)
async function checkRequirementAndStartOrStop() {
for (const [id] of registeredPlugins.getCurrentValue()) {
if (await meetRequirement(id)) await activatePlugin(id).catch(console.error)
else stopPlugin(id)
}
}
async function meetRequirement(id: string) {
const define = getPluginDefine(id)
if (!define) return false
if (extraCheck && !extraCheck(id)) return false
return true
}
}
function verifyHostHooks() {
if (!_host)
throw new Error(
'[@masknet/plugin-infra] You must call configureHostHooks or startDaemon to configure host hooks.',
)
}
async function activatePlugin(id: string) {
if (activated.has(id)) return
const definition = await __getDefinition(id)
if (!definition) return
updateCompositedMinimalMode(id).catch(noop)
if (definition.enableRequirement.target !== 'stable' && !definition.experimentalMark) {
console.warn(
`[@masknet/plugin-infra] Plugin ${id} is not enabled in stable release, expected it's "experimentalMark" to be true.`,
)
definition.experimentalMark = true
}
verifyHostHooks()
const abort = new AbortController()
const activatedPlugin: ActivatedPluginInstance = {
instance: definition,
controller: abort,
context: {
...getManagedContext(id, abort.signal),
..._host.createContext(id, definition, abort.signal),
} as any,
minimalModeEnabled: new ValueRefWithReady(),
}
activated.set(id, activatedPlugin)
if (definition.init) {
await timeout(
Promise.resolve(definition.init(activatedPlugin.controller.signal, activatedPlugin.context)),
1000,
`Plugin ${id} init() timed out.`,
).catch(console.error)
}
events.emit('activateChanged', id, true)
}
function stopPlugin(id: string) {
const instance = activated.get(id)
if (!instance) return
instance.controller.abort()
activated.delete(id)
events.emit('activateChanged', id, false)
}
function isActivated(id: string) {
return activated.has(id)
}
async function __getDefinition(id: string) {
if (resolved.has(id)) return resolved.get(id)!
const deferredDefinition = getPluginDefine(id)
if (!deferredDefinition) return
const loader = selectLoader(deferredDefinition)
if (!loader) return
const definition = (await loader.load()).default
resolved.set(id, definition)
if (import.meta.webpackHot) {
loader.hotModuleReload(async (_) => {
resolved.set(id, (await _).default)
console.log('[HMR] Plugin', id, 'hot reloaded.')
isActivated(id) && setTimeout(() => activatePlugin(id), 200)
stopPlugin(id)
})
}
return definition
}
}
createManager.NoManagedContext = () => ({})