@W-20726537 Data access layer middleware by raiyaj · Pull Request #3648 · SalesforceCommerceCloud/pwa-kit

raiyaj · 2026-02-09T19:23:20Z

This PR adds a client for querying the MRT data store, which is backed by DynamoDB. The idea is for this client to be abstracted by a PWA Kit helper which will be called by customer code.

Description

Types of Changes

Bug fix (non-breaking change that fixes an issue)
New feature (non-breaking change that adds functionality)
Documentation update
Breaking change (could cause existing functionality to not work as expected)
Other changes (non-breaking changes that does not fit any of the above)

Breaking changes include:

Removing a public function or component or prop

Adding a required argument to a function

Changing the data type of a function parameter or return value

Adding a new peer dependency to package.json

Changes

Add a singleton DataStore middleware client (based heavily on the MetricsSender) with public methods for getting the singleton instance, checking if the data store is available, and then fetching an entry from the data access layer
Add a reference app route to facilitate testing the client
Add unit tests

How to Test-Drive This PR

Test plan

Checklists

General

Changes are covered by test cases
CHANGELOG.md updated with a short description of changes (not required for documentation updates)

Accessibility Compliance

You must check off all items in one of the follow two lists:

There are no changes to UI

or...

Changes were tested with a Screen Reader (iOS VoiceOver or Android Talkback) and had no issues
Changes comply with WCAG 2.0 guidelines levels A and AA
Changes to common UI patterns and interactions comply with WAI-ARIA best practices

Localization

Changes include a UI text update in the Retail React App (which requires translation)

cc-prodsec · 2026-02-09T19:23:57Z

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

Status	Scanner	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.

…llations

…cy installations" This reverts commit 82679c3.

raiyaj · 2026-02-10T02:14:33Z

packages/pwa-kit-runtime/CHANGELOG.md

@@ -1,4 +1,6 @@
 ## v3.16.0-dev (Dec 17, 2025)
+- Add Data Store client [#3648](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/3648)


Since this feature is currently inaccessible to end users, I'm wondering if I should omit this entry?

Is it technically available but just not "officially released"? Or is it neither?

It's an undocumented feature that's intended to only be used internally by ECOM and PWA Kit/SF Next (see my answer below).

I ended up reverting this and adding the skip changelog PR label, but I can add it back if you prefer.

raiyaj · 2026-02-10T02:23:17Z

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

+            // eslint-disable-next-line @typescript-eslint/no-var-requires
+            const {DynamoDBClient} = require('@aws-sdk/client-dynamodb')
+            // eslint-disable-next-line @typescript-eslint/no-var-requires
+            const {DynamoDBDocumentClient} = require('@aws-sdk/lib-dynamodb')


pwa-kit-runtime seems unable to statically analyze module-level AWS SDK imports (it results in the error enoent: no such file or directory, open 'node:stream'), so these are imported lazily following the pattern in metrics-sender.js.

raiyaj · 2026-02-10T02:28:03Z

packages/pwa-kit-runtime/src/utils/ssr-server/utils.js

+/**
+ * Log an internal MRT error.
+ *
+ * @param namespace Namespace for the error (e.g. data_store, redirect) to facilitate searching
+ * @param err Error to log
+ * @param context Optional context to include in the log
+ */
+export const logMRTError = (namespace, err, context) => {
+    const error = err instanceof Error ? err : new Error(String(err))
+    console.error(
+        JSON.stringify({
+            [`__MRT__${namespace}`]: 'error',
+            type: 'MRT_internal',
+            error: error.message,
+            stack: error.stack,
+            ...context
+        })
+    )
+}


For context, errors with the MRT_internal type are filtered out of log tailing and Log Center forwarding, so they're obscured from customers when thrown from Lambda.

bfeister · 2026-02-11T15:54:28Z

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

+     * @throws {DataStoreNotFoundError} An entry with the given key cannot be found
+     * @throws {DataStoreServiceError} An internal error occurred
+     */
+    async getEntry(key) {


@raiyaj last I heard about this feature, there was an assumption the data is PUSHed from ECOM into MRT. Assuming that's still true, what is the mechanism by which customers will know whether their key is valid?

Are there docs for this somewhere? PR description doesn't seem to cover how a customer would know about creating a key / populating the data store, etc.

Great question. Yup, customers will be able to change their site metadata in ECOM, which will trigger a data store upsert in MRT – that's documented here in the HLD. Customers don't need to know the entry keys, though, instead they would call a generic helper (something like getCustomSitePreferences()) which would fetch the entry with the right key.

Does your team still plan to implement this helper in PWA Kit and SF Next?

bfeister

The main question is:

Are there docs for this somewhere? PR description doesn't seem to cover how a customer would know about creating a key / populating the data store, etc.

wip: port from managed-runtime-libraries

87027b6

raiyaj added 14 commits February 9, 2026 11:49

fix imports

a0f3cee

fix export

9b5d440

port util tests

d621960

update changelog

407963b

port client tests

d17aadb

pr feedback: remove isRemote() check in isDataStoreAvailable()

01ddca2

try installing libraries in the monorepo root to fix dependency insta…

82679c3

…llations

Revert "try installing libraries in the monorepo root to fix dependen…

01a97d0

…cy installations" This reverts commit 82679c3.

reinstall from public npm

dd1d875

uninstall

52eb4d7

reinstall from public npm

ce7d46d

port reference app tests

b598935

Merge branch 'develop' into w-20726537-data-access-layer-middleware

456c57b

undo accidental test change

f4071dd

raiyaj commented Feb 10, 2026

View reviewed changes

raiyaj marked this pull request as ready for review February 10, 2026 02:47

raiyaj requested a review from a team as a code owner February 10, 2026 02:47

npeternel-sf previously approved these changes Feb 10, 2026

View reviewed changes

bfeister reviewed Feb 11, 2026

View reviewed changes

raiyaj added 2 commits February 12, 2026 11:40

Merge branch 'develop' into w-20726537-data-access-layer-middleware

8f29f79

reinstall following merge conflict

cccf34a

raiyaj dismissed npeternel-sf’s stale review via cccf34a February 12, 2026 20:13

raiyaj added the skip changelog Skip the "Changelog Check" GitHub Actions step even if the Changelog.md files are not updated label Feb 12, 2026

raiyaj added 2 commits February 12, 2026 12:19

empty commit

c7bedfa

Merge branch 'develop' into w-20726537-data-access-layer-middleware

8279469

kieran-sf approved these changes Feb 13, 2026

View reviewed changes

bfeister approved these changes Feb 13, 2026

View reviewed changes

raiyaj merged commit 8151418 into develop Feb 13, 2026
42 checks passed

raiyaj deleted the w-20726537-data-access-layer-middleware branch February 13, 2026 21:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

@W-20726537 Data access layer middleware#3648

@W-20726537 Data access layer middleware#3648
raiyaj merged 19 commits intodevelopfrom
w-20726537-data-access-layer-middleware

raiyaj commented Feb 9, 2026 •

edited

Loading

Uh oh!

cc-prodsec commented Feb 9, 2026 •

edited

Loading

Uh oh!

raiyaj Feb 10, 2026 •

edited

Loading

Uh oh!

bfeister Feb 11, 2026

Uh oh!

raiyaj Feb 11, 2026

Uh oh!

raiyaj Feb 12, 2026

Uh oh!

raiyaj Feb 10, 2026

Uh oh!

raiyaj Feb 10, 2026 •

edited

Loading

Uh oh!

bfeister Feb 11, 2026

Uh oh!

bfeister Feb 11, 2026

Uh oh!

raiyaj Feb 11, 2026 •

edited

Loading

Uh oh!

bfeister left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

		@@ -1,4 +1,6 @@
		## v3.16.0-dev (Dec 17, 2025)
		- Add Data Store client [#3648](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/3648)

Conversation

raiyaj commented Feb 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Types of Changes

Changes

How to Test-Drive This PR

Checklists

General

Accessibility Compliance

Localization

Uh oh!

cc-prodsec commented Feb 9, 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!

raiyaj Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bfeister Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

raiyaj Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

raiyaj Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

raiyaj Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

raiyaj Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bfeister Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

bfeister Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

raiyaj Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bfeister left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

raiyaj commented Feb 9, 2026 •

edited

Loading

cc-prodsec commented Feb 9, 2026 •

edited

Loading

raiyaj Feb 10, 2026 •

edited

Loading

raiyaj Feb 10, 2026 •

edited

Loading

raiyaj Feb 11, 2026 •

edited

Loading