gologin 2.1.21 → 2.1.23

package/.eslintrc.json

@@ -6,9 +6,21 @@
   },
   "extends": "eslint:recommended",
   "overrides": [
+    {
+      "files": [
+        "*.d.ts"
+      ],
+      "parser": "@typescript-eslint/parser",
+      "plugins": [
+        "@typescript-eslint"
+      ],
+      "rules": {
+        "no-unused-vars": "off"
+      }
+    }
   ],
   "parserOptions": {
-    "ecmaVersion": "latest",
+    "ecmaVersion": 2020,
     "sourceType": "module"
   },
   "plugins": [

package/.github/workflows/e2e-tests.yml

@@ -0,0 +1,37 @@
+name: Test App
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x]
+
+    steps:
+      - uses: actions/checkout@v1
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libnss3 libatk-bridge2.0-0 libdrm2 libxkbcommon0 libgbm1 libxss1 libasound2t64 fonts-liberation libcups2 libxcomposite1 libxdamage1 libxrandr2 libxfixes3 libxtst6 libxi6 libx11-xcb1 libx11-6 libxcb1 libxext6 libxrender1 libcairo2 libglib2.0-0 libgtk-3-0 libgdk-pixbuf2.0-0 libpango-1.0-0 libpangocairo-1.0-0 libatk1.0-0 libcairo-gobject2 libxshmfence1 libgl1-mesa-dri libegl1 libxau6 libxdmcp6 libappindicator3-1 xdg-utils
+
+      - name: Run and test app
+        working-directory: ./
+        run: |
+          npm install
+          npm run test:e2e
+        env:
+          GL_API_TOKEN: ${{ secrets.GL_API_TOKEN }}
+          GOLOGIN_PROFILE_ID: ${{ secrets.GOLOGIN_PROFILE_ID }}

package/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 Combined changelog for GoLogin node.js SDK
 
+## [2.1.23] 2025-06-09
+
+
+### Fixes
+
+* Viewport of puppeteer complies with profile resolution
+
+### New
+
+* Added fallback url for blocked countries
+
+### Miscellaneous Chores
+
+* Added sentry to have information about errors that users face
+
+
 ## [2.1.21] 2025-04-23
 
 

package/README.md

@@ -184,56 +184,13 @@ For debugging use `DEBUG=* node example.js` command
 To use GoLogin with Selenium see  `selenium/example.js`
 
 ## Full GoLogin API
-**Swagger:** <a href="https://api.gologin.com/docs" target="_blank">link here</a>
-
-**Postman:** <a href="https://documenter.getpostman.com/view/21126834/Uz5GnvaL" target="_blank">link here</a>
-
-
-## For local profiles
-
-#### startLocal()  
-
-- returns: string 
-
-start browser with profile id, return WebSocket url for puppeteer. Extracted profile folder should be in specified temp directory.
-
-#### stopLocal()  
-
-stop current browser without removing archived profile 
-
-### example-local-profile.js
-
-```js
-import puppeteer from 'puppeteer-core';
-
-import GoLogin from '../src/gologin.js';
-
-const { connect } = puppeteer;
-
-(async () => {
-  const GL = new GoLogin({
-    token: 'yU0token',
-    profile_id: 'yU0Pr0f1leiD',
-    executablePath: '/usr/bin/orbita-browser/chrome',
-    tmpdir: '/my/tmp/dir',
-  });
-
-  const wsUrl = await GL.startLocal();
-  const browser = await connect({
-    browserWSEndpoint: wsUrl.toString(),
-    ignoreHTTPSErrors: true,
-  });
-
-  const page = await browser.newPage();
-  await page.goto('https://myip.link');
-  console.log(await page.content());
-  await browser.close();
-  await GL.stopLocal({ posting: false });
-})();
-```
+<a href="https://gologin.com/docs/api-reference/profile/get-all-profiles" target="_blank">Gologin Api Documentation</a>
 
 ## Python support
 
 <a href="https://github.com/pyppeteer/pyppeteer" target="_blank">pyppeteer</a> (recommend) and <a href="https://www.selenium.dev" target="_blank">Selenium</a> supported (see file gologin.py)
 
 for Selenium may need download <a href="https://chromedriver.chromium.org/downloads" target="_blank">webdriver</a>
+
+## Privacy
+Our full privacy policy you can finde <a href="https://github.com/gologinapp/gologin/blob/master/docs/PRIVACY.md">here</a>

package/docker-compose.yml

@@ -0,0 +1,32 @@
+version: '3.8'
+
+services:
+  gologin-browser:
+    image: node:18-bullseye
+    platform: linux/amd64
+    container_name: gologin-browser
+    working_dir: /app
+    volumes:
+      - .:/app
+      - node_modules_cache:/app/node_modules
+    environment:
+      - GL_API_TOKEN=your_token_here
+      - NODE_ENV=development
+    ports:
+      - "9222:9222"
+    command: >
+      sh -c "
+        apt-get update &&
+        apt-get install -y libnss3 libatk-bridge2.0-0 libdrm2 libxkbcommon0 libgbm1 libxss1 libasound2 fonts-liberation libcups2 libxcomposite1 libxdamage1 libxrandr2 libxfixes3 libxtst6 libxi6 libx11-xcb1 libx11-6 libxcb1 libxext6 libxrender1 libcairo2 libglib2.0-0 libgtk-3-0 libgdk-pixbuf2.0-0 libpango-1.0-0 libpangocairo-1.0-0 libatk1.0-0 libcairo-gobject2 libgconf-2-4 libxshmfence1 libgl1-mesa-glx libgl1-mesa-dri libegl1-mesa libxau6 libxdmcp6 libappindicator3-1 xdg-utils &&
+        npm install &&
+        npm run test:e2e
+      "
+    networks:
+      - gologin-network
+
+volumes:
+  node_modules_cache:
+
+networks:
+  gologin-network:
+    driver: bridge 

package/docs/PRIVACY.md

@@ -0,0 +1,36 @@
+# Privacy Policy
+
+## Data Collection
+
+### Error Reporting
+
+We collect error information to improve the stability and performance of our application. Error data is sent to our self-hosted Sentry instance
+
+**What we collect:**
+- Error logs and stack traces only when application errors occur
+- Basic hardware information (CPU architecture, memory usage)
+- Software environment details (operating system, browser version)
+- Application state at the time of error
+
+**What we don't collect:**
+- Personal user information
+- User credentials or authentication data
+- Private user content or files
+- Browsing history or personal usage patterns
+
+**When we collect data:**
+- Only when application errors occur
+- No continuous monitoring or tracking
+- Data collection is limited to error scenarios
+
+**Data storage:**
+- All error data is stored on our self-hosted infrastructure
+- Data is not shared with third-party services
+- Error logs are retained for debugging and improvement purposes only
+
+**How to disable error reporting:**
+- Set environment variable: `DISABLE_TELEMETRY=true`
+
+## Contact
+
+If you have questions about this privacy policy or our data practices, please contact us.

package/index.d.ts

@@ -1,4 +1,4 @@
-import { type Browser } from 'puppeteer-core/lib/Browser';
+import { Browser } from 'puppeteer-core/lib/Browser';
 
 import { CreateCustomBrowserValidation, BrowserProxyCreateValidation } from './types/profile-params';
 
