Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: new cookie flag preventing auth cookie from being stored #36

Merged
merged 1 commit into from
Jun 11, 2024

Conversation

ep1cman
Copy link
Collaborator

@ep1cman ep1cman commented Jun 11, 2024

As of UniFi Protect 4.0.5, they have started sending the cookie flag "partitioned". Python currently does not know about this (planned to be fixed in 3.13 python/cpython#112713). This causes the cookie to be considered invalid, and thus the auth cookie is never saved. Since unifi protect rate limits authentication attempts this leads to 501 errors after a few requests are made.

This commit adds partitioned to the list of cookie flags the standard library accepts as valid. Thus allowing the cookie to be correctly parsed and saved.

Summary by CodeRabbit

  • New Features
    • Improved compatibility for older Python versions (prior to 3.13) in handling cookies.
    • Introduced new constants for better token management: TOKEN_COOKIE_MAX_EXP_SECONDS and NEVER_RAN.

As of UniFi Protect 4.0.5, they have started sending the cookie flag "partitioned".
Python currently does not know about this (planned to be fixed in 3.13 python/cpython#112713).
This causes the cookie to be considered invalid, and thus the auth cookie is never saved.
Since unifi protect rate limits authentication attempts this leads to 501 errors after a few requests are made.

This commit adds `partitioned` to the list of cookie flags the standard library accepts as valid.
Thus allowing the cookie to be correctly parsed and saved.
Copy link
Contributor

coderabbitai bot commented Jun 11, 2024

Walkthrough

The change in the src/uiprotect/api.py file introduces compatibility handling for Python versions prior to 3.13 by importing cookies from http and modifying cookies.Morsel attributes. It also defines two constants: TOKEN_COOKIE_MAX_EXP_SECONDS set to 60 and NEVER_RAN set to -1000, ensuring better compatibility and functionality in the codebase.

Changes

Files Change Summary
src/uiprotect/api.py Added compatibility handling for Python < 3.13 by importing cookies from http. Modified cookies.Morsel attributes by adding "partitioned" to _reserved and _flags. Defined constants TOKEN_COOKIE_MAX_EXP_SECONDS and NEVER_RAN.

Poem

In the land of code, a change was made,
For cookies and constants, the path was laid.
Python's versions now in harmony,
With Morsel tweaks and constants, see?
Sixty seconds for a token's stay,
And NEVER_RAN to guide the way.
CodeRabbit hops in delight,
For the code is now just right! 🐇✨


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
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 <commit_id>.
    • 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 Configration 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5ac7a6e and 4bab6e9.

Files selected for processing (1)
  • src/uiprotect/api.py (1 hunks)
Additional comments not posted (2)
src/uiprotect/api.py (2)

68-73: Ensure compatibility with Python versions prior to 3.13 by handling the 'partitioned' cookie flag.

This change is crucial for maintaining compatibility until Python 3.13 is released, which will natively support the 'partitioned' flag. The reference to the Python issue provides good context and justification for this temporary fix.


74-74: Define constants for token cookie expiration and a placeholder for never run tasks.

Defining these constants improves code readability and maintainability by replacing magic numbers with descriptive names. This is a good practice in coding standards.

Copy link
Member

@bdraco bdraco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ep1cman

@bdraco bdraco changed the title fix: Fixes new cookie flag preventing auth cookie from being stored fix: new cookie flag preventing auth cookie from being stored Jun 11, 2024
Copy link

codecov bot commented Jun 11, 2024

Codecov Report

Attention: Patch coverage is 75.00000% with 1 line in your changes missing coverage. Please review.

Files Coverage Δ
src/uiprotect/api.py 54.17% <75.00%> (+0.10%) ⬆️

... and 1 file with indirect coverage changes

@bdraco bdraco merged commit b6eb7fc into uilibs:main Jun 11, 2024
7 of 8 checks passed
@bdraco
Copy link
Member

bdraco commented Jun 11, 2024

Tooling will auto release 1.0.1 shortly. It would be great if you could open a PR to bump the library in HA as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants