2.0.21

.gitea/workflows/default_nottags.yaml

@@ -0,0 +1,66 @@
+name: Default (not tags)
+
+on:
+  push:
+    tags-ignore:
+      - '**'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install pnpm and npmci
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+
+      - name: Run npm prepare
+        run: npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build

.gitea/workflows/default_tags.yaml

@@ -0,0 +1,124 @@
+name: Default (tags)
+
+on:
+  push:
+    tags:
+      - '*'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build
+
+  release:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Release
+        run: |
+          npmci node install stable
+          npmci npm publish
+
+  metadata:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+    continue-on-error: true
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Code quality
+        run: |
+          npmci command npm install -g typescript
+          npmci npm install
+
+      - name: Trigger
+        run: npmci trigger
+
+      - name: Build docs and upload artifacts
+        run: |
+          npmci node install stable
+          npmci npm install
+          pnpm install -g @git.zone/tsdoc
+          npmci command tsdoc
+        continue-on-error: true

npmextra.json

@@ -10,10 +10,10 @@
     "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
-      "gitscope": "pushrocks",
+      "gitscope": "push.rocks",
       "gitrepo": "smartrequest",
       "description": "dropin replacement for request",
-      "npmPackagename": "@pushrocks/smartrequest",
+      "npmPackagename": "@push.rocks/smartrequest",
       "license": "MIT"
     }
   }

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "@pushrocks/smartrequest",
+  "name": "@push.rocks/smartrequest",
-  "version": "2.0.0",
+  "version": "2.0.21",
   "private": false,
   "description": "dropin replacement for request",
   "main": "dist_ts/index.js",
@@ -13,7 +13,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@gitlab.com/pushrocks/smartrequest.git"
+    "url": "git+https://gitlab.com/push.rocks/smartrequest.git"
   },
   "keywords": [
     "request"
@@ -21,23 +21,21 @@
   "author": "Lossless GmbH",
   "license": "MIT",
   "bugs": {
-    "url": "https://gitlab.com/pushrocks/smartrequest/issues"
+    "url": "https://gitlab.com/push.rocks/smartrequest/issues"
   },
-  "homepage": "https://gitlab.com/pushrocks/smartrequest#README",
+  "homepage": "https://gitlab.com/push.rocks/smartrequest#readme",
   "dependencies": {
-    "@pushrocks/smartpromise": "^3.1.7",
+    "@push.rocks/smartpromise": "^4.0.2",
-    "@pushrocks/smarturl": "^3.0.2",
+    "@push.rocks/smarturl": "^3.0.6",
-    "agentkeepalive": "^4.2.1",
+    "agentkeepalive": "^4.5.0",
     "form-data": "^4.0.0"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.63",
+    "@git.zone/tsbuild": "^2.1.66",
-    "@gitzone/tsrun": "^1.2.37",
+    "@git.zone/tsrun": "^1.2.44",
-    "@gitzone/tstest": "^1.0.72",
+    "@git.zone/tstest": "^1.0.77",
-    "@pushrocks/tapbundle": "^5.0.4",
+    "@pushrocks/tapbundle": "^5.0.8",
-    "@types/node": "^18.6.2",
+    "@types/node": "^20.9.0"
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0"
   },
   "files": [
     "ts/**/*",

test/test.ts

@@ -13,13 +13,18 @@ tap.test('should request a JSON document over https', async () => {
     .toEqual(1);
 });
 
-tap.skip.test('should post a JSON document over http', async () => {
+tap.test('should post a JSON document over http', async () => {
   await expectAsync(smartrequest.postJson('http://md5.jsontest.com/?text=example_text'))
     .property('body')
     .property('md5')
     .toEqual('fa4c6baa0812e5b5c80ed8885e55a8a6');
 });
 
+tap.test('should safe get stuff', async () => {
+  smartrequest.safeGet('http://coffee.link/');
+  smartrequest.safeGet('https://coffee.link/');
+});
+
 tap.skip.test('should deal with unix socks', async () => {
   const socketResponse = await smartrequest.request(
     'http://unix:/var/run/docker.sock:/containers/json',

ts/00_commitinfo_data.ts

@@ -2,7 +2,7 @@
  * autocreated commitinfo by @pushrocks/commitinfo
  */
 export const commitinfo = {
-  name: '@pushrocks/smartrequest',
+  name: '@push.rocks/smartrequest',
-  version: '2.0.0',
+  version: '2.0.21',
   description: 'dropin replacement for request'
 }

ts/index.ts

@@ -1,7 +1,8 @@
-export { request } from './smartrequest.request.js';
+export { request, safeGet } from './smartrequest.request.js';
 export type { IExtendedIncomingMessage } from './smartrequest.request.js';
 export type { ISmartRequestOptions } from './smartrequest.interfaces.js';
 
 export * from './smartrequest.jsonrest.js';
 export * from './smartrequest.binaryrest.js';
 export * from './smartrequest.formdata.js';
+export * from './smartrequest.stream.js';

ts/smartrequest.interfaces.ts

@@ -6,4 +6,5 @@ export interface ISmartRequestOptions extends https.RequestOptions {
   requestBody?: any;
   autoJsonParse?: boolean;
   queryParams?: { [key: string]: string };
+  hardDataCuttingTimeout?: number;
 }

ts/smartrequest.plugins.ts

@@ -7,8 +7,8 @@ import * as path from 'path';
 export { http, https, fs, path };
 
 // pushrocks scope
-import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartpromise from '@push.rocks/smartpromise';
-import * as smarturl from '@pushrocks/smarturl';
+import * as smarturl from '@push.rocks/smarturl';
 
 export { smartpromise, smarturl };
 

ts/smartrequest.request.ts

@@ -1,14 +1,12 @@
 import * as plugins from './smartrequest.plugins.js';
 import * as interfaces from './smartrequest.interfaces.js';
 
-import { IncomingMessage } from 'http';
+export interface IExtendedIncomingMessage extends plugins.http.IncomingMessage {
-
-export interface IExtendedIncomingMessage extends IncomingMessage {
   body: any;
 }
 
 const buildUtf8Response = (
-  incomingMessageArg: IncomingMessage,
+  incomingMessageArg: plugins.http.IncomingMessage,
   autoJsonParse = true
 ): Promise<IExtendedIncomingMessage> => {
   const done = plugins.smartpromise.defer<IExtendedIncomingMessage>();
@@ -59,33 +57,37 @@ const parseSocketPathAndRoute = (stringToParseArg: string) => {
  */
 const httpAgent = new plugins.agentkeepalive({
   keepAlive: true,
-  freeSocketTimeout: 4000,
+  maxFreeSockets: 10,
-  maxFreeSockets: 1,
   maxSockets: 100,
   maxTotalSockets: 1000,
+  timeout: 60000,
 });
 
 /**
  * a custom http agent to make sure we can set custom keepAlive options for speedy subsequent calls
  */
 const httpAgentKeepAliveFalse = new plugins.agentkeepalive({
-  maxFreeSockets: 0,
   keepAlive: false,
-  keepAliveMsecs: 0,
+  timeout: 60000,
 });
 
 /**
  * a custom https agent to make sure we can set custom keepAlive options for speedy subsequent calls
  */
-const httpsAgent = new plugins.agentkeepalive.HttpsAgent();
+const httpsAgent = new plugins.agentkeepalive.HttpsAgent({
+  keepAlive: true,
+  maxFreeSockets: 10,
+  maxSockets: 100,
+  maxTotalSockets: 1000,
+  timeout: 60000,
+});
 
 /**
  * a custom https agent to make sure we can set custom keepAlive options for speedy subsequent calls
  */
-const httpsAgentKeepAliveFalse = new plugins.https.Agent({
+const httpsAgentKeepAliveFalse = new plugins.agentkeepalive.HttpsAgent({
-  maxFreeSockets: 0,
   keepAlive: false,
-  keepAliveMsecs: 0,
+  timeout: 60000,
 });
 
 export let request = async (
@@ -94,7 +96,7 @@ export let request = async (
   responseStreamArg: boolean = false,
   requestDataFunc: (req: plugins.http.ClientRequest) => void = null
 ): Promise<IExtendedIncomingMessage> => {
-  const done = plugins.smartpromise.defer<any>();
+  const done = plugins.smartpromise.defer<IExtendedIncomingMessage>();
 
   // merge options
   const defaultOptions: interfaces.ISmartRequestOptions = {
@@ -128,20 +130,30 @@ export let request = async (
 
   // TODO: support tcp sockets
 
+  // lets determine agent
+  switch (true) {
+    case !!optionsArg.agent:
+      break;
+    case parsedUrl.protocol === 'https:' && optionsArg.keepAlive:
+      optionsArg.agent = httpsAgent;
+      break;
+    case parsedUrl.protocol === 'https:' && !optionsArg.keepAlive:
+      optionsArg.agent = httpsAgentKeepAliveFalse;
+      break;
+    case parsedUrl.protocol === 'http:' && optionsArg.keepAlive:
+      optionsArg.agent = httpAgent;
+      break;
+    case parsedUrl.protocol === 'http:' && !optionsArg.keepAlive:
+      optionsArg.agent = httpAgentKeepAliveFalse;
+      break;
+  }
+
   // lets determine the request module to use
   const requestModule = (() => {
     switch (true) {
-      case parsedUrl.protocol === 'https' && optionsArg.keepAlive:
+      case parsedUrl.protocol === 'https:':
-        optionsArg.agent = httpsAgent;
         return plugins.https;
-      case parsedUrl.protocol === 'https' && !optionsArg.keepAlive:
+      case parsedUrl.protocol === 'http:':
-        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;
@@ -152,11 +164,18 @@ export let request = async (
   }
 
   // lets perform the actual request
-  const requestToFire = requestModule.request(optionsArg, async (response) => {
+  const requestToFire = requestModule.request(optionsArg, async (resArg) => {
+    if (optionsArg.hardDataCuttingTimeout) {
+      setTimeout(() => {
+        resArg.destroy();
+        done.reject(new Error('Request timed out'));
+      }, optionsArg.hardDataCuttingTimeout)
+    }
+
     if (responseStreamArg) {
-      done.resolve(response);
+      done.resolve(resArg as IExtendedIncomingMessage);
     } else {
-      const builtResponse = await buildUtf8Response(response, optionsArg.autoJsonParse);
+      const builtResponse = await buildUtf8Response(resArg, optionsArg.autoJsonParse);
       done.resolve(builtResponse);
     }
   });
@@ -183,8 +202,30 @@ export let request = async (
   // lets handle an error
   requestToFire.on('error', (e) => {
     console.error(e);
+    requestToFire.destroy();
   });
 
-  const result = await done.promise;
+  const response = await done.promise;
-  return result;
+  response.on('error', (err) => {
+    console.log(err);
+    response.destroy();
+  });
+  return response;
+};
+
+export const safeGet = async (urlArg: string) => {
+  const agentToUse = urlArg.startsWith('http://') ? new plugins.http.Agent() : new plugins.https.Agent();
+  try {
+    const response = await request(urlArg, {
+      method: 'GET',
+      agent: agentToUse,
+      timeout: 5000,
+      hardDataCuttingTimeout: 5000,
+      autoJsonParse: false,
+    });
+    return response;
+  } catch (err) {
+    console.log(err);
+    return null;
+  }
 };

ts/smartrequest.stream.ts

@@ -0,0 +1,17 @@
+import * as plugins from './smartrequest.plugins.js';
+import * as interfaces from './smartrequest.interfaces.js';
+import { request } from './smartrequest.request.js';
+
+export const getStream = async (
+  urlArg: string,
+  optionsArg: interfaces.ISmartRequestOptions = {}
+): Promise<plugins.http.IncomingMessage> => {
+  try {
+    // Call the existing request function with responseStreamArg set to true.
+    const responseStream = await request(urlArg, optionsArg, true);
+    return responseStream;
+  } catch (err) {
+    console.error('An error occurred while getting the stream:', err);
+    throw err; // Rethrow the error to be handled by the caller.
+  }
+};

tsconfig.json

@@ -3,8 +3,12 @@
     "experimentalDecorators": true,
     "useDefineForClassFields": false,
     "target": "ES2022",
-    "module": "ES2022",
+    "module": "NodeNext",
-    "moduleResolution": "nodenext",
+    "moduleResolution": "NodeNext",
-    "esModuleInterop": true
+    "esModuleInterop": true,
-  }
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
 }