3.0.6

.gitlab-ci.yml

@@ -12,6 +12,9 @@ stages:
   - release
   - metadata
 
+before_script:
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
@@ -19,23 +22,36 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
     - lossless
     - docker
     - notpriv
 
-audit:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
+  tags:
+    - docker
+  allow_failure: true
+
+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
+    - npmci command npm audit --audit-level=high --only=dev
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -50,9 +66,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -63,9 +77,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -85,6 +97,8 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
     - npmci npm prepare

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
+      "command": "npm test",
-      "type": "node",
+      "name": "Run npm test",
       "request": "launch",
-      "args": [
+      "type": "node-terminal"
-        "${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"
     }
   ]
 }

.vscode/settings.json

@@ -15,7 +15,7 @@
             "properties": {
               "projectType": {
                 "type": "string",
-                "enum": ["website", "element", "service", "npm"]
+                "enum": ["website", "element", "service", "npm", "wcc"]
               }
             }
           }

npmextra.json

@@ -9,7 +9,7 @@
       "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "webrequest",
-      "shortDescription": "securely request from browsers",
+      "description": "securely request from browsers",
       "npmPackagename": "@pushrocks/webrequest",
       "license": "MIT"
     }

package.json

@@ -1,29 +1,34 @@
 {
   "name": "@pushrocks/webrequest",
-  "version": "2.0.7",
+  "version": "3.0.6",
   "private": false,
   "description": "securely request from browsers",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/ --web)",
-    "build": "(tsbuild --web)",
+    "build": "(tsbuild --web --allowimplicitany && tsbundle npm)"
-    "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.24",
+    "@gitzone/tsbuild": "^2.1.63",
-    "@gitzone/tstest": "^1.0.33",
+    "@gitzone/tsbundle": "^2.0.4",
-    "@pushrocks/smartexpress": "^3.0.72",
+    "@gitzone/tstest": "^1.0.71",
-    "@pushrocks/tapbundle": "^3.2.1",
+    "@pushrocks/smartexpress": "^4.0.5",
-    "@types/node": "^14.0.14",
+    "@pushrocks/tapbundle": "^5.0.3",
-    "node-fetch": "^2.6.0",
+    "@types/node": "^17.0.36",
-    "tslint": "^6.1.2",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartdelay": "^2.0.9"
+    "@pushrocks/smartdelay": "^2.0.13",
+    "@pushrocks/smartenv": "^5.0.2",
+    "@pushrocks/smartjson": "^4.0.6",
+    "@pushrocks/smartpromise": "^3.1.7",
+    "@pushrocks/webstore": "^2.0.3",
+    "node-fetch": "^3.2.4"
   },
   "files": [
     "ts/**/*",
@@ -36,5 +41,8 @@
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -27,7 +27,6 @@ Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20W
 
 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). :)

test/test.browser.ts

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

test/test.ts

@@ -1,5 +1,5 @@
 import { expect, tap } from '@pushrocks/tapbundle';
-import * as webrequest from '../ts/index';
+import * as webrequest from '../ts/index.js';
 
 // test dependencies
 import * as smartexpress from '@pushrocks/smartexpress';
