feat(#684): add druxtMenu/flushEntities mutation

Decipher commented 6 months ago

Types of changes

[ ] Bug fix (a non-breaking change which fixes an issue)
[ ] New feature (a non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Description

Adds druxtMenu/flushEntities Vuex mutation to allow the menu vuex store to be flushed when logging in/out with an authenticated user.

Checklist:

[ ] My change requires a change to the documentation.
[ ] I have updated the documentation accordingly. (PR: #)
[ ] I have added tests to cover my changes (if not applicable, please state why)
[ ] All new and existing tests are passing.

Screenshots/Media:

Summary by CodeRabbit

New Features
- Implemented a feature to refresh menu data for logged-in users, ensuring up-to-date information is displayed.
Refactor
- Enhanced the menu data management to allow selective clearing of menu-related data from the application state.

changeset-bot[bot] commented 6 months ago

🦋 Changeset detected

Latest commit: 273a630d6ee79a812aa68a198ecdea984dad4b3d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

| Name | Type | | ---------- | ----- | | druxt-menu | Minor | | druxt-site | Patch |

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

coderabbitai[bot] commented 6 months ago

Walkthrough

The DruxtMenu component has been updated to enhance cache management for logged-in users on statically generated sites. It now includes functionality to clear specific menu-related entities from the Vuex state before fetching new menu data. This ensures that users see the most current menu information without old data interfering.

Changes

File Path Change Summary

.packages/menu/src/components/DruxtMenu.vue, .changeset/happy-ties-rule.md Added a commit to flush entities with a specific prefix before fetching menu data if logged in and statically generated.

.packages/menu/src/stores/menu.js, .test/stores/menu.test.js Modified DruxtMenuStore to include a new flushEntities mutator function, which removes JSON:API menu item entities from the Vuex state object. This function takes a prefix parameter and can be used to flush all menu entities or entities for a specific prefix. Added tests for the AddEntities and flushEntities functions in the DruxtStore to verify the behavior of adding and flushing entities in the druxtMenu store.

File Path	Change Summary
`.packages/menu/src/components/DruxtMenu.vue, .changeset/happy-ties-rule.md`	Added a commit to flush entities with a specific prefix before fetching menu data if logged in and statically generated.
`.packages/menu/src/stores/menu.js, .test/stores/menu.test.js`	Modified `DruxtMenuStore` to include a new `flushEntities` mutator function, which removes JSON:API menu item entities from the Vuex state object. This function takes a `prefix` parameter and can be used to flush all menu entities or entities for a specific prefix. Added tests for the `AddEntities` and `flushEntities` functions in the `DruxtStore` to verify the behavior of adding and flushing entities in the `druxtMenu` store.

🐇💻✨
In the code burrow, deep and vast,
A rabbit tweaked the menu's past.
Old data flushed, the new shall last,
Ensuring menus are unsurpassed. 🍃🥕

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with CodeRabbit: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit tests for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository from git and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.

codecov[bot] commented 6 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (96d693d) 96.14% compared to head (273a630) 96.23%.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## develop #689 +/- ## =========================================== + Coverage 96.14% 96.23% +0.09% =========================================== Files 91 91 Lines 2362 2367 +5 Branches 509 511 +2 =========================================== + Hits 2271 2278 +7 + Misses 76 74 -2 Partials 15 15 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

druxt / druxt.js