makerspace / makeradmin

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

Upgrade sqlalchemy to version 2 #562

Open emanuelen5 opened 4 weeks ago

emanuelen5 commented 4 weeks ago

Closes #489

Summary by CodeRabbit

coderabbitai[bot] commented 4 weeks ago

Walkthrough

The pull request introduces several modifications across multiple files, primarily focusing on updating the SQLAlchemy version constraint in requirements.txt to ~=2.0. Additionally, it simplifies member retrieval methods by replacing db_session.query(Model).get(id) with db_session.get(Model, id) in various functions, enhancing code clarity and efficiency. Other changes include improved SQL execution handling using the text() construct from SQLAlchemy, adjustments to relationship configurations in ORM models, and minor import statement reorganizations.

Changes

File Path Change Summary
api/requirements.txt Updated sqlalchemy version constraint from >=1.4.9,<2.0 to ~=2.0.
api/src/core/auth.py Simplified member retrieval in password_reset function.
api/src/core/models.py Consolidated imports and updated SQL execution methods to use text().
api/src/firstrun.py Simplified member retrieval in create_admin function.
api/src/init_db.py Updated SQL execution to use text() in clear_permission_cache.
api/src/member/member.py Simplified member retrieval in send_updated_member_info_email and set_pin_code functions; improved error handling in set_pin_code.
api/src/member/views.py Simplified member retrieval in current_member function.
api/src/membership/member_entity.py Updated SQL execution to use text() and improved error handling in create method.
api/src/membership/models.py Updated relationship definitions with cascade_backrefs=False and adjusted imports.
api/src/messages/models.py Consolidated import statements.
api/src/migrate.py Updated SQL execution to use text() for various SQL statements.
api/src/multiaccessy/invite.py Simplified member retrieval in check_labaccess_requirements and ensure_accessy_labaccess.
api/src/multiaccessy/models.py Consolidated import statements.
api/src/pytest.ini Removed SQLAlchemy 2.0 compatibility warning filter.
api/src/quiz/models.py Updated relationship definitions with cascade_backrefs=False.
api/src/quiz/views.py Enhanced SQL handling in quiz_statistics and simplified member retrieval in answer_question.
api/src/service/auth.py Simplified token retrieval in authenticate_request function.
api/src/service/entity.py Simplified entity retrieval in read, _update_internal, and delete methods.
api/src/shell_with_db.py Removed unnecessary import statements.
api/src/shop/email.py Simplified member retrieval in email sending functions.
api/src/shop/filters.py Simplified member retrieval in filter_no_subscription_active.
api/src/shop/models.py Updated relationship definitions with cascade_backrefs=False.
api/src/shop/ordered_entity.py Updated SQL execution to use text() in create method.
api/src/shop/pay.py Simplified member retrieval in payment-related functions.
api/src/shop/shop_data.py Integrated TransactionContent model into transaction handling logic.
api/src/shop/stripe_customer.py Simplified member retrieval in delete_stripe_customer function.
api/src/shop/stripe_event.py Simplified member retrieval in multiple functions related to Stripe events.
api/src/shop/stripe_payment_intent.py Simplified member and transaction retrieval in payment functions.
api/src/shop/stripe_subscriptions.py Simplified member retrieval in subscription-related functions.
api/src/shop/transactions.py Updated SQL execution to use text() and simplified member retrieval in transaction functions.
api/src/statistics/maker_statistics.py Added text import and updated SQL execution in lasertime function.
api/src/systest/api/password_reset_test.py Simplified member retrieval in test function.
api/src/test_aid/db.py Added text import and updated SQL execution in get_member_number method.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant DB

    Client->>API: Request password reset
    API->>DB: Get member by token
    DB-->>API: Return member
    API-->>Client: Send password reset email

Assessment against linked issues

Objective Addressed Explanation
Upgrade to SQLAlchemy 2 (Issue #489)
Use replacement style in the form of select No changes were made to implement the select style.

Possibly related PRs

Suggested reviewers

Poem

🐇 In the code where rabbits play,
SQLAlchemy leads the way.
With get we hop, no need to query,
Simplified paths, oh so cheery!
Dependencies updated, all in line,
Hopping forward, our code will shine! 🌟


📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Reviewing files that changed from the base of the PR and between 24e635b18f94443b86956a4e87c41c607f1784ff and 21911b43c678a5a9ee70a741f6bfdd2a4fdf2fe5.
📒 Files selected for processing (1) * `api/requirements.txt` (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1) * api/requirements.txt

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://docs.coderabbit.ai) 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.
emanuelen5 commented 4 weeks ago

The tests still fail. Simple reproducer:

PYTEST_ADDOPTS='-k test_reminder_message_is_created_20_days_before_expiry_even_if_other_span_after' make test
emanuelen5 commented 3 weeks ago

@coderabbitai review

coderabbitai[bot] commented 3 weeks ago
:white_check_mark: Actions performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.
emanuelen5 commented 3 weeks ago

@coderabbitai review

coderabbitai[bot] commented 3 weeks ago
:white_check_mark: Actions performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.