Merge #1595

1595: refactor: update clients to have different user agents r=brunoocasali a=Botseer

# Pull Request

## Related issue
Fixes #1437

## What does this PR do?
The users agents for BrowserClient and NodeClient have been differentiated as per the issue for better metrics.

As for the code changes, I have made the change such that the necessary user agents are provided while constructing the respective client itself. Therefore there is no need to handle user agents in the `http-request` file.

## PR checklist
Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!


Co-authored-by: Botseer <[email protected]>

src/clients/browser-client.ts

@@ -1,9 +1,16 @@
 import { Config } from '../types'
 import { Client } from './client'
+import { PACKAGE_VERSION } from '../package-version'
 
 class MeiliSearch extends Client {
  constructor(config: Config) {
- super(config)
+ super({
+ ...config,
+ clientAgents: [
+ ...(config.clientAgents ?? []),
+ `Meilisearch JavaScript (v${PACKAGE_VERSION})`,
+ ],
+ })
  }
 }
 

src/clients/node-client.ts

@@ -1,12 +1,19 @@
 import { Client } from './client'
 import { Config, TokenSearchRules, TokenOptions } from '../types'
 import { Token } from '../token'
+import { PACKAGE_VERSION } from '../package-version'
 
 class MeiliSearch extends Client {
  tokens: Token
 
  constructor(config: Config) {
- super(config)
+ super({
+ ...config,
+ clientAgents: [
+ ...(config.clientAgents ?? []),
+ `Meilisearch Node (v${PACKAGE_VERSION})`,
+ ],
+ })
  this.tokens = new Token(config)
  }
 

src/http-requests.ts

@@ -1,5 +1,4 @@
 import { Config, EnqueuedTaskObject } from './types'
-import { PACKAGE_VERSION } from './package-version'
 
 import {
  MeiliSearchError,
@@ -55,7 +54,6 @@ function cloneAndParseHeaders(headers: HeadersInit): Record<string, string> {
 
 function createHeaders(config: Config): Record<string, any> {
  const agentHeader = 'X-Meilisearch-Client'
- const packageAgent = `Meilisearch JavaScript (v${PACKAGE_VERSION})`
  const contentType = 'Content-Type'
  const authorization = 'Authorization'
  const headers = cloneAndParseHeaders(config.requestConfig?.headers ?? {})
@@ -71,16 +69,12 @@ function createHeaders(config: Config): Record<string, any> {
 
  // Creates the custom user agent with information on the package used.
  if (config.clientAgents && Array.isArray(config.clientAgents)) {
- const clients = config.clientAgents.concat(packageAgent)
-
- headers[agentHeader] = clients.join(' ; ')
+ headers[agentHeader] = config.clientAgents.join(' ; ')
  } else if (config.clientAgents && !Array.isArray(config.clientAgents)) {
  // If the header is defined but not an array
  throw new MeiliSearchError(
  `Meilisearch: The header "${agentHeader}" should be an array of string(s).\n`
  )
- } else {
- headers[agentHeader] = packageAgent
  }
 
  return headers