- Notifications
You must be signed in to change notification settings - Fork24
Add customizable header command#119
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
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
8 commits Select commitHold shift + click to select a range
697b30e Fix equals being lost in SSH config value
code-asher811673f Add header command setting
code-asherf9b416a Check for missing base URL
code-asher8a56af9 A bit too many quotes
code-asherc67bca2 Fix merging headers into config object
code-asher37118f9 Better fix for getting base URL
code-asher5923769 Avoid logging in when no url has been set
code-ashera7f21be Fix getting headers on login
code-asherFile 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
8 changes: 7 additions & 1 deletion.eslintrc.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
5 changes: 5 additions & 0 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
4 changes: 3 additions & 1 deletionsrc/commands.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
45 changes: 30 additions & 15 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
57 changes: 57 additions & 0 deletionssrc/headers.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,57 @@ | ||
| import * as os from "os" | ||
| import { it, expect } from "vitest" | ||
| import { getHeaders } from "./headers" | ||
| const logger = { | ||
| writeToCoderOutputChannel() { | ||
| // no-op | ||
| }, | ||
| } | ||
| it("should return no headers", async () => { | ||
| await expect(getHeaders(undefined, undefined, logger)).resolves.toStrictEqual({}) | ||
| await expect(getHeaders("localhost", undefined, logger)).resolves.toStrictEqual({}) | ||
| await expect(getHeaders(undefined, "command", logger)).resolves.toStrictEqual({}) | ||
| await expect(getHeaders("localhost", "", logger)).resolves.toStrictEqual({}) | ||
| await expect(getHeaders("", "command", logger)).resolves.toStrictEqual({}) | ||
| await expect(getHeaders("localhost", " ", logger)).resolves.toStrictEqual({}) | ||
| await expect(getHeaders(" ", "command", logger)).resolves.toStrictEqual({}) | ||
| }) | ||
| it("should return headers", async () => { | ||
| await expect(getHeaders("localhost", "printf foo=bar'\n'baz=qux", logger)).resolves.toStrictEqual({ | ||
| foo: "bar", | ||
| baz: "qux", | ||
| }) | ||
| await expect(getHeaders("localhost", "printf foo=bar'\r\n'baz=qux", logger)).resolves.toStrictEqual({ | ||
| foo: "bar", | ||
| baz: "qux", | ||
| }) | ||
| await expect(getHeaders("localhost", "printf foo=bar'\r\n'", logger)).resolves.toStrictEqual({ foo: "bar" }) | ||
| await expect(getHeaders("localhost", "printf foo=bar", logger)).resolves.toStrictEqual({ foo: "bar" }) | ||
| await expect(getHeaders("localhost", "printf foo=bar=", logger)).resolves.toStrictEqual({ foo: "bar=" }) | ||
| await expect(getHeaders("localhost", "printf foo=bar=baz", logger)).resolves.toStrictEqual({ foo: "bar=baz" }) | ||
| await expect(getHeaders("localhost", "printf foo=", logger)).resolves.toStrictEqual({ foo: "" }) | ||
| }) | ||
| it("should error on malformed or empty lines", async () => { | ||
| await expect(getHeaders("localhost", "printf foo=bar'\r\n\r\n'", logger)).rejects.toMatch(/Malformed/) | ||
| await expect(getHeaders("localhost", "printf '\r\n'foo=bar", logger)).rejects.toMatch(/Malformed/) | ||
| await expect(getHeaders("localhost", "printf =foo", logger)).rejects.toMatch(/Malformed/) | ||
| await expect(getHeaders("localhost", "printf foo", logger)).rejects.toMatch(/Malformed/) | ||
| await expect(getHeaders("localhost", "printf ' =foo'", logger)).rejects.toMatch(/Malformed/) | ||
| await expect(getHeaders("localhost", "printf 'foo =bar'", logger)).rejects.toMatch(/Malformed/) | ||
| await expect(getHeaders("localhost", "printf 'foo foo=bar'", logger)).rejects.toMatch(/Malformed/) | ||
| await expect(getHeaders("localhost", "printf ''", logger)).rejects.toMatch(/Malformed/) | ||
| }) | ||
| it("should have access to environment variables", async () => { | ||
| const coderUrl = "dev.coder.com" | ||
| await expect( | ||
| getHeaders(coderUrl, os.platform() === "win32" ? "printf url=%CODER_URL" : "printf url=$CODER_URL", logger), | ||
| ).resolves.toStrictEqual({ url: coderUrl }) | ||
| }) | ||
| it("should error on non-zero exit", async () => { | ||
| await expect(getHeaders("localhost", "exit 10", logger)).rejects.toMatch(/exited unexpectedly with code 10/) | ||
| }) |
64 changes: 64 additions & 0 deletionssrc/headers.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,64 @@ | ||
| import * as cp from "child_process" | ||
| import * as util from "util" | ||
| export interface Logger { | ||
| writeToCoderOutputChannel(message: string): void | ||
| } | ||
| interface ExecException { | ||
| code?: number | ||
| stderr?: string | ||
| stdout?: string | ||
| } | ||
| function isExecException(err: unknown): err is ExecException { | ||
| return typeof (err as ExecException).code !== "undefined" | ||
| } | ||
| // TODO: getHeaders might make more sense to directly implement on Storage | ||
| // but it is difficult to test Storage right now since we use vitest instead of | ||
| // the standard extension testing framework which would give us access to vscode | ||
| // APIs. We should revert the testing framework then consider moving this. | ||
| // getHeaders executes the header command and parses the headers from stdout. | ||
| // Both stdout and stderr are logged on error but stderr is otherwise ignored. | ||
| // Throws an error if the process exits with non-zero or the JSON is invalid. | ||
| // Returns undefined if there is no header command set. No effort is made to | ||
| // validate the JSON other than making sure it can be parsed. | ||
| export async function getHeaders( | ||
| url: string | undefined, | ||
| command: string | undefined, | ||
| logger: Logger, | ||
| ): Promise<Record<string, string>> { | ||
| const headers: Record<string, string> = {} | ||
| if (typeof url === "string" && url.trim().length > 0 && typeof command === "string" && command.trim().length > 0) { | ||
| let result: { stdout: string; stderr: string } | ||
| try { | ||
| result = await util.promisify(cp.exec)(command, { | ||
| env: { | ||
| ...process.env, | ||
| CODER_URL: url, | ||
| }, | ||
| }) | ||
| } catch (error) { | ||
| if (isExecException(error)) { | ||
| logger.writeToCoderOutputChannel(`Header command exited unexpectedly with code ${error.code}`) | ||
| logger.writeToCoderOutputChannel(`stdout: ${error.stdout}`) | ||
| logger.writeToCoderOutputChannel(`stderr: ${error.stderr}`) | ||
| throw new Error(`Header command exited unexpectedly with code ${error.code}`) | ||
| } | ||
| throw new Error(`Header command exited unexpectedly: ${error}`) | ||
| } | ||
| const lines = result.stdout.replace(/\r?\n$/, "").split(/\r?\n/) | ||
| for (let i = 0; i < lines.length; ++i) { | ||
| const [key, value] = lines[i].split(/=(.*)/) | ||
| // Header names cannot be blank or contain whitespace and the Coder CLI | ||
| // requires that there be an equals sign (the value can be blank though). | ||
| if (key.length === 0 || key.indexOf(" ") !== -1 || typeof value === "undefined") { | ||
| throw new Error(`Malformed line from header command: [${lines[i]}] (out: ${result.stdout})`) | ||
| } | ||
| headers[key] = value | ||
| } | ||
| } | ||
| return headers | ||
| } |
10 changes: 9 additions & 1 deletionsrc/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
2 changes: 2 additions & 0 deletionssrc/sshSupport.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
10 changes: 7 additions & 3 deletionssrc/sshSupport.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
5 changes: 5 additions & 0 deletionssrc/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
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.