fix(testing): revert change & fix playwright tests (#4310)
* fix(testing): revert change & fix playwright tests * fix(constants): add type to import statement * refactor(e2e): delete browser test This test was originally added to ensure playwright was working. At this point, we know it works so removing this test because it doesn't help with anything specific to code-server and only adds unnecessary code to the codebase plus increases the e2e test job duration. * chore(e2e): use 1 worker for e2e test I don't know if it's a resources issue, playwright, or code-server but it seems like the e2e tests choke when multiple workers are used. This change is okay because our CI runner only has 2 cores so it would only use 1 worker anyway, but by specifying it in our playwright config, we ensure more stability in our e2e tests working correctly. See these PRs: - https://github.com/cdr/code-server/pull/3263 - https://github.com/cdr/code-server/pull/4310 * revert(vscode): add missing route with redirect * chore(vscode): update to latest fork * Touch up compilation step. * Bump vendor. * Fix VS Code minification step * Move ClientConfiguration to common Common code must not import Node code as it is imported by the browser. * Ensure lib directory exists before curling cURL errors now because VS Code was moved and the directory does not exist. * Update incorrect e2e test help output Revert workers change as well; this can be overridden when desired. * Add back extension compilation step * Include missing resources in release This includes a favicon, for example. I opted to include the entire directory to make sure we do not miss anything. Some of the other stuff looks potentially useful (like completions). * Set quality property in product configuration When httpWebWorkerExtensionHostIframe.html is fetched it uses the web endpoint template (in which we do not include the commit) but if the quality is not set it prepends the commit to the web endpoint instead. The new static endpoint does not use/handle commits so this 404s. Long-term we might want to make the new static endpoint use commits like the old one but we will also need to update the various other static URLs to include the commit. For now I just fixed this by adding the quality since: 1. Probably faster than trying to find and update all static uses. 2. VS Code probably expects it anyway. 3. Gives us better control over the endpoint. * Update VS Code This fixes several build issues. * Bump vscode. * Bump. * Bump. * Use CLI directly. * Update tests to reflect new upstream behavior. * Move unit tests to after the build Our code has new dependencies on VS Code that are pulled in when the unit tests run. Because of this we need to build VS Code before running the unit tests (as it only pulls built code). * Upgrade proxy-agent dependencies This resolves a security report with one of its dependencies (vm2). * Symlink VS Code output directory before unit tests This is necessary now that we import from the out directory. * Fix issues surrounding persistent processes between tests. * Update VS Code cache directories These were renamed so the cached paths need to be updated. I changed the key as well to force a rebuild. * Move test symlink to script This way it works for local testing as well. I had to use out-build instead of out-vscode-server-min because Jest throws some obscure error about a handlebars haste map. * Fix listening on a socket * Update VS Code It contains fixes for missing files in the build. * Standardize disposals * Dispose HTTP server Shares code with the test HTTP server. For now it is a function but maybe we should make it a class that is extended by tests. * Dispose app on exit * Fix logging link errors Unfortunately the logger currently chokes when provided with error objects. Also for some reason the bracketed text was not displaying... * Update regex used by e2e to extract address The address was recently changed to use URL which seems to add a trailing slash when using toString, causing the regex match to fail. * Log browser console in e2e tests * Add base back to login page This is used to set cookies when using a base path. * Remove login page test The file this was testing no longer exists. * Use path.posix for static base Since this is a web path and not platform-dependent. * Add test for invalid password Co-authored-by: Teffen Ellis <teffen@nirri.us> Co-authored-by: Asher <ash@coder.com>
This commit is contained in:
@ -1,15 +0,0 @@
|
||||
import { describe, test, expect } from "./baseFixture"
|
||||
|
||||
// This is a "gut-check" test to make sure playwright is working as expected
|
||||
describe("browser", true, () => {
|
||||
test("browser should display correct userAgent", async ({ codeServerPage, browserName }) => {
|
||||
const displayNames = {
|
||||
chromium: "Chrome",
|
||||
firefox: "Firefox",
|
||||
webkit: "Safari",
|
||||
}
|
||||
const userAgent = await codeServerPage.page.evaluate(() => navigator.userAgent)
|
||||
|
||||
expect(userAgent).toContain(displayNames[browserName])
|
||||
})
|
||||
})
|
@ -1,11 +1,11 @@
|
||||
import { Logger, logger } from "@coder/logger"
|
||||
import { field, Logger, logger } from "@coder/logger"
|
||||
import * as cp from "child_process"
|
||||
import { promises as fs } from "fs"
|
||||
import * as path from "path"
|
||||
import { Page } from "playwright"
|
||||
import { onLine } from "../../../src/node/util"
|
||||
import { PASSWORD, workspaceDir } from "../../utils/constants"
|
||||
import { tmpdir } from "../../utils/helpers"
|
||||
import { idleTimer, tmpdir } from "../../utils/helpers"
|
||||
|
||||
interface CodeServerProcess {
|
||||
process: cp.ChildProcess
|
||||
@ -99,34 +99,44 @@ export class CodeServer {
|
||||
},
|
||||
)
|
||||
|
||||
const timer = idleTimer("Failed to extract address; did the format change?", reject)
|
||||
|
||||
proc.on("error", (error) => {
|
||||
this.logger.error(error.message)
|
||||
timer.dispose()
|
||||
reject(error)
|
||||
})
|
||||
|
||||
proc.on("close", () => {
|
||||
proc.on("close", (code) => {
|
||||
const error = new Error("closed unexpectedly")
|
||||
if (!this.closed) {
|
||||
this.logger.error(error.message)
|
||||
this.logger.error(error.message, field("code", code))
|
||||
}
|
||||
timer.dispose()
|
||||
reject(error)
|
||||
})
|
||||
|
||||
let resolved = false
|
||||
proc.stdout.setEncoding("utf8")
|
||||
onLine(proc, (line) => {
|
||||
// As long as we are actively getting input reset the timer. If we stop
|
||||
// getting input and still have not found the address the timer will
|
||||
// reject.
|
||||
timer.reset()
|
||||
|
||||
// Log the line without the timestamp.
|
||||
this.logger.trace(line.replace(/\[.+\]/, ""))
|
||||
if (resolved) {
|
||||
return
|
||||
}
|
||||
const match = line.trim().match(/HTTP server listening on (https?:\/\/[.:\d]+)$/)
|
||||
const match = line.trim().match(/HTTP server listening on (https?:\/\/[.:\d]+)\/?$/)
|
||||
if (match) {
|
||||
// Cookies don't seem to work on IP address so swap to localhost.
|
||||
// TODO: Investigate whether this is a bug with code-server.
|
||||
const address = match[1].replace("127.0.0.1", "localhost")
|
||||
this.logger.debug(`spawned on ${address}`)
|
||||
resolved = true
|
||||
timer.dispose()
|
||||
resolve({ process: proc, address })
|
||||
}
|
||||
})
|
||||
@ -156,7 +166,14 @@ export class CodeServer {
|
||||
export class CodeServerPage {
|
||||
private readonly editorSelector = "div.monaco-workbench"
|
||||
|
||||
constructor(private readonly codeServer: CodeServer, public readonly page: Page) {}
|
||||
constructor(private readonly codeServer: CodeServer, public readonly page: Page) {
|
||||
this.page.on("console", (message) => {
|
||||
this.codeServer.logger.debug(message)
|
||||
})
|
||||
this.page.on("pageerror", (error) => {
|
||||
logError(this.codeServer.logger, "page", error)
|
||||
})
|
||||
}
|
||||
|
||||
address() {
|
||||
return this.codeServer.address()
|
||||
|
@ -3,20 +3,20 @@
|
||||
"#": "We must put jest in a sub-directory otherwise VS Code somehow picks up the types and generates conflicts with mocha.",
|
||||
"devDependencies": {
|
||||
"@playwright/test": "^1.12.1",
|
||||
"@types/jest": "^26.0.20",
|
||||
"@types/jest": "^27.0.2",
|
||||
"@types/jsdom": "^16.2.13",
|
||||
"@types/node-fetch": "^2.5.8",
|
||||
"@types/supertest": "^2.0.10",
|
||||
"@types/supertest": "^2.0.11",
|
||||
"@types/wtfnode": "^0.7.0",
|
||||
"argon2": "^0.28.0",
|
||||
"jest": "^26.6.3",
|
||||
"jest": "^27.3.1",
|
||||
"jest-fetch-mock": "^3.0.3",
|
||||
"jsdom": "^16.4.0",
|
||||
"node-fetch": "^2.6.1",
|
||||
"playwright": "^1.12.1",
|
||||
"supertest": "^6.1.1",
|
||||
"ts-jest": "^26.4.4",
|
||||
"wtfnode": "^0.9.0"
|
||||
"supertest": "^6.1.6",
|
||||
"ts-jest": "^27.0.7",
|
||||
"wtfnode": "^0.9.1"
|
||||
},
|
||||
"resolutions": {
|
||||
"ansi-regex": "^5.0.1",
|
||||
|
@ -2,7 +2,12 @@ import { PlaywrightTestConfig } from "@playwright/test"
|
||||
|
||||
import path from "path"
|
||||
|
||||
// Run tests in three browsers.
|
||||
// The default configuration runs all tests in three browsers with workers equal
|
||||
// to half the available threads. See 'yarn test:e2e --help' to customize from
|
||||
// the command line. For example:
|
||||
// yarn test:e2e --workers 1 # Run with one worker
|
||||
// yarn test:e2e --project Chromium # Only run on Chromium
|
||||
// yarn test:e2e --grep login # Run tests matching "login"
|
||||
const config: PlaywrightTestConfig = {
|
||||
testDir: path.join(__dirname, "e2e"), // Search for tests in this directory.
|
||||
timeout: 60000, // Each test is given 60 seconds.
|
||||
|
@ -1,73 +0,0 @@
|
||||
import { JSDOM } from "jsdom"
|
||||
import { LocationLike } from "../../common/util.test"
|
||||
|
||||
describe("login", () => {
|
||||
describe("there is an element with id 'base'", () => {
|
||||
beforeEach(() => {
|
||||
const dom = new JSDOM()
|
||||
global.document = dom.window.document
|
||||
|
||||
const location: LocationLike = {
|
||||
pathname: "/healthz",
|
||||
origin: "http://localhost:8080",
|
||||
}
|
||||
|
||||
global.location = location as Location
|
||||
})
|
||||
afterEach(() => {
|
||||
// Reset the global.document
|
||||
global.document = undefined as any as Document
|
||||
global.location = undefined as any as Location
|
||||
})
|
||||
it("should set the value to options.base", () => {
|
||||
// Mock getElementById
|
||||
const spy = jest.spyOn(document, "getElementById")
|
||||
// Create a fake element and set the attribute
|
||||
const mockElement = document.createElement("input")
|
||||
const expected = {
|
||||
base: "./hello-world",
|
||||
logLevel: 2,
|
||||
disableTelemetry: false,
|
||||
disableUpdateCheck: false,
|
||||
}
|
||||
mockElement.setAttribute("data-settings", JSON.stringify(expected))
|
||||
document.body.appendChild(mockElement)
|
||||
spy.mockImplementation(() => mockElement)
|
||||
})
|
||||
})
|
||||
describe("there is not an element with id 'base'", () => {
|
||||
let spy: jest.SpyInstance
|
||||
|
||||
beforeAll(() => {
|
||||
// This is important because we're manually requiring the file
|
||||
// If you don't call this before all tests
|
||||
// the module registry from other tests may cause side effects.
|
||||
jest.resetModuleRegistry()
|
||||
})
|
||||
|
||||
beforeEach(() => {
|
||||
const dom = new JSDOM()
|
||||
global.document = dom.window.document
|
||||
spy = jest.spyOn(document, "getElementById")
|
||||
|
||||
const location: LocationLike = {
|
||||
pathname: "/healthz",
|
||||
origin: "http://localhost:8080",
|
||||
}
|
||||
|
||||
global.location = location as Location
|
||||
})
|
||||
|
||||
afterEach(() => {
|
||||
spy.mockClear()
|
||||
jest.resetModules()
|
||||
// Reset the global.document
|
||||
global.document = undefined as any as Document
|
||||
global.location = undefined as any as Location
|
||||
})
|
||||
|
||||
afterAll(() => {
|
||||
jest.restoreAllMocks()
|
||||
})
|
||||
})
|
||||
})
|
@ -110,71 +110,6 @@ describe("util", () => {
|
||||
})
|
||||
})
|
||||
|
||||
describe("getOptions", () => {
|
||||
beforeEach(() => {
|
||||
const location: LocationLike = {
|
||||
pathname: "/healthz",
|
||||
origin: "http://localhost:8080",
|
||||
// search: "?environmentId=600e0187-0909d8a00cb0a394720d4dce",
|
||||
}
|
||||
|
||||
// Because resolveBase is not a pure function
|
||||
// and relies on the global location to be set
|
||||
// we set it before all the tests
|
||||
// and tell TS that our location should be looked at
|
||||
// as Location (even though it's missing some properties)
|
||||
global.location = location as Location
|
||||
})
|
||||
|
||||
afterEach(() => {
|
||||
jest.restoreAllMocks()
|
||||
})
|
||||
|
||||
it("should return options with base and cssStaticBase even if it doesn't exist", () => {
|
||||
expect(util.getClientConfiguration()).toStrictEqual({
|
||||
base: "",
|
||||
csStaticBase: "",
|
||||
})
|
||||
})
|
||||
|
||||
it("should return options when they do exist", () => {
|
||||
// Mock getElementById
|
||||
const spy = jest.spyOn(document, "getElementById")
|
||||
// Create a fake element and set the attribute
|
||||
const mockElement = document.createElement("div")
|
||||
mockElement.setAttribute(
|
||||
"data-settings",
|
||||
'{"base":".","csStaticBase":"./static/development/Users/jp/Dev/code-server","logLevel":2,"disableUpdateCheck":false}',
|
||||
)
|
||||
// Return mockElement from the spy
|
||||
// this way, when we call "getElementById"
|
||||
// it returns the element
|
||||
spy.mockImplementation(() => mockElement)
|
||||
|
||||
expect(util.getClientConfiguration()).toStrictEqual({
|
||||
base: "",
|
||||
csStaticBase: "/static/development/Users/jp/Dev/code-server",
|
||||
disableUpdateCheck: false,
|
||||
logLevel: 2,
|
||||
})
|
||||
})
|
||||
|
||||
it("should include queryOpts", () => {
|
||||
// Trying to understand how the implementation works
|
||||
// 1. It grabs the search params from location.search (i.e. ?)
|
||||
// 2. it then grabs the "options" param if it exists
|
||||
// 3. then it creates a new options object
|
||||
// spreads the original options
|
||||
// then parses the queryOpts
|
||||
location.search = '?options={"logLevel":2}'
|
||||
expect(util.getClientConfiguration()).toStrictEqual({
|
||||
base: "",
|
||||
csStaticBase: "",
|
||||
logLevel: 2,
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe("arrayify", () => {
|
||||
it("should return value it's already an array", () => {
|
||||
expect(util.arrayify(["hello", "world"])).toStrictEqual(["hello", "world"])
|
||||
|
@ -47,16 +47,16 @@ describe("createApp", () => {
|
||||
port,
|
||||
_: [],
|
||||
})
|
||||
const [app, wsApp, server] = await createApp(defaultArgs)
|
||||
const app = await createApp(defaultArgs)
|
||||
|
||||
// This doesn't check much, but it's a good sanity check
|
||||
// to ensure we actually get back values from createApp
|
||||
expect(app).not.toBeNull()
|
||||
expect(wsApp).not.toBeNull()
|
||||
expect(server).toBeInstanceOf(http.Server)
|
||||
expect(app.router).not.toBeNull()
|
||||
expect(app.wsRouter).not.toBeNull()
|
||||
expect(app.server).toBeInstanceOf(http.Server)
|
||||
|
||||
// Cleanup
|
||||
server.close()
|
||||
app.dispose()
|
||||
})
|
||||
|
||||
it("should handle error events on the server", async () => {
|
||||
@ -65,24 +65,18 @@ describe("createApp", () => {
|
||||
_: [],
|
||||
})
|
||||
|
||||
// This looks funky, but that's because createApp
|
||||
// returns an array like [app, wsApp, server]
|
||||
// We only need server which is at index 2
|
||||
// we do it this way so ESLint is happy that we're
|
||||
// have no declared variables not being used
|
||||
const app = await createApp(defaultArgs)
|
||||
const server = app[2]
|
||||
|
||||
const testError = new Error("Test error")
|
||||
// We can easily test how the server handles errors
|
||||
// By emitting an error event
|
||||
// Ref: https://stackoverflow.com/a/33872506/3015595
|
||||
server.emit("error", testError)
|
||||
app.server.emit("error", testError)
|
||||
expect(spy).toHaveBeenCalledTimes(1)
|
||||
expect(spy).toHaveBeenCalledWith(`http server error: ${testError.message} ${testError.stack}`)
|
||||
|
||||
// Cleanup
|
||||
server.close()
|
||||
app.dispose()
|
||||
})
|
||||
|
||||
it("should reject errors that happen before the server can listen", async () => {
|
||||
@ -96,14 +90,13 @@ describe("createApp", () => {
|
||||
|
||||
async function masterBall() {
|
||||
const app = await createApp(defaultArgs)
|
||||
const server = app[2]
|
||||
|
||||
const testError = new Error("Test error")
|
||||
|
||||
server.emit("error", testError)
|
||||
app.server.emit("error", testError)
|
||||
|
||||
// Cleanup
|
||||
server.close()
|
||||
app.dispose()
|
||||
}
|
||||
|
||||
expect(() => masterBall()).rejects.toThrow(`listen EACCES: permission denied 127.0.0.1:${port}`)
|
||||
@ -117,10 +110,9 @@ describe("createApp", () => {
|
||||
})
|
||||
|
||||
const app = await createApp(defaultArgs)
|
||||
const server = app[2]
|
||||
|
||||
expect(unlinkSpy).toHaveBeenCalledTimes(1)
|
||||
server.close()
|
||||
app.dispose()
|
||||
})
|
||||
|
||||
it("should create an https server if args.cert exists", async () => {
|
||||
@ -133,14 +125,13 @@ describe("createApp", () => {
|
||||
["cert-key"]: testCertificate.certKey,
|
||||
})
|
||||
const app = await createApp(defaultArgs)
|
||||
const server = app[2]
|
||||
|
||||
// This doesn't check much, but it's a good sanity check
|
||||
// to ensure we actually get an https.Server
|
||||
expect(server).toBeInstanceOf(https.Server)
|
||||
expect(app.server).toBeInstanceOf(https.Server)
|
||||
|
||||
// Cleanup
|
||||
server.close()
|
||||
app.dispose()
|
||||
})
|
||||
})
|
||||
|
||||
@ -156,18 +147,12 @@ describe("ensureAddress", () => {
|
||||
})
|
||||
|
||||
it("should throw and error if no address", () => {
|
||||
expect(() => ensureAddress(mockServer)).toThrow("server has no address")
|
||||
})
|
||||
it("should return the address if it exists and not a string", async () => {
|
||||
const port = await getAvailablePort()
|
||||
mockServer.listen(port)
|
||||
const address = ensureAddress(mockServer)
|
||||
expect(address).toBe(`http://:::${port}`)
|
||||
expect(() => ensureAddress(mockServer, "http")).toThrow("Server has no address")
|
||||
})
|
||||
it("should return the address if it exists", async () => {
|
||||
mockServer.address = () => "http://localhost:8080"
|
||||
const address = ensureAddress(mockServer)
|
||||
expect(address).toBe(`http://localhost:8080`)
|
||||
mockServer.address = () => "http://localhost:8080/"
|
||||
const address = ensureAddress(mockServer, "http")
|
||||
expect(address.toString()).toBe(`http://localhost:8080/`)
|
||||
})
|
||||
})
|
||||
|
||||
|
@ -10,10 +10,10 @@ import {
|
||||
parse,
|
||||
setDefaults,
|
||||
shouldOpenInExistingInstance,
|
||||
shouldRunVsCodeCli,
|
||||
splitOnFirstEquals,
|
||||
} from "../../../src/node/cli"
|
||||
import { tmpdir } from "../../../src/node/constants"
|
||||
import { shouldSpawnCliProcess } from "../../../src/node/main"
|
||||
import { generatePassword, paths } from "../../../src/node/util"
|
||||
import { useEnv } from "../../utils/helpers"
|
||||
|
||||
@ -486,45 +486,45 @@ describe("splitOnFirstEquals", () => {
|
||||
})
|
||||
})
|
||||
|
||||
describe("shouldRunVsCodeCli", () => {
|
||||
it("should return false if no 'extension' related args passed in", () => {
|
||||
describe("shouldSpawnCliProcess", () => {
|
||||
it("should return false if no 'extension' related args passed in", async () => {
|
||||
const args = {
|
||||
_: [],
|
||||
}
|
||||
const actual = shouldRunVsCodeCli(args)
|
||||
const actual = await shouldSpawnCliProcess(args)
|
||||
const expected = false
|
||||
|
||||
expect(actual).toBe(expected)
|
||||
})
|
||||
|
||||
it("should return true if 'list-extensions' passed in", () => {
|
||||
it("should return true if 'list-extensions' passed in", async () => {
|
||||
const args = {
|
||||
_: [],
|
||||
["list-extensions"]: true,
|
||||
}
|
||||
const actual = shouldRunVsCodeCli(args)
|
||||
const actual = await shouldSpawnCliProcess(args)
|
||||
const expected = true
|
||||
|
||||
expect(actual).toBe(expected)
|
||||
})
|
||||
|
||||
it("should return true if 'install-extension' passed in", () => {
|
||||
it("should return true if 'install-extension' passed in", async () => {
|
||||
const args = {
|
||||
_: [],
|
||||
["install-extension"]: ["hello.world"],
|
||||
}
|
||||
const actual = shouldRunVsCodeCli(args)
|
||||
const actual = await shouldSpawnCliProcess(args)
|
||||
const expected = true
|
||||
|
||||
expect(actual).toBe(expected)
|
||||
})
|
||||
|
||||
it("should return true if 'uninstall-extension' passed in", () => {
|
||||
it("should return true if 'uninstall-extension' passed in", async () => {
|
||||
const args = {
|
||||
_: [],
|
||||
["uninstall-extension"]: ["hello.world"],
|
||||
}
|
||||
const actual = shouldRunVsCodeCli(args)
|
||||
const actual = await shouldSpawnCliProcess(args)
|
||||
const expected = true
|
||||
|
||||
expect(actual).toBe(expected)
|
||||
|
@ -58,7 +58,7 @@ describe("plugin", () => {
|
||||
})
|
||||
|
||||
afterAll(async () => {
|
||||
await s.close()
|
||||
await s.dispose()
|
||||
})
|
||||
|
||||
it("/api/applications", async () => {
|
||||
|
@ -1,7 +1,7 @@
|
||||
import bodyParser from "body-parser"
|
||||
import * as express from "express"
|
||||
import * as http from "http"
|
||||
import * as nodeFetch from "node-fetch"
|
||||
import nodeFetch from "node-fetch"
|
||||
import { HttpCode } from "../../../src/common/http"
|
||||
import { proxy } from "../../../src/node/proxy"
|
||||
import { getAvailablePort } from "../../utils/helpers"
|
||||
@ -24,7 +24,7 @@ describe("proxy", () => {
|
||||
})
|
||||
|
||||
afterAll(async () => {
|
||||
await nhooyrDevServer.close()
|
||||
await nhooyrDevServer.dispose()
|
||||
})
|
||||
|
||||
beforeEach(() => {
|
||||
@ -33,7 +33,7 @@ describe("proxy", () => {
|
||||
|
||||
afterEach(async () => {
|
||||
if (codeServer) {
|
||||
await codeServer.close()
|
||||
await codeServer.dispose()
|
||||
codeServer = undefined
|
||||
}
|
||||
})
|
||||
@ -202,13 +202,13 @@ describe("proxy (standalone)", () => {
|
||||
it("should return a 500 when proxy target errors ", async () => {
|
||||
// Close the proxy target so that proxy errors
|
||||
await proxyTarget.close()
|
||||
const errorResp = await nodeFetch.default(`${URL}/error`)
|
||||
const errorResp = await nodeFetch(`${URL}/error`)
|
||||
expect(errorResp.status).toBe(HttpCode.ServerError)
|
||||
expect(errorResp.statusText).toBe("Internal Server Error")
|
||||
})
|
||||
|
||||
it("should proxy correctly", async () => {
|
||||
const resp = await nodeFetch.default(`${URL}/route`)
|
||||
const resp = await nodeFetch(`${URL}/route`)
|
||||
expect(resp.status).toBe(200)
|
||||
expect(resp.statusText).toBe("OK")
|
||||
})
|
||||
|
@ -6,7 +6,7 @@ describe("health", () => {
|
||||
|
||||
afterEach(async () => {
|
||||
if (codeServer) {
|
||||
await codeServer.close()
|
||||
await codeServer.dispose()
|
||||
codeServer = undefined
|
||||
}
|
||||
})
|
||||
|
@ -58,7 +58,7 @@ describe("login", () => {
|
||||
afterEach(async () => {
|
||||
process.env.PASSWORD = previousEnvPassword
|
||||
if (_codeServer) {
|
||||
await _codeServer.close()
|
||||
await _codeServer.dispose()
|
||||
_codeServer = undefined
|
||||
}
|
||||
})
|
||||
@ -72,5 +72,20 @@ describe("login", () => {
|
||||
|
||||
expect(htmlContent).toContain("Missing password")
|
||||
})
|
||||
|
||||
it("should return HTML with 'Incorrect password' message", async () => {
|
||||
const params = new URLSearchParams()
|
||||
params.append("password", "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
|
||||
const resp = await codeServer().fetch("/login", {
|
||||
method: "POST",
|
||||
body: params,
|
||||
})
|
||||
|
||||
expect(resp.status).toBe(200)
|
||||
|
||||
const htmlContent = await resp.text()
|
||||
|
||||
expect(htmlContent).toContain("Incorrect password")
|
||||
})
|
||||
})
|
||||
})
|
||||
|
@ -7,7 +7,7 @@ import * as integration from "../../../utils/integration"
|
||||
|
||||
const NOT_FOUND = {
|
||||
code: 404,
|
||||
message: "Not Found",
|
||||
message: /not found/i,
|
||||
}
|
||||
|
||||
describe("/_static", () => {
|
||||
@ -33,7 +33,7 @@ describe("/_static", () => {
|
||||
|
||||
afterEach(async () => {
|
||||
if (_codeServer) {
|
||||
await _codeServer.close()
|
||||
await _codeServer.dispose()
|
||||
_codeServer = undefined
|
||||
}
|
||||
})
|
||||
@ -44,7 +44,7 @@ describe("/_static", () => {
|
||||
expect(resp.status).toBe(NOT_FOUND.code)
|
||||
|
||||
const content = await resp.json()
|
||||
expect(content.error).toContain(NOT_FOUND.message)
|
||||
expect(content.error).toMatch(NOT_FOUND.message)
|
||||
})
|
||||
}
|
||||
|
||||
|
@ -82,3 +82,21 @@ export const getAvailablePort = (options?: net.ListenOptions): Promise<number> =
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
/**
|
||||
* Return a timer that will not reject as long as it is disposed or continually
|
||||
* reset before the delay elapses.
|
||||
*/
|
||||
export function idleTimer(message: string, reject: (error: Error) => void, delay = 5000) {
|
||||
const start = () => setTimeout(() => reject(new Error(message)), delay)
|
||||
let timeout = start()
|
||||
return {
|
||||
reset: () => {
|
||||
clearTimeout(timeout)
|
||||
timeout = start()
|
||||
},
|
||||
dispose: () => {
|
||||
clearTimeout(timeout)
|
||||
},
|
||||
}
|
||||
}
|
||||
|
@ -1,30 +1,29 @@
|
||||
import { logger } from "@coder/logger"
|
||||
import * as express from "express"
|
||||
import * as http from "http"
|
||||
import * as net from "net"
|
||||
import * as nodeFetch from "node-fetch"
|
||||
import nodeFetch, { RequestInit, Response } from "node-fetch"
|
||||
import Websocket from "ws"
|
||||
import { Disposable } from "../../src/common/emitter"
|
||||
import * as util from "../../src/common/util"
|
||||
import { ensureAddress } from "../../src/node/app"
|
||||
import { disposer } from "../../src/node/http"
|
||||
|
||||
import { handleUpgrade } from "../../src/node/wsRouter"
|
||||
|
||||
// Perhaps an abstraction similar to this should be used in app.ts as well.
|
||||
export class HttpServer {
|
||||
private readonly sockets = new Set<net.Socket>()
|
||||
private cleanupTimeout?: NodeJS.Timeout
|
||||
private hs: http.Server
|
||||
public dispose: Disposable["dispose"]
|
||||
|
||||
// See usage in test/integration.ts
|
||||
public constructor(private readonly hs = http.createServer()) {
|
||||
this.hs.on("connection", (socket) => {
|
||||
this.sockets.add(socket)
|
||||
socket.on("close", () => {
|
||||
this.sockets.delete(socket)
|
||||
if (this.cleanupTimeout && this.sockets.size === 0) {
|
||||
clearTimeout(this.cleanupTimeout)
|
||||
this.cleanupTimeout = undefined
|
||||
}
|
||||
})
|
||||
})
|
||||
/**
|
||||
* Expects a server and a disposal that cleans up the server (and anything
|
||||
* else that may need cleanup).
|
||||
*
|
||||
* Otherwise a new server is created.
|
||||
*/
|
||||
public constructor(server?: { server: http.Server; dispose: Disposable["dispose"] }) {
|
||||
this.hs = server?.server || http.createServer()
|
||||
this.dispose = server?.dispose || disposer(this.hs)
|
||||
}
|
||||
|
||||
/**
|
||||
@ -34,20 +33,17 @@ export class HttpServer {
|
||||
public listen(fn: http.RequestListener): Promise<void> {
|
||||
this.hs.on("request", fn)
|
||||
|
||||
let resolved = false
|
||||
return new Promise((res, rej) => {
|
||||
this.hs.listen(0, "localhost", () => {
|
||||
res()
|
||||
resolved = true
|
||||
})
|
||||
return new Promise((resolve, reject) => {
|
||||
this.hs.on("error", reject)
|
||||
|
||||
this.hs.on("error", (err) => {
|
||||
if (!resolved) {
|
||||
rej(err)
|
||||
} else {
|
||||
this.hs.listen(0, "localhost", () => {
|
||||
this.hs.off("error", reject)
|
||||
resolve()
|
||||
|
||||
this.hs.on("error", (err) => {
|
||||
// Promise resolved earlier so this is some other error.
|
||||
util.logError(logger, "http server error", err)
|
||||
}
|
||||
})
|
||||
})
|
||||
})
|
||||
}
|
||||
@ -59,49 +55,31 @@ export class HttpServer {
|
||||
handleUpgrade(app, this.hs)
|
||||
}
|
||||
|
||||
/**
|
||||
* close cleans up the server.
|
||||
*/
|
||||
public close(): Promise<void> {
|
||||
return new Promise((res, rej) => {
|
||||
// Close will not actually close anything; it just waits until everything
|
||||
// is closed.
|
||||
this.hs.close((err) => {
|
||||
if (err) {
|
||||
rej(err)
|
||||
return
|
||||
}
|
||||
res()
|
||||
})
|
||||
|
||||
// If there are sockets remaining we might need to force close them or
|
||||
// this promise might never resolve.
|
||||
if (this.sockets.size > 0) {
|
||||
// Give sockets a chance to close up shop.
|
||||
this.cleanupTimeout = setTimeout(() => {
|
||||
this.cleanupTimeout = undefined
|
||||
for (const socket of this.sockets.values()) {
|
||||
console.warn("a socket was left hanging")
|
||||
socket.destroy()
|
||||
}
|
||||
}, 1000)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
/**
|
||||
* fetch fetches the request path.
|
||||
* The request path must be rooted!
|
||||
*/
|
||||
public fetch(requestPath: string, opts?: nodeFetch.RequestInit): Promise<nodeFetch.Response> {
|
||||
return nodeFetch.default(`${ensureAddress(this.hs)}${requestPath}`, opts)
|
||||
public fetch(requestPath: string, opts?: RequestInit): Promise<Response> {
|
||||
const address = ensureAddress(this.hs, "http")
|
||||
if (typeof address === "string") {
|
||||
throw new Error("Cannot fetch socket path")
|
||||
}
|
||||
address.pathname = requestPath
|
||||
|
||||
return nodeFetch(address.toString(), opts)
|
||||
}
|
||||
|
||||
/**
|
||||
* Open a websocket against the requset path.
|
||||
* Open a websocket against the request path.
|
||||
*/
|
||||
public ws(requestPath: string): Websocket {
|
||||
return new Websocket(`${ensureAddress(this.hs).replace("http:", "ws:")}${requestPath}`)
|
||||
const address = ensureAddress(this.hs, "ws")
|
||||
if (typeof address === "string") {
|
||||
throw new Error("Cannot open websocket to socket path")
|
||||
}
|
||||
address.pathname = requestPath
|
||||
|
||||
return new Websocket(address.toString())
|
||||
}
|
||||
|
||||
public port(): number {
|
||||
|
2315
test/yarn.lock
2315
test/yarn.lock
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user