Merge pull request #528 from multiversx/TOOL-327-extend-user-agent-on…

…ly-on-backend

Extend user agent only on backend

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@multiversx/sdk-core",
-  "version": "13.14.0",
+  "version": "13.14.2",
   "description": "MultiversX SDK for JavaScript and TypeScript",
   "author": "MultiversX",
   "homepage": "https://multiversx.com",

src/networkProviders/apiNetworkProvider.ts

@@ -18,7 +18,7 @@ import { DefinitionOfFungibleTokenOnNetwork, DefinitionOfTokenCollectionOnNetwor
 import { FungibleTokenOfAccountOnNetwork, NonFungibleTokenOfAccountOnNetwork } from "./tokens";
 import { TransactionOnNetwork, prepareTransactionForBroadcasting } from "./transactions";
 import { TransactionStatus } from "./transactionStatus";
-import { extendUserAgent } from "./userAgent";
+import { extendUserAgentIfBackend } from "./userAgent";
 
 // TODO: Find & remove duplicate code between "ProxyNetworkProvider" and "ApiNetworkProvider".
 export class ApiNetworkProvider implements INetworkProvider {
@@ -34,7 +34,7 @@ export class ApiNetworkProvider implements INetworkProvider {
         this.config = { ...defaultAxiosConfig, ...config };
         this.backingProxyNetworkProvider = new ProxyNetworkProvider(url, proxyConfig);
         this.axios = getAxios();
-        extendUserAgent(this.userAgentPrefix, this.config);
+        extendUserAgentIfBackend(this.userAgentPrefix, this.config);
     }
 
     private getProxyConfig(config: NetworkProviderConfig | undefined) {

src/networkProviders/proxyNetworkProvider.ts

@@ -15,7 +15,7 @@ import { DefinitionOfFungibleTokenOnNetwork, DefinitionOfTokenCollectionOnNetwor
 import { FungibleTokenOfAccountOnNetwork, NonFungibleTokenOfAccountOnNetwork } from "./tokens";
 import { TransactionOnNetwork, prepareTransactionForBroadcasting } from "./transactions";
 import { TransactionStatus } from "./transactionStatus";
-import { extendUserAgent } from "./userAgent";
+import { extendUserAgentIfBackend } from "./userAgent";
 
 // TODO: Find & remove duplicate code between "ProxyNetworkProvider" and "ApiNetworkProvider".
 export class ProxyNetworkProvider implements INetworkProvider {
@@ -28,7 +28,7 @@ export class ProxyNetworkProvider implements INetworkProvider {
         this.url = url;
         this.config = { ...defaultAxiosConfig, ...config };
         this.axios = getAxios();
-        extendUserAgent(this.userAgentPrefix, this.config);
+        extendUserAgentIfBackend(this.userAgentPrefix, this.config);
     }
 
     async getNetworkConfig(): Promise<NetworkConfig> {

src/networkProviders/userAgent.ts

@@ -1,19 +1,33 @@
 import { AxiosHeaders } from "axios";
-import { NetworkProviderConfig } from "./networkProviderConfig";
 import { UnknownClientName } from "./constants";
+import { NetworkProviderConfig } from "./networkProviderConfig";
+
+export function extendUserAgentIfBackend(userAgentPrefix: string, config: NetworkProviderConfig) {
+    if (isBackend()) {
+        extendUserAgent(userAgentPrefix, config);
+    }
+}
 
-export function extendUserAgent(userAgentPrefix: string, config: NetworkProviderConfig) {
+function extendUserAgent(userAgentPrefix: string, config: NetworkProviderConfig) {
     if (!config.headers) {
-        config.headers = new AxiosHeaders({})
-    };
+        config.headers = new AxiosHeaders({});
+    }
     if (!config.clientName) {
-        console.log("Can you please provide the client name of the application that uses the SDK? It will be used for metrics.")
+        console.log(
+            "We recommend providing the `clientName` when instantiating a NetworkProvider (e.g. ProxyNetworkProvider, ApiNetworkProvider). This information will be used for metrics collection and improving our services.",
+        );
     }
     const headers = AxiosHeaders.from(config.headers as AxiosHeaders).normalize(true);
     const resolvedClientName = config.clientName || UnknownClientName;
 
-    const currentUserAgent = headers.hasUserAgent() ? headers.getUserAgent() : '';
-    const newUserAgent = currentUserAgent ? `${currentUserAgent} ${userAgentPrefix}/${resolvedClientName}` : `${userAgentPrefix}/${resolvedClientName}`;
+    const currentUserAgent = headers.hasUserAgent() ? headers.getUserAgent() : "";
+    const newUserAgent = currentUserAgent
+        ? `${currentUserAgent} ${userAgentPrefix}/${resolvedClientName}`
+        : `${userAgentPrefix}/${resolvedClientName}`;
 
     headers.setUserAgent(newUserAgent, true);
 }
+
+function isBackend(): boolean {
+    return typeof window === "undefined";
+}