Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow disabling HTTP request logs in dev server #74349

Open
wants to merge 9 commits into
base: canary
Choose a base branch
from

Conversation

mohsen1
Copy link
Contributor

@mohsen1 mohsen1 commented Dec 28, 2024

This PR introduces a way to filter or disable incoming request logs in development. It adds a new incomingRequest option to loggingConfig, supporting both a simple boolean toggle and a configurable ignore. By default, logs remain enabled, preserving existing behavior.

Notes:
loggingConfig.incomingRequest = false fully disables incoming request logs.
loggingConfig.incomingRequest.ignore accepts a regular expressions array to selectively silence logs.
• Covered by unit tests (shouldLogIncomingRequest)

Resolves the dev server’s verbose logging problem discussed in #65992 and complements the effort in #67590.

@ijjk
Copy link
Member

ijjk commented Dec 28, 2024

Allow CI Workflow Run

  • approve CI run for commit: bc8aed5

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

@mohsen1 mohsen1 force-pushed the add-dev-request-logging-ignoring branch from 81f16af to bc8aed5 Compare December 28, 2024 15:51
@huksley
Copy link

huksley commented Dec 29, 2024

IMO, should be called logging.requestTracing sunce it shows both incoming request and response

@mohsen1
Copy link
Contributor Author

mohsen1 commented Jan 2, 2025

Tracing and logging are different concepts. Tracing usually involves keeping track of a request journey and storing it somewhere. Logging is simpler, just print requests that are happening.

@ijjk ijjk requested a review from huozhi January 2, 2025 19:03
@huozhi huozhi added the CI approved Approve running CI for fork label Jan 13, 2025
Copy link
Member

@huozhi huozhi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We also need an e2e development test for this option

packages/next/src/server/dev/log-requests.ts Outdated Show resolved Hide resolved
packages/next/src/server/dev/log-requests.ts Outdated Show resolved Hide resolved
packages/next/src/server/config-shared.ts Outdated Show resolved Hide resolved
packages/next/src/server/config-shared.ts Outdated Show resolved Hide resolved
packages/next/src/server/config-shared.ts Outdated Show resolved Hide resolved
@ijjk ijjk added the tests label Jan 14, 2025
@ijjk
Copy link
Member

ijjk commented Jan 14, 2025

Tests Passed

@ijjk
Copy link
Member

ijjk commented Jan 14, 2025

Stats from current PR

Default Build
General
vercel/next.js canary mohsen1/next.js add-dev-request-logging-ignoring Change
buildDuration 17.1s 18.3s ⚠️ +1.2s
buildDurationCached 14.4s 12.2s N/A
nodeModulesSize 418 MB 418 MB N/A
nextStartRea..uration (ms) 395ms 393ms N/A
Client Bundles (main, webpack)
vercel/next.js canary mohsen1/next.js add-dev-request-logging-ignoring Change
5306-HASH.js gzip 54 kB 53.9 kB N/A
8276.HASH.js gzip 169 B 168 B N/A
8377-HASH.js gzip 5.44 kB 5.44 kB N/A
bccd1874-HASH.js gzip 52.9 kB 52.9 kB N/A
framework-HASH.js gzip 57.5 kB 57.5 kB N/A
main-app-HASH.js gzip 240 B 242 B N/A
main-HASH.js gzip 34.3 kB 34.2 kB N/A
webpack-HASH.js gzip 1.71 kB 1.71 kB N/A
Overall change 0 B 0 B
Legacy Client Bundles (polyfills)
vercel/next.js canary mohsen1/next.js add-dev-request-logging-ignoring Change
polyfills-HASH.js gzip 39.4 kB 39.4 kB
Overall change 39.4 kB 39.4 kB
Client Pages
vercel/next.js canary mohsen1/next.js add-dev-request-logging-ignoring Change
_app-HASH.js gzip 193 B 193 B
_error-HASH.js gzip 193 B 193 B
amp-HASH.js gzip 512 B 510 B N/A
css-HASH.js gzip 343 B 342 B N/A
dynamic-HASH.js gzip 1.84 kB 1.84 kB
edge-ssr-HASH.js gzip 265 B 265 B
head-HASH.js gzip 363 B 362 B N/A
hooks-HASH.js gzip 393 B 392 B N/A
image-HASH.js gzip 4.57 kB 4.57 kB N/A
index-HASH.js gzip 268 B 268 B
link-HASH.js gzip 2.35 kB 2.34 kB N/A
routerDirect..HASH.js gzip 328 B 328 B
script-HASH.js gzip 397 B 397 B
withRouter-HASH.js gzip 323 B 326 B N/A
1afbb74e6ecf..834.css gzip 106 B 106 B
Overall change 3.59 kB 3.59 kB
Client Build Manifests
vercel/next.js canary mohsen1/next.js add-dev-request-logging-ignoring Change
_buildManifest.js gzip 749 B 747 B N/A
Overall change 0 B 0 B
Rendered Page Sizes
vercel/next.js canary mohsen1/next.js add-dev-request-logging-ignoring Change
index.html gzip 524 B 524 B
link.html gzip 539 B 538 B N/A
withRouter.html gzip 520 B 520 B
Overall change 1.04 kB 1.04 kB
Edge SSR bundle Size
vercel/next.js canary mohsen1/next.js add-dev-request-logging-ignoring Change
edge-ssr.js gzip 129 kB 129 kB N/A
page.js gzip 208 kB 208 kB N/A
Overall change 0 B 0 B
Middleware size
vercel/next.js canary mohsen1/next.js add-dev-request-logging-ignoring Change
middleware-b..fest.js gzip 670 B 667 B N/A
middleware-r..fest.js gzip 155 B 156 B N/A
middleware.js gzip 31.3 kB 31.3 kB N/A
edge-runtime..pack.js gzip 844 B 844 B
Overall change 844 B 844 B
Next Runtimes
vercel/next.js canary mohsen1/next.js add-dev-request-logging-ignoring Change
274-experime...dev.js gzip 322 B 322 B
274.runtime.dev.js gzip 314 B 314 B
app-page-exp...dev.js gzip 374 kB 374 kB N/A
app-page-exp..prod.js gzip 130 kB 130 kB N/A
app-page-tur..prod.js gzip 143 kB 143 kB N/A
app-page-tur..prod.js gzip 139 kB 139 kB N/A
app-page.run...dev.js gzip 362 kB 362 kB N/A
app-page.run..prod.js gzip 126 kB 126 kB N/A
app-route-ex...dev.js gzip 37.6 kB 37.6 kB N/A
app-route-ex..prod.js gzip 25.6 kB 25.6 kB N/A
app-route-tu..prod.js gzip 25.6 kB 25.6 kB N/A
app-route-tu..prod.js gzip 25.4 kB 25.4 kB N/A
app-route.ru...dev.js gzip 39.2 kB 39.2 kB
app-route.ru..prod.js gzip 25.4 kB 25.4 kB N/A
pages-api-tu..prod.js gzip 9.69 kB 9.69 kB
pages-api.ru...dev.js gzip 11.6 kB 11.6 kB
pages-api.ru..prod.js gzip 9.68 kB 9.68 kB
pages-turbo...prod.js gzip 21.8 kB 21.7 kB N/A
pages.runtim...dev.js gzip 27.6 kB 27.5 kB N/A
pages.runtim..prod.js gzip 21.8 kB 21.7 kB N/A
server.runti..prod.js gzip 916 kB 916 kB N/A
Overall change 70.8 kB 70.8 kB
build cache
vercel/next.js canary mohsen1/next.js add-dev-request-logging-ignoring Change
0.pack gzip 2.1 MB 2.1 MB N/A
index.pack gzip 75.3 kB 75.2 kB N/A
Overall change 0 B 0 B
Diff details
Diff for edge-ssr.js

