fix: add https-proxy-agent to fetch requests #1433

malis42 · 2024-02-13T09:41:20Z

What/Why/How?

Adding https-proxy-agent package to fix issues with requests when using CLI behind proxy. Create better mechanism for handling env.REDOCLY_DOMAIN usage in few modules.

Now if you need to run the CLI tool behind a proxy, you can use the HTTP_PROXY and HTTPS_PROXY environment variables to configure the proxy settings.

https-proxy-agent package was used for node-fetch requests. Now we pass agent for every fetchWithTimeout request, as well as other regular fetch request.

Reference

Resolves #1404
Fixes #529
Fixes #1146

Testing

Fixed unit tests. Tested with few CLI commands: push, lint etc.

Screenshots (optional)

n/a

Has code been changed?

Yes

Check yourself

Code is linted
Tested with redoc/reference-docs/workflows (internal)
All new/updated code is covered with tests

Security

Security impact of change has been considered
Code follows company security practices and guidelines

changeset-bot · 2024-02-13T09:41:24Z

🦋 Changeset detected

Latest commit: 50f5541

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@redocly/openapi-core	Minor
@redocly/cli	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions · 2024-02-13T09:42:33Z

Command	Mean [s]	Min [s]	Max [s]	Relative
`redocly lint packages/core/src/benchmark/benches/rebilly.yaml`	1.133 ± 0.035	1.101	1.218	1.00
`redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml`	1.158 ± 0.030	1.103	1.206	1.02 ± 0.04

github-actions · 2024-02-13T09:43:30Z

Coverage report

St.^❔	Category	Percentage	Covered / Total
🟡	Statements	76.95%	4468/5806
🟡	Branches	67.05%	2362/3523
🟡	Functions	70.41%	728/1034
🟡	Lines	77.17%	4204/5448

Show new covered files 🐣

St.^❔	File	Statements	Branches	Functions	Lines
🟢	`...` / domains.ts	100%	76.92%	100%	100%

Show files with reduced coverage 🔻

St.^❔	File	Statements	Branches	Functions	Lines
🟡	`...` / config.ts	70.32%	77.3% (+1.11% 🔼)	67.86% (-1.11% 🔻)	70%
🟡	`...` / index.ts	63.64% (-3.03% 🔻)	67.86% (-3.57% 🔻)	73.91% (-1.09% 🔻)	63.64% (-3.03% 🔻)
🟡	`...` / push.ts	73.53%	68.46%	54.55%	75.93%
🟡	`...` / api-client.ts	75.44% (-4.56% 🔻)	41.38% (-4.77% 🔻)	75%	74.55% (-4.62% 🔻)

Test suite run success

722 tests passing in 102 suites.

Report generated by 🧪jest coverage report action from 50f5541

lornajane · 2024-02-13T14:07:37Z

Cool! I think this relates to some open issue(s) though, could you link them from the PR description?

packages/cli/src/cms/api/api-client.ts

tatomyr

Please test this in Workflows and add some docs for the new proxy feature.
Could you also update the description so it reflects how to use the proxy feature and how #1404 got resolved?

packages/core/src/domains.ts

packages/core/src/utils.ts

github-actions · 2024-02-16T10:27:51Z

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
`redocly lint packages/core/src/benchmark/benches/rebilly.yaml`	985.9 ± 12.9	960.7	1001.8	1.00
`redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml`	986.6 ± 19.7	952.5	1016.0	1.00 ± 0.02

.changeset/great-stingrays-unite.md

IgorKarpiuk

LGTM

tatomyr

Left a minor comment. Otherwise looks good.

packages/core/src/redocly/domains.ts

…k for push command auth check, small refactors

…t in packages/core

…ests to redocly dir

Co-authored-by: Heather Cloward <[email protected]>

This reverts commit 2639dc4.

This reverts commit 93e42db.

…ges (#1461) * Reapply "fix: add https-proxy-agent to fetch requests (#1433)" (#1458) * fix: add https-proxy-agent package to browser excluded packages

malis42 marked this pull request as ready for review February 14, 2024 10:37

malis42 requested review from a team as code owners February 14, 2024 10:37

IgorKarpiuk reviewed Feb 16, 2024

View reviewed changes

packages/cli/src/cms/api/api-client.ts Outdated Show resolved Hide resolved

tatomyr reviewed Feb 16, 2024

View reviewed changes

packages/core/src/domains.ts Outdated Show resolved Hide resolved

packages/core/src/utils.ts Outdated Show resolved Hide resolved

packages/core/src/utils.ts Show resolved Hide resolved

tatomyr added the deploy_s3_sandbox label Feb 16, 2024

IgorKarpiuk mentioned this pull request Feb 16, 2024

chore: do not update domain env variable from code #1423

Closed

4 tasks

malis42 added deploy_s3_sandbox and removed deploy_s3_sandbox labels Feb 16, 2024

HCloward reviewed Feb 16, 2024

View reviewed changes

.changeset/great-stingrays-unite.md Outdated Show resolved Hide resolved

IgorKarpiuk approved these changes Feb 20, 2024

View reviewed changes

tatomyr added deploy_s3_sandbox and removed deploy_s3_sandbox labels Feb 20, 2024

tatomyr reviewed Feb 20, 2024

View reviewed changes

packages/core/src/redocly/domains.ts Outdated Show resolved Hide resolved

tatomyr approved these changes Feb 29, 2024

View reviewed changes

malis42 added 10 commits February 29, 2024 12:36

fix: add https-proxy-agent to fetch requests

9840636

fix: move domains submodule to separate file

ea0c9a4

fix: fix issues with imports for core package and domains submodule

a58444f

fix: add changeset, add one rule to sidebar docs, prettier fixes

7f9462f

fix: create utils getter function for proxy agent, small refactors

75189ae

fix: fix issue with import

fd5ee45

fix: prettier fix

c01574e

fix: fix issues with unit mocks, revert change to custom rule docs

e12032e

fix: changeset fix

3791489

fix: fix issue with base url for token validation, add try catch bloc…

d44d82e

…k for push command auth check, small refactors

malis42 and others added 10 commits February 29, 2024 12:38

fix: prettier fixes, add new test file for domains to improve coverage

e40150d

fix: add proxy agent to api-client rqeuests

0685870

fix: tests fix

e7965d1

fix: change error message to more generic one

7c5e11c

fix: move domains to /redocly dir, add docs, install https-proxy-agen…

1d5ac1a

…t in packages/core

fix: remove https-proxy-agent from package.json in cli, move domain t…

1176b4d

…ests to redocly dir

fix: prettier fix

b31cea7

Update .changeset/great-stingrays-unite.md

b7e107c

Co-authored-by: Heather Cloward <[email protected]>

fix: prettier fix

7b7680f

fix: change variable name from screaming case to camel case

50f5541

malis42 force-pushed the fix/https-proxy-issues-fix branch from 368c353 to 50f5541 Compare February 29, 2024 11:40

malis42 merged commit 2639dc4 into main Feb 29, 2024
31 checks passed

malis42 deleted the fix/https-proxy-issues-fix branch February 29, 2024 11:55

RomanHotsiy added a commit that referenced this pull request Feb 29, 2024

Revert "fix: add https-proxy-agent to fetch requests (#1433)"

8b9f666

This reverts commit 2639dc4.

RomanHotsiy mentioned this pull request Feb 29, 2024

Revert "fix: add https-proxy-agent to fetch requests" #1458

Merged

RomanHotsiy added a commit that referenced this pull request Feb 29, 2024

Revert "fix: add https-proxy-agent to fetch requests (#1433)" (#1458)

93e42db

This reverts commit 2639dc4.

malis42 added a commit that referenced this pull request Feb 29, 2024

Reapply "fix: add https-proxy-agent to fetch requests (#1433)" (#1458)

a756aac

This reverts commit 93e42db.

malis42 mentioned this pull request Feb 29, 2024

fix: fix issues with https-agent-proxy for cli and openapi-core packages #1461

Merged

5 tasks

malis42 mentioned this pull request Mar 20, 2024

fix: fix issues with https-agent-proxy for cli and openapi-core packages #1493

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: add https-proxy-agent to fetch requests #1433

fix: add https-proxy-agent to fetch requests #1433

malis42 commented Feb 13, 2024 •

edited

Loading

changeset-bot bot commented Feb 13, 2024 •

edited

Loading

github-actions bot commented Feb 13, 2024 •

edited

Loading

github-actions bot commented Feb 13, 2024 •

edited

Loading

lornajane commented Feb 13, 2024

tatomyr left a comment •

edited

Loading

github-actions bot commented Feb 16, 2024 •

edited

Loading

IgorKarpiuk left a comment

tatomyr left a comment

fix: add https-proxy-agent to fetch requests #1433

fix: add https-proxy-agent to fetch requests #1433

Conversation

malis42 commented Feb 13, 2024 • edited Loading

What/Why/How?

Reference

Testing

Screenshots (optional)

Has code been changed?

Check yourself

Security

changeset-bot bot commented Feb 13, 2024 • edited Loading

🦋 Changeset detected

github-actions bot commented Feb 13, 2024 • edited Loading

github-actions bot commented Feb 13, 2024 • edited Loading

Coverage report

Test suite run success

lornajane commented Feb 13, 2024

tatomyr left a comment • edited Loading

Choose a reason for hiding this comment

github-actions bot commented Feb 16, 2024 • edited Loading

IgorKarpiuk left a comment

Choose a reason for hiding this comment

tatomyr left a comment

Choose a reason for hiding this comment

malis42 commented Feb 13, 2024 •

edited

Loading

changeset-bot bot commented Feb 13, 2024 •

edited

Loading

github-actions bot commented Feb 13, 2024 •

edited

Loading

github-actions bot commented Feb 13, 2024 •

edited

Loading

tatomyr left a comment •

edited

Loading

github-actions bot commented Feb 16, 2024 •

edited

Loading