Skip to content

Enable TS Server plugins on web #47377

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rbuckton merged 12 commits into from
Jun 14, 2022
Merged

Enable TS Server plugins on web #47377

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
e2bbb6c
Prototype TS plugins on web
mjbvz Feb 16, 2022
53d90b6
use default export from plugins
mjbvz Feb 24, 2022
34a83a3
Allow configure plugin requests against any web servers in partial se…
mjbvz Mar 4, 2022
51680a1
Addressing some comments
mjbvz Mar 8, 2022
85e0fca
add tsserverWeb to patch in dynamic import
rbuckton May 4, 2022
f40a867
Remove eval
mjbvz May 10, 2022
186cec9
Ensure dynamically imported plugins are loaded in the correct order
rbuckton May 25, 2022
39dac60
Add tests for async service plugin timing
rbuckton May 25, 2022
78e016c
Update src/server/editorServices.ts
rbuckton Jun 3, 2022
c760041
Partial PR feedback
rbuckton Jun 4, 2022
9bc39d1
Rename tsserverWeb to dynamicImportCompat
rbuckton Jun 4, 2022
186f97e
Additional PR feedback
rbuckton Jun 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions src/server/project.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1577,7 +1577,7 @@ namespace ts.server {
}
}

protected enablePlugin(pluginConfigEntry: PluginImport, searchPaths: string[], pluginConfigOverrides: Map<any> | undefined) {
protected async enablePlugin(pluginConfigEntry: PluginImport, searchPaths: string[], pluginConfigOverrides: Map<any> | undefined) {
Comment thread
rbuckton marked this conversation as resolved.
Outdated
this.projectService.logger.info(`Enabling plugin ${pluginConfigEntry.name} from candidate paths: ${searchPaths.join(",")}`);
if (!pluginConfigEntry.name || parsePackageName(pluginConfigEntry.name).rest) {
this.projectService.logger.info(`Skipped loading plugin ${pluginConfigEntry.name || JSON.stringify(pluginConfigEntry)} because only package name is allowed plugin name`);
Expand All @@ -1589,8 +1589,27 @@ namespace ts.server {
const logError = (message: string) => {
(errorLogs || (errorLogs = [])).push(message);
};
const resolvedModule = firstDefined(searchPaths, searchPath =>

let resolvedModule: any | undefined;
if (this.projectService.host.importServicePlugin) {
for (const searchPath of searchPaths) {
try {
resolvedModule = await this.projectService.host.importServicePlugin(searchPath, pluginConfigEntry.name);
}
catch (e) {
// TODO: log this?
Comment thread
mjbvz marked this conversation as resolved.
Outdated
continue;
}
if (resolvedModule) {
break;
}
}
}
else {
resolvedModule = firstDefined(searchPaths, searchPath =>
Project.resolveModule(pluginConfigEntry.name, searchPath, this.projectService.host, log, logError) as PluginModuleFactory | undefined);
}

if (resolvedModule) {
const configurationOverride = pluginConfigOverrides && pluginConfigOverrides.get(pluginConfigEntry.name);
if (configurationOverride) {
Expand Down
1 change: 0 additions & 1 deletion src/server/session.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -646,7 +646,6 @@ namespace ts.server {
CommandNames.OrganizeImportsFull,
CommandNames.GetEditsForFileRename,
CommandNames.GetEditsForFileRenameFull,
CommandNames.ConfigurePlugin,
CommandNames.PrepareCallHierarchy,
CommandNames.ProvideCallHierarchyIncomingCalls,
CommandNames.ProvideCallHierarchyOutgoingCalls,
Expand Down
1 change: 1 addition & 0 deletions src/server/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,6 @@ declare namespace ts.server {
gc?(): void;
trace?(s: string): void;
require?(initialPath: string, moduleName: string): RequireResult;
importServicePlugin?(root: string, moduleName: string): Promise<any>;
Comment thread
mjbvz marked this conversation as resolved.
Outdated
}
}
18 changes: 18 additions & 0 deletions src/webServer/webServer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
/*@internal*/
/// <reference lib="dom" />

namespace ts.server {
export interface HostWithWriteMessage {
writeMessage(s: any): void;
Expand Down Expand Up @@ -137,6 +139,22 @@ namespace ts.server {
/* eslint-enable no-restricted-globals */

require: () => ({ module: undefined, error: new Error("Not implemented") }),
importServicePlugin: async (root: string, moduleName: string) => {
Comment thread
rbuckton marked this conversation as resolved.
Outdated
const packageRoot = combinePaths(root, "node_modules", moduleName);

const packageJsonResponse = await fetch(combinePaths(packageRoot, "package.json"));
const packageJson = await packageJsonResponse.json();
const browser = packageJson.browser;
Comment thread
rbuckton marked this conversation as resolved.
if (!browser) {
throw new Error("Could not load plugin. No 'browser' field found in package.json.");
}

const scriptPath = combinePaths(packageRoot, browser);

// TODO: TS rewrites `import(...)` to `require`. Use eval to bypass this
// eslint-disable-next-line no-eval
return (await eval(`import(${JSON.stringify(scriptPath)})`)).default;
Comment thread
rbuckton marked this conversation as resolved.
Outdated
},
exit: notImplemented,

// Debugging related
Expand Down