refactor(store): tree-shake internal state tokens by arturovt · Pull Request #2246 · ngxs/store

arturovt · 2024-11-03T17:08:44Z

In this commit, we remove internal injection token providers from the root providers list. Instead, we expose a function that provides these tokens.

nx-cloud · 2024-11-03T17:11:16Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 0a93595. 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-03T17:11:39Z

Open in Stackblitz

@ngxs/devtools-plugin

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

@ngxs/form-plugin

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

@ngxs/hmr-plugin

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

@ngxs/router-plugin

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

@ngxs/storage-plugin

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

@ngxs/store

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

@ngxs/websocket-plugin

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

commit: 0a93595

bundlemon · 2024-11-03T17:15:53Z

BundleMon

Files updated (2)

Status	Path	Size	Limits
✅	fesm2022/ngxs-store.mjs	102.86KB (+368B +0.35%)	103KB / +0.5%
✅	fesm2022/ngxs-store-internals.mjs	11.33KB (+32B +0.28%)	13KB / +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 +400B +0.3%

Groups updated (2)

Status	Path	Size	Limits
✅	@ngxs/store(esm2022)[gzip] _{./esm2022/*/.mjs}	225.62KB (+1.44KB +0.64%)	+1%
✅	@ngxs/store(fesm2022)[gzip] _{./fesm2022/*.mjs}	31.29KB (+168B +0.53%)	+1%

Final result: ✅

View report in BundleMon website ➡️

Current branch size history | Target branch size history

bundlemon · 2024-11-03T17:15:55Z

BundleMon (NGXS Plugins)

Unchanged files (9)

Status	Path	Size	Limits
✅	Plugins(fesm2022)[gzip] _{storage-plugin/fesm2022/ngxs-storage-plugin.m js}	4.16KB	+0.5%
✅	Plugins(fesm2022)[gzip] _{router-plugin/fesm2022/ngxs-router-plugin.mjs}	3.19KB	+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

bundlemon · 2024-11-03T17:15:57Z

BundleMon (Integration Projects)

Files updated (3)

Status	Path	Size	Limits
✅	Main bundles(Gzip) _{hello-world-ng17/dist-integration/main.(hash) .js}	68.51KB (-22B -0.03%)	+1%
✅	Main bundles(Gzip) _{hello-world-ng16/dist-integration/main.(hash) .js}	67.61KB (-33B -0.05%)	+1%
✅	Main bundles(Gzip) _{hello-world-ng18/dist-integration/browser/mai n-(hash).js}	71.62KB (-56B -0.08%)	+1%

Total files change -111B -0.05%

Final result: ✅

View report in BundleMon website ➡️

Current branch size history | Target branch size history

markwhitfeld

I'm trying to understand the motivation here?
What is the practical benefit of the tree shaking? What problem are we solving?

arturovt · 2024-11-08T20:32:40Z

Tokens are removed from the bundle.

In this commit, we remove internal injection token providers from the root providers list. Instead, we expose a function that provides these tokens.

qlty-cloud-legacy · 2024-11-10T12:35:48Z

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

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

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

View more on Code Climate.

arturovt · 2024-11-12T11:50:56Z

Merging because I want to proceed with the next patch release. This change only reduces the bundle size by removing tokens that are not used in standard apps. These tokens were previously exposed as part of the ngxs-labs/data package.

hakimio · 2024-11-12T12:22:54Z

-import {
-  ɵStateClass,
-  ɵNGXS_STATE_CONTEXT_FACTORY,
-  ɵNGXS_STATE_FACTORY,


@arturovt ɵNGXS_STATE_FACTORY is used by @angular-ru/ngxs ☹

They will need to use the ɵprovideNgxsInternalStateTokens in their providers list.

How do you inject the factory without having access to the injection token? State factory itself is used in the code.

You can still inject the factory through the token.

Through which token?

I don't understand the phrase "having access to the token". Why don't you have access to the token?

ngxs no longer exports ɵNGXS_STATE_FACTORY and ɵNGXS_STATE_CONTEXT_FACTORY tokens after this PR was merged.

It didn't export it before either.

Ok, my bad. For some reason instead of import, I thought export was removed. The tokens are still exported from @ngxs/store/internals. I'll try to use ɵprovideNgxsInternalStateTokens() to see if it fixes the issue.

ɵprovideNgxsInternalStateTokens() fixes the issue. Sorry for the confusion.

arturovt requested review from Carniatto, joaqcid, kuncevic, markwhitfeld, poloagustin and splincode as code owners November 3, 2024 17:08

arturovt force-pushed the refactor/tokens branch from 066a020 to 35a8968 Compare November 3, 2024 22:17

markwhitfeld reviewed Nov 8, 2024

View reviewed changes

refactor(store): tree-shake internal state tokens

0a93595

In this commit, we remove internal injection token providers from the root providers list. Instead, we expose a function that provides these tokens.

arturovt force-pushed the refactor/tokens branch from 35a8968 to 0a93595 Compare November 10, 2024 12:28

arturovt merged commit 2699787 into master Nov 12, 2024

arturovt deleted the refactor/tokens branch November 12, 2024 11:50

hakimio reviewed Nov 12, 2024

View reviewed changes

Uh oh!

Conversation

arturovt commented Nov 3, 2024

Uh oh!

nx-cloud Bot commented Nov 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

☁️ Nx Cloud Report

Uh oh!

pkg-pr-new Bot commented Nov 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bundlemon Bot commented Nov 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

BundleMon

Uh oh!

bundlemon Bot commented Nov 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

BundleMon (NGXS Plugins)

Uh oh!

bundlemon Bot commented Nov 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

BundleMon (Integration Projects)

Uh oh!

markwhitfeld left a comment

Choose a reason for hiding this comment

Uh oh!

arturovt commented Nov 8, 2024

Uh oh!

qlty-cloud-legacy Bot commented Nov 10, 2024

Uh oh!

arturovt commented Nov 12, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

arturovt Nov 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

nx-cloud Bot commented Nov 3, 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

arturovt Nov 12, 2024 •

edited

Loading