@@ -10,7 +10,7 @@ tap.test('setup test server', async () => {
   testServer = new smartexpress.Server({
     cors: false,
     forceSsl: false,
-    port: 2345
+    port: 2345,
   });
 
   testServer.addRoute(
@@ -34,7 +34,7 @@ tap.test('setup test server', async () => {
     new smartexpress.Handler('GET', (req, res) => {
       res.status(200);
       res.send({
-        hithere: 'hi'
+        hithere: 'hi',
       });
     })
   );
@@ -42,29 +42,32 @@ tap.test('setup test server', async () => {
   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 (await new webrequest.WebRequest().requestMultiEndpoint([
     'http://localhost:2345/apiroute1',
     'http://localhost:2345/apiroute2',
     'http://localhost:2345/apiroute4',
-    'http://localhost:2345/apiroute3'
+    'http://localhost:2345/apiroute3',
-  ]);
+  ], {
+    method: 'GET'
+  })).json();
 
   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('should cache response', async () => {
-  testServer.stop();
+  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();

ts/00_commitinfo_data.ts

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

ts/index.ts

@@ -1,72 +1,150 @@
-import * as plugins from './webrequest.plugins';
+import * as plugins from './webrequest.plugins.js';
 
 /**
  * web request
  */
 export class WebRequest {
-  private static polyfillsLoaded = false;
+  private static polyfillStatusEvaluated = false;
-  public static loadNeededPolyfills() {
+  private static neededPolyfillsLoadedDeferred = plugins.smartpromise.defer();
-    if (!this.polyfillsLoaded) {
+  public static async loadNeededPolyfills() {
-      this.polyfillsLoaded = true;
+    if (this.polyfillStatusEvaluated) {
-      // tslint:disable-next-line: no-eval
+      return this.neededPolyfillsLoadedDeferred.promise;
-      const loadFetchPolyfill = eval(`globalThis.fetch = require('node-fetch')`);
-      loadFetchPolyfill();
     }
+    this.polyfillStatusEvaluated = true;
+    const smartenv = new plugins.smartenv.Smartenv();
+    if (!smartenv.isBrowser) {
+      this.polyfillStatusEvaluated = true;
+      const fetchMod = await smartenv.getSafeNodeModule('node-fetch');
+      globalThis.Response = fetchMod.Response;
+      globalThis.fetch = fetchMod.default;
     }
+    this.neededPolyfillsLoadedDeferred.resolve();
+  }
+
+  public cacheStore = new plugins.webstore.WebStore({
+    dbName: 'webrequest',
+    storeName: 'webrequest',
+  });
 
   constructor() {
     WebRequest.loadNeededPolyfills();
   }
 
-  public async getJson(urlArg: string | string[]) {
+  public async getJson(urlArg: string, useCacheArg: boolean = false) {
+    await WebRequest.neededPolyfillsLoadedDeferred.promise;
     const response: Response = await this.request(urlArg, {
-      method: 'GET'
+      method: 'GET',
+      useCache: useCacheArg,
     });
-    return response.json();
+    const responseText = await response.text();
+    const responseResult = plugins.smartjson.parse(responseText);
+    return responseResult;
   }
 
   /**
    * postJson
    */
-  public async postJson(urlArg: string, requestBody?: any) {
+  public async postJson(urlArg: string, requestBody?: any, useCacheArg: boolean = false) {
+    await WebRequest.neededPolyfillsLoadedDeferred.promise;
     const response: Response = await this.request(urlArg, {
-      body: JSON.stringify(requestBody),
+      body: plugins.smartjson.stringify(requestBody),
-      method: 'POST'
+      method: 'POST',
+      useCache: useCacheArg
     });
-    return response.json();
+    const responseText = await response.text();
+    const responseResult = plugins.smartjson.parse(responseText);
+    return responseResult;
   }
 
   /**
    * put js
    */
-  public async putJson(urlArg: string, requestBody?: any) {
+  public async putJson(urlArg: string, requestBody?: any, useStoreAsFallback: boolean = false) {
+    await WebRequest.neededPolyfillsLoadedDeferred.promise;
     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;
   }
 
   /**
    * put js
    */
-  public async deleteJson(urlArg: string) {
+  public async deleteJson(urlArg: string, useStoreAsFallback: boolean = false) {
+    await WebRequest.neededPolyfillsLoadedDeferred.promise;
     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;
   }
 
-  /**
-   * a fault tolerant request
-   */
   public async request(
+    urlArg: string,
+    optionsArg: {
+      method: 'GET' | 'POST' | 'PUT' | 'DELETE';
+      body?: any;
+      headers?: HeadersInit;
+      useCache?: boolean;
+      timeoutMs?: number;
+    }
+  ) {
+    await WebRequest.neededPolyfillsLoadedDeferred.promise;
+    const controller = new AbortController();
+    if (optionsArg.timeoutMs) {
+      plugins.smartdelay.delayFor(optionsArg.timeoutMs).then(() => {
+        controller.abort();
+      });
+    }
+    let cachedResponseDeferred = plugins.smartpromise.defer<Response>();
+    let cacheUsed = false;
+    if (optionsArg.useCache && this.cacheStore.check(urlArg)) {
+      const responseBuffer: ArrayBuffer = await this.cacheStore.get(urlArg)
+      cachedResponseDeferred.resolve(new Response(responseBuffer, {}));
+    } else {
+      cachedResponseDeferred.resolve(null);
+    }
+    const response: Response = await fetch(urlArg, {
+      signal: controller.signal,
+      method: optionsArg.method,
+      headers: {
+        'Content-Type': 'application/json',
+        ...(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 (!cacheUsed && optionsArg.useCache && response.status < 300) {
+      const buffer = await response.clone().arrayBuffer();
+      await this.cacheStore.set(urlArg, buffer);
+    }
+    console.log(`${urlArg} answers with status: ${response.status}`);
+    return response;
+  }
+
+  /**
+   * a multi endpoint, fault tolerant request function
+   */
+  public async requestMultiEndpoint(
     urlArg: string | string[],
     optionsArg: {
       method: 'GET' | 'POST' | 'PUT' | 'DELETE';
       body?: any;
+      headers?: HeadersInit;
     }
   ): Promise<Response> {
+    await WebRequest.neededPolyfillsLoadedDeferred.promise;
     let allUrls: string[];
     let usedUrlIndex = 0;
 
@@ -99,7 +177,7 @@ export class WebRequest {
     };
 
     // lets go recursive
-    const doRequest = async (urlToUse: string) => {
+    const doRequest = async (urlToUse: string): Promise<any> => {
       if (!urlToUse) {
         throw new Error('request failed permanently');
       }
@@ -107,23 +185,25 @@ export class WebRequest {
       const response = await fetch(urlToUse, {
         method: optionsArg.method,
         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}`);
 
       if (response.status >= 200 && response.status < 300) {
         return response;
       } else {
+        // lets perform a history check to determine failed urls
         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]);
-    console.log(finalResponse);
     return finalResponse;
   }
 }

ts/webrequest.plugins.ts

@@ -1,3 +1,7 @@
 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 { smartdelay };
+export { smartdelay, smartenv, smartjson, smartpromise, webstore };