feat(datastore): add subscription variables for multi-tenant filtering#14564
Open
anivar wants to merge 1 commit intoaws-amplify:mainfrom
Open
feat(datastore): add subscription variables for multi-tenant filtering#14564anivar wants to merge 1 commit intoaws-amplify:mainfrom
anivar wants to merge 1 commit intoaws-amplify:mainfrom
Conversation
anivar
force-pushed
the
feat/datastore-subscription-variables
branch
from
bf213c0 to
972faa4
Compare
🦋 Changeset detectedLatest commit: f6ba207 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Add subscriptionVariables config option to DataStore.configure() that
passes custom GraphQL variables to subscription operations. Enables
server-side filtering for multi-tenant apps instead of client-side.
Usage:
DataStore.configure({
subscriptionVariables: {
Todo: { storeId: 'store-123' },
Order: (op) => ({ storeId: op === 'DELETE' ? undefined : 'store-123' }),
},
});
Variables are validated (must be plain objects), reserved GraphQL names
(filter, owner, input, etc.) are filtered out with warnings, and
function-form variables receive the operation type.
Fixes aws-amplify#9413
anivar
force-pushed
the
feat/datastore-subscription-variables
branch
from
972faa4 to
f6ba207
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.
Description of changes
Adds a
subscriptionVariablesconfig option toDataStore.configure()that passes custom GraphQL variables to subscription operations. This enables server-side subscription filtering for multi-tenant apps, avoiding the current approach of receiving all updates and filtering client-side.Usage:
What changed:
subscriptionVariablesfield inDataStoreConfigtypeSyncEngine→SubscriptionProcessorprocessSubscriptionVariables()insync/utils.ts— validates input, filters reserved names, supports static objects or per-operation functionsbuildSubscriptionGraphQLOperation()accepts custom variables for query buildingvariablesbefore GraphQL callWhat was simplified vs original:
sanitizeSubscriptionVariablesandfilterReservedSubscriptionVariableKeysprocessSubscriptionVariablesfunctionIssue #, if available
Fixes #9413
Description of how you validated changes
Checklist
yarn testpassesBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.