Compare commits

...

16 Commits

Author SHA1 Message Date
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
11 changed files with 25824 additions and 1242 deletions

4
.gitignore vendored
View File

@ -15,8 +15,6 @@ node_modules/
# builds # builds
dist/ dist/
dist_web/ dist_*/
dist_serve/
dist_ts_web/
# custom # custom

View File

@ -3,14 +3,14 @@ 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
# ==================== # ====================
# security stage # security stage
@ -18,21 +18,36 @@ stages:
mirror: mirror:
stage: security stage: security
script: script:
- npmci git mirror - npmci git mirror
only:
- tags
tags: tags:
- docker - lossless
- notpriv - docker
- notpriv
snyk: auditProductionDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security stage: security
script: script:
- npmci npm prepare - npmci npm prepare
- npmci command npm install -g snyk - npmci command npm install --production --ignore-scripts
- npmci command npm install --ignore-scripts - npmci command npm config set registry https://registry.npmjs.org
- npmci command snyk test - npmci command npm audit --audit-level=high --only=prod --production
tags: tags:
- docker - docker
- notpriv
auditDevDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=dev
tags:
- docker
allow_failure: true
# ==================== # ====================
# test stage # test stage
@ -41,37 +56,36 @@ snyk:
testStable: testStable:
stage: test stage: test
script: script:
- npmci npm prepare - npmci npm prepare
- npmci node install stable - npmci node install stable
- 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
- priv
testBuild: testBuild:
stage: test stage: test
script: script:
- npmci npm prepare - npmci npm prepare
- npmci node install stable - npmci node install stable
- npmci npm install - npmci npm install
- npmci command npm run build - npmci command npm run build
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
@ -79,35 +93,39 @@ release:
codequality: codequality:
stage: metadata stage: metadata
allow_failure: true allow_failure: true
only:
- tags
script: script:
- npmci command npm install -g tslint typescript - npmci command npm install -g tslint typescript
- npmci npm prepare
- npmci npm install - npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts" - npmci command "tslint -c tslint.json ./ts/**/*.ts"
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-dbase:npmci
services:
- docker:stable-dind
stage: metadata stage: metadata
script: script:
- npmci node install lts
- npmci command npm install -g @gitzone/tsdoc - npmci command npm install -g @gitzone/tsdoc
- npmci npm prepare - npmci npm prepare
- npmci npm install - npmci npm install
- npmci command tsdoc - npmci command tsdoc
tags: tags:
- lossless
- docker - docker
- notpriv - notpriv
only: only:
@ -115,5 +133,5 @@ pages:
artifacts: artifacts:
expire_in: 1 week expire_in: 1 week
paths: paths:
- public - public
allow_failure: true allow_failure: true

View File

@ -11,7 +11,13 @@
}, },
"gitzone": { "gitzone": {
"type": "object", "type": "object",
"description": "settings for gitzone" "description": "settings for gitzone",
"properties": {
"projectType": {
"type": "string",
"enum": ["website", "element", "service", "npm", "wcc"]
}
}
} }
} }
} }

View File

