Move tsserverlibrary.js to typescript.js, make tsserverlibrary.js a shim #55273

jakebailey · 2023-08-04T21:36:18Z

The thinking here is:

External users (ts-eslint, others) are wanting to use ProjectService without the problems of importing typescript twice.
Moving ProjectService into typescript.js is effectively moving the entire server namespace into typescript.js.
At that point, why even have tsserverlibrary.js?

Before this change, the two bundles loaded in roughly:

typescript.js - 206.30ms (± 0.30%)
tsserverlibrary.js - 223.68ms (± 0.21%)

So, this only adds about 20ms of extra time to importers. But, it does increase the size of typescript.js by 7%: https://github.com/microsoft/TypeScript/actions/runs/5814577872#summary-15764542922

In the process of this, we also noticed that we can in the future:

Just make tsserver a thin wrapper around typescript.js. The two bundles contain exactly the same code except that tsserver adds a node host, which we probably want to export. That'd save even more space at no perf cost.
- We could make tsc a wrapper around typescript.js too, technically, although that'd probably end up being slower and is probably not worth it.
- But IMO these would probably be better off being improved via Use ESM for our executables (tsc, tsserver, typingsInstaller) #51440.
Maybe other optimizations?

cc @JoshuaKGoldberg @bradzacher

For #27891

typescript-bot · 2023-08-04T21:36:32Z

Looks like you're introducing a change to the public API surface area. If this includes breaking changes, please document them on our wiki's API Breaking Changes page.

Also, please make sure @DanielRosenwasser and @RyanCavanaugh are aware of the changes, just as a heads up.

jakebailey · 2023-08-04T21:38:00Z

src/testRunner/unittests/publicApi.ts

