feat(storage-plugin): allow providing feature states #1994

arturovt · 2023-04-11T20:27:39Z

Issue: #850

This commit introduces the ability to specify states for persistence at the feature level.
Previously, you could only specify a list of states for persistence when providing the storage
plugin at the root level. This feature is only available with the standalone API, as Angular has
an ENVIRONMENT_INITIALIZER feature that allows us to add these states at the feature level.

The API is simple and straightforward. It introduces the withStorageFeature function, which
can be called along with provideStates. It requires a list of states to be provided. If all
states are already being persisted because the developer specified keys: * at the root level,
this won't do anything.

markwhitfeld · 2023-04-14T10:23:04Z

Very interesting work going on here! 🎉
Could you add a description to the PR (as well as a linked issue or discussion if applicable) so that the problem, and proposed solution are clear?

nx-cloud · 2023-10-02T16:28:18Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 4d8ac9a. 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 3 targets

Sent with 💌 from NxCloud.

bundlemon · 2023-10-02T16:28:37Z

BundleMon (Integration Projects)

Files updated (2)

Status	Path	Size	Limits
✅	Main bundles(Gzip) _{hello-world-ng16/dist-integration/main.(hash) .js}	66.85KB (+96B +0.14%)	+1%
✅	Main bundles(Gzip) _{hello-world-ng17/dist-integration/main.(hash) .js}	68.38KB (+91B +0.13%)	+1%

Total files change +187B +0.14%

Final result: ✅

View report in BundleMon website ➡️

Current branch size history | Target branch size history

markwhitfeld

This is a really awesome feature!
We need a bit more information of what this feature looks like, so could you add a section in the docs about it, or describe it in the PR description, so that what the feature looks like is clear for review.
Is there a linked issue or discussion? This may assist in making the the problem, and proposed solution clearer.

packages/storage-plugin/tests/storage-for-feature.spec.ts

markwhitfeld · 2024-02-09T11:05:01Z

packages/storage-plugin/internals/src/storage-key.ts

