Merge branch 'develop' into dependabot/github_actions/dot-github/work…

…flows/github_actions-5ebe5a9988
10up · Dec 23, 2024 · 160cc56 · 160cc56
2 parents 9361504 + 695a0fd
commit 160cc56
Show file tree

Hide file tree

Showing 13 changed files with 88 additions and 15 deletions.
diff --git a/.changeset/orange-shirts-relax.md b/.changeset/orange-shirts-relax.md
@@ -0,0 +1,5 @@
+---
+"@headstartwp/next": patch
+---
+
+Ensure query string is appended to URL rewrite/redirect in middleware
diff --git a/.changeset/pre.json b/.changeset/pre.json
@@ -30,6 +30,7 @@
     "large-spies-give",
     "late-rings-design",
     "moody-emus-matter",
+    "orange-shirts-relax",
     "perfect-cobras-knock",
     "perfect-pumas-approve",
     "poor-donkeys-march",

diff --git a/packages/next/CHANGELOG.md b/packages/next/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @headstartwp/next
 
+## 1.5.0-next.8
+
+### Patch Changes
+
+- 9f7da69: Ensure query string is appended to URL rewrite/redirect in middleware
+
 ## 1.5.0-next.7
 
 ### Minor Changes

diff --git a/packages/next/package.json b/packages/next/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@headstartwp/next",
-  "version": "1.5.0-next.7",
+  "version": "1.5.0-next.8",
   "description": "`@headstartwp/next` is the Next.js bindings for the headless framework.",
   "homepage": "https://github.com/10up/headstartwp/blob/develop/packages/next/README.md",
   "license": "MIT",

diff --git a/packages/next/src/middlewares/__tests__/appMiddleware.ts b/packages/next/src/middlewares/__tests__/appMiddleware.ts
@@ -305,6 +305,51 @@ describe('appMiddleware', () => {
 		expect(res.headers.get('x-headstartwp-locale')).toBe('pt');
 	});
 