@@ -19,21 +18,6 @@ describe("unittests:: Public APIs", () => {
        it("should be acknowledged when they change", () => {
            Harness.Baseline.runBaseline(api, fileContent, { PrintDiff: true });
        });
-
-        it("should compile", () => {


We actually already test this by nature of the new public API compiler tests I added, which disable skipLibCheck to test the actual public API. This change could be pulled out into another PR but it's needed for this PR because this test assumes that our d.ts files are self-contained, which is no longer true.

Alternatively, I can just make tsserverlibrary.d.ts a copy of typescript.d.ts and it'd be fine.

is is possible to create symlinks for tsserverlibrary.js and tsserverLibrary,d,ts to point to typescript.js and typescript.d.ts instead

Right now tsserverlibrary just reexports typescript, it's just that it's not self contained so this one particular test breaks (but isn't needed anyway).

In terms of the package itself, we can't really use symlinks as those are not universally supported on Windows or by package managers themselves. There are ways that people store packages which can't contain symlinks at all (e.g., zips, used in yarn, for example), and it'd be a bit dicey to commit back to a release branch.

jakebailey · 2023-08-09T22:12:33Z

Herebyfile.mjs

+else if (typeof importScripts !== "undefined") {
+    importScripts("./typescript.js");
+}


I'm not totally sure if this is a good idea in general; I'm guessing it's possible for this line to make it into someone else's bundle which will start importing things if it happens to be a worker... but maybe not if they're correctly emulating CJS?

I'm half wondering if it'd be better to just not do this line at all and leave it as a module reexport, and just wait for feedback that says we need to do better.

But, I somewhat expect that nobody is actually loading this bundle into a browser at all.

sheetalkamat · 2023-08-11T16:52:20Z

src/typescript/tsconfig.json

@@ -6,7 +6,7 @@
        { "path": "../compiler" },
        { "path": "../jsTyping" },
        { "path": "../services" },
-        { "path": "../deprecatedCompat" }


Is this intentional to drop drepcated compat from typescript.js ?

It's already in the server tsconfig / project, since it's needed for both tsserver and tsserverlibrary; to make this PR I actually just deleted all of the contents of typescript and moved tsserverlibrary here, but git unfortunately can't show that!

it should still be here since references are not transitive.

They aren't? But, tsserverlibrary's been set up this way since I merged modules and has been fine; what breaks if this isn't done? If it's about the code itself, it's imported in the server namespace so gets pulled in there.

Removing built and doing npx tsc -b ./src/typescript, I see:

Then hereby services gives me a file with:

So, it seems like it all works?

Build as in typecheck or as in write out files? I guess dts emit may matter for this...

I'm surprised in that I think a lot of monorepo projects aren't just bulk including all transitive dependencies in their tsconfigs as that would get unweildy.

#46153 and #30608

Aha! Thanks!

I'll go figure out which transitive things we're missing.

I pulled this out into #55339, which I'd like to merge first.

Given this isn't a regression (all I did was move tsserverlibrary and rename it), this shouldn't block merging of this PR, right? So the above isn't exactly a prereq?

jakebailey · 2023-08-11T23:48:32Z

@typescript-bot pack this

typescript-bot · 2023-08-11T23:48:34Z

Heya @jakebailey, I've started to run the tarball bundle task on this PR at d3fc401. You can monitor the build here.

typescript-bot · 2023-08-11T23:50:10Z

Hey @jakebailey, I've packed this into an installable tgz. You can install it for testing by referencing it in your package.json like so:

{
    "devDependencies": {
        "typescript": "https://typescript.visualstudio.com/cf7ac146-d525-443c-b23c-0d58337efebc/_apis/build/builds/156459/artifacts?artifactName=tgz&fileId=707B8223C42B7FCA29546B6C83C65AF7F6909290F460D73BD53B6CE1D4E81E8202&fileName=/typescript-5.3.0-insiders.20230811.tgz"
    }
}

and then running npm install.

There is also a playground for this build and an npm module you can use via "typescript": "npm:@typescript-deploys/pr-build@5.3.0-pr-55273-3".;

jakebailey · 2023-08-11T23:50:47Z

Herebyfile.mjs

+`;
+
+const lsslDtsInternal = `
+import ts = require("./typescript.internal.js");


This is a little unfortunate for anyone who is attempting to pull these internal types, e.g. byots/ts-expose-internals but the fix would be quite simple for them; just use typescript.internal.d.ts for both.

jakebailey · 2023-08-11T23:51:58Z

@JoshuaKGoldberg you may beat me too this, but I think we should try including the above package in ts-eslint and see if it compiles, to make sure my new d.ts works.

That and I need to also test vscode, which similarly imports this but also augments it IIRC. (I'll do that Monday)

jakebailey · 2023-08-12T00:30:37Z

Actually, took me like 2 minutes to test in vscode, and it worked even with their augmentation, so it probably is fine everywhere else.

jakebailey · 2023-08-14T18:42:26Z

Herebyfile.mjs

@@ -563,7 +586,7 @@ export const watchLocal = task({
    name: "watch-local",
    description: "Watches the full compiler and services",
    hiddenFromTaskList: true,
-    dependencies: [localize, watchTsc, watchTsserver, watchServices, watchLssl, watchOtherOutputs, dts, watchSrc],
+    dependencies: [localize, watchTsc, watchTsserver, watchServices, lssl, watchOtherOutputs, dts, watchSrc],


Last minute change; we still have to run lssl here at least once in watch mode, so we do it just like dts here.

jakebailey · 2023-08-14T22:46:14Z

Meant to ping @mjbvz too; I don't think that this will affect VS Code at all; I think both of these files are preserved in your pruned package and this probably makes the whole editor lighter!

jakebailey added 3 commits August 4, 2023 14:07

Move tsserverlibrary.js to typescript.js

f344f9b

Make tsserverlibrary a wrapper around typescript

ae24827

Remove redundant unit test covered by compiler case

b40497c

typescript-bot assigned jakebailey Aug 4, 2023

typescript-bot added Author: Team For Uncommitted Bug PR for untriaged, rejected, closed or missing bug labels Aug 4, 2023

jakebailey commented Aug 4, 2023

View reviewed changes

jakebailey changed the title ~~Move contents of tsserverlibrary.js to typescript.js, make tsserverlibrary.js a shim~~ Move tsserverlibrary.js to typescript.js, make tsserverlibrary.js a shim Aug 4, 2023

Merge branch 'main' into bye-bye-tsserverlibrary

7d0cd83

jakebailey commented Aug 9, 2023

View reviewed changes

jakebailey marked this pull request as ready for review August 9, 2023 22:13

DanielRosenwasser mentioned this pull request Aug 9, 2023

Design Meeting Notes, 8/9/2023 #55325

Closed

jakebailey mentioned this pull request Aug 9, 2023

Make tsserver and typingsInstaller thin wrappers around public API #55326

Merged

Update shim to be less fancy

d3fc401

jakebailey requested review from weswigham, andrewbranch and sheetalkamat August 10, 2023 20:26

jakebailey added the Breaking Change Would introduce errors in existing code label Aug 10, 2023

sheetalkamat approved these changes Aug 11, 2023

View reviewed changes

sheetalkamat reviewed Aug 11, 2023

View reviewed changes

jakebailey mentioned this pull request Aug 11, 2023

Ensure our project references include transitive references #55339

Closed

jakebailey commented Aug 11, 2023

View reviewed changes

jakebailey added the API Relates to the public API for TypeScript label Aug 12, 2023

jakebailey mentioned this pull request Aug 14, 2023

Reduce typescript package size #27891

Closed

4 tasks

weswigham approved these changes Aug 14, 2023

View reviewed changes

jakebailey added 3 commits August 14, 2023 11:40

Merge branch 'main' into bye-bye-tsserverlibrary

1f6d337

Re-add lssl to watch-local, which will run once

e9c8a61

Fix diff

0027c61

jakebailey commented Aug 14, 2023

View reviewed changes

jakebailey merged commit 3c6c557 into microsoft:main Aug 14, 2023
18 checks passed

jakebailey deleted the bye-bye-tsserverlibrary branch August 14, 2023 19:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move tsserverlibrary.js to typescript.js, make tsserverlibrary.js a shim #55273

Move tsserverlibrary.js to typescript.js, make tsserverlibrary.js a shim #55273

jakebailey commented Aug 4, 2023 •

edited

typescript-bot commented Aug 4, 2023

jakebailey Aug 4, 2023

sheetalkamat Aug 9, 2023

jakebailey Aug 9, 2023 •

edited

jakebailey Aug 9, 2023

jakebailey Aug 9, 2023

sheetalkamat Aug 11, 2023

jakebailey Aug 11, 2023

sheetalkamat Aug 11, 2023

jakebailey Aug 11, 2023

jakebailey Aug 11, 2023

jakebailey Aug 11, 2023

sheetalkamat Aug 11, 2023

jakebailey Aug 11, 2023

jakebailey Aug 11, 2023

jakebailey Aug 11, 2023

jakebailey commented Aug 11, 2023

typescript-bot commented Aug 11, 2023 •

edited

typescript-bot commented Aug 11, 2023 •

edited

jakebailey Aug 11, 2023

jakebailey commented Aug 11, 2023

jakebailey commented Aug 12, 2023

jakebailey Aug 14, 2023

jakebailey commented Aug 14, 2023 •

edited

Move tsserverlibrary.js to typescript.js, make tsserverlibrary.js a shim #55273

Move tsserverlibrary.js to typescript.js, make tsserverlibrary.js a shim #55273

Conversation

jakebailey commented Aug 4, 2023 • edited

typescript-bot commented Aug 4, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jakebailey Aug 9, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jakebailey commented Aug 11, 2023

typescript-bot commented Aug 11, 2023 • edited

typescript-bot commented Aug 11, 2023 • edited

Choose a reason for hiding this comment

jakebailey commented Aug 11, 2023

jakebailey commented Aug 12, 2023

Choose a reason for hiding this comment

jakebailey commented Aug 14, 2023 • edited

jakebailey commented Aug 4, 2023 •

edited

jakebailey Aug 9, 2023 •

edited

typescript-bot commented Aug 11, 2023 •

edited

typescript-bot commented Aug 11, 2023 •

edited

jakebailey commented Aug 14, 2023 •

edited