@@ -12,7 +12,7 @@ export interface KeyWithExplicitEngine {

 /** Determines whether the provided key has the following structure. */
 export function ɵisKeyWithExplicitEngine(key: any): key is KeyWithExplicitEngine {
-  return key != null && !!key.engine;
+  return !!key?.engine;


Although very succinct, it is difficult to understand this. Adding brackets would help with understanding.

Suggested change

return !!key?.engine;

return !!(key?.engine);

Caveat... if the prettier formatter wants to remove the brackets, then we would have to rather revert to the previous longer form of this.

Suggested change

return !!key?.engine;

return Boolean(key?.engine);

markwhitfeld · 2024-02-09T11:22:54Z

packages/storage-plugin/tests/storage-for-feature.spec.ts

+      NgxsStoragePluginModule.forRoot({
+        key: [CounterState]
+      })


We also need to test the case where the root plugin has been initialised with no keys present (therefore every state is stored), and then the blog route is loaded, which will set a key and engine. Will the existing states be stored? I'm not sure if the current logic handles this scenario.

I think the expectation would be that all states would be stored in the default key, and that explicitly specified feature states would be stored separately.
Maybe we need to discuss what would happen for any other feature states... What is the current behaviour for lazy feature states?

markwhitfeld · 2024-02-09T11:24:14Z

packages/storage-plugin/src/keys-manager.ts

+
+@Injectable({ providedIn: 'root' })
+export class ɵNgxsStoragePluginKeysManager {
+  readonly keysWithEngines: KeyWithEngine[] = [];


Exposing this breaks encapsulation. We need to discuss alternatives to exposing this property.

nx-cloud · 2024-02-16T10:11:34Z

☁️ Nx Cloud Report

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

This commit introduces the ability to specify states for persistence at the feature level. Previously, you could only specify a list of states for persistence when providing the storage plugin at the root level. This feature is only available with the standalone API, as Angular has an `ENVIRONMENT_INITIALIZER` feature that allows us to add these states at the feature level. The API is simple and straightforward. It introduces the `withStorageFeature` function, which can be called along with `provideStates`. It requires a list of states to be provided. If all states are already being persisted because the developer specified `keys: *` at the root level, this won't do anything.

codeclimate · 2024-03-13T01:05:25Z

Code Climate has analyzed commit 046d028 and detected 1 issue on this pull request.

Here's the issue category breakdown:

Category	Count
Complexity	1

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

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

View more on Code Climate.

isochronous · 2024-06-25T18:25:16Z

Please, add some documentation around this withStorageFeature function

isochronous · 2024-06-25T18:31:37Z

And does this method support the beforeSerialize and afterDeserialize lifecycle methods that are provided via the .forRoot version?

arturovt changed the base branch from v-next to master October 2, 2023 16:09

arturovt force-pushed the feat/storage-feature branch from bf03709 to e0f96a2 Compare October 2, 2023 16:22

arturovt marked this pull request as ready for review October 2, 2023 16:23

arturovt requested review from markwhitfeld, kuncevic, Carniatto, poloagustin, joaqcid and splincode as code owners October 2, 2023 16:23

arturovt force-pushed the feat/storage-feature branch from e0f96a2 to a33b2f5 Compare October 2, 2023 16:28

markwhitfeld requested changes Oct 20, 2023

View reviewed changes

arturovt force-pushed the feat/storage-feature branch from a33b2f5 to 4d8ac9a Compare October 20, 2023 20:12

markwhitfeld reviewed Oct 30, 2023

View reviewed changes

packages/storage-plugin/tests/storage-for-feature.spec.ts Outdated Show resolved Hide resolved

markwhitfeld requested changes Feb 9, 2024

View reviewed changes

arturovt force-pushed the feat/storage-feature branch from 4d8ac9a to c24ee47 Compare February 16, 2024 10:10

arturovt force-pushed the feat/storage-feature branch 6 times, most recently from dc7dfd0 to 589d87b Compare March 12, 2024 20:42

rhutchison approved these changes Mar 13, 2024

View reviewed changes

arturovt force-pushed the feat/storage-feature branch from 033e7c8 to 046d028 Compare March 13, 2024 01:05

arturovt merged commit 8085e85 into master Mar 13, 2024
12 of 13 checks passed

arturovt deleted the feat/storage-feature branch March 13, 2024 01:26

markwhitfeld added this to the v.18.0.0 milestone Jun 24, 2024

markwhitfeld added the released label Jun 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(storage-plugin): allow providing feature states #1994

feat(storage-plugin): allow providing feature states #1994

arturovt commented Apr 11, 2023 •

edited

Loading

markwhitfeld commented Apr 14, 2023

nx-cloud bot commented Oct 2, 2023 •

edited

Loading

bundlemon bot commented Oct 2, 2023 •

edited

Loading

markwhitfeld left a comment

markwhitfeld Feb 9, 2024

rhutchison Feb 9, 2024

markwhitfeld Feb 9, 2024

markwhitfeld Feb 9, 2024

nx-cloud bot commented Feb 16, 2024 •

edited

Loading

codeclimate bot commented Mar 13, 2024

isochronous commented Jun 25, 2024

isochronous commented Jun 25, 2024

feat(storage-plugin): allow providing feature states #1994

feat(storage-plugin): allow providing feature states #1994

Conversation

arturovt commented Apr 11, 2023 • edited Loading

markwhitfeld commented Apr 14, 2023

nx-cloud bot commented Oct 2, 2023 • edited Loading

☁️ Nx Cloud Report

bundlemon bot commented Oct 2, 2023 • edited Loading

BundleMon (Integration Projects)

markwhitfeld left a comment

Choose a reason for hiding this comment

markwhitfeld Feb 9, 2024

Choose a reason for hiding this comment

rhutchison Feb 9, 2024

Choose a reason for hiding this comment

markwhitfeld Feb 9, 2024

Choose a reason for hiding this comment

markwhitfeld Feb 9, 2024

Choose a reason for hiding this comment

nx-cloud bot commented Feb 16, 2024 • edited Loading

☁️ Nx Cloud Report

codeclimate bot commented Mar 13, 2024

isochronous commented Jun 25, 2024

isochronous commented Jun 25, 2024

arturovt commented Apr 11, 2023 •

edited

Loading

nx-cloud bot commented Oct 2, 2023 •

edited

Loading

bundlemon bot commented Oct 2, 2023 •

edited

Loading

nx-cloud bot commented Feb 16, 2024 •

edited

Loading