[DAL] Add MRT Data Store Context and Hooks for Template Usage by bendvc · Pull Request #3834 · SalesforceCommerceCloud/pwa-kit

bendvc · 2026-05-15T17:29:37Z

Summary

Adds React Context provider and hooks to make MRT Data Store custom preferences easily accessible in template applications. The provider is automatically integrated into
the SSR rendering pipeline, requiring no manual setup from developers.

Changes

New Features (pwa-kit-react-sdk)

Context & Provider

Added MrtDataStoreContext and MrtDataStoreProvider to src/ssr/universal/contexts/index.js
Provider automatically switches data source:
- Server (SSR): Receives preferences as props from SSR bootstrap
- Client: Reads from window.MRT_DATA_STORE (serialized by server)
Integrated into both server (react-rendering.js) and client (main.jsx) rendering pipelines

Hooks

Added useCustomSitePreferences() - Returns site-specific preferences
Added useCustomGlobalPreferences() - Returns global preferences
Both hooks exported from @salesforce/pwa-kit-react-sdk/ssr/universal/hooks

Tests

Added 5 comprehensive tests for MrtDataStoreProvider:
- Provides empty objects when no data available
- Uses SSR props on server
- Reads from window on client
- Prefers window over SSR props (client hydration behavior)
- Handles missing nested properties gracefully
All tests passing, 96.29% coverage

Usage Example

                                                                                                                                                                            
  import {                                                                                                                                                                  
      useCustomSitePreferences,                                                                                                                                             
      useCustomGlobalPreferences                                                                                                                                            
  } from '@salesforce/pwa-kit-react-sdk/ssr/universal/hooks'                                                                                                                
                                                                                                                                                                            
  const MyComponent = () => {                                                                                                                                               
      const sitePrefs = useCustomSitePreferences()                                                                                                                          
      const globalPrefs = useCustomGlobalPreferences()                                                                                                                      
                                                                                                                                                                            
      return <div>{sitePrefs.myFeatureFlag ? 'Enabled' : 'Disabled'}</div>                                                                                                  
  }

No setup required - provider is automatically integrated into the rendering pipeline!

Testing the Demo

Enable MRT Data Store in config/default.js:
app: {
mrtDataStore: {
enabled: true
}
}
Run with local data:
MRT_DATA_STORE_DEFAULTS='{"custom-global-preferences":{"theme":"dark"},"RefArch-custom-site-preferences":{"maxItems":10}}' PWAKIT_MRT_DATA_STORE_ENABLED=true npm start
Visit http://localhost:3000/demo-mrt-data-store

Files Changed

pwa-kit-react-sdk:

src/ssr/universal/contexts/index.js - Added provider & context
src/ssr/universal/contexts/index.test.js - Added tests
src/ssr/universal/hooks/index.js - Added hooks
src/ssr/server/react-rendering.js - Integrated provider into SSR
src/ssr/browser/main.jsx - Integrated provider into client
CHANGELOG.md

template-retail-react-app:

app/pages/demo-mrt-data-store/index.jsx - New demo page
app/routes.jsx - Added route
CHANGELOG.md

Separate Bug Fix (for another branch)

Bug: Signature Mismatch Between Client and Server Functions

Problem: Client and server versions of getCustomSitePreferences and getCustomGlobalPreferences have incompatible signatures:

Server: async getCustomSitePreferences({siteId}) (async, requires params)
Client: getCustomSitePreferences() (sync, no params)

Solution: Make both versions async and accept same parameters for consistency.

Files to change (pwa-kit-runtime):

src/utils/data-store/ssr-site-preferences.client.js - Make async, add params
src/utils/data-store/ssr-global-preferences.client.js - Make async
src/utils/data-store/ssr-site-preferences.test.js - Update tests to use await
src/utils/data-store/ssr-global-preferences.test.js - Update tests to use await
CHANGELOG.md - Add bug fix entry

git2gus · 2026-05-15T17:29:39Z

Git2Gus App is installed but the .git2gus/config.json doesn't have right values. You should add the required configuration.

cc-prodsec · 2026-05-15T17:29:47Z

✅ Snyk checks have passed. No issues have been found so far.

Status	Scan Engine	Critical	High	Medium	Low	Total (0)
✅	Open Source Security	0	0	0	0	0 issues
✅	Licenses	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

adamraya · 2026-05-15T21:38:12Z

Do we want to keep the .md file if so should we move it to the template-retail-react-app/docs/ folder?

Sorry.. this file wasn't supposed to be included, it was something I was working on for someone else.

adamraya · 2026-05-15T21:41:07Z

+const MrtDataStoreContext = createContext({
+    customSitePreferences: {},
+    customGlobalPreferences: {}
+})


nit: should we keep the exiting pattern of using React.createContext() or updating to consolidate one pattern?

Good call. Updated.

adamraya · 2026-05-15T21:44:04Z

