feat: allow appending custom parts to the user agent (#602)

Related apify/apify-sdk-js#331

Author: B4nan

package-lock.json

@@ -1,6 +1,6 @@
 {
 	"name": "apify-client",
-	"version": "2.9.7",
+	"version": "2.9.8",
 	"description": "Apify API client for JavaScript",
 	"main": "dist/index.js",
 	"module": "dist/index.mjs",

package.json

@@ -53,6 +53,7 @@ export class ApifyClient {
             requestInterceptors: ow.optional.array,
             timeoutSecs: ow.optional.number,
             token: ow.optional.string,
+            userAgentSuffix: ow.optional.any(ow.string, ow.array.ofType(ow.string)),
         }));
 
         const {
@@ -77,6 +78,7 @@ export class ApifyClient {
             timeoutSecs,
             logger: this.logger,
             token: this.token,
+            userAgentSuffix: options.userAgentSuffix,
         });
     }
 
@@ -341,4 +343,5 @@ export interface ApifyClientOptions {
     /** @default 360 */
     timeoutSecs?: number;
     token?: string;
+    userAgentSuffix?: string | string[];
 }

src/apify_client.ts

@@ -6,11 +6,11 @@ import KeepAliveAgent from 'agentkeepalive';
 import retry, { RetryFunction } from 'async-retry';
 import axios, {
     AxiosError,
+    AxiosHeaders,
     AxiosInstance,
     AxiosRequestConfig,
-    InternalAxiosRequestConfig,
     AxiosResponse,
-    AxiosHeaders,
+    InternalAxiosRequestConfig,
 } from 'axios';
 
 import { ApifyApiError } from './apify_api_error';
@@ -21,12 +21,7 @@ import {
     responseInterceptors,
 } from './interceptors';
 import { Statistics } from './statistics';
-import {
-    isNode,
-    getVersionData,
-    cast,
-    isStream,
-} from './utils';
+import { asArray, cast, getVersionData, isNode, isStream } from './utils';
 
 const { version } = getVersionData();
 
@@ -116,7 +111,12 @@ export class HttpClient {
         if (isNode()) {
             // Works only in Node. Cannot be set in browser
             const isAtHome = !!process.env[APIFY_ENV_VARS.IS_AT_HOME];
-            const userAgent = `ApifyClient/${version} (${os.type()}; Node/${process.version}); isAtHome/${isAtHome}`;
+            let userAgent = `ApifyClient/${version} (${os.type()}; Node/${process.version}); isAtHome/${isAtHome}`;
+
+            if (options.userAgentSuffix) {
+                userAgent += `; ${asArray(options.userAgentSuffix).join('; ')}`;
+            }
+
             this.axios.defaults.headers['User-Agent'] = userAgent;
         }
 
@@ -288,4 +288,6 @@ export interface HttpClientOptions {
     logger: Log;
     token?: string;
     workflowKey?: string;
+    /** @internal */
+    userAgentSuffix?: string | string[];
 }

src/http_client.ts

@@ -238,6 +238,14 @@ export function cast<T>(input: unknown): T {
     return input as T;
 }
 
+export function asArray<T>(value: T | T[]): T[] {
+    if (Array.isArray(value)) {
+        return value;
+    }
+
+    return [value];
+}
+
 export type Dictionary<T = unknown> = Record<PropertyKey, T>;
 
 export type DistributiveOptional<T, K extends keyof T> = T extends any ? Omit<T, K> & Partial<Pick<T, K>> : never;

src/utils.ts

@@ -27,10 +27,7 @@ describe('HttpClient', () => {
             baseUrl,
             timeoutSecs: 1,
             maxRetries: 0,
-            requestInterceptors: [(config) => {
-                config.headers = {};
-                return config;
-            }],
+            userAgentSuffix: ['SDK/3.1.1', 'Crawlee/3.11.5'],
         });
     });
     afterEach(async () => {
@@ -41,20 +38,13 @@ describe('HttpClient', () => {
         const context = { delayMillis: 3000 };
         const resourceId = Buffer.from(JSON.stringify(context)).toString('hex');
 
-        expect.assertions(2);
-        try {
-            await client.actor(resourceId).get();
-        } catch (err) {
-            expect(err.message).toMatch('timeout of 1000ms exceeded');
-        }
+        await expect(client.actor(resourceId).get()).rejects.toThrow('timeout of 1000ms exceeded');
+        const ua = mockServer.getLastRequest().headers['user-agent'];
+        expect(ua).toMatch(/ApifyClient\/\d+\.\d+\.\d+/);
+        expect(ua).toMatch('isAtHome/false; SDK/3.1.1; Crawlee/3.11.5');
 
-        try {
-            const r = await page.evaluate((rId) => client.task(rId).get(), resourceId);
-            expect(r).toBeDefined();
-        } catch (err) {
-            expect(err).toBeInstanceOf(Error);
-            // this is failing after axios upgrade, the error is returned with a wrong name and message
-            // expect(err.message).toMatch('timeout of 1000ms exceeded');
-        }
+        await expect(page.evaluate((rId) => client.task(rId).get(), resourceId)).rejects.toThrow();
+        // this is failing after axios upgrade, the error is returned with a wrong name and message
+        // expect(err.message).toMatch('timeout of 1000ms exceeded');
     });
 });