Skip to content

feat(js): pass searchParams to EchoRequester, update CTS #70

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.

Sign up for GitHub

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

Merged
merged 10 commits into from
Jan 10, 2022
Merged

feat(js): pass searchParams to EchoRequester, update CTS #70

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
c4950a8
feat(cts): add tests for `analytics`
shortcuts Jan 7, 2022
bfbf975
fix: tests, date
shortcuts Jan 7, 2022
a14b792
feat(js): pass `searchParams` to `EchoRequester`, update CTS
shortcuts Jan 7, 2022
aad0c09
tests: add `searchParams` values
shortcuts Jan 7, 2022
6cc05ef
use `searchParams` object
shortcuts Jan 7, 2022
4e9cbcd
Merge branch 'main' into feat/APIC-247/cts-search-parameters
shortcuts Jan 10, 2022
db35de7
fix(specs): analytics paths and params (#73)
shortcuts Jan 10, 2022
61eae55
remove `objectContaining` on `searchParams`
shortcuts Jan 10, 2022
f9c18d2
split assertions, make `EchoRequester` return undefined
shortcuts Jan 10, 2022
78fa21d
fix typescript syntax
shortcuts Jan 10, 2022
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
527 changes: 56 additions & 471 deletions clients/algoliasearch-client-javascript/client-analytics/src/analyticsApi.ts
View file
Open in desktop

Large diffs are not rendered by default.

48 changes: 46 additions & 2 deletions clients/algoliasearch-client-javascript/client-analytics/utils/requester/EchoRequester.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,58 @@ import type { EndRequest, Request, Response } from '../types';

import { Requester } from './Requester';

type AdditionalContent = {
headers: Record<string, string>;
connectTimeout: number;
responseTimeout: number;
userAgent?: string;
searchParams?: Record<string, any>;
};

function searchParamsWithoutUA(
params: URLSearchParams
): AdditionalContent['searchParams'] {
const searchParams = {};

for (const [k, v] of params) {
if (k === 'x-algolia-agent') {
continue;
}

searchParams[k] = v;
}

return Object.entries(searchParams).length === 0 ? undefined : searchParams;
}

export class EchoRequester extends Requester {
constructor(private status = 200) {
super();
}

send(_request: EndRequest, originalRequest: Request): Promise<Response> {
send(
{ headers, url, connectTimeout, responseTimeout }: EndRequest,
{ data, ...originalRequest }: Request
): Promise<Response> {
const urlSearchParams = new URL(url).searchParams;
const userAgent = urlSearchParams.get('x-algolia-agent') || undefined;
const searchParams = searchParamsWithoutUA(urlSearchParams);
const additionalContent: AdditionalContent = {
headers,
connectTimeout,
responseTimeout,
userAgent: userAgent ? encodeURI(userAgent) : undefined,
searchParams,
};
const originalData =
data && Object.entries(data).length > 0 ? data : undefined;

return Promise.resolve({
content: JSON.stringify(originalRequest),
content: JSON.stringify({
...originalRequest,
...additionalContent,
data: originalData,
}),
isTimedOut: false,
status: this.status,
});
Expand Down
48 changes: 46 additions & 2 deletions clients/algoliasearch-client-javascript/client-insights/utils/requester/EchoRequester.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,58 @@ import type { EndRequest, Request, Response } from '../types';

import { Requester } from './Requester';

type AdditionalContent = {
headers: Record<string, string>;
connectTimeout: number;
responseTimeout: number;
userAgent?: string;
searchParams?: Record<string, any>;
};

function searchParamsWithoutUA(
params: URLSearchParams
): AdditionalContent['searchParams'] {
const searchParams = {};

for (const [k, v] of params) {
if (k === 'x-algolia-agent') {
continue;
}

searchParams[k] = v;
}

return Object.entries(searchParams).length === 0 ? undefined : searchParams;
}

export class EchoRequester extends Requester {
constructor(private status = 200) {
super();
}

send(_request: EndRequest, originalRequest: Request): Promise<Response> {
send(
{ headers, url, connectTimeout, responseTimeout }: EndRequest,
{ data, ...originalRequest }: Request
): Promise<Response> {
const urlSearchParams = new URL(url).searchParams;
const userAgent = urlSearchParams.get('x-algolia-agent') || undefined;
const searchParams = searchParamsWithoutUA(urlSearchParams);
const additionalContent: AdditionalContent = {
headers,
connectTimeout,
responseTimeout,
userAgent: userAgent ? encodeURI(userAgent) : undefined,
searchParams,
};
const originalData =
data && Object.entries(data).length > 0 ? data : undefined;

return Promise.resolve({
content: JSON.stringify(originalRequest),
content: JSON.stringify({
...originalRequest,
...additionalContent,
data: originalData,
}),
isTimedOut: false,
status: this.status,
});
Expand Down
48 changes: 46 additions & 2 deletions ...s/algoliasearch-client-javascript/client-personalization/utils/requester/EchoRequester.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,58 @@ import type { EndRequest, Request, Response } from '../types';

import { Requester } from './Requester';

type AdditionalContent = {
headers: Record<string, string>;
connectTimeout: number;
responseTimeout: number;
userAgent?: string;
searchParams?: Record<string, any>;
};

function searchParamsWithoutUA(
params: URLSearchParams
): AdditionalContent['searchParams'] {
const searchParams = {};

for (const [k, v] of params) {
if (k === 'x-algolia-agent') {
continue;
}

searchParams[k] = v;
}

return Object.entries(searchParams).length === 0 ? undefined : searchParams;
}

export class EchoRequester extends Requester {
constructor(private status = 200) {
super();
}

send(_request: EndRequest, originalRequest: Request): Promise<Response> {
send(
{ headers, url, connectTimeout, responseTimeout }: EndRequest,
{ data, ...originalRequest }: Request
): Promise<Response> {
const urlSearchParams = new URL(url).searchParams;
const userAgent = urlSearchParams.get('x-algolia-agent') || undefined;
const searchParams = searchParamsWithoutUA(urlSearchParams);
const additionalContent: AdditionalContent = {
headers,
connectTimeout,
responseTimeout,
userAgent: userAgent ? encodeURI(userAgent) : undefined,
searchParams,
};
const originalData =
data && Object.entries(data).length > 0 ? data : undefined;

return Promise.resolve({
content: JSON.stringify(originalRequest),
content: JSON.stringify({
...originalRequest,
...additionalContent,
data: originalData,
}),
isTimedOut: false,
status: this.status,
});
Expand Down
48 changes: 46 additions & 2 deletions clients/algoliasearch-client-javascript/client-search/utils/requester/EchoRequester.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,58 @@ import type { EndRequest, Request, Response } from '../types';

import { Requester } from './Requester';

type AdditionalContent = {
headers: Record<string, string>;
connectTimeout: number;
responseTimeout: number;
userAgent?: string;
searchParams?: Record<string, any>;
};

function searchParamsWithoutUA(
params: URLSearchParams
): AdditionalContent['searchParams'] {
const searchParams = {};

for (const [k, v] of params) {
if (k === 'x-algolia-agent') {
continue;
}

searchParams[k] = v;
}

return Object.entries(searchParams).length === 0 ? undefined : searchParams;
}

export class EchoRequester extends Requester {
constructor(private status = 200) {
super();
}

send(_request: EndRequest, originalRequest: Request): Promise<Response> {
send(
{ headers, url, connectTimeout, responseTimeout }: EndRequest,
{ data, ...originalRequest }: Request
): Promise<Response> {
const urlSearchParams = new URL(url).searchParams;
const userAgent = urlSearchParams.get('x-algolia-agent') || undefined;
const searchParams = searchParamsWithoutUA(urlSearchParams);
const additionalContent: AdditionalContent = {
headers,
connectTimeout,
responseTimeout,
userAgent: userAgent ? encodeURI(userAgent) : undefined,
searchParams,
};
const originalData =
data && Object.entries(data).length > 0 ? data : undefined;

return Promise.resolve({
content: JSON.stringify(originalRequest),
content: JSON.stringify({
...originalRequest,
...additionalContent,
data: originalData,
}),
isTimedOut: false,
status: this.status,
});
Expand Down
48 changes: 46 additions & 2 deletions clients/algoliasearch-client-javascript/recommend/utils/requester/EchoRequester.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,58 @@ import type { EndRequest, Request, Response } from '../types';

import { Requester } from './Requester';

type AdditionalContent = {
headers: Record<string, string>;
connectTimeout: number;
responseTimeout: number;
userAgent?: string;
searchParams?: Record<string, any>;
};

function searchParamsWithoutUA(
params: URLSearchParams
): AdditionalContent['searchParams'] {
const searchParams = {};

for (const [k, v] of params) {
if (k === 'x-algolia-agent') {
continue;
}

searchParams[k] = v;
}

return Object.entries(searchParams).length === 0 ? undefined : searchParams;
}

export class EchoRequester extends Requester {
constructor(private status = 200) {
super();
}

send(_request: EndRequest, originalRequest: Request): Promise<Response> {
send(
{ headers, url, connectTimeout, responseTimeout }: EndRequest,
{ data, ...originalRequest }: Request
): Promise<Response> {
const urlSearchParams = new URL(url).searchParams;
const userAgent = urlSearchParams.get('x-algolia-agent') || undefined;
const searchParams = searchParamsWithoutUA(urlSearchParams);
const additionalContent: AdditionalContent = {
headers,
connectTimeout,
responseTimeout,
userAgent: userAgent ? encodeURI(userAgent) : undefined,
searchParams,
};
const originalData =
data && Object.entries(data).length > 0 ? data : undefined;

return Promise.resolve({
content: JSON.stringify(originalRequest),
content: JSON.stringify({
...originalRequest,
...additionalContent,
data: originalData,
}),
isTimedOut: false,
status: this.status,
});
Expand Down
48 changes: 46 additions & 2 deletions clients/algoliasearch-client-javascript/utils/requester/EchoRequester.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,58 @@ import type { EndRequest, Request, Response } from '../types';

import { Requester } from './Requester';

type AdditionalContent = {
headers: Record<string, string>;
connectTimeout: number;
responseTimeout: number;
userAgent?: string;
searchParams?: Record<string, any>;
};

function searchParamsWithoutUA(
params: URLSearchParams
): AdditionalContent['searchParams'] {
const searchParams = {};

for (const [k, v] of params) {
if (k === 'x-algolia-agent') {
continue;
}

searchParams[k] = v;
}

return Object.entries(searchParams).length === 0 ? undefined : searchParams;
}

export class EchoRequester extends Requester {
constructor(private status = 200) {
super();
}

send(_request: EndRequest, originalRequest: Request): Promise<Response> {
send(
{ headers, url, connectTimeout, responseTimeout }: EndRequest,
{ data, ...originalRequest }: Request
): Promise<Response> {
const urlSearchParams = new URL(url).searchParams;
const userAgent = urlSearchParams.get('x-algolia-agent') || undefined;
const searchParams = searchParamsWithoutUA(urlSearchParams);
const additionalContent: AdditionalContent = {
headers,
connectTimeout,
responseTimeout,
userAgent: userAgent ? encodeURI(userAgent) : undefined,
searchParams,
};
const originalData =
data && Object.entries(data).length > 0 ? data : undefined;

return Promise.resolve({
content: JSON.stringify(originalRequest),
content: JSON.stringify({
...originalRequest,
...additionalContent,
data: originalData,
}),
isTimedOut: false,
status: this.status,
});
Expand Down
13 changes: 2 additions & 11 deletions specs/analytics/paths/common/parameters.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,18 +43,9 @@ Limit:
default: 10

Search:
in: path
name: search
description: The query term. Must match the exact user input.
required: true
schema:
type: string

SearchInPath:
in: path
in: query
name: search
description: The query term. Must match the exact user input.
required: true
description: The query term to search for. Must match the exact user input.
schema:
type: string

Expand Down
Loading