TypeError: stateSource[STATE_SOURCE].update is not a function in NgRx Signals #4511
-
DescriptionI'm encountering an issue when attempting to patch the state using NgRx Signals. The error message I'm receiving is: The error is pointing to the patchState function, specifically at the following line: function patchState(stateSource, ...updaters) {
stateSource[STATE_SOURCE].update(currentState => updaters.reduce((nextState, updater) => ({
...nextState,
...(typeof updater === ‘function’ ? updater(nextState) : updater)
}), currentState));
notifyWatchers(stateSource);
}Below are two screenshots, showing the difference between a successful and unsuccessful patchState (Please note that in the former, there is no Successful ContextAny insights into what might be causing this error or suggestions for how to resolve it would be greatly appreciated! Thank you for your help. |
Beta Was this translation helpful? Give feedback.
Replies: 2 comments 3 replies
-
|
My first guess is that you updated to 18.0.0 without running It would be extremely helpful, if you also provide the lines of code where you run |
Beta Was this translation helpful? Give feedback.
-
|
Thanks for the quick reply! I've run Btw, here is the code where private createConnection<T>(collection: string, store, queryParams: QueryParams, queryOptions: QueryOptions, destroyRef: DestroyRef): CachedConnection {
// console.log("CONNECT " + this.getQueryKey(collection, queryParams, queryOptions));
// ------------ DEFINE OBSERVABLES FOR DISCONNECTING ------------------------------
const queryKey = this.getQueryKey(collection, queryParams, queryOptions);
const disconnectObs$ = this.closeConnection$.pipe(
filter((qk) => qk === queryKey),
take(1),
// tap(a => { console.log("DISCONNECT: " + queryKey) }),
publish(),
refCount(),
);
// ------------ HANDLE PATCHING TO STORE ------------------------------------------
// Handle patching to the store
this.db.streamEntitiesChanges(collection, queryParams, queryOptions).pipe(
takeUntil(disconnectObs$),
).subscribe((fbPayload: Array<{ type: string, docData: AnyEntity }>) => {
// Handle all the added entities
const entitiesToAdd = fbPayload
.filter((dc) => dc.type === 'added' && !dc.docData['_deleted'])
.map((dc) => dc.docData);
// Handle all the modified entities
const entitiesToModify = fbPayload
.filter((dc) => dc.type === 'modified' && !dc.docData['_deleted'])
.map((dc) => dc.docData);
// Handle all the removed entities
const entitiesToRemove = fbPayload
.filter((dc) => dc.type === 'modified' && dc.docData['_deleted'])
.map((dc) => dc.docData['__id']);
// Handle changes of the 'removed' type. In general, firebase 'removed'
// could be due to no longer matching the stream query rather than being
// deleted from the DB. this is why we use soft deletes (set _deleted to true)
// so technically we shouldn't be getting any 'removed' entries. however,
// if there were manual deletions in the database, there could still be changes
// of this type which the below code seeks to handle
const entitiesToModify2 = fbPayload
.filter((dc) => dc.type === 'removed' && !entityInQueryResults(dc.docData, queryParams, queryOptions))
.map((dc) => dc.docData);
const entitiesToRemove2 = fbPayload
.filter((dc) => dc.type === 'removed' && entityInQueryResults(dc.docData, queryParams, queryOptions))
.map((dc) => dc.docData['__id']);
// Patch all the changes to the store
patchState(store, setEntities(entitiesToAdd, { selectId }));
patchState(store, setEntities([...entitiesToModify, ...entitiesToModify2], { selectId }));
patchState(store, removeEntities([...entitiesToRemove, ...entitiesToRemove2]));
});
return {
queryKey: this.getQueryKey(collection, queryParams, queryOptions),
registeredSet: new Set<DestroyRef>([destroyRef]),
};
}Please let me know if you need more context. |
Beta Was this translation helpful? Give feedback.
-
|
thanks @rainerhahnekamp for your help! this is some additional explanation of our codebase / more relevant code: there are stores for each entity, e.g. where then within one thing to note is that this patchState IS WORKING in many other cases when this method is called. we have some syntax that allows for nested queries like the below where we can create a stream based on previously queried entities. so in the code below, it is creating a stream for the group query, and then for each of the queried groups, it is creating a group rating stream query (Side note: I know this will result in N+1 queries, which is bad for creating a bunch of firestore listeners, but the plan is that there would be some infrastructure auto-combining all those into a smaller number on 'in' queries). It is the streaming of the GroupRating that isn't working. so let me explain that portion of the code too. the when the earlier Not sure if this is relevant, but the Sorry this is so complex... the strange thing is that we have another repo using the exact same code that doesn't result in this error and we can't see anything different happening... Probably you wouldn't have time to dig into it more, but we are happy to add you to the repo if that is helpful for identifying the problem. |
Beta Was this translation helpful? Give feedback.
-
|
Uff, that's a lot of code. Try to unset the protectedState like this: export const GroupRatingStore = signalStore(
{ providedIn: 'root', protectedState: false },
withEntitiesAndDBMethods<GroupRating>('groupRatings'),
);If everything works, you tried to patch outside of the SignalStore which is disabled since the stable release: https://dev.to/ngrx/announcing-ngrx-signals-v18-state-encapsulation-private-store-members-enhanced-entity-management-and-more-2lo6 You can leave your If there are still some uncertainties, would it be possible to come up with a reproducible example on StackBlitz? https://stackblitz.com/github/ngrx/signal-store-starter?file=src%2Fmain.ts |
Beta Was this translation helpful? Give feedback.
-
|
thanks! that was the issue. it's interesting because it still works most of the time. we had encountered an issue related to the protectedState somewhere else when we upgraded to V18 and refactored that part accordingly, but we'll make sure to refactor the other portions and use protectedState in the meantime. |
Beta Was this translation helpful? Give feedback.
Uff, that's a lot of code. Try to unset the protectedState like this:
If everything works, you tried to patch outside of the SignalStore which is disabled since the stable release: https://dev.to/ngrx/announcing-ngrx-signals-v18-state-encapsulation-private-store-members-enhanced-entity-management-and-more-2lo6
You can leave your
GroupRatingStorestate unprotected, but we recommend that every state update, i.e., callingpatchState, happens inside the SignalStore. That might require some refactoring on your side.If there are still some un…