-
Notifications
You must be signed in to change notification settings - Fork 6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Tool 233 extend user agent on js network providers #67
Changes from 5 commits
9a91315
b014180
691a1a9
e6a6609
8089c7e
fc2503a
9f9e675
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,3 +3,5 @@ import { Address } from "./primitives"; | |
|
||
export const MaxUint64AsBigNumber = new BigNumber("18446744073709551615"); | ||
export const EsdtContractAddress = new Address("erd1qqqqqqqqqqqqqqqpqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqzllls8a5w6u"); | ||
export const MetricsPrefix = "multiversx-sdk" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
export const UnknownClientName = "unknown" |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
import { AxiosRequestConfig } from 'axios'; | ||
|
||
export interface NetworkProviderConfig extends AxiosRequestConfig { | ||
clientName?: string; | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
import { assert } from "chai"; | ||
import { assert, expect } from "chai"; | ||
import { ApiNetworkProvider } from "./apiNetworkProvider"; | ||
import { INetworkProvider, ITransactionNext } from "./interface"; | ||
import { Address } from "./primitives"; | ||
|
@@ -7,15 +7,16 @@ import { MockQuery } from "./testscommon/dummyQuery"; | |
import { NonFungibleTokenOfAccountOnNetwork } from "./tokens"; | ||
import { TransactionEventData } from "./transactionEvents"; | ||
import { TransactionOnNetwork } from "./transactions"; | ||
import { AxiosHeaders } from "axios"; | ||
|
||
describe("test network providers on devnet: Proxy and API", function () { | ||
let alice = new Address("erd1qyu5wthldzr8wx5c9ucg8kjagg0jfs53s8nr3zpz3hypefsdd8ssycr6th"); | ||
let carol = new Address("erd1k2s324ww2g0yj38qn2ch2jwctdy8mnfxep94q9arncc6xecg3xaq6mjse8"); | ||
let dan = new Address("erd1kyaqzaprcdnv4luvanah0gfxzzsnpaygsy6pytrexll2urtd05ts9vegu7"); | ||
const MAX_NUMBER_OF_ITEMS_BY_DEFAULT = 20; | ||
|
||
let apiProvider: INetworkProvider = new ApiNetworkProvider("https://devnet-api.multiversx.com", { timeout: 10000 }); | ||
let proxyProvider: INetworkProvider = new ProxyNetworkProvider("https://devnet-gateway.multiversx.com", { timeout: 10000 }); | ||
let apiProvider: INetworkProvider = new ApiNetworkProvider("https://devnet-api.multiversx.com", { timeout: 10000, clientName: 'test' }); | ||
let proxyProvider: INetworkProvider = new ProxyNetworkProvider("https://devnet-gateway.multiversx.com", { timeout: 10000, clientName: 'test' }); | ||
|
||
it("should have same response for getNetworkConfig()", async function () { | ||
let apiResponse = await apiProvider.getNetworkConfig(); | ||
|
@@ -24,6 +25,39 @@ describe("test network providers on devnet: Proxy and API", function () { | |
assert.deepEqual(apiResponse, proxyResponse); | ||
}); | ||
|
||
it("should add userAgent unknown for clientName when no clientName passed", async function () { | ||
const expectedApiUserAgent = "multiversx-sdk/api/unknown" | ||
const expectedProxyUserAgent = "multiversx-sdk/proxy/unknown" | ||
|
||
let localApiProvider: any = new ApiNetworkProvider("https://devnet-api.multiversx.com", { timeout: 10000 }); | ||
let localProxyProvider: any = new ProxyNetworkProvider("https://devnet-gateway.multiversx.com", { timeout: 10000 }); | ||
|
||
assert.equal(localApiProvider.config.headers.getUserAgent(), expectedApiUserAgent); | ||
assert.equal(localProxyProvider.config.headers.getUserAgent(), expectedProxyUserAgent); | ||
}); | ||
|
||
it("should set userAgent with specified clientName ", async function () { | ||
const expectedApiUserAgent = "multiversx-sdk/api/test" | ||
const expectedProxyUserAgent = "multiversx-sdk/proxy/test" | ||
|
||
let localApiProvider: any = new ApiNetworkProvider("https://devnet-api.multiversx.com", { timeout: 10000, clientName: 'test' }); | ||
let localProxyProvider: any = new ProxyNetworkProvider("https://devnet-gateway.multiversx.com", { timeout: 10000, clientName: 'test' }); | ||
|
||
assert.equal(localApiProvider.config.headers.getUserAgent(), expectedApiUserAgent); | ||
assert.equal(localProxyProvider.config.headers.getUserAgent(), expectedProxyUserAgent); | ||
}); | ||
|
||
it("should keep the set userAgent and add the sdk to it", async function () { | ||
const expectedApiUserAgent = "Client-info multiversx-sdk/api/test" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👍 |
||
const expectedProxyUserAgent = "Client-info multiversx-sdk/proxy/test" | ||
|
||
let localApiProvider: any = new ApiNetworkProvider("https://devnet-api.multiversx.com", { timeout: 10000, headers: new AxiosHeaders({ "User-Agent": "Client-info" }), clientName: 'test' }); | ||
let localProxyProvider: any = new ProxyNetworkProvider("https://devnet-gateway.multiversx.com", { timeout: 10000, headers: new AxiosHeaders({ "User-Agent": "Client-info" }), clientName: 'test' }); | ||
|
||
assert.equal(localApiProvider.config.headers.getUserAgent(), expectedApiUserAgent); | ||
assert.equal(localProxyProvider.config.headers.getUserAgent(), expectedProxyUserAgent); | ||
}); | ||
|
||
it("should have same response for getNetworkStatus()", async function () { | ||
let apiResponse = await apiProvider.getNetworkStatus(); | ||
let proxyResponse = await proxyProvider.getNetworkStatus(); | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
import { AxiosHeaders } from "axios"; | ||
import { NetworkProviderConfig } from "./networkProviderConfig"; | ||
import { UnknownClientName } from "./constants"; | ||
|
||
export function extendUserAgent(userAgentPrefix: string, config: NetworkProviderConfig) { | ||
if (!config.headers) { | ||
config.headers = new AxiosHeaders({}) | ||
}; | ||
if (!config.clientName) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Check can be above There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. done |
||
console.log("Can you please provide the client name of the application that uses the SDK? It will be used for metrics.") | ||
} | ||
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}`; | ||
|
||
headers.setUserAgent(newUserAgent, true); | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about
structuredClone()
, does it help?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
in order to use this I need to upgrade the types/node to a version higher then 17, maybe ww will do that with a major release