use backend api domain for forwarder. AG-32237

Squashed commit of the following:

commit 942c2dd
Author: Slava Leleka <[email protected]>
Date:   Fri Apr 26 14:39:30 2024 +0400

    fix typo

commit c0b0229
Author: Slava Leleka <[email protected]>
Date:   Fri Apr 26 14:22:04 2024 +0400

    make sure extension uninstall url is set

commit b9dab67
Author: Slava Leleka <[email protected]>
Date:   Fri Apr 26 14:18:16 2024 +0400

    Revert "remove obsolete uninstall script"

    This reverts commit 260abeb.

commit 260abeb
Author: Slava Leleka <[email protected]>
Date:   Fri Apr 26 14:15:17 2024 +0400

    remove obsolete uninstall script

commit cb67ba4
Author: Slava Leleka <[email protected]>
Date:   Fri Apr 26 13:51:08 2024 +0400

    add test for fallback api update

commit 1530ab3
Author: Slava Leleka <[email protected]>
Date:   Thu Apr 25 21:21:55 2024 +0400

    cleanup

commit 610ad5a
Author: Slava Leleka <[email protected]>
Date:   Thu Apr 25 21:02:49 2024 +0400

    improve fallbackApi

commit a1d9fc4
Author: Slava Leleka <[email protected]>
Date:   Thu Apr 25 20:57:30 2024 +0400

    simplify uninstall url setting

commit 2f24d1b
Author: Slava Leleka <[email protected]>
Date:   Thu Apr 25 20:48:45 2024 +0400

    refactor helpers

commit 36ffbfe
Author: Slava Leleka <[email protected]>
Date:   Thu Apr 25 20:42:14 2024 +0400

    fix linter

commit 3fbd717
Author: Slava Leleka <[email protected]>
Date:   Thu Apr 25 20:40:36 2024 +0400

    improve fallbackApi

commit 2761dff
Author: Slava Leleka <[email protected]>
Date:   Thu Apr 25 20:40:25 2024 +0400

    fix tests

commit f825504
Author: Slava Leleka <[email protected]>
Date:   Thu Apr 25 20:40:11 2024 +0400

    move forwarder to background dir

commit f2da809
Author: Slava Leleka <[email protected]>
Date:   Thu Apr 25 18:20:25 2024 +0400

    cleanup, improve uninstall url setting

commit ad97bfa
Author: Slava Leleka <[email protected]>
Date:   Thu Apr 25 17:39:25 2024 +0400

    simplify forwarder class

commit cb22643
Author: Slava Leleka <[email protected]>
Date:   Thu Apr 25 14:03:40 2024 +0400

    ditch init sleep for uninstall script

commit 65c0b62
Author: Slava Leleka <[email protected]>
Date:   Thu Apr 25 13:58:51 2024 +0400

    fix getForwarderApiUrl comment

commit 04c0d35
Author: Slava Leleka <[email protected]>
Date:   Thu Apr 25 13:55:19 2024 +0400

    ditch Forwarder.prevDomain

commit b4d3395
Author: Slava Leleka <[email protected]>
Date:   Thu Apr 25 00:05:46 2024 +0400

    cleanup, improve Forwarder.getUrl() comment

commit 5500fd7
Author: Slava Leleka <[email protected]>
Date:   Wed Apr 24 23:23:31 2024 +0400

    force fallback info updating after ff permission is grangted

... and 15 more commits

Author: slavaleleka

CHANGELOG.md

@@ -11,6 +11,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - @adguard/logger library for logging
 
+### Changed
+
+- Backend API domain is used for forwarder urls.
+
+[Unreleased]: https://github.com/AdguardTeam/AdGuardVPNExtension/compare/v2.2.14...HEAD
+
 
 ## [2.2.14] - 2024-03-15
 

src/background/actions.ts

@@ -3,11 +3,13 @@ import browser from 'webextension-polyfill';
 import { Prefs } from '../common/prefs';
 import { log } from '../common/logger';
 import { SETTINGS_IDS, THEME_URL_PARAMETER } from '../common/constants';
+import { getForwarderUrl } from '../common/helpers';
 
 import { tabs } from './tabs';
 import { credentials } from './credentials';
+import { forwarder } from './forwarder';
 import { settings } from './settings';
-import { UPGRADE_LICENSE_URL } from './config';
+import { FORWARDER_URL_QUERIES } from './config';
 import { promoNotifications } from './promoNotifications';
 import { browserAction } from './browserAction';
 
@@ -208,7 +210,9 @@ const clearBadgeText = async (tabId: number) => {
  */
 const getPremiumPromoPageUrl = async (): Promise<string> => {
     const username = await credentials.getUsername();
-    return `${UPGRADE_LICENSE_URL}${username ? `&email=${encodeURIComponent(username)}` : ''}`;
+    const forwarderDomain = await forwarder.updateAndGetDomain();
+    const upgradeLicenseUrl = getForwarderUrl(forwarderDomain, FORWARDER_URL_QUERIES.UPGRADE_LICENSE);
+    return `${upgradeLicenseUrl}${username ? `&email=${encodeURIComponent(username)}` : ''}`;
 };
 
 /**

src/background/api/fallbackApi.ts

@@ -6,6 +6,7 @@ import {
     AUTH_API_URL,
     VPN_API_URL,
     STAGE_ENV,
+    FORWARDER_DOMAIN,
 } from '../config';
 import { clearFromWrappingQuotes } from '../../common/utils/string';
 import { log } from '../../common/logger';
@@ -16,8 +17,6 @@ import { authService } from '../authentication/authService';
 import { credentialsService } from '../credentials/credentialsService';
 import { FallbackInfo, StorageKey } from '../schema';
 
-export const DEFAULT_CACHE_EXPIRE_TIME_MS = 1000 * 60 * 5; // 5 minutes
-
 // DNS over https api
 const GOOGLE_DOH_HOSTNAME = 'dns.google';
 export const GOOGLE_DOH_URL = `${GOOGLE_DOH_HOSTNAME}/resolve`;
@@ -54,14 +53,20 @@ export class FallbackApi {
      */
     defaultFallbackInfo: FallbackInfo;
 
+    /**
+     * Fallback info cache expiration time in milliseconds.
+     */
+    static DEFAULT_CACHE_EXPIRE_TIME_MS = 1000 * 60 * 5; // 5 minutes
+
     /**
      * Default urls we set already expired,
      * so we need to check bkp url immediately when bkp url is required
      */
-    constructor(vpnApiUrl: string, authApiUrl: string) {
+    constructor(vpnApiUrl: string, authApiUrl: string, forwarderApiUrl: string) {
         this.defaultFallbackInfo = {
             vpnApiUrl,
             authApiUrl,
+            forwarderApiUrl,
             expiresInMs: Date.now() - 1,
         };
     }
@@ -84,7 +89,11 @@ export class FallbackApi {
         return fallbackInfo.expiresInMs < Date.now();
     }
 
-    private async updateFallbackInfo() {
+    /**
+     * Updates the fallback info.
+     * If backup urls are not received, the default fallback info is set.
+     */
+    private async updateFallbackInfo(): Promise<void> {
         const [bkpVpnApiUrl, bkpAuthApiUrl] = await Promise.all([
             this.getBkpVpnApiUrl(),
             this.getBkpAuthApiUrl(),
@@ -94,8 +103,13 @@ export class FallbackApi {
             this.fallbackInfo = {
                 vpnApiUrl: bkpVpnApiUrl,
                 authApiUrl: bkpAuthApiUrl,
-                expiresInMs: Date.now() + DEFAULT_CACHE_EXPIRE_TIME_MS,
+                // use received vpn api url as forwarder api url
+                forwarderApiUrl: bkpVpnApiUrl,
+                expiresInMs: Date.now() + FallbackApi.DEFAULT_CACHE_EXPIRE_TIME_MS,
             };
+        } else if (!this.fallbackInfo) {
+            // set default fallback info if bkp urls are not received and fallback info is not set
+            this.fallbackInfo = this.defaultFallbackInfo;
         }
     }
 
@@ -115,6 +129,21 @@ export class FallbackApi {
         return fallbackInfo.vpnApiUrl;
     };
 
+    /**
+     * Returns fallback forwarder API URL. AG-32237.
+     *
+     * Received VPN API URL is used as a fallback forwarder API URL,
+     * but if the default VPN API URL is received, the default forwarder API URL should be returned.
+     *
+     * @returns Forwarder API URL.
+     */
+    public getForwarderApiUrl = async (): Promise<string> => {
+        const { forwarderApiUrl } = await this.getFallbackInfo();
+        return forwarderApiUrl === this.defaultFallbackInfo.vpnApiUrl
+            ? this.defaultFallbackInfo.forwarderApiUrl
+            : forwarderApiUrl;
+    };
+
     public getAuthApiUrl = async (): Promise<string> => {
         const fallbackInfo = await this.getFallbackInfo();
         return fallbackInfo.authApiUrl;
@@ -284,7 +313,14 @@ export class FallbackApi {
         return `${basePrefix}.${UserType.Free}`;
     };
 
-    getBkpVpnApiUrl = async () => {
+    /**
+     * Fetches and returns backup VPN API URL.
+     *
+     * @returns Backup VPN API URL if fetched successfully and not an empty string;
+     * if fetched url is an empty string, returns default fallback VPN API URL;
+     * OR null if fetching failed.
+     */
+    getBkpVpnApiUrl = async (): Promise<string | null> => {
         const prefix = await this.getApiHostnamePrefix();
         // we use prefix for api hostname to recognize free, premium and not authenticated users
         const hostname = `${prefix}.${BKP_API_HOSTNAME_PART}`;
@@ -313,4 +349,4 @@ export class FallbackApi {
     }
 }
 
-export const fallbackApi = new FallbackApi(VPN_API_URL, AUTH_API_URL);
+export const fallbackApi = new FallbackApi(VPN_API_URL, AUTH_API_URL, FORWARDER_DOMAIN);

src/background/config.ts

@@ -2,6 +2,42 @@ import { log } from '../common/logger';
 
 import { runtime } from './browserApi/runtime';
 
+/**
+ * Keys for forwarder urls queries.
+ */
+const enum ForwarderUrlQueryKey {
+    AdguardDnsKb = 'ADGUARD_DNS_KB',
+    ComparePage = 'COMPARE_PAGE',
+    DeviceCount = 'DEVICE_COUNT',
+    EditAccount = 'EDIT_ACCOUNT',
+    Eula = 'EULA',
+    Faq = 'FAQ',
+    Feedback = 'FEEDBACK',
+    FirefoxThankYouPage = 'FIREFOX_THANK_YOU_PAGE',
+    OptionsStore = 'OPTIONS_STORE',
+    OtherProducts = 'OTHER_PRODUCTS',
+    PasswordCompromised = 'PASSWORD_COMPROMISED',
+    PasswordRecovery = 'PASSWORD_RECOVERY',
+    PopupDefaultSupport = 'POPUP_DEFAULT_SUPPORT',
+    PopupFeedback = 'POPUP_FEEDBACK',
+    PopupStore = 'POPUP_STORE',
+    Privacy = 'PRIVACY',
+    Subscribe = 'SUBSCRIBE',
+    SuggestFeature = 'SUGGEST_FEATURE',
+    ThankYouPage = 'THANK_YOU_PAGE',
+    UninstallPage = 'UNINSTALL_PAGE',
+    UpgradeLicense = 'UPGRADE_LICENSE',
+    VpnBlockedGetApp = 'VPN_BLOCKED_GET_APP',
+    Website = 'WEBSITE',
+}
+
+/**
+ * Type for forwarder urls queries data object.
+ */
+type ForwarderUrlQueries = {
+    [key in ForwarderUrlQueryKey]: string;
+};
+
 // global data
 // @ts-ignore
 const CONFIG = __APP_CONFIG__;
@@ -16,37 +52,89 @@ log.debug(`Current stage env: "${CONFIG.STAGE_ENV}"`);
 
 Object.keys(CONFIG).forEach((key) => {
     if (CONFIG[key] === undefined) {
-        throw new Error(`All values in config should be defined, ${CONFIG}`);
+        throw new Error(`Missed value for key '${key}' in config: ${CONFIG}`);
     }
 });
 
-export const {
+const {
     VPN_API_URL,
     AUTH_API_URL,
-    PASSWORD_RECOVERY_URL,
-    EDIT_ACCOUNT_URL,
     AUTH_CLIENT_ID,
-    POPUP_STORE_URL,
-    POPUP_FEEDBACK_URL,
-    OPTIONS_STORE_URL,
     WS_API_URL_TEMPLATE,
-    PRIVACY_URL,
-    EULA_URL,
-    UPGRADE_LICENSE_URL,
-    OTHER_PRODUCTS_URL,
-    POPUP_DEFAULT_SUPPORT_URL,
-    WEBSITE_URL,
-    ADGUARD_DNS_KB_LINK,
-    FORWARDER_DOMAIN,
-    SUGGEST_FEATURE,
-    THANK_YOU_PAGE_URL,
-    FIREFOX_THANK_YOU_PAGE_URL,
-    UNINSTALL_PAGE_URL,
-    FEEDBACK_URL,
-    FAQ_URL,
     BROWSER,
     BUILD_ENV,
     STAGE_ENV,
+    // keep them sorted
+    ADGUARD_DNS_KB,
     COMPARE_PAGE,
-    VPN_BLOCKED_GET_APP_LINK,
+    DEVICE_COUNT,
+    EDIT_ACCOUNT,
+    EULA,
+    FAQ,
+    FEEDBACK,
+    FIREFOX_THANK_YOU_PAGE,
+    OPTIONS_STORE,
+    OTHER_PRODUCTS,
+    PASSWORD_COMPROMISED,
+    PASSWORD_RECOVERY,
+    POPUP_DEFAULT_SUPPORT,
+    POPUP_FEEDBACK,
+    POPUP_STORE,
+    PRIVACY,
+    SUBSCRIBE,
+    SUGGEST_FEATURE,
+    THANK_YOU_PAGE,
+    UNINSTALL_PAGE,
+    UPGRADE_LICENSE,
+    VPN_BLOCKED_GET_APP,
+    WEBSITE,
 } = CONFIG;
+
+// not destructuring for adding a jsdoc comment
+/**
+ * **Should NOT be used directly**, use the Forwarder class. AG-32237.
+ */
+const FORWARDER_DOMAIN = CONFIG.FORWARDER_DOMAIN; // eslint-disable-line prefer-destructuring
+
+/**
+ * List of forwarder urls queries from the config.
+ *
+ * Needed for forwarder url generation. AG-32237.
+ */
+const FORWARDER_URL_QUERIES: ForwarderUrlQueries = {
+    ADGUARD_DNS_KB,
+    COMPARE_PAGE,
+    DEVICE_COUNT,
+    EDIT_ACCOUNT,
+    EULA,
+    FAQ,
+    FEEDBACK,
+    FIREFOX_THANK_YOU_PAGE,
+    OPTIONS_STORE,
+    OTHER_PRODUCTS,
+    PASSWORD_COMPROMISED,
+    PASSWORD_RECOVERY,
+    POPUP_DEFAULT_SUPPORT,
+    POPUP_FEEDBACK,
+    POPUP_STORE,
+    PRIVACY,
+    SUBSCRIBE,
+    SUGGEST_FEATURE,
+    THANK_YOU_PAGE,
+    UNINSTALL_PAGE,
+    UPGRADE_LICENSE,
+    VPN_BLOCKED_GET_APP,
+    WEBSITE,
+};
+
+export {
+    VPN_API_URL,
+    AUTH_API_URL,
+    AUTH_CLIENT_ID,
+    WS_API_URL_TEMPLATE,
+    BROWSER,
+    BUILD_ENV,
+    STAGE_ENV,
+    FORWARDER_DOMAIN,
+    FORWARDER_URL_QUERIES,
+};

src/background/connectivity/switcher.ts

@@ -1,6 +1,6 @@
 import { proxy } from '../proxy';
 import { log } from '../../common/logger';
-import { runWithCancel, sleepIfNecessary } from '../../common/helpers';
+import { sleepIfNecessary } from '../../common/helpers';
 // eslint-disable-next-line import/no-cycle
 import { credentials } from '../credentials';
 // eslint-disable-next-line import/no-cycle
@@ -9,6 +9,7 @@ import { locationsService } from '../endpoints/locationsService';
 import { endpoints } from '../endpoints';
 import type { AccessCredentialsData } from '../credentials/Credentials';
 import type { EndpointInterface, LocationInterface } from '../schema';
+import { runWithCancel } from '../helpers';
 
 import {
     connectivityService,

src/background/endpoints/Endpoints.ts

@@ -5,8 +5,7 @@ import qs from 'qs';
 import { getDomain } from 'tldts';
 
 import { log } from '../../common/logger';
-import { getLocationWithLowestPing, sleep } from '../../common/helpers';
-import { POPUP_DEFAULT_SUPPORT_URL } from '../config';
+import { getForwarderUrl, getLocationWithLowestPing, sleep } from '../../common/helpers';
 import { notifier } from '../../common/notifier';
 import { proxy } from '../proxy';
 import { vpnProvider } from '../providers/vpnProvider';
@@ -23,6 +22,8 @@ import type {
 import type { VpnExtensionInfoInterface } from '../../common/schema/endpoints/vpnInfo';
 import { settings } from '../settings';
 import { QuickConnectSetting } from '../../common/constants';
+import { forwarder } from '../forwarder';
+import { FORWARDER_URL_QUERIES } from '../config';
 import { EndpointsState, LocationInterface, StorageKey } from '../schema';
 import { stateStorage } from '../stateStorage';
 
@@ -449,6 +450,8 @@ class Endpoints implements EndpointsInterface {
 
         const appId = await credentials.getAppId();
 
+        const forwarderDomain = await forwarder.updateAndGetDomain();
+
         // if no endpoints info, then get endpoints failure url with empty token
         let appendToQueryString = false;
         if (!this.vpnInfo) {
@@ -459,7 +462,7 @@ class Endpoints implements EndpointsInterface {
                 this.vpnInfo = await vpnProvider.getVpnExtensionInfo(appId, token);
             } catch (e) {
                 this.vpnInfo = {
-                    vpnFailurePage: POPUP_DEFAULT_SUPPORT_URL,
+                    vpnFailurePage: getForwarderUrl(forwarderDomain, FORWARDER_URL_QUERIES.POPUP_DEFAULT_SUPPORT),
                     bandwidthFreeMbits: 0,
                     premiumPromoPage: '',
                     premiumPromoEnabled: false,

src/background/forwarder/forwarder.ts

@@ -0,0 +1,33 @@
+import { fallbackApi } from '../api/fallbackApi';
+import { setExtensionUninstallUrl } from '../helpers';
+
+/**
+ * Class for handling forwarder domain. AG-32237.
+ */
+export class Forwarder {
+    /**
+     * Domain for the forwarder.
+     */
+    private domain: string;
+
+    /**
+     * Updates and returns the domain for the forwarder.
+     *
+     * If the forwarder domain is changed, it also updates the extension uninstall url with the new domain.
+     *
+     * @returns Forwarder domain.
+     */
+    public async updateAndGetDomain(): Promise<string> {
+        const newDomain = await fallbackApi.getForwarderApiUrl();
+
+        // update the extension uninstall url if forwarder domain is changed
+        if (newDomain !== this.domain) {
+            this.domain = newDomain;
+            await setExtensionUninstallUrl(this.domain);
+        }
+
+        return this.domain;
+    }
+}
+
+export const forwarder = new Forwarder();

src/background/forwarder/index.ts

@@ -0,0 +1 @@
+export { forwarder } from './forwarder';