feat: hide x-opennext header from server requests when poweredByHeader is false (opennextjs#567)

* add: poweredByHeader can hide x-opennext header from server requests

* add e2e test

* add changeset

* Revert "add changeset"

This reverts commit 8cbd733.

* add changeset in the root folder

Author: sommeeeer

.changeset/giant-vans-shop.md

@@ -0,0 +1,5 @@
+---
+"@opennextjs/aws": patch
+---
+
+Hides the x-opennext header from server requests when poweredByHeader is false in next config

examples/pages-router/next.config.js

@@ -53,6 +53,7 @@ const nextConfig = {
     },
   ],
   trailingSlash: true,
+  poweredByHeader: true,
 };
 
 module.exports = nextConfig;

packages/open-next/src/core/routing/util.ts

@@ -2,7 +2,7 @@ import crypto from "node:crypto";
 import { OutgoingHttpHeaders } from "node:http";
 import { Readable } from "node:stream";
 
-import { BuildId, HtmlPages } from "config/index.js";
+import { BuildId, HtmlPages, NextConfig } from "config/index.js";
 import type { IncomingMessage, StreamCreator } from "http/index.js";
 import { OpenNextNodeResponse } from "http/openNextResponse.js";
 import { parseHeaders } from "http/util.js";
@@ -322,7 +322,9 @@ export function fixSWRCacheHeader(headers: OutgoingHttpHeaders) {
  * @__PURE__
  */
 export function addOpenNextHeader(headers: OutgoingHttpHeaders) {
-  headers["X-OpenNext"] = "1";
+  if (NextConfig.poweredByHeader) {
+    headers["X-OpenNext"] = "1";
+  }
   if (globalThis.openNextDebug) {
     headers["X-OpenNext-Version"] = globalThis.openNextVersion;
     headers["X-OpenNext-RequestId"] = globalThis.__als.getStore()?.requestId;

packages/open-next/src/types/next-types.ts

@@ -75,6 +75,7 @@ export interface NextConfig {
     appDir?: boolean;
   };
   images: ImageConfig;
+  poweredByHeader?: boolean;
 }
 
 export interface RouteDefinition {

packages/tests-e2e/tests/appRouter/headers.test.ts

@@ -20,4 +20,8 @@ test("Headers", async ({ page }) => {
   // Request header should be available in RSC
   let el = page.getByText(`request-header`);
   await expect(el).toBeVisible();
+
+  // Both these headers should not be present cause poweredByHeader is false in appRouter
+  expect(headers["x-powered-by"]).toBeFalsy();
+  expect(headers["x-opennext"]).toBeFalsy();
 });

packages/tests-e2e/tests/pagesRouter/header.test.ts

@@ -0,0 +1,14 @@
+import { expect, test } from "@playwright/test";
+
+test("should test if poweredByHeader adds the correct headers ", async ({
+  page,
+}) => {
+  const result = await page.goto("/");
+  expect(result).toBeDefined();
+  expect(result?.status()).toBe(200);
+  const headers = result?.headers();
+
+  // Both these headers should be present cause poweredByHeader is true in pagesRouter
+  expect(headers?.["x-powered-by"]).toBe("Next.js");
+  expect(headers?.["x-opennext"]).toBe("1");
+});