code-server 3.9.2

[jsjoeio]

Created with brew bump-formula-pr.

[carlocab]

==> yarn --production --frozen-lockfile
yarn install v1.22.10
info No lockfile found.
[1/5] Validating package.json...
error [email protected]: The engine "node" is incompatible with this module. Expected version ">= 12 <= 14". Got "15.12.0"
error Found incompatible module.

[jsjoeio]

The engine "node" is incompatible with this module. Expected version ">= 12 <= 14". Got "15.12.0"

CI tests are using Node v15 but we only support 12-14. This seems like an expected failure, no?

We introduced a tighter restriction around Node requirements in 3.9.2 because when you're developing/contributing, there are issues with Node v15. This is based on us having to align with the requirements of VS Code.

AH - my teammate found this in your docs:

Node modules which are compatible with the latest Node version should declare a dependency on the node formula.

depends_on "node"

If your formula requires being executed with an older Node version you should use one of the versioned node formulae (e.g. node@12).

I wonder if it would be possible to echo that in CI and link to the docs - it would definitely be helpful for folks newer to the homebrew ecosystem!

[jsjoeio]

==> /opt/homebrew/Cellar/code-server/3.9.2/bin/code-server --extensions-dir=. --install-extension ms-python.python
env: node: No such file or directory

Hmm...investigating

[carlocab]

I wonder if it would be possible to echo that in CI and link to the docs

Not sure how CI would know when to link the docs -- it just prints out build errors but doesn't parse them. However, maybe there's a solution here I'm just not thinking of. PRs to improve things appreciated.

[jsjoeio]

==> /opt/homebrew/Cellar/code-server/3.9.2/bin/code-server --extensions-dir=. --install-extension wesbos.theme-cobalt2
env: node: No such file or directory

Not sure why that's failing... going to check to make sure it's working for me locally (by installing from npm)

[carlocab]

Your issue might be that the versioned Node formulae are keg-only.

Is there an environment variable that code-server checks for the path to a Node executable? If so, we should wrap the binary in an env script that sets that for the user. Or an env script that prepends to the user's PATH appropriately, but I'm less fond of that option.

Edit: Oh, wait. The formula already does that. Except that it prepends the wrong path in the env script.

[jsjoeio]

Yeah I tested locally and it's working as expected so it's not the test.

Ahh, hmm... thinking.

[jsjoeio]

Except that it prepends the wrong path in the env script

What is the right path?

I'm having trouble finding this in the docs. This was passed on from a previous maintainer, and as you can see, we need to add more documentation for current maintainers.

[carlocab]

Try this:

diff --git a/Formula/code-server.rb b/Formula/code-server.rb
index 58b528c1654..fbc2313c6bf 100644
--- a/Formula/code-server.rb
+++ b/Formula/code-server.rb
@@ -24,9 +24,12 @@ class CodeServer < Formula
   end
 
   def install
+    node = Formula["node@14"]
+
     system "yarn", "--production", "--frozen-lockfile"
     libexec.install Dir["*"]
-    env = { PATH: "#{HOMEBREW_PREFIX}/opt/node/bin:$PATH" }
+
+    env = { PATH: "#{node.opt_bin}:$PATH" }
     (bin/"code-server").write_env_script "#{libexec}/out/node/entry.js", env
   end

You could've probably just done s/node/node@14 in the line that defines env, but I'm thinking this makes it a bit more obvious that something else needs to be changed if the Node dependency changes again in the future.

[jsjoeio]

Ah! Thank you! 🙏 As you can probably tell, I haven't written Ruby before.

We'll make sure to update the docs in code-server to explain this as well (should it need to be updated in the future).

[jsjoeio]

brew bot shamming me for editing in GitHub web instead of in my local editor

[Rylan12]

Looks good! Thanks, @jsjoeio!

[BrewTestBot]

🤖 A scheduled task has triggered a merge.