Effekt Version Manager: automatic installer and updater #20

jiribenes · 2024-08-09T13:30:30Z

This is a somewhat rough draft of an automatic installer & updater for Effekt (addresses effekt-lang/effekt#289)
I cannot test this locally, my local setup is quite weird and I can't really use npm for Effekt distribution.

This PR will require extensive testing on various platforms.

Features

new status bar shows the state of the LSP server, current Effekt version and the selected backend (useful for debugging)
- clicking on the status bar checks for Effekt updates (in npm)
updated dependencies to allow newer VSCode features
on startup, check if we can find the effekt binary:
- if not and if it's a custom executable by the user, report a specific error
- if not, offer the user to install the newest version of Effekt from npm
- if we have effekt, take a look at its version: if it's older than the latest version on npm, offer updating to a newer version of Effekt via npm
if the user wants to install/update and they don't have nodejs or npm, report a specific error
if effekt isn't found after installation, check the places npm installs into if the binary is there and if it works (in order to debug PATH issues)
also add a specific command to explicitly install/update (again useful for debugging installations)
the Effekt Version Manager has its own output log, separate from the server (offered to the user when something errors)

Problems

~~mostly untested!~~ EDIT: Tested somewhat extensively now, see below.
~~requires Add --version CLI flag effekt#540~~ EDIT: merged, tested
~~should also be tested with rolling release (Move to a weekly release scheme effekt#538)~~ EDIT: merged, tested
the Effekt npm package(s) are really out of date (!) -- we can of course also check via GitHub API and take the tgz from the release directly (https://api.github.com/repos/effekt-lang/effekt/releases), but that's a bit cumbersome and complicates the installation EDIT: fixed via Move to a weekly release scheme effekt#538

Screenshots

Status bar

Installation pop-ups

src/effektManager.ts

jiribenes · 2024-08-26T12:35:08Z

src/effektManager.ts

+    /**
+     * Locates the Effekt executable.
+     */
+    public async getEffektExecutable(): Promise<EffektExecutableInfo> {
+        const customPath = this.config.get<string>("executable");
+        if (customPath) {
+            try {
+                const version = await this.execCommand(`"${customPath}" --version`);
+                return { path: customPath, version };
+            } catch (error) {
+                this.showErrorWithLogs(`Custom Effekt executable not working: ${customPath}. ${error}`);
+            }
+        }
+
+        for (const name of this.possibleEffektExecutables) {
+            try {
+                const version = await this.execCommand(`${name} --version`);
+                return { path: name, version };
+            } catch {
+                // Try next option
+            }
+        }
+
+        throw new Error('Effekt executable not found');
+    }


Technically in case --version fails, we also might want to try --help as that ought to work universally across all Effekt versions, whereas --version is only being added as of writing this comment (effekt-lang/effekt#556).

src/semver.d.ts

b-studios

This looks beautiful! The implementation is exemplary!

One thing that I noticed is that we check for node, but not the JVM. Maybe checking and reporting: "Hey, maybe you want to install a JVM > X" would help some users?

b-studios · 2024-09-10T18:52:11Z

.vscode/launch.json

-    ]
-}
+	"configurations": [
+		{


Why does everybody suddenly start to use tabs?

I actually took these files from the VSCode template extension, just to update the structure :)

b-studios · 2024-09-10T18:56:38Z

src/effektManager.ts

+        }
+    }
+
+    private handleInstallationResult(result: InstallationResult, action: 'install' | 'update'): void {


It is funny how stringly typed things become ok with singleton types and unions...

jiribenes · 2024-09-10T19:28:22Z

This looks beautiful! The implementation is exemplary!

Thanks! I'll forward the praise to Claude 3.5 Sonnet ;)

One thing that I noticed is that we check for node, but not the JVM. Maybe checking and reporting: "Hey, maybe you want to install a JVM > X" would help some users?

I used to have the check there, it should be easy to re-add. :)
Note that these checks only run when the user chooses to update.

jiribenes · 2024-09-11T08:38:32Z

Rebased on current master so that I can have this version together with the cool syntax highlighting :)

jiribenes · 2024-09-11T10:32:02Z

Rebased on current master yet again.

jiribenes · 2024-09-11T10:33:50Z

package.json

    "scripts": {
        "vscode:prepublish": "npm run compile",
-        "compile": "tsc -p ./",
-        "watch": "tsc -watch -p ./",
-        "postinstall": "node ./node_modules/vscode/bin/install",
-        "test": "npm run compile && node ./node_modules/vscode/bin/test"
+        "compile": "tsc -b",
+        "watch": "tsc -b -w",
+        "lint": "eslint ./client/src ./server/src --ext .ts,.tsx"
    },
    "dependencies": {
+        "compare-versions": "^6.1.1",
        "vscode-languageclient": "^5.2.1"
    },
    "devDependencies": {
-        "typescript": "^2.6.1",
-        "vscode": "^1.1.37",
-        "tslint": "^5.8.0",
-        "@types/node": "^7.0.43",
-        "@types/mocha": "^2.2.42"
+        "@types/mocha": "^10.0.6",
+        "@types/node": "^18.14.6",
+        "@types/vscode": "^1.30.0",
+        "@typescript-eslint/eslint-plugin": "^7.1.0",
+        "@typescript-eslint/parser": "^7.1.0",
+        "eslint": "^8.57.0",
+        "mocha": "^10.3.0",
+        "typescript": "^5.3.3"
    }


Just to be clear, the changes here and in .vscode are taken directly from the official VSCode extension template https://github.com/microsoft/vscode-extension-samples (from the LSP sample)

jiribenes · 2024-09-11T12:39:50Z

I added some code to detect the JRE version, not sure it works too well (can't test it properly right now).
The only caveat is that this check only runs when we try to install/update Effekt.

src/effektManager.ts

jiribenes · 2024-09-17T12:18:28Z

src/effektManager.ts

+    private async runNpmInstall(): Promise<void> {
+        // 1) Check if the npm root is managed by Nix in order to produce a better error
+        const npmRoot = await this.execCommand('npm root -g');
+        if (npmRoot.startsWith("/nix/store")) {
+            this.logMessage('ERROR', 'NPM root is in the read-only Nix store. Installation is not possible.')
+            throw new Error('Detected Nix environment: NPM global modules are stored in a read-only directory managed by Nix. Installation cannot proceed.');
+        }
+
+        // 2) Actually run `npm install -g ...`
+        const npmInstallCommand = `npm install -g ${this.effektNPMPackage}@latest`;
+        const npmOutput = await this.execCommand(npmInstallCommand);
+
+        this.logMessage('INFO', `Ran '${npmInstallCommand}'; stdout: ${npmOutput}`);
+    }


I added Nix detection here just to have a nicer error message for myself :)
No idea if it's actually useful for anybody else than me (and I also have no idea whether this is correct)

jiribenes · 2024-09-17T20:03:19Z

Current state of testing: seems to work for all Linux (N ≥ 4) and MacOS (N = 2) testers so far.
One reported permissions issues on Linux when calling npm install -g.
Two people tried on Windows without WSL: installation goes well, but then the server crashes, see #25. With WSL, everything seems to work perfectly fine for one of them, but not the other. => Further testing on Windows is required.

From feedback: It would be nice to display the full path to the Effekt executable in the status bar on hover (~~we have the info anyways!~~ EDIT: No, we don't, we use PATH...)

src/effektManager.ts

jiribenes mentioned this pull request Aug 9, 2024

Add --version CLI flag effekt-lang/effekt#540

Closed

jiribenes commented Aug 10, 2024

View reviewed changes

src/effektManager.ts Outdated Show resolved Hide resolved

jiribenes changed the title ~~Automatic installer & updater~~ Effekt Version Manager: automatic installer and updater Aug 10, 2024

jiribenes mentioned this pull request Aug 26, 2024

Add --version CLI flag effekt-lang/effekt#556

Merged

jiribenes commented Aug 26, 2024

View reviewed changes

src/semver.d.ts Outdated Show resolved Hide resolved

jiribenes mentioned this pull request Aug 27, 2024

Move to a weekly release scheme effekt-lang/effekt#538

Merged

3 tasks

b-studios reviewed Sep 10, 2024

View reviewed changes

jiribenes force-pushed the jiribenes/installer branch 3 times, most recently from a390c14 to 236de6f Compare September 11, 2024 08:37

jiribenes force-pushed the jiribenes/installer branch from 236de6f to af3a587 Compare September 11, 2024 09:15

jiribenes added 16 commits September 11, 2024 12:16

[WIP] Automatic installer

b5d95c1

Refactor updater&installer into separate file

5cfd08b

Attempt to backport changes

170cd03

Nicer error logging

3c78bb9

Refactor, add doc comments

2fbf610

Re-add node&npm version check

961b251

Try to fix CI by bumping node

ffc5696

Add 'restartServer' command, refactor cmds

a121fb1

Refactor, rename

6f43974

Rudimentary error handling in commands

0c7ebe4

Effekt versions should be compared loosely

8253e4a

Click on status bar item to check for updates

cbc37e8

Add more sofisticated tooltip with current version

440a6da

[WIP] Add installation verification

898b460

Fix type mismatch when checking effekt version

1390d5e

Migrate to 'compare-versions' instead of 'node-semver'

39d41c3

Don't compare missing version

79e0e0b

jiribenes force-pushed the jiribenes/installer branch from af3a587 to 79e0e0b Compare September 11, 2024 10:16

jiribenes commented Sep 11, 2024

View reviewed changes

jiribenes mentioned this pull request Sep 11, 2024

Add GIFs into the README #24

Open

Add Java (JRE) detection

8d11e78

Detect older versions of Effekt via a hack

58a759d

jiribenes commented Sep 11, 2024

View reviewed changes

src/effektManager.ts Show resolved Hide resolved

jiribenes added 5 commits September 17, 2024 10:51

Fix Java version detection

ceb9c1b

Remove misleading message about PATH.

7f227b3

Force 'execCommand' to use utf8 and to have max 1MB buffer

7a3a837

Refactor ci.yml

297b738

Auto-format

25fac57

This comment was marked as resolved.

Sign in to view

jiribenes added 2 commits September 17, 2024 13:49

Fix spurious 'Effekt is not installed' message when refusing to update

8a32b5d

Experimental Nix-managed NPM detection for better errors

b3d30d0

jiribenes commented Sep 17, 2024

View reviewed changes

jiribenes mentioned this pull request Sep 17, 2024

Investigate LSP support on Windows #25

Closed

jiribenes marked this pull request as ready for review September 18, 2024 13:33

jiribenes commented Sep 23, 2024

View reviewed changes

src/effektManager.ts Outdated Show resolved Hide resolved

Update minimum NodeJS version

b7551fb

jiribenes mentioned this pull request Sep 25, 2024

Install Effekt from VSCode effekt-lang/effekt#289

Closed

Fix LSP on Windows (#25)

71ae96e

jiribenes linked an issue Sep 29, 2024 that may be closed by this pull request

Investigate LSP support on Windows #25

Closed

On Windows, try 'effekt.cmd' first

36d28ee

jiribenes requested a review from b-studios September 29, 2024 12:50

b-studios merged commit b24a821 into master Oct 1, 2024
1 check passed

b-studios deleted the jiribenes/installer branch October 1, 2024 14:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Effekt Version Manager: automatic installer and updater #20

Effekt Version Manager: automatic installer and updater #20

jiribenes commented Aug 9, 2024 •

edited

Loading

jiribenes Aug 26, 2024 •

edited

Loading

b-studios left a comment

b-studios Sep 10, 2024

jiribenes Sep 10, 2024

b-studios Sep 10, 2024

jiribenes commented Sep 10, 2024

jiribenes commented Sep 11, 2024

jiribenes commented Sep 11, 2024

jiribenes Sep 11, 2024

jiribenes commented Sep 11, 2024

This comment was marked as resolved.

jiribenes Sep 17, 2024

jiribenes commented Sep 17, 2024 •

edited

Loading

Effekt Version Manager: automatic installer and updater #20

Effekt Version Manager: automatic installer and updater #20

Conversation

jiribenes commented Aug 9, 2024 • edited Loading

Features

Problems

Screenshots

Status bar

Installation pop-ups

jiribenes Aug 26, 2024 • edited Loading

Choose a reason for hiding this comment

b-studios left a comment

Choose a reason for hiding this comment

b-studios Sep 10, 2024

Choose a reason for hiding this comment

jiribenes Sep 10, 2024

Choose a reason for hiding this comment

b-studios Sep 10, 2024

Choose a reason for hiding this comment

jiribenes commented Sep 10, 2024

jiribenes commented Sep 11, 2024

jiribenes commented Sep 11, 2024

jiribenes Sep 11, 2024

Choose a reason for hiding this comment

jiribenes commented Sep 11, 2024

This comment was marked as resolved.

jiribenes Sep 17, 2024

Choose a reason for hiding this comment

jiribenes commented Sep 17, 2024 • edited Loading

jiribenes commented Aug 9, 2024 •

edited

Loading

jiribenes Aug 26, 2024 •

edited

Loading

jiribenes commented Sep 17, 2024 •

edited

Loading