Tool 233 extend user agent on js network providers

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@multiversx/sdk-network-providers",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "lockfileVersion": 2,
   "requires": true,
   "author": "MultiversX",

src/NetworkProviderConfig.ts

@@ -0,0 +1,5 @@
+import { AxiosRequestConfig } from 'axios';
+
+export interface ExtendedAxiosRequestConfig extends AxiosRequestConfig {
+    clientName?: string;
+}

src/apiNetworkProvider.ts

@@ -1,4 +1,4 @@
-import axios, { AxiosRequestConfig } from "axios";
+import axios from "axios";
 import { AccountOnNetwork, GuardianData } from "./accounts";
 import { defaultAxiosConfig, defaultPagination } from "./config";
 import { ContractQueryRequest } from "./contractQueryRequest";
@@ -16,17 +16,21 @@ import { DefinitionOfFungibleTokenOnNetwork, DefinitionOfTokenCollectionOnNetwor
 import { FungibleTokenOfAccountOnNetwork, NonFungibleTokenOfAccountOnNetwork } from "./tokens";
 import { TransactionOnNetwork, prepareTransactionForBroadcasting } from "./transactions";
 import { TransactionStatus } from "./transactionStatus";
+import { setUserAgent } from "./userAgent";
+import { ExtendedAxiosRequestConfig } from "./NetworkProviderConfig";
 
 // TODO: Find & remove duplicate code between "ProxyNetworkProvider" and "ApiNetworkProvider".
 export class ApiNetworkProvider implements INetworkProvider {
     private url: string;
-    private config: AxiosRequestConfig;
+    private config: ExtendedAxiosRequestConfig;
     private backingProxyNetworkProvider;
+    private userAgentPrefix = 'sdk-network-providers/api'
 
-    constructor(url: string, config?: AxiosRequestConfig) {
+    constructor(url: string, config?: ExtendedAxiosRequestConfig) {
         this.url = url;
         this.config = { ...defaultAxiosConfig, ...config };
         this.backingProxyNetworkProvider = new ProxyNetworkProvider(url, config);
+        setUserAgent(this.userAgentPrefix, this.config);
     }
 
     async getNetworkConfig(): Promise<NetworkConfig> {

src/proxyNetworkProvider.ts

@@ -1,4 +1,4 @@
-import axios, { AxiosRequestConfig } from "axios";
+import axios from "axios";
 import { AccountOnNetwork, GuardianData } from "./accounts";
 import { defaultAxiosConfig } from "./config";
 import { EsdtContractAddress } from "./constants";
@@ -14,15 +14,19 @@ import { DefinitionOfFungibleTokenOnNetwork, DefinitionOfTokenCollectionOnNetwor
 import { FungibleTokenOfAccountOnNetwork, NonFungibleTokenOfAccountOnNetwork } from "./tokens";
 import { TransactionOnNetwork, prepareTransactionForBroadcasting } from "./transactions";
 import { TransactionStatus } from "./transactionStatus";
+import { setUserAgent } from "./userAgent";
+import { ExtendedAxiosRequestConfig } from "./NetworkProviderConfig";
 
 // TODO: Find & remove duplicate code between "ProxyNetworkProvider" and "ApiNetworkProvider".
 export class ProxyNetworkProvider implements INetworkProvider {
     private url: string;
-    private config: AxiosRequestConfig;
+    private config: ExtendedAxiosRequestConfig;
+    private userAgentPrefix = 'sdk-network-providers/proxy'
 
-    constructor(url: string, config?: AxiosRequestConfig) {
+    constructor(url: string, config?: ExtendedAxiosRequestConfig) {
         this.url = url;
         this.config = { ...defaultAxiosConfig, ...config };
+        setUserAgent(this.userAgentPrefix, this.config);
     }
 
     async getNetworkConfig(): Promise<NetworkConfig> {

src/userAgent.ts

@@ -0,0 +1,22 @@
+import { AxiosHeaders } from "axios";
+import { ExtendedAxiosRequestConfig } from "./NetworkProviderConfig";
+
+export function setUserAgent(userAgentPrefix: string, config: ExtendedAxiosRequestConfig | undefined) {
+    if (!config) {
+        config = { headers: new AxiosHeaders({}) }
+    }
+    if (!config.headers) {
+        config.headers = new AxiosHeaders({})
+    };
+
+    const headers = AxiosHeaders.from(config.headers as AxiosHeaders).normalize(true);
+    if (!config.clientName) {
+        console.log("Can you please provide the client name of the aplication that uses the sdk?")
+    }
+    const resolvedClientName = config.clientName || 'unknown';
+
+    const currentUserAgent = headers.hasUserAgent() ? headers.getUserAgent() : '';
+    const newUserAgent = `${currentUserAgent} ${userAgentPrefix}${resolvedClientName}`.trim();
+
+    headers.setUserAgent(newUserAgent, true);
+}