+                customSitePreferences: window.__MRT_DATA_STORE__.customSitePreferences || {},
+                customGlobalPreferences: window.__MRT_DATA_STORE__.customGlobalPreferences || {}


nit: Should we use the same constants we use in the react-rendering?

pwa-kit/packages/pwa-kit-react-sdk/src/ssr/server/react-rendering.js

Lines 443 to 446 in 04f4023

windowGlobals[DATA_STORE_WINDOW_GLOBAL] = {

[DATA_STORE_BOOTSTRAP_SITE_PREFERENCES_KEY]: customSitePreferences ?? {},

[DATA_STORE_BOOTSTRAP_GLOBAL_PREFERENCES_KEY]: customGlobalPreferences ?? {}

}

Another good catch. Fixed.

adamraya · 2026-05-15T23:24:29Z

        windowGlobals[DATA_STORE_WINDOW_GLOBAL] = {
-            [DATA_STORE_BOOTSTRAP_SITE_PREFERENCES_KEY]: customSitePreferences ?? {},
-            [DATA_STORE_BOOTSTRAP_GLOBAL_PREFERENCES_KEY]: customGlobalPreferences ?? {}
+            __siteId: siteId, // Include siteId so client can construct keys


nit: Should use a constant like DATA_STORE_BOOTSTRAP_SITE_ID_KEY = '__siteId' form constants.js instead of the '__siteId' string directly file and re-use it in these two places?:

pwa-kit/packages/pwa-kit-react-sdk/src/ssr/server/react-rendering.js

Line 447 in 44f8d8a

__siteId: siteId, // Include siteId so client can construct keys

pwa-kit/packages/pwa-kit-react-sdk/src/ssr/browser/main.jsx

Line 53 in 44f8d8a

? window.__MRT_DATA_STORE__.__siteId

adamraya · 2026-05-15T23:27:35Z

It looks we no longer need DATA_STORE_BOOTSTRAP_SITE_PREFERENCES_KEY and DATA_STORE_BOOTSTRAP_GLOBAL_PREFERENCES_KEY:

pwa-kit/packages/pwa-kit-runtime/src/utils/data-store/constants.js

Lines 20 to 27 in debad80

    
           /** 
        
            * Property under `window[DATA_STORE_WINDOW_GLOBAL]` for resolved site-scoped preferences. 
        
            * (DAL key is still `<siteId>-custom-site-preferences`; this is only the bootstrap object shape.) 
        
            */ 
        
           export const DATA_STORE_BOOTSTRAP_SITE_PREFERENCES_KEY = 'customSitePreferences' 
        
           /** Property under `window[DATA_STORE_WINDOW_GLOBAL]` for resolved global preferences. */ 
        
           export const DATA_STORE_BOOTSTRAP_GLOBAL_PREFERENCES_KEY = 'customGlobalPreferences'

vcua-mobify · 2026-05-20T17:38:25Z

            expect(data[DATA_STORE_WINDOW_GLOBAL]).toEqual({
-                [DATA_STORE_BOOTSTRAP_SITE_PREFERENCES_KEY]: {},
-                [DATA_STORE_BOOTSTRAP_GLOBAL_PREFERENCES_KEY]: {}
+                __siteId: undefined,


Same comment from @adamraya on this line as well

Replace `__siteId` literal with new `DATA_STORE_BOOTSTRAP_SITE_ID_KEY` constant across the bootstrap writer, client reader, and the rendering test. Remove the now-unused `DATA_STORE_BOOTSTRAP_SITE_PREFERENCES_KEY` / `DATA_STORE_BOOTSTRAP_GLOBAL_PREFERENCES_KEY` exports and their imports in the data-store test files.

vcua-mobify

+1

`compile-folder.js` and `compile-pseudo.js` were spawning `formatjs` via `exec` and returning before the callback fired. In the generated test project, npm postinstall finishes while formatjs is still writing `app/static/translations/compiled/en-XA.json`, leaving the file empty when tests run and breaking `locale.test.js > loading the pseudo locale` on Node 24 CI runners. Switch to `execSync` so the postinstall blocks until formatjs has finished.

… and changelog entry Reverts: - bf3aed5 Add CHANGELOG entry for translation compile script fix - 0636c23 Make translation compile scripts wait for formatjs to finish The locale.test.js failure on Node 24 CI is caused by `@formatjs/cli@>=6.15.0` shipping native binaries that silently emit "Warning: Pseudo-locale transformations not yet implemented" and produce a single-element array instead of the expected 3-element pseudo-localized output. That root cause is fixed in #3842 (pin `@formatjs/cli` to 6.9.0 + verdaccio config to stop proxying monorepo packages). Reverting both commits since they were addressing the wrong symptom; we'll merge develop in once #3842 lands.

…dal-hooks # Conflicts: # packages/pwa-kit-runtime/CHANGELOG.md

PR's vendor.js is 395.33 KB gzip (was 394.78 KB on develop) — the new MrtDataStoreProvider context, useCustomSitePreferences / useCustomGlobalPreferences hooks, and the bootstrap-key wiring add ~0.55 KB to the shipped client bundle. Raise the budget by 2 kB so compile variance doesn't flake CI without giving up the guardrail.

Initial Commit

04f4023

bendvc requested a review from a team as a code owner May 15, 2026 17:29

bendvc requested a review from adamraya May 15, 2026 21:03

Add demo code to be removed later

1147fde

adamraya reviewed May 15, 2026

View reviewed changes

Comment thread packages/pwa-kit-runtime/src/utils/data-store/ssr-global-preferences.client.js

adamraya reviewed May 15, 2026

View reviewed changes

bendvc added 4 commits May 15, 2026 14:47

PR feedbadk

855fe9e

PR feedback

cb06549

PR feedback

44f8d8a

Fix test

7af57e7

adamraya reviewed May 15, 2026

View reviewed changes

vcua-mobify reviewed May 20, 2026

View reviewed changes

vcua-mobify previously approved these changes May 20, 2026

View reviewed changes

adamraya and others added 2 commits May 21, 2026 10:27

Merge branch 'develop' into bendvc/W-22385616_dal-hooks

2c9439b

Cover MRT Data Store siteId read in OuterApp test

57302f6

adamraya dismissed vcua-mobify’s stale review via 57302f6 May 21, 2026 17:42

adamraya previously approved these changes May 21, 2026

View reviewed changes

adamraya dismissed their stale review via 0636c23 May 21, 2026 20:34

adamraya added 2 commits May 21, 2026 13:41

Add CHANGELOG entry for translation compile script fix

bf3aed5

vcua-mobify previously approved these changes May 22, 2026

View reviewed changes

Merge remote-tracking branch 'origin/develop' into bendvc/W-22385616_…

50c2a60

…dal-hooks # Conflicts: # packages/pwa-kit-runtime/CHANGELOG.md

adamraya dismissed vcua-mobify’s stale review via 50c2a60 May 22, 2026 22:22

adamraya enabled auto-merge May 22, 2026 22:25

adamraya previously approved these changes May 22, 2026

View reviewed changes

vcua-mobify previously approved these changes May 22, 2026

View reviewed changes

adamraya dismissed stale reviews from vcua-mobify and themself via 2299ae5 May 22, 2026 22:32

Add CHANGELOG entry for vendor.js bundle-size budget bump

3b92a04

adamraya approved these changes May 22, 2026

View reviewed changes

vcua-mobify approved these changes May 22, 2026

View reviewed changes

adamraya merged commit 2bb709f into develop May 22, 2026
76 of 78 checks passed

adamraya deleted the bendvc/W-22385616_dal-hooks branch May 22, 2026 23:50

Navigation Menu

Uh oh!

[DAL] Add MRT Data Store Context and Hooks for Template Usage - #3834

[DAL] Add MRT Data Store Context and Hooks for Template Usage #3834
adamraya merged 15 commits into
developfrom
bendvc/W-22385616_dal-hooks

bendvc commented May 15, 2026 •

edited

Loading

Uh oh!

git2gus Bot commented May 15, 2026

Uh oh!

cc-prodsec commented May 15, 2026 •

edited

Loading

Uh oh!

Uh oh!

adamraya May 15, 2026

Uh oh!

bendvc May 15, 2026

Uh oh!

adamraya May 15, 2026

Uh oh!

bendvc May 15, 2026

Uh oh!

adamraya May 15, 2026

Uh oh!

bendvc May 15, 2026

Uh oh!

adamraya May 15, 2026

Uh oh!

adamraya commented May 15, 2026

Uh oh!

vcua-mobify May 20, 2026

Uh oh!

vcua-mobify left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		customSitePreferences: window.__MRT_DATA_STORE__.customSitePreferences \|\| {},
		customGlobalPreferences: window.__MRT_DATA_STORE__.customGlobalPreferences \|\| {}

	windowGlobals[DATA_STORE_WINDOW_GLOBAL] = {
	[DATA_STORE_BOOTSTRAP_SITE_PREFERENCES_KEY]: customSitePreferences ?? {},
	[DATA_STORE_BOOTSTRAP_GLOBAL_PREFERENCES_KEY]: customGlobalPreferences ?? {}
	}

Uh oh!

Conversation

bendvc commented May 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

New Features (pwa-kit-react-sdk)

Context & Provider

Hooks

Tests

Usage Example

Uh oh!

git2gus Bot commented May 15, 2026

Uh oh!

cc-prodsec commented May 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Snyk checks have passed. No issues have been found so far.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adamraya commented May 15, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vcua-mobify left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

bendvc commented May 15, 2026 •

edited

Loading

cc-prodsec commented May 15, 2026 •

edited

Loading