backtrace-service - npm Package Compare versions

Comparing version 1.2.8 to 1.2.9

lib/config/config.d.ts

@@ -19,3 +19,3 @@ import { IServiceDescriptor } from '../model/serviceDescriptor';
  */
-export declare function getDescriptor(serviceName: string, defaultPort: number, opts?: IDescriptorOpts, createDir?: boolean): IServiceDescriptor;
+export declare function getDescriptor(serviceName: string, defaultPort: number, opts?: IDescriptorOpts): IServiceDescriptor;
 /**
@@ -22,0 +22,0 @@ * getConfig fetches from the expected place on the machine (outside the service).

lib/config/config.js

@@ -19,2 +19,4 @@ "use strict";
 var log = __importStar(require("../log/log"));
+// XXX: better default?
+var defaultCoronerdHostname = '0.0.0.0';
 /**
@@ -56,2 +58,26 @@ * getBackupConfig fetches a config file provided by the service itself.
 exports.getProperConfig = getProperConfig;
+function getCoronerdHostname() {
+    var alldescPath = process.env.ALL_DESCRIPTOR_PATH ||
+        "/var/run/coronerd/svclayer/_all.json";
+    // if coronerd has supplied its REST URL, then use it.
+    if (fs.existsSync(alldescPath)) {
+        try {
+            var alldesc = JSON.parse(fs.readFileSync(alldescPath, { encoding: 'utf8' }));
+            if (alldesc && typeof (alldesc.coronerd) === 'string') {
+                try {
+                    var crUrl = url.parse(alldesc.coronerd);
+                    if (crUrl.hostname)
+                        return crUrl.hostname;
+                }
+                catch (err) {
+                    // ignore errors and use fallback below
+                }
+            }
+        }
+        catch (err) {
+            // ignore errors and use fallback below
+        }
+    }
+    return defaultCoronerdHostname;
+}
 /**
@@ -63,5 +89,4 @@ * getDescriptor fetches the service's integration parameters.
  */
