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

[Nextjs] CloudSDK Integration #1652

Merged
merged 43 commits into from
Nov 8, 2023
Merged

[Nextjs] CloudSDK Integration #1652

merged 43 commits into from
Nov 8, 2023

Conversation

illiakovalenko
Copy link
Contributor

@illiakovalenko illiakovalenko commented Nov 2, 2023 •
edited
Loading

Description / Motivation

This pull request introduces CloudSDK integration into our codebase, enabling several enhancements and improvements.
The new npm packages are: @sitecore-cloudsdk/events, @sitecore-cloudsdk/personalize
The main changes in this PR are as follows:

  • CDPPageView: We have integrated the Cloud SDK Events package into our CDPPageView components. This allows us to efficiently send pageView events using Cloud SDK, improving tracking and analytics capabilities.
  • Personalize Middleware: The Personalize middleware now leverages the Cloud SDK Personalize package. With this integration, we can execute targeted experiences more effectively.
  • BYOC Component Initialization: We have updated BYOC (Bring Your Own Context) components to be initialized using context information. This change ensures that BYOC components are now seamlessly integrated with context and required SDK's.
  • Introduced Context class, that is used to initialize the application Context and associated Software Development Kits (SDKs). Accessible within the @sitecore-jss/sitecore-jss-nextjs/context submodule.
  • Point of Sale resolution is fully removed, now it's handled by Sitecore Edge Proxy

Testing Details

  • Unit Test Added
  • Manual Test/Other - Tested locally using "production" mode

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 illiakovalenko added do-not-merge do-not-review PR's not ready for review labels Nov 2, 2023
@illiakovalenko illiakovalenko changed the title [DRAFT] Engage SDK integration [Nextjs] CloudSDK Integration Nov 6, 2023
@illiakovalenko illiakovalenko requested a review from a team November 7, 2023 12:29
@illiakovalenko illiakovalenko removed do-not-merge do-not-review PR's not ready for review labels Nov 7, 2023
ambrauer
ambrauer reviewed Nov 7, 2023
View reviewed changes
packages/sitecore-jss-nextjs/src/middleware/personalize-middleware.ts Show resolved Hide resolved
packages/sitecore-jss-nextjs/src/context/context.ts Outdated Show resolved Hide resolved
packages/create-sitecore-jss/src/templates/nextjs-xmcloud/package.json Outdated Show resolved Hide resolved
packages/create-sitecore-jss/src/templates/nextjs-xmcloud/src/byoc/index.ts Outdated Show resolved Hide resolved
packages/create-sitecore-jss/src/templates/nextjs-xmcloud/src/lib/context/index.ts Outdated Show resolved Hide resolved
...s/create-sitecore-jss/src/templates/nextjs-xmcloud/src/lib/middleware/plugins/personalize.ts Show resolved Hide resolved
packages/sitecore-jss-nextjs/package.json Outdated Show resolved Hide resolved
packages/sitecore-jss-nextjs/package.json Show resolved Hide resolved
packages/sitecore-jss-nextjs/src/middleware/personalize-middleware.ts Outdated Show resolved Hide resolved
packages/sitecore-jss-nextjs/src/middleware/personalize-middleware.ts Outdated Show resolved Hide resolved
ambrauer
ambrauer approved these changes Nov 8, 2023
View reviewed changes
Copy link
Contributor

@ambrauer ambrauer left a comment

Choose a reason for hiding this comment

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

Looks great! 👍

@ambrauer ambrauer merged commit 6325950 into dev Nov 8, 2023
1 check passed
@ambrauer ambrauer deleted the feature/JSS-685 branch November 8, 2023 20:28
art-alexeyenko pushed a commit that referenced this pull request Nov 8, 2023
@illiakovalenko
[Nextjs] CloudSDK Integration (#1652)
3ca985d 
* Initial commit

* Handle async Events init call

* Update

* Update

* Updated test

* rename nextjs-personalize -> nextjs-xmcloud. move feaas and BYOC here.

* Move Sitecore Edge Platform / conext related items to nextjs-xmcloud

* Updated context initialization

* Updated dependency

* Updated Yarn.lock

* Fix lint errors

* Updated CHANGELOG

* Repurpose nextjs-personalize -> nextjs-xmcloud initializer "system" template (driven by prompt / --xmcloud CLI option)

* Moved skipping of site information fetch on XM Cloud to base package (GraphQLSiteInfoService)

* CHANGELOG update

* Updated Context implementation, added unit tests

* Updated CHANGELOG

* Updated comment

* Updated cloudsdk to use latest production version

* Updated yarn.lock

* Introduced Bootstrap and pulled nextjs-xmcloud

* Update .env

* Updated jsdoc

* Avoid unused vars rule for Bootstrap

* Normalize sitecoreEdgeUrl

* Updated CHANGELOG

* Updated BYOC initialization

* Updated Props doc

* Updates

* Updated unit test

* Updated comment

* Provided sitecoreEdgeUrl to the middleware

* Refactoring

* Passing props to SDK's

* Updated type

* Renamed SDKs -> sdks

* Updated yarn.lock

---------

Co-authored-by: Adam Brauer <[email protected]>
(cherry picked from commit 6325950)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ambrauer ambrauer ambrauer 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.
2 participants
@illiakovalenko @ambrauer