Diff too large to display

Diff for 5306-HASH.js

Diff too large to display

Diff for main-HASH.js

Diff too large to display

Diff for app-page-exp..ntime.dev.js
failed to diff
Diff for app-page-exp..time.prod.js

Diff too large to display

Diff for app-page-tur..time.prod.js

Diff too large to display

Diff for app-page-tur..time.prod.js

Diff too large to display

Diff for app-page.runtime.dev.js
failed to diff
Diff for app-page.runtime.prod.js

Diff too large to display

Diff for pages-turbo...time.prod.js

Diff too large to display

Diff for pages.runtime.dev.js

Diff too large to display

Diff for pages.runtime.prod.js

Diff too large to display

Diff for server.runtime.prod.js
failed to diff
Commit: c4b964a

@mohsen1
Copy link
Contributor Author

mohsen1 commented Jan 14, 2025

The above failure is likely unrelated to my change. It's surprisingly passing on my machine so it might be flaky.

I found a bug that is likely causing this instability. This diff should make it more stable

diff --git packages/react-refresh-utils/internal/helpers.ts packages/react-refresh-utils/internal/helpers.ts
index fd26cc0599..1f7a63b6e6 100644
--- packages/react-refresh-utils/internal/helpers.ts
+++ packages/react-refresh-utils/internal/helpers.ts
@@ -63,6 +63,11 @@ function registerExportsForReactRefresh(
   moduleExports: unknown,
   moduleID: string
 ) {
+  // Skip registration if this module was already registered
+  if (RefreshRuntime.isRegisteredForRefresh(moduleID + ' %exports%')) {
+    return
+  }
+
   RefreshRuntime.register(moduleExports, moduleID + ' %exports%')
   if (moduleExports == null || typeof moduleExports !== 'object') {
     // Exit if we can't iterate over exports.

The issue appears to be in the React Refresh implementation. When we add the default export to bar.js, it becomes a React Refresh boundary (due to exporting a component). This causes the module to be initialized twice:
Once during the initial module evaluation

@mohsen1 mohsen1 force-pushed the add-dev-request-logging-ignoring branch from 48da0ca to 362b62b Compare January 14, 2025 14:37
@ijjk ijjk added the examples Issue was opened via the examples template. label Jan 14, 2025
@mohsen1 mohsen1 force-pushed the add-dev-request-logging-ignoring branch 2 times, most recently from e072846 to edc2b65 Compare January 15, 2025 06:38
@mohsen1 mohsen1 force-pushed the add-dev-request-logging-ignoring branch from 4913050 to 908a7a5 Compare January 15, 2025 06:56
@mohsen1
Copy link
Contributor Author

mohsen1 commented Jan 15, 2025

@huozhi PTAL

@ijjk ijjk added the Documentation Related to Next.js' official documentation. label Jan 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI approved Approve running CI for fork Documentation Related to Next.js' official documentation. examples Issue was opened via the examples template. tests type: next
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants