Back to query results #74

cibere · 2025-02-07T03:00:41Z

Summary

Adds support for the BackToQueryResults from Flow-Launcher/Flow.Launcher#3087

Changelog

Breaking Changes

New Features

Bug Fixes

Checklist

If code changes were made then they have been tested.
- I have updated the documentation to reflect the changes.

Summary by CodeRabbit

New Features
- Introduced asynchronous functionality that allows users to exit the context menu and quickly return to their query results, streamlining navigation within the application.

coderabbitai · 2025-02-07T03:00:49Z

📝 Walkthrough

Walkthrough

This pull request introduces a new asynchronous method, back_to_query_results, in both the FlowLauncherAPI and Query classes. The method instructs the application to exit the context menu and return to query results by sending a JSONRPC request with the action "BackToQueryResults". Additionally, a minor correction was applied to the update method’s docstring in the Query class, fixing a typographical error.

Changes

File(s)	Change Summary
flogin/flow/api.py, flogin/query.py	Added new asynchronous method `back_to_query_results` in FlowLauncherAPI and Query classes to exit context menus and return to query results via JSONRPC.
flogin/query.py	Updated the `update` method’s docstring by correcting a typo (“acess” changed to “access”).

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant FlowLauncherAPI
    participant JSONRPC_Client

    Client->>FlowLauncherAPI: back_to_query_results()
    FlowLauncherAPI->>JSONRPC_Client: request("BackToQueryResults")
    JSONRPC_Client-->>FlowLauncherAPI: response/acknowledgement
    FlowLauncherAPI-->>Client: return control

sequenceDiagram
    participant Client
    participant Query
    participant JSONRPC_Client

    Client->>Query: back_to_query_results()
    Query->>JSONRPC_Client: request("BackToQueryResults")
    JSONRPC_Client-->>Query: response/acknowledgement
    Query-->>Client: return control

Poem

I'm a bunny coding through the night, 🐰
Hopping over bugs with pure delight,
New methods appear, lighting up the way,
Query results and context menus sway,
In joyful leaps, my code takes flight!
Happy hops for every fix in sight!

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bda3a99 and adc2d44.

📒 Files selected for processing (2)

flogin/flow/api.py (1 hunks)
flogin/query.py (2 hunks)

🔇 Additional comments (3)

flogin/query.py (2)

131-131: LGTM! Fixed typo in docstring.

The typo "acess" has been correctly fixed to "access".

167-186: LGTM! Well-documented and correctly implemented method.

The new back_to_query_results method is:

Well-documented with proper docstring format

Correctly implemented as a thin wrapper around the API method

Properly marked with version tag

flogin/flow/api.py (1)

475-492: LGTM! Well-documented and correctly implemented method.

The new back_to_query_results method is:

Well-documented with proper docstring format

Correctly implemented using the jsonrpc client

Properly marked with version tag

Aligns with the PR objective to add support for the BackToQueryResults feature

✨ Finishing Touches

📝 Docstrings were successfully generated. (♻️ Check again to generate again)

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>, 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 generate docstrings to generate docstrings for this PR. (Beta)
@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 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.

cibere · 2025-02-07T03:00:50Z

@coderabbitai full review

coderabbitai · 2025-02-07T03:00:55Z

✅ Actions performed

Full review triggered.

@cibere

Docstrings generation was requested by @cibere. * #74 (comment) The following files were modified: * `flogin/flow/api.py` * `flogin/query.py`

coderabbitai · 2025-02-07T08:58:56Z

Note

Generated docstrings for this pull request at #75

cibere added 3 commits February 6, 2025 18:54

+ FlowLauncherAPI.back_to_query_results

207a0c7

+ Query.back_to_query_results

ed085be

run ruff

adc2d44

coderabbitai bot added a commit that referenced this pull request Feb 7, 2025

📝 Add docstrings to BackToQueryResults

8072562

Docstrings generation was requested by @cibere. * #74 (comment) The following files were modified: * `flogin/flow/api.py` * `flogin/query.py`

coderabbitai bot mentioned this pull request Feb 7, 2025

📝 Add docstrings to BackToQueryResults #75

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Back to query results #74

Back to query results #74

Uh oh!

cibere commented Feb 7, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Feb 7, 2025 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

cibere commented Feb 7, 2025

Uh oh!

coderabbitai bot commented Feb 7, 2025

Uh oh!

coderabbitai bot commented Feb 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Back to query results #74

Are you sure you want to change the base?

Back to query results #74

Uh oh!

Conversation

cibere commented Feb 7, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changelog

Breaking Changes

New Features

Bug Fixes

Checklist

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Feb 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

cibere commented Feb 7, 2025

Uh oh!

coderabbitai bot commented Feb 7, 2025

Uh oh!

coderabbitai bot commented Feb 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

cibere commented Feb 7, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 7, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)