feat(store): expose abort controller on state context #2244

arturovt · 2024-11-02T22:11:12Z

No description provided.

nx-cloud · 2024-11-02T22:13:14Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 8ae35ba. 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.

pkg-pr-new · 2024-11-03T16:02:07Z

Open in Stackblitz

@ngxs/devtools-plugin

yarn add https://pkg.pr.new/@ngxs/devtools-plugin@2244.tgz

@ngxs/router-plugin

yarn add https://pkg.pr.new/@ngxs/router-plugin@2244.tgz

@ngxs/hmr-plugin

yarn add https://pkg.pr.new/@ngxs/hmr-plugin@2244.tgz

@ngxs/form-plugin

yarn add https://pkg.pr.new/@ngxs/form-plugin@2244.tgz

@ngxs/storage-plugin

yarn add https://pkg.pr.new/@ngxs/storage-plugin@2244.tgz

@ngxs/store

yarn add https://pkg.pr.new/@ngxs/store@2244.tgz

@ngxs/websocket-plugin

yarn add https://pkg.pr.new/@ngxs/websocket-plugin@2244.tgz

commit: 8ae35ba

bundlemon · 2024-11-03T16:06:00Z

BundleMon

Files updated (2)

Status	Path	Size	Limits
❌	fesm2022/ngxs-store-internals.mjs	11.64KB (+348B +3.01%)	13KB / +0.5%
✅	fesm2022/ngxs-store.mjs	102.77KB (+268B +0.26%)	103KB / +0.5%

Unchanged files (4)

Status	Path	Size	Limits
✅	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 +616B +0.46%

Groups updated (2)

Status	Path	Size	Limits
✅	@ngxs/store(esm2022)[gzip] _{./esm2022/*/.mjs}	225.07KB (+920B +0.4%)	+1%
✅	@ngxs/store(fesm2022)[gzip] _{./fesm2022/*.mjs}	31.36KB (+236B +0.74%)	+1%

Final result: ❌

View report in BundleMon website ➡️

Current branch size history | Target branch size history

bundlemon · 2024-11-03T16:06:02Z

BundleMon (NGXS Plugins)

Files updated (1)

Status	Path	Size	Limits
❌	Plugins(fesm2022)[gzip] _{hmr-plugin/fesm2022/ngxs-hmr-plugin.mjs}	2.64KB (+25B +0.93%)	+0.5%

Unchanged files (8)

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] _{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%

Total files change +25B +0.12%

Groups updated (1)

Status	Path	Size	Limits
✅	All Plugins(fesm2022)[gzip] _{./-plugin/fesm2022/.mjs}	20.73KB (+25B +0.12%)	+0.5%

Final result: ❌

View report in BundleMon website ➡️

Current branch size history | Target branch size history

bundlemon · 2024-11-03T16:06:05Z

BundleMon (Integration Projects)

Files updated (3)

Status	Path	Size	Limits
✅	Main bundles(Gzip) _{hello-world-ng18/dist-integration/browser/mai n-(hash).js}	71.91KB (+99B +0.13%)	+1%
✅	Main bundles(Gzip) _{hello-world-ng17/dist-integration/main.(hash) .js}	68.72KB (+75B +0.11%)	+1%
✅	Main bundles(Gzip) _{hello-world-ng16/dist-integration/main.(hash) .js}	67.81KB (+57B +0.08%)	+1%

Total files change +231B +0.11%

Final result: ✅

View report in BundleMon website ➡️

Current branch size history | Target branch size history

markwhitfeld · 2024-11-08T19:54:41Z

packages/store/src/symbols.ts

@@ -99,6 +99,8 @@ export { StateOperator };
 * State context provided to the actions in the state.
 */
 export interface StateContext<T> {
+  abortController: AbortController;


Suggested change

abortController: AbortController;

abortSignal: AbortSignal;

markwhitfeld · 2024-11-08T19:55:45Z

packages/store/src/internal/state-factory.ts

+          const stateContext = this._stateContextFactory.createStateContext(
+            path,
+            abortController
+          );


Suggested change

const stateContext = this._stateContextFactory.createStateContext(

path,

abortController

);

const stateContext = this._stateContextFactory.createStateContext(

path,

abortSignal

);

markwhitfeld · 2024-11-08T19:56:30Z

packages/store/src/internal/state-factory.ts

+        const abortController = new AbortController();
+        const cancellable = !!actionMeta.options.cancelUncompleted;


Suggested change

const abortController = new AbortController();

const cancellable = !!actionMeta.options.cancelUncompleted;

const abortController = new AbortController();

const abortSignal = abortController.signal;

const cancellable = !!actionMeta.options.cancelUncompleted;

markwhitfeld · 2024-11-08T19:57:52Z

packages/store/src/internal/state-factory.ts

            }

+            const aborted = fromEvent(abortController.signal, 'abort');


Suggested change

const aborted = fromEvent(abortController.signal, 'abort');

const aborted = fromEvent(abortSignal, 'abort');

markwhitfeld · 2024-11-08T19:58:39Z

packages/store/src/internal/state-context-factory.ts

    const root = this._internalStateOperations.getRootStateOperations();

    return {
+      abortController: abortController!,


Suggested change

abortController: abortController!,

abortSignal: abortSignal!,

markwhitfeld · 2024-11-08T19:59:00Z

packages/store/src/internal/state-context-factory.ts


  /**
   * Create the state context
   */
-  createStateContext<T>(path: string): StateContext<T> {
+  createStateContext<T>(path: string, abortController?: AbortController): StateContext<T> {


Suggested change

createStateContext<T>(path: string, abortController?: AbortController): StateContext<T> {

createStateContext<T>(path: string, abortSignal?: AbortSignal): StateContext<T> {

markwhitfeld · 2024-11-08T20:01:12Z

packages/store/src/internal/lifecycle-state-manager.ts

@@ -99,6 +99,7 @@ export class LifecycleStateManager implements OnDestroy {
  }

  private _getStateContext(mappedStore: MappedStore): StateContext<any> {
+    // Question: abort controller is not gonna be available for lifecycle hooks.


I think that the abortSignal could be available for lifecycle hooks.
For example, when we have a local state, the abort signal for the lifecycle hooks would be triggered when the state should be unloaded.

packages/hmr-plugin/src/internal/hmr-state-context-factory.ts

markwhitfeld · 2024-11-08T20:14:18Z

packages/store/src/internal/state-factory.ts

@@ -345,10 +346,14 @@ export class StateFactory implements OnDestroy {
    const { dispatched$ } = this._actions;
    for (const actionType of Object.keys(actions)) {
      const actionHandlers = actions[actionType].map(actionMeta => {
-        const cancelable = !!actionMeta.options.cancelUncompleted;
+        const abortController = new AbortController();


If cancellation is enabled we would retain a reference to the previous abortController for the handler and when the next action hits this handler we would call abortController.abort() on the previous abortController to trigger the cancellation of the previous handler and of any related work that has used the abort signal from the context.
When the abortSignal fires for some work in progress in the handler (like fetch), the handler would throw an error, we should catch this error and not let it propagate to the action error handlers.

codeclimate · 2024-11-08T20:54:49Z

Code Climate has analyzed commit 8ae35ba 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.

arturovt force-pushed the feat/ac branch from a3e9f48 to 607b72a Compare November 3, 2024 16:00

arturovt force-pushed the feat/ac branch from 607b72a to ffe76c5 Compare November 3, 2024 17:02

markwhitfeld requested changes Nov 8, 2024

View reviewed changes

arturovt added 2 commits November 8, 2024 22:44

feat(store): expose abort controller on state context

835ff0c

chore: change to abort signal

8ae35ba

arturovt force-pushed the feat/ac branch from ffe76c5 to 8ae35ba Compare November 8, 2024 20:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(store): expose abort controller on state context #2244

feat(store): expose abort controller on state context #2244

arturovt commented Nov 2, 2024

nx-cloud bot commented Nov 2, 2024 •

edited

Loading

pkg-pr-new bot commented Nov 3, 2024 •

edited

Loading

bundlemon bot commented Nov 3, 2024 •

edited

Loading

bundlemon bot commented Nov 3, 2024 •

edited

Loading

bundlemon bot commented Nov 3, 2024 •

edited

Loading

markwhitfeld Nov 8, 2024

markwhitfeld Nov 8, 2024

markwhitfeld Nov 8, 2024

markwhitfeld Nov 8, 2024

markwhitfeld Nov 8, 2024

markwhitfeld Nov 8, 2024

markwhitfeld Nov 8, 2024

markwhitfeld Nov 8, 2024

codeclimate bot commented Nov 8, 2024

		const abortController = new AbortController();
		const cancellable = !!actionMeta.options.cancelUncompleted;

		}

		const aborted = fromEvent(abortController.signal, 'abort');

	const aborted = fromEvent(abortController.signal, 'abort');
	const aborted = fromEvent(abortSignal, 'abort');

	abortController: abortController!,
	abortSignal: abortSignal!,

	createStateContext<T>(path: string, abortController?: AbortController): StateContext<T> {
	createStateContext<T>(path: string, abortSignal?: AbortSignal): StateContext<T> {

feat(store): expose abort controller on state context #2244

Are you sure you want to change the base?

feat(store): expose abort controller on state context #2244

Conversation

arturovt commented Nov 2, 2024

nx-cloud bot commented Nov 2, 2024 • edited Loading

☁️ Nx Cloud Report

pkg-pr-new bot commented Nov 3, 2024 • edited Loading

bundlemon bot commented Nov 3, 2024 • edited Loading

BundleMon

bundlemon bot commented Nov 3, 2024 • edited Loading

BundleMon (NGXS Plugins)

bundlemon bot commented Nov 3, 2024 • edited Loading

BundleMon (Integration Projects)

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codeclimate bot commented Nov 8, 2024

nx-cloud bot commented Nov 2, 2024 •

edited

Loading

pkg-pr-new bot commented Nov 3, 2024 •

edited

Loading

bundlemon bot commented Nov 3, 2024 •

edited

Loading

bundlemon bot commented Nov 3, 2024 •

edited

Loading

bundlemon bot commented Nov 3, 2024 •

edited

Loading