feat(e2e): add support running behind proxy #5348

jsjoeio · 2022-07-15T20:58:40Z

Description

This PR adds a new job to run our end-to-end tests behind a reverse-proxy (with Caddy) to simulate how code-server runs in coder/coder and in many community-member deployments.

Changes

add new job to ci along with Caddyfile
refactor auth in e2e tests
refactor address() method in e2e model to work with reverse-proxy
add USE_PROXY env var used in e2e tests and scripts

Fixes #5337

github-actions · 2022-07-15T20:58:58Z

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

Host: https://coder.com/docs/code-server/b0efa94
Last deploy status: success
Commit: b991350
Workflow status: https://github.com/coder/code-server/actions/runs/2827314727

test/e2e/models/CodeServer.ts

codecov · 2022-07-15T21:03:26Z

Codecov Report

Merging #5348 (b991350) into main (efb5bae) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #5348   +/-   ##
=======================================
  Coverage   72.42%   72.42%           
=======================================
  Files          30       30           
  Lines        1672     1672           
  Branches      366      366           
=======================================
  Hits         1211     1211           
  Misses        398      398           
  Partials       63       63

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 efb5bae...b991350. Read the comment docs.

github-actions · 2022-07-15T21:04:14Z

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

Last publish status: success
Commit: b991350

To install in a local project, run:

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

To install globally, run:

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

test/e2e/models/CodeServer.ts

.github/workflows/ci.yaml

ci/Caddyfile

docs/MAINTAINING.md

jsjoeio · 2022-07-22T23:31:25Z

Need to figure out Caddyfile issues.

Opened forum post here: https://caddy.community/t/automatically-forward-subpath-to-port-on-localhost/16629

Oddly enough:

