fix(debugger): accept arbitrary ip and port as NODE_OPTIONS #53683

HelmerBarcos · 2023-08-07T15:09:55Z

What?

This enables debugging sessions from a remote host. This is helpful while debugging a Next.js application that runs inside a Docker container with following possibilities inside the package.json:

    "dev": "NODE_OPTIONS='--inspect=localhost:9250' next dev",
    "dev": "NODE_OPTIONS='--inspect=co.localhost:9250' next dev",
    "dev": "NODE_OPTIONS='--inspect=barcos.co:9250' next dev",
    "dev": "NODE_OPTIONS='--inspect=barcos.co.co.hzoe.com:9250' next dev",
    "dev": "NODE_OPTIONS='--inspect=0.0.0.0:9250' next dev",
    "dev": "NODE_OPTIONS='--inspect=9250' next dev",
    "dev": "NODE_OPTIONS='--inspect' next dev",
    "dev": "NODE_OPTIONS='--inspect=127.0.0.1:9250' next dev",

Bug

This fixes:

Other "fixed" bugs

Why?

It was an attempt to fix the bug, but it didn't work for all the cases.

fix: NODE_OPTIONS='--inspect' in next dev for debugging #48019

Keep in mind that the default host will be 127.0.0.1, and this will be blocked for external hosts trying to attach to the debugger. The NODE_OPTIONS should be set to NODE_OPTIONS='--inspect=0.0.0.0:SOME_PORT'.
https://nodejs.org/en/docs/guides/debugging-getting-started#security-implications

vleeuwenmenno · 2023-08-09T21:16:43Z

Is there a version we can use that does not have the bug that is fixed in this PR?
This PR needs priority ...

timmywil · 2023-08-21T15:20:36Z

Agreed, would be great to prioritize this issue and get a fix in 13.4.20.

Update ports exposed, and run the next server with inspect flag Currently does not work due to bug in next.js See related PR: vercel/next.js#53683

wyattjoh · 2023-08-31T15:59:59Z

test/integration/cli/test/index.test.js

+    const testAllIPsAndPorts = async (someIp) => {
+      const testIps = [
+        '0.0.0.0',
+        '127.0.0.1',
+        'localhost',
+        '192.168.18.90',
+        'barcos.co',
+        'app.barcos.co',
+      ]
+      for (const someIp of testIps) {
+        const port = await findPort()
+        test(`NODE_OPTIONS='--inspect=${someIp}:${port}'`, async () => {
+          let output = ''
+          const app = await runNextCommandDev(
+            [dirBasic, '--port', port],
+            undefined,
+            {
+              onStdout(msg) {
+                output += stripAnsi(msg)
+              },
+              env: { NODE_OPTIONS: `--inspect=${someIp}:${port}` },
+            }
+          )
+          try {
+            await check(() => output, new RegExp(`on ${someIp}:${port}`))
+            await check(() => output, new RegExp(`http://${someIp}:${port}`))
+          } finally {
+            await killApp(app)
+          }
+        })
+      }
+    }
+
+    testAllIPsAndPorts()
+


Looks good! But test case names should be determanistic, not dynamically generated.

Could you update this such that the for loop is inside the test case? So you would have something like:

