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.

Sign up for GitHub

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

Jump to bottom

[Next.js] Multi-site implementation #1288

Merged
merged 16 commits into from
Jan 12, 2023
Merged

[Next.js] Multi-site implementation #1288

merged 16 commits into from
Jan 12, 2023

Conversation

ambrauer
Copy link
Contributor

Description / Motivation

Allows a single JSS Next.js app to serve multiple Sitecore sites. Available in new nextjs-multisite initializer add-on (#1248). Lots of changes, including:

Closes #1239 (many thanks to @mjarosch for the excellent draft contribution which helped influence some of our decisions 🙏)

Testing Details

Unit tests, local integration testing

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

illiakovalenko and others added 15 commits December 19, 2022 16:09
@illiakovalenko
[Next.js][Multi-site] Create plugin approach for extract-path
4832b9c
@illiakovalenko
Minor changes to JSDoc
d4986bf
@illiakovalenko
Merge pull request #1264 from Sitecore/feature/561499
946a6c5 
[Next.js][Multi-site] Create plugin approach for extract-path
@illiakovalenko
[Next.js][Multi-site] Dynamic site resolver (#1271)
9d42e01 
* [Next.js][Multi-site] Dynamic site resolver

* add changes

* Add unit tests, parse pattern

* etc

* simplify reg exp
@illiakovalenko @ambrauer
[Next.js][Multi-site] Multi-site path utils (#1275)
a75a453 
* [Next.js][Multi-site] Multi-site path utils

* Add return type to `getSiteRewriteData`

Co-authored-by: Adam Brauer <[email protected]>
@ambrauer @art-alexeyenko @illiakovalenko
[Next.js][Multi-site] Fetch site info during build (#1276)
96bd727 
* GraphQL site info service (#1227)

* GraphQL site info service

* some tweaks

* more tweaks: debug, query

* query fix for xm cloud

* move template id to contstants

* [Next.js][Multi-site] Dynamic site resolver (#1224)

* [Next.js][Multi-site] Dynamic site resolver

* Use SiteInfo from graphql-siteinfo-service

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

* Plugin approach for JSS config generation. Added multisite plugin to set the "sites" prop.

* Standardized comments in config plugins. Misc fixes.

* Fixed tests and relocated headlessSiteGroupingTemplate constant (since this query is temp anyway)

* Moved defaultLanguage of 'en' to defaultConfig

* Simplify config plugin order. Delete multisite-sample.ts

Co-authored-by: Artem Alexeyenko <[email protected]>
Co-authored-by: Illia Kovalenko <[email protected]>
@addy-pathania
[Next.js][Multi-site] Site resolution in API routes (#1277)
9d960f2 
* add site resolution in api routes

* re-exported SiteResolver from nextjs package

* passed siteInfo to siteResolver

* refactored based on changes in resolver function
@ambrauer
[Next.js][Multi-site] Site resolution in page props factory (#1281)
ed32f75 
* SiteResolver.resolve updates: removed 'language' from site resolution logic, return SiteInfo instead of site name

* Another refactor of SiteResolver. It now must be instantiated with the array of SiteInfo passed. Also introduced a way to resolve by site name ("getByName"). The old "resolve" became "getByHost".

* Added "site" prop to page props and resolve for both base nextjs initializer (single site) and nextjs-multisite add-on.

* misc lint fixes

* Adjustments to API routes based on latest SiteResolver changes

* Added comments

* Removed generateConfig from fetch-graphql-introspection-data.ts. No longer works after config generation refactor, and not necessary anyway since we provide details on how to generate config in error message anyway
@ambrauer
Update page props factory error-pages plugin to use props.site.name
5c2d3c0
@illiakovalenko @art-alexeyenko
@ambrauer @sc-ruslanmatkovskyi
[Next.js][Multi-site] Multi-site middleware plugin (#1279)
bc26952 
* 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

* Adjust changes according to review

* Adjust changes according to review

* lint fix

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]>
@illiakovalenko @art-alexeyenko
@ambrauer @sc-ruslanmatkovskyi
[Next.js][Multi-site] Support for "sc_site" query string parameter (#…
aa2c943 
…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]>
@illiakovalenko
Import SiteResolver from middleware submodule
2a6e7bf
@art-alexeyenko
Ensure site and variant prefixes are position agnostic (#1286)
fd498ae 
* personalize rewrite unit tests

(cherry picked from commit 3c412ed6855d60452e1e29d21a92d1901312d3d4)

* site path utils unit tests, tweak to personalize path unit test
@addy-pathania @ambrauer
[MultiSite] SSG support (#1284)
835134a 
* added ssg support for multisite

* added changes from review comments

* added sitename for debug log

* refactored sitemap methods

* fixed debug sitename

* add error when no sites

* removed commented code

* refactored transformLanguageSitePaths

* Update packages/sitecore-jss-nextjs/src/services/graphql-sitemap-service.ts

Co-authored-by: Adam Brauer <[email protected]>
@ambrauer
Merge remote-tracking branch 'origin/dev' into feature/multi-site-int…
221de74 
…egration
@ambrauer ambrauer requested a review from a team January 12, 2023 19:34
art-alexeyenko
art-alexeyenko approved these changes Jan 12, 2023
View reviewed changes
Copy link
Contributor

@art-alexeyenko art-alexeyenko left a comment

Choose a reason for hiding this comment

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

Everything seems covered, big kudos to the team for productizing the POC.
Let's roll with this.

@ambrauer ambrauer merged commit c4c7cd6 into dev Jan 12, 2023
@ambrauer ambrauer deleted the feature/multi-site-integration branch January 12, 2023 20:24
@ambrauer ambrauer mentioned this pull request Feb 16, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@art-alexeyenko art-alexeyenko art-alexeyenko approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ambrauer @art-alexeyenko @illiakovalenko @addy-pathania