makerspace / makeradmin

Stockholm Makerspace member administration and store.
https://docs.makeradmin.se/
21 stars 17 forks source link

Add accessy log #561

Closed HalfVoxel closed 1 month ago

HalfVoxel commented 1 month ago

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in this pull request involve multiple updates across various files, primarily enhancing functionality and organization. Key modifications include the addition of new dependencies in the requirements.txt, the introduction of a new SQL table for logging physical access events, and the enhancement of webhook handling in the multiaccessy module. Additionally, several methods and classes related to webhook events have been added, along with improvements in type annotations for better clarity. Configuration changes in docker-compose.yml and create_env.py further refine the environment setup.

Changes

File Change Summary
api/requirements.txt Added NamedAtomicLock, moved dataclasses_json to runtime requirements while retaining it in test requirements.
api/src/api.py Imported register_accessy_webhook from multiaccessy.accessy and called it post permission registration.
api/src/migrations/0028_initial_accessy_log.sql Added new table physical_access_log with specified columns and constraints for logging physical access events.
api/src/multiaccessy/__init__.py Imported InternalService and created an instance named service.
api/src/multiaccessy/accessy.py Introduced AccessyWebhookEventType enum and several data classes, updated request method signature, added multiple methods for webhook management, and enhanced type hints.
api/src/multiaccessy/models.py Added new SQLAlchemy model PhysicalAccessEntry for physical_access_log.
api/src/multiaccessy/views.py Added data classes for webhook events, implemented decode_event and handle_event functions, and created accessy_webhook endpoint for handling incoming events.
api/src/service/entity.py Updated fromisoformat method signature to specify parameter and return types.
api/src/services.py Added Instance(path="/accessy", service=multiaccessy.service) to services tuple.
create_env.py Removed CORS_ALLOWED_ORIGINS from configuration dictionary.
docker-compose.yml Added HOST_BACKEND environment variable to api service, updated CORS_ALLOWED_ORIGINS to include HOST_BACKEND.

Poem

In the burrow deep, where the code does leap,
Changes abound, like secrets we keep.
With webhooks in tow, and logs to show,
The rabbit hops high, as new features grow.
Dependencies added, the structure refined,
A dance of the code, in harmony aligned! 🐇✨


📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Files that changed from the base of the PR and between 2e28f18be02b68bb2ff553ef4fbd7c461186cd4a and 7690637ac50a5fd002da96e625f06fd0014f6cc5.
📒 Files selected for processing (1) * api/src/multiaccessy/views.py (1 hunks)
🔇 Additional comments (5)
api/src/multiaccessy/views.py (5)
`1-17`: **LGTM! Well-organized imports and logger setup.** The imports are properly structured and all necessary dependencies are included. --- `131-134`: **Skipping comment about inconsistent role field type** This issue was already identified in a previous review. --- `184-184`: **Skipping comments about assert statements** These issues were already identified in previous reviews. Also applies to: 190-190 --- `214-220`: **Skipping comment about header validation** This issue was already addressed in a previous review. --- `158-170`: **Consider implementing commented-out event types** There are several commented-out event types in the mapping. If these events are expected to be received, they should be implemented to ensure complete webhook handling coverage. Let's check if these events are actually needed: Would you like help implementing the missing event types?
--- 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.