test("NODE_OPTIONS='--inspect=<host>:<port>'", async () => { const hosts = [ '0.0.0.0', '127.0.0.1', 'localhost', '192.168.18.90', 'barcos.co', 'app.barcos.co', null, ] for (const host of hosts) { const port = await findPort() // ... } })

Thanks. I made the changes just a couple of minutes ago; I had a lot of work to do

@wyattjoh, do I need to do anything else? This MR could be beneficial for many developers who prefer not to debug using console logs.

mkoreo · 2023-10-17T10:57:35Z

Is there a version we can use that does not have the bug that is fixed in this PR? This PR needs priority ...

Indeed, this issue has been going on for 7-8 months now in which it is completely impossible to debug next.js in a docker container. Is it possible to give the review of these 10 lines of code priority?

timneutkens · 2023-10-17T11:05:48Z

The PR was already reviewed but the comments were not addressed yet, so this can't be landed as-is. Feel free to open a new PR based on this one to fix that, happy to land it when the comments are addressed.

HelmerBarcos · 2023-10-23T16:49:28Z

@timneutkens @wyattjoh How I said I had a lot of work to do. But now the MR should be ready to merge

gaac510 · 2023-11-07T10:50:37Z

Is there a version we can use that does not have the bug that is fixed in this PR?

Hope it's OK to ask this question again, since this PR appears to be held up again.

HelmerBarcos · 2023-11-09T11:51:44Z

Any updates for this PR?

ijjk · 2023-11-12T09:25:35Z

Allow CI Workflow Run

approve CI run for commit: c2473a2

Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer

ijjk · 2023-11-12T09:25:36Z

Allow CI Workflow Run

approve CI run for commit: c2473a2

Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer

simonstaton · 2023-11-14T13:37:58Z

Any update on this? Currently it's impossible to debug a NextJS application running in a docker container.

HelmerBarcos · 2023-11-20T15:43:22Z

Should I do anything? I don't see any approvals or changes requested after 1 month.

mkoreo · 2023-12-02T10:10:50Z

@timneutkens Hey, could you have another look at this PR? I believe @HelmerBarcos has addressed the remarks.

mark-davenport-fountain · 2024-01-03T14:45:45Z

I didn't see this PR before opening a very similar one here - #59410

The only real difference I think is that I've also added ability to set the host. It didn't look like this is actually passing along the host to NODE_OPTIONS. I pulled the tests over from this PR to mine as well.

Not a concern to me which one gets merged, but it'd be nice to get this in so that we can have debugging supported in docker containers.

HelmerBarcos · 2024-01-20T13:44:13Z

Im closing this PR and opening a new one. See #60919

HelmerBarcos requested review from timneutkens, ijjk, shuding, huozhi, feedthejim and ztanner as code owners August 7, 2023 15:09

ijjk added area: tests type: next labels Aug 7, 2023

HelmerBarcos force-pushed the FIX_DEBUGGER_PORT branch 6 times, most recently from 214fdfb to 5541fa2 Compare August 9, 2023 19:40

SatsAllDay mentioned this pull request Aug 28, 2023

WIP: Support server-side debugging when running local in docker stackernews/stacker.news#450

Open

HelmerBarcos force-pushed the FIX_DEBUGGER_PORT branch from 5541fa2 to 0001765 Compare August 31, 2023 08:53

HelmerBarcos requested a review from wyattjoh as a code owner August 31, 2023 08:53

wyattjoh requested changes Aug 31, 2023

View reviewed changes

HelmerBarcos requested review from wyattjoh and Tannerrea October 23, 2023 16:32

HelmerBarcos force-pushed the FIX_DEBUGGER_PORT branch from b9dd6ac to dd509c2 Compare October 23, 2023 16:46

HelmerBarcos force-pushed the FIX_DEBUGGER_PORT branch 3 times, most recently from 894d346 to c2473a2 Compare October 25, 2023 20:46

HelmerBarcos changed the title ~~fix(debugger): accept arbitrary ip an port as NODE_OPTIONS~~ fix(debugger): accept arbitrary ip and port as NODE_OPTIONS Nov 1, 2023

timneutkens added the CI approved Approve running CI for fork label Nov 12, 2023

simonstaton approved these changes Nov 14, 2023

View reviewed changes

HelmerBarcos force-pushed the FIX_DEBUGGER_PORT branch from c2473a2 to 691c68f Compare December 21, 2023 17:57

HelmerBarcos added 2 commits January 20, 2024 14:39

fix(debugger): accept arbitrary ip an port as NODE_OPTIONS

5dcb5f5

chore: making test determanistic

2d0af87

HelmerBarcos force-pushed the FIX_DEBUGGER_PORT branch from 691c68f to 2d0af87 Compare January 20, 2024 13:39

HelmerBarcos closed this Jan 20, 2024

HelmerBarcos mentioned this pull request Jan 20, 2024

Fix debugger port #60919

Closed

github-actions bot added the locked label Feb 4, 2024

github-actions bot locked as resolved and limited conversation to collaborators Feb 4, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(debugger): accept arbitrary ip and port as NODE_OPTIONS #53683

fix(debugger): accept arbitrary ip and port as NODE_OPTIONS #53683

HelmerBarcos commented Aug 7, 2023 •

edited

Loading

vleeuwenmenno commented Aug 9, 2023

timmywil commented Aug 21, 2023

wyattjoh Aug 31, 2023

HelmerBarcos Oct 23, 2023 •

edited

Loading

HelmerBarcos Dec 21, 2023

mkoreo commented Oct 17, 2023

timneutkens commented Oct 17, 2023

HelmerBarcos commented Oct 23, 2023

gaac510 commented Nov 7, 2023

HelmerBarcos commented Nov 9, 2023 •

edited

Loading

ijjk commented Nov 12, 2023

ijjk commented Nov 12, 2023

simonstaton commented Nov 14, 2023 •

edited

Loading

HelmerBarcos commented Nov 20, 2023

mkoreo commented Dec 2, 2023

mark-davenport-fountain commented Jan 3, 2024

HelmerBarcos commented Jan 20, 2024 •

edited

Loading

fix(debugger): accept arbitrary ip and port as NODE_OPTIONS #53683

fix(debugger): accept arbitrary ip and port as NODE_OPTIONS #53683

Conversation

HelmerBarcos commented Aug 7, 2023 • edited Loading

What?

Bug

Why?

vleeuwenmenno commented Aug 9, 2023

timmywil commented Aug 21, 2023

wyattjoh Aug 31, 2023

Choose a reason for hiding this comment

HelmerBarcos Oct 23, 2023 • edited Loading

Choose a reason for hiding this comment

HelmerBarcos Dec 21, 2023

Choose a reason for hiding this comment

mkoreo commented Oct 17, 2023

timneutkens commented Oct 17, 2023

HelmerBarcos commented Oct 23, 2023

gaac510 commented Nov 7, 2023

HelmerBarcos commented Nov 9, 2023 • edited Loading

ijjk commented Nov 12, 2023

ijjk commented Nov 12, 2023

simonstaton commented Nov 14, 2023 • edited Loading

HelmerBarcos commented Nov 20, 2023

mkoreo commented Dec 2, 2023

mark-davenport-fountain commented Jan 3, 2024

HelmerBarcos commented Jan 20, 2024 • edited Loading

HelmerBarcos commented Aug 7, 2023 •

edited

Loading

HelmerBarcos Oct 23, 2023 •

edited

Loading

HelmerBarcos commented Nov 9, 2023 •

edited

Loading

simonstaton commented Nov 14, 2023 •

edited

Loading

HelmerBarcos commented Jan 20, 2024 •

edited

Loading