refactor commons. AG-29663

Squashed commit of the following:

commit 912a868
Merge: 50666c9 a60d6ef
Author: Slava Leleka <[email protected]>
Date:   Tue Feb 20 18:30:28 2024 +0200

    Merge branch 'master' into fix/AG-29663

commit 50666c9
Author: Slava Leleka <[email protected]>
Date:   Mon Feb 12 19:22:36 2024 +0200

    add todo for prepareUrl()

commit 658649f
Author: Slava Leleka <[email protected]>
Date:   Mon Feb 12 19:04:05 2024 +0200

    fix tests

commit 648c0dd
Author: Slava Leleka <[email protected]>
Date:   Mon Feb 12 19:03:40 2024 +0200

    refactor string utils

commit e0f3d5a
Author: Slava Leleka <[email protected]>
Date:   Mon Feb 12 18:58:16 2024 +0200

    move CustomError from common dir

commit 0975b1e
Author: Slava Leleka <[email protected]>
Date:   Mon Feb 12 18:57:53 2024 +0200

    move ICON_FOR_DOMAIN from common dir

commit a61660e
Author: Slava Leleka <[email protected]>
Date:   Mon Feb 12 18:54:21 2024 +0200

    refactor common utils

commit 25ce2a3
Author: Slava Leleka <[email protected]>
Date:   Mon Feb 12 18:46:43 2024 +0200

    refactor common constants

commit 807ff4b
Author: Slava Leleka <[email protected]>
Date:   Mon Feb 12 17:41:17 2024 +0200

    merge src/lib and src/common dirs

jest.config.ts