@@ -12,10 +12,6 @@ export type OsType = (typeof OPERATING_SYSTEMS)[keyof typeof OPERATING_SYSTEMS];
 
 type CloudLaunchParams = {
   cloud: true;
-
-  /**
-   * Format: 'dataCenter:DE'
-   */
   geolocation?: string;
 };
 type LocalLaunchParams = {
@@ -36,14 +32,7 @@ type LaunchParams =
   | ExistingProfileLaunchParams
   | NewProfileLaunchParams
   | {
-    /**
-     * default delay, 250
-     */
     defaultDelay: number;
-
-    /**
-     * Operating system
-     */
     os: OsType;
   };
 
@@ -62,19 +51,55 @@ type Cookie = {
   url?: string;
 };
 
+type TrafficData = {
+  trafficUsedBytes: number;
+  trafficLimitBytes: number;
+};
+
+type AvailableTrafficData = {
+  mobileTrafficData: TrafficData;
+  residentialTrafficData: TrafficData;
+  dataCenterTrafficData: TrafficData;
+};
+
+type ProxyType = 'mobile' | 'resident' | 'dataCenter';
+
+type ProxyResponse = {
+  trafficLimitBytes: number;
+  trafficUsedBytes: number;
+};
+
+type ProfileResponse = {
+  id: string;
+};
+
 type GologinApiType = {
   launch: (params?: LaunchParams) => Promise<{ browser: Browser }>;
-  exit: (status = 0) => Promise<void>;
+  createProfileWithCustomParams: (options: CreateCustomBrowserValidation) => Promise<string>;
+  refreshProfilesFingerprint: (profileIds: string[]) => Promise<any>;
+  createProfileRandomFingerprint: (name?: string) => Promise<ProfileResponse>;
+  updateUserAgentToLatestBrowser: (profileIds: string[], workspaceId?: string) => Promise<any>;
+  changeProfileProxy: (profileId: string, proxyData: BrowserProxyCreateValidation) => Promise<number>;
+  getAvailableType: (availableTrafficData: AvailableTrafficData) => ProxyType | 'none';
+  addGologinProxyToProfile: (profileId: string, countryCode: string, proxyType?: ProxyType | '') => Promise<ProxyResponse>;
+  addCookiesToProfile: (profileId: string, cookies: Cookie[]) => Promise<number>;
+  deleteProfile: (profileId: string) => Promise<number>;
+  exit: () => Promise<void>;
   createCustom: (params: CreateCustomBrowserValidation) => Promise<string>;
   updateProfileFingerprint: (profileId: string[]) => Promise<void>;
-  updateUserAgentToLatestBrowser: (profileIds: string[], workspaceId?: string) => Promise<void>;
   updateProfileProxy: (profileId: string, proxyData: BrowserProxyCreateValidation) => Promise<void>;
-  addCookiesToProfile: (profileId: string, cookies: Cookie[]) => Promise<void>;
 };
 
 type GologinApiParams = {
   token: string;
 };
 
+export declare function getDefaultParams(): {
+  token: string | undefined;
+  profile_id: string | undefined;
+  executablePath: string | undefined;
+};
+
 export declare function GologinApi(params: GologinApiParams): GologinApiType;
+
 export declare function exitAll(): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gologin",
-  "version": "2.1.21",
+  "version": "2.1.23",
   "description": "A high-level API to control Orbita browser over GoLogin API",
   "types": "./index.d.ts",
   "main": "./src/gologin.js",
@@ -15,6 +15,7 @@
   "author": "The GoLogin Authors",
   "license": "GPL-3.0",
   "dependencies": {
+    "@sentry/node": "^9.24.0",
     "adm-zip": "^0.5.1",
     "archiver": "^3.1.1",
     "child_process": "^1.0.2",
@@ -42,8 +43,11 @@
     "eslint-plugin-simple-import-sort": "^8.0.0"
   },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "npm run test:unit && npm run test:e2e",
+    "test:unit": "echo \"No unit tests specified\" && exit 0",
+    "test:e2e": "node test/e2e/run-tests.js",
+    "test:e2e:local": "HEADLESS=false npm run test:e2e",
     "format": "npx prettier --single-quote src/* --write",
     "iphey": "GOLOGIN_PROFILE_ID= GOLOGIN_API_TOKEN= node examples/example-iphey "
   }
-}
+}

package/src/browser/browser-api.js

@@ -1,6 +1,5 @@
-import requestretry from 'requestretry';
-
-import { API_URL } from '../utils/common.js';
+import { API_URL, FALLBACK_API_URL } from '../utils/common.js';
+import { makeRequest } from '../utils/http.js';
 
 /**
   * @param {string} profileId
@@ -8,15 +7,15 @@ import { API_URL } from '../utils/common.js';
   * @param {string} resolution
 */
 export const updateProfileResolution = (profileId, ACCESS_TOKEN, resolution) =>
