Skip to content
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

fix: add options to clients #16

Merged
merged 6 commits into from
Nov 29, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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];
Original file line number Diff line number Diff line change
@@ -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';
Expand All @@ -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',
},
Expand All @@ -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;
}
Expand Down
12 changes: 0 additions & 12 deletions clients/algoliasearch-client-javascript/utils/EchoRequester.ts

This file was deleted.

4 changes: 0 additions & 4 deletions clients/algoliasearch-client-javascript/utils/Requester.ts

This file was deleted.

19 changes: 14 additions & 5 deletions clients/algoliasearch-client-javascript/utils/Transporter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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[];
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
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<Response> {
return {
content: JSON.stringify(originalRequest),
isTimedOut: false,
status: this.status,
};
}
}
Original file line number Diff line number Diff line change
@@ -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';
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import { EndRequest, Request, Response } from '../types';
export abstract class Requester {
abstract send(request: EndRequest, originalRequest: Request): Promise<Response>;
}
12 changes: 0 additions & 12 deletions clients/utils/javascript/EchoRequester.ts

This file was deleted.

4 changes: 0 additions & 4 deletions clients/utils/javascript/Requester.ts

This file was deleted.

19 changes: 14 additions & 5 deletions clients/utils/javascript/Transporter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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[];
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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);
Expand Down
16 changes: 16 additions & 0 deletions clients/utils/javascript/requester/EchoRequester.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
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<Response> {
return {
content: JSON.stringify(originalRequest),
isTimedOut: false,
status: this.status,
};
}
}
Original file line number Diff line number Diff line change
@@ -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';
Expand Down
4 changes: 4 additions & 0 deletions clients/utils/javascript/requester/Requester.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import { EndRequest, Request, Response } from '../types';
export abstract class Requester {
abstract send(request: EndRequest, originalRequest: Request): Promise<Response>;
}
2 changes: 1 addition & 1 deletion templates/javascript/api-all.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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}}
46 changes: 27 additions & 19 deletions templates/javascript/api-single.mustache
Original file line number Diff line number Diff line change
@@ -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}}';
Expand Down Expand Up @@ -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'
},
Expand All @@ -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<TResponse>(request: Request, requestOptions: RequestOptions): Promise<TResponse> {
{{#authMethods}}
Expand Down