Compare commits

..

16 Commits

Author SHA1 Message Date
9bba1ef94c 3.0.14 2023-02-11 18:19:03 +01:00
1e58f77142 fix(core): update 2023-02-11 18:19:02 +01:00
f882b0a90f 3.0.13 2022-08-19 17:49:47 +02:00
0f1240d0db fix(core): update 2022-08-19 17:49:47 +02:00
089bb9282f 3.0.12 2022-08-05 12:21:35 +02:00
73c10c1db8 fix(core): update 2022-08-05 12:21:34 +02:00
59c0c4e60c 3.0.11 2022-08-05 11:53:42 +02:00
8e079cfdfd fix(core): update 2022-08-05 11:53:42 +02:00
d410517c8b 3.0.10 2022-08-02 18:19:27 +02:00
c02340813f fix(core): update 2022-08-02 18:19:27 +02:00
0d3f636af3 3.0.9 2022-07-28 16:23:11 +02:00
a64d47c02e fix(core): update 2022-07-28 16:23:11 +02:00
e6279c00f1 3.0.8 2022-07-27 17:32:54 +02:00
8d59494a75 fix(core): update 2022-07-27 17:32:54 +02:00
d1f3117376 3.0.7 2022-05-29 21:29:43 +02:00
14cca11c55 fix(core): update 2022-05-29 21:29:42 +02:00
8 changed files with 10104 additions and 1813 deletions

7321
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,6 +1,6 @@
{ {
"name": "@pushrocks/webrequest", "name": "@pushrocks/webrequest",
"version": "3.0.6", "version": "3.0.14",
"private": false, "private": false,
"description": "securely request from browsers", "description": "securely request from browsers",
"main": "dist_ts/index.js", "main": "dist_ts/index.js",
@ -13,22 +13,20 @@
"build": "(tsbuild --web --allowimplicitany && tsbundle npm)" "build": "(tsbuild --web --allowimplicitany && tsbundle npm)"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.63", "@gitzone/tsbuild": "^2.1.65",
"@gitzone/tsbundle": "^2.0.4", "@gitzone/tsbundle": "^2.0.7",
"@gitzone/tstest": "^1.0.71", "@gitzone/tstest": "^1.0.73",
"@pushrocks/smartexpress": "^4.0.5", "@pushrocks/smartexpress": "^4.0.21",
"@pushrocks/tapbundle": "^5.0.3", "@pushrocks/tapbundle": "^5.0.4",
"@types/node": "^17.0.36", "@types/node": "^18.6.4"
"tslint": "^6.1.3",
"tslint-config-prettier": "^1.18.0"
}, },
"dependencies": { "dependencies": {
"@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": "^4.0.6", "@pushrocks/smartjson": "^5.0.1",
"@pushrocks/smartpromise": "^3.1.7", "@pushrocks/smartpromise": "^3.1.7",
"@pushrocks/webstore": "^2.0.3", "@pushrocks/webstore": "^2.0.5"
"node-fetch": "^3.2.4"
}, },
"files": [ "files": [
"ts/**/*", "ts/**/*",

4390
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

View File

@ -2,15 +2,11 @@ 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() const response = await new webrequest.WebRequest()
.requestMultiEndpoint(['https://lossless.com'], { .request('https://api.signup.software', {
method: 'GET', method: 'GET',
}) })
.catch((e) => { console.log(JSON.stringify(await response.text()));
done.resolve();
});
await done.promise;
}); });
tap.start(); tap.start();

View File

@ -3,6 +3,6 @@
*/ */
export const commitinfo = { export const commitinfo = {
name: '@pushrocks/webrequest', name: '@pushrocks/webrequest',
version: '3.0.6', version: '3.0.14',
description: 'securely request from browsers' description: 'securely request from browsers'
} }

View File

@ -1,11 +1,25 @@
import * as plugins from './webrequest.plugins.js'; import * as plugins from './webrequest.plugins.js';
export interface IWebrequestContructorOptions {
logging?: boolean;
}
/** /**
* web request * web request
*/ */
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,
Response: typeof Response,
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;
@ -13,12 +27,24 @@ 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('node-fetch'); const fetchMod = await smartenv.getSafeNodeModule('@adobe/helix-fetch');
globalThis.Response = fetchMod.Response; this.neededPolyfillsLoadedDeferred.resolve({
globalThis.fetch = fetchMod.default; fetch: fetchMod.fetch,
Response: fetchMod.Response,
helixTimeout: fetchMod.timeoutSignal,
});
} else {
console.log('webrequest using browser context.');
this.neededPolyfillsLoadedDeferred.resolve({
fetch: (...args) => {
return fetch(...args);
},
Response: globalThis.Response,
AbortController: globalThis.AbortController
});
} }
this.neededPolyfillsLoadedDeferred.resolve();
} }
public cacheStore = new plugins.webstore.WebStore({ public cacheStore = new plugins.webstore.WebStore({
@ -26,7 +52,13 @@ export class WebRequest {
storeName: 'webrequest', storeName: 'webrequest',
}); });
constructor() { public options: IWebrequestContructorOptions;
constructor(public optionsArg: IWebrequestContructorOptions = {}) {
this.options = {
logging: true,
...optionsArg
}
WebRequest.loadNeededPolyfills(); WebRequest.loadNeededPolyfills();
} }
@ -47,9 +79,12 @@ 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',
useCache: useCacheArg headers: {
'Content-Type': 'application/json',
},
body: plugins.smartjson.stringify(requestBody),
useCache: useCacheArg,
}); });
const responseText = await response.text(); const responseText = await response.text();
const responseResult = plugins.smartjson.parse(responseText); const responseResult = plugins.smartjson.parse(responseText);
@ -62,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);
@ -76,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();
@ -93,31 +134,43 @@ export class WebRequest {
timeoutMs?: number; timeoutMs?: number;
} }
) { ) {
await WebRequest.neededPolyfillsLoadedDeferred.promise; optionsArg = {
const controller = new AbortController(); timeoutMs: 60000,
useCache: false,
...optionsArg,
};
const fetchObject = await WebRequest.neededPolyfillsLoadedDeferred.promise;
let controller: AbortController;
if (optionsArg.timeoutMs) { if (optionsArg.timeoutMs) {
if (fetchObject.AbortController) {
controller = new fetchObject.AbortController();
plugins.smartdelay.delayFor(optionsArg.timeoutMs).then(() => { plugins.smartdelay.delayFor(optionsArg.timeoutMs).then(() => {
controller.abort(); 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 && 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);
} }
const response: Response = await fetch(urlArg, { let response: Response = await fetchObject.fetch(urlArg, {
signal: controller.signal, signal: controller ? controller.signal : null,
method: optionsArg.method, method: optionsArg.method,
headers: { headers: {
'Content-Type': 'application/json',
...(optionsArg.headers || {}), ...(optionsArg.headers || {}),
}, },
body: optionsArg.body, body: optionsArg.body,
}).catch(async err => { }).catch(async (err) => {
if (optionsArg.useCache && await cachedResponseDeferred.promise) { if (optionsArg.useCache && (await cachedResponseDeferred.promise)) {
cacheUsed = true; cacheUsed = true;
const cachedResponse = cachedResponseDeferred.promise; const cachedResponse = cachedResponseDeferred.promise;
return cachedResponse; return cachedResponse;
@ -125,11 +178,15 @@ export class WebRequest {
return err; return err;
} }
}); });
if (optionsArg.useCache && (await cachedResponseDeferred.promise) && response.status === 500) {
cacheUsed = true;
response = await cachedResponseDeferred.promise;
}
if (!cacheUsed && optionsArg.useCache && response.status < 300) { if (!cacheUsed && optionsArg.useCache && response.status < 300) {
const buffer = await response.clone().arrayBuffer(); const buffer = await response.clone().arrayBuffer();
await this.cacheStore.set(urlArg, buffer); await this.cacheStore.set(urlArg, buffer);
} }
console.log(`${urlArg} answers with status: ${response.status}`); this.log(`${urlArg} answers with status: ${response.status}`);
return response; return response;
} }
@ -181,7 +238,7 @@ export class WebRequest {
if (!urlToUse) { if (!urlToUse) {
throw new Error('request failed permanently'); throw new Error('request failed permanently');
} }
console.log(`Getting ${urlToUse} with method ${optionsArg.method}`); this.log(`Getting ${urlToUse} with method ${optionsArg.method}`);
const response = await fetch(urlToUse, { const response = await fetch(urlToUse, {
method: optionsArg.method, method: optionsArg.method,
headers: { headers: {
@ -190,7 +247,7 @@ export class WebRequest {
}, },
body: optionsArg.body, body: optionsArg.body,
}); });
console.log(`${urlToUse} answers with status: ${response.status}`); this.log(`${urlToUse} answers with status: ${response.status}`);
if (response.status >= 200 && response.status < 300) { if (response.status >= 200 && response.status < 300) {
return response; return response;
@ -206,4 +263,10 @@ export class WebRequest {
const finalResponse: Response = await doRequest(allUrls[usedUrlIndex]); const finalResponse: Response = await doRequest(allUrls[usedUrlIndex]);
return finalResponse; return finalResponse;
} }
public log(logArg: string) {
if (this.options.logging) {
console.log(logArg);
}
}
} }

10
tsconfig.json Normal file
View File

@ -0,0 +1,10 @@
{
"compilerOptions": {
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "ES2022",
"moduleResolution": "nodenext",
"esModuleInterop": true
}
}

View File

@ -1,17 +0,0 @@
{
"extends": ["tslint:latest", "tslint-config-prettier"],
"rules": {
"semicolon": [true, "always"],
"no-console": false,
"ordered-imports": false,
"object-literal-sort-keys": false,
"member-ordering": {
"options":{
"order": [
"static-method"
]
}
}
},
"defaultSeverity": "warning"
}