{
	admin    localhost:4444
}
:8000/*/ide/* {
        handle {
                respond "hello world" 200
        }

}

Doesn't work with http://localhost:8000/8080/ide/hi so something is up

test/e2e/models/CodeServer.ts

We don't need the submodules for the e2e job. This will speed up the checkout step.

This adds a new job to CI to run our tests behind Caddy and simulate code-server running against a reverse-proxy.

This refactors the e2e test in a couple ways: - remove setting cookie in localStorage (instead we pass --auth none) - refactor address() method to account for reverse proxy logic

test/e2e/models/CodeServer.ts

test/playwright.config.ts

stale

code-asher

May reverse proxies never break again! 🥂

.github/workflows/ci.yaml

test/utils/constants.ts

code-asher · 2022-08-09T17:18:53Z

test/utils/helpers.ts

+ */
+export async function getMaybeProxiedCodeServer(codeServer: CodeServerPage | CodeServer): Promise<string> {
+  let address = await codeServer.address()
+  if (process.env.USE_PROXY && process.env.USE_PROXY === "1") {


nit: we could do with just the latter check

Suggested change

if (process.env.USE_PROXY && process.env.USE_PROXY === "1") {

if (process.env.USE_PROXY === "1") {

Ooops sorry my suggestion removed the indent, I keep forgetting copy does not copy the indent and I have to add it back in manually.

😂 i'll fix locally, no worries. i didn't realize that either

Co-authored-by: Asher <[email protected]>

test/utils/helpers.ts

Co-authored-by: Asher <[email protected]>

jsjoeio requested a review from a team July 15, 2022 20:58

jsjoeio self-assigned this Jul 15, 2022

jsjoeio marked this pull request as draft July 15, 2022 20:58

jsjoeio commented Jul 15, 2022

View reviewed changes

test/e2e/models/CodeServer.ts Outdated Show resolved Hide resolved

jsjoeio temporarily deployed to npm July 15, 2022 21:03 Inactive

code-asher previously approved these changes Jul 15, 2022

View reviewed changes

jsjoeio commented Jul 15, 2022

View reviewed changes

test/e2e/models/CodeServer.ts Outdated Show resolved Hide resolved

jsjoeio temporarily deployed to npm July 15, 2022 22:10 Inactive

jsjoeio temporarily deployed to npm July 20, 2022 19:18 Inactive

jsjoeio temporarily deployed to npm July 21, 2022 20:42 Inactive

jsjoeio temporarily deployed to npm July 21, 2022 21:00 Inactive

jsjoeio temporarily deployed to npm July 21, 2022 21:54 Inactive

jsjoeio temporarily deployed to npm July 21, 2022 22:10 Inactive

jsjoeio temporarily deployed to npm July 21, 2022 22:28 Inactive

jsjoeio temporarily deployed to npm July 22, 2022 17:29 Inactive

jsjoeio commented Jul 22, 2022

View reviewed changes

.github/workflows/ci.yaml Outdated Show resolved Hide resolved

jsjoeio commented Jul 22, 2022

View reviewed changes

ci/Caddyfile Outdated Show resolved Hide resolved

jsjoeio commented Jul 22, 2022

View reviewed changes

docs/MAINTAINING.md Show resolved Hide resolved

jsjoeio temporarily deployed to npm July 22, 2022 21:48 Inactive

jsjoeio temporarily deployed to npm July 22, 2022 23:35 Inactive

jsjoeio temporarily deployed to npm August 1, 2022 21:06 Inactive

jsjoeio temporarily deployed to npm August 1, 2022 21:29 Inactive

jsjoeio temporarily deployed to npm August 1, 2022 22:06 Inactive

jsjoeio commented Aug 1, 2022

View reviewed changes

test/e2e/models/CodeServer.ts Outdated Show resolved Hide resolved

jsjoeio commented Aug 3, 2022

View reviewed changes

test/e2e/models/CodeServer.ts Outdated Show resolved Hide resolved

test/e2e/models/CodeServer.ts Outdated Show resolved Hide resolved

jsjoeio temporarily deployed to npm August 3, 2022 22:34 Inactive

jsjoeio temporarily deployed to npm August 5, 2022 21:48 Inactive

jsjoeio temporarily deployed to npm August 5, 2022 22:17 Inactive

jsjoeio added 5 commits August 8, 2022 10:16

docs: update maintaining

d64f197

chore(e2e): add maxFailures to playwright

2a89832

fix(ci): skip submodule in e2e job

64f39e2

We don't need the submodules for the e2e job. This will speed up the checkout step.

feat(ci): add test-e2e-proxy job

d9d7a5e

This adds a new job to CI to run our tests behind Caddy and simulate code-server running against a reverse-proxy.

refactor: make e2e work with reverse proxy

070a328

This refactors the e2e test in a couple ways: - remove setting cookie in localStorage (instead we pass --auth none) - refactor address() method to account for reverse proxy logic

jsjoeio force-pushed the jsjoeio/proxy-e2e branch from a223de2 to 070a328 Compare August 8, 2022 17:25

jsjoeio commented Aug 8, 2022

View reviewed changes

test/e2e/models/CodeServer.ts Outdated Show resolved Hide resolved

test/playwright.config.ts Outdated Show resolved Hide resolved

Update test/e2e/models/CodeServer.ts

a784f2d

jsjoeio marked this pull request as ready for review August 8, 2022 17:30

jsjoeio requested a review from code-asher August 8, 2022 17:30

jsjoeio temporarily deployed to npm August 8, 2022 17:32 Inactive

code-asher approved these changes Aug 9, 2022

View reviewed changes

jsjoeio and others added 4 commits August 9, 2022 10:21

Update test/playwright.config.ts

bbf0c47

Update test/utils/constants.ts

fe7a276

Co-authored-by: Asher <[email protected]>

Update test/utils/helpers.ts

f20d2af

Co-authored-by: Asher <[email protected]>

Merge branch 'main' into jsjoeio/proxy-e2e

4d207b6

jsjoeio enabled auto-merge (squash) August 9, 2022 17:22

jsjoeio added 2 commits August 9, 2022 10:30

fixup: formatting

06b91df

Merge branch 'main' into jsjoeio/proxy-e2e

dff6a4c

jsjoeio temporarily deployed to npm August 9, 2022 17:37 Inactive

code-asher reviewed Aug 9, 2022

View reviewed changes

test/utils/helpers.ts Outdated Show resolved Hide resolved

jsjoeio and others added 2 commits August 9, 2022 11:01

Update test/utils/helpers.ts

7f9a9b0

Co-authored-by: Asher <[email protected]>

Merge branch 'main' into jsjoeio/proxy-e2e

b991350

jsjoeio temporarily deployed to npm August 9, 2022 18:07 Inactive

jsjoeio merged commit f178f04 into main Aug 9, 2022

jsjoeio deleted the jsjoeio/proxy-e2e branch August 9, 2022 18:24

jsjoeio mentioned this pull request Aug 9, 2022

Bug in v0.7.6 a494489: inconsistency of code-server terminal loading. coder/coder#2845

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(e2e): add support running behind proxy #5348

feat(e2e): add support running behind proxy #5348

jsjoeio commented Jul 15, 2022 •

edited

Loading

github-actions bot commented Jul 15, 2022 •

edited

Loading

codecov bot commented Jul 15, 2022 •

edited

Loading

github-actions bot commented Jul 15, 2022 •

edited

Loading

jsjoeio commented Jul 22, 2022 •

edited

Loading

code-asher left a comment

code-asher Aug 9, 2022

code-asher Aug 9, 2022

jsjoeio Aug 9, 2022 •

edited

Loading

	if (process.env.USE_PROXY && process.env.USE_PROXY === "1") {
	if (process.env.USE_PROXY === "1") {

feat(e2e): add support running behind proxy #5348

feat(e2e): add support running behind proxy #5348

Conversation

jsjoeio commented Jul 15, 2022 • edited Loading

Description

Changes

github-actions bot commented Jul 15, 2022 • edited Loading

codecov bot commented Jul 15, 2022 • edited Loading

Codecov Report

github-actions bot commented Jul 15, 2022 • edited Loading

jsjoeio commented Jul 22, 2022 • edited Loading

code-asher left a comment

Choose a reason for hiding this comment

code-asher Aug 9, 2022

Choose a reason for hiding this comment

code-asher Aug 9, 2022

Choose a reason for hiding this comment

jsjoeio Aug 9, 2022 • edited Loading

Choose a reason for hiding this comment

jsjoeio commented Jul 15, 2022 •

edited

Loading

github-actions bot commented Jul 15, 2022 •

edited

Loading

codecov bot commented Jul 15, 2022 •

edited

Loading

github-actions bot commented Jul 15, 2022 •

edited

Loading

jsjoeio commented Jul 22, 2022 •

edited

Loading

jsjoeio Aug 9, 2022 •

edited

Loading