fix(store): avoid delayed updates from state stream #1981

arturovt · 2023-03-19T20:23:39Z

PR Checklist

Please check if your PR fulfills the following requirements:

The commit message follows our guidelines: https://github.com/ngxs/store/blob/master/CONTRIBUTING.md#commit
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[x] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Currently, if an action is dispatched and, in the subscription to the observable returned by the dispatch call, we use a selectOnce then the value emitted is the value from the state before the action was dispatched.

Issue Number: #1976

What is the new behavior?

The queueScheduler from rxjs does not honor the "synchronous" operation stated in the docs, so this has been removed from the stream constructed for selectors, and the state stream now uses the OrderedBehaviorSubject as its base. This is similar to the way that the Actions stream uses the OrderedSubject as its base in order to avoid similar timing issues with its stream.

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

bundlemon · 2023-03-19T20:30:09Z

BundleMon

Files updated (1)

Status	Path	Size	Limits
❌	fesm2015/ngxs-store.js	93.68KB (+1.92KB +2.1%)	125KB / +0.5%

Unchanged files (2)

Status	Path	Size	Limits
✅	fesm2015/ngxs-store-operators.js	6.23KB	15KB / +0.5%
✅	fesm2015/ngxs-store-internals.js	4.22KB	20KB / +0.5%

Total files change +1.92KB +1.88%

Groups updated (3)

Status	Path	Size	Limits
❌	@ngxs/store(esm2015)[gzip] _{./esm2015/*/.js}	177.36KB (+2.06KB +1.17%)	+1%
❌	@ngxs/store(umd)[gzip] _{./bundles/*.umd.js}	36.53KB (+496B +1.34%)	+1%
❌	@ngxs/store(fesm2015)[gzip] _{./fesm2015/*.js}	25.03KB (+403B +1.6%)	+1%

Final result: ❌

View report in BundleMon website ➡️

Current branch size history | Target branch size history

bundlemon · 2023-03-19T20:30:22Z

BundleMon (Integration Projects)

Files updated (3)

Status	Path	Size	Limits
✅	Main bundles(Gzip) _{hello-world-ng12-ivy/dist-integration/main.(h ash).js}	67.9KB (-53B -0.08%)	+1%
✅	Main bundles(Gzip) _{hello-world-ng13-ivy/dist-integration/main.(h ash).js}	69.73KB (-64B -0.09%)	+1%
✅	Main bundles(Gzip) _{hello-world-ng14-ivy/dist-integration/main.(h ash).js}	64.81KB (-674B -1.01%)	+1%

Total files change -791B -0.38%

Final result: ✅

View report in BundleMon website ➡️

Current branch size history | Target branch size history

bundlemon · 2023-03-19T20:30:29Z

BundleMon (NGXS Plugins)

Unchanged files (14)

Status	Path	Size	Limits
✅	Plugins(umd)[gzip] _{storage-plugin/bundles/ngxs-storage-plugin.um d.js}	7.96KB	+1%
✅	Plugins(umd)[gzip] _{router-plugin/bundles/ngxs-router-plugin.umd. js}	7.41KB	+1%
✅	Plugins(umd)[gzip] _{websocket-plugin/bundles/ngxs-websocket-plugi n.umd.js}	6.92KB	+1%
✅	Plugins(umd)[gzip] _{hmr-plugin/bundles/ngxs-hmr-plugin.umd.js}	6.89KB	+1%
✅	Plugins(fesm2015)[gzip] _{storage-plugin/fesm2015/ngxs-storage-plugin.j s}	3.64KB	+1%
✅	Plugins(umd)[gzip] _{form-plugin/bundles/ngxs-form-plugin.umd.js}	3.41KB	+1%
✅	Plugins(fesm2015)[gzip] _{router-plugin/fesm2015/ngxs-router-plugin.js}	3.09KB	+1%
✅	Plugins(umd)[gzip] _{devtools-plugin/bundles/ngxs-devtools-plugin. umd.js}	2.75KB	+1%
✅	Plugins(fesm2015)[gzip] _{form-plugin/fesm2015/ngxs-form-plugin.js}	2.65KB	+1%
✅	Plugins(fesm2015)[gzip] _{hmr-plugin/fesm2015/ngxs-hmr-plugin.js}	2.65KB	+1%
✅	Plugins(fesm2015)[gzip] _{websocket-plugin/fesm2015/ngxs-websocket-plug in.js}	2.59KB	+1%
✅	Plugins(umd)[gzip] _{logger-plugin/bundles/ngxs-logger-plugin.umd. js}	2.53KB	+1%
✅	Plugins(fesm2015)[gzip] _{devtools-plugin/fesm2015/ngxs-devtools-plugin .js}	2.17KB	+1%
✅	Plugins(fesm2015)[gzip] _{logger-plugin/fesm2015/ngxs-logger-plugin.js}	2.01KB	+1%

No change in files bundle size

Unchanged groups (3)

Status	Path	Size	Limits
✅	All Plugins(esm2015)[gzip] _{./-plugin/esm2015/**/.js}	108.59KB	+1%
✅	All Plugins(umd)[gzip] _{./-plugin/bundles/.umd.js}	37.88KB	+1%
✅	All Plugins(fesm2015)[gzip] _{./-plugin/fesm2015/.js}	18.8KB	+1%

Final result: ✅

View report in BundleMon website ➡️

Current branch size history | Target branch size history

