From 725996b8e9151fa2f6c507c05690a426d90d5d82 Mon Sep 17 00:00:00 2001 From: Pierre Millot Date: Tue, 13 Dec 2022 14:14:17 +0100 Subject: [PATCH] revert useAlgoliaTracking --- .../__tests__/algoliasearch.test.ts | 1 - .../src/transporter/createTransporter.ts | 7 ++++--- .../client-common/src/types/createClient.ts | 2 +- .../client-common/src/types/transporter.ts | 2 -- .../algoliasearch-client-javascript/yarn.lock | 6 +++--- .../codegen/AlgoliaJavaScriptGenerator.java | 2 +- playground/javascript/node/ingestion.ts | 4 ++-- .../paths/runs/{task => tasks}/taskID.yml | 0 .../javascript/clients/api-single.mustache | 21 +++++++++++++------ 9 files changed, 26 insertions(+), 19 deletions(-) rename specs/ingestion/paths/runs/{task => tasks}/taskID.yml (100%) diff --git a/clients/algoliasearch-client-javascript/packages/algoliasearch/__tests__/algoliasearch.test.ts b/clients/algoliasearch-client-javascript/packages/algoliasearch/__tests__/algoliasearch.test.ts index 573a77ef48..163829b161 100644 --- a/clients/algoliasearch-client-javascript/packages/algoliasearch/__tests__/algoliasearch.test.ts +++ b/clients/algoliasearch-client-javascript/packages/algoliasearch/__tests__/algoliasearch.test.ts @@ -83,7 +83,6 @@ describe('api', () => { `Algolia for JavaScript (${apiClientVersion}); Search (${apiClientVersion});` ), }, - useAlgoliaTracking: true, baseHeaders: { 'content-type': 'text/plain', 'x-algolia-api-key': 'API_KEY', diff --git a/clients/algoliasearch-client-javascript/packages/client-common/src/transporter/createTransporter.ts b/clients/algoliasearch-client-javascript/packages/client-common/src/transporter/createTransporter.ts index e6d1f491f7..621b2d47de 100644 --- a/clients/algoliasearch-client-javascript/packages/client-common/src/transporter/createTransporter.ts +++ b/clients/algoliasearch-client-javascript/packages/client-common/src/transporter/createTransporter.ts @@ -36,7 +36,6 @@ export function createTransporter({ baseHeaders, baseQueryParameters, algoliaAgent, - useAlgoliaTracking, timeouts, requester, requestsCache, @@ -111,12 +110,15 @@ export function createTransporter({ : {}; const queryParameters: QueryParameters = { - ...(useAlgoliaTracking ? { 'x-algolia-agent': algoliaAgent.value } : {}), ...baseQueryParameters, ...request.queryParameters, ...dataQueryParameters, }; + if (algoliaAgent.value) { + queryParameters['x-algolia-agent'] = algoliaAgent.value; + } + if (requestOptions && requestOptions.queryParameters) { for (const key of Object.keys(requestOptions.queryParameters)) { // We want to keep `undefined` and `null` values, @@ -338,7 +340,6 @@ export function createTransporter({ requester, timeouts, algoliaAgent, - useAlgoliaTracking, baseHeaders, baseQueryParameters, hosts, diff --git a/clients/algoliasearch-client-javascript/packages/client-common/src/types/createClient.ts b/clients/algoliasearch-client-javascript/packages/client-common/src/types/createClient.ts index b9c05652f8..29535ac881 100644 --- a/clients/algoliasearch-client-javascript/packages/client-common/src/types/createClient.ts +++ b/clients/algoliasearch-client-javascript/packages/client-common/src/types/createClient.ts @@ -9,7 +9,7 @@ type OverriddenTransporterOptions = export type CreateClientOptions = Omit< TransporterOptions, - OverriddenTransporterOptions | 'algoliaAgent' | 'useAlgoliaTracking' + OverriddenTransporterOptions | 'algoliaAgent' > & Partial> & { appId: string; diff --git a/clients/algoliasearch-client-javascript/packages/client-common/src/types/transporter.ts b/clients/algoliasearch-client-javascript/packages/client-common/src/types/transporter.ts index c5518f5856..3b760d1d99 100644 --- a/clients/algoliasearch-client-javascript/packages/client-common/src/types/transporter.ts +++ b/clients/algoliasearch-client-javascript/packages/client-common/src/types/transporter.ts @@ -139,8 +139,6 @@ export type TransporterOptions = { * The user agent used. Sent on query parameters. */ algoliaAgent: AlgoliaAgent; - - useAlgoliaTracking: boolean; }; export type Transporter = TransporterOptions & { diff --git a/clients/algoliasearch-client-javascript/yarn.lock b/clients/algoliasearch-client-javascript/yarn.lock index c2b75c1ec1..257f0aa820 100644 --- a/clients/algoliasearch-client-javascript/yarn.lock +++ b/clients/algoliasearch-client-javascript/yarn.lock @@ -113,9 +113,9 @@ __metadata: version: 0.0.0-use.local resolution: "@algolia/ingestion@workspace:packages/ingestion" dependencies: - "@algolia/client-common": 5.0.0-alpha.26 - "@algolia/requester-browser-xhr": 5.0.0-alpha.26 - "@algolia/requester-node-http": 5.0.0-alpha.26 + "@algolia/client-common": 5.0.0-alpha.27 + "@algolia/requester-browser-xhr": 5.0.0-alpha.27 + "@algolia/requester-node-http": 5.0.0-alpha.27 "@types/node": 16.11.59 rollup: 2.79.1 typescript: 4.8.3 diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaJavaScriptGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaJavaScriptGenerator.java index 40a8fed5c4..f505e1bb7e 100644 --- a/generators/src/main/java/com/algolia/codegen/AlgoliaJavaScriptGenerator.java +++ b/generators/src/main/java/com/algolia/codegen/AlgoliaJavaScriptGenerator.java @@ -119,7 +119,7 @@ private void setDefaultGeneratorOptions() { additionalProperties.put("algoliaAgent", Utils.capitalize(CLIENT)); additionalProperties.put("gitRepoId", "algoliasearch-client-javascript"); additionalProperties.put("isSearchClient", CLIENT.equals("search")); - additionalProperties.put("useAlgoliaTracking", !CLIENT.equals("ingestion")); + additionalProperties.put("useAlgoliaUA", !CLIENT.equals("ingestion")); additionalProperties.put("isAlgoliasearchClient", isAlgoliasearchClient); if (isAlgoliasearchClient) { diff --git a/playground/javascript/node/ingestion.ts b/playground/javascript/node/ingestion.ts index 989ed15b39..3847a77170 100644 --- a/playground/javascript/node/ingestion.ts +++ b/playground/javascript/node/ingestion.ts @@ -10,11 +10,11 @@ const apiKey = '**** ADMIN_KEY *****'; // Init client with appId and apiKey -const client = ingestionClient(appId, apiKey, 'us', {authMode: 'WithinHeaders'}); +const client = ingestionClient(appId, apiKey, 'us', {authMode: 'WithinHeaders', hosts: [{url: 'staging-data.us.algolia.com', accept: 'readWrite', protocol: 'https'}]}); async function testIngestion() { try { - const res = await client.createAuthentication({input: {appID: appId, apiKey}, name: 'test', type: 'algolia'}); + const res = await client.getAuthentications(); console.log(`[OK]`, res); } catch (e) { diff --git a/specs/ingestion/paths/runs/task/taskID.yml b/specs/ingestion/paths/runs/tasks/taskID.yml similarity index 100% rename from specs/ingestion/paths/runs/task/taskID.yml rename to specs/ingestion/paths/runs/tasks/taskID.yml diff --git a/templates/javascript/clients/api-single.mustache b/templates/javascript/clients/api-single.mustache index d606c79ebb..2baa7ddb98 100644 --- a/templates/javascript/clients/api-single.mustache +++ b/templates/javascript/clients/api-single.mustache @@ -19,12 +19,21 @@ export function create{{capitalizedApiName}}({ const transporter = createTransporter({ hosts: getDefaultHosts({{^hasRegionalHost}}appIdOption{{/hasRegionalHost}}{{#hasRegionalHost}}regionOption{{/hasRegionalHost}}), ...options, - useAlgoliaTracking: {{{useAlgoliaTracking}}}, - algoliaAgent: getAlgoliaAgent({ - algoliaAgents, - client: '{{{algoliaAgent}}}', - version: apiClientVersion, - }), + algoliaAgent: + {{^useAlgoliaUA}} + {...getAlgoliaAgent({ + algoliaAgents, + client: '{{{algoliaAgent}}}', + version: apiClientVersion, + }), value: ''}, + {{/useAlgoliaUA}} + {{#useAlgoliaUA}} + getAlgoliaAgent({ + algoliaAgents, + client: '{{{algoliaAgent}}}', + version: apiClientVersion, + }), + {{/useAlgoliaUA}} baseHeaders: { 'content-type': 'text/plain', ...auth.headers(),