Compare commits
14 Commits
Author | SHA1 | Date | |
---|---|---|---|
c8f27a1935 | |||
3b7378386f | |||
4164458d80 | |||
9af837124a | |||
4685856ade | |||
a46af3a431 | |||
ac65f4c85f | |||
d845e19934 | |||
9bba1ef94c | |||
1e58f77142 | |||
f882b0a90f | |||
0f1240d0db | |||
089bb9282f | |||
73c10c1db8 |
@ -13,31 +13,24 @@ stages:
|
|||||||
- metadata
|
- metadata
|
||||||
|
|
||||||
before_script:
|
before_script:
|
||||||
- npm install -g @shipzone/npmci
|
- pnpm install -g pnpm
|
||||||
|
- pnpm install -g @shipzone/npmci
|
||||||
|
- npmci npm prepare
|
||||||
|
|
||||||
# ====================
|
# ====================
|
||||||
# security stage
|
# security stage
|
||||||
# ====================
|
# ====================
|
||||||
mirror:
|
# ====================
|
||||||
stage: security
|
# security stage
|
||||||
script:
|
# ====================
|
||||||
- npmci git mirror
|
|
||||||
only:
|
|
||||||
- tags
|
|
||||||
tags:
|
|
||||||
- lossless
|
|
||||||
- docker
|
|
||||||
- notpriv
|
|
||||||
|
|
||||||
auditProductionDependencies:
|
auditProductionDependencies:
|
||||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
- npmci command npm install --production --ignore-scripts
|
- npmci command pnpm audit --audit-level=high --prod
|
||||||
- npmci command npm config set registry https://registry.npmjs.org
|
|
||||||
- npmci command npm audit --audit-level=high --only=prod --production
|
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
allow_failure: true
|
allow_failure: true
|
||||||
|
|
||||||
@ -45,11 +38,10 @@ auditDevDependencies:
|
|||||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
|
||||||
- npmci command npm install --ignore-scripts
|
|
||||||
- npmci command npm config set registry https://registry.npmjs.org
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
- npmci command npm audit --audit-level=high --only=dev
|
- npmci command pnpm audit --audit-level=high --dev
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
allow_failure: true
|
allow_failure: true
|
||||||
|
|
||||||
@ -60,7 +52,6 @@ auditDevDependencies:
|
|||||||
testStable:
|
testStable:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
|
||||||
- npmci node install stable
|
- npmci node install stable
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci npm test
|
- npmci npm test
|
||||||
@ -71,10 +62,9 @@ testStable:
|
|||||||
testBuild:
|
testBuild:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
|
||||||
- npmci node install stable
|
- npmci node install stable
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci command npm run build
|
- npmci npm build
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
@ -100,10 +90,9 @@ codequality:
|
|||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
script:
|
script:
|
||||||
- npmci command npm install -g tslint typescript
|
- npmci command npm install -g typescript
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
|
||||||
tags:
|
tags:
|
||||||
- lossless
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
@ -123,11 +112,9 @@ trigger:
|
|||||||
pages:
|
pages:
|
||||||
stage: metadata
|
stage: metadata
|
||||||
script:
|
script:
|
||||||
- npmci node install lts
|
- npmci node install stable
|
||||||
- npmci command npm install -g @gitzone/tsdoc
|
|
||||||
- npmci npm prepare
|
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci command tsdoc
|
- npmci command npm run buildDocs
|
||||||
tags:
|
tags:
|
||||||
- lossless
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
|
14558
package-lock.json
generated
14558
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
10
package.json
10
package.json
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@pushrocks/webrequest",
|
"name": "@pushrocks/webrequest",
|
||||||
"version": "3.0.11",
|
"version": "3.0.18",
|
||||||
"private": false,
|
"private": false,
|
||||||
"description": "securely request from browsers",
|
"description": "securely request from browsers",
|
||||||
"main": "dist_ts/index.js",
|
"main": "dist_ts/index.js",
|
||||||
@ -10,18 +10,20 @@
|
|||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(tstest test/ --web)",
|
"test": "(tstest test/ --web)",
|
||||||
"build": "(tsbuild --web --allowimplicitany && tsbundle npm)"
|
"build": "(tsbuild --web --allowimplicitany && tsbundle npm)",
|
||||||
|
"buildDocs": "tsdoc"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@gitzone/tsbuild": "^2.1.65",
|
"@gitzone/tsbuild": "^2.1.65",
|
||||||
"@gitzone/tsbundle": "^2.0.7",
|
"@gitzone/tsbundle": "^2.0.7",
|
||||||
|
"@gitzone/tsrun": "^1.2.39",
|
||||||
"@gitzone/tstest": "^1.0.73",
|
"@gitzone/tstest": "^1.0.73",
|
||||||
"@pushrocks/smartexpress": "^4.0.21",
|
"@pushrocks/smartexpress": "^4.0.21",
|
||||||
"@pushrocks/tapbundle": "^5.0.4",
|
"@pushrocks/tapbundle": "^5.0.4",
|
||||||
"@types/node": "^18.6.4"
|
"@types/node": "^18.13.0"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@adobe/helix-fetch": "^3.1.1",
|
"@adobe/fetch": "^4.0.1",
|
||||||
"@pushrocks/smartdelay": "^2.0.13",
|
"@pushrocks/smartdelay": "^2.0.13",
|
||||||
"@pushrocks/smartenv": "^5.0.2",
|
"@pushrocks/smartenv": "^5.0.2",
|
||||||
"@pushrocks/smartjson": "^5.0.1",
|
"@pushrocks/smartjson": "^5.0.1",
|
||||||
|
4370
pnpm-lock.yaml
generated
Normal file
4370
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
@ -21,7 +21,6 @@ Code Style | [](htt
|
|||||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||||
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
@ -33,7 +32,6 @@ We are always happy for code contributions. If you are not the code contributing
|
|||||||
|
|
||||||
For further information read the linked docs at the top of this readme.
|
For further information read the linked docs at the top of this readme.
|
||||||
|
|
||||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
## Legal
|
||||||
|
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
|
||||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||||
|
|
||||||
[](https://maintainedby.lossless.com)
|
|
||||||
|
@ -2,15 +2,10 @@ import { expect, tap } from '@pushrocks/tapbundle';
|
|||||||
import * as webrequest from '../ts/index.js';
|
import * as webrequest from '../ts/index.js';
|
||||||
|
|
||||||
tap.test('should run multiendpoint request', async (tools) => {
|
tap.test('should run multiendpoint request', async (tools) => {
|
||||||
const done = tools.defer();
|
const response = await new webrequest.WebRequest().request('https://api.signup.software', {
|
||||||
const response = await new webrequest.WebRequest()
|
method: 'GET',
|
||||||
.requestMultiEndpoint(['https://lossless.com'], {
|
});
|
||||||
method: 'GET',
|
console.log(JSON.stringify(await response.text()));
|
||||||
})
|
|
||||||
.catch((e) => {
|
|
||||||
done.resolve();
|
|
||||||
});
|
|
||||||
await done.promise;
|
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.start();
|
tap.start();
|
||||||
|
23
test/test.ts
23
test/test.ts
@ -43,14 +43,19 @@ tap.test('setup test server', async () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
tap.test('first test', async (tools) => {
|
tap.test('first test', async (tools) => {
|
||||||
const response = await (await new webrequest.WebRequest().requestMultiEndpoint([
|
const response = await (
|
||||||
'http://localhost:2345/apiroute1',
|
await new webrequest.WebRequest().requestMultiEndpoint(
|
||||||
'http://localhost:2345/apiroute2',
|
[
|
||||||
'http://localhost:2345/apiroute4',
|
'http://localhost:2345/apiroute1',
|
||||||
'http://localhost:2345/apiroute3',
|
'http://localhost:2345/apiroute2',
|
||||||
], {
|
'http://localhost:2345/apiroute4',
|
||||||
method: 'GET'
|
'http://localhost:2345/apiroute3',
|
||||||
})).json();
|
],
|
||||||
|
{
|
||||||
|
method: 'GET',
|
||||||
|
}
|
||||||
|
)
|
||||||
|
).json();
|
||||||
|
|
||||||
const response2 = await new webrequest.WebRequest().getJson('http://localhost:2345/apiroute3');
|
const response2 = await new webrequest.WebRequest().getJson('http://localhost:2345/apiroute3');
|
||||||
|
|
||||||
@ -68,6 +73,6 @@ tap.test('should cache response', async () => {
|
|||||||
await testServer.stop();
|
await testServer.stop();
|
||||||
const response2 = await webrequestInstance.getJson('http://localhost:2345/apiroute3', true);
|
const response2 = await webrequestInstance.getJson('http://localhost:2345/apiroute3', true);
|
||||||
expect(response2).toHaveProperty('hithere');
|
expect(response2).toHaveProperty('hithere');
|
||||||
})
|
});
|
||||||
|
|
||||||
tap.start();
|
tap.start();
|
||||||
|
@ -3,6 +3,6 @@
|
|||||||
*/
|
*/
|
||||||
export const commitinfo = {
|
export const commitinfo = {
|
||||||
name: '@pushrocks/webrequest',
|
name: '@pushrocks/webrequest',
|
||||||
version: '3.0.11',
|
version: '3.0.18',
|
||||||
description: 'securely request from browsers'
|
description: 'securely request from browsers'
|
||||||
}
|
}
|
||||||
|
99
ts/index.ts
99
ts/index.ts
@ -10,10 +10,16 @@ export interface IWebrequestContructorOptions {
|
|||||||
export class WebRequest {
|
export class WebRequest {
|
||||||
private static polyfillStatusEvaluated = false;
|
private static polyfillStatusEvaluated = false;
|
||||||
private static neededPolyfillsLoadedDeferred = plugins.smartpromise.defer<{
|
private static neededPolyfillsLoadedDeferred = plugins.smartpromise.defer<{
|
||||||
fetch: typeof fetch,
|
fetch: typeof fetch;
|
||||||
Response: typeof Response,
|
Response: typeof Response;
|
||||||
AbortController: typeof AbortController
|
AbortController?: typeof AbortController;
|
||||||
|
helixTimeout?: any;
|
||||||
}>();
|
}>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* loads the needed polyfill
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
public static async loadNeededPolyfills() {
|
public static async loadNeededPolyfills() {
|
||||||
if (this.polyfillStatusEvaluated) {
|
if (this.polyfillStatusEvaluated) {
|
||||||
return this.neededPolyfillsLoadedDeferred.promise;
|
return this.neededPolyfillsLoadedDeferred.promise;
|
||||||
@ -21,18 +27,22 @@ export class WebRequest {
|
|||||||
this.polyfillStatusEvaluated = true;
|
this.polyfillStatusEvaluated = true;
|
||||||
const smartenv = new plugins.smartenv.Smartenv();
|
const smartenv = new plugins.smartenv.Smartenv();
|
||||||
if (!smartenv.isBrowser) {
|
if (!smartenv.isBrowser) {
|
||||||
|
console.log('webrequest using node context.');
|
||||||
this.polyfillStatusEvaluated = true;
|
this.polyfillStatusEvaluated = true;
|
||||||
const fetchMod = await smartenv.getSafeNodeModule('@adobe/helix-fetch');
|
const fetchMod = await smartenv.getSafeNodeModule('@adobe/fetch');
|
||||||
this.neededPolyfillsLoadedDeferred.resolve({
|
this.neededPolyfillsLoadedDeferred.resolve({
|
||||||
fetch: fetchMod.fetch,
|
fetch: fetchMod.fetch,
|
||||||
Response: fetchMod.Response,
|
Response: fetchMod.Response,
|
||||||
AbortController: fetchMod.AbortSignal
|
helixTimeout: fetchMod.timeoutSignal,
|
||||||
});
|
});
|
||||||
} else {
|
} else {
|
||||||
|
console.log('webrequest using browser context.');
|
||||||
this.neededPolyfillsLoadedDeferred.resolve({
|
this.neededPolyfillsLoadedDeferred.resolve({
|
||||||
fetch: globalThis.fetch,
|
fetch: (...args) => {
|
||||||
|
return fetch(...args);
|
||||||
|
},
|
||||||
Response: globalThis.Response,
|
Response: globalThis.Response,
|
||||||
AbortController: globalThis.AbortController
|
AbortController: globalThis.AbortController,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -47,8 +57,8 @@ export class WebRequest {
|
|||||||
constructor(public optionsArg: IWebrequestContructorOptions = {}) {
|
constructor(public optionsArg: IWebrequestContructorOptions = {}) {
|
||||||
this.options = {
|
this.options = {
|
||||||
logging: true,
|
logging: true,
|
||||||
...optionsArg
|
...optionsArg,
|
||||||
}
|
};
|
||||||
WebRequest.loadNeededPolyfills();
|
WebRequest.loadNeededPolyfills();
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -69,8 +79,11 @@ export class WebRequest {
|
|||||||
public async postJson(urlArg: string, requestBody?: any, useCacheArg: boolean = false) {
|
public async postJson(urlArg: string, requestBody?: any, useCacheArg: boolean = false) {
|
||||||
await WebRequest.neededPolyfillsLoadedDeferred.promise;
|
await WebRequest.neededPolyfillsLoadedDeferred.promise;
|
||||||
const response: Response = await this.request(urlArg, {
|
const response: Response = await this.request(urlArg, {
|
||||||
body: plugins.smartjson.stringify(requestBody),
|
|
||||||
method: 'POST',
|
method: 'POST',
|
||||||
|
headers: {
|
||||||
|
'Content-Type': 'application/json',
|
||||||
|
},
|
||||||
|
body: plugins.smartjson.stringify(requestBody),
|
||||||
useCache: useCacheArg,
|
useCache: useCacheArg,
|
||||||
});
|
});
|
||||||
const responseText = await response.text();
|
const responseText = await response.text();
|
||||||
@ -84,8 +97,11 @@ export class WebRequest {
|
|||||||
public async putJson(urlArg: string, requestBody?: any, useStoreAsFallback: boolean = false) {
|
public async putJson(urlArg: string, requestBody?: any, useStoreAsFallback: boolean = false) {
|
||||||
await WebRequest.neededPolyfillsLoadedDeferred.promise;
|
await WebRequest.neededPolyfillsLoadedDeferred.promise;
|
||||||
const response: Response = await this.request(urlArg, {
|
const response: Response = await this.request(urlArg, {
|
||||||
body: plugins.smartjson.stringify(requestBody),
|
|
||||||
method: 'PUT',
|
method: 'PUT',
|
||||||
|
headers: {
|
||||||
|
'Content-Type': 'application/json',
|
||||||
|
},
|
||||||
|
body: plugins.smartjson.stringify(requestBody),
|
||||||
});
|
});
|
||||||
const responseText = await response.text();
|
const responseText = await response.text();
|
||||||
const responseResult = plugins.smartjson.parse(responseText);
|
const responseResult = plugins.smartjson.parse(responseText);
|
||||||
@ -98,6 +114,9 @@ export class WebRequest {
|
|||||||
public async deleteJson(urlArg: string, useStoreAsFallback: boolean = false) {
|
public async deleteJson(urlArg: string, useStoreAsFallback: boolean = false) {
|
||||||
await WebRequest.neededPolyfillsLoadedDeferred.promise;
|
await WebRequest.neededPolyfillsLoadedDeferred.promise;
|
||||||
const response: Response = await this.request(urlArg, {
|
const response: Response = await this.request(urlArg, {
|
||||||
|
headers: {
|
||||||
|
'Content-Type': 'application/json',
|
||||||
|
},
|
||||||
method: 'GET',
|
method: 'GET',
|
||||||
});
|
});
|
||||||
const responseText = await response.text();
|
const responseText = await response.text();
|
||||||
@ -115,38 +134,52 @@ export class WebRequest {
|
|||||||
timeoutMs?: number;
|
timeoutMs?: number;
|
||||||
}
|
}
|
||||||
) {
|
) {
|
||||||
|
optionsArg = {
|
||||||
|
timeoutMs: 60000,
|
||||||
|
useCache: false,
|
||||||
|
...optionsArg,
|
||||||
|
};
|
||||||
|
|
||||||
const fetchObject = await WebRequest.neededPolyfillsLoadedDeferred.promise;
|
const fetchObject = await WebRequest.neededPolyfillsLoadedDeferred.promise;
|
||||||
const controller = new fetchObject.AbortController();
|
let controller: AbortController;
|
||||||
if (optionsArg.timeoutMs) {
|
if (optionsArg.timeoutMs) {
|
||||||
plugins.smartdelay.delayFor(optionsArg.timeoutMs).then(() => {
|
if (fetchObject.AbortController) {
|
||||||
controller.abort();
|
controller = new fetchObject.AbortController();
|
||||||
});
|
plugins.smartdelay.delayFor(optionsArg.timeoutMs).then(() => {
|
||||||
|
controller.abort();
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
controller = {
|
||||||
|
signal: fetchObject.helixTimeout(optionsArg.timeoutMs),
|
||||||
|
} as any;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
let cachedResponseDeferred = plugins.smartpromise.defer<Response>();
|
let cachedResponseDeferred = plugins.smartpromise.defer<Response>();
|
||||||
let cacheUsed = false;
|
let cacheUsed = false;
|
||||||
if (optionsArg.useCache && await this.cacheStore.check(urlArg)) {
|
if (optionsArg.useCache && (await this.cacheStore.check(urlArg))) {
|
||||||
const responseBuffer: ArrayBuffer = await this.cacheStore.get(urlArg);
|
const responseBuffer: ArrayBuffer = await this.cacheStore.get(urlArg);
|
||||||
cachedResponseDeferred.resolve(new Response(responseBuffer, {}));
|
cachedResponseDeferred.resolve(new Response(responseBuffer, {}));
|
||||||
} else {
|
} else {
|
||||||
cachedResponseDeferred.resolve(null);
|
cachedResponseDeferred.resolve(null);
|
||||||
}
|
}
|
||||||
let response: Response = await fetchObject.fetch(urlArg, {
|
let response: Response = await fetchObject
|
||||||
signal: controller.signal,
|
.fetch(urlArg, {
|
||||||
method: optionsArg.method,
|
signal: controller ? controller.signal : null,
|
||||||
headers: {
|
method: optionsArg.method,
|
||||||
'Content-Type': 'application/json',
|
headers: {
|
||||||
...(optionsArg.headers || {}),
|
...(optionsArg.headers || {}),
|
||||||
},
|
},
|
||||||
body: optionsArg.body,
|
body: optionsArg.body,
|
||||||
}).catch(async (err) => {
|
})
|
||||||
if (optionsArg.useCache && (await cachedResponseDeferred.promise)) {
|
.catch(async (err) => {
|
||||||
cacheUsed = true;
|
if (optionsArg.useCache && (await cachedResponseDeferred.promise)) {
|
||||||
const cachedResponse = cachedResponseDeferred.promise;
|
cacheUsed = true;
|
||||||
return cachedResponse;
|
const cachedResponse = cachedResponseDeferred.promise;
|
||||||
} else {
|
return cachedResponse;
|
||||||
return err;
|
} else {
|
||||||
}
|
return err;
|
||||||
});
|
}
|
||||||
|
});
|
||||||
if (optionsArg.useCache && (await cachedResponseDeferred.promise) && response.status === 500) {
|
if (optionsArg.useCache && (await cachedResponseDeferred.promise) && response.status === 500) {
|
||||||
cacheUsed = true;
|
cacheUsed = true;
|
||||||
response = await cachedResponseDeferred.promise;
|
response = await cachedResponseDeferred.promise;
|
||||||
|
Reference in New Issue
Block a user