@algolia/requester-browser-xhr 5.0.0-alpha.1 → 5.0.0-alpha.100
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +2 -2
- package/dist/{requester-browser-xhr.cjs.js → requester-browser-xhr.cjs} +52 -54
- package/dist/requester-browser-xhr.esm.node.js +52 -52
- package/dist/src/createXhrRequester.d.ts +2 -2
- package/dist/src/createXhrRequester.d.ts.map +1 -1
- package/dist/src/echoRequester.d.ts +2 -2
- package/dist/src/echoRequester.d.ts.map +1 -1
- package/package.json +14 -10
- package/src/__tests__/browser-xhr-requester.test.ts +12 -12
package/dist/index.d.ts
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
export * from './src/createXhrRequester';
|
|
2
|
-
export * from './src/echoRequester';
|
|
1
|
+
export * from './src/createXhrRequester';
|
|
2
|
+
export * from './src/echoRequester';
|
|
3
3
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1,63 +1,61 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
|
-
|
|
5
3
|
var clientCommon = require('@algolia/client-common');
|
|
6
4
|
|
|
7
|
-
function createXhrRequester() {
|
|
8
|
-
function send(request) {
|
|
9
|
-
return new Promise((resolve) => {
|
|
10
|
-
const baseRequester = new XMLHttpRequest();
|
|
11
|
-
baseRequester.open(request.method, request.url, true);
|
|
12
|
-
Object.keys(request.headers).forEach((key) => baseRequester.setRequestHeader(key, request.headers[key]));
|
|
13
|
-
const createTimeout = (timeout, content) => {
|
|
14
|
-
return setTimeout(() => {
|
|
15
|
-
baseRequester.abort();
|
|
16
|
-
resolve({
|
|
17
|
-
status: 0,
|
|
18
|
-
content,
|
|
19
|
-
isTimedOut: true,
|
|
20
|
-
});
|
|
21
|
-
}, timeout);
|
|
22
|
-
};
|
|
23
|
-
const connectTimeout = createTimeout(request.connectTimeout, 'Connection timeout');
|
|
24
|
-
let responseTimeout;
|
|
25
|
-
baseRequester.onreadystatechange = () => {
|
|
26
|
-
if (baseRequester.readyState > baseRequester.OPENED &&
|
|
27
|
-
responseTimeout === undefined) {
|
|
28
|
-
clearTimeout(connectTimeout);
|
|
29
|
-
responseTimeout = createTimeout(request.responseTimeout, 'Socket timeout');
|
|
30
|
-
}
|
|
31
|
-
};
|
|
32
|
-
baseRequester.onerror = () => {
|
|
33
|
-
// istanbul ignore next
|
|
34
|
-
if (baseRequester.status === 0) {
|
|
35
|
-
clearTimeout(connectTimeout);
|
|
36
|
-
clearTimeout(responseTimeout);
|
|
37
|
-
resolve({
|
|
38
|
-
content: baseRequester.responseText || 'Network request failed',
|
|
39
|
-
status: baseRequester.status,
|
|
40
|
-
isTimedOut: false,
|
|
41
|
-
});
|
|
42
|
-
}
|
|
43
|
-
};
|
|
44
|
-
baseRequester.onload = () => {
|
|
45
|
-
clearTimeout(connectTimeout);
|
|
46
|
-
clearTimeout(responseTimeout);
|
|
47
|
-
resolve({
|
|
48
|
-
content: baseRequester.responseText,
|
|
49
|
-
status: baseRequester.status,
|
|
50
|
-
isTimedOut: false,
|
|
51
|
-
});
|
|
52
|
-
};
|
|
53
|
-
baseRequester.send(request.data);
|
|
54
|
-
});
|
|
55
|
-
}
|
|
56
|
-
return { send };
|
|
5
|
+
function createXhrRequester() {
|
|
6
|
+
function send(request) {
|
|
7
|
+
return new Promise((resolve) => {
|
|
8
|
+
const baseRequester = new XMLHttpRequest();
|
|
9
|
+
baseRequester.open(request.method, request.url, true);
|
|
10
|
+
Object.keys(request.headers).forEach((key) => baseRequester.setRequestHeader(key, request.headers[key]));
|
|
11
|
+
const createTimeout = (timeout, content) => {
|
|
12
|
+
return setTimeout(() => {
|
|
13
|
+
baseRequester.abort();
|
|
14
|
+
resolve({
|
|
15
|
+
status: 0,
|
|
16
|
+
content,
|
|
17
|
+
isTimedOut: true,
|
|
18
|
+
});
|
|
19
|
+
}, timeout);
|
|
20
|
+
};
|
|
21
|
+
const connectTimeout = createTimeout(request.connectTimeout, 'Connection timeout');
|
|
22
|
+
let responseTimeout;
|
|
23
|
+
baseRequester.onreadystatechange = () => {
|
|
24
|
+
if (baseRequester.readyState > baseRequester.OPENED &&
|
|
25
|
+
responseTimeout === undefined) {
|
|
26
|
+
clearTimeout(connectTimeout);
|
|
27
|
+
responseTimeout = createTimeout(request.responseTimeout, 'Socket timeout');
|
|
28
|
+
}
|
|
29
|
+
};
|
|
30
|
+
baseRequester.onerror = () => {
|
|
31
|
+
// istanbul ignore next
|
|
32
|
+
if (baseRequester.status === 0) {
|
|
33
|
+
clearTimeout(connectTimeout);
|
|
34
|
+
clearTimeout(responseTimeout);
|
|
35
|
+
resolve({
|
|
36
|
+
content: baseRequester.responseText || 'Network request failed',
|
|
37
|
+
status: baseRequester.status,
|
|
38
|
+
isTimedOut: false,
|
|
39
|
+
});
|
|
40
|
+
}
|
|
41
|
+
};
|
|
42
|
+
baseRequester.onload = () => {
|
|
43
|
+
clearTimeout(connectTimeout);
|
|
44
|
+
clearTimeout(responseTimeout);
|
|
45
|
+
resolve({
|
|
46
|
+
content: baseRequester.responseText,
|
|
47
|
+
status: baseRequester.status,
|
|
48
|
+
isTimedOut: false,
|
|
49
|
+
});
|
|
50
|
+
};
|
|
51
|
+
baseRequester.send(request.data);
|
|
52
|
+
});
|
|
53
|
+
}
|
|
54
|
+
return { send };
|
|
57
55
|
}
|
|
58
56
|
|
|
59
|
-
function echoRequester(status = 200) {
|
|
60
|
-
return clientCommon.createEchoRequester({ getURL: (url) => new URL(url), status });
|
|
57
|
+
function echoRequester(status = 200) {
|
|
58
|
+
return clientCommon.createEchoRequester({ getURL: (url) => new URL(url), status });
|
|
61
59
|
}
|
|
62
60
|
|
|
63
61
|
exports.createXhrRequester = createXhrRequester;
|
|
@@ -1,59 +1,59 @@
|
|
|
1
1
|
import { createEchoRequester } from '@algolia/client-common';
|
|
2
2
|
|
|
3
|
-
function createXhrRequester() {
|
|
4
|
-
function send(request) {
|
|
5
|
-
return new Promise((resolve) => {
|
|
6
|
-
const baseRequester = new XMLHttpRequest();
|
|
7
|
-
baseRequester.open(request.method, request.url, true);
|
|
8
|
-
Object.keys(request.headers).forEach((key) => baseRequester.setRequestHeader(key, request.headers[key]));
|
|
9
|
-
const createTimeout = (timeout, content) => {
|
|
10
|
-
return setTimeout(() => {
|
|
11
|
-
baseRequester.abort();
|
|
12
|
-
resolve({
|
|
13
|
-
status: 0,
|
|
14
|
-
content,
|
|
15
|
-
isTimedOut: true,
|
|
16
|
-
});
|
|
17
|
-
}, timeout);
|
|
18
|
-
};
|
|
19
|
-
const connectTimeout = createTimeout(request.connectTimeout, 'Connection timeout');
|
|
20
|
-
let responseTimeout;
|
|
21
|
-
baseRequester.onreadystatechange = () => {
|
|
22
|
-
if (baseRequester.readyState > baseRequester.OPENED &&
|
|
23
|
-
responseTimeout === undefined) {
|
|
24
|
-
clearTimeout(connectTimeout);
|
|
25
|
-
responseTimeout = createTimeout(request.responseTimeout, 'Socket timeout');
|
|
26
|
-
}
|
|
27
|
-
};
|
|
28
|
-
baseRequester.onerror = () => {
|
|
29
|
-
// istanbul ignore next
|
|
30
|
-
if (baseRequester.status === 0) {
|
|
31
|
-
clearTimeout(connectTimeout);
|
|
32
|
-
clearTimeout(responseTimeout);
|
|
33
|
-
resolve({
|
|
34
|
-
content: baseRequester.responseText || 'Network request failed',
|
|
35
|
-
status: baseRequester.status,
|
|
36
|
-
isTimedOut: false,
|
|
37
|
-
});
|
|
38
|
-
}
|
|
39
|
-
};
|
|
40
|
-
baseRequester.onload = () => {
|
|
41
|
-
clearTimeout(connectTimeout);
|
|
42
|
-
clearTimeout(responseTimeout);
|
|
43
|
-
resolve({
|
|
44
|
-
content: baseRequester.responseText,
|
|
45
|
-
status: baseRequester.status,
|
|
46
|
-
isTimedOut: false,
|
|
47
|
-
});
|
|
48
|
-
};
|
|
49
|
-
baseRequester.send(request.data);
|
|
50
|
-
});
|
|
51
|
-
}
|
|
52
|
-
return { send };
|
|
3
|
+
function createXhrRequester() {
|
|
4
|
+
function send(request) {
|
|
5
|
+
return new Promise((resolve) => {
|
|
6
|
+
const baseRequester = new XMLHttpRequest();
|
|
7
|
+
baseRequester.open(request.method, request.url, true);
|
|
8
|
+
Object.keys(request.headers).forEach((key) => baseRequester.setRequestHeader(key, request.headers[key]));
|
|
9
|
+
const createTimeout = (timeout, content) => {
|
|
10
|
+
return setTimeout(() => {
|
|
11
|
+
baseRequester.abort();
|
|
12
|
+
resolve({
|
|
13
|
+
status: 0,
|
|
14
|
+
content,
|
|
15
|
+
isTimedOut: true,
|
|
16
|
+
});
|
|
17
|
+
}, timeout);
|
|
18
|
+
};
|
|
19
|
+
const connectTimeout = createTimeout(request.connectTimeout, 'Connection timeout');
|
|
20
|
+
let responseTimeout;
|
|
21
|
+
baseRequester.onreadystatechange = () => {
|
|
22
|
+
if (baseRequester.readyState > baseRequester.OPENED &&
|
|
23
|
+
responseTimeout === undefined) {
|
|
24
|
+
clearTimeout(connectTimeout);
|
|
25
|
+
responseTimeout = createTimeout(request.responseTimeout, 'Socket timeout');
|
|
26
|
+
}
|
|
27
|
+
};
|
|
28
|
+
baseRequester.onerror = () => {
|
|
29
|
+
// istanbul ignore next
|
|
30
|
+
if (baseRequester.status === 0) {
|
|
31
|
+
clearTimeout(connectTimeout);
|
|
32
|
+
clearTimeout(responseTimeout);
|
|
33
|
+
resolve({
|
|
34
|
+
content: baseRequester.responseText || 'Network request failed',
|
|
35
|
+
status: baseRequester.status,
|
|
36
|
+
isTimedOut: false,
|
|
37
|
+
});
|
|
38
|
+
}
|
|
39
|
+
};
|
|
40
|
+
baseRequester.onload = () => {
|
|
41
|
+
clearTimeout(connectTimeout);
|
|
42
|
+
clearTimeout(responseTimeout);
|
|
43
|
+
resolve({
|
|
44
|
+
content: baseRequester.responseText,
|
|
45
|
+
status: baseRequester.status,
|
|
46
|
+
isTimedOut: false,
|
|
47
|
+
});
|
|
48
|
+
};
|
|
49
|
+
baseRequester.send(request.data);
|
|
50
|
+
});
|
|
51
|
+
}
|
|
52
|
+
return { send };
|
|
53
53
|
}
|
|
54
54
|
|
|
55
|
-
function echoRequester(status = 200) {
|
|
56
|
-
return createEchoRequester({ getURL: (url) => new URL(url), status });
|
|
55
|
+
function echoRequester(status = 200) {
|
|
56
|
+
return createEchoRequester({ getURL: (url) => new URL(url), status });
|
|
57
57
|
}
|
|
58
58
|
|
|
59
59
|
export { createXhrRequester, echoRequester };
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import type { Requester } from '@algolia/client-common';
|
|
2
|
-
export declare function createXhrRequester(): Requester;
|
|
1
|
+
import type { Requester } from '@algolia/client-common';
|
|
2
|
+
export declare function createXhrRequester(): Requester;
|
|
3
3
|
//# sourceMappingURL=createXhrRequester.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createXhrRequester.d.ts","sourceRoot":"","sources":["
|
|
1
|
+
{"version":3,"file":"createXhrRequester.d.ts","sourceRoot":"","sources":["../../src/createXhrRequester.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAc,SAAS,EAAY,MAAM,wBAAwB,CAAC;AAI9E,wBAAgB,kBAAkB,IAAI,SAAS,CAyE9C"}
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import type { Requester } from '@algolia/client-common';
|
|
2
|
-
export declare function echoRequester(status?: number): Requester;
|
|
1
|
+
import type { Requester } from '@algolia/client-common';
|
|
2
|
+
export declare function echoRequester(status?: number): Requester;
|
|
3
3
|
//# sourceMappingURL=echoRequester.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"echoRequester.d.ts","sourceRoot":"","sources":["
|
|
1
|
+
{"version":3,"file":"echoRequester.d.ts","sourceRoot":"","sources":["../../src/echoRequester.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAExD,wBAAgB,aAAa,CAAC,MAAM,GAAE,MAAY,GAAG,SAAS,CAE7D"}
|
package/package.json
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@algolia/requester-browser-xhr",
|
|
3
|
-
"version": "5.0.0-alpha.
|
|
3
|
+
"version": "5.0.0-alpha.100",
|
|
4
4
|
"description": "Promise-based request library for browser using xhr.",
|
|
5
5
|
"repository": "algolia/algoliasearch-client-javascript",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"author": "Algolia",
|
|
8
|
-
"
|
|
8
|
+
"type": "module",
|
|
9
|
+
"main": "dist/requester-browser-xhr.cjs",
|
|
9
10
|
"module": "dist/requester-browser-xhr.esm.node.js",
|
|
10
11
|
"types": "dist/index.d.ts",
|
|
11
12
|
"files": [
|
|
@@ -14,19 +15,22 @@
|
|
|
14
15
|
"index.ts"
|
|
15
16
|
],
|
|
16
17
|
"scripts": {
|
|
17
|
-
"
|
|
18
|
+
"build": "yarn clean && rollup --config",
|
|
19
|
+
"clean": "rm -rf ./dist || true",
|
|
18
20
|
"test": "jest"
|
|
19
21
|
},
|
|
20
22
|
"dependencies": {
|
|
21
|
-
"@algolia/client-common": "5.0.0-alpha.
|
|
23
|
+
"@algolia/client-common": "5.0.0-alpha.100"
|
|
22
24
|
},
|
|
23
25
|
"devDependencies": {
|
|
24
|
-
"@
|
|
25
|
-
"@
|
|
26
|
-
"jest": "
|
|
27
|
-
"
|
|
28
|
-
"
|
|
29
|
-
"
|
|
26
|
+
"@babel/preset-env": "7.23.9",
|
|
27
|
+
"@babel/preset-typescript": "7.23.3",
|
|
28
|
+
"@types/jest": "29.5.11",
|
|
29
|
+
"@types/node": "20.11.0",
|
|
30
|
+
"jest": "29.7.0",
|
|
31
|
+
"jest-environment-jsdom": "29.7.0",
|
|
32
|
+
"ts-jest": "29.1.2",
|
|
33
|
+
"typescript": "5.3.3",
|
|
30
34
|
"xhr-mock": "2.5.1"
|
|
31
35
|
},
|
|
32
36
|
"engines": {
|
|
@@ -116,14 +116,14 @@ describe('timeout handling', () => {
|
|
|
116
116
|
const response = await requester.send({
|
|
117
117
|
...timeoutRequest,
|
|
118
118
|
connectTimeout: 1000,
|
|
119
|
-
url: 'http://
|
|
119
|
+
url: 'http://localhost:1111/connection_timeout',
|
|
120
120
|
});
|
|
121
121
|
|
|
122
122
|
const now = Date.now();
|
|
123
123
|
|
|
124
124
|
expect(response.content).toBe('Connection timeout');
|
|
125
|
-
expect(now - before).
|
|
126
|
-
expect(now - before).
|
|
125
|
+
expect(now - before).toBeGreaterThanOrEqual(999);
|
|
126
|
+
expect(now - before).toBeLessThanOrEqual(1200);
|
|
127
127
|
});
|
|
128
128
|
|
|
129
129
|
it('connection timeouts with the given 2 seconds connection timeout', async () => {
|
|
@@ -131,14 +131,14 @@ describe('timeout handling', () => {
|
|
|
131
131
|
const response = await requester.send({
|
|
132
132
|
...timeoutRequest,
|
|
133
133
|
connectTimeout: 2000,
|
|
134
|
-
url: 'http://
|
|
134
|
+
url: 'http://localhost:1111/connection_timeout',
|
|
135
135
|
});
|
|
136
136
|
|
|
137
137
|
const now = Date.now();
|
|
138
138
|
|
|
139
139
|
expect(response.content).toBe('Connection timeout');
|
|
140
|
-
expect(now - before).
|
|
141
|
-
expect(now - before).
|
|
140
|
+
expect(now - before).toBeGreaterThanOrEqual(1990);
|
|
141
|
+
expect(now - before).toBeLessThanOrEqual(2200);
|
|
142
142
|
});
|
|
143
143
|
|
|
144
144
|
it("socket timeouts if response don't appears before the timeout with 2 seconds timeout", async () => {
|
|
@@ -153,8 +153,8 @@ describe('timeout handling', () => {
|
|
|
153
153
|
const now = Date.now();
|
|
154
154
|
|
|
155
155
|
expect(response.content).toBe('Socket timeout');
|
|
156
|
-
expect(now - before).
|
|
157
|
-
expect(now - before).
|
|
156
|
+
expect(now - before).toBeGreaterThanOrEqual(1990);
|
|
157
|
+
expect(now - before).toBeLessThanOrEqual(2200);
|
|
158
158
|
});
|
|
159
159
|
|
|
160
160
|
it("socket timeouts if response don't appears before the timeout with 3 seconds timeout", async () => {
|
|
@@ -169,8 +169,8 @@ describe('timeout handling', () => {
|
|
|
169
169
|
const now = Date.now();
|
|
170
170
|
|
|
171
171
|
expect(response.content).toBe('Socket timeout');
|
|
172
|
-
expect(now - before).
|
|
173
|
-
expect(now - before).
|
|
172
|
+
expect(now - before).toBeGreaterThanOrEqual(2999);
|
|
173
|
+
expect(now - before).toBeLessThanOrEqual(3200);
|
|
174
174
|
});
|
|
175
175
|
|
|
176
176
|
it('do not timeouts if response appears before the timeout', async () => {
|
|
@@ -186,8 +186,8 @@ describe('timeout handling', () => {
|
|
|
186
186
|
expect(response.isTimedOut).toBe(false);
|
|
187
187
|
expect(response.status).toBe(200);
|
|
188
188
|
expect(response.content).toBe('{"foo": "bar"}');
|
|
189
|
-
expect(now - before).
|
|
190
|
-
expect(now - before).
|
|
189
|
+
expect(now - before).toBeGreaterThanOrEqual(4999);
|
|
190
|
+
expect(now - before).toBeLessThanOrEqual(5200);
|
|
191
191
|
}, 10000); // This is a long-running test, default server timeout is set to 5000ms
|
|
192
192
|
});
|
|
193
193
|
|