apify 4.0.0-beta.31 → 4.0.0-beta.32

package/dist/proxy_configuration.js

@@ -53,13 +53,13 @@ const SESSION_ID_LENGTH = 12;
  */
 export class ProxyConfiguration extends CoreProxyConfiguration {
     configuration;
-    groups;
-    countryCode;
-    subdivisionCode;
-    password;
-    hostname;
-    port;
-    usesApifyProxy;
+    #groups;
+    #countryCode;
+    #subdivisionCode;
+    #password;
+    #hostname;
+    #port;
+    #usesApifyProxy;
     log = defaultLog.child({ prefix: 'ProxyConfiguration' });
     /**
      * @internal
@@ -96,17 +96,15 @@ export class ProxyConfiguration extends CoreProxyConfiguration {
         }
         // Validation
         if ((proxyUrls || newUrlFunction) && (groupsToUse.length || countryCodeToUse || subdivisionCodeToUse)) {
-            this._throwCannotCombineCustomWithApify();
+            this.throwCannotCombineCustomWithApify();
         }
-        if (proxyUrls && newUrlFunction)
-            this._throwCannotCombineCustomMethods();
-        this.groups = groupsToUse;
-        this.countryCode = countryCodeToUse;
-        this.subdivisionCode = subdivisionCodeToUse;
-        this.password = password;
-        this.hostname = hostname;
-        this.port = port;
-        this.usesApifyProxy = !proxyUrls && !newUrlFunction;
+        this.#groups = groupsToUse;
+        this.#countryCode = countryCodeToUse;
+        this.#subdivisionCode = subdivisionCodeToUse;
+        this.#password = password;
+        this.#hostname = hostname;
+        this.#port = port;
+        this.#usesApifyProxy = !proxyUrls && !newUrlFunction;
         if (proxyUrls && proxyUrls.some((url) => url?.includes('apify.com'))) {
             this.log.warning('Some Apify proxy features may work incorrectly. Please consider setting up Apify properties instead of `proxyUrls`.\n' +
                 'See https://docs.apify.com/sdk/js/docs/concepts/proxy-management#apify-proxy-configuration');
@@ -121,11 +119,11 @@ export class ProxyConfiguration extends CoreProxyConfiguration {
      * `ProxyConfiguration` instance instead of calling this manually.
      */
     async initialize(options) {
-        if (this.usesApifyProxy) {
-            if (!this.password) {
-                await this._setPasswordIfToken();
+        if (this.#usesApifyProxy) {
+            if (!this.#password) {
+                await this.setPasswordIfToken();
             }
-            if (!this.password) {
+            if (!this.#password) {
                 if (Actor.isAtHome()) {
                     throw new Error(`Apify Proxy password must be provided using options.password or the "${APIFY_ENV_VARS.PROXY_PASSWORD}" environment variable. ` +
                         `You can also provide your Apify token via the "${APIFY_ENV_VARS.TOKEN}" environment variable, ` +
@@ -139,7 +137,7 @@ export class ProxyConfiguration extends CoreProxyConfiguration {
                 }
             }
             if (options?.checkAccess !== false) {
-                return this._checkAccess();
+                return this.checkAccess();
             }
         }
         return true;
@@ -161,12 +159,12 @@ export class ProxyConfiguration extends CoreProxyConfiguration {
             hostname: parsed.hostname,
             port: parsed.port,
         };
-        if (this.usesApifyProxy) {
-            result.groups = this.groups;
-            if (this.countryCode !== undefined)
-                result.countryCode = this.countryCode;
-            if (this.subdivisionCode !== undefined)
-                result.subdivisionCode = this.subdivisionCode;
+        if (this.#usesApifyProxy) {
+            result.groups = this.#groups;
+            if (this.#countryCode !== undefined)
+                result.countryCode = this.#countryCode;
+            if (this.#subdivisionCode !== undefined)
+                result.subdivisionCode = this.#subdivisionCode;
         }
         return result;
     }
@@ -176,7 +174,7 @@ export class ProxyConfiguration extends CoreProxyConfiguration {
      * `proxyUrls`, the URLs are rotated round-robin.
      */
     async newUrl(options) {
-        if (!this.usesApifyProxy) {
+        if (!this.#usesApifyProxy) {
             return super.newUrl(options);
         }
         return this.composeDefaultUrl(cryptoRandomObjectId(SESSION_ID_LENGTH));
@@ -184,40 +182,38 @@ export class ProxyConfiguration extends CoreProxyConfiguration {
     /**
      * Returns proxy username.
      */
-    _getUsername(sessionId) {
-        const { groups, countryCode, subdivisionCode } = this;
+    getUsername(sessionId) {
         const parts = [];
-        if (groups && groups.length) {
-            parts.push(`groups-${groups.join('+')}`);
+        if (this.#groups && this.#groups.length) {
+            parts.push(`groups-${this.#groups.join('+')}`);
         }
         parts.push(`session-${sessionId}`);
-        if (subdivisionCode) {
-            parts.push(`country-${countryCode}_${subdivisionCode}`);
+        if (this.#subdivisionCode) {
+            parts.push(`country-${this.#countryCode}_${this.#subdivisionCode}`);
         }
-        else if (countryCode) {
-            parts.push(`country-${countryCode}`);
+        else if (this.#countryCode) {
+            parts.push(`country-${this.#countryCode}`);
         }
         return parts.join(',');
     }
     composeDefaultUrl(sessionId) {
-        const username = this._getUsername(sessionId);
-        const url = new URL(`http://${this.hostname}:${this.port}`);
+        const username = this.getUsername(sessionId);
+        const url = new URL(`http://${this.#hostname}:${this.#port}`);
         url.username = `${username}`;
-        url.password = `${this.password}`;
+        url.password = `${this.#password}`;
         const urlString = url.toString();
         return urlString.substring(0, urlString.length - 1);
     }
     /**
      * Fetch & set the proxy password from Apify API if an Apify token is provided.
      */
-    // TODO: Make this private
-    async _setPasswordIfToken() {
+    async setPasswordIfToken() {
         const { token } = this.configuration;
         if (!token)
             return;
         try {
             const user = await Actor.apifyClient.user().get();
-            this.password = user.proxy?.password;
+            this.#password = user.proxy?.password;
         }
         catch (error) {
             if (Actor.isAtHome()) {
@@ -235,8 +231,8 @@ export class ProxyConfiguration extends CoreProxyConfiguration {
      * If the check can not be made, it only prints a warning and allows the program to continue. This is to
      * prevent program crashes caused by short downtimes of Proxy.
      */
-    async _checkAccess() {
-        const status = await this._fetchStatus();
+    async checkAccess() {
+        const status = await this.fetchStatus();
         if (!status) {
             this.log.warning('Apify Proxy access check timed out. Watch out for errors with status code 407. ' +
                 "If you see some, it most likely means you don't have access to either all or some of the proxies you're trying to use.");
@@ -261,7 +257,7 @@ export class ProxyConfiguration extends CoreProxyConfiguration {
     /**
      * Apify Proxy can be down for a second or a minute, but this should not crash processes.
      */
-    async _fetchStatus() {
+    async fetchStatus() {
         const { proxyStatusUrl } = this.configuration;
         const statusUrl = `${proxyStatusUrl}/?format=json`;
         const proxyUrl = await this.newUrl();
@@ -270,7 +266,7 @@ export class ProxyConfiguration extends CoreProxyConfiguration {
             return undefined;
         for (let attempt = 1; attempt <= CHECK_ACCESS_MAX_ATTEMPTS; attempt++) {
             try {
-                return await this._requestStatus(statusUrl, proxyUrl);
+                return await this.requestStatus(statusUrl, proxyUrl);
             }
             catch {
                 // retry connection errors
@@ -286,7 +282,7 @@ export class ProxyConfiguration extends CoreProxyConfiguration {
      * plus a `Proxy-Authorization` header — so no proxy-agent dependency is
      * needed. The status endpoint (`http://proxy.apify.com`) is plain HTTP.
      */
-    async _requestStatus(statusUrl, proxyUrl) {
+    async requestStatus(statusUrl, proxyUrl) {
         const target = new URL(statusUrl);
         const proxy = new URL(proxyUrl);
         const headers = { host: target.host };
@@ -304,7 +300,7 @@ export class ProxyConfiguration extends CoreProxyConfiguration {
         });
         request.end();
         // `once` rejects if the request emits `error` first (connection refused,
-        // timeout/abort), so failures propagate to the retry loop in `_fetchStatus`.
+        // timeout/abort), so failures propagate to the retry loop in `fetchStatus`.
         const [response] = (await once(request, 'response'));
         const statusCode = response.statusCode ?? 0;
         if (statusCode < 200 || statusCode >= 300) {
@@ -317,17 +313,10 @@ export class ProxyConfiguration extends CoreProxyConfiguration {
      * Throws cannot combine custom proxies with Apify Proxy
      * @internal
      */
-    _throwCannotCombineCustomWithApify() {
+    throwCannotCombineCustomWithApify() {
         throw new Error('Cannot combine custom proxies with Apify Proxy! ' +
             'It is not allowed to set "options.proxyUrls" or "options.newUrlFunction" combined with ' +
             '"options.groups", "options.apifyProxyGroups", "options.countryCode", "options.apifyProxyCountry", ' +
             '"options.subdivisionCode" or "options.apifyProxySubdivision".');
     }
-    /**
-     * Throws cannot combine custom proxies with custom generating function
-     * @internal
-     */
-    _throwCannotCombineCustomMethods() {
-        throw new Error('Cannot combine custom proxies "options.proxyUrls" with custom generating function "options.newUrlFunction".');
-    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apify",
-  "version": "4.0.0-beta.31",
+  "version": "4.0.0-beta.32",
   "description": "The scalable web crawling and scraping library for JavaScript/Node.js. Enables development of data extraction and web automation jobs (not only) with headless Chrome and Puppeteer.",
   "engines": {
     "node": ">=22.0.0"