Compare commits
70 Commits
Author | SHA1 | Date | |
---|---|---|---|
d204059313 | |||
00210566d5 | |||
14245b2521 | |||
f0fa91e2db | |||
19a1fe1524 | |||
27770a8ad1 | |||
ab48f11e83 | |||
a0a9e3f824 | |||
c829b06169 | |||
80fa40baf4 | |||
3659b80e1e | |||
770e7d46ea | |||
2a46f2a306 | |||
eae4d09664 | |||
23a2f597fc | |||
c278249c32 | |||
a32c372374 | |||
f98972d9fe | |||
acebe6a381 | |||
7031504852 | |||
3010a1da9a | |||
cdead33be4 | |||
5e23649702 | |||
cc6bd5726a | |||
f487584e80 | |||
443bccd4c9 | |||
f359856b1d | |||
bda04f124b | |||
466187fd52 | |||
d22504317e | |||
6e31d84798 | |||
36472b7306 | |||
e86f14b8d8 | |||
2b9e7f6dd2 | |||
5e4afccf9c | |||
3de7a1a210 | |||
bd2a5eedff | |||
aa18357d75 | |||
9960aff219 | |||
03d884ed59 | |||
9a0ac6fc62 | |||
ad35ea4eb8 | |||
ffb0195f04 | |||
78737c24df | |||
6e276eda00 | |||
021d26a23a | |||
c9c8a1234c | |||
dffabd905f | |||
36f2707141 | |||
b00d674b6f | |||
b09598d465 | |||
acc7b2d46f | |||
16a97a420c | |||
a73c78e54b | |||
1f408b5123 | |||
284f4967f4 | |||
55c80c1403 | |||
7a3e565dbb | |||
6f5d10ccd3 | |||
f1ddab72f6 | |||
376225888c | |||
63e8660f6c | |||
2358b1d48f | |||
9db29bacc2 | |||
5f27b6834c | |||
6717ecf80c | |||
7784f99878 | |||
54a0521f9e | |||
ef25315d59 | |||
74b6bf230f |
18
.gitignore
vendored
18
.gitignore
vendored
@ -1,4 +1,20 @@
|
|||||||
node_modules/
|
.nogit/
|
||||||
|
|
||||||
|
# artifacts
|
||||||
coverage/
|
coverage/
|
||||||
public/
|
public/
|
||||||
pages/
|
pages/
|
||||||
|
|
||||||
|
# installs
|
||||||
|
node_modules/
|
||||||
|
|
||||||
|
# caches
|
||||||
|
.yarn/
|
||||||
|
.cache/
|
||||||
|
.rpt2_cache
|
||||||
|
|
||||||
|
# builds
|
||||||
|
dist/
|
||||||
|
dist_*/
|
||||||
|
|
||||||
|
# custom
|
126
.gitlab-ci.yml
126
.gitlab-ci.yml
@ -1,16 +1,16 @@
|
|||||||
# 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
|
||||||
|
|
||||||
# ====================
|
# ====================
|
||||||
# security stage
|
# security stage
|
||||||
@ -18,102 +18,114 @@ 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
|
||||||
# ====================
|
# ====================
|
||||||
|
|
||||||
testLTS:
|
testStable:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
- npmci node install lts
|
- 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
|
||||||
- notpriv
|
|
||||||
|
|
||||||
testSTABLE:
|
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 npm test
|
- 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
|
||||||
# ====================
|
# ====================
|
||||||
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 tslint typescript
|
||||||
- docker run
|
- npmci npm prepare
|
||||||
--env SOURCE_CODE="$PWD"
|
- npmci npm install
|
||||||
--volume "$PWD":/code
|
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||||
--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 lts
|
||||||
|
- npmci command npm install -g @gitzone/tsdoc
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
|
- npmci command tsdoc
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
only:
|
only:
|
||||||
@ -121,5 +133,5 @@ pages:
|
|||||||
artifacts:
|
artifacts:
|
||||||
expire_in: 1 week
|
expire_in: 1 week
|
||||||
paths:
|
paths:
|
||||||
- public
|
- public
|
||||||
allow_failure: true
|
allow_failure: true
|
||||||
|
29
.vscode/launch.json
vendored
Normal file
29
.vscode/launch.json
vendored
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
{
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
{
|
||||||
|
"name": "current file",
|
||||||
|
"type": "node",
|
||||||
|
"request": "launch",
|
||||||
|
"args": [
|
||||||
|
"${relativeFile}"
|
||||||
|
],
|
||||||
|
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||||
|
"cwd": "${workspaceRoot}",
|
||||||
|
"protocol": "inspector",
|
||||||
|
"internalConsoleOptions": "openOnSessionStart"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "test.ts",
|
||||||
|
"type": "node",
|
||||||
|
"request": "launch",
|
||||||
|
"args": [
|
||||||
|
"test/test.ts"
|
||||||
|
],
|
||||||
|
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||||
|
"cwd": "${workspaceRoot}",
|
||||||
|
"protocol": "inspector",
|
||||||
|
"internalConsoleOptions": "openOnSessionStart"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
26
.vscode/settings.json
vendored
Normal file
26
.vscode/settings.json
vendored
Normal 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"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
69
README.md
69
README.md
@ -1,69 +0,0 @@
|
|||||||
# @pushrocks/smartrequest
|
|
||||||
dropin replacement for request
|
|
||||||
|
|
||||||
## Availabililty and Links
|
|
||||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartrequest)
|
|
||||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartrequest)
|
|
||||||
* [github.com (source mirror)](https://github.com/pushrocks/smartrequest)
|
|
||||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartrequest/)
|
|
||||||
|
|
||||||
## Status for master
|
|
||||||
[](https://gitlab.com/pushrocks/smartrequest/commits/master)
|
|
||||||
[](https://gitlab.com/pushrocks/smartrequest/commits/master)
|
|
||||||
[](https://www.npmjs.com/package/@pushrocks/smartrequest)
|
|
||||||
[](https://snyk.io/test/npm/@pushrocks/smartrequest)
|
|
||||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
||||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
||||||
[](https://prettier.io/)
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
Use TypeScript for best in class instellisense.
|
|
||||||
|
|
||||||
> note: smartrequest uses the **native** node request module under the hood (not the one from npm)
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
import * as smartrequest from 'smartrequest'
|
|
||||||
|
|
||||||
// simple post
|
|
||||||
let options: smartrequest.ISmartRequestOptions = { // typed options
|
|
||||||
headers: {
|
|
||||||
"Content-Type": "application/json"
|
|
||||||
"Authorization": "Bearer token"
|
|
||||||
},
|
|
||||||
requestBody: {
|
|
||||||
key1: 'value1',
|
|
||||||
key2: 3
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
smartrequest.post('https://example.com', options).then(res => {
|
|
||||||
console.log(res.status)
|
|
||||||
console.log(res.body) // if json, body will be parsed automatically
|
|
||||||
}).catch(err => {
|
|
||||||
console.log(err)
|
|
||||||
})
|
|
||||||
|
|
||||||
// also available
|
|
||||||
smartrequest.get(...)
|
|
||||||
smartrequest.put(...)
|
|
||||||
smartrequest.del(...)
|
|
||||||
|
|
||||||
// streaming
|
|
||||||
smartrequest.get('https://example.com/bigfile.mp4', optionsArg, true).then(res => { // third arg = true signals streaming
|
|
||||||
console.log(res.status)
|
|
||||||
res.on('data', data => {
|
|
||||||
// do something with the data chunk here
|
|
||||||
}
|
|
||||||
res.on('end', () => {
|
|
||||||
// do something when things have ended
|
|
||||||
})
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
For further information read the linked docs at the top of this readme.
|
|
||||||
|
|
||||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
||||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
|
||||||
|
|
||||||
[](https://maintainedby.lossless.com)
|
|
@ -7,6 +7,7 @@
|
|||||||
"npmAccessLevel": "public"
|
"npmAccessLevel": "public"
|
||||||
},
|
},
|
||||||
"gitzone": {
|
"gitzone": {
|
||||||
|
"projectType": "npm",
|
||||||
"module": {
|
"module": {
|
||||||
"githost": "gitlab.com",
|
"githost": "gitlab.com",
|
||||||
"gitscope": "pushrocks",
|
"gitscope": "pushrocks",
|
||||||
|
10994
package-lock.json
generated
10994
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
45
package.json
45
package.json
@ -1,13 +1,13 @@
|
|||||||
{
|
{
|
||||||
"name": "@pushrocks/smartrequest",
|
"name": "@pushrocks/smartrequest",
|
||||||
"version": "1.1.15",
|
"version": "1.1.51",
|
||||||
"private": false,
|
"private": false,
|
||||||
"description": "dropin replacement for request",
|
"description": "dropin replacement for request",
|
||||||
"main": "dist/index.js",
|
"main": "dist_ts/index.js",
|
||||||
"typings": "dist/index.d.ts",
|
"typings": "dist_ts/index.d.ts",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(tstest test/)",
|
"test": "(tstest test/ --web)",
|
||||||
"build": "(tsbuild)"
|
"build": "(tsbuild --web)"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@ -23,15 +23,32 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://gitlab.com/pushrocks/smartrequest#README",
|
"homepage": "https://gitlab.com/pushrocks/smartrequest#README",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@pushrocks/smartpromise": "^3.0.2",
|
"@pushrocks/smartpromise": "^3.0.6",
|
||||||
"@types/form-data": "^2.2.1",
|
"agentkeepalive": "^4.1.3",
|
||||||
"form-data": "^2.3.3"
|
"form-data": "^3.0.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@gitzone/tsbuild": "^2.1.8",
|
"@gitzone/tsbuild": "^2.1.25",
|
||||||
"@gitzone/tsrun": "^1.2.5",
|
"@gitzone/tsrun": "^1.2.12",
|
||||||
"@gitzone/tstest": "^1.0.20",
|
"@gitzone/tstest": "^1.0.44",
|
||||||
"@pushrocks/tapbundle": "^3.0.9",
|
"@pushrocks/tapbundle": "^3.2.9",
|
||||||
"@types/node": "^11.13.6"
|
"@types/node": "^14.6.0",
|
||||||
}
|
"tslint": "^6.1.3",
|
||||||
|
"tslint-config-prettier": "^1.18.0"
|
||||||
|
},
|
||||||
|
"files": [
|
||||||
|
"ts/**/*",
|
||||||
|
"ts_web/**/*",
|
||||||
|
"dist/**/*",
|
||||||
|
"dist_*/**/*",
|
||||||
|
"dist_ts/**/*",
|
||||||
|
"dist_ts_web/**/*",
|
||||||
|
"assets/**/*",
|
||||||
|
"cli.js",
|
||||||
|
"npmextra.json",
|
||||||
|
"readme.md"
|
||||||
|
],
|
||||||
|
"browserslist": [
|
||||||
|
"last 1 chrome versions"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
96
readme.md
Normal file
96
readme.md
Normal file
@ -0,0 +1,96 @@
|
|||||||
|
# @pushrocks/smartrequest
|
||||||
|
dropin replacement for request
|
||||||
|
|
||||||
|
## Availabililty and Links
|
||||||
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartrequest)
|
||||||
|
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartrequest)
|
||||||
|
* [github.com (source mirror)](https://github.com/pushrocks/smartrequest)
|
||||||
|
* [docs (typedoc)](https://pushrocks.gitlab.io/smartrequest/)
|
||||||
|
|
||||||
|
## Status for master
|
||||||
|
|
||||||
|
Status Category | Status Badge
|
||||||
|
-- | --
|
||||||
|
GitLab Pipelines | [](https://lossless.cloud)
|
||||||
|
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||||
|
npm | [](https://lossless.cloud)
|
||||||
|
Snyk | [](https://lossless.cloud)
|
||||||
|
TypeScript Support | [](https://lossless.cloud)
|
||||||
|
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||||
|
Code Style | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||||
|
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||||
|
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Use TypeScript for best in class instellisense.
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- supports http
|
||||||
|
- supports https
|
||||||
|
- supports unix socks
|
||||||
|
- supports formData
|
||||||
|
- supports file uploads
|
||||||
|
- supports best practice keepAlive
|
||||||
|
- dedicated functions for working with JSON request/response cycles
|
||||||
|
- written in TypeScript
|
||||||
|
- continuously updated
|
||||||
|
- uses node native http and https modules
|
||||||
|
- used in modules like @pushrocks/smartproxy and @apiglobal/typedrequest
|
||||||
|
- commercial support available at [https://lossless.support](https://lossless.support)
|
||||||
|
|
||||||
|
> note: smartrequest uses the **native** node http/https modules under the hood (not the bloated one from npm)
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
import * as smartrequest from 'smartrequest'
|
||||||
|
|
||||||
|
// simple post
|
||||||
|
const options: smartrequest.ISmartRequestOptions = { // typed options
|
||||||
|
headers: {
|
||||||
|
"Content-Type": "application/json"
|
||||||
|
"Authorization": "Bearer token"
|
||||||
|
},
|
||||||
|
requestBody: JSON.stringify({
|
||||||
|
key1: 'value1',
|
||||||
|
key2: 3
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
smartrequest.request('https://example.com', options).then(res => {
|
||||||
|
console.log(res.status)
|
||||||
|
console.log(res.body) // if json, body will be parsed automatically
|
||||||
|
}).catch(err => {
|
||||||
|
console.log(err)
|
||||||
|
})
|
||||||
|
|
||||||
|
// dedicated JSON methods are available:
|
||||||
|
smartrequest.getJson(...)
|
||||||
|
smartrequest.postJson(...)
|
||||||
|
smartrequest.putJson(...)
|
||||||
|
smartrequest.delJson(...)
|
||||||
|
|
||||||
|
// streaming
|
||||||
|
smartrequest.get('https://example.com/bigfile.mp4', optionsArg, true).then(res => { // third arg = true signals streaming
|
||||||
|
console.log(res.status)
|
||||||
|
res.on('data', data => {
|
||||||
|
// do something with the data chunk here
|
||||||
|
}
|
||||||
|
res.on('end', () => {
|
||||||
|
// do something when things have ended
|
||||||
|
})
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
|
||||||
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||||
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||||
|
|
||||||
|
[](https://maintainedby.lossless.com)
|
12
test/test.ts
12
test/test.ts
@ -6,6 +6,12 @@ tap.test('should request a html document over https', async () => {
|
|||||||
await expect(smartrequest.getJson('https://encrypted.google.com/'))
|
await expect(smartrequest.getJson('https://encrypted.google.com/'))
|
||||||
.to.eventually.property('body')
|
.to.eventually.property('body')
|
||||||
.be.a('string');
|
.be.a('string');
|
||||||
|
await expect(smartrequest.getJson('https://encrypted.google.com/'))
|
||||||
|
.to.eventually.property('body')
|
||||||
|
.be.a('string');
|
||||||
|
await expect(smartrequest.getJson('https://encrypted.google.com/'))
|
||||||
|
.to.eventually.property('body')
|
||||||
|
.be.a('string');
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('should request a JSON document over https', async () => {
|
tap.test('should request a JSON document over https', async () => {
|
||||||
@ -15,7 +21,7 @@ tap.test('should request a JSON document over https', async () => {
|
|||||||
.equal(1);
|
.equal(1);
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('should post a JSON document over http', async () => {
|
tap.skip.test('should post a JSON document over http', async () => {
|
||||||
await expect(smartrequest.postJson('http://md5.jsontest.com/?text=example_text'))
|
await expect(smartrequest.postJson('http://md5.jsontest.com/?text=example_text'))
|
||||||
.to.eventually.property('body')
|
.to.eventually.property('body')
|
||||||
.property('md5')
|
.property('md5')
|
||||||
@ -28,8 +34,8 @@ tap.skip.test('should deal with unix socks', async () => {
|
|||||||
{
|
{
|
||||||
headers: {
|
headers: {
|
||||||
'Content-Type': 'application/json',
|
'Content-Type': 'application/json',
|
||||||
Host: 'docker.sock'
|
Host: 'docker.sock',
|
||||||
}
|
},
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
console.log(socketResponse.body);
|
console.log(socketResponse.body);
|
||||||
|
@ -8,20 +8,24 @@ export const getBinary = async (
|
|||||||
domainArg: string,
|
domainArg: string,
|
||||||
optionsArg: interfaces.ISmartRequestOptions = {}
|
optionsArg: interfaces.ISmartRequestOptions = {}
|
||||||
) => {
|
) => {
|
||||||
|
optionsArg = {
|
||||||
|
...optionsArg,
|
||||||
|
autoJsonParse: false,
|
||||||
|
};
|
||||||
const done = plugins.smartpromise.defer();
|
const done = plugins.smartpromise.defer();
|
||||||
const response = await request(domainArg, optionsArg, true);
|
const response = await request(domainArg, optionsArg, true);
|
||||||
const data = [];
|
const data = [];
|
||||||
|
|
||||||
response
|
response
|
||||||
.on('data', function(chunk) {
|
.on('data', function (chunk) {
|
||||||
data.push(chunk);
|
data.push(chunk);
|
||||||
})
|
})
|
||||||
.on('end', function() {
|
.on('end', function () {
|
||||||
//at this point data is an array of Buffers
|
//at this point data is an array of Buffers
|
||||||
//so Buffer.concat() can make us a new Buffer
|
//so Buffer.concat() can make us a new Buffer
|
||||||
//of all of them together
|
//of all of them together
|
||||||
const buffer = Buffer.concat(data);
|
const buffer = Buffer.concat(data);
|
||||||
response.body = buffer.toString('binary');
|
response.body = buffer;
|
||||||
done.resolve();
|
done.resolve();
|
||||||
});
|
});
|
||||||
await done.promise;
|
await done.promise;
|
||||||
|
@ -8,16 +8,38 @@ import { request } from './smartrequest.request';
|
|||||||
export interface IFormField {
|
export interface IFormField {
|
||||||
name: string;
|
name: string;
|
||||||
type: 'string' | 'filePath' | 'Buffer';
|
type: 'string' | 'filePath' | 'Buffer';
|
||||||
payload: string;
|
payload: string | Buffer;
|
||||||
|
fileName?: string;
|
||||||
|
contentType?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
const appendFormField = async (formDataArg: plugins.formData, formDataField: IFormField) => {
|
const appendFormField = async (formDataArg: plugins.formData, formDataField: IFormField) => {
|
||||||
if (formDataField.type === 'filePath') {
|
switch (formDataField.type) {
|
||||||
let fileData = plugins.fs.readFileSync(plugins.path.join(process.cwd(), formDataField.payload));
|
case 'string':
|
||||||
formDataArg.append('file', fileData, {
|
formDataArg.append(formDataField.name, formDataField.payload);
|
||||||
filename: 'upload.pdf',
|
break;
|
||||||
contentType: 'application/pdf'
|
case 'filePath':
|
||||||
});
|
if (typeof formDataField.payload !== 'string') {
|
||||||
|
throw new Error(
|
||||||
|
`Payload for key ${
|
||||||
|
formDataField.name
|
||||||
|
} must be of type string. Got ${typeof formDataField.payload} instead.`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
const fileData = plugins.fs.readFileSync(
|
||||||
|
plugins.path.join(process.cwd(), formDataField.payload)
|
||||||
|
);
|
||||||
|
formDataArg.append('file', fileData, {
|
||||||
|
filename: formDataField.fileName ? formDataField.fileName : 'upload.pdf',
|
||||||
|
contentType: 'application/pdf',
|
||||||
|
});
|
||||||
|
break;
|
||||||
|
case 'Buffer':
|
||||||
|
formDataArg.append(formDataField.name, formDataField.payload, {
|
||||||
|
filename: formDataField.fileName ? formDataField.fileName : 'upload.pdf',
|
||||||
|
contentType: formDataField.contentType ? formDataField.contentType : 'application/pdf',
|
||||||
|
});
|
||||||
|
break;
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -30,14 +52,15 @@ export const postFormData = async (
|
|||||||
for (const formField of payloadArg) {
|
for (const formField of payloadArg) {
|
||||||
await appendFormField(form, formField);
|
await appendFormField(form, formField);
|
||||||
}
|
}
|
||||||
const requestOptions = Object.assign({}, optionsArg, {
|
const requestOptions = {
|
||||||
|
...optionsArg,
|
||||||
method: 'POST',
|
method: 'POST',
|
||||||
headers: {
|
headers: {
|
||||||
...optionsArg.headers,
|
...optionsArg.headers,
|
||||||
...form.getHeaders()
|
...form.getHeaders(),
|
||||||
},
|
},
|
||||||
requestBody: form
|
requestBody: form,
|
||||||
});
|
};
|
||||||
|
|
||||||
// lets fire the actual request for sending the formdata
|
// lets fire the actual request for sending the formdata
|
||||||
const response = await request(urlArg, requestOptions);
|
const response = await request(urlArg, requestOptions);
|
||||||
|
@ -2,5 +2,7 @@ import * as plugins from './smartrequest.plugins';
|
|||||||
import * as https from 'https';
|
import * as https from 'https';
|
||||||
|
|
||||||
export interface ISmartRequestOptions extends https.RequestOptions {
|
export interface ISmartRequestOptions extends https.RequestOptions {
|
||||||
|
keepAlive?: boolean;
|
||||||
requestBody?: any;
|
requestBody?: any;
|
||||||
|
autoJsonParse?: boolean;
|
||||||
}
|
}
|
||||||
|
@ -14,7 +14,7 @@ export const getJson = async (
|
|||||||
) => {
|
) => {
|
||||||
optionsArg.method = 'GET';
|
optionsArg.method = 'GET';
|
||||||
optionsArg.headers = {
|
optionsArg.headers = {
|
||||||
...optionsArg.headers
|
...optionsArg.headers,
|
||||||
};
|
};
|
||||||
let response = await request(domainArg, optionsArg);
|
let response = await request(domainArg, optionsArg);
|
||||||
return response;
|
return response;
|
||||||
@ -37,7 +37,7 @@ export const postJson = async (
|
|||||||
// assign the right Content-Type, leaving all other headers in place
|
// assign the right Content-Type, leaving all other headers in place
|
||||||
optionsArg.headers = {
|
optionsArg.headers = {
|
||||||
...optionsArg.headers,
|
...optionsArg.headers,
|
||||||
'Content-Type': 'application/json'
|
'Content-Type': 'application/json',
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
let response = await request(domainArg, optionsArg);
|
let response = await request(domainArg, optionsArg);
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
import * as formData from 'form-data';
|
import formData from 'form-data';
|
||||||
import * as fs from 'fs';
|
import * as fs from 'fs';
|
||||||
import * as http from 'http';
|
import * as http from 'http';
|
||||||
import * as https from 'https';
|
import * as https from 'https';
|
||||||
@ -8,3 +8,8 @@ import * as url from 'url';
|
|||||||
import * as smartpromise from '@pushrocks/smartpromise';
|
import * as smartpromise from '@pushrocks/smartpromise';
|
||||||
|
|
||||||
export { formData, http, https, fs, path, url, smartpromise };
|
export { formData, http, https, fs, path, url, smartpromise };
|
||||||
|
|
||||||
|
// third party scope
|
||||||
|
import * as agentkeepalive from 'agentkeepalive';
|
||||||
|
|
||||||
|
export { agentkeepalive };
|
||||||
|
@ -1,4 +1,3 @@
|
|||||||
import * as https from 'https';
|
|
||||||
import * as plugins from './smartrequest.plugins';
|
import * as plugins from './smartrequest.plugins';
|
||||||
import * as interfaces from './smartrequest.interfaces';
|
import * as interfaces from './smartrequest.interfaces';
|
||||||
|
|
||||||
@ -9,19 +8,24 @@ export interface IExtendedIncomingMessage extends IncomingMessage {
|
|||||||
}
|
}
|
||||||
|
|
||||||
const buildUtf8Response = (
|
const buildUtf8Response = (
|
||||||
incomingMessageArg: IncomingMessage
|
incomingMessageArg: IncomingMessage,
|
||||||
|
autoJsonParse = true
|
||||||
): Promise<IExtendedIncomingMessage> => {
|
): Promise<IExtendedIncomingMessage> => {
|
||||||
let done = plugins.smartpromise.defer<IExtendedIncomingMessage>();
|
const done = plugins.smartpromise.defer<IExtendedIncomingMessage>();
|
||||||
// Continuously update stream with data
|
// Continuously update stream with data
|
||||||
let body = '';
|
let body = '';
|
||||||
incomingMessageArg.on('data', function(chunkArg) {
|
incomingMessageArg.on('data', (chunkArg) => {
|
||||||
body += chunkArg;
|
body += chunkArg;
|
||||||
});
|
});
|
||||||
|
|
||||||
incomingMessageArg.on('end', function() {
|
incomingMessageArg.on('end', () => {
|
||||||
try {
|
if (autoJsonParse) {
|
||||||
(incomingMessageArg as IExtendedIncomingMessage).body = JSON.parse(body);
|
try {
|
||||||
} catch (err) {
|
(incomingMessageArg as IExtendedIncomingMessage).body = JSON.parse(body);
|
||||||
|
} catch (err) {
|
||||||
|
(incomingMessageArg as IExtendedIncomingMessage).body = body;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
(incomingMessageArg as IExtendedIncomingMessage).body = body;
|
(incomingMessageArg as IExtendedIncomingMessage).body = body;
|
||||||
}
|
}
|
||||||
done.resolve(incomingMessageArg as IExtendedIncomingMessage);
|
done.resolve(incomingMessageArg as IExtendedIncomingMessage);
|
||||||
@ -46,79 +50,132 @@ const parseSocketPathAndRoute = (stringToParseArg: string) => {
|
|||||||
const result = parseRegex.exec(stringToParseArg);
|
const result = parseRegex.exec(stringToParseArg);
|
||||||
return {
|
return {
|
||||||
socketPath: result[1],
|
socketPath: result[1],
|
||||||
path: result[2]
|
path: result[2],
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* a custom http agent to make sure we can set custom keepAlive options for speedy subsequent calls
|
||||||
|
*/
|
||||||
|
const httpAgent = new plugins.agentkeepalive.default();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* a custom http agent to make sure we can set custom keepAlive options for speedy subsequent calls
|
||||||
|
*/
|
||||||
|
const httpAgentKeepAliveFalse = new plugins.http.Agent({
|
||||||
|
maxFreeSockets: 0,
|
||||||
|
keepAlive: false,
|
||||||
|
keepAliveMsecs: 0,
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* a custom https agent to make sure we can set custom keepAlive options for speedy subsequent calls
|
||||||
|
*/
|
||||||
|
const httpsAgent = new plugins.agentkeepalive.HttpsAgent();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* a custom https agent to make sure we can set custom keepAlive options for speedy subsequent calls
|
||||||
|
*/
|
||||||
|
const httpsAgentKeepAliveFalse = new plugins.https.Agent({
|
||||||
|
maxFreeSockets: 0,
|
||||||
|
keepAlive: false,
|
||||||
|
keepAliveMsecs: 0,
|
||||||
|
});
|
||||||
|
|
||||||
export let request = async (
|
export let request = async (
|
||||||
domainArg: string,
|
urlArg: string,
|
||||||
optionsArg: interfaces.ISmartRequestOptions = {},
|
optionsArg: interfaces.ISmartRequestOptions = {},
|
||||||
streamArg: boolean = false
|
responseStreamArg: boolean = false,
|
||||||
|
requestDataFunc: (req: plugins.http.ClientRequest) => void = null
|
||||||
): Promise<IExtendedIncomingMessage> => {
|
): Promise<IExtendedIncomingMessage> => {
|
||||||
let done = plugins.smartpromise.defer<any>();
|
const done = plugins.smartpromise.defer<any>();
|
||||||
|
|
||||||
|
// merge options
|
||||||
|
const defaultOptions: interfaces.ISmartRequestOptions = {
|
||||||
|
// agent: agent,
|
||||||
|
autoJsonParse: true,
|
||||||
|
keepAlive: true,
|
||||||
|
};
|
||||||
|
|
||||||
|
optionsArg = {
|
||||||
|
...defaultOptions,
|
||||||
|
...optionsArg,
|
||||||
|
};
|
||||||
|
|
||||||
// parse url
|
// parse url
|
||||||
let parsedUrl: plugins.url.Url;
|
const parsedUrl = plugins.url.parse(urlArg);
|
||||||
parsedUrl = plugins.url.parse(domainArg);
|
|
||||||
optionsArg.hostname = parsedUrl.hostname;
|
optionsArg.hostname = parsedUrl.hostname;
|
||||||
if (parsedUrl.port) {
|
if (parsedUrl.port) {
|
||||||
optionsArg.port = parseInt(parsedUrl.port);
|
optionsArg.port = parseInt(parsedUrl.port, 10);
|
||||||
}
|
}
|
||||||
optionsArg.path = parsedUrl.path;
|
optionsArg.path = parsedUrl.path;
|
||||||
|
|
||||||
// determine if unixsock
|
// determine if unixsock
|
||||||
if (testForUnixSock(domainArg)) {
|
if (testForUnixSock(urlArg)) {
|
||||||
const detailedUnixPath = parseSocketPathAndRoute(optionsArg.path);
|
const detailedUnixPath = parseSocketPathAndRoute(optionsArg.path);
|
||||||
optionsArg.socketPath = detailedUnixPath.socketPath;
|
optionsArg.socketPath = detailedUnixPath.socketPath;
|
||||||
optionsArg.path = detailedUnixPath.path;
|
optionsArg.path = detailedUnixPath.path;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TODO: support tcp sockets
|
||||||
|
|
||||||
// lets determine the request module to use
|
// lets determine the request module to use
|
||||||
const requestModule = (() => {
|
const requestModule = (() => {
|
||||||
if (parsedUrl.protocol === 'https:') {
|
switch (true) {
|
||||||
return plugins.https;
|
case parsedUrl.protocol === 'https:' && optionsArg.keepAlive:
|
||||||
} else if (parsedUrl.protocol === 'http:') {
|
optionsArg.agent = httpsAgent;
|
||||||
return plugins.http;
|
return plugins.https;
|
||||||
} else {
|
case parsedUrl.protocol === 'https:' && !optionsArg.keepAlive:
|
||||||
throw new Error(`unsupported protocol: ${parsedUrl.protocol}`);
|
optionsArg.agent = httpsAgentKeepAliveFalse;
|
||||||
|
return plugins.https;
|
||||||
|
case parsedUrl.protocol === 'http:' && optionsArg.keepAlive:
|
||||||
|
optionsArg.agent = httpAgent;
|
||||||
|
return plugins.http;
|
||||||
|
case parsedUrl.protocol === 'http:' && !optionsArg.keepAlive:
|
||||||
|
optionsArg.agent = httpAgentKeepAliveFalse;
|
||||||
|
return plugins.http;
|
||||||
}
|
}
|
||||||
})() as typeof plugins.https;
|
})() as typeof plugins.https;
|
||||||
|
|
||||||
|
if (!requestModule) {
|
||||||
|
console.error(`The request to ${urlArg} is missing a viable protocol. Must be http or https`);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
// lets perform the actual request
|
// lets perform the actual request
|
||||||
let request = requestModule.request(optionsArg);
|
const requestToFire = requestModule.request(optionsArg, async (response) => {
|
||||||
|
if (responseStreamArg) {
|
||||||
|
done.resolve(response);
|
||||||
|
} else {
|
||||||
|
const builtResponse = await buildUtf8Response(response, optionsArg.autoJsonParse);
|
||||||
|
done.resolve(builtResponse);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
// lets write the requestBody
|
// lets write the requestBody
|
||||||
if (optionsArg.requestBody) {
|
if (optionsArg.requestBody) {
|
||||||
if (!(optionsArg.requestBody instanceof plugins.formData)) {
|
if (optionsArg.requestBody instanceof plugins.formData) {
|
||||||
|
optionsArg.requestBody.pipe(requestToFire).on('finish', (event) => {
|
||||||
|
requestToFire.end();
|
||||||
|
});
|
||||||
|
} else {
|
||||||
if (typeof optionsArg.requestBody !== 'string') {
|
if (typeof optionsArg.requestBody !== 'string') {
|
||||||
optionsArg.requestBody = JSON.stringify(optionsArg.requestBody);
|
optionsArg.requestBody = JSON.stringify(optionsArg.requestBody);
|
||||||
}
|
}
|
||||||
request.write(optionsArg.requestBody);
|
requestToFire.write(optionsArg.requestBody);
|
||||||
request.end();
|
requestToFire.end();
|
||||||
} else if (optionsArg.requestBody instanceof plugins.formData) {
|
|
||||||
optionsArg.requestBody.pipe(request).on('finish', event => {
|
|
||||||
request.end();
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
} else if (requestDataFunc) {
|
||||||
|
requestDataFunc(requestToFire);
|
||||||
} else {
|
} else {
|
||||||
request.end();
|
requestToFire.end();
|
||||||
}
|
}
|
||||||
|
|
||||||
// lets handle an error
|
// lets handle an error
|
||||||
request.on('error', e => {
|
requestToFire.on('error', (e) => {
|
||||||
console.error(e);
|
console.error(e);
|
||||||
});
|
});
|
||||||
|
|
||||||
// lets handle the response
|
|
||||||
request.on('response', async response => {
|
|
||||||
if (streamArg) {
|
|
||||||
done.resolve(response);
|
|
||||||
} else {
|
|
||||||
const builtResponse = await buildUtf8Response(response);
|
|
||||||
done.resolve(builtResponse);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
const result = await done.promise;
|
const result = await done.promise;
|
||||||
return result;
|
return result;
|
||||||
};
|
};
|
||||||
|
Reference in New Issue
Block a user