@ -4,6 +4,7 @@
"npmAccessLevel": "public" "npmAccessLevel": "public"
}, },
"gitzone": { "gitzone": {
"projectType": "npm",
"module": { "module": {
"githost": "gitlab.com", "githost": "gitlab.com",
"gitscope": "pushrocks", "gitscope": "pushrocks",

26775
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,39 +1,46 @@
{ {
"name": "@pushrocks/webrequest", "name": "@pushrocks/webrequest",
"version": "2.0.6", "version": "2.0.14",
"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",
"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 && tsbundle npm)",
"format": "(gitzone format)" "format": "(gitzone format)"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.17", "@gitzone/tsbuild": "^2.1.29",
"@gitzone/tstest": "^1.0.24", "@gitzone/tsbundle": "^1.0.89",
"@pushrocks/smartexpress": "^3.0.40", "@gitzone/tstest": "^1.0.60",
"@pushrocks/tapbundle": "^3.0.13", "@pushrocks/smartexpress": "^3.0.108",
"@types/node": "^12.7.8", "@pushrocks/tapbundle": "^4.0.3",
"node-fetch": "^2.6.0", "@types/node": "^17.0.17",
"tslint": "^5.20.0", "tslint": "^6.1.3",
"tslint-config-prettier": "^1.18.0" "tslint-config-prettier": "^1.18.0"
}, },
"dependencies": { "dependencies": {
"@pushrocks/smartdelay": "^2.0.3" "@pushrocks/smartdelay": "^2.0.13",
"@pushrocks/smartenv": "^4.0.16",
"@pushrocks/smartjson": "^4.0.6",
"node-fetch": "^2.6.1"
}, },
"files": [ "files": [
"ts/*", "ts/**/*",
"ts_web/*", "ts_web/**/*",
"dist/*", "dist/**/*",
"dist_web/*", "dist_*/**/*",
"dist_ts_web/*", "dist_ts/**/*",
"assets/*", "dist_ts_web/**/*",
"assets/**/*",
"cli.js", "cli.js",
"npmextra.json", "npmextra.json",
"readme.md" "readme.md"
],
"browserslist": [
"last 1 chrome versions"
] ]
} }

View File

@ -8,16 +8,29 @@ securely request from browsers
* [docs (typedoc)](https://pushrocks.gitlab.io/webrequest/) * [docs (typedoc)](https://pushrocks.gitlab.io/webrequest/)
## Status for master ## Status for master
[![build status](https://gitlab.com/pushrocks/webrequest/badges/master/build.svg)](https://gitlab.com/pushrocks/webrequest/commits/master)
[![coverage report](https://gitlab.com/pushrocks/webrequest/badges/master/coverage.svg)](https://gitlab.com/pushrocks/webrequest/commits/master) Status Category | Status Badge
[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/webrequest.svg)](https://www.npmjs.com/package/@pushrocks/webrequest) -- | --
[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/webrequest/badge.svg)](https://snyk.io/test/npm/@pushrocks/webrequest) GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/webrequest/badges/master/pipeline.svg)](https://lossless.cloud)
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/) GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/webrequest/badges/master/coverage.svg)](https://lossless.cloud)
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/) npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/webrequest)](https://lossless.cloud)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/) 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)
Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
## Usage ## 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. For further information read the linked docs at the top of this readme.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)

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

@ -0,0 +1,16 @@
import { expect, tap } from '@pushrocks/tapbundle';
import * as webrequest from '../ts/index';
tap.test('first test', async (tools) => {
const done = tools.defer();
const response = await new webrequest.WebRequest()
.request(['https://lossless.com'], {
method: 'GET',
})
.catch((e) => {
done.resolve();
});
await done.promise;
});
tap.start();

View File

@ -1,15 +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';
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';
@ -20,7 +10,7 @@ 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( testServer.addRoute(
@ -44,7 +34,7 @@ tap.test('setup test server', async () => {
new smartexpress.Handler('GET', (req, res) => { new smartexpress.Handler('GET', (req, res) => {
res.status(200); res.status(200);
res.send({ res.send({
hithere: 'hi' hithere: 'hi',
}); });
}) })
); );
@ -52,25 +42,21 @@ tap.test('setup test server', async () => {
await testServer.start(); await testServer.start();
}); });
tap.test('first test', async tools => { tap.test('first test', async (tools) => {
const response = await new webrequest.WebRequest().getJson([ const response = await new webrequest.WebRequest().getJson([
'http://localhost:2345/apiroute1', 'http://localhost:2345/apiroute1',
'http://localhost:2345/apiroute2', 'http://localhost:2345/apiroute2',
'http://localhost:2345/apiroute4', 'http://localhost:2345/apiroute4',
'http://localhost:2345/apiroute3' 'http://localhost:2345/apiroute3',
]); ]);
const response2 = await new webrequest.WebRequest().getJson('http://localhost:2345/apiroute3'); const response2 = await new webrequest.WebRequest().getJson('http://localhost:2345/apiroute3');
console.log(response); console.log('response 1: ' + JSON.stringify(response));
console.log(response2) console.log('response 2: ' + JSON.stringify(response2));
expect(response) expect(response).toHaveProperty('hithere') //.to.equal('hi');
.property('hithere') expect(response2).toHaveProperty('hithere') //.to.equal('hi');
.to.equal('hi');
expect(response2)
.property('hithere')
.to.equal('hi');
}); });
tap.test('tear down server', async () => { tap.test('tear down server', async () => {

View File

@ -4,11 +4,26 @@ import * as plugins from './webrequest.plugins';
* web request * web request
*/ */
export class WebRequest { export class WebRequest {
private static polyfillsLoaded = false;
public static loadNeededPolyfills() {
const smartenv = new plugins.smartenv.Smartenv();
if (!smartenv.isBrowser && !this.polyfillsLoaded) {
this.polyfillsLoaded = true;
globalThis.fetch = smartenv.getSafeNodeModule('node-fetch');
}
}
constructor() {
WebRequest.loadNeededPolyfills();
}
public async getJson(urlArg: string | string[]) { public async getJson(urlArg: string | string[]) {
const response: Response = await this.request(urlArg, { const response: Response = await this.request(urlArg, {
method: 'GET' method: 'GET',
}); });
return response.json(); const responseText = await response.text();
const responseResult = plugins.smartjson.parse(responseText);
return responseResult;
} }
/** /**
@ -16,10 +31,12 @@ export class WebRequest {
*/ */
public async postJson(urlArg: string, requestBody?: any) { public async postJson(urlArg: string, requestBody?: any) {
const response: Response = await this.request(urlArg, { const response: Response = await this.request(urlArg, {
body: JSON.stringify(requestBody), body: plugins.smartjson.stringify(requestBody),
method: 'POST' method: 'POST',
}); });
return response.json(); const responseText = await response.text();
const responseResult = plugins.smartjson.parse(responseText);
return responseResult;
} }
/** /**
@ -27,10 +44,12 @@ export class WebRequest {
*/ */
public async putJson(urlArg: string, requestBody?: any) { public async putJson(urlArg: string, requestBody?: any) {
const response: Response = await this.request(urlArg, { const response: Response = await this.request(urlArg, {
body: JSON.stringify(requestBody), body: plugins.smartjson.stringify(requestBody),
method: 'PUT' method: 'PUT',
}); });
return response.json(); const responseText = await response.text();
const responseResult = plugins.smartjson.parse(responseText);
return responseResult;
} }
/** /**
@ -38,9 +57,11 @@ export class WebRequest {
*/ */
public async deleteJson(urlArg: string) { public async deleteJson(urlArg: string) {
const response: Response = await this.request(urlArg, { const response: Response = await this.request(urlArg, {
method: 'GET' method: 'GET',
}); });
return response.json(); const responseText = await response.text();
const responseResult = plugins.smartjson.parse(responseText);
return responseResult;
} }
/** /**
@ -51,6 +72,7 @@ export class WebRequest {
optionsArg: { optionsArg: {
method: 'GET' | 'POST' | 'PUT' | 'DELETE'; method: 'GET' | 'POST' | 'PUT' | 'DELETE';
body?: any; body?: any;
headers?: HeadersInit;
} }
): Promise<Response> { ): Promise<Response> {
let allUrls: string[]; let allUrls: string[];
@ -85,7 +107,7 @@ export class WebRequest {
}; };
// 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');
} }
@ -93,23 +115,25 @@ export class WebRequest {
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 body: optionsArg.body,
}); });
console.log(`${urlToUse} answers with status: ${response.status}`); console.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());
// tslint:disable-next-line: no-return-await // lets fire the request
return await doRequest(allUrls[usedUrlIndex]); const result = await doRequest(allUrls[usedUrlIndex]);
return result;
} }
}; };
const finalResponse: Response = await doRequest(allUrls[usedUrlIndex]); const finalResponse: Response = await doRequest(allUrls[usedUrlIndex]);
console.log(finalResponse);
return finalResponse; return finalResponse;
} }
} }

View File

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