Create SessionManagerTest.php +semver: minor

guibranco commented 2 weeks ago

Closes #245

📑 Description

✅ Checks

[X] My pull request adheres to the code style of this project
[X] My code requires changes to the documentation
[X] I have updated the documentation as required
[X] All the tests have passed

☢️ Does this introduce a breaking change?

[ ] Yes
[X] No

ℹ Additional Information

Summary by CodeRabbit

Tests
- Introduced a comprehensive suite of unit tests for session management functionalities.
- Validated various scenarios including session start, key existence, session destruction, and expiration.
- Ensured robust testing with methods for setting and retrieving session values, handling flash messages, and regenerating session IDs.
Chores
- Enhanced the commit message generation script with improved error handling and functionality.
- Added support for bypassing the script and checking for required tools.
Style
- Updated spell-checking configuration to recognize the term "httponly."
Refactor
- Improved the SessionManager class with updated method signatures and enhanced error handling through a new SessionException class.

coderabbitai[bot] commented 2 weeks ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The changes introduce a new file, SessionManagerTest.php, which contains a complete suite of unit tests for the SessionManager class. The tests utilize PHPUnit and cover various functionalities such as session management, including starting sessions, managing session values, and handling session expiration. The test suite ensures that the SessionManager behaves correctly in multiple scenarios and includes setup and teardown methods to maintain test integrity.

Changes

File	Change Summary
tests/SessionManagerTest.php	Added a new test class `SessionManagerTest` with multiple test methods to validate functionalities of the `SessionManager` class, including session start, value retrieval, key existence, session destruction, ID regeneration, flash messaging, and session expiration.
.githooks/prepare-commit-msg	Modified the script to enhance functionality for generating AI-powered commit messages, including error handling and bypass options.
.vscode/settings.json	Added "httponly" to the `cSpell.words` setting for spell checker recognition.
src/SessionManager.php	Updated method signatures and internal logic in the `SessionManager` class, introduced `SessionException`, and refined session management methods.

Assessment against linked issues

Objective	Addressed	Explanation
Add unit tests for `start()`, `set()`, `get()`, `has()`, `remove()`, `destroy()`, `regenerate()`, `flash()`, `getFlash()`, `setExpiration()` (#245)	✅
Ensure session starts properly if not already started (#245)	✅
Validate session key-value storage and retrieval (#245)	✅
Ensure proper handling of session destruction and ID regeneration (#245)	✅
Implement flash messaging functionality (#245)	✅

Possibly related PRs

#240: Introduces the SessionManager class, which is being tested in the current PR.

Suggested labels

🚦 awaiting triage

Suggested reviewers

gstraccini

Poem

In the land of code where rabbits play,
New tests hop in to save the day.
Sessions start and values set,
With every check, no room for regret.
Flash messages dance, and keys disappear,
Our SessionManager shines bright, oh dear! 🐇✨

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 , please review it.` - `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### 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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

deepsource-io[bot] commented 2 weeks ago

Here's the code health analysis summary for commits f2a503e..a04c997. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Link
Test coverage	✅ Success	View Check ↗
SQL	✅ Success	View Check ↗
Secrets	✅ Success	View Check ↗
PHP	✅ Success	View Check ↗
Docker	✅ Success	View Check ↗

Code Coverage Report

Metric	Aggregate	Php
Branch Coverage	100%	100%
Composite Coverage	89.9% (up 9.5% from `main`)	89.9% (up 9.5% from `main`)
Line Coverage	89.9% (up 9.5% from `main`)	89.9% (up 9.5% from `main`)

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

guibranco commented 2 weeks ago

@gstraccini rerun failed workflwos

gstraccini[bot] commented 2 weeks ago

I'm sorry @guibranco, I can't do that. Command not found. :pleading_face:

guibranco commented 2 weeks ago

@gstraccini rerun failed workflows

gstraccini[bot] commented 2 weeks ago

Rerunning 6 failed workflows on the commit 5bd6a4db305456b0d1c3bee58eaa959ece824a62! :repeat:

gstraccini[bot] commented 2 weeks ago

Rerunning the following workflows:

Deep Source - 🔄
Sonar Cloud - 🔄
Code Climate - 🔄
Build - 🔄
Codacy - 🔄
Codecov - 🔄

github-actions[bot] commented 2 weeks ago

Infisical secrets check: ✅ No secrets leaked!

💻 Scan logs

```txt 10:02PM INF scanning for exposed secrets... 10:02PM INF 183 commits scanned. 10:02PM INF scan completed in 413ms 10:02PM INF no leaks found ```

codacy-production[bot] commented 2 weeks ago

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
Report missing for f2a503eab7e88f04d602a309df9769146a466d5d[^1]	:white_check_mark: 80.00%

Coverage variation details

| | Coverable lines | Covered lines | Coverage | | ------------- | ------------- | ------------- | ------------- | | Common ancestor commit (f2a503eab7e88f04d602a309df9769146a466d5d) | Report Missing | Report Missing | Report Missing | | | Head commit (a04c9973c73f8bf1500f01f95880f66b06be77e5) | 308 | 277 | 89.94% | **Coverage variation** is the difference between the coverage for the head and common ancestor commits of the pull request branch: ` - `

Diff coverage details

| | Coverable lines | Covered lines | Diff coverage | | ------------- | ------------- | ------------- | ------------- | | Pull request (#246) | 15 | 12 | **80.00%** | **Diff coverage** is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: `/ * 100%`

See your quality gate settings Change summary preferences

_{Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more} [^1]: Codacy didn't receive coverage data for the commit, or there was an error processing the received data. Check your integration for errors and validate that your coverage setup is correct.