@@ -4,7 +4,7 @@ module.exports = {
     collectCoverage: true,
     collectCoverageFrom: [
         '**/src/background/**/*.{js,jsx}',
-        '**/src/lib/**/*.{js,jsx}',
+        '**/src/common/**/*.{js,jsx}',
         '!**/node_modules/**',
     ],
     setupFiles: ['<rootDir>/tests/__setups__/chrome.ts'],

src/background/abTestManager/ABTestManager.ts

@@ -4,7 +4,7 @@ import {
     versionsSchema,
 } from '../schema/credentials/trackInstallResponse';
 import { browserApi } from '../browserApi';
-import { log } from '../../lib/logger';
+import { log } from '../../common/logger';
 
 import { AG21492_SHOW_SCREENSHOT_FLOW_VERSION_ID } from './constants';
 

src/background/actions.ts

@@ -1,8 +1,8 @@
 import browser from 'webextension-polyfill';
 
 import { Prefs } from '../common/prefs';
-import { log } from '../lib/logger';
-import { FREE_GBS_ANCHOR, SETTINGS_IDS, THEME_URL_PARAMETER } from '../lib/constants';
+import { log } from '../common/logger';
+import { SETTINGS_IDS, THEME_URL_PARAMETER } from '../common/constants';
 
 import { tabs } from './tabs';
 import { credentials } from './credentials';
@@ -16,6 +16,8 @@ type SetBadgeDetailsType = browser.Action.SetBadgeTextDetailsType;
 
 const OPTIONS_PAGE_PATH = '/options.html';
 
+const FREE_GBS_ANCHOR = 'free-gbs';
+
 /**
  * Opens options page in Firefox with queryString if provided.
  * There is a bug with browser.runtime.openOptionsPage() method in Firefox

src/background/api/Api.ts

@@ -1,6 +1,7 @@
-import { ERROR_STATUSES } from '../../lib/constants';
-import { CustomError } from '../../lib/CustomError';
-import { notifier } from '../../lib/notifier';
+import { notifier } from '../../common/notifier';
+import { ERROR_STATUSES } from '../constants';
+
+import { CustomError } from './CustomError';
 
 const REQUEST_TIMEOUT_MS = 1000 * 6; // 6 seconds
 

src/background/api/accountApi.ts

@@ -1,4 +1,4 @@
-import { SubscriptionType } from '../../lib/constants';
+import { SubscriptionType } from '../../common/constants';
 
 import { Api } from './Api';
 import { fallbackApi } from './fallbackApi';

src/background/api/fallbackApi.ts

@@ -6,9 +6,9 @@ import {
     VPN_API_URL,
     STAGE_ENV,
 } from '../config';
-import { clearFromWrappingQuotes } from '../../lib/string-utils';
-import { log } from '../../lib/logger';
-import { fetchConfig } from '../../lib/fetch-config';
+import { clearFromWrappingQuotes } from '../../common/utils/string';
+import { log } from '../../common/logger';
+import { fetchConfig } from '../../common/fetch-config';
 import { getErrorMessage } from '../../common/utils/error';
 import { stateStorage } from '../stateStorage';
 import { authService } from '../authentication/authService';

src/background/auth/auth.ts

@@ -1,19 +1,19 @@
 import qs from 'qs';
 import { nanoid } from 'nanoid';
 
+import { SocialAuthProvider } from '../../common/constants';
+import { log } from '../../common/logger';
+import { notifier } from '../../common/notifier';
+import { translator } from '../../common/translator';
 import { authProvider } from '../providers/authProvider';
 import { tabs } from '../tabs';
 import { proxy } from '../proxy';
 import { notifications } from '../notifications';
 import { AUTH_CLIENT_ID } from '../config';
-import { log } from '../../lib/logger';
-import { notifier } from '../../lib/notifier';
-import { SUPPORT_EMAIL } from '../../common/constants';
-import { translator } from '../../common/translator';
+import { SUPPORT_EMAIL } from '../constants';
 import { fallbackApi } from '../api/fallbackApi';
 // eslint-disable-next-line import/no-cycle
 import { settings } from '../settings';
-import { SocialAuthProvider } from '../../lib/constants';
 import { flagsStorage } from '../flagsStorage';
 import type { AuthCredentials } from '../api/apiTypes';
 import type { AuthAccessToken } from '../schema';

src/background/browserActionIcon.ts

@@ -1,9 +1,9 @@
 import browser from 'webextension-polyfill';
 import throttle from 'lodash/throttle';
 
-import { notifier } from '../lib/notifier';
-import { isHttp } from '../lib/string-utils';
-import { log } from '../lib/logger';
+import { notifier } from '../common/notifier';
+import { isHttp } from '../common/utils/string';
+import { log } from '../common/logger';
 
 import { actions } from './actions';
 import { exclusions } from './exclusions';

src/background/config.ts

@@ -1,4 +1,4 @@
-import { log } from '../lib/logger';
+import { log } from '../common/logger';
 
 import { runtime } from './browserApi/runtime';
 

src/background/connectivity/connectivityService/fsm/actions.ts

@@ -1,6 +1,6 @@
 import { assign } from 'xstate';
 
-import { log } from '../../../../lib/logger';
+import { log } from '../../../../common/logger';
 import { CONNECTIVITY_CONTEXT_DEFAULTS, ConnectivityContext } from '../../../schema/connectivity';
 import { switcher } from '../../switcher';
 

src/background/connectivity/connectivityService/main.ts

@@ -1,7 +1,7 @@
 import type { EventData } from 'xstate';
 
-import { notifier } from '../../../lib/notifier';
-import { log } from '../../../lib/logger';
+import { notifier } from '../../../common/notifier';
+import { log } from '../../../common/logger';
 import { stateStorage } from '../../stateStorage';
 import {
     StorageKey,

src/background/connectivity/endpointConnectivity/EndpointConnectivity.ts

@@ -1,14 +1,14 @@
 import { WsConnectivityMsg, WsSettingsMsg } from '../protobufCompiled';
 import { websocketFactory } from '../websocket';
 import { WS_API_URL_TEMPLATE } from '../../config';
-import { renderTemplate } from '../../../lib/string-utils';
-import { notifier } from '../../../lib/notifier';
+import { renderTemplate } from '../../../common/utils/string';
+import { notifier } from '../../../common/notifier';
 import { proxy } from '../../proxy';
-import { log } from '../../../lib/logger';
+import { log } from '../../../common/logger';
 import { dns } from '../../dns';
 import { sendPingMessage } from '../pingHelpers';
 import { webrtc } from '../../browserApi/webrtc';
-import { sleepIfNecessary } from '../../../lib/helpers';
+import { sleepIfNecessary } from '../../../common/helpers';
 import {
     connectivityService,
     ConnectivityEventType,

src/background/connectivity/pingHelpers.ts

@@ -1,8 +1,8 @@
 import { nanoid } from 'nanoid';
 
-import { stringToUint8Array } from '../../lib/string-utils';
-import { log } from '../../lib/logger';
-import { sleep } from '../../lib/helpers';
+import { stringToUint8Array } from '../../common/utils/string';
+import { log } from '../../common/logger';
+import { sleep } from '../../common/helpers';
 
 import { WsConnectivityMsg, WsPingMsg } from './protobufCompiled';
 

src/background/connectivity/switcher.ts

@@ -1,7 +1,6 @@
 import { proxy } from '../proxy';
-import { log } from '../../lib/logger';
-import { runWithCancel, sleepIfNecessary } from '../../lib/helpers';
-import { FORCE_CANCELLED } from '../../lib/constants';
+import { log } from '../../common/logger';
+import { runWithCancel, sleepIfNecessary } from '../../common/helpers';
 // eslint-disable-next-line import/no-cycle
 import { credentials } from '../credentials';
 // eslint-disable-next-line import/no-cycle
@@ -20,6 +19,9 @@ import {
 // eslint-disable-next-line import/no-cycle
 import { connectivity } from './index';
 
+// Error text thrown when connection is canceled by user. See issue - AG-2291
+const FORCE_CANCELLED = 'Connection was cancelled by user';
+
 /**
  * Turns on proxy after doing preparing steps
  * 1. Gets selected location

src/background/connectivity/websocket/websocketFactory.ts

@@ -1,4 +1,4 @@
-import { log } from '../../../lib/logger';
+import { log } from '../../../common/logger';
 
 export const websocketFactory = (() => {
     let ws: WebSocket;

src/background/constants.ts

@@ -0,0 +1,5 @@
+export const ERROR_STATUSES = {
+    NETWORK_ERROR: 'network.error',
+};
+
+export const SUPPORT_EMAIL = '[email protected]';

src/background/contextMenu.ts

@@ -2,12 +2,12 @@ import browser from 'webextension-polyfill';
 import throttle from 'lodash/throttle';
 import { defaults } from 'lodash';
 
-import { notifier } from '../lib/notifier';
+import { notifier } from '../common/notifier';
 import { translator } from '../common/translator';
-import { isHttp } from '../lib/string-utils';
-import { log } from '../lib/logger';
+import { isHttp } from '../common/utils/string';
+import { log } from '../common/logger';
 import { ExclusionsMode } from '../common/exclusionsConstants';
-import { SETTINGS_IDS } from '../lib/constants';
+import { SETTINGS_IDS } from '../common/constants';
 
 import { exclusions } from './exclusions';
 import { tabs } from './tabs';

src/background/credentials/Credentials.ts

@@ -3,8 +3,8 @@ import md5 from 'crypto-js/md5';
 import lodashGet from 'lodash/get';
 
 import { type AccountInfoData, accountProvider } from '../providers/accountProvider';
-import { log } from '../../lib/logger';
-import { notifier } from '../../lib/notifier';
+import { log } from '../../common/logger';
+import { notifier } from '../../common/notifier';
 import type { VpnProviderInterface } from '../providers/vpnProvider';
 import type { PermissionsErrorInterface } from '../permissionsChecker/permissionsError';
 import type { StorageInterface } from '../browserApi/storage';

src/background/dns/Dns.ts

@@ -1,8 +1,8 @@
-import { notifier } from '../../lib/notifier';
+import { notifier } from '../../common/notifier';
 import { settings } from '../settings';
 import { StorageKey, DnsServerData, DnsState } from '../schema';
 import { stateStorage } from '../stateStorage';
-import { log } from '../../lib/logger';
+import { log } from '../../common/logger';
 
 import { DEFAULT_DNS_SERVER, POPULAR_DNS_SERVERS } from './dnsConstants';
 

src/background/endpoints/Endpoints.ts

@@ -4,10 +4,10 @@ import isEmpty from 'lodash/isEmpty';
 import qs from 'qs';
 import { getDomain } from 'tldts';
 
-import { log } from '../../lib/logger';
-import { getLocationWithLowestPing, sleep } from '../../lib/helpers';
+import { log } from '../../common/logger';
+import { getLocationWithLowestPing, sleep } from '../../common/helpers';
 import { POPUP_DEFAULT_SUPPORT_URL } from '../config';
-import { notifier } from '../../lib/notifier';
+import { notifier } from '../../common/notifier';
 import { proxy } from '../proxy';
 import { vpnProvider } from '../providers/vpnProvider';
 import { endpointsTldExclusions } from '../proxy/endpointsTldExclusions';
@@ -22,7 +22,7 @@ import type {
 } from '../schema';
 import type { VpnExtensionInfoInterface } from '../../common/schema/endpoints/vpnInfo';
 import { settings } from '../settings';
-import { QuickConnectSetting } from '../../lib/constants';
+import { QuickConnectSetting } from '../../common/constants';
 import { EndpointsState, LocationInterface, StorageKey } from '../schema';
 import { stateStorage } from '../stateStorage';
 

src/background/endpoints/locationsService.ts

@@ -1,10 +1,10 @@
 import isEmpty from 'lodash/isEmpty';
 
-import { log } from '../../lib/logger';
+import { log } from '../../common/logger';
 import { measurePingWithinLimits } from '../connectivity/pingHelpers';
-import { notifier } from '../../lib/notifier';
+import { notifier } from '../../common/notifier';
 import { vpnProvider } from '../providers/vpnProvider';
-import { SETTINGS_IDS } from '../../lib/constants';
+import { SETTINGS_IDS } from '../../common/constants';
 // eslint-disable-next-line import/no-cycle
 import { settings } from '../settings';
 import {

src/background/exclusions/ExclusionsService.ts

@@ -16,8 +16,8 @@ import {
     getHostname,
     getSubdomain,
     isWildcard,
-} from '../../common/url-utils';
-import { notifier } from '../../lib/notifier';
+} from '../../common/utils/url';
+import { notifier } from '../../common/notifier';
 import { stateStorage } from '../stateStorage';
 
 import { AllExclusions, exclusionsManager } from './exclusions/ExclusionsManager';

src/background/exclusions/ExclusionsTree.ts

@@ -2,7 +2,7 @@
 import { isIP } from 'is-ip';
 
 import { ExclusionDtoInterface, ExclusionsType } from '../../common/exclusionsConstants';
-import { getETld } from '../../common/url-utils';
+import { getETld } from '../../common/utils/url';
 import type {
     ServicesIndexType,
     ServicesInterface,

src/background/exclusions/exclusions-helpers.ts

@@ -1,8 +1,8 @@
 import { nanoid } from 'nanoid';
 import { isIP } from 'is-ip';
 
-import { getETld, getSubdomain, isWildcard } from '../../common/url-utils';
-import { log } from '../../lib/logger';
+import { getETld, getSubdomain, isWildcard } from '../../common/utils/url';
+import { log } from '../../common/logger';
 import { ExclusionState } from '../../common/exclusionsConstants';
 import type { ServicesInterface, ExclusionInterface } from '../schema';
 

src/background/exclusions/exclusions/ExclusionsHandler.ts

@@ -1,8 +1,8 @@
 import { nanoid } from 'nanoid';
 
 import { ExclusionsMode, ExclusionState } from '../../../common/exclusionsConstants';
-import { areHostnamesEqual, shExpMatch } from '../../../lib/string-utils';
-import { getETld, getHostname, getSubdomain } from '../../../common/url-utils';
+import { areHostnamesEqual, shExpMatch } from '../../../common/utils/string';
+import { getETld, getHostname, getSubdomain } from '../../../common/utils/url';
 import type { ExclusionInterface, IndexedExclusionsInterface } from '../../schema';
 
 interface UpdateHandler {

src/background/exclusions/exclusions/ExclusionsManager.ts

@@ -1,6 +1,6 @@
 import { ExclusionsMode, ExclusionState } from '../../../common/exclusionsConstants';
-import { notifier } from '../../../lib/notifier';
-import { log } from '../../../lib/logger';
+import { notifier } from '../../../common/notifier';
+import { log } from '../../../common/logger';
 import { settings } from '../../settings';
 import { proxy } from '../../proxy';
 import {

src/background/exclusions/services/ServicesManager.ts

@@ -3,9 +3,9 @@ import axios from 'axios';
 
 import { vpnProvider } from '../../providers/vpnProvider';
 import { browserApi } from '../../browserApi';
-import { log } from '../../../lib/logger';
+import { log } from '../../../common/logger';
 import { ServiceDto } from '../../../common/exclusionsConstants';
-import { fetchConfig } from '../../../lib/fetch-config';
+import { fetchConfig } from '../../../common/fetch-config';
 import { stateStorage } from '../../stateStorage';
 import {
     StorageKey,

src/background/flagsStorage.ts

@@ -1,5 +1,5 @@
-import { FLAGS_FIELDS } from '../lib/constants';
-import { log } from '../lib/logger';
+import { FLAGS_FIELDS } from '../common/constants';
+import { log } from '../common/logger';
 
 import { browserApi } from './browserApi';
 import { updateService } from './updateService';

src/background/flagsStorageData.ts

@@ -1,6 +1,6 @@
 import zod from 'zod';
 
-import { FLAGS_FIELDS } from '../lib/constants';
+import { FLAGS_FIELDS } from '../common/constants';
 
 export const flagsStorageDataScheme = zod.record(zod.string().or(zod.boolean()));
 

src/background/hintPopup.ts

@@ -1,4 +1,4 @@
-import { notifier } from '../lib/notifier';
+import { notifier } from '../common/notifier';
 import { ExclusionsMode } from '../common/exclusionsConstants';
 
 import { browserApi } from './browserApi';

src/background/limitedOfferService/limitedOfferService.ts

@@ -1,7 +1,7 @@
-import { isRuLocale } from '../../common/promo-utils';
+import { isRuLocale } from '../../common/utils/promo';
 import { translator } from '../../common/translator';
 import { ONE_DAY_MS, ONE_HOUR_MS } from '../../common/constants';
-import { log } from '../../lib/logger';
+import { log } from '../../common/logger';
 import { BrowserApi, browserApi } from '../browserApi';
 import { FORWARDER_DOMAIN } from '../config';
 import { credentials } from '../credentials';

src/background/main/main.ts

@@ -15,7 +15,7 @@ import { contextMenu } from '../contextMenu';
 import { credentials } from '../credentials';
 import { endpoints } from '../endpoints';
 import { exclusions } from '../exclusions';
-import { log } from '../../lib/logger';
+import { log } from '../../common/logger';
 import { management } from '../management';
 import { messaging } from '../messaging';
 import { nonRoutable } from '../routability/nonRoutable';
@@ -30,15 +30,15 @@ import { vpnApi } from '../api';
 import { browserActionIcon } from '../browserActionIcon';
 import { openThankYouPage } from '../postinstall';
 import { endpointsTldExclusions } from '../proxy/endpointsTldExclusions';
-import { logStorage } from '../../lib/log-storage';
+import { logStorage } from '../../common/log-storage';
 import { fallbackApi } from '../api/fallbackApi';
 import { flagsStorage } from '../flagsStorage';
 import { popupOpenedCounter } from '../popupData/popupOpenedCounter';
 import { locationsService } from '../endpoints/locationsService';
 import { connectivityService } from '../connectivity/connectivityService';
 import { proxyApi } from '../proxy/abstractProxyApi';
 import { updateOptionsPageListeners } from '../stateStorage/helper';
-import { logStorageManager } from '../../lib/log-storage/LogStorageManager';
+import { logStorageManager } from '../../common/log-storage/LogStorageManager';
 import '../rateModal';
 import '../uninstall';
 import '../networkConnectionObserver';

src/background/management/Management.ts

@@ -1,6 +1,6 @@
 import browser from 'webextension-polyfill';
 
-import { log } from '../../lib/logger';
+import { log } from '../../common/logger';
 
 class Management {
     PROXY_PERMISSION = 'proxy';