-  requestretry.patch(`${API_URL}/browser/${profileId}/resolution`, {
-    headers: {
-      Authorization: `Bearer ${ACCESS_TOKEN}`,
-      'user-agent': 'gologin-api',
-    },
+  makeRequest(`${API_URL}/browser/${profileId}/resolution`, {
+    method: 'PATCH',
     json: { resolution },
     maxAttempts: 3,
     retryDelay: 2000,
     timeout: 10 * 1000,
+  }, {
+    token: ACCESS_TOKEN,
+    fallbackUrl: `${FALLBACK_API_URL}/browser/${profileId}/resolution`,
   }).catch((e) => {
     console.log(e);
 
@@ -29,15 +28,15 @@ export const updateProfileResolution = (profileId, ACCESS_TOKEN, resolution) =>
   * @param {string} userAgent
 */
 export const updateProfileUserAgent = (profileId, ACCESS_TOKEN, userAgent) =>
-  requestretry.patch(`${API_URL}/browser/${profileId}/ua`, {
-    headers: {
-      Authorization: `Bearer ${ACCESS_TOKEN}`,
-      'user-agent': 'gologin-api',
-    },
+  makeRequest(`${API_URL}/browser/${profileId}/ua`, {
+    method: 'PATCH',
     json: { userAgent },
     maxAttempts: 3,
     retryDelay: 2000,
     timeout: 10 * 1000,
+  }, {
+    token: ACCESS_TOKEN,
+    fallbackUrl: `${FALLBACK_API_URL}/browser/${profileId}/ua`,
   }).catch((e) => {
     console.log(e);
 
@@ -55,15 +54,15 @@ export const updateProfileUserAgent = (profileId, ACCESS_TOKEN, userAgent) =>
   * @param {string} [browserProxyData.password]
 */
 export const updateProfileProxy = (profileId, ACCESS_TOKEN, browserProxyData) =>
-  requestretry.patch(`${API_URL}/browser/${profileId}/proxy`, {
-    headers: {
-      Authorization: `Bearer ${ACCESS_TOKEN}`,
-      'user-agent': 'gologin-api',
-    },
+  makeRequest(`${API_URL}/browser/${profileId}/proxy`, {
+    method: 'PATCH',
     json: browserProxyData,
     maxAttempts: 3,
     retryDelay: 2000,
     timeout: 10 * 1000,
+  }, {
+    token: ACCESS_TOKEN,
+    fallbackUrl: `${FALLBACK_API_URL}/browser/${profileId}/proxy`,
   }).catch((e) => {
     console.log(e);
 
@@ -81,15 +80,15 @@ export const updateProfileBookmarks = async (profileIds, ACCESS_TOKEN, bookmarks
     bookmarks,
   };
 
-  return requestretry.patch(`${API_URL}/browser/bookmarks/many`, {
-    headers: {
-      Authorization: `Bearer ${ACCESS_TOKEN}`,
-      'user-agent': 'gologin-api',
-    },
+  return makeRequest(`${API_URL}/browser/bookmarks/many`, {
+    method: 'PATCH',
     json: params,
     maxAttempts: 3,
     retryDelay: 2000,
     timeout: 10 * 1000,
+  }, {
+    token: ACCESS_TOKEN,
+    fallbackUrl: `${FALLBACK_API_URL}/browser/bookmarks/many`,
   }).catch((error) => console.log(error));
 };
 

package/src/browser/browser-checker.js

@@ -7,11 +7,12 @@ import { homedir } from 'os';
 import { join } from 'path';
 import ProgressBar from 'progress';
 import util from 'util';
+import { createInterface } from 'readline';
 
 import { API_URL, getOS } from '../utils/common.js';
 
 const exec = util.promisify(execNonPromise);
-const { access, mkdir, readdir, rmdir, unlink, copyFile, readlink, symlink, lstat, rename, writeFile } = _promises;
+const { access, mkdir, readdir, rmdir, unlink, copyFile, readlink, symlink, lstat, rename, writeFile, readFile } = _promises;
 
 const PLATFORM = process.platform;
 const ARCH = process.arch;
@@ -44,15 +45,52 @@ export class BrowserChecker {
 
   }
 
-  async checkBrowser(majorVersion) {
+  async checkBrowser({ autoUpdateBrowser, checkBrowserUpdate, majorVersion }) {
     const isBrowserFolderExists = await access(join(this.#browserPath, `orbita-browser-${majorVersion}`)).then(() => true).catch(() => false);
-    if (isBrowserFolderExists) {
+
+    if (!isBrowserFolderExists || autoUpdateBrowser) {
+      await this.downloadBrowser(majorVersion);
+
       return this.getBrowserExecutablePath(majorVersion);
     }
 
-    await this.downloadBrowser(majorVersion);
-
     return this.getBrowserExecutablePath(majorVersion);
+
+    // TO DO: add check for browser update
+    // const { latestVersion: browserLatestVersion } = await this.getLatestBrowserVersion();
+    // const [latestBrowserMajorVersion] = browserLatestVersion.split('.');
+    // const currentVersion = await this.getCurrentVersion(majorVersion);
+
+    // const isCurrentVersionsLatest = majorVersion === latestBrowserMajorVersion;
+    // console.log('browserLatestVersion', browserLatestVersion);
+    // console.log('currentVersion', currentVersion);
+    // console.log('isCurrentVersionsLatest', isCurrentVersionsLatest);
+    // console.log('checkBrowserUpdate', checkBrowserUpdate);
+    // console.log('autoUpdateBrowser', autoUpdateBrowser);
+    // if (browserLatestVersion === currentVersion || !(checkBrowserUpdate && isCurrentVersionsLatest)) {
+    //   return this.getBrowserExecutablePath(majorVersion);
+    // }
+
+    
+
+    // return new Promise(resolve => {
+    //   const rl = createInterface(process.stdin, process.stdout);
+    //   const timeout = setTimeout(() => {
+    //     console.log(`\nContinue with current ${currentVersion} version.`);
+    //     resolve();
+    //   }, 10000);
+
+    //   rl.question(`New Orbita ${browserLatestVersion} is available. Update? [y/n] `, (answer) => {
+    //     clearTimeout(timeout);
+    //     rl.close();
+    //     if (answer && answer[0].toString().toLowerCase() === 'y') {
+    //       return this.downloadBrowser(majorVersion).then(() => resolve(this.getBrowserExecutablePath(majorVersion)));
+    //     }
+
+    //     console.log(`Continue with current ${currentVersion} version.`);
+    //     resolve(this.getBrowserExecutablePath(majorVersion));
+    //   });
+    // });
   }
 
   async downloadBrowser(majorVersion) {
@@ -274,11 +312,7 @@ export class BrowserChecker {
     );
   }
 
-  async deleteOldArchives(deleteCurrentBrowser = false) {
-    if (deleteCurrentBrowser) {
-      return this.deleteDir(join(this.#browserPath, 'orbita-browser'));
-    }
-
+  async deleteOldArchives() {
     await this.deleteDir(join(this.#browserPath, EXTRACTED_FOLDER));
 
     return readdir(this.#browserPath)
@@ -315,15 +349,13 @@ export class BrowserChecker {
     }
   }
 
-  getCurrentVersion() {
-    let command = `if [ -f ${join(this.#browserPath, 'orbita-browser', 'version')} ]; then cat ${join(this.#browserPath, 'orbita-browser', 'version')}; else echo 0.0.0; fi`;
-    if (PLATFORM === 'win32') {
-      command = `if exist "${join(this.#browserPath, 'orbita-browser', 'version')}" (type "${join(this.#browserPath, 'orbita-browser', 'version')}") else (echo 0.0.0)`;
-    } else if (PLATFORM === 'darwin') {
-      command = `if [ -f ${join(this.#browserPath, 'orbita-browser', 'version', VERSION_FILE)} ]; then cat ${join(this.#browserPath, 'orbita-browser', 'version', VERSION_FILE)}; else echo 0.0.0; fi`;
+  async getCurrentVersion(majorVersion) {
+    let versionFilePath = join(this.#browserPath, `orbita-browser-${majorVersion}`, 'version');
+    if (PLATFORM === 'darwin') {
+      versionFilePath = join(this.#browserPath, `orbita-browser-${majorVersion}`, 'version', VERSION_FILE);
     }
 
-    return exec(command);
+    return (await readFile(versionFilePath, 'utf8').catch(() => '0.0.0')).replace(/[\r\n\t\f\v\u0000-\u001F\u007F]/g, '');
   }
 
   getLatestBrowserVersion() {

package/src/browser/browser-user-data-manager.js

@@ -2,10 +2,11 @@ import { createHash } from 'crypto';
 import { createWriteStream, promises as _promises, rmdirSync } from 'fs';
 import { homedir, tmpdir } from 'os';
 import { dirname, join, resolve, sep } from 'path';
-import requestretry from 'requestretry';
 import { fileURLToPath } from 'url';
 
 import { fontsCollection } from '../../fonts.js';
+import { FALLBACK_API_URL } from '../utils/common.js';
+import { makeRequest } from '../utils/http.js';
 
 const { access, readFile, writeFile, mkdir, readdir, copyFile, rename } = _promises;
 
@@ -24,15 +25,15 @@ const GOLOGIN_TEST_FOLDER_NAME = '.gologin_test';
 const osPlatform = process.platform;
 
 export const downloadCookies = ({ profileId, ACCESS_TOKEN, API_BASE_URL }) =>
-  requestretry.get(`${API_BASE_URL}/browser/${profileId}/cookies`, {
-    headers: {
-      Authorization: `Bearer ${ACCESS_TOKEN}`,
-      'user-agent': 'gologin-api',
-    },
+  makeRequest(`${API_BASE_URL}/browser/${profileId}/cookies`, {
     json: true,
     maxAttempts: 3,
     retryDelay: 2000,
     timeout: 10 * 1000,
+    method: 'GET',
+  }, {
+    token: ACCESS_TOKEN,
+    fallbackUrl: `${FALLBACK_API_URL}/browser/${profileId}/cookies`,
   }).catch((e) => {
     console.log(e);
 
@@ -40,15 +41,15 @@ export const downloadCookies = ({ profileId, ACCESS_TOKEN, API_BASE_URL }) =>
   });
 
 export const uploadCookies = ({ cookies = [], profileId, ACCESS_TOKEN, API_BASE_URL }) =>
-  requestretry.post(`${API_BASE_URL}/browser/${profileId}/cookies?encrypted=true`, {
-    headers: {
-      Authorization: `Bearer ${ACCESS_TOKEN}`,
-      'User-Agent': 'gologin-api',
-    },
+  makeRequest(`${API_BASE_URL}/browser/${profileId}/cookies?encrypted=true`, {
     json: cookies,
     maxAttempts: 3,
     retryDelay: 2000,
     timeout: 20 * 1000,
+    method: 'POST',
+  }, {
+    token: ACCESS_TOKEN,
+    fallbackUrl: `${FALLBACK_API_URL}/browser/${profileId}/cookies?encrypted=true`,
   }).catch((e) => {
     console.log(e);
 
@@ -66,7 +67,7 @@ export const downloadFonts = async (fontsList = [], profilePath) => {
   const files = await readdir(browserFontsPath);
   const fontsToDownload = fontsList.filter(font => !files.includes(font));
 
-  let promises = fontsToDownload.map(font => requestretry.get(FONTS_URL + font, {
+  let promises = fontsToDownload.map(font => makeRequest(FONTS_URL + font, {
     maxAttempts: 5,
     retryDelay: 2000,
     timeout: 30 * 1000,