Skip to content

Fix Copy Action Issue #3165

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

Merged
merged 1 commit into from
Jan 3, 2025
Merged

Fix Copy Action Issue #3165

merged 1 commit into from
Jan 3, 2025

Conversation

Jack251970
Copy link
Member

Revert "Fix clipboard action under sta thread issue" to fix copy action issue in #3122.

Copy link

github-actions bot commented Jan 3, 2025

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

❌ Errors Count
❌ forbidden-pattern 22
❌ ignored-expect-variant 1
⚠️ non-alpha-in-dictionary 19

See ❌ Event descriptions for more information.

If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

Copy link

gitstream-cm bot commented Jan 3, 2025

Be a legend 🏆 by adding a before and after screenshot of the changes you made, especially if they are around UI/UX.

Copy link
Contributor

coderabbitai bot commented Jan 3, 2025

📝 Walkthrough

Walkthrough

This pull request involves removing Single Threaded Apartment (STA) related methods and simplifying clipboard handling across multiple files in the Flow Launcher infrastructure. The changes primarily focus on eliminating asynchronous task management for COM interactions, specifically removing OleInitialize and OleUninitialize functions, and modifying how clipboard operations are performed. The modifications streamline the codebase by removing complex asynchronous threading mechanisms and replacing them with more direct, synchronous implementations.

Changes

File Change Summary
Flow.Launcher.Infrastructure/NativeMethods.txt Removed OleInitialize and OleUninitialize functions
Flow.Launcher.Infrastructure/UserSettings/Settings.cs Simplified clipboard shortcut model initialization by directly passing Clipboard.GetText
Flow.Launcher.Infrastructure/Win32Helper.cs Removed four StartSTATaskAsync methods for STA thread management
Flow.Launcher/PublicAPIInstance.cs Converted CopyToClipboard method from async to synchronous, removed Win32Helper.StartSTATaskAsync usage

Possibly related PRs

Suggested labels

enhancement

Suggested reviewers

  • taooceros

Poem

🐰 Hop, hop, through code so bright,
STA threads now take flight!
Clipboard dancing, simple and clean,
No more async, a coder's dream!
Simplicity wins the day, hooray! 🎉


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.

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

🧹 Nitpick comments (3)
Flow.Launcher/PublicAPIInstance.cs (3)

125-133: Handle non-existent paths gracefully.
When directCopy is true, the code checks File.Exists or Directory.Exists and proceeds. If both checks fail, there is no fallback path for a malformed or non-existent path string. Consider adding an early return or user notification for invalid paths.

+ if (!isFile && !Directory.Exists(stringToCopy))
+ {
+     ShowMsg("Copy Failed", "Invalid file or directory path.");
+     return;
+ }

135-139: Retain user orientation in notifications.
The new localized message references “file” or “folder” but does not explicitly mention what was copied. Consider displaying the actual path in the notification to reassure the user.


140-148: Use Clipboard.SetText(...) when copying strings.
Clipboard.SetDataObject(stringToCopy) works, yet Clipboard.SetText(stringToCopy) is more direct and descriptive. Using a specialized method may be clearer and can benefit from additional text-specific optimizations in certain environments.

- Clipboard.SetDataObject(stringToCopy);
+ Clipboard.SetText(stringToCopy);
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fd3576d and e0f0bed.

📒 Files selected for processing (4)
  • Flow.Launcher.Infrastructure/NativeMethods.txt (1 hunks)
  • Flow.Launcher.Infrastructure/UserSettings/Settings.cs (1 hunks)
  • Flow.Launcher.Infrastructure/Win32Helper.cs (0 hunks)
  • Flow.Launcher/PublicAPIInstance.cs (1 hunks)
💤 Files with no reviewable changes (1)
  • Flow.Launcher.Infrastructure/Win32Helper.cs
✅ Files skipped from review due to trivial changes (1)
  • Flow.Launcher.Infrastructure/NativeMethods.txt
🔇 Additional comments (2)
Flow.Launcher/PublicAPIInstance.cs (1)

120-124: Ensure thread context consistency for clipboard operations.
Removing async in favor of a synchronous call is acceptable if this method is always called from an STA thread (which WPF typically provides). However, if this method is ever invoked on a non-STA thread, clipboard operations may fail.

Would you like to verify or confirm that all code paths invoking CopyToClipboard originate from STA threads?

✅ Verification successful

Let me gather more information about the thread context by examining the call sites.


Thread safety for clipboard operations is maintained through WPF's STA context

Based on the analysis of the codebase:

  1. The application is a WPF application (confirmed by MainWindow.xaml), which means the main UI thread is automatically running in STA mode.
  2. All direct calls to CopyToClipboard are made from:
    • UI event handlers in MainWindow.xaml.cs (OnCopy event)
    • ViewModel commands in MainViewModel.cs
    • Plugin actions that are executed through the WPF command system
  3. The WPF command system ensures that commands are executed on the UI thread, which maintains the STA context required for clipboard operations.

The removal of async is safe because:

  1. All calls to CopyToClipboard are made through WPF's command and event system
  2. WPF automatically ensures these operations run on the STA UI thread
  3. No background thread usage was found in relation to clipboard operations

The code is correctly handling clipboard operations within the appropriate thread context.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# This script will search all references of CopyToClipboard calls to check if they're invoked only from the UI thread or any guaranteed STA context.
rg -A 5 "CopyToClipboard"

Length of output: 6872


Script:

#!/bin/bash
# Check MainWindow.xaml to verify if it's a WPF window
cat Flow.Launcher/MainWindow.xaml

# Check for any background/async operations in MainViewModel
ast-grep --pattern 'Task $_ CopyToClipboard'

# Look for any background thread or Task.Run usage near CopyToClipboard calls
rg -B 5 "CopyToClipboard" 

Length of output: 38317

Flow.Launcher.Infrastructure/UserSettings/Settings.cs (1)

233-233: Confirm no asynchronous constraints remain.
Replacing ()=> Win32Helper.StartSTATaskAsync(Clipboard.GetText).Result with Clipboard.GetText is simpler. Ensure that synchronous retrieval here does not block the UI if large data is present in the clipboard.

Copy link
Member

@jjw24 jjw24 left a comment

Choose a reason for hiding this comment

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

Awesome, thank you.

@jjw24 jjw24 added Dev branch only An issue or fix for the Dev branch build and removed bug Something isn't working labels Jan 3, 2025
@jjw24 jjw24 added this to the 1.20.0 milestone Jan 3, 2025
@jjw24 jjw24 merged commit a34136f into Flow-Launcher:dev Jan 3, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Dev branch only An issue or fix for the Dev branch build
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants