feat: scaffold PIC-1321 App Framework storage for Klaviyo field mappings - #11280
Open
david-shibley-contentful wants to merge 1 commit into
Open
feat: scaffold PIC-1321 App Framework storage for Klaviyo field mappings#11280david-shibley-contentful wants to merge 1 commit into
david-shibley-contentful wants to merge 1 commit into
Conversation
JuliRossi
reviewed
Aug 21, 2026
Collaborator
There was a problem hiding this comment.
⚔️ I think we are exposing a bit too much about the innerworkings of app storage in this ADR. The idea was to use it for internal apps only.
Contributor
Author
There was a problem hiding this comment.
Good call — removed the ADR entirely in eab1588, nothing else in the codebase referenced it. Updated the PR description to drop the dangling link too.
JuliRossi
reviewed
Aug 21, 2026
| // the same fallback logic in entrySyncFunction.ts. | ||
| function toStorageRow(mapping: any): FieldMappingRow | null { | ||
| const contentfulFieldId = mapping.contentfulFieldId || mapping.id; | ||
| const klaviyoBlockName = mapping.klaviyoBlockName || mapping.name || contentfulFieldId; |
Collaborator
There was a problem hiding this comment.
💭 I think we are doing this in entrySyncFunction.ts as well the contentfulFieldId/klaviyoBlockName/fieldType alias fallback in toStorageRow is basically the same logic. Perhaps this could be a shared helper both files import?
| { parameters: { entryId, mappings } } | ||
| ); | ||
| } catch (error) { | ||
| logger.error('Error writing field mappings via Set Field Mappings action:', error); |
Collaborator
There was a problem hiding this comment.
💭 Do we want to surface this failure to the caller somehow? Right now if the App Action call fails we just log and return none of the four call sites (ConfigScreen, FieldMappingScreen, FieldSelectDialog, Sidebar) can tell the save didn't go through.
JuliRossi
requested changes
Aug 21, 2026
Adds a storage block to contentful-app-manifest.json, a local type shim for the not-yet-shipped context.storage DSL, and getFieldMappings/ setFieldMappings Functions written against that contract. Get/set now try context.storage first and fall back to the existing klaviyoFieldMappings CMA-entry logic (moved to field-mappings-legacy.ts) when it's absent, which is true in every real environment today. The frontend no longer touches that CMA entry directly - it calls the two App Actions via field-mappings-client.ts, same exported names/ signatures as before so call sites only changed their import path. getFieldMappings also bulk-migrates the legacy blob into the field_mappings storage table the first time context.storage is present, gated on the table being empty so it only runs once. entrySyncFunction.ts still reads via the legacy path unconditionally; wiring it onto context.storage is a follow-up once the platform ships. Known risk: the manifest change is confirmed safe against the local @contentful/app-scripts@2.3.0 build validation, but it's unverified whether the live Extensibility API's bundle-upload validation accepts the new top-level storage key. Do not run upload-ci/upload-staging/ deploy with this change until that's confirmed against staging. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
david-shibley-contentful
force-pushed
the
feat/klaviyo-app-framework-storage-scaffold
branch
from
August 21, 2026 20:26
eab1588 to
2bc0d32
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
storageblock incontentful-app-manifest.json, a local type shim for the not-yet-shippedcontext.storageDSL, and two new Functions (getFieldMappings,setFieldMappings) written against that contract.entrySyncFunction.tsand the existing frontend field-mapping UI (which currently store mappings as a stringified JSON blob in aklaviyoFieldMappingsCMA entry, per the drift from ADR-0003) are untouched.@contentful/app-scripts@2.3.0build validation, but it's unverified whether the live Extensibility API's bundle-upload validation accepts the new top-levelstoragekey. Do not runupload-ci/upload-staging/deploywith this change until that's confirmed against staging.Test plan
npm run build:functionssucceeds locally with the new manifeststorageblock and both new Functions bundle cleanlynpx tsc --noEmitpasses with no type errors against the installed@contentful/node-apps-toolkit@3.15.0npm testrun (no existing test files touch these new files; pre-existing suite has zero test files, so this is a no-op check)storagekey before ever runningupload-ci/deployon this branchGenerated with Claude Code