-function getDescriptor(serviceName, defaultPort, opts, createDir) {
+function getDescriptor(serviceName, defaultPort, opts) {
     if (opts === void 0) { opts = {}; }
-    if (createDir === void 0) { createDir = true; }
     var varprefix = process.env.SERVICE_DESCRIPTOR_VARPREFIX || '/var/run/coronerd/services.d';
@@ -71,30 +96,37 @@ var varPath = process.env.SERVICE_DESCRIPTOR_VARPATH ||
     var paths = getDescriptorPaths(serviceName, varPath);
-    var desc = readDescriptorConfiguration(paths);
-    var generateConf = !desc;
-    // if descriptor doesn't exists in descriptor paths
-    // generate new descriptor file with basic configuration
+    var foundPath = "";
+    var desc;
+    for (var _i = 0, paths_1 = paths; _i < paths_1.length; _i++) {
+        var descriptorPath = paths_1[_i];
+        desc = readDescriptorConfiguration(descriptorPath);
+        if (desc) {
+            foundPath = descriptorPath;
+            break;
+        }
+    }
+    // if descriptor doesn't exist in the descriptor search path,
+    // generate new descriptor file with default configuration in the
+    // var path, where it can own the file.
     if (!desc) {
         desc = getDefaultDescriptor(serviceName, defaultPort, opts);
+        mkdirp_1.default(path_1.default.basename(varPath), function (err) {
+            if (err) {
+                throw err;
+            }
+            fs.writeFileSync(varPath, JSON.stringify(desc, null, 2));
+        });
     }
-    var surl = url.parse(desc.server);
-    if (!surl.port && surl.protocol !== 'https:') {
-        throw new Error('Unspecified port number requires https');
-    }
-    // generate configuration after checking port and url
-    // to solve problem when user path invalid server and port in options
-    if (generateConf) {
-        var dirPath = path_1.default.basename(varPath);
-        if (fs.existsSync(dirPath)) {
+    var surl = new url.URL(desc.server);
+    // if the descriptor owned by the service was read in and happens to
+    // contain the invalid-for-SSL default hostname "0.0.0.0" that was
+    // written out previously, see whether it can be automatically fixed up.
+    if (foundPath === varPath && surl.hostname === defaultCoronerdHostname) {
+        var hostname = getCoronerdHostname();
+        if (hostname !== defaultCoronerdHostname) {
+            surl.hostname = hostname;
+            desc.server = surl.toString();
             fs.writeFileSync(varPath, JSON.stringify(desc, null, 2));
         }
-        else if (createDir) {
-            mkdirp_1.default(dirPath, function (err) {
-                if (err) {
-                    throw err;
-                }
-                fs.writeFileSync(varPath, JSON.stringify(desc, null, 2));
-            });
-        }
     }
-    var port = 443;
+    var port = (surl.protocol === 'https:') ? 443 : 80;
     if (surl.port) {
@@ -108,2 +140,3 @@ port = parseInt(surl.port, 10);
         port: port,
+        protocol: surl.protocol.split(':')[0],
     };
@@ -113,22 +146,21 @@ }
 function getDefaultDescriptor(serviceName, defaultPort, opts) {
+    var protocol = opts.protocol ? opts.protocol : 'http';
+    var hostname = getCoronerdHostname();
     return {
         name: serviceName,
         secret: crypto_1.randomBytes(32).toString('hex'),
-        server: opts.server || "https://0.0.0.0:" + defaultPort,
+        server: opts.server || protocol + "://" + hostname + ":" + defaultPort,
         resource: opts.resource || "/api/" + serviceName,
-        proxy: opts.proxy || false,
+        proxy: opts.proxy !== undefined ? opts.proxy : true,
         enabled: true,
     };
 }
-function readDescriptorConfiguration(paths) {
-    for (var _i = 0, paths_1 = paths; _i < paths_1.length; _i++) {
-        var descriptorPath = paths_1[_i];
-        try {
-            var conf = JSON.parse(fs.readFileSync(descriptorPath, { encoding: 'utf8' }));
-            return conf;
-        }
-        catch (err) {
-            continue;
-        }
+function readDescriptorConfiguration(descriptorPath) {
+    try {
+        var conf = JSON.parse(fs.readFileSync(descriptorPath, { encoding: 'utf8' }));
+        return conf;
     }
+    catch (err) {
+        // ignore error
+    }
     return undefined;
@@ -135,0 +167,0 @@ }

lib/config/model/coronerDescriptor.d.ts

@@ -0,0 +0,0 @@ /**

lib/config/model/coronerDescriptor.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=coronerDescriptor.js.map

lib/config/model/descriptorOptions.d.ts

@@ -5,2 +5,3 @@ export interface IDescriptorOpts {
     proxy?: boolean;
+    protocol?: string;
 }

lib/config/model/descriptorOptions.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=descriptorOptions.js.map

lib/identity/identity.d.ts

@@ -0,0 +0,0 @@ import { NextFunction, Request, Response } from 'express';

lib/identity/identity.js

@@ -0,0 +0,0 @@ "use strict";

lib/identity/model/authRequestOptions.d.ts

@@ -0,0 +0,0 @@ export interface ICoronerRequestOption {

lib/identity/model/authRequestOptions.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=authRequestOptions.js.map

lib/identity/model/serverConfiguration.d.ts

@@ -0,0 +0,0 @@ export interface IConfig {

lib/identity/model/serverConfiguration.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=serverConfiguration.js.map

lib/index.d.ts

@@ -0,0 +0,0 @@ /**

lib/index.js

@@ -0,0 +0,0 @@ "use strict";

lib/log/log.d.ts

 export declare function info(log: string): void;
 export declare function warning(log: string): void;
 export declare function error(log: string): void;

lib/log/log.js

@@ -0,0 +0,0 @@ "use strict";

lib/model/responseResult.d.ts

@@ -0,0 +0,0 @@ import { Response } from 'express';

lib/model/responseResult.js

@@ -0,0 +0,0 @@ "use strict";

lib/model/serviceDescriptor.d.ts

@@ -6,2 +6,3 @@ export interface IServiceDescriptor {
     secret: string;
+    protocol: string;
 }

lib/model/serviceDescriptor.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=serviceDescriptor.js.map

lib/universe/backtraceUniverseHelper.d.ts

@@ -0,0 +0,0 @@ /**

lib/universe/backtraceUniverseHelper.js

@@ -0,0 +0,0 @@ "use strict";

package.json

 {
   "name": "backtrace-service",
-  "version": "1.2.8",
+  "version": "1.2.9",
   "description": "Common tools for Backtrace Node services",
@@ -5,0 +5,0 @@ "author": "Backtrace",

README.md

@@ -0,0 +0,0 @@ # Backtrace Service Layer nodejs library

source/config/config.ts

@@ -10,2 +10,6 @@ import { randomBytes } from 'crypto';
 import { IDescriptorOpts } from './model/descriptorOptions';
+
+// XXX: better default?
+const defaultCoronerdHostname = '0.0.0.0';
+
 /**
@@ -52,2 +56,27 @@ * getBackupConfig fetches a config file provided by the service itself.
 
+function getCoronerdHostname() {
+  const alldescPath = process.env.ALL_DESCRIPTOR_PATH ||
+    "/var/run/coronerd/svclayer/_all.json";
+  // if coronerd has supplied its REST URL, then use it.
+  if (fs.existsSync(alldescPath)) {
+    try {
+      const alldesc = JSON.parse(
+        fs.readFileSync(alldescPath, { encoding: 'utf8' }),
+      );
+      if (alldesc && typeof(alldesc.coronerd) === 'string') {
+        try {
+          const crUrl = url.parse(alldesc.coronerd);
+          if (crUrl.hostname)
+            return crUrl.hostname;
+        } catch (err) {
+          // ignore errors and use fallback below
+        }
+      }
+    } catch (err) {
+      // ignore errors and use fallback below
+    }
+  }
+  return defaultCoronerdHostname;
+}
+
 /**
@@ -63,3 +92,2 @@ * getDescriptor fetches the service's integration parameters.
   opts: IDescriptorOpts = {},
-  createDir: boolean = true,
 ): IServiceDescriptor {
@@ -73,31 +101,39 @@ const varprefix =
   const paths: string[] = getDescriptorPaths(serviceName, varPath);
-  let desc = readDescriptorConfiguration(paths);
-  const generateConf = !desc;
-  // if descriptor doesn't exists in descriptor paths
-  // generate new descriptor file with basic configuration
+  let foundPath = "";
+  let desc: ICoronerDescriptor | undefined;
+  for (const descriptorPath of paths) {
+    desc = readDescriptorConfiguration(descriptorPath);
+    if (desc) {
+      foundPath = descriptorPath;
+      break;
+    }
+  }
+
+  // if descriptor doesn't exist in the descriptor search path,
+  // generate new descriptor file with default configuration in the
+  // var path, where it can own the file.
   if (!desc) {
     desc = getDefaultDescriptor(serviceName, defaultPort, opts);
+    mkdirp(path.basename(varPath), (err: Error) => {
+      if (err) {
+        throw err;
+      }
+      fs.writeFileSync(varPath, JSON.stringify(desc, null, 2));
+    });
   }
-  const surl = url.parse(desc.server);
-  if (!surl.port && surl.protocol !== 'https:') {
-    throw new Error('Unspecified port number requires https');
-  }
+  let surl = new url.URL(desc.server);
 
-  // generate configuration after checking port and url
-  // to solve problem when user path invalid server and port in options
-  if (generateConf) {
-    const dirPath = path.basename(varPath);
-    if (fs.existsSync(dirPath)) {
+  // if the descriptor owned by the service was read in and happens to
+  // contain the invalid-for-SSL default hostname "0.0.0.0" that was
+  // written out previously, see whether it can be automatically fixed up.
+  if (foundPath === varPath && surl.hostname === defaultCoronerdHostname) {
+    const hostname = getCoronerdHostname();
+    if (hostname !== defaultCoronerdHostname) {
+      surl.hostname = hostname;
+      desc.server = surl.toString();
       fs.writeFileSync(varPath, JSON.stringify(desc, null, 2));
-    } else if (createDir) {
-      mkdirp(dirPath, (err: Error) => {
-        if (err) {
-          throw err;
-        }
-        fs.writeFileSync(varPath, JSON.stringify(desc, null, 2));
-      });
     }
   }
 
-  let port: number = 443;
+  let port: number = (surl.protocol === 'https:') ? 443 : 80;
   if (surl.port) {
@@ -111,3 +147,4 @@ port = parseInt(surl.port, 10);
     secret: desc.secret,
-    port,
+    port: port,
+    protocol: surl.protocol.split(':')[0],
   };
@@ -121,26 +158,28 @@ }
 ) {
+  const protocol = opts.protocol ? opts.protocol : 'http';
+  const hostname = getCoronerdHostname();
   return {
     name: serviceName,
     secret: randomBytes(32).toString('hex'),
-    server: opts.server || `https://0.0.0.0:${defaultPort}`,
+    server: opts.server || `${protocol}://${hostname}:${defaultPort}`,
     resource: opts.resource || `/api/${serviceName}`,
-    proxy: opts.proxy || false,
+    proxy: opts.proxy !== undefined ? opts.proxy : true,
     enabled: true,
   };
 }
+
 function readDescriptorConfiguration(
-  paths: string[],
+  descriptorPath: string,
 ): ICoronerDescriptor | undefined {
-  for (const descriptorPath of paths) {
-    try {
-      const conf = JSON.parse(
-        fs.readFileSync(descriptorPath, { encoding: 'utf8' }),
-      );
-      return conf;
-    } catch (err) {
-      continue;
-    }
+  try {
+    const conf = JSON.parse(
+      fs.readFileSync(descriptorPath, { encoding: 'utf8' }),
+    );
+    return conf;
+  } catch (err) {
+    // ignore error
   }
   return undefined;
 }
+
 function getDescriptorPaths(serviceName: string, varPath: string): string[] {
@@ -147,0 +186,0 @@ return !process.env.SERVICE_DESCRIPTOR_PATH

source/config/model/coronerDescriptor.ts

@@ -0,0 +0,0 @@ /**

source/config/model/descriptorOptions.ts

@@ -5,2 +5,3 @@ export interface IDescriptorOpts {
   proxy?: boolean;
+  protocol?: string;
 }

source/identity/identity.ts

@@ -0,0 +0,0 @@ import axios from 'axios';

source/identity/model/authRequestOptions.ts

@@ -0,0 +0,0 @@ export interface ICoronerRequestOption {

source/identity/model/serverConfiguration.ts

@@ -0,0 +0,0 @@ export interface IConfig {

source/index.ts

@@ -0,0 +0,0 @@ /**

source/log/log.ts

@@ -0,0 +0,0 @@ import chalk from 'chalk';

source/model/serviceDescriptor.ts

@@ -7,2 +7,3 @@ /* A service descriptor, for service use. */
   secret: string;
+  protocol: string;
 }

source/universe/backtraceUniverseHelper.ts

@@ -0,0 +0,0 @@ import * as url from 'url';

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

90934

increased by2.21%

Number of package files

50

increased by6.38%

Lines of code

1568

increased by5.23%

Worsened metrics

Number of low supply chain risk alerts

10

increased by11.11%

No dependency changes