enhancement!: use server.globalProxy value for creating a global http/https proxy #20416

innerdvations · 2024-05-31T16:08:12Z

What does it do?

Move server.proxy to server.proxy.koa
Move server.globalProxy to server.proxy.global
add server.proxy.fetch to act only on Fetch requests (defaults to proxy.global if set)
add server.proxy.http to act on http requests (defaults to proxy.global if set)
add server.proxy.https to act on https requests (defaults to proxy.global if set)

This

Why is it needed?

Allows proxy of all http and https requests globally (including anything that uses http/https internally, such as axios, passport-oauth2, etc, giving Strapi an actual global proxy to solve issues like proxied SSO

How to test it?

set server.proxy.global (or ad individual value) in your config
use something like npx http-echo-server to create an echo proxy
set up SSO (or whatever feature you want to test proxied)
when you use SSO, you should see it proxied through your echo server
fetch requests (such as telemetry) should still come through to the echo proxy

Related issue(s)/PR(s)

Fixes #17317

DX-989

Documentation PR: strapi/documentation#2124

TODO:

write a codemod to migrate server.proxy -> server.proxy.koa and server.globalProxy -> server.proxy.global which will come in a later PR

vercel · 2024-05-31T16:09:28Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
contributor-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 13, 2024 9:40am

derrickmehaffy · 2024-05-31T18:07:23Z

Building exp release: https://github.com/strapi/strapi/actions/runs/9322440851

derrickmehaffy · 2024-05-31T18:12:36Z

@innerdvations looks like we are getting build failures with @strapi/core:

innerdvations · 2024-06-03T06:49:40Z

@innerdvations looks like we are getting build failures with @strapi/core:

Ugh, very sorry! I missed a last minute version bump on undici. It builds now.

derrickmehaffy · 2024-06-03T07:33:09Z

Can you run a new exp version build Ben and I'll at in the morning

derrickmehaffy · 2024-06-03T17:26:00Z

new exp: https://github.com/strapi/strapi/actions/runs/9354606706

derrickmehaffy · 2024-06-04T15:40:36Z

exp version: 0.0.0-experimental.c3e9d4b26f9fd3d9eb530b5c11f9baa1d09b13ad

derrickmehaffy · 2024-06-04T16:13:09Z

Something I noticed so far is that image thumbails loaded by the media lib are not passing through the proxy:

Will continue to test for patching of SSO

innerdvations · 2024-06-05T07:09:28Z

Something I noticed so far is that image thumbails loaded by the media lib are not passing through the proxy:

I haven't looked into how they're loaded. If they're essentially an img src so it would make sense not to pass through the proxy. If we have something where the server is pulling them from the remote bucket and then sending them to the user, that should go through the proxy, but I'll consider it a separate issue and address it later.

derrickmehaffy · 2024-06-05T13:13:46Z

Something I noticed so far is that image thumbails loaded by the media lib are not passing through the proxy:

I haven't looked into how they're loaded. If they're essentially an img src so it would make sense not to pass through the proxy. If we have something where the server is pulling them from the remote bucket and then sending them to the user, that should go through the proxy, but I'll consider it a separate issue and address it later.

Ah yeah your probably right ignore me

derrickmehaffy

Looking good! these are the logs from my squid proxy:

into enhancement/sso-proxy

Convly

The code LGTM, one small comment.

I couldn't test the actual behavior as I don't have the correct setup.

Convly · 2024-06-13T10:16:47Z

packages/core/core/src/services/server/index.ts

@@ -17,7 +17,7 @@ const healthCheck: Core.MiddlewareHandler = async (ctx) => {

 const createServer = (strapi: Core.Strapi): Modules.Server.Server => {
  const app = createKoaApp({
-    proxy: strapi.config.get('server.proxy'),


Shouldn't this change have a dedicated codemod?

If it's meant for another PR, could we add a TODO so that we don't forget?

yep, already created a jira ticket but I'll mention it here too

Hum if we just have strapi.proxy set can't we consider that it's should be the proxy applied for everything like a shorthand version ? that could be super convenient 🤔

I don't have time to write tests for it before I'm off, but I did this as a follow-up convenience feature, and someone can hopefully finish it and update the docs: #20537

Oh wait, I think I completely misunderstood. You mean the strapi.proxy could be like string | { fetch, http, https, koa } and if it's a string it is treated as global?

innerdvations · 2024-06-13T10:20:44Z

I couldn't test the actual behavior as I don't have the correct setup.

You can test it generally using http-proxy-server, for example that the fetch option still works. Also, if you write some custom code and send a request using the http or https modules, those should also get proxied.

For the more advanced stuff like testing that SSO works through a proxy, I'm hoping @derrickmehaffy will be able to give it one final QA once the code has settled before we merge.

Bassel17

LGTM code wise, just left a small suggestion

Bassel17 · 2024-06-13T12:34:12Z

packages/core/core/src/utils/fetch.ts

-  const globalProxy =
-    strapi.config.get<ConstructorParameters<typeof ProxyAgent>[0]>('server.globalProxy');
+  const proxy =
+    strapi.config.get<ConstructorParameters<typeof ProxyAgent>[0]>('server.proxy.fetch') ||


I was wondering if it will be clearer to add a type alias for this ConstructorParameters<typeof ProxyAgent>[0]
will leave it for you to decided otherwise looks good

enhancement: use globalProxy for all http or https requests

3ced0ab

innerdvations added pr: enhancement This PR adds or updates some part of the codebase or features source: core:core Source is core/core labels May 31, 2024

innerdvations requested a review from derrickmehaffy May 31, 2024 16:08

chore: clean up imports

4edd957

vercel bot had a problem deploying to Preview – contributor-docs May 31, 2024 16:18 Failure

vercel bot had a problem deploying to Preview – helper-plugin-storybook May 31, 2024 16:18 Failure

fix: undici version

52e58ca

vercel bot had a problem deploying to Preview – helper-plugin-storybook June 3, 2024 06:49 Failure

Merge branch 'v5/main' into enhancement/sso-proxy

3c73a4c

vercel bot deployed to Preview – contributor-docs June 3, 2024 07:05 View deployment

vercel bot had a problem deploying to Preview – helper-plugin-storybook June 3, 2024 07:05 Failure

chore: linting

517c241

vercel bot deployed to Preview – contributor-docs June 3, 2024 07:59 View deployment

vercel bot had a problem deploying to Preview – helper-plugin-storybook June 3, 2024 07:59 Failure

Merge branch 'v5/main' into enhancement/sso-proxy

c3e9d4b

vercel bot had a problem deploying to Preview – helper-plugin-storybook June 3, 2024 15:56 Failure

vercel bot deployed to Preview – contributor-docs June 3, 2024 16:02 View deployment

Merge branch 'v5/main' into enhancement/sso-proxy

3b6ee56

vercel bot deployed to Preview – contributor-docs June 5, 2024 08:08 View deployment

vercel bot had a problem deploying to Preview – helper-plugin-storybook June 5, 2024 08:09 Failure

Merge branch 'v5/main' into enhancement/sso-proxy

a007ac1

vercel bot had a problem deploying to Preview – helper-plugin-storybook June 11, 2024 11:31 Failure

vercel bot deployed to Preview – contributor-docs June 11, 2024 11:37 View deployment

derrickmehaffy approved these changes Jun 11, 2024

View reviewed changes

innerdvations mentioned this pull request Jun 13, 2024

Add new proxy configuration feature strapi/documentation#2124

Merged

innerdvations and others added 3 commits June 13, 2024 11:14

Merge branch 'v5/main' into enhancement/sso-proxy

2099dbe

enhancement: custom server config for each proxy value

d89eeb7

Merge branch 'enhancement/sso-proxy' of https://github.com/strapi/strapi

0e20f60

into enhancement/sso-proxy

innerdvations marked this pull request as ready for review June 13, 2024 09:19

fix: use server.proxy.koa for koa proxy value

f1ec726

innerdvations requested review from alexandrebodin, Convly, jhoward1994 and Bassel17 June 13, 2024 09:23

vercel bot deployed to Preview – contributor-docs June 13, 2024 09:32 View deployment

vercel bot had a problem deploying to Preview – helper-plugin-storybook June 13, 2024 09:32 Failure

fix: remove unneeded async

cee0ba1

innerdvations added the flag: 💥 Breaking change This PR contains breaking changes and should not be merged label Jun 13, 2024

vercel bot deployed to Preview – contributor-docs June 13, 2024 09:40 View deployment

vercel bot had a problem deploying to Preview – helper-plugin-storybook June 13, 2024 09:40 Failure

Convly reviewed Jun 13, 2024

View reviewed changes

Bassel17 approved these changes Jun 13, 2024

View reviewed changes

innerdvations mentioned this pull request Jun 17, 2024

enhancement: set app.proxy automatically if proxy is set #20537

Draft

2 tasks

innerdvations merged commit 60e1f8b into v5/main Jun 17, 2024
75 of 83 checks passed

innerdvations deleted the enhancement/sso-proxy branch June 17, 2024 11:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

enhancement!: use server.globalProxy value for creating a global http/https proxy #20416

enhancement!: use server.globalProxy value for creating a global http/https proxy #20416

innerdvations commented May 31, 2024 •

edited

Loading

vercel bot commented May 31, 2024 •

edited

Loading

derrickmehaffy commented May 31, 2024

derrickmehaffy commented May 31, 2024

innerdvations commented Jun 3, 2024

derrickmehaffy commented Jun 3, 2024

derrickmehaffy commented Jun 3, 2024

derrickmehaffy commented Jun 4, 2024

derrickmehaffy commented Jun 4, 2024

innerdvations commented Jun 5, 2024 •

edited

Loading

derrickmehaffy commented Jun 5, 2024

derrickmehaffy left a comment

Convly left a comment

Convly Jun 13, 2024

innerdvations Jun 13, 2024

alexandrebodin Jun 17, 2024

innerdvations Jun 17, 2024

innerdvations Jun 18, 2024 •

edited

Loading

innerdvations commented Jun 13, 2024

Bassel17 left a comment

Bassel17 Jun 13, 2024

enhancement!: use server.globalProxy value for creating a global http/https proxy #20416

enhancement!: use server.globalProxy value for creating a global http/https proxy #20416

Conversation

innerdvations commented May 31, 2024 • edited Loading

What does it do?

Why is it needed?

How to test it?

Related issue(s)/PR(s)

vercel bot commented May 31, 2024 • edited Loading

derrickmehaffy commented May 31, 2024

derrickmehaffy commented May 31, 2024

innerdvations commented Jun 3, 2024

derrickmehaffy commented Jun 3, 2024

derrickmehaffy commented Jun 3, 2024

derrickmehaffy commented Jun 4, 2024

derrickmehaffy commented Jun 4, 2024

innerdvations commented Jun 5, 2024 • edited Loading

derrickmehaffy commented Jun 5, 2024

derrickmehaffy left a comment

Choose a reason for hiding this comment

Convly left a comment

Choose a reason for hiding this comment

Convly Jun 13, 2024

Choose a reason for hiding this comment

innerdvations Jun 13, 2024

Choose a reason for hiding this comment

alexandrebodin Jun 17, 2024

Choose a reason for hiding this comment

innerdvations Jun 17, 2024

Choose a reason for hiding this comment

innerdvations Jun 18, 2024 • edited Loading

Choose a reason for hiding this comment

innerdvations commented Jun 13, 2024

Bassel17 left a comment

Choose a reason for hiding this comment

Bassel17 Jun 13, 2024

Choose a reason for hiding this comment

innerdvations commented May 31, 2024 •

edited

Loading

vercel bot commented May 31, 2024 •

edited

Loading

innerdvations commented Jun 5, 2024 •

edited

Loading

innerdvations Jun 18, 2024 •

edited

Loading