Skip to content

⚡ Optimize VPN Service Startup Performance - #211

Open
Asutorufa wants to merge 2 commits into
mainfrom
optimize-vpn-startup-3314752751189640977
Open

⚡ Optimize VPN Service Startup Performance#211
Asutorufa wants to merge 2 commits into
mainfrom
optimize-vpn-startup-3314752751189640977

Conversation

@Asutorufa

Copy link
Copy Markdown
Collaborator

💡 What: The optimization implemented
This change moves blocking I/O and JNI calls in YuhaiinVpnService.onStartCommand to a background thread using Kotlin Coroutines. It also ensures that startForeground is called immediately on the main thread to comply with Android's foreground service requirements.

🎯 Why: The performance problem it solves
Previously, the VPN service performed several blocking I/O operations (like reading from Store) and JNI calls on the main thread during onStartCommand. This could lead to Application Not Responding (ANR) errors and crashes, especially on Android 8+ where failing to call startForeground within a few seconds of starting the service results in a crash.

📊 Measured Improvement:
While it was impractical to measure the exact millisecond improvement in this environment due to build and network constraints, moving blocking I/O off the main thread is a standard Android performance optimization that prevents main-thread stalls and ANRs. The onStartCommand now returns almost immediately, allowing the system to proceed while the VPN initializes in the background. Additionally, calling startNotification earlier makes the service more robust against "Service.startForeground() not called" errors.


PR created automatically by Jules for task 3314752751189640977 started by @Asutorufa

…ckground thread

- Moved blocking calls (Yuhaiin.getTunAddress, configure, start) to a coroutine on Dispatchers.IO.
- Ensured startForeground is called early on the main thread for Android compliance.
- Added @volatile to state and mInterface for thread safety.
- Updated stop() to handle the CONNECTING state.
- Managed coroutine lifecycle with serviceScope and onDestroy.

Co-authored-by: Asutorufa <16442314+Asutorufa@users.noreply.github.com>
@google-labs-jules

Copy link
Copy Markdown
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @Asutorufa, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the VPN service's startup reliability and performance by offloading time-consuming operations from the main thread. By leveraging Kotlin Coroutines, the service can now initialize critical components asynchronously, thereby avoiding potential Application Not Responding (ANR) errors and ensuring that the foreground service notification is displayed promptly, aligning with Android's strict service lifecycle policies.

Highlights

  • Performance Optimization: Blocking I/O and JNI calls in YuhaiinVpnService.onStartCommand have been moved to a background thread using Kotlin Coroutines to prevent ANRs and improve startup performance.
  • Foreground Service Compliance: The startNotification (which calls startForeground) is now invoked immediately on the main thread within onStartCommand, ensuring compliance with Android's foreground service requirements and preventing crashes on Android 8+.
  • Coroutine Lifecycle Management: A CoroutineScope has been introduced for the service, and its cancellation is handled in the onDestroy method to properly manage background tasks.
  • State Management: The stop method now correctly handles the CONNECTING state, and state and mInterface variables have been marked as @Volatile for proper multi-threaded access.
Changelog
  • app/src/main/kotlin/io/github/asutorufa/yuhaiin/service/YuhaiinVpnService.kt
    • Added necessary Kotlin Coroutines imports.
    • Initialized a CoroutineScope for the service lifecycle.
    • Marked state and mInterface properties as @Volatile.
    • Implemented onDestroy to cancel the service's coroutine scope.
    • Updated stop method to also handle the CONNECTING state.
    • Moved startNotification() call to occur immediately on the main thread.
    • Refactored VPN initialization logic within onStartCommand to run on a background Dispatchers.IO thread using Kotlin Coroutines.
Activity
  • No activity has been recorded on this pull request yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request successfully optimizes the VPN service startup by moving blocking I/O and JNI calls in onStartCommand to a background thread, which is a great improvement for performance and stability, preventing potential ANR errors. My review includes a critical fix for a resource leak in the new error handling logic and a suggestion to apply similar non-blocking principles to the stop() method to prevent ANRs during shutdown as well.

Comment thread app/src/main/kotlin/io/github/asutorufa/yuhaiin/service/YuhaiinVpnService.kt Outdated
- Offloaded blocking I/O and VPN initialization to Dispatchers.IO.
- Ensured early startForeground call for Android compliance.
- Added @volatile and state guards for thread-safe asynchronous startup.
- Handled CancellationException to prevent false-positive error logs.
- Updated stop() to handle interruptions during the CONNECTING phase.
- Addressed PR feedback regarding resource leak prevention and logging.

Co-authored-by: Asutorufa <16442314+Asutorufa@users.noreply.github.com>
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.

1 participant