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

feat(cts): add tests for host, user agent, and timeouts #112

Merged
merged 20 commits into from
Feb 10, 2022
Merged

feat(cts): add tests for host, user agent, and timeouts #112

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
e81ca0a
chore: add tests for host, user agent, and timeouts
eunjae-lee Feb 1, 2022
4639c12
chore: rename test
eunjae-lee Feb 1, 2022
df19ea0
chore: add more tests
eunjae-lee Feb 1, 2022
6980d57
fix: add host to EchoResponse
eunjae-lee Feb 2, 2022
4a61b97
chore: rename tests
eunjae-lee Feb 2, 2022
09a6488
chore: fix host test and add region test
eunjae-lee Feb 2, 2022
a3a4248
Update suite.mustache
Feb 2, 2022
3cc180b
Merge branch 'main' into chore/add-client-tests
Feb 3, 2022
e73da28
Merge branch 'main' into chore/add-client-tests
Feb 7, 2022
46fba38
chore: update generated tests
eunjae-lee Feb 7, 2022
42b1a53
Merge branch 'main' into chore/add-client-tests
eunjae-lee Feb 7, 2022
b3c0b26
update tests for region
eunjae-lee Feb 7, 2022
60877e8
fix wrong timeouts
eunjae-lee Feb 7, 2022
36328ad
Merge branch 'main' into chore/add-client-tests
eunjae-lee Feb 7, 2022
df28d2c
Merge branch 'chore/add-client-tests' of github.com:algolia/api-clien…
eunjae-lee Feb 7, 2022
f31b4b0
wip
eunjae-lee Feb 8, 2022
835e92a
update region tests
eunjae-lee Feb 8, 2022
057a31f
Merge branch 'main' into chore/add-client-tests
eunjae-lee Feb 8, 2022
47032fc
Merge branch 'main' into chore/add-client-tests
eunjae-lee Feb 9, 2022
c676961
Merge branch 'main' into chore/add-client-tests
eunjae-lee Feb 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
3 changes: 2 additions & 1 deletion clients/algoliasearch-client-javascript/client-common/src/requester/EchoRequester.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,15 @@ export class EchoRequester extends Requester {
{ headers, url, connectTimeout, responseTimeout }: EndRequest,
{ data, ...originalRequest }: Request
): Promise<Response> {
const urlSearchParams = new URL(url).searchParams;
const { host, searchParams: urlSearchParams } = new URL(url);
const userAgent = urlSearchParams.get('x-algolia-agent') || undefined;
const originalData =
data && Object.entries(data).length > 0 ? data : undefined;

return Promise.resolve({
content: JSON.stringify({
...originalRequest,
host,
headers,
connectTimeout,
responseTimeout,
Expand Down
1 change: 1 addition & 0 deletions clients/algoliasearch-client-javascript/client-common/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ export type Response = {

export type EchoResponse = Request & {
connectTimeout: number;
host: string;
headers: Record<string, string>;
responseTimeout: number;
searchParams?: Record<string, string>;
Expand Down
50 changes: 50 additions & 0 deletions tests/CTS/client/abtesting/api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
[
{
"testName": "calls api with correct user agent",
"steps": [
{
"type": "method",
"object": "$client",
"path": "addABTests",
"parameters": [
{
"name": "test",
"variant": [{ "index": "my-test-index", "trafficPercentage": 90 }],
"endAt": "2022-02-01T13:37:01Z"
}
],
"expected": {
"testSubject": "actual.userAgent",
"match": {
"regexp": "/Algolia%20for%20(.+)%20\\(\\d+\\.\\d+\\.\\d+\\)/"
}
}
}
]
},
{
"testName": "calls api with correct timeouts",
"steps": [
{
"type": "method",
"object": "$client",
"path": "addABTests",
"parameters": [
{
"name": "test",
"variant": [{ "index": "my-test-index", "trafficPercentage": 90 }],
"endAt": "2022-02-01T13:37:01Z"
}
],
"expected": {
"match": {
"objectContaining": {
"connectTimeout": 1,
"responseTimeout": 30
}
}
}
}
]
}
]
36 changes: 36 additions & 0 deletions tests/CTS/client/abtesting/parameters.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
[
{
"testName": "does not throw when region is not given",
"autoCreateClient": false,
"steps": [
{
"type": "createClient",
"parameters": {
"appId": "my-app-id",
"apiKey": "my-api-key",
"region": ""
},
"expected": {
"error": false
}
}
]
},
{
"testName": "does not throw when region is given",
"autoCreateClient": false,
"steps": [
{
"type": "createClient",
"parameters": {
"appId": "my-app-id",
"apiKey": "my-api-key",
"region": "us"
},
"expected": {
"error": false
}
}
]
}
]
38 changes: 38 additions & 0 deletions tests/CTS/client/analytics/api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
[
{
"testName": "calls api with correct user agent",
"steps": [
{
"type": "method",
"object": "$client",
"path": "getAverageClickPosition",
"parameters": [{ "index": "my-index" }],
"expected": {
"testSubject": "actual.userAgent",
"match": {
"regexp": "/Algolia%20for%20(.+)%20\\(\\d+\\.\\d+\\.\\d+\\)/"
}
}
}
]
},
{
"testName": "calls api with correct timeouts",
"steps": [
{
"type": "method",
"object": "$client",
"path": "getAverageClickPosition",
"parameters": [{ "index": "my-index" }],
"expected": {
"match": {
"objectContaining": {
"connectTimeout": 1,
"responseTimeout": 2
}
}
}
}
]
}
]
0 tests/CTS/client/analytics/basic.json → tests/CTS/client/analytics/parameters.json
View file
Open in desktop
File renamed without changes.
46 changes: 46 additions & 0 deletions tests/CTS/client/insights/api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
[
{
"testName": "calls api with correct user agent",
"steps": [
{
"type": "method",
"object": "$client",
"path": "pushEvents",
"parameters": [
{
"events": []
}
],
"expected": {
"testSubject": "actual.userAgent",
"match": {
"regexp": "/Algolia%20for%20(.+)%20\\(\\d+\\.\\d+\\.\\d+\\)/"
}
}
}
]
},
{
"testName": "calls api with correct timeouts",
"steps": [
{
"type": "method",
"object": "$client",
"path": "pushEvents",
"parameters": [
{
"events": []
}
],
"expected": {
"match": {
"objectContaining": {
"connectTimeout": 1,
"responseTimeout": 30
}
}
}
}
]
}
]
38 changes: 38 additions & 0 deletions tests/CTS/client/personalization/api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
[
{
"testName": "calls api with correct user agent",
"steps": [
{
"type": "method",
"object": "$client",
"path": "getPersonalizationStrategy",
"parameters": [],
"expected": {
"testSubject": "actual.userAgent",
"match": {
"regexp": "/Algolia%20for%20(.+)%20\\(\\d+\\.\\d+\\.\\d+\\)/"
}
}
}
]
},
{
"testName": "calls api with correct timeouts",
"steps": [
{
"type": "method",
"object": "$client",
"path": "getPersonalizationStrategy",
"parameters": [],
"expected": {
"match": {
"objectContaining": {
"connectTimeout": 1,
"responseTimeout": 2
}
}
}
}
]
}
]
36 changes: 36 additions & 0 deletions tests/CTS/client/personalization/parameters.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
[
{
"testName": "throws when region is not given",
"autoCreateClient": false,
"steps": [
{
"type": "createClient",
"parameters": {
"appId": "my-app-id",
"apiKey": "my-api-key",
"region": ""
},
"expected": {
"error": "`region` is missing."
}
}
]
},
{
"testName": "does not throw when region is given",
"autoCreateClient": false,
"steps": [
{
"type": "createClient",
"parameters": {
"appId": "my-app-id",
"apiKey": "my-api-key",
"region": "us"
},
"expected": {
"error": false
}
}
]
}
]
38 changes: 38 additions & 0 deletions tests/CTS/client/query-suggestions/api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
[
{
"testName": "calls api with correct user agent",
"steps": [
{
"type": "method",
"object": "$client",
"path": "createConfig",
"parameters": [{}],
"expected": {
"testSubject": "actual.userAgent",
"match": {
"regexp": "/Algolia%20for%20(.+)%20\\(\\d+\\.\\d+\\.\\d+\\)/"
}
}
}
]
},
{
"testName": "calls api with correct timeouts",
"steps": [
{
"type": "method",
"object": "$client",
"path": "createConfig",
"parameters": [{}],
"expected": {
"match": {
"objectContaining": {
"connectTimeout": 1,
"responseTimeout": 30
}
}
}
}
]
}
]
36 changes: 36 additions & 0 deletions tests/CTS/client/query-suggestions/parameters.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
[
{
"testName": "throws when region is not given",
"autoCreateClient": false,
"steps": [
{
"type": "createClient",
"parameters": {
"appId": "my-app-id",
"apiKey": "my-api-key",
"region": ""
},
"expected": {
"error": "`region` is missing."
}
}
]
},
{
"testName": "does not throw when region is given",
"autoCreateClient": false,
"steps": [
{
"type": "createClient",
"parameters": {
"appId": "my-app-id",
"apiKey": "my-api-key",
"region": "us"
},
"expected": {
"error": false
}
}
]
}
]
38 changes: 38 additions & 0 deletions tests/CTS/client/recommend/api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
[
{
"testName": "calls api with correct user agent",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Not required for this PR) I don't know if it's the same for other clients, but we also send the client name in the UA in JS.

cc @millotp @damcou do you send it in PHP/Java?

We could maybe test Algolia%20for.*clientName or something similar

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works for me

"steps": [
{
"type": "method",
"object": "$client",
"path": "getRecommendations",
"parameters": [{ "requests": [] }],
"expected": {
"testSubject": "actual.userAgent",
"match": {
"regexp": "/Algolia%20for%20(.+)%20\\(\\d+\\.\\d+\\.\\d+\\)/"
}
}
}
]
},
{
"testName": "calls api with correct timeouts",
"steps": [
{
"type": "method",
"object": "$client",
"path": "getRecommendations",
"parameters": [{ "requests": [] }],
"expected": {
"match": {
"objectContaining": {
"connectTimeout": 1,
"responseTimeout": 30
}
}
}
}
]
}
]
Loading