From 2cce63a429a43569e31d75cc2f97b691d7f41157 Mon Sep 17 00:00:00 2001 From: Pierre Millot Date: Thu, 25 Nov 2021 18:13:20 +0100 Subject: [PATCH 1/6] fix: add host as options --- .../.gitignore | 4 +- .../client-search/apis.ts | 2 +- .../client-search/searchApi.ts | 42 ++++++---- .../utils/EchoRequester.ts | 6 +- .../utils/HttpRequester.ts | 2 +- .../utils/Requester.ts | 4 +- .../utils/Transporter.ts | 19 +++-- .../utils/{ => cache}/Cache.ts | 0 .../utils/{ => cache}/MemoryCache.ts | 0 .../utils/requester/EchoRequester.ts | 12 +++ .../utils/requester/HttpRequester.ts | 84 +++++++++++++++++++ .../utils/requester/Requester.ts | 4 + clients/utils/javascript/EchoRequester.ts | 6 +- clients/utils/javascript/HttpRequester.ts | 2 +- clients/utils/javascript/Requester.ts | 4 +- clients/utils/javascript/Transporter.ts | 19 +++-- clients/utils/javascript/{ => cache}/Cache.ts | 0 .../javascript/{ => cache}/MemoryCache.ts | 0 playground/javascript/app.ts | 4 +- templates/javascript/api-all.mustache | 2 +- templates/javascript/api-single.mustache | 46 +++++----- templates/javascript/gitignore | 6 -- 22 files changed, 199 insertions(+), 69 deletions(-) rename clients/algoliasearch-client-javascript/utils/{ => cache}/Cache.ts (100%) rename clients/algoliasearch-client-javascript/utils/{ => cache}/MemoryCache.ts (100%) create mode 100644 clients/algoliasearch-client-javascript/utils/requester/EchoRequester.ts create mode 100644 clients/algoliasearch-client-javascript/utils/requester/HttpRequester.ts create mode 100644 clients/algoliasearch-client-javascript/utils/requester/Requester.ts rename clients/utils/javascript/{ => cache}/Cache.ts (100%) rename clients/utils/javascript/{ => cache}/MemoryCache.ts (100%) delete mode 100644 templates/javascript/gitignore diff --git a/clients/algoliasearch-client-javascript/.gitignore b/clients/algoliasearch-client-javascript/.gitignore index b3a5f6266da..149b5765472 100644 --- a/clients/algoliasearch-client-javascript/.gitignore +++ b/clients/algoliasearch-client-javascript/.gitignore @@ -1,6 +1,4 @@ +wwwroot/*.js node_modules typings dist -build -.env -.vscode \ No newline at end of file diff --git a/clients/algoliasearch-client-javascript/client-search/apis.ts b/clients/algoliasearch-client-javascript/client-search/apis.ts index c69231a7b79..7ce8b4109ed 100644 --- a/clients/algoliasearch-client-javascript/client-search/apis.ts +++ b/clients/algoliasearch-client-javascript/client-search/apis.ts @@ -4,6 +4,6 @@ import { SearchApi } from './searchApi'; export class searchClient extends SearchApi {} export * from '../utils/errors'; -export { EchoRequester } from '../utils/EchoRequester'; +export { EchoRequester } from '../utils/requester/EchoRequester'; export const APIS = [SearchApi]; diff --git a/clients/algoliasearch-client-javascript/client-search/searchApi.ts b/clients/algoliasearch-client-javascript/client-search/searchApi.ts index b643e903b30..d3ed1a77304 100644 --- a/clients/algoliasearch-client-javascript/client-search/searchApi.ts +++ b/clients/algoliasearch-client-javascript/client-search/searchApi.ts @@ -1,7 +1,7 @@ import { shuffle } from '../utils/helpers'; import { Transporter } from '../utils/Transporter'; import { Headers, Host, Request, RequestOptions } from '../utils/types'; -import { Requester } from '../utils/Requester'; +import { Requester } from '../utils/requester/Requester'; import { BatchObject } from '../model/batchObject'; import { BatchResponse } from '../model/batchResponse'; @@ -27,22 +27,11 @@ export class SearchApi { appId: new ApiKeyAuth('header', 'X-Algolia-Application-Id'), }; - constructor(appId: string, apiKey: string, requester?: Requester) { + constructor(appId: string, apiKey: string, options?: { requester?: Requester; hosts?: Host[] }) { this.setApiKey(SearchApiApiKeys.appId, appId); this.setApiKey(SearchApiApiKeys.apiKey, apiKey); this.transporter = new Transporter({ - hosts: ( - [ - { url: `${appId}-dsn.algolia.net`, accept: 'read', protocol: 'https' }, - { url: `${appId}.algolia.net`, accept: 'write', protocol: 'https' }, - ] as Host[] - ).concat( - shuffle([ - { url: `${appId}-1.algolianet.com`, accept: 'readWrite', protocol: 'https' }, - { url: `${appId}-2.algolianet.com`, accept: 'readWrite', protocol: 'https' }, - { url: `${appId}-3.algolianet.com`, accept: 'readWrite', protocol: 'https' }, - ]) - ), + hosts: options?.hosts ?? this.getDefaultHosts(appId, apiKey), baseHeaders: { 'content-type': 'application/x-www-form-urlencoded', }, @@ -52,10 +41,33 @@ export class SearchApi { read: 5, write: 30, }, - requester, + requester: options?.requester, }); } + public getDefaultHosts(appId: string, apiKey: string): Host[] { + return ( + [ + { url: `${appId}-dsn.algolia.net`, accept: 'read', protocol: 'https' }, + { url: `${appId}.algolia.net`, accept: 'write', protocol: 'https' }, + ] as Host[] + ).concat( + shuffle([ + { url: `${appId}-1.algolianet.com`, accept: 'readWrite', protocol: 'https' }, + { url: `${appId}-2.algolianet.com`, accept: 'readWrite', protocol: 'https' }, + { url: `${appId}-3.algolianet.com`, accept: 'readWrite', protocol: 'https' }, + ]) + ); + } + + public setRequest(requester: Requester): void { + this.transporter.setRequester(requester); + } + + public setHosts(hosts: Host[]): void { + this.transporter.setHosts(hosts); + } + public setApiKey(key: SearchApiApiKeys, value: string) { this.authentications[SearchApiApiKeys[key]].apiKey = value; } diff --git a/clients/algoliasearch-client-javascript/utils/EchoRequester.ts b/clients/algoliasearch-client-javascript/utils/EchoRequester.ts index 12c6cd1b25f..5f7a9c715a6 100644 --- a/clients/algoliasearch-client-javascript/utils/EchoRequester.ts +++ b/clients/algoliasearch-client-javascript/utils/EchoRequester.ts @@ -1,10 +1,10 @@ -import { EndRequest, Response } from './types'; +import { EndRequest, Request, Response } from '../types'; import { Requester } from './Requester'; export class EchoRequester extends Requester { - async send(request: EndRequest): Promise { + async send(request: EndRequest, originalRequest: Request): Promise { return { - content: JSON.stringify(request), + content: JSON.stringify(originalRequest), isTimedOut: false, status: 200, }; diff --git a/clients/algoliasearch-client-javascript/utils/HttpRequester.ts b/clients/algoliasearch-client-javascript/utils/HttpRequester.ts index 7105360a440..c99ae708423 100644 --- a/clients/algoliasearch-client-javascript/utils/HttpRequester.ts +++ b/clients/algoliasearch-client-javascript/utils/HttpRequester.ts @@ -1,4 +1,4 @@ -import { EndRequest, Response } from './types'; +import { EndRequest, Response } from '../types'; import * as http from 'http'; import * as https from 'https'; import { Requester } from './Requester'; diff --git a/clients/algoliasearch-client-javascript/utils/Requester.ts b/clients/algoliasearch-client-javascript/utils/Requester.ts index 6735a27a347..c26e08205dc 100644 --- a/clients/algoliasearch-client-javascript/utils/Requester.ts +++ b/clients/algoliasearch-client-javascript/utils/Requester.ts @@ -1,4 +1,4 @@ -import { EndRequest, Response } from './types'; +import { EndRequest, Request, Response } from '../types'; export abstract class Requester { - abstract send(request: EndRequest): Promise; + abstract send(request: EndRequest, originalRequest: Request): Promise; } diff --git a/clients/algoliasearch-client-javascript/utils/Transporter.ts b/clients/algoliasearch-client-javascript/utils/Transporter.ts index 4248c636a35..f7fccad3ff5 100644 --- a/clients/algoliasearch-client-javascript/utils/Transporter.ts +++ b/clients/algoliasearch-client-javascript/utils/Transporter.ts @@ -7,8 +7,8 @@ import type { Response, EndRequest, } from './types'; -import { MemoryCache } from './MemoryCache'; -import type { Cache } from './Cache'; +import { MemoryCache } from './cache/MemoryCache'; +import type { Cache } from './cache/Cache'; import { StatefulHost } from './StatefulHost'; import { deserializeFailure, @@ -20,8 +20,8 @@ import { import { Headers } from './types'; import { RetryError } from './errors'; import * as responseUtils from './Response'; -import { Requester } from './Requester'; -import { HttpRequester } from './HttpRequester'; +import { Requester } from './requester/Requester'; +import { HttpRequester } from './requester/HttpRequester'; export class Transporter { private hosts: Host[]; @@ -52,6 +52,15 @@ export class Transporter { this.requester = requester; } + public setHosts(hosts: Host[]): void { + this.hosts = hosts; + this.hostsCache.clear(); + } + + public setRequester(requester: Requester): void { + this.requester = requester; + } + async createRetryableOptions(compatibleHosts: Host[]): Promise<{ hosts: Host[]; getTimeout: (retryCount: number, timeout: number) => number; @@ -169,7 +178,7 @@ export class Transporter { return stackFrame; }; - const response = await this.requester.send(payload); + const response = await this.requester.send(payload, request); if (responseUtils.isRetryable(response)) { pushToStackTrace(response); diff --git a/clients/algoliasearch-client-javascript/utils/Cache.ts b/clients/algoliasearch-client-javascript/utils/cache/Cache.ts similarity index 100% rename from clients/algoliasearch-client-javascript/utils/Cache.ts rename to clients/algoliasearch-client-javascript/utils/cache/Cache.ts diff --git a/clients/algoliasearch-client-javascript/utils/MemoryCache.ts b/clients/algoliasearch-client-javascript/utils/cache/MemoryCache.ts similarity index 100% rename from clients/algoliasearch-client-javascript/utils/MemoryCache.ts rename to clients/algoliasearch-client-javascript/utils/cache/MemoryCache.ts diff --git a/clients/algoliasearch-client-javascript/utils/requester/EchoRequester.ts b/clients/algoliasearch-client-javascript/utils/requester/EchoRequester.ts new file mode 100644 index 00000000000..5f7a9c715a6 --- /dev/null +++ b/clients/algoliasearch-client-javascript/utils/requester/EchoRequester.ts @@ -0,0 +1,12 @@ +import { EndRequest, Request, Response } from '../types'; +import { Requester } from './Requester'; + +export class EchoRequester extends Requester { + async send(request: EndRequest, originalRequest: Request): Promise { + return { + content: JSON.stringify(originalRequest), + isTimedOut: false, + status: 200, + }; + } +} diff --git a/clients/algoliasearch-client-javascript/utils/requester/HttpRequester.ts b/clients/algoliasearch-client-javascript/utils/requester/HttpRequester.ts new file mode 100644 index 00000000000..c99ae708423 --- /dev/null +++ b/clients/algoliasearch-client-javascript/utils/requester/HttpRequester.ts @@ -0,0 +1,84 @@ +import { EndRequest, Response } from '../types'; +import * as http from 'http'; +import * as https from 'https'; +import { Requester } from './Requester'; + +export class HttpRequester extends Requester { + private httpAgent: http.Agent; + private httpsAgent: https.Agent; + + constructor() { + super(); + this.httpAgent = new http.Agent({ keepAlive: true }); + this.httpsAgent = new https.Agent({ keepAlive: true }); + } + + async send(request: EndRequest): Promise { + return new Promise((resolve) => { + const url = new URL(request.url); + + const path = url.search === null ? url.pathname : `${url.pathname}?${url.search}`; + + const options: https.RequestOptions = { + agent: url.protocol === 'https:' ? this.httpsAgent : this.httpAgent, + hostname: url.hostname, + path, + method: request.method, + headers: request.headers, + ...(url.port !== undefined ? { port: url.port || '' } : {}), + }; + + const req = (url.protocol === 'https:' ? https : http).request(options, (response) => { + let contentBuffers: Buffer[] = []; + + response.on('data', (chunk) => { + contentBuffers = contentBuffers.concat(chunk); + }); + + response.on('end', () => { + clearTimeout(connectTimeout); + clearTimeout(responseTimeout as NodeJS.Timeout); + + resolve({ + status: response.statusCode || 0, + content: Buffer.concat(contentBuffers).toString(), + isTimedOut: false, + }); + }); + }); + + const createTimeout = (timeout: number, content: string): NodeJS.Timeout => { + return setTimeout(() => { + req.destroy(); + + resolve({ + status: 0, + content, + isTimedOut: true, + }); + }, timeout * 1000); + }; + + const connectTimeout = createTimeout(request.connectTimeout, 'Connection timeout'); + + let responseTimeout: NodeJS.Timeout | undefined; + + req.on('error', (error) => { + clearTimeout(connectTimeout); + clearTimeout(responseTimeout!); + resolve({ status: 0, content: error.message, isTimedOut: false }); + }); + + req.once('response', () => { + clearTimeout(connectTimeout); + responseTimeout = createTimeout(request.responseTimeout, 'Socket timeout'); + }); + + if (request.data !== undefined) { + req.write(request.data); + } + + req.end(); + }); + } +} diff --git a/clients/algoliasearch-client-javascript/utils/requester/Requester.ts b/clients/algoliasearch-client-javascript/utils/requester/Requester.ts new file mode 100644 index 00000000000..c26e08205dc --- /dev/null +++ b/clients/algoliasearch-client-javascript/utils/requester/Requester.ts @@ -0,0 +1,4 @@ +import { EndRequest, Request, Response } from '../types'; +export abstract class Requester { + abstract send(request: EndRequest, originalRequest: Request): Promise; +} diff --git a/clients/utils/javascript/EchoRequester.ts b/clients/utils/javascript/EchoRequester.ts index 12c6cd1b25f..5f7a9c715a6 100644 --- a/clients/utils/javascript/EchoRequester.ts +++ b/clients/utils/javascript/EchoRequester.ts @@ -1,10 +1,10 @@ -import { EndRequest, Response } from './types'; +import { EndRequest, Request, Response } from '../types'; import { Requester } from './Requester'; export class EchoRequester extends Requester { - async send(request: EndRequest): Promise { + async send(request: EndRequest, originalRequest: Request): Promise { return { - content: JSON.stringify(request), + content: JSON.stringify(originalRequest), isTimedOut: false, status: 200, }; diff --git a/clients/utils/javascript/HttpRequester.ts b/clients/utils/javascript/HttpRequester.ts index 7105360a440..c99ae708423 100644 --- a/clients/utils/javascript/HttpRequester.ts +++ b/clients/utils/javascript/HttpRequester.ts @@ -1,4 +1,4 @@ -import { EndRequest, Response } from './types'; +import { EndRequest, Response } from '../types'; import * as http from 'http'; import * as https from 'https'; import { Requester } from './Requester'; diff --git a/clients/utils/javascript/Requester.ts b/clients/utils/javascript/Requester.ts index 6735a27a347..c26e08205dc 100644 --- a/clients/utils/javascript/Requester.ts +++ b/clients/utils/javascript/Requester.ts @@ -1,4 +1,4 @@ -import { EndRequest, Response } from './types'; +import { EndRequest, Request, Response } from '../types'; export abstract class Requester { - abstract send(request: EndRequest): Promise; + abstract send(request: EndRequest, originalRequest: Request): Promise; } diff --git a/clients/utils/javascript/Transporter.ts b/clients/utils/javascript/Transporter.ts index 4248c636a35..f7fccad3ff5 100644 --- a/clients/utils/javascript/Transporter.ts +++ b/clients/utils/javascript/Transporter.ts @@ -7,8 +7,8 @@ import type { Response, EndRequest, } from './types'; -import { MemoryCache } from './MemoryCache'; -import type { Cache } from './Cache'; +import { MemoryCache } from './cache/MemoryCache'; +import type { Cache } from './cache/Cache'; import { StatefulHost } from './StatefulHost'; import { deserializeFailure, @@ -20,8 +20,8 @@ import { import { Headers } from './types'; import { RetryError } from './errors'; import * as responseUtils from './Response'; -import { Requester } from './Requester'; -import { HttpRequester } from './HttpRequester'; +import { Requester } from './requester/Requester'; +import { HttpRequester } from './requester/HttpRequester'; export class Transporter { private hosts: Host[]; @@ -52,6 +52,15 @@ export class Transporter { this.requester = requester; } + public setHosts(hosts: Host[]): void { + this.hosts = hosts; + this.hostsCache.clear(); + } + + public setRequester(requester: Requester): void { + this.requester = requester; + } + async createRetryableOptions(compatibleHosts: Host[]): Promise<{ hosts: Host[]; getTimeout: (retryCount: number, timeout: number) => number; @@ -169,7 +178,7 @@ export class Transporter { return stackFrame; }; - const response = await this.requester.send(payload); + const response = await this.requester.send(payload, request); if (responseUtils.isRetryable(response)) { pushToStackTrace(response); diff --git a/clients/utils/javascript/Cache.ts b/clients/utils/javascript/cache/Cache.ts similarity index 100% rename from clients/utils/javascript/Cache.ts rename to clients/utils/javascript/cache/Cache.ts diff --git a/clients/utils/javascript/MemoryCache.ts b/clients/utils/javascript/cache/MemoryCache.ts similarity index 100% rename from clients/utils/javascript/MemoryCache.ts rename to clients/utils/javascript/cache/MemoryCache.ts diff --git a/playground/javascript/app.ts b/playground/javascript/app.ts index fcc2d59d8c0..8de2982b5a8 100644 --- a/playground/javascript/app.ts +++ b/playground/javascript/app.ts @@ -1,4 +1,4 @@ -import { searchClient, ApiError } from 'algoliasearch-client-javascript'; +import { searchClient, ApiError, EchoRequester } from 'algoliasearch-client-javascript'; import dotenv from 'dotenv'; dotenv.config({ path: '../.env' }); @@ -10,7 +10,7 @@ const searchIndex = process.env.SEARCH_INDEX || 'test_index'; const searchQuery = process.env.SEARCH_QUERY || 'test_query'; // Init client with appId and apiKey -const client = new searchClient(appId, apiKey); +const client = new searchClient(appId, apiKey, { requester: new EchoRequester() }); async function testMultiQueries() { try { diff --git a/templates/javascript/api-all.mustache b/templates/javascript/api-all.mustache index 17bcd356c68..4da3802a3ee 100644 --- a/templates/javascript/api-all.mustache +++ b/templates/javascript/api-all.mustache @@ -12,7 +12,7 @@ export * from './{{ classFilename }}Interface' export class searchClient extends SearchApi{} export * from '../utils/errors'; -export { EchoRequester } from '../utils/EchoRequester'; +export { EchoRequester } from '../utils/requester/EchoRequester'; export const APIS = [{{#apis}}{{#operations}}{{ classname }}{{/operations}}{{^-last}}, {{/-last}}{{/apis}}]; {{/apiInfo}} diff --git a/templates/javascript/api-single.mustache b/templates/javascript/api-single.mustache index 9ebb11b699a..e8fbb16b700 100644 --- a/templates/javascript/api-single.mustache +++ b/templates/javascript/api-single.mustache @@ -1,7 +1,7 @@ import { shuffle } from '../utils/helpers'; import { Transporter } from '../utils/Transporter'; import { Headers, Host, Request, RequestOptions } from '../utils/types'; -import { Requester } from '../utils/Requester'; +import { Requester } from '../utils/requester/Requester'; {{#imports}} import { {{classname}} } from '{{filename}}'; @@ -37,22 +37,11 @@ export class {{classname}} { {{/hasAuthMethods}} } - constructor(appId: string, apiKey: string, requester?: Requester) { + constructor(appId: string, apiKey: string, options?: {requester?: Requester, hosts?: Host[]}) { this.setApiKey(SearchApiApiKeys.appId, appId); this.setApiKey(SearchApiApiKeys.apiKey, apiKey); this.transporter = new Transporter({ - hosts: ( - [ - { url: `${appId}-dsn.algolia.net`, accept: 'read', protocol: 'https' }, - { url: `${appId}.algolia.net`, accept: 'write', protocol: 'https' }, - ] as Host[] - ).concat( - shuffle([ - { url: `${appId}-1.algolianet.com`, accept: 'readWrite', protocol: 'https' }, - { url: `${appId}-2.algolianet.com`, accept: 'readWrite', protocol: 'https' }, - { url: `${appId}-3.algolianet.com`, accept: 'readWrite', protocol: 'https' }, - ]) - ), + hosts: options?.hosts ?? this.getDefaultHosts(appId, apiKey), baseHeaders: { 'content-type': 'application/x-www-form-urlencoded' }, @@ -62,17 +51,36 @@ export class {{classname}} { read: 5, write: 30, }, - requester, + requester: options?.requester, }); } + public getDefaultHosts(appId: string, apiKey: string): Host[] { + return ( + [ + { url: `${appId}-dsn.algolia.net`, accept: 'read', protocol: 'https' }, + { url: `${appId}.algolia.net`, accept: 'write', protocol: 'https' }, + ] as Host[] + ).concat( + shuffle([ + { url: `${appId}-1.algolianet.com`, accept: 'readWrite', protocol: 'https' }, + { url: `${appId}-2.algolianet.com`, accept: 'readWrite', protocol: 'https' }, + { url: `${appId}-3.algolianet.com`, accept: 'readWrite', protocol: 'https' }, + ]) + ); + } + + public setRequest(requester: Requester): void { + this.transporter.setRequester(requester); + } + + public setHosts(hosts: Host[]): void { + this.transporter.setHosts(hosts); + } + public setApiKey(key: {{classname}}ApiKeys, value: string) { this.authentications[{{classname}}ApiKeys[key]].apiKey = value; } - {{#hasAuthMethods}} - {{#authMethods}} - {{/authMethods}} - {{/hasAuthMethods}} private async sendRequest(request: Request, requestOptions: RequestOptions): Promise { {{#authMethods}} diff --git a/templates/javascript/gitignore b/templates/javascript/gitignore deleted file mode 100644 index b3a5f6266da..00000000000 --- a/templates/javascript/gitignore +++ /dev/null @@ -1,6 +0,0 @@ -node_modules -typings -dist -build -.env -.vscode \ No newline at end of file From 5131c000980eefce8cf03c7aea46ab658be154ce Mon Sep 17 00:00:00 2001 From: Pierre Millot Date: Thu, 25 Nov 2021 18:14:54 +0100 Subject: [PATCH 2/6] create requester folder --- clients/utils/javascript/{ => requester}/EchoRequester.ts | 0 clients/utils/javascript/{ => requester}/HttpRequester.ts | 0 clients/utils/javascript/{ => requester}/Requester.ts | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename clients/utils/javascript/{ => requester}/EchoRequester.ts (100%) rename clients/utils/javascript/{ => requester}/HttpRequester.ts (100%) rename clients/utils/javascript/{ => requester}/Requester.ts (100%) diff --git a/clients/utils/javascript/EchoRequester.ts b/clients/utils/javascript/requester/EchoRequester.ts similarity index 100% rename from clients/utils/javascript/EchoRequester.ts rename to clients/utils/javascript/requester/EchoRequester.ts diff --git a/clients/utils/javascript/HttpRequester.ts b/clients/utils/javascript/requester/HttpRequester.ts similarity index 100% rename from clients/utils/javascript/HttpRequester.ts rename to clients/utils/javascript/requester/HttpRequester.ts diff --git a/clients/utils/javascript/Requester.ts b/clients/utils/javascript/requester/Requester.ts similarity index 100% rename from clients/utils/javascript/Requester.ts rename to clients/utils/javascript/requester/Requester.ts From 9da8e43169cf4b8398afc6df162dc40de0a65d00 Mon Sep 17 00:00:00 2001 From: Pierre Millot Date: Thu, 25 Nov 2021 18:33:12 +0100 Subject: [PATCH 3/6] add back .gitignore --- templates/javascript/.gitignore | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 templates/javascript/.gitignore diff --git a/templates/javascript/.gitignore b/templates/javascript/.gitignore new file mode 100644 index 00000000000..c5c6046b52d --- /dev/null +++ b/templates/javascript/.gitignore @@ -0,0 +1,6 @@ +node_versions +typings +dist +build +.env +.vscode From b945f7f93939225a2d330ba83f5f260b348f0237 Mon Sep 17 00:00:00 2001 From: Pierre Millot Date: Thu, 25 Nov 2021 18:35:05 +0100 Subject: [PATCH 4/6] clean --- .../utils/EchoRequester.ts | 12 --- .../utils/HttpRequester.ts | 84 ------------------- .../utils/Requester.ts | 4 - 3 files changed, 100 deletions(-) delete mode 100644 clients/algoliasearch-client-javascript/utils/EchoRequester.ts delete mode 100644 clients/algoliasearch-client-javascript/utils/HttpRequester.ts delete mode 100644 clients/algoliasearch-client-javascript/utils/Requester.ts diff --git a/clients/algoliasearch-client-javascript/utils/EchoRequester.ts b/clients/algoliasearch-client-javascript/utils/EchoRequester.ts deleted file mode 100644 index 5f7a9c715a6..00000000000 --- a/clients/algoliasearch-client-javascript/utils/EchoRequester.ts +++ /dev/null @@ -1,12 +0,0 @@ -import { EndRequest, Request, Response } from '../types'; -import { Requester } from './Requester'; - -export class EchoRequester extends Requester { - async send(request: EndRequest, originalRequest: Request): Promise { - return { - content: JSON.stringify(originalRequest), - isTimedOut: false, - status: 200, - }; - } -} diff --git a/clients/algoliasearch-client-javascript/utils/HttpRequester.ts b/clients/algoliasearch-client-javascript/utils/HttpRequester.ts deleted file mode 100644 index c99ae708423..00000000000 --- a/clients/algoliasearch-client-javascript/utils/HttpRequester.ts +++ /dev/null @@ -1,84 +0,0 @@ -import { EndRequest, Response } from '../types'; -import * as http from 'http'; -import * as https from 'https'; -import { Requester } from './Requester'; - -export class HttpRequester extends Requester { - private httpAgent: http.Agent; - private httpsAgent: https.Agent; - - constructor() { - super(); - this.httpAgent = new http.Agent({ keepAlive: true }); - this.httpsAgent = new https.Agent({ keepAlive: true }); - } - - async send(request: EndRequest): Promise { - return new Promise((resolve) => { - const url = new URL(request.url); - - const path = url.search === null ? url.pathname : `${url.pathname}?${url.search}`; - - const options: https.RequestOptions = { - agent: url.protocol === 'https:' ? this.httpsAgent : this.httpAgent, - hostname: url.hostname, - path, - method: request.method, - headers: request.headers, - ...(url.port !== undefined ? { port: url.port || '' } : {}), - }; - - const req = (url.protocol === 'https:' ? https : http).request(options, (response) => { - let contentBuffers: Buffer[] = []; - - response.on('data', (chunk) => { - contentBuffers = contentBuffers.concat(chunk); - }); - - response.on('end', () => { - clearTimeout(connectTimeout); - clearTimeout(responseTimeout as NodeJS.Timeout); - - resolve({ - status: response.statusCode || 0, - content: Buffer.concat(contentBuffers).toString(), - isTimedOut: false, - }); - }); - }); - - const createTimeout = (timeout: number, content: string): NodeJS.Timeout => { - return setTimeout(() => { - req.destroy(); - - resolve({ - status: 0, - content, - isTimedOut: true, - }); - }, timeout * 1000); - }; - - const connectTimeout = createTimeout(request.connectTimeout, 'Connection timeout'); - - let responseTimeout: NodeJS.Timeout | undefined; - - req.on('error', (error) => { - clearTimeout(connectTimeout); - clearTimeout(responseTimeout!); - resolve({ status: 0, content: error.message, isTimedOut: false }); - }); - - req.once('response', () => { - clearTimeout(connectTimeout); - responseTimeout = createTimeout(request.responseTimeout, 'Socket timeout'); - }); - - if (request.data !== undefined) { - req.write(request.data); - } - - req.end(); - }); - } -} diff --git a/clients/algoliasearch-client-javascript/utils/Requester.ts b/clients/algoliasearch-client-javascript/utils/Requester.ts deleted file mode 100644 index c26e08205dc..00000000000 --- a/clients/algoliasearch-client-javascript/utils/Requester.ts +++ /dev/null @@ -1,4 +0,0 @@ -import { EndRequest, Request, Response } from '../types'; -export abstract class Requester { - abstract send(request: EndRequest, originalRequest: Request): Promise; -} From 406c9e868cbb4c0677e1f3ca21bd1f5c69906614 Mon Sep 17 00:00:00 2001 From: Pierre Millot Date: Fri, 26 Nov 2021 15:39:29 +0100 Subject: [PATCH 5/6] wrong gitignore --- clients/algoliasearch-client-javascript/.gitignore | 4 +++- templates/javascript/{.gitignore => gitignore} | 4 ++-- 2 files changed, 5 insertions(+), 3 deletions(-) rename templates/javascript/{.gitignore => gitignore} (52%) diff --git a/clients/algoliasearch-client-javascript/.gitignore b/clients/algoliasearch-client-javascript/.gitignore index 149b5765472..b3a5f6266da 100644 --- a/clients/algoliasearch-client-javascript/.gitignore +++ b/clients/algoliasearch-client-javascript/.gitignore @@ -1,4 +1,6 @@ -wwwroot/*.js node_modules typings dist +build +.env +.vscode \ No newline at end of file diff --git a/templates/javascript/.gitignore b/templates/javascript/gitignore similarity index 52% rename from templates/javascript/.gitignore rename to templates/javascript/gitignore index c5c6046b52d..b3a5f6266da 100644 --- a/templates/javascript/.gitignore +++ b/templates/javascript/gitignore @@ -1,6 +1,6 @@ -node_versions +node_modules typings dist build .env -.vscode +.vscode \ No newline at end of file From 6162a4ae48d8aa61abe126cbcaffb081d6518b31 Mon Sep 17 00:00:00 2001 From: Pierre Millot Date: Fri, 26 Nov 2021 16:28:51 +0100 Subject: [PATCH 6/6] add optional status --- .../utils/requester/EchoRequester.ts | 6 +++++- clients/utils/javascript/requester/EchoRequester.ts | 6 +++++- playground/javascript/app.ts | 4 ++-- 3 files changed, 12 insertions(+), 4 deletions(-) diff --git a/clients/algoliasearch-client-javascript/utils/requester/EchoRequester.ts b/clients/algoliasearch-client-javascript/utils/requester/EchoRequester.ts index 5f7a9c715a6..59db014da01 100644 --- a/clients/algoliasearch-client-javascript/utils/requester/EchoRequester.ts +++ b/clients/algoliasearch-client-javascript/utils/requester/EchoRequester.ts @@ -2,11 +2,15 @@ import { EndRequest, Request, Response } from '../types'; import { Requester } from './Requester'; export class EchoRequester extends Requester { + constructor(private status = 200) { + super(); + } + async send(request: EndRequest, originalRequest: Request): Promise { return { content: JSON.stringify(originalRequest), isTimedOut: false, - status: 200, + status: this.status, }; } } diff --git a/clients/utils/javascript/requester/EchoRequester.ts b/clients/utils/javascript/requester/EchoRequester.ts index 5f7a9c715a6..59db014da01 100644 --- a/clients/utils/javascript/requester/EchoRequester.ts +++ b/clients/utils/javascript/requester/EchoRequester.ts @@ -2,11 +2,15 @@ import { EndRequest, Request, Response } from '../types'; import { Requester } from './Requester'; export class EchoRequester extends Requester { + constructor(private status = 200) { + super(); + } + async send(request: EndRequest, originalRequest: Request): Promise { return { content: JSON.stringify(originalRequest), isTimedOut: false, - status: 200, + status: this.status, }; } } diff --git a/playground/javascript/app.ts b/playground/javascript/app.ts index 8de2982b5a8..fcc2d59d8c0 100644 --- a/playground/javascript/app.ts +++ b/playground/javascript/app.ts @@ -1,4 +1,4 @@ -import { searchClient, ApiError, EchoRequester } from 'algoliasearch-client-javascript'; +import { searchClient, ApiError } from 'algoliasearch-client-javascript'; import dotenv from 'dotenv'; dotenv.config({ path: '../.env' }); @@ -10,7 +10,7 @@ const searchIndex = process.env.SEARCH_INDEX || 'test_index'; const searchQuery = process.env.SEARCH_QUERY || 'test_query'; // Init client with appId and apiKey -const client = new searchClient(appId, apiKey, { requester: new EchoRequester() }); +const client = new searchClient(appId, apiKey); async function testMultiQueries() { try {