feat: add SDK and Crawlee version to the ApifyClient's user agent

Closes #331
apify · Nov 1, 2024 · 3e1e0bf · 3e1e0bf
1 parent 928a55e
commit 3e1e0bf
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 13 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/apify/package.json b/packages/apify/package.json
@@ -62,11 +62,11 @@
         "@crawlee/core": "^3.9.0",
         "@crawlee/types": "^3.9.0",
         "@crawlee/utils": "^3.9.0",
-        "apify-client": "^2.9.0",
+        "apify-client": "^2.10.0",
         "fs-extra": "^11.2.0",
         "ow": "^0.28.2",
         "semver": "^7.5.4",
         "tslib": "^2.6.2",
         "ws": "^8.18.0"
     }
-}
+}
diff --git a/packages/apify/src/actor.ts b/packages/apify/src/actor.ts
@@ -41,7 +41,7 @@ import { KeyValueStore } from './key_value_store';
 import { PlatformEventManager } from './platform_event_manager';
 import type { ProxyConfigurationOptions } from './proxy_configuration';
 import { ProxyConfiguration } from './proxy_configuration';
-import { checkCrawleeVersion, logSystemInfo, printOutdatedSdkWarning } from './utils';
+import { checkCrawleeVersion, getSystemInfo, printOutdatedSdkWarning } from './utils';
 
 /**
  * `Actor` class serves as an alternative approach to the static helpers exported from the package. It allows to pass configuration
@@ -191,7 +191,7 @@ export class Actor<Data extends Dictionary = Dictionary> {
         this.initialized = true;
 
         checkCrawleeVersion();
-        logSystemInfo();
+        log.info('System info', getSystemInfo());
         printOutdatedSdkWarning();
 
         // reset global config instance to respect APIFY_ prefixed env vars
@@ -938,9 +938,11 @@ export class Actor<Data extends Dictionary = Dictionary> {
      */
     newClient(options: ApifyClientOptions = {}): ApifyClient {
         const { storageDir, ...storageClientOptions } = this.config.get('storageClientOptions') as Dictionary;
+        const { apifyVersion, crawleeVersion } = getSystemInfo();
         return new ApifyClient({
             baseUrl: this.config.get('apiBaseUrl'),
             token: this.config.get('token'),
+            userAgentSuffix: [`SDK/${apifyVersion}`, `Crawlee/${crawleeVersion}`],
             ...storageClientOptions,
             ...options, // allow overriding the instance configuration
         });

diff --git a/packages/apify/src/utils.ts b/packages/apify/src/utils.ts
@@ -14,21 +14,20 @@ import semver from 'semver';
 import { version as apifyVersion } from '../package.json';
 
 /**
- * Logs info about system, node version and apify package version.
+ * Gets info about system, node version and apify package version.
  * @internal
  */
-export function logSystemInfo() {
-    log.info('System info', {
+export function getSystemInfo() {
+    return {
         apifyVersion,
         apifyClientVersion,
         crawleeVersion,
         osType: type(),
         nodeVersion: process.version,
-    });
+    };
 }
 
 /**
- * Logs info about system, node version and apify package version.
  * @internal
  */
 export function checkCrawleeVersion() {