+	it('[multisite] supports query strings in App and Pages router', async () => {
+		setHeadstartWPConfig({
+			sites: [
+				{
+					sourceUrl: 'http://testwp.com',
+					hostUrl: 'http://test.com',
+				},
+				{
+					sourceUrl: 'http://testwp2.com',
+					hostUrl: 'http://test2.com',
+				},
+				{
+					sourceUrl: 'http://testwp2.com/en',
+					hostUrl: 'http://test2.com',
+				},
+			],
+		});
+
+		// App Router
+		let req = new NextRequest('http://test2.com/post-name?s=search-slug', {
+			method: 'GET',
+		});
+
+		req.headers.set('host', 'test2.com');
+
+		let res = await AppMiddleware(req, { appRouter: true });
+
+		expect(res.headers.get('x-middleware-rewrite')).toBe(
+			'http://test2.com/test2.com/post-name?s=search-slug',
+		);
+
+		// Pages Router
+		req = new NextRequest('http://test2.com/post-name?s=search-slug', {
+			method: 'GET',
+		});
+
+		req.headers.set('host', 'test2.com');
+
+		res = await AppMiddleware(req, { appRouter: false });
+
+		expect(res.headers.get('x-middleware-rewrite')).toBe(
+			'http://test2.com/_sites/test2.com/post-name?s=search-slug',
+		);
+	});
+
 	it('[polylang] supports locales with app router', async () => {
 		setHeadstartWPConfig({
 			sourceUrl: 'http://testwp.com',
@@ -343,6 +388,16 @@ describe('appMiddleware', () => {
 
 		res = await AppMiddleware(req, { appRouter: true });
 		expect(res.headers.get('x-middleware-rewrite')).toBe('http://test.com/en/post-name');
+
+		// add default locale with a query string
+		req = new NextRequest('http://test.com/post-name?s=query', {
+			method: 'GET',
+		});
+
+		res = await AppMiddleware(req, { appRouter: true });
+		expect(res.headers.get('x-middleware-rewrite')).toBe(
+			'http://test.com/en/post-name?s=query',
+		);
 	});
 
 	it('[polylang no locale detection] supports locales with app router', async () => {

diff --git a/packages/next/src/middlewares/appMidleware.ts b/packages/next/src/middlewares/appMidleware.ts
@@ -93,7 +93,7 @@ export async function AppMiddleware(
 	options: AppMidlewareOptions = { appRouter: false },
 ) {
 	let response = NextResponse.next();
-	const { pathname } = req.nextUrl;
+	const { pathname, searchParams } = req.nextUrl;
 
 	if (isStaticAssetRequest(req) || isInternalRequest(req)) {
 		return response;
@@ -120,6 +120,9 @@ export async function AppMiddleware(
 	const site = getSiteByHost(hostname, !hasPolylangIntegration ? locale : undefined);
 	const isMultisiteRequest = site !== null && typeof site.sourceUrl !== 'undefined';
 
+	// ensure we re-add the query string when rewriting/redirecing
+	const queryString = Array.from(searchParams.keys()).length ? `?${searchParams.toString()}` : '';
+
 	const {
 		redirectStrategy,
 		sourceUrl,
@@ -161,7 +164,7 @@ export async function AppMiddleware(
 			shouldRedirect = true;
 			const pathNameWithoutLocale = pathname.replace(`/${locale}`, '');
 			response = NextResponse.redirect(
-				new URL(pathNameWithoutLocale, req.url.replace(`/${locale}`, '')),
+				new URL(pathNameWithoutLocale + queryString, req.url.replace(`/${locale}`, '')),
 			);
 		}
 		// if we detected a non-default locale, there isn't a supported locale in the URL already
@@ -175,14 +178,17 @@ export async function AppMiddleware(
 		) {
 			shouldRedirect = true;
 			response = NextResponse.redirect(
-				new URL(`/${locale}${pathname.startsWith('/') ? '' : '/'}${pathname}`, req.url),
+				new URL(
+					`/${locale}${pathname.startsWith('/') ? '' : '/'}${pathname}${queryString}`,
+					req.url,
+				),
 			);
 		}
 		// nothing else and there's not a locale in path then rewrite to add default locale
 		else if (pathnameIsMissingLocale && !isValidLocale(firstPathSlice)) {
 			response = NextResponse.rewrite(
 				new URL(
-					`/${defaultAppRouterLocale}${pathname.startsWith('/') ? '' : '/'}${pathname}`,
+					`/${defaultAppRouterLocale}${pathname.startsWith('/') ? '' : '/'}${pathname}${queryString}`,
 					req.url,
 				),
 			);
@@ -191,10 +197,10 @@ export async function AppMiddleware(
 
 	if (isMultisiteRequest && !shouldRedirect) {
 		const hostNameOrSlug = site.slug || hostname;
-		const pagesRouterRewrite = `/_sites/${hostNameOrSlug}${pathname}`;
+		const pagesRouterRewrite = `/_sites/${hostNameOrSlug}${pathname}${queryString}`;
 		const appRouterRewrite = locale
-			? `/${locale}/${hostNameOrSlug}${pathname.replace(`/${locale}`, '')}`
-			: `/${hostNameOrSlug}${pathname}`;
+			? `/${locale}/${hostNameOrSlug}${pathname.replace(`/${locale}`, '')}${queryString}`
+			: `/${hostNameOrSlug}${pathname}${queryString}`;
 
 		response = NextResponse.rewrite(
 			new URL(options.appRouter ? appRouterRewrite : pagesRouterRewrite, req.nextUrl),

diff --git a/projects/vite-react/package.json b/projects/vite-react/package.json
@@ -13,7 +13,7 @@
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "@headstartwp/core": "^1.5.0-next.7",
-    "@headstartwp/next": "^1.5.0-next.7"
+    "@headstartwp/next": "^1.5.0-next.8"
   },
   "devDependencies": {
     "@10up/eslint-config": "^4.0.0",

diff --git a/projects/wp-multisite-i18n-nextjs/package.json b/projects/wp-multisite-i18n-nextjs/package.json
@@ -15,7 +15,7 @@
   },
   "dependencies": {
     "@headstartwp/core": "^1.5.0-next.7",
-    "@headstartwp/next": "^1.5.0-next.7",
+    "@headstartwp/next": "^1.5.0-next.8",
     "@linaria/core": "^6.2.0",
     "@linaria/react": "^6.2.1",
     "clsx": "^1.1.1",

diff --git a/projects/wp-multisite-nextjs-app/package.json b/projects/wp-multisite-nextjs-app/package.json
@@ -13,7 +13,7 @@
     "react-dom": "^18",
     "next": "^14.2.5",
     "@headstartwp/core": "^1.5.0-next.7",
-    "@headstartwp/next": "^1.5.0-next.7"
+    "@headstartwp/next": "^1.5.0-next.8"
   },
   "devDependencies": {
     "@10up/eslint-config": "^4.0.0",

diff --git a/projects/wp-multisite-nextjs/package.json b/projects/wp-multisite-nextjs/package.json
@@ -15,7 +15,7 @@
   },
   "dependencies": {
     "@headstartwp/core": "^1.5.0-next.7",
-    "@headstartwp/next": "^1.5.0-next.7",
+    "@headstartwp/next": "^1.5.0-next.8",
     "@linaria/core": "^6.2.0",
     "@linaria/react": "^6.2.1",
     "clsx": "^1.1.1",

diff --git a/projects/wp-nextjs-app/package.json b/projects/wp-nextjs-app/package.json
@@ -13,7 +13,7 @@
     "react-dom": "^18",
     "next": "^14.2.5",
     "@headstartwp/core": "^1.5.0-next.7",
-    "@headstartwp/next": "^1.5.0-next.7"
+    "@headstartwp/next": "^1.5.0-next.8"
   },
   "devDependencies": {
     "@10up/eslint-config": "^4.0.0",

diff --git a/projects/wp-nextjs/package.json b/projects/wp-nextjs/package.json
@@ -16,7 +16,7 @@
   },
   "dependencies": {
     "@headstartwp/core": "^1.5.0-next.7",
-    "@headstartwp/next": "^1.5.0-next.7",
+    "@headstartwp/next": "^1.5.0-next.8",
     "@10up/next-redis-cache-provider": "^1.0.0",
     "@linaria/core": "^6.2.0",
     "@linaria/react": "^6.2.1",

diff --git a/projects/wp-polylang-nextjs-app/package.json b/projects/wp-polylang-nextjs-app/package.json
@@ -13,7 +13,7 @@
     "react-dom": "^18",
     "next": "^14.2.5",
     "@headstartwp/core": "^1.5.0-next.7",
-    "@headstartwp/next": "^1.5.0-next.7"
+    "@headstartwp/next": "^1.5.0-next.8"
   },
   "devDependencies": {
     "@10up/eslint-config": "^4.0.0",