@sera4/essentia 1.1.40 → 1.1.41

package/helpers/index.js

@@ -0,0 +1 @@
+export * from "./test-server-wrapper.js";

package/helpers/test-server-wrapper.js

@@ -0,0 +1,167 @@
+import uuidv4 from 'uuid/v4.js';
+import fs from "fs";
+
+/**
+ * A small wrapper around an express js server
+ * meant to be used in unit tests
+ */
+export class TestServerWrapper {
+
+  constructor(apiPrefix, expressServer, defaultHeaders, oldAuthToken, routePrinter, chai) {
+    this.server = expressServer;
+    this.defaultHeaders = defaultHeaders;
+    this.apiPrefix = apiPrefix;
+    this.routePrinter = routePrinter;
+    this.chai = chai;
+
+    // Support for older/deprecated apis
+    const oldAuthHeaders = {field: "Authorization", value: `Token organization_token=${oldAuthToken}`};
+    this.v1 = {
+      get: (url) => this.getWithPrefix("/v1", url, oldAuthHeaders),
+      post: (url) => this.postWithPrefix("/v1", url, oldAuthHeaders),
+      put: (url) => this.putWithPrefix("/v1", url, oldAuthHeaders),
+      delete: (url) => this.deleteWithPrefix("/v1", url, oldAuthHeaders)
+    }
+  }
+
+  /**
+   * Adds a leading slash to the url if missing
+   * @param {String} url the url to sanitize
+   * @returns sanitized url
+   */
+  sanitizeUrl (url) {
+    // add leading slash if missing
+    if (!url.startsWith("/")) {
+      return "/" + url;
+    } else {
+      return url;
+    }
+  }
+
+  /**
+   * Apply given headers to the request object
+   * @param {Object} request
+   * @param {Object} headers
+   */
+  applyHeaders (request, headers) {
+    Object.keys(headers).map(k => {
+      request.set(k, headers[k]);
+    });
+  }
+
+  get (url, options) {
+    return this.getWithPrefix(this.apiPrefix, url, options);
+  }
+
+  getWithPrefix (prefix, url, options) {
+    const sanitizedUrl = this.sanitizeUrl(url);
+    const request = this.chai.request(this.server).get(`${prefix}${sanitizedUrl}`);
+    this.applyHeaders(request, this.defaultHeaders);
+
+    if (options?.field) {
+      this.applyHeaders(request, {[options.field] : options.value});
+    }
+
+    if (options?.body) {
+      request.send(options.body);
+    }
+    return request;
+  }
+
+  post (url, options) {
+    return this.postWithPrefix(this.apiPrefix, url, options);
+  }
+
+  postWithPrefix (prefix, url, options) {
+    const sanitizedUrl = this.sanitizeUrl(url);
+    const request = this.chai.request(this.server).post(`${prefix}${sanitizedUrl}`);
+    this.applyHeaders(request, this.defaultHeaders);
+
+    if (options?.field) {
+      this.applyHeaders(request, {[options.field] : options.value});
+    }
+    return request;
+  }
+
+  put (url, options) {
+    return this.putWithPrefix(this.apiPrefix, url, options);
+  }
+
+  putWithPrefix (prefix, url, options) {
+    const sanitizedUrl = this.sanitizeUrl(url);
+    const request = this.chai.request(this.server).put(`${prefix}${sanitizedUrl}`);
+    this.applyHeaders(request, this.defaultHeaders);
+
+    if (options?.field) {
+      this.applyHeaders(request, {[options.field] : options.value});
+    }
+    return request;
+  }
+
+  delete (url, options) {
+    return this.deleteWithPrefix(this.apiPrefix, url, options);
+  }
+
+  deleteWithPrefix (prefix, url, options) {
+    const sanitizedUrl = this.sanitizeUrl(url);
+    const request = this.chai.request(this.server).delete(`${prefix}${sanitizedUrl}`);
+    this.applyHeaders(request, this.defaultHeaders);
+
+    if (options?.field) {
+      this.applyHeaders(request, {[options.field] : options.value});
+    }
+    return request;
+  }
+
+  upload ( url, fields, file, options) {
+    return this.uploadWithPrefix(this.apiPrefix, url, fields, file, options);
+  }
+
+  uploadWithPrefix (prefix, url, fields, file, options) {
+    const sanitizedUrl = this.sanitizeUrl(url);
+    const request = this.chai.request(this.server).post(`${prefix}${sanitizedUrl}`);
+    this.applyHeaders(request, this.defaultHeaders);
+
+    if (options?.field) {
+      this.applyHeaders(request, {[options.field] : options.value});
+    }
+
+    request.attach("data", fs.readFileSync(file), {filename: "data"});
+    const keys = Object.keys(fields);
+    keys.forEach(k => {
+      request.field(k, fields[k]);
+    });
+    return request;
+  }
+
+  stop () {
+    this.server.close();
+  }
+
+  allRoutes () {
+    return this.routePrinter.getAll();
+  }
+
+  // Support for injecting certain memberships in every request
+  withMembership (m) {
+    const headers = { field: "tws-membership", value: JSON.stringify(m) }
+    return {
+      get: (url, options) => this.get(url, {...headers, ...options}),
+      post: (url, options) => this.post(url, {...headers, ...options}),
+      put: (url, options) => this.put(url, {...headers, ...options}),
+      delete: (url, options) => this.delete(url, {...headers, ...options}),
+      upload: (url, fields, file, options) => this.upload(url, fields, file, {...headers, ...options}),
+      stop: this.stop,
+      allRoutes: this.allRoutes,
+      v1: this.v1
+    }
+  }
+
+  withS4 () {
+    return this.withMembership({s4_role: 1, id: uuidv4(), account_id: uuidv4(), tenant_id: uuidv4()});
+  }
+
+  withTap() {
+    return this.withMembership({s4_role: 2, id: uuidv4(), account_id: uuidv4(), tenant_id: uuidv4()});
+  }
+}

package/index.js

@@ -12,3 +12,4 @@ export { default as paperTrail } from "./paper-trail/index.js";
 export { default as serializer } from "./serializer/index.js";
 export * from "./utils/index.js";
 export * from "./safe_proxy/index.js";
+export * from "./helpers/index.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sera4/essentia",
-  "version": "1.1.40",
+  "version": "1.1.41",
   "description": "A library of utilities for Teleporte Web Services",
   "main": "index.js",
   "type": "module",