[Next.js][Multi-site] Support for "sc_site" query string parameter (#1283)

* jss-cli unit test coverage: first batch

* jss-cli unit test coverage: second batch

* jss-cli unit tests: second batch

* fix expected output for test not to fail across environments

* lint

* dev-tools unit test coverage first batch

* dev-tools unit test coverage: second batch

* resolve-scjssconfig test placeholder (for the future!)

* exclude index file from jss-vue test coverage (#1266)

* version v21.1.0-canary.58 [skip ci]

* fix test for scjssconfig resolving

* Update packages/sitecore-jss-dev-tools/src/manifest/manifest-manager.test.ts

Co-authored-by: Adam Brauer <[email protected]>

* Update packages/sitecore-jss-dev-tools/src/manifest/manifest-manager.test.ts

Co-authored-by: Adam Brauer <[email protected]>

* lint

* adding test data for scjssconfig

* some improvements to reject logic in resolve scjssconfig

* lint numero 2

* version v21.1.0-canary.59 [skip ci]

* #556667: fixed urls for sitemap

* version v21.1.0-canary.60 [skip ci]

* final batch

* re-gen yarn.lock

* yarn.lock re-update

* version v21.1.0-canary.61 [skip ci]

* #552985: fixed header styles

* version v21.1.0-canary.62 [skip ci]

* #546298: fixed style for showing hidden components

* version v21.1.0-canary.63 [skip ci]

* SiteResolver.resolve updates: removed 'language' from site resolution logic, return SiteInfo instead of site name

* [Next.js][Multi-site] Multi-site middleware plugin

* #559044: fixed rendering dynamic placeholder (#1278)

* version v21.1.0-canary.64 [skip ci]

* Adjust with latest site resolver changes

* adjust

* Add latest changes

* Extra comment

* extra fix

* Extend unit tests

* Revert cookie set change

* Use response cookies instead of request

* Add querystring support

* Adjust changes according to review

* Adjust changes

* Adjust changes according to review

* lint fix

* Use `sc_site` request cookie when it's present

Co-authored-by: Artem Alexeyenko <[email protected]>
Co-authored-by: Automated Build <[email protected]>
Co-authored-by: Adam Brauer <[email protected]>
Co-authored-by: Ruslan Matkovskyi <[email protected]>
Co-authored-by: Ruslan Matkovskyi <[email protected]>

Author: 5 people

packages/sitecore-jss-nextjs/src/middleware/multisite-middleware.test.ts

@@ -28,7 +28,13 @@ describe('MultisiteMiddleware', () => {
         clone() {
           return Object.assign({}, req.nextUrl);
         },
-        ...props?.nextUrl,
+        searchParams: {
+          get(key) {
+            return req.nextUrl.searchParams[key];
+          },
+          ...props.searchParams,
+        },
+        ...props.nextUrl,
       },
       headers: {
         get(key: string) {
@@ -308,6 +314,86 @@ describe('MultisiteMiddleware', () => {
 
       nextRewriteStub.restore();
     });
+
+    it('sc_site querystring parameter is provided', async () => {
+      const req = createRequest({ searchParams: { sc_site: 'qsFoo' } });
+
+      const res = createResponse();
+
+      const nextRewriteStub = sinon.stub(nextjs.NextResponse, 'rewrite').returns(res);
+
+      const { middleware, getSite } = createMiddleware();
+
+      const finalRes = await middleware.getHandler()(req, res);
+
+      validateDebugLog('multisite middleware start: %o', {
+        pathname: '/styleguide',
+        hostname: 'foo.net',
+      });
+
+      validateDebugLog('multisite middleware end: %o', {
+        rewritePath: '/_site_qsFoo/styleguide',
+        siteName: 'qsFoo',
+        headers: {
+          'x-sc-rewrite': '/_site_qsFoo/styleguide',
+        },
+        cookies: {
+          ...res.cookies,
+          sc_site: 'qsFoo',
+        },
+      });
+
+      expect(getSite.notCalled).equal(true);
+
+      expect(finalRes).to.deep.equal(res);
+
+      expect(nextRewriteStub).calledWith({
+        ...req.nextUrl,
+        pathname: '/_site_qsFoo/styleguide',
+      });
+
+      nextRewriteStub.restore();
+    });
+
+    it('sc_site cookie is provided', async () => {
+      const req = createRequest({ cookieValues: { sc_site: 'foobar' } });
+
+      const res = createResponse();
+
+      const nextRewriteStub = sinon.stub(nextjs.NextResponse, 'rewrite').returns(res);
+
+      const { middleware, getSite } = createMiddleware();
+
+      const finalRes = await middleware.getHandler()(req, res);
+
+      validateDebugLog('multisite middleware start: %o', {
+        pathname: '/styleguide',
+        hostname: 'foo.net',
+      });
+
+      validateDebugLog('multisite middleware end: %o', {
+        rewritePath: '/_site_foobar/styleguide',
+        siteName: 'foobar',
+        headers: {
+          'x-sc-rewrite': '/_site_foobar/styleguide',
+        },
+        cookies: {
+          ...res.cookies,
+          sc_site: 'foobar',
+        },
+      });
+
+      expect(getSite.notCalled).equal(true);
+
+      expect(finalRes).to.deep.equal(res);
+
+      expect(nextRewriteStub).calledWith({
+        ...req.nextUrl,
+        pathname: '/_site_foobar/styleguide',
+      });
+
+      nextRewriteStub.restore();
+    });
   });
 
   describe('error handling', () => {

packages/sitecore-jss-nextjs/src/middleware/multisite-middleware.ts

@@ -94,7 +94,11 @@ export class MultisiteMiddleware {
       return response;
     }
 
-    const { name: siteName } = this.config.getSite(hostname);
+    // Site name can be forced by query string parameter or cookie
+    const siteName =
+      req.nextUrl.searchParams.get('sc_site') ||
+      req.cookies.get('sc_site') ||
+      this.config.getSite(hostname).name;
 
     // Rewrite to site specific path
     const rewritePath = getSiteRewrite(pathname, {