- Notifications
You must be signed in to change notification settings - Fork24
Add package scripts and cli library, enable integration testing#536
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
jaggederest wants to merge9 commits intomainChoose a base branch
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
+516 −46
Open
Changes fromall commits
Commits
Show all changes
9 commits Select commitHold shift + click to select a range
7e1bce9 pretest working
jaggederestc693a46 enable vscode-test and bump tsconfig to modern settings
jaggederest240b649 Merge branch 'main' into jaggederest/integration_tests
jaggederest0e58a31 test: fix integration tests to run without Remote SSH extension
jaggederest872b7e8 Merge remote-tracking branch 'origin/jaggederest/integration_tests' i…
jaggederest01c2d80 autocorrect formatting
jaggederest8ddbf26 bump node version to 22
jaggederest9b74df4 fix: configure Vitest to properly exclude VS Code integration tests
jaggederestadec211 whitespace
jaggederestFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
1 change: 1 addition & 0 deletions.eslintignore
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| vitest.config.ts |
4 changes: 2 additions & 2 deletions.github/workflows/ci.yaml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion.github/workflows/release.yaml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -18,7 +18,7 @@ jobs: | ||
| -uses:actions/setup-node@v4 | ||
| with: | ||
| node-version:"22" | ||
| -run:yarn | ||
12 changes: 12 additions & 0 deletions.vscode-test.mjs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| import{defineConfig}from"@vscode/test-cli"; | ||
| exportdefaultdefineConfig({ | ||
| files:"out/test/**/*.test.js", | ||
| extensionDevelopmentPath:".", | ||
| extensionTestsPath:"./out/test", | ||
| launchArgs:["--enable-proposed-api","coder.coder-remote"], | ||
| mocha:{ | ||
| ui:"tdd", | ||
| timeout:20000, | ||
| }, | ||
| }); |
2 changes: 1 addition & 1 deletion.vscodeignore
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -12,4 +12,4 @@ node_modules/** | ||
| **/.editorconfig | ||
| **/*.map | ||
| **/*.ts | ||
| *.gif | ||
12 changes: 8 additions & 4 deletionspackage.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
35 changes: 23 additions & 12 deletionssrc/extension.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -21,25 +21,36 @@ export async function activate(ctx: vscode.ExtensionContext): Promise<void> { | ||
| // | ||
| // Cursor and VSCode are covered by ms remote, and the only other is windsurf for now | ||
| // Means that vscodium is not supported by this for now | ||
| constisTestMode= | ||
| process.env.NODE_ENV==="test"|| | ||
| ctx.extensionMode===vscode.ExtensionMode.Test; | ||
| constremoteSSHExtension= | ||
| vscode.extensions.getExtension("jeanp413.open-remote-ssh")|| | ||
| vscode.extensions.getExtension("codeium.windsurf-remote-openssh")|| | ||
| vscode.extensions.getExtension("anysphere.remote-ssh")|| | ||
| vscode.extensions.getExtension("ms-vscode-remote.remote-ssh"); | ||
| letvscodeProposed:typeofvscode=vscode; | ||
| if(!remoteSSHExtension){ | ||
| if(!isTestMode){ | ||
| vscode.window.showErrorMessage( | ||
| "Remote SSH extension not found, cannot activate Coder extension", | ||
| ); | ||
| thrownewError("Remote SSH extension not found"); | ||
| } | ||
| // In test mode, use regular vscode API | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Nice! I wonder if we can avoid the special testing behavior. Maybe we should always try to activate, but if we are unable to get this special API we skip the remote registration (and possibly log a warning)? Similar to what you already have except we always do it, not just in testing. That would make it nicer for use cases where you have not installed the remote extension yet, for whatever reason, while reducing drift between production and testing. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Yeah I suspect this is the kind of behavior we want, so 👍 to logging a warning and handling it gracefully | ||
| }else{ | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
| vscodeProposed=(moduleasany)._load( | ||
| "vscode", | ||
| { | ||
| filename:remoteSSHExtension.extensionPath, | ||
| }, | ||
| false, | ||
| ); | ||
| } | ||
| constoutput=vscode.window.createOutputChannel("Coder"); | ||
| conststorage=newStorage( | ||
| @@ -278,7 +289,7 @@ export async function activate(ctx: vscode.ExtensionContext): Promise<void> { | ||
| // Since the "onResolveRemoteAuthority:ssh-remote" activation event exists | ||
| // in package.json we're able to perform actions before the authority is | ||
| // resolved by the remote SSH extension. | ||
| if(!isTestMode&&vscodeProposed.env.remoteAuthority){ | ||
| constremote=newRemote( | ||
| vscodeProposed, | ||
| storage, | ||
14 changes: 10 additions & 4 deletionssrc/remote.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -6,7 +6,9 @@ import * as fs from "fs/promises"; | ||
| import * as jsonc from "jsonc-parser"; | ||
| import * as os from "os"; | ||
| import * as path from "path"; | ||
| // Dynamic import for ESM module | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
| let prettyBytes: any; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I know you said this was temporary, just leaving a note here to acknowledge we need to update this and other references before merge. 😄 | ||
| import * as semver from "semver"; | ||
| import * as vscode from "vscode"; | ||
| import { | ||
| @@ -841,7 +843,7 @@ export class Remote { | ||
| `${sshPid}.json`, | ||
| ); | ||
| const updateStatus =async(network: { | ||
| p2p: boolean; | ||
| latency: number; | ||
| preferred_derp: string; | ||
| @@ -850,6 +852,10 @@ export class Remote { | ||
| download_bytes_sec: number; | ||
| using_coder_connect: boolean; | ||
| }) => { | ||
| // Load ESM module if not already loaded | ||
| if (!prettyBytes) { | ||
| prettyBytes = (await import("pretty-bytes")).default; | ||
jaggederest marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| } | ||
| let statusText = "$(globe) "; | ||
| // Coder Connect doesn't populate any other stats | ||
| @@ -910,9 +916,9 @@ export class Remote { | ||
| .then((content) => { | ||
| return JSON.parse(content); | ||
| }) | ||
| .then(async(parsed) => { | ||
| try { | ||
| awaitupdateStatus(parsed); | ||
| } catch (ex) { | ||
| // Ignore | ||
| } | ||
8 changes: 7 additions & 1 deletionsrc/storage.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -3,7 +3,9 @@ import { createWriteStream } from "fs"; | ||
| importfsfrom"fs/promises"; | ||
| import{IncomingMessage}from"http"; | ||
| importpathfrom"path"; | ||
| // Dynamic import for ESM module | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
jaggederest marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| letprettyBytes:any; | ||
| import*asvscodefrom"vscode"; | ||
| import{errToStr}from"./api-helper"; | ||
| import*asclifrom"./cliManager"; | ||
| @@ -122,6 +124,10 @@ export class Storage { | ||
| * downloads being disabled. | ||
| */ | ||
| publicasyncfetchBinary(restClient:Api,label:string):Promise<string>{ | ||
| // Load ESM module if not already loaded | ||
| if(!prettyBytes){ | ||
| prettyBytes=(awaitimport("pretty-bytes")).default; | ||
| } | ||
jaggederest marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| constbaseUrl=restClient.getAxiosInstance().defaults.baseURL; | ||
| // Settings can be undefined when set to their defaults (true in this case), | ||
56 changes: 56 additions & 0 deletionssrc/test/extension.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| import*asassertfrom"assert"; | ||
| import*asvscodefrom"vscode"; | ||
| suite("Extension Test Suite",()=>{ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Exciting to have this working!! | ||
| vscode.window.showInformationMessage("Start all tests."); | ||
| test("Extension should be present",()=>{ | ||
| assert.ok(vscode.extensions.getExtension("coder.coder-remote")); | ||
| }); | ||
| test("Extension should activate",async()=>{ | ||
| constextension=vscode.extensions.getExtension("coder.coder-remote"); | ||
| assert.ok(extension); | ||
| if(!extension.isActive){ | ||
| awaitextension.activate(); | ||
| } | ||
| assert.ok(extension.isActive); | ||
| }); | ||
| test("Extension should export activate function",async()=>{ | ||
| constextension=vscode.extensions.getExtension("coder.coder-remote"); | ||
| assert.ok(extension); | ||
| awaitextension.activate(); | ||
| // The extension doesn't export anything, which is fine | ||
| // The test was expecting exports.activate but the extension | ||
| // itself is the activate function | ||
| assert.ok(extension.isActive); | ||
| }); | ||
| test("Commands should be registered",async()=>{ | ||
| constextension=vscode.extensions.getExtension("coder.coder-remote"); | ||
| assert.ok(extension); | ||
| if(!extension.isActive){ | ||
| awaitextension.activate(); | ||
| } | ||
| // Give a small delay for commands to register | ||
| awaitnewPromise((resolve)=>setTimeout(resolve,100)); | ||
| constcommands=awaitvscode.commands.getCommands(true); | ||
| constcoderCommands=commands.filter((cmd)=>cmd.startsWith("coder.")); | ||
| assert.ok( | ||
| coderCommands.length>0, | ||
| "Should have registered Coder commands", | ||
| ); | ||
| assert.ok( | ||
| coderCommands.includes("coder.login"), | ||
| "Should have coder.login command", | ||
| ); | ||
| }); | ||
| }); | ||
11 changes: 5 additions & 6 deletionstsconfig.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,13 @@ | ||
| { | ||
| "compilerOptions": { | ||
| "module":"Node16", | ||
| "target":"ES2022", | ||
| "outDir":"out", | ||
| // "dom" is required for importing the API from coder/coder. | ||
| "lib": ["ES2022","dom"], | ||
| "sourceMap":true, | ||
| "strict":true, | ||
| "skipLibCheck":true | ||
| }, | ||
| "exclude": ["vitest.config.ts"] | ||
| } |
17 changes: 17 additions & 0 deletionsvitest.config.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| import{defineConfig}from"vitest/config"; | ||
| exportdefaultdefineConfig({ | ||
| test:{ | ||
| include:["src/**/*.test.ts"], | ||
| exclude:[ | ||
| "**/node_modules/**", | ||
| "**/dist/**", | ||
| "**/build/**", | ||
| "**/out/**", | ||
| "**/src/test/**", | ||
| "src/test/**", | ||
| "./src/test/**", | ||
| ], | ||
| environment:"node", | ||
| }, | ||
| }); |
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.