fix: prefer proxy password from env var (#385)

- Fetch proxy password from `/user/me` using `APIFY_ENV_VARS.TOKEN` only
when `APIFY_ENV_VARS.PROXY_PASSWORD` is not provided
- Proxy init no longer logs when there is a difference between the proxy
password from the environmental variable and the one obtained from the
API, since only one is going to be taken into consideration. When
running on Apify, the passwords will always be different.
- should solve the second part of:
https://console.apify.com/actors/RB9HEZitC8hIUXAha/issues/exVPDR4pOsgqlkE5T

Closes [#20502](apify/apify-core#20502)

Author: stepskop

packages/apify/src/proxy_configuration.ts

@@ -4,7 +4,6 @@ import type {
 } from '@crawlee/core';
 import { ProxyConfiguration as CoreProxyConfiguration } from '@crawlee/core';
 import { gotScraping } from '@crawlee/utils';
-import type { UserProxy } from 'apify-client';
 import ow from 'ow';
 
 import { APIFY_ENV_VARS, APIFY_PROXY_VALUE_REGEX } from '@apify/consts';
@@ -260,7 +259,27 @@ export class ProxyConfiguration extends CoreProxyConfiguration {
      */
     async initialize(): Promise<boolean> {
         if (this.usesApifyProxy) {
-            await this._setPasswordIfToken();
+            if (!this.password) {
+                await this._setPasswordIfToken();
+            }
+
+            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, ` +
+                            `so that the SDK can fetch the proxy password from Apify API, when ${APIFY_ENV_VARS.PROXY_PASSWORD} is not defined`,
+                    );
+                } else {
+                    this.log.warning(
+                        `No proxy password or token detected, running without proxy. To use Apify Proxy locally, ` +
+                            `provide options.password or "${APIFY_ENV_VARS.PROXY_PASSWORD}" environment variable. ` +
+                            `You can also provide your Apify token via the "${APIFY_ENV_VARS.TOKEN}" environment variable, ` +
+                            `so that the SDK can fetch the proxy password from Apify API, when ${APIFY_ENV_VARS.PROXY_PASSWORD} is not defined`,
+                    );
+                }
+            }
+
             return this._checkAccess();
         }
 
@@ -415,55 +434,23 @@ export class ProxyConfiguration extends CoreProxyConfiguration {
     }
 
     /**
-     * Checks if Apify Token is provided in env and gets the password via API and sets it to env
+     * Fetch & set the proxy password from Apify API if an Apify token is provided.
      */
+    // TODO: Make this private
     protected async _setPasswordIfToken(): Promise<void> {
         const token = this.config.get('token');
 
-        if (token) {
-            let proxy: UserProxy;
-
-            try {
-                const user = await Actor.apifyClient.user().get();
-                proxy = user.proxy!;
-            } catch (error) {
-                if (Actor.isAtHome()) {
-                    throw error;
-                } else {
-                    this.log.warning(
-                        `Failed to fetch user data based on token, disabling proxy.`,
-                        { error },
-                    );
-                    return;
-                }
-            }
-
-            const { password } = proxy!;
-
-            if (this.password) {
-                if (this.password !== password) {
-                    this.log.warning(
-                        'The Apify Proxy password you provided belongs to' +
-                            ' a different user than the Apify token you are using. Are you sure this is correct?',
-                    );
-                }
-            } else {
-                this.password = password;
-            }
-        }
-
-        if (!this.password) {
+        if (!token) return;
+        try {
+            const user = await Actor.apifyClient.user().get();
+            this.password = user.proxy?.password;
+        } catch (error) {
             if (Actor.isAtHome()) {
-                throw new Error(
-                    `Apify Proxy password must be provided using options.password or the "${APIFY_ENV_VARS.PROXY_PASSWORD}" environment variable. ` +
-                        `If you add the "${APIFY_ENV_VARS.TOKEN}" environment variable, the password will be automatically inferred.`,
-                );
+                throw error;
             } else {
-                this.log.warning(
-                    `No proxy password or token detected, running without proxy. To use Apify Proxy locally, ` +
-                        `provide options.password or "${APIFY_ENV_VARS.PROXY_PASSWORD}" environment variable. ` +
-                        `If you add the "${APIFY_ENV_VARS.TOKEN}" environment variable, the password will be automatically inferred.`,
-                );
+                this.log.warning(`Failed to fetch user data using token`, {
+                    error,
+                });
             }
         }
     }

test/apify/proxy_configuration.test.ts

@@ -619,26 +619,16 @@ describe('Actor.createProxyConfiguration()', () => {
         getUserSpy.mockRestore();
     });
 
-    test('should show warning log', async () => {
-        process.env.APIFY_TOKEN = '123456789';
+    test(`shouldn't request password from API when both PROXY_PASSWORD and TOKEN envs are provided`, async () => {
+        process.env[APIFY_ENV_VARS.TOKEN] = 'some_token';
+        process.env[APIFY_ENV_VARS.PROXY_PASSWORD] = 'proxy_password';
 
         const getUserSpy = vitest.spyOn(UserClient.prototype, 'get');
-        const status = { connected: true };
-        const fakeUserData = {
-            proxy: { password: 'some-other-users-password' },
-        };
-        getUserSpy.mockResolvedValueOnce(fakeUserData as any);
-        gotScrapingSpy.mockResolvedValueOnce({ body: status } as any);
-
-        const proxyConfiguration = new ProxyConfiguration(basicOpts);
-        // @ts-expect-error
-        const logMock = vitest.spyOn(proxyConfiguration.log, 'warning');
+        const proxyConfiguration = new ProxyConfiguration();
         await proxyConfiguration.initialize();
-        expect(logMock).toBeCalledTimes(1);
+        expect(getUserSpy).toBeCalledTimes(0);
 
-        logMock.mockRestore();
         getUserSpy.mockRestore();
-        gotScrapingSpy.mockRestore();
     });
 
     // TODO: test that on platform we throw but locally we only print warning