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.

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

Jump to bottom

fix(recommend): remove the search user-agent from requests [RECO-2154] #1508

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

fix(recommend): remove the search user-agent from requests [RECO-2154] #1508

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 3 additions & 5 deletions packages/recommend/src/__tests__/recommend-client.test.ts
View file
Open in desktop
Expand Up @@ -108,22 +108,20 @@ describe('recommend', () => {
const client = recommend('appId', 'apiKey');

if (testing.isBrowser()) {
expect(client.transporter.userAgent.value).toEqual(
`Algolia for JavaScript (${version}); Recommend (${version}); Browser`
);
expect(client.transporter.userAgent.value).toEqual(`Recommend (${version}); Browser`);
} else {
const nodeVersion = process.versions.node;

expect(client.transporter.userAgent.value).toEqual(
`Algolia for JavaScript (${version}); Recommend (${version}); Node.js (${nodeVersion})`
`Recommend (${version}); Node.js (${nodeVersion})`
);
}
});

test('allows to customize options', () => {
const client = recommend('appId', 'apiKey');
const cache = createInMemoryCache();
const userAgent = createUserAgent('0.2.0');
const userAgent = createUserAgent('0.2.0', '');

const customClient = recommend('appId', 'apiKey', {
hostsCache: cache,
Expand Down
2 changes: 1 addition & 1 deletion packages/recommend/src/builds/browser.ts
View file
Open in desktop
Expand Up @@ -42,7 +42,7 @@ export default function recommend(
createInMemoryCache(),
],
}),
userAgent: createUserAgent(version)
userAgent: createUserAgent(version, '')
.add({ segment: 'Recommend', version })
.add({ segment: 'Browser' }),
authMode: AuthMode.WithinQueryParameters,
Expand Down
2 changes: 1 addition & 1 deletion packages/recommend/src/builds/node.ts
View file
Open in desktop
Expand Up @@ -36,7 +36,7 @@ export default function recommend(
responsesCache: createNullCache(),
requestsCache: createNullCache(),
hostsCache: createInMemoryCache(),
userAgent: createUserAgent(version)
userAgent: createUserAgent(version, '')
.add({ segment: 'Recommend', version })
.add({ segment: 'Node.js', version: process.versions.node }),
};
Expand Down
8 changes: 5 additions & 3 deletions packages/transporter/src/createUserAgent.ts
View file
Open in desktop
@@ -1,10 +1,12 @@
import { UserAgent, UserAgentOptions } from '.';

export function createUserAgent(version: string): UserAgent {
export function createUserAgent(version: string, base = 'Algolia for JavaScript'): UserAgent {
const userAgent: UserAgent = {
value: `Algolia for JavaScript (${version})`,
value: base ? `${base} (${version})` : '',
add(options: UserAgentOptions): UserAgent {
const addedUserAgent = `; ${options.segment}${
const separator = userAgent.value ? '; ' : '';

const addedUserAgent = `${separator}${options.segment}${
options.version !== undefined ? ` (${options.version})` : ''
}`;

Expand Down