codeclimate · 2023-03-20T07:47:01Z

Code Climate has analyzed commit 31213db and detected 2 issues on this pull request.

Here's the issue category breakdown:

Category	Count
Duplication	2

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 97.0% (0.0% change).

View more on Code Climate.

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@ngxs/form-plugin](https://github.com/ngxs/store) | dependencies | minor | [`3.7.6` -> `3.8.0`](https://renovatebot.com/diffs/npm/@ngxs%2fform-plugin/3.7.6/3.8.0) | | [@ngxs/storage-plugin](https://github.com/ngxs/store) | dependencies | minor | [`3.7.6` -> `3.8.0`](https://renovatebot.com/diffs/npm/@ngxs%2fstorage-plugin/3.7.6/3.8.0) | | [@ngxs/store](https://github.com/ngxs/store) | dependencies | minor | [`3.7.6` -> `3.8.0`](https://renovatebot.com/diffs/npm/@ngxs%2fstore/3.7.6/3.8.0) | --- ### Release Notes <details> <summary>ngxs/store</summary> ### [`v3.8.0`](https://github.com/ngxs/store/blob/HEAD/CHANGELOG.md#380-2023-03-29) [Compare Source](ngxs/store@v3.7.6...v3.8.0) - Feature: Build packages in Ivy format [#1945](ngxs/store#1945) - Feature: Add advanced selector utilities [#1824](ngxs/store#1824) - Feature: Expose `ActionContext` and `ActionStatus` [#1766](ngxs/store#1766) - Feature: `ofAction*` methods should have strong types [#1808](ngxs/store#1808) - Feature: Improve contextual type inference for state operators [#1806](ngxs/store#1806) [#1947](ngxs/store#1947) - Feature: Enable warning on unhandled actions [#1870](ngxs/store#1870) [#1951](ngxs/store#1951) - Feature: Router Plugin - Provide more actions and navigation timing option [#1932](ngxs/store#1932) - Feature: Storage Plugin - Allow providing namespace for keys [#1841](ngxs/store#1841) - Feature: Storage Plugin - Enable providing storage engine individually [#1935](ngxs/store#1935) - Feature: Devtools Plugin - Add new options to the `NgxsDevtoolsOptions` interface [#1879](ngxs/store#1879) - Feature: Devtools Plugin - Add trace options to `NgxsDevtoolsOptions` [#1968](ngxs/store#1968) - Feature: Form Plugin - Allow `ngxsFormDebounce` to be string [#1972](ngxs/store#1972) - Performance: Tree-shake patch errors [#1955](ngxs/store#1955) - Fix: Get descriptor explicitly when it's considered as a class property [#1961](ngxs/store#1961) - Fix: Avoid delayed updates from state stream [#1981](ngxs/store#1981) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1837 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

arturovt requested review from markwhitfeld, kuncevic, Carniatto, poloagustin, joaqcid and splincode as code owners March 19, 2023 20:23

arturovt force-pushed the fix/1976 branch from 0b96dce to 04157c8 Compare March 19, 2023 20:25

fix(store): avoid incorrectly ordered events from main state stream

4d7539b

arturovt force-pushed the fix/1976 branch from 04157c8 to 4d7539b Compare March 20, 2023 06:49

markwhitfeld added 2 commits March 20, 2023 09:42

chore: tweak changelog description

d2b8774

chore: add doc comment for OrderedBehaviorSubject

31213db

markwhitfeld approved these changes Mar 20, 2023

View reviewed changes

markwhitfeld changed the title ~~fix(store): avoid incorrectly ordered events from main state stream~~ fix(store): avoid delayed updates on main state stream Mar 20, 2023

markwhitfeld changed the title ~~fix(store): avoid delayed updates on main state stream~~ fix(store): avoid delayed updates from state stream Mar 20, 2023

markwhitfeld merged commit f234866 into master Mar 20, 2023

markwhitfeld deleted the fix/1976 branch March 20, 2023 08:03

markwhitfeld added this to the v3.8.0 milestone Mar 29, 2023

abdulrahman305 mentioned this pull request Jul 3, 2024

[Snyk] Upgrade: , , , , abdulrahman305/auptimizer#4

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(store): avoid delayed updates from state stream #1981

fix(store): avoid delayed updates from state stream #1981

arturovt commented Mar 19, 2023 •

edited by markwhitfeld

Loading

bundlemon bot commented Mar 19, 2023 •

edited

Loading

bundlemon bot commented Mar 19, 2023 •

edited

Loading

bundlemon bot commented Mar 19, 2023 •

edited

Loading

codeclimate bot commented Mar 20, 2023

fix(store): avoid delayed updates from state stream #1981

fix(store): avoid delayed updates from state stream #1981

Conversation

arturovt commented Mar 19, 2023 • edited by markwhitfeld Loading

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

bundlemon bot commented Mar 19, 2023 • edited Loading

BundleMon

bundlemon bot commented Mar 19, 2023 • edited Loading

BundleMon (Integration Projects)

bundlemon bot commented Mar 19, 2023 • edited Loading

BundleMon (NGXS Plugins)

codeclimate bot commented Mar 20, 2023

arturovt commented Mar 19, 2023 •

edited by markwhitfeld

Loading

bundlemon bot commented Mar 19, 2023 •

edited

Loading

bundlemon bot commented Mar 19, 2023 •

edited

Loading

bundlemon bot commented Mar 19, 2023 •

edited

Loading