Added `PasswordPolicy` for managing password expiry period data

henry0715-dev commented 2 months ago

Close #326

Summary by CodeRabbit

New Features
- Introduced a PasswordPolicy entity for enhanced password management, including an expiration period.
- Added a new method for managing password policies in the Store and StateDb.
Bug Fixes
- Corrected the return type for account policy mapping to improve accuracy.
Improvements
- Streamlined logging in the backup module for better clarity.
- Enhanced the organization of data structures related to outlier information.
Documentation
- Updated changelog with a summary of changes for better user awareness.

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes introduce a new PasswordPolicy entity to manage password expiration periods, enhancing password management capabilities. Key modifications include an updated update method signature in Table<'d, Account>, a refined return type for Store::outlier_map, and a reorganization of the OutlierInfo structure. Additionally, redundant logging in the backup module has been streamlined, contributing to improved code clarity and functionality.

Changes

Files	Change Summary
`CHANGELOG.md`, `src/lib.rs`, `src/tables.rs`	Introduced `PasswordPolicy` entity and associated methods, modified public interfaces to include new functionality related to password management.
`src/tables/account_policy.rs`	Added `PasswordPolicy` struct with methods for managing password expiration periods, including CRUD operations and a new constant for the expiration key.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Store
    participant PasswordPolicy

    User->>Store: Request password policy
    Store->>PasswordPolicy: Retrieve password policy data
    PasswordPolicy-->>Store: Return password policy
    Store-->>User: Provide password policy information

Assessment against linked issues

Objective	Addressed	Explanation
Introduce `PasswordPolicy` for password expiration period ( #326 )	✅
Implement CRUD functionality for password expiration period ( #326 )	✅
Modify existing account policy functions for new expiration logic ( #326 )	❓	Unclear if existing functions were modified to accommodate the new structure.

Poem

🐇 In the meadow where passwords bloom,
A policy now clears the gloom.
With days counted, we cheer and play,
For security grows brighter each day!
Hops of joy in the code we weave,
In this world, we truly believe! 🌼

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](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - 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 testing code 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 and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - 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/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov[bot] commented 2 months ago

Codecov Report

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

Project coverage is 61.97%. Comparing base (42a05b0) to head (2e4b2eb).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #333 +/- ## ========================================== + Coverage 61.87% 61.97% +0.09% ========================================== Files 97 97 Lines 19186 19235 +49 ========================================== + Hits 11872 11921 +49 Misses 7314 7314 ```

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

sehkone commented 2 months ago

Closed because this will be revisited on a solid basis later.

petabi / review-database