Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test(store): ensure state writes are allowed with fire & forget #2241

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

arturovt
Copy link
Member

No description provided.

Copy link

nx-cloud bot commented Oct 25, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit b256490. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 4 targets

Sent with 💌 from NxCloud.

Copy link

pkg-pr-new bot commented Oct 25, 2024

Open in Stackblitz

@ngxs/form-plugin

yarn add https://pkg.pr.new/@ngxs/[email protected]

@ngxs/devtools-plugin

yarn add https://pkg.pr.new/@ngxs/[email protected]

@ngxs/hmr-plugin

yarn add https://pkg.pr.new/@ngxs/[email protected]

@ngxs/router-plugin

yarn add https://pkg.pr.new/@ngxs/[email protected]

@ngxs/storage-plugin

yarn add https://pkg.pr.new/@ngxs/[email protected]

@ngxs/store

yarn add https://pkg.pr.new/@ngxs/[email protected]

@ngxs/websocket-plugin

yarn add https://pkg.pr.new/@ngxs/[email protected]

commit: b256490

Copy link

bundlemon bot commented Oct 25, 2024

BundleMon

Files updated (1)
Status Path Size Limits
fesm2022/ngxs-store.mjs
102.36KB (-95B -0.09%) 103KB / +0.5%
Unchanged files (5)
Status Path Size Limits
fesm2022/ngxs-store-internals.mjs
11.64KB 13KB / +0.5%
fesm2022/ngxs-store-internals-testing.mjs
6.83KB 7KB / +0.5%
fesm2022/ngxs-store-operators.mjs
6.22KB 7KB / +0.5%
fesm2022/ngxs-store-plugins.mjs
2.04KB 3KB / +0.5%
fesm2022/ngxs-store-experimental.mjs
1.4KB 2KB / +0.5%

Total files change -95B -0.07%

Unchanged groups (2)
Status Path Size Limits
@ngxs/store(esm2022)[gzip]
./esm2022/**/*.mjs
224.49KB +1%
@ngxs/store(fesm2022)[gzip]
./fesm2022/*.mjs
31.24KB +1%

Final result: ✅

View report in BundleMon website ➡️


Current branch size history | Target branch size history

Copy link

bundlemon bot commented Oct 25, 2024

BundleMon (NGXS Plugins)

Unchanged files (9)
Status Path Size Limits
Plugins(fesm2022)[gzip]
storage-plugin/fesm2022/ngxs-storage-plugin.m
js
4.15KB +0.5%
Plugins(fesm2022)[gzip]
router-plugin/fesm2022/ngxs-router-plugin.mjs
3.2KB +0.5%
Plugins(fesm2022)[gzip]
websocket-plugin/fesm2022/ngxs-websocket-plug
in.mjs
2.64KB +0.5%
Plugins(fesm2022)[gzip]
hmr-plugin/fesm2022/ngxs-hmr-plugin.mjs
2.61KB +0.5%
Plugins(fesm2022)[gzip]
form-plugin/fesm2022/ngxs-form-plugin.mjs
2.59KB +0.5%
Plugins(fesm2022)[gzip]
devtools-plugin/fesm2022/ngxs-devtools-plugin
.mjs
2.23KB +0.5%
Plugins(fesm2022)[gzip]
logger-plugin/fesm2022/ngxs-logger-plugin.mjs
2.03KB +0.5%
Plugins(fesm2022)[gzip]
storage-plugin/fesm2022/ngxs-storage-plugin-i
nternals.mjs
875B +0.5%
Plugins(fesm2022)[gzip]
router-plugin/fesm2022/ngxs-router-plugin-int
ernals.mjs
411B +0.5%

No change in files bundle size

Unchanged groups (1)
Status Path Size Limits
All Plugins(fesm2022)[gzip]
./-plugin/fesm2022/.mjs
20.71KB +0.5%

Final result: ✅

View report in BundleMon website ➡️


Current branch size history | Target branch size history

Copy link

bundlemon bot commented Oct 25, 2024

BundleMon (Integration Projects)

Unchanged files (3)
Status Path Size Limits
Main bundles(Gzip)
hello-world-ng18/dist-integration/browser/mai
n-(hash).js
71.87KB +1%
Main bundles(Gzip)
hello-world-ng17/dist-integration/main.(hash)
.js
68.69KB +1%
Main bundles(Gzip)
hello-world-ng16/dist-integration/main.(hash)
.js
67.8KB +1%

No change in files bundle size

Final result: ✅

View report in BundleMon website ➡️


Current branch size history | Target branch size history

Copy link

codeclimate bot commented Oct 25, 2024

Code Climate has analyzed commit b256490 and detected 0 issues on this pull request.

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 95.4% (0.0% change).

View more on Code Climate.

Copy link
Member

@markwhitfeld markwhitfeld left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe that the expected behaviour should be as follows...
(this is assuming that cancelUncompleted: true is present)

  • If the fire and forget action is left to run without a new action coming in, then it should be allowed to do as many writes to the context that it needs to (ie. the StateContext remains writeable)
  • but as soon as a second action comes in then the previous StateContext should become noop'ed so that it is no longer writeable.

Please add test cases to demonstrate both of these expected behaviours.

@arturovt
Copy link
Member Author

I'm afraid that might be difficult to implement. With your second approach, we would need to manually subscribe to the canceled observable:

const canceled = dispatched$.pipe(ofActionDispatched(action));

canceled.subscribe(() => {
  stateContext.setState = noop;
  stateContext.patchState = noop;
});

That is actually possible, but we need to unsubscribe from the canceled observable. However, the exact point at which we need to unsubscribe is unknown - perhaps when the action handler completes?

With the fire-and-forget approach, we never know if the action is still executing any functionality or when that functionality completes.

@markwhitfeld
Copy link
Member

markwhitfeld commented Oct 29, 2024 via email

@arturovt
Copy link
Member Author

arturovt commented Oct 30, 2024

My thoughts that fire-and-forget actions should not be cancellable. Instead, it should be the user’s responsibility to manage their cancellation by returning an observable, rather than subscribing to an observable and 'forgetting' it. I’d prefer not to capture previous state contexts because, if the fire-and-forget action never resolves, we wouldn't know when to release a reference to the previous state context.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants