Compare commits

..

80 Commits

Author SHA1 Message Date
b30a7b57d3 3.0.21 2023-03-07 16:04:08 +01:00
240b2fc69a fix(core): update 2023-03-07 16:04:08 +01:00
0e1da04c3c 3.0.20 2023-03-07 11:31:26 +01:00
2a715e5b80 fix(core): update 2023-03-07 11:31:25 +01:00
5ff76b5c9f 3.0.19 2023-03-07 11:30:01 +01:00
76733cc96a fix(core): update 2023-03-07 11:30:00 +01:00
c8f27a1935 3.0.18 2023-02-12 19:08:51 +01:00
3b7378386f fix(core): update 2023-02-12 19:08:50 +01:00
4164458d80 3.0.17 2023-02-12 19:07:30 +01:00
9af837124a fix(core): update 2023-02-12 19:07:30 +01:00
4685856ade 3.0.16 2023-02-12 17:54:01 +01:00
a46af3a431 fix(core): update 2023-02-12 17:54:00 +01:00
ac65f4c85f 3.0.15 2023-02-12 17:46:50 +01:00
d845e19934 fix(core): update 2023-02-12 17:46:49 +01:00
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
f4374942ad 3.0.6 2022-05-29 20:53:16 +02:00
12dc003226 fix(core): update 2022-05-29 20:53:16 +02:00
d4f022a2d9 3.0.5 2022-05-29 20:22:42 +02:00
609c3833b1 fix(core): update 2022-05-29 20:22:42 +02:00
184bf11bd7 3.0.4 2022-05-27 19:50:25 +02:00
ea303b5c26 fix(core): update 2022-05-27 19:50:24 +02:00
b3f6b8db6a 3.0.3 2022-03-25 00:04:24 +01:00
ce9d02562f fix(core): update 2022-03-25 00:04:24 +01:00
e9e974e696 3.0.2 2022-03-24 13:20:35 +01:00
ee361eba4d fix(core): update 2022-03-24 13:20:35 +01:00
1d14312ccc 3.0.1 2022-03-16 16:34:55 +01:00
09ac10c27c fix(core): update 2022-03-16 16:34:55 +01:00
4b7a9d97f3 3.0.0 2022-03-16 16:26:31 +01:00
2dfd75aaea BREAKING CHANGE(core): switch to esm 2022-03-16 16:26:30 +01:00
7e7bb5f739 2.0.16 2022-03-16 16:23:32 +01:00
06caeaf7c8 fix(core): update 2022-03-16 16:23:32 +01:00
dec635f57f 2.0.15 2022-02-10 18:45:22 +01:00
7d28f15f23 fix(core): update 2022-02-10 18:45:22 +01:00
9c3187b2e9 2.0.14 2022-02-10 18:02:08 +01:00
adadd2c100 fix(core): update 2022-02-10 18:02:07 +01:00
1bb08bfb7f 2.0.13 2020-10-15 18:46:21 +00:00
11746c61bd fix(core): update 2020-10-15 18:46:21 +00:00
2b6d9c961c 2.0.12 2020-10-09 10:14:46 +00:00
0b53be66f2 fix(core): update 2020-10-09 10:14:45 +00:00
547b151ee2 2.0.11 2020-10-09 10:05:26 +00:00
9855311739 fix(core): update 2020-10-09 10:05:26 +00:00
1453abcd5f 2.0.10 2020-07-08 02:15:14 +00:00
99afb573cd fix(core): update 2020-07-08 02:15:14 +00:00
94360ff1da 2.0.9 2020-06-25 23:40:30 +00:00
3fd2075c26 fix(core): update 2020-06-25 23:40:29 +00:00
71782672d7 2.0.8 2020-06-25 23:35:00 +00:00
9dec755ea5 fix(core): update 2020-06-25 23:34:59 +00:00
01cd3fbb0b 2.0.7 2020-06-25 22:45:20 +00:00
c5f8e36104 fix(core): update 2020-06-25 22:45:19 +00:00
752bbd74b0 2.0.6 2019-09-27 21:20:06 +02:00
467f8d3254 fix(core): update 2019-09-27 21:20:06 +02:00
9ff7713103 2.0.5 2019-09-27 20:44:43 +02:00
30de4add37 2.0.4 2019-09-27 20:16:29 +02:00
434dbd718a fix(core): update 2019-09-27 20:16:28 +02:00
94cb734f9f 2.0.3 2019-09-27 14:05:43 +02:00
e03edc6bbf 2.0.2 2019-09-27 14:04:52 +02:00
03c4340e4c fix(core): update 2019-09-27 14:04:52 +02:00
f048bd407b 2.0.1 2019-09-26 22:33:16 +02:00
93a43d7ff5 fix(core): update 2019-09-26 22:33:15 +02:00
0d594dbe6b 2.0.0 2019-06-04 15:40:30 +02:00
9a9523cc13 BREAKING CHANGE(core): switch to support binary files in future versions 2019-06-04 15:40:30 +02:00
a8e6462f55 1.0.8 2019-06-04 15:23:48 +02:00
5dfc650f2c fix(core): update 2019-06-04 15:23:47 +02:00
0a423e10cc 1.0.7 2019-02-15 12:39:29 +01:00
35b3ff8021 fix(now supports request body): update 2019-02-15 12:39:29 +01:00
16 changed files with 4906 additions and 2596 deletions

16
.gitignore vendored
View File

@ -1,6 +1,20 @@
.nogit/ .nogit/
node_modules/
# artifacts
coverage/ coverage/
public/ public/
pages/ pages/
# installs
node_modules/
# caches
.yarn/ .yarn/
.cache/
.rpt2_cache
# builds
dist/
dist_*/
# custom

View File

@ -1,119 +1,122 @@
# gitzone standard # gitzone ci_default
image: hosttoday/ht-docker-node:npmci image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
cache: cache:
paths: paths:
- .npmci_cache/ - .npmci_cache/
key: "$CI_BUILD_STAGE" key: '$CI_BUILD_STAGE'
stages: stages:
- security - security
- test - test
- release - release
- metadata - metadata
before_script:
- pnpm install -g pnpm
- pnpm install -g @shipzone/npmci
- npmci npm prepare
# ==================== # ====================
# security stage # security stage
# ==================== # ====================
mirror: # ====================
# security stage
# ====================
auditProductionDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security stage: security
script: script:
- npmci git mirror - npmci command npm config set registry https://registry.npmjs.org
- npmci command pnpm audit --audit-level=high --prod
tags: tags:
- docker - lossless
- notpriv - docker
allow_failure: true
snyk: auditDevDependencies:
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 -g snyk - npmci command pnpm audit --audit-level=high --dev
- npmci command npm install --ignore-scripts
- npmci command snyk test
tags: tags:
- docker - lossless
- notpriv - docker
allow_failure: true
# ==================== # ====================
# test stage # test stage
# ==================== # ====================
testLTS: testStable:
stage: test stage: test
script: script:
- npmci npm prepare - npmci node install stable
- npmci node install lts - npmci npm install
- npmci npm install - npmci npm test
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/ coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- docker - docker
- notpriv
testBuild:
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 build
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/ coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- docker - docker
- notpriv
release: release:
stage: release stage: release
script: script:
- npmci node install stable - npmci node install stable
- npmci npm publish - npmci npm publish
only: only:
- tags - tags
tags: tags:
- docker - lossless
- notpriv - docker
- notpriv
# ==================== # ====================
# metadata stage # metadata stage
# ==================== # ====================
codequality: codequality:
stage: metadata stage: metadata
image: docker:stable
allow_failure: true allow_failure: true
services: only:
- docker:stable-dind - tags
script: script:
- export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/') - npmci command npm install -g typescript
- docker run - npmci npm prepare
--env SOURCE_CODE="$PWD" - npmci npm install
--volume "$PWD":/code
--volume /var/run/docker.sock:/var/run/docker.sock
"registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
artifacts:
paths: [codeclimate.json]
tags: tags:
- docker - lossless
- priv - docker
- priv
trigger: trigger:
stage: metadata stage: metadata
script: script:
- npmci trigger - npmci trigger
only: only:
- tags - tags
tags: tags:
- docker - lossless
- notpriv - docker
- notpriv
pages: pages:
image: hosttoday/ht-docker-node:npmci
stage: metadata stage: metadata
script: script:
- npmci command npm install -g typedoc typescript - npmci node install stable
- npmci npm prepare
- npmci npm install - npmci npm install
- npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/ - npmci command npm run buildDocs
tags: tags:
- lossless
- docker - docker
- notpriv - notpriv
only: only:
@ -121,5 +124,5 @@ pages:
artifacts: artifacts:
expire_in: 1 week expire_in: 1 week
paths: paths:
- public - public
allow_failure: true allow_failure: true

11
.vscode/launch.json vendored Normal file
View File

@ -0,0 +1,11 @@
{
"version": "0.2.0",
"configurations": [
{
"command": "npm test",
"name": "Run npm test",
"request": "launch",
"type": "node-terminal"
}
]
}

26
.vscode/settings.json vendored Normal file
View File

@ -0,0 +1,26 @@
{
"json.schemas": [
{
"fileMatch": ["/npmextra.json"],
"schema": {
"type": "object",
"properties": {
"npmci": {
"type": "object",
"description": "settings for npmci"
},
"gitzone": {
"type": "object",
"description": "settings for gitzone",
"properties": {
"projectType": {
"type": "string",
"enum": ["website", "element", "service", "npm", "wcc"]
}
}
}
}
}
}
]
}

View File

@ -2,5 +2,16 @@
"npmci": { "npmci": {
"npmGlobalTools": [], "npmGlobalTools": [],
"npmAccessLevel": "public" "npmAccessLevel": "public"
},
"gitzone": {
"projectType": "npm",
"module": {
"githost": "gitlab.com",
"gitscope": "pushrocks",
"gitrepo": "webrequest",
"description": "securely request from browsers",
"npmPackagename": "@pushrocks/webrequest",
"license": "MIT"
}
} }
} }

2431
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,28 +1,48 @@
{ {
"name": "@pushrocks/webrequest", "name": "@pushrocks/webrequest",
"version": "1.0.6", "version": "3.0.21",
"private": false, "private": false,
"description": "securely request from browsers", "description": "securely request from browsers",
"main": "dist/index.js", "main": "dist_ts/index.js",
"typings": "dist/index.d.ts", "typings": "dist_ts/index.d.ts",
"type": "module",
"author": "Lossless GmbH", "author": "Lossless GmbH",
"license": "MIT", "license": "MIT",
"scripts": { "scripts": {
"test": "(tstest test/ --web)", "test": "(tstest test/ --web)",
"build": "(tsbuild --web)", "build": "(tsbuild --web --allowimplicitany && tsbundle npm)",
"format": "(gitzone format)" "buildDocs": "tsdoc"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.3", "@gitzone/tsbuild": "^2.1.65",
"@gitzone/tstest": "^1.0.17", "@gitzone/tsbundle": "^2.0.7",
"@pushrocks/smartexpress": "^2.0.4", "@gitzone/tsrun": "^1.2.39",
"@pushrocks/tapbundle": "^3.0.7", "@gitzone/tstest": "^1.0.73",
"@types/node": "^10.12.12", "@pushrocks/smartexpress": "^4.0.21",
"node-fetch": "^2.3.0", "@pushrocks/tapbundle": "^5.0.4",
"tslint": "^5.11.0", "@types/node": "^18.14.6"
"tslint-config-prettier": "^1.15.0"
}, },
"dependencies": { "dependencies": {
"@pushrocks/smartdelay": "^2.0.2" "@adobe/fetch": "^4.0.4",
} "@pushrocks/smartdelay": "^2.0.13",
"@pushrocks/smartenv": "^5.0.2",
"@pushrocks/smartjson": "^5.0.1",
"@pushrocks/smartpromise": "^3.1.7",
"@pushrocks/webstore": "^2.0.5"
},
"files": [
"ts/**/*",
"ts_web/**/*",
"dist/**/*",
"dist_*/**/*",
"dist_ts/**/*",
"dist_ts_web/**/*",
"assets/**/*",
"cli.js",
"npmextra.json",
"readme.md"
],
"browserslist": [
"last 1 chrome versions"
]
} }

4408
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

37
readme.md Normal file
View File

@ -0,0 +1,37 @@
# @pushrocks/webrequest
securely request from browsers
## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/webrequest)
* [gitlab.com (source)](https://gitlab.com/pushrocks/webrequest)
* [github.com (source mirror)](https://github.com/pushrocks/webrequest)
* [docs (typedoc)](https://pushrocks.gitlab.io/webrequest/)
## Status for master
Status Category | Status Badge
-- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/webrequest/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/webrequest/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/webrequest)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/webrequest)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/webrequest)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/webrequest)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/webrequest)](https://lossless.cloud)
## Usage
Use TypeScript for best in class intellisense.
## Contribution
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
For further information read the linked docs at the top of this readme.
## 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)

11
test/test.browser.ts Normal file
View File

@ -0,0 +1,11 @@
import { expect, tap } from '@pushrocks/tapbundle';
import * as webrequest from '../ts/index.js';
tap.test('should run multiendpoint request', async (tools) => {
const response = await new webrequest.WebRequest().request('https://api.signup.software', {
method: 'GET',
});
console.log(JSON.stringify(await response.text()));
});
tap.start();

View File

@ -1,16 +1,5 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@pushrocks/tapbundle';
import * as webrequest from '../ts/index'; import * as webrequest from '../ts/index.js';
import * as fetch from 'node-fetch';
declare global {
namespace NodeJS {
interface Global {
fetch: any;
}
}
}
global.fetch = fetch;
// test dependencies // test dependencies
import * as smartexpress from '@pushrocks/smartexpress'; import * as smartexpress from '@pushrocks/smartexpress';
@ -21,46 +10,69 @@ tap.test('setup test server', async () => {
testServer = new smartexpress.Server({ testServer = new smartexpress.Server({
cors: false, cors: false,
forceSsl: false, forceSsl: false,
port: 2345 port: 2345,
}); });
testServer.addRoute('/apiroute1', new smartexpress.Handler("GET", (req, res) => { testServer.addRoute(
res.status(429); '/apiroute1',
res.end(); new smartexpress.Handler('GET', (req, res) => {
})); res.status(429);
res.end();
})
);
testServer.addRoute('/apiroute2', new smartexpress.Handler("GET", (req, res) => { testServer.addRoute(
res.status(500); '/apiroute2',
res.end(); new smartexpress.Handler('GET', (req, res) => {
})); res.status(500);
res.end();
})
);
testServer.addRoute('/apiroute3', new smartexpress.Handler("GET", (req, res) => { testServer.addRoute(
res.status(200); '/apiroute3',
res.send({ new smartexpress.Handler('GET', (req, res) => {
hithere: 'hi' res.status(200);
}); res.send({
})); hithere: 'hi',
});
})
);
await testServer.start() await testServer.start();
}) });
tap.test('first test', async (tools) => { tap.test('first test', async (tools) => {
const response = await (new webrequest.WebRequest()).request([ 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',
}) ],
{
method: 'GET',
}
)
).json();
console.log(response); const response2 = await new webrequest.WebRequest().getJson('http://localhost:2345/apiroute3');
expect(response).property('hithere').to.equal('hi'); console.log('response 1: ' + JSON.stringify(response));
}) console.log('response 2: ' + JSON.stringify(response2));
tap.test('tear down server', async () => { expect(response).toHaveProperty('hithere'); //.to.equal('hi');
testServer.stop(); expect(response2).toHaveProperty('hithere'); //.to.equal('hi');
}) });
tap.start() tap.test('should cache response', async () => {
const webrequestInstance = new webrequest.WebRequest();
const response = await webrequestInstance.getJson('http://localhost:2345/apiroute3', true);
expect(response).toHaveProperty('hithere');
await testServer.stop();
const response2 = await webrequestInstance.getJson('http://localhost:2345/apiroute3', true);
expect(response2).toHaveProperty('hithere');
});
tap.start();

8
ts/00_commitinfo_data.ts Normal file
View File

@ -0,0 +1,8 @@
/**
* autocreated commitinfo by @pushrocks/commitinfo
*/
export const commitinfo = {
name: '@pushrocks/webrequest',
version: '3.0.21',
description: 'securely request from browsers'
}

View File

@ -1,33 +1,209 @@
import * as plugins from './webrequest.plugins'; 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 neededPolyfillsLoadedDeferred = plugins.smartpromise.defer<{
fetch: typeof fetch;
Response: typeof Response;
AbortController?: typeof AbortController;
helixTimeout?: any;
}>();
/** /**
* gets json * loads the needed polyfill
* @returns
*/ */
async getJson(url: string | string[]) {} public static async loadNeededPolyfills() {
if (this.polyfillStatusEvaluated) {
return this.neededPolyfillsLoadedDeferred.promise;
}
this.polyfillStatusEvaluated = true;
const smartenv = new plugins.smartenv.Smartenv();
if (!smartenv.isBrowser) {
console.log('webrequest using node context.');
this.polyfillStatusEvaluated = true;
const fetchMod = await smartenv.getSafeNodeModule('@adobe/fetch');
this.neededPolyfillsLoadedDeferred.resolve({
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,
});
}
}
public cacheStore = new plugins.webstore.WebStore({
dbName: 'webrequest',
storeName: 'webrequest',
});
public options: IWebrequestContructorOptions;
constructor(public optionsArg: IWebrequestContructorOptions = {}) {
this.options = {
logging: true,
...optionsArg,
};
WebRequest.loadNeededPolyfills();
}
public async getJson(urlArg: string, useCacheArg: boolean = false) {
await WebRequest.neededPolyfillsLoadedDeferred.promise;
const response: Response = await this.request(urlArg, {
method: 'GET',
useCache: useCacheArg,
});
const responseText = await response.text();
const responseResult = plugins.smartjson.parse(responseText);
return responseResult;
}
/** /**
* postJson * postJson
*/ */
postJson() {} public async postJson(urlArg: string, requestBody?: any, useCacheArg: boolean = false) {
await WebRequest.neededPolyfillsLoadedDeferred.promise;
const response: Response = await this.request(urlArg, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: plugins.smartjson.stringify(requestBody),
useCache: useCacheArg,
});
const responseText = await response.text();
const responseResult = plugins.smartjson.parse(responseText);
return responseResult;
}
/** /**
* put js * put js
*/ */
putJson() {} public async putJson(urlArg: string, requestBody?: any, useStoreAsFallback: boolean = false) {
await WebRequest.neededPolyfillsLoadedDeferred.promise;
const response: Response = await this.request(urlArg, {
method: 'PUT',
headers: {
'Content-Type': 'application/json',
},
body: plugins.smartjson.stringify(requestBody),
});
const responseText = await response.text();
const responseResult = plugins.smartjson.parse(responseText);
return responseResult;
}
/** /**
* * put js
*/ */
async request( public async deleteJson(urlArg: string, useStoreAsFallback: boolean = false) {
await WebRequest.neededPolyfillsLoadedDeferred.promise;
const response: Response = await this.request(urlArg, {
headers: {
'Content-Type': 'application/json',
},
method: 'GET',
});
const responseText = await response.text();
const responseResult = plugins.smartjson.parse(responseText);
return responseResult;
}
public async request(
urlArg: string,
optionsArg: {
method: 'GET' | 'POST' | 'PUT' | 'DELETE';
body?: any;
headers?: HeadersInit;
useCache?: boolean;
timeoutMs?: number;
}
) {
optionsArg = {
timeoutMs: 60000,
useCache: false,
...optionsArg,
};
const fetchObject = await WebRequest.neededPolyfillsLoadedDeferred.promise;
let controller: AbortController;
if (optionsArg.timeoutMs) {
if (fetchObject.AbortController) {
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 cacheUsed = false;
if (optionsArg.useCache && (await this.cacheStore.check(urlArg))) {
const responseBuffer: ArrayBuffer = await this.cacheStore.get(urlArg);
cachedResponseDeferred.resolve(new Response(responseBuffer, {}));
} else {
cachedResponseDeferred.resolve(null);
}
let response: Response = await fetchObject
.fetch(urlArg, {
signal: controller ? controller.signal : null,
method: optionsArg.method,
headers: {
...(optionsArg.headers || {}),
},
body: optionsArg.body,
})
.catch(async (err) => {
if (optionsArg.useCache && (await cachedResponseDeferred.promise)) {
cacheUsed = true;
const cachedResponse = cachedResponseDeferred.promise;
return cachedResponse;
} else {
return err;
}
});
if (optionsArg.useCache && (await cachedResponseDeferred.promise) && response.status === 500) {
cacheUsed = true;
response = await cachedResponseDeferred.promise;
}
if (!cacheUsed && optionsArg.useCache && response.status < 300) {
const buffer = await response.clone().arrayBuffer();
await this.cacheStore.set(urlArg, buffer);
}
this.log(`${urlArg} answers with status: ${response.status}`);
return response;
}
/**
* a multi endpoint, fault tolerant request function
*/
public async requestMultiEndpoint(
urlArg: string | string[], urlArg: string | string[],
optionsArg: { optionsArg: {
method: 'GET' | 'POST' | 'PUT' | 'DELETE'; method: 'GET' | 'POST' | 'PUT' | 'DELETE';
body?: any;
headers?: HeadersInit;
} }
) { ): Promise<Response> {
await WebRequest.neededPolyfillsLoadedDeferred.promise;
let allUrls: string[]; let allUrls: string[];
let usedUrlIndex = 0; let usedUrlIndex = 0;
@ -40,50 +216,59 @@ export class WebRequest {
const requestHistory: string[] = []; // keep track of the request history const requestHistory: string[] = []; // keep track of the request history
const doHistoryCheck = async ( // check history for a const doHistoryCheck = async (
// check history for a
historyEntryTypeArg: string historyEntryTypeArg: string
) => { ) => {
requestHistory.push(historyEntryTypeArg); requestHistory.push(historyEntryTypeArg);
if (historyEntryTypeArg === '429') { if (historyEntryTypeArg === '429') {
console.log('got 429, so waiting a little bit.') console.log('got 429, so waiting a little bit.');
await plugins.smartdelay.delayFor( await plugins.smartdelay.delayFor(Math.floor(Math.random() * (2000 - 1000 + 1)) + 1000); // wait between 1 and 10 seconds
Math.floor(Math.random() * (2000 - 1000 +1)) + 1000
); // wait between 1 and 10 seconds
} }
let numOfHistoryType = 0; let numOfHistoryType = 0;
for (const entry of requestHistory) { for (const entry of requestHistory) {
if (entry === historyEntryTypeArg) numOfHistoryType++; if (entry === historyEntryTypeArg) numOfHistoryType++;
} }
if (numOfHistoryType > (2 * allUrls.length * usedUrlIndex)) { if (numOfHistoryType > 2 * allUrls.length * usedUrlIndex) {
usedUrlIndex++; usedUrlIndex++;
} }
}; };
// lets go recursive // lets go recursive
const doRequest = async (urlToUse: string) => { const doRequest = async (urlToUse: string): Promise<any> => {
if (!urlToUse) { if (!urlToUse) {
throw new Error('request failed permanently'); throw new Error('request failed permanently');
} }
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: {
'Content-Type': 'application/json' 'Content-Type': 'application/json',
} ...(optionsArg.headers || {}),
},
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;
} else { } else {
// lets perform a history check to determine failed urls
await doHistoryCheck(response.status.toString()); await doHistoryCheck(response.status.toString());
return await doRequest(allUrls[usedUrlIndex]); // lets fire the request
const result = await doRequest(allUrls[usedUrlIndex]);
return result;
} }
}; };
const finalResponse: Response = await doRequest(urlArg[usedUrlIndex]); const finalResponse: Response = await doRequest(allUrls[usedUrlIndex]);
console.log(finalResponse) return finalResponse;
return JSON.parse(await finalResponse.text()); }
public log(logArg: string) {
if (this.options.logging) {
console.log(logArg);
}
} }
} }

View File

@ -1,5 +1,7 @@
import * as smartdelay from '@pushrocks/smartdelay'; import * as smartdelay from '@pushrocks/smartdelay';
import * as smartenv from '@pushrocks/smartenv';
import * as smartjson from '@pushrocks/smartjson';
import * as smartpromise from '@pushrocks/smartpromise';
import * as webstore from '@pushrocks/webstore';
export { export { smartdelay, smartenv, smartjson, smartpromise, webstore };
smartdelay
}

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"
}