Support Profile Detection for the Auto Profiles (#42)

[SYM01]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @SYM01, I'm Gemini Code Assist¹! 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 'Auto Switch' proxy mode by introducing intelligent, per-tab profile detection. It allows the extension to automatically identify and display the proxy profile being used for the active browser tab based on a set of configurable rules. This feature aims to provide users with greater transparency and control over their proxy settings in dynamic browsing environments.

Highlights

• Per-Tab Profile Detection: Introduced a new mechanism to detect and apply specific proxy profiles for individual browser tabs when the 'Auto Switch' mode is active. This allows the extension to dynamically determine the most suitable proxy based on the current tab's URL.
• Dynamic UI Feedback: Added a new UI component, AutoModeActionBar, to the extension's popup. This component displays the currently detected proxy profile for the active tab, providing immediate visual feedback to the user about which proxy is in use.
• Enhanced Badge Indicator: The extension's badge indicator can now be updated on a per-tab basis, reflecting the proxy profile detected for the currently active tab. This improves clarity and user experience.
• PAC Script Simulation: Implemented core PAC (Proxy Auto-Configuration) script functions like shExpMatch and isInNet directly within the extension. This enables robust evaluation of 'Auto Switch' rules (domain, URL, CIDR) without relying on external PAC script execution.
• Web Request Statistics Service: A new WebRequestStatsService has been added to track web request activity, including failed requests and the detected profile for each tab. This service facilitates the new UI feedback and can be extended for future monitoring or debugging.
• Browser API Integration: Extended the browser adapter layer to support new APIs for tab management (getActiveTab, onTabRemoved), inter-script messaging (onMessage, sendMessage), and more granular web request event listening (onWebRequestResponseStarted), which are crucial for the new detection capabilities.
• Dependency Updates: Updated various project dependencies, including Sentry, VueUse, Acorn, Espree, ipaddr.js, Vue, Vue Router, Arco Design, Vite plugins, and TypeScript, ensuring the project uses recent and stable versions.

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]

Code Review

This pull request introduces a new feature to display per-tab proxy usage statistics and detection information, particularly for 'auto-switch' proxy profiles. Key changes include adding activeTab permission to manifest.json, updating numerous dependencies in package.json, and introducing new internationalization messages for auto-mode detection. The core functionality involves refactoring browser adapter types and methods (src/adapters/base.ts, chrome.ts, firefox.ts, web.ts) to support per-tab badge updates, tab removal events, and inter-extension messaging. A new WebRequestStatsService is implemented in src/services/stats.ts to track failed requests and the currently detected proxy profile for each tab, utilizing a new pacSimulator.ts for PAC script evaluation logic. The background.ts script is updated to initialize this stats service, listen for web request events (response started, errors, tab removal), and dynamically update the browser action badge for specific tabs. A new AutoModeActionBar.vue component is added to the popup UI (PopupPage.vue) to display the detected proxy profile for the active tab when in auto-switch mode. Review comments highlight issues with the onWebRequestAuthRequired signature in base.ts and its implementations, suggesting a promise-based approach for better handling of async operations and fixing a critical proxy authentication bug. Additionally, several test cases in profile2config.test.ts are identified as having incorrect expectations regarding how findProfile should behave for non-auto and auto-switch profiles, and a setTimeout workaround in background.ts is flagged for needing a link to the relevant Chrome bug report. A block of commented-out mocking code in AutoModeActionBar.vue is also noted for removal.

[gemini-code-assist]

The signature of onWebRequestAuthRequired is overly complex and attempts to support both Manifest V2 (callback-based) and V3 (promise-based) async models in a way that is causing bugs. A cleaner approach is to use a promise-based signature, which is supported in both modern Chrome and Firefox.

This change is part of a fix for a critical bug in proxy authentication. Please see the related comments in src/background.ts, src/adapters/chrome.ts, and src/adapters/firefox.ts.

  abstract onWebRequestAuthRequired(
    callback: (
      details: WebAuthenticationChallengeDetails
    ) => Promise<BlockingResponse | undefined>
  ): void;

[gemini-code-assist]

Following the proposed change in base.ts to use a promise-based callback for onWebRequestAuthRequired, this implementation can be simplified. The asyncBlocking option allows the listener to return a promise, and the as any cast is no longer needed. This fixes a critical bug in proxy authentication.

  onWebRequestAuthRequired(
    callback: (
      details: WebAuthenticationChallengeDetails
    ) => Promise<BlockingResponse | undefined>
  ): void {
    browser.webRequest.onAuthRequired.addListener(
      callback,
      { urls: ["<all_urls>"] },
      ["asyncBlocking"]
    );
  }

[gemini-code-assist]

This test's expectation is incorrect based on the implementation of findProfile. When a rule in an auto-switch profile matches, findProfile should return the matched sub-profile, not fall back to the default profile. Here, https://test.example.com matches the *.example.com rule, which points to simpleProxy. The result should be the simpleProxy profile. The test incorrectly expects the direct (default) profile.

  test("auto profile with domain rule match", async () => {
    const profile = new ProfileConverter(profiles.autoProxy, profileLoader);
    const url = new URL("https://test.example.com");
    const result = await profile.findProfile(url);

    expect(result.profile).toBeDefined();
    expect(result.profile!.profile.profileID).toBe("simpleProxy");
    expect(result.isConfident).toBe(true);
  });

[gemini-code-assist]

This test has an incorrect expectation. The findProfile method is designed to find the terminal profile to use for a given URL. For a non-auto profile (like a simple proxy), it should return itself, as it is the terminal profile. The implementation correctly returns { profile: this, isConfident: true }. However, this test expects result.profile to be undefined. This test should be corrected to reflect the implementation's logic. Several other tests in this file seem to be based on this wrong assumption and should also be reviewed.

  test("proxy profile (non-auto) should return itself", async () => {
    const profile = new ProfileConverter(profiles.simpleProxy);
    const url = new URL("https://example.com");
    const result = await profile.findProfile(url);

    expect(result.profile).toBe(profile);
    expect(result.isConfident).toBe(true);
  });

[gemini-code-assist]

Using setTimeout with a magic number like 50 is a code smell and can lead to race conditions or flaky behavior. The comment mentions it's a workaround for a Chrome bug. For better maintainability, please add a link to the corresponding Chrome bug report. This will provide context for future developers and help track if/when the workaround can be removed.

[gemini-code-assist]

This block of commented-out code seems to be for mocking/testing purposes. It should be removed before merging the pull request to keep the codebase clean.