feat: add option for disabling file downloads

[jsjoeio]

This PR adds a new CLI flag called --disable-file-downloads which removes the "Download..." option from the File Actions (right-clicking on file).

Screenshot

As you can see, there is no "Download..." option here:

e2e test ensuring the behavior works as well.

e2e test ensuring default behavior (downloads enabled) works:

Fixes#2426

Notes

Click to expand

What is the current behavior?

Currently, the default behavior is to allow any file to be downloaded (note: not folders). To do this,

1. Right-click any file in code-server
2. Select "Download"

What is the desired behavior?

A way to disable this behavior.

The best solution we've come up with is a CLI option such as --disable-file-downloads which would be a boolean flag meaning the default is false, but when you pass it, it is true. You could also explicitly say --disable-file-downloads=true. And because of the way code-server is designed, you'll also be able to set it in your config.yaml like disable-file-downloads: true.

How do we implement this?

There are two pieces of logic to implement:

1. code-server needs to support a flag called --disable-file-downloads
2. Code needs to show/hide "Download" based on flag boolean. Default should match current behavior aka true

For 1, we can take a TDD approach and write a test to ensure that:

• code-server supports a --disable-file-downloads flag
• code-server defaults to --disable-file-downlaods=true

For 2, we can take TDD but it's a little bit more work:

• write e2e test that checks for "Download" in menu
• write failing e2e test that checks for "Download" is not in the menu
• add logic to remove it from menu based on CLI flags
  • create new context key
  • use in fileActions.contributions.ts
  • test to make sure it works.
  • add disable-file-downloads as arg to serverEnvironmentService
  • add logic based on CLI flag

To do this, I need to create a new context key like this then add it here

Running e2e tests: VSCODE_DEV=1 LOG_LEVEL=debug yarn test:e2e --grep "disabled" --quiet --retries 0 --debug

Seeing these type errors:

[VSCode][watch-client][16:58:27]Error: /Users/jp/dev/coder/code-server/lib/vscode/src/vs/workbench/services/workingCopy/test/electron-browser/workingCopyBackupService.test.ts(60,9): Argumentoftype'TestWorkbenchEnvironmentService'isnotassignabletoparameteroftype'INativeWorkbenchEnvironmentService'.[VSCode][watch-client]Property'isEnabledFileDownloads'ismissingintype'TestWorkbenchEnvironmentService'butrequiredintype'INativeWorkbenchEnvironmentService'.[VSCode][watch-client][16:58:27]Error: /Users/jp/dev/coder/code-server/lib/vscode/src/vs/workbench/services/environment/electron-sandbox/environmentService.ts(54,14): Class'NativeWorkbenchEnvironmentService'incorrectlyimplementsinterface'INativeWorkbenchEnvironmentService'.[VSCode][watch-client]Property'isEnabledFileDownloads'ismissingintype'NativeWorkbenchEnvironmentService'butrequiredintype'INativeWorkbenchEnvironmentService'.[VSCode][watch-client][16:58:27]Error: /Users/jp/dev/coder/code-server/lib/vscode/src/vs/workbench/electron-sandbox/desktop.main.ts(169,61): Argumentoftype'NativeWorkbenchEnvironmentService'isnotassignabletoparameteroftype'INativeWorkbenchEnvironmentService | SyncDescriptor<INativeWorkbenchEnvironmentService>'.[VSCode][watch-client]Property'isEnabledFileDownloads'ismissingintype'NativeWorkbenchEnvironmentService'butrequiredintype'INativeWorkbenchEnvironmentService'.[VSCode][watch-client][16:58:27]Error: /Users/jp/dev/coder/code-server/lib/vscode/src/vs/workbench/electron-sandbox/desktop.main.ts(177,167): Argumentoftype'NativeWorkbenchEnvironmentService'isnotassignabletoparameteroftype'INativeWorkbenchEnvironmentService'.[VSCode][watch-client][16:58:27]Error: /Users/jp/dev/coder/code-server/lib/vscode/src/vs/workbench/electron-sandbox/desktop.main.ts(217,68): Argumentoftype'NativeWorkbenchEnvironmentService'isnotassignabletoparameteroftype'IWorkbenchEnvironmentService'.[VSCode][watch-client]Property'isEnabledFileDownloads'ismissingintype'NativeWorkbenchEnvironmentService'butrequiredintype'IWorkbenchEnvironmentService'.[VSCode][watch-client][16:58:27]Error: /Users/jp/dev/coder/code-server/lib/vscode/src/vs/workbench/electron-sandbox/desktop.main.ts(252,62): Argumentoftype'NativeWorkbenchEnvironmentService'isnotassignabletoparameteroftype'INativeWorkbenchEnvironmentService'.[VSCode][watch-client][16:58:27]Error: /Users/jp/dev/coder/code-server/lib/vscode/src/vs/workbench/electron-sandbox/desktop.main.ts(255,41): Argumentoftype'NativeWorkbenchEnvironmentService'isnotassignabletoparameteroftype'INativeWorkbenchEnvironmentService'.[VSCode][watch-client][16:58:27]Error: /Users/jp/dev/coder/code-server/lib/vscode/src/vs/workbench/electron-sandbox/desktop.main.ts(266,39): Argumentoftype'NativeWorkbenchEnvironmentService'isnotassignabletoparameteroftype'INativeWorkbenchEnvironmentService'.[VSCode][watch-client][16:58:27]Error: /Users/jp/dev/coder/code-server/lib/vscode/src/vs/workbench/electron-sandbox/desktop.main.ts(284,101): Argumentoftype'NativeWorkbenchEnvironmentService'isnotassignabletoparameteroftype'IWorkbenchEnvironmentService'.[VSCode][watch-client][16:58:27]Error: /Users/jp/dev/coder/code-server/lib/vscode/src/vs/workbench/electron-sandbox/desktop.main.ts(287,169): Argumentoftype'NativeWorkbenchEnvironmentService'isnotassignabletoparameteroftype'IWorkbenchEnvironmentService'.

Now it's not working 🤔

[github-actions]

✨ code-server docs for PR #5055 is ready! It will be updated on every commit.

• Host: https://coder.com/docs/code-server/f9498bc
• Last deploy status: success
• Commit: 5ba6882
• Workflow status: https://github.com/coder/code-server/actions/runs/2158153480

[codecov]

Codecov Report

Merging #5055 (5ba6882) into main (3bf470f) will increase coverage by 0.03%.
The diff coverage is 100.00%.

@@ Coverage Diff @@## main #5055 +/- ##
==========================================
+ Coverage 71.30% 71.33% +0.03% 
==========================================
Files 30 30 Lines 1683 1685 +2 Branches 373 374 +1 ==========================================
+ Hits 1200 1202 +2 
Misses 413 413 Partials 70 70 

Impacted Files	Coverage Δ
src/node/cli.ts	91.66% <100.00%> (+0.06%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c05b727...5ba6882. Read the comment docs.

[github-actions]

✨ code-server dev build published to npm for PR #5055!

• Last publish status: success
• Commit: 5ba6882

To install in a local project, run:

npm install @coder/code-server-pr@5055

To install globally, run:

npm install -g @coder/code-server-pr@5055

[code-asher]

Looks great!

I am not sure if we should try this now or if this is good enough but we might want to disable the download command itself because it is possible to bind the download command to a keybinding and then just use that to download files.

Changes made, need a new approval