@drenso/homey-log 3.0.0-beta.0 → 8.37.1-cjs

package/build.js

@@ -0,0 +1,37 @@
+'use strict';
+
+// eslint-disable-next-line import/no-extraneous-dependencies
+const { buildSync } = require('esbuild');
+const { execSync } = require('child_process');
+
+const defaultOptions = {
+  entryPoints: ['index.js'],
+  bundle: true,
+  outdir: 'build',
+  platform: 'node',
+  external: ['homey'],
+  minify: true,
+  treeShaking: true,
+};
+
+// CommonJS build
+buildSync({
+  ...defaultOptions,
+  ...{
+    format: 'cjs',
+  },
+});
+
+// ESM build
+buildSync({
+  ...defaultOptions,
+  ...{
+    format: 'esm',
+    outExtension: {
+      '.js': '.mjs',
+    },
+  },
+});
+
+// Generate types
+execSync('npm run typings:generate');

package/index.js

@@ -1,5 +1,216 @@
 'use strict';
 
-const Log = require('./lib/Log');
+const os = require('node:os');
 
-module.exports = {Log};
+if (!process.env.HOME) {
+  // Sentry SDK requires the HOME env var to be set, which is not guaranteed on Homey
+  process.env.HOME = os.tmpdir();
+}
+
+// eslint-disable-next-line import/no-extraneous-dependencies
+const Sentry = require('@sentry/node');
+const HomeyModule = require('homey');
+
+class Log {
+
+  _capturedMessages = [];
+  _capturedExceptions = [];
+
+  /**
+   * Construct a new Log instance.
+   * @param {object} args
+   * @param {import('homey').default} args.homey - `this.homey` instance in
+   * your app (e.g. `App#homey`/`Driver#homey`/`Device#homey`).
+   *
+   * @param {object} [args.options] - Additional options for Sentry
+   *
+   * @example
+   * class MyApp extends Homey.App {
+   *   onInit() {
+   *     this.homeyLog = new Log({ homey: this.homey });
+   *   }
+   * }
+   */
+  constructor({ homey, options }) {
+    if (typeof homey === 'undefined') {
+      return Log._error('Error: missing `homey` constructor parameter');
+    }
+
+    if (!HomeyModule.env) {
+      return Log._error('Error: could not access `Homey.env`');
+    }
+
+    if (typeof HomeyModule.env.HOMEY_LOG_URL !== 'string') {
+      return Log._error('Error: expected `HOMEY_LOG_URL` env variable, homey-log is disabled');
+    }
+
+    // Check if debug mode is enabled
+    const disableSentry = process.env.DEBUG === '1' && !Log._isLogForced();
+    if (disableSentry) {
+      Log._log('App is running in debug mode, not enabling Sentry logging');
+    }
+
+    this._manifest = HomeyModule.manifest;
+    this._homeyVersion = homey.version;
+    this._managerCloud = homey.cloud;
+    this._homeyPlatform = homey.platform;
+    this._homeyPlatformVersion = homey.platformVersion;
+
+    // Init Sentry, pass enabled option to prevent sending events upstream when in debug mode
+    this.init(HomeyModule.env.HOMEY_LOG_URL, { ...{ enabled: !disableSentry }, ...options });
+  }
+
+  /**
+   * Init Sentry.
+   * @param {string} dsn The Sentry DSN
+   * @param {object} opts Options to be passed to the Sentry init
+   * @returns {Log}
+   * @private
+   */
+  init(dsn, opts) {
+    Sentry.initWithoutDefaultIntegrations({
+      ...{
+        dsn,
+        integrations: [
+          ...Sentry.getDefaultIntegrationsWithoutPerformance(),
+        ],
+      },
+      ...opts,
+    });
+
+    this.setTags({
+      appId: this._manifest.id,
+      appVersion: this._manifest.version,
+      homeyVersion: this._homeyVersion,
+      homeyPlatform: this._homeyPlatform,
+      homeyPlatformVersion: this._homeyPlatformVersion,
+    });
+
+    // Get homey cloud id and set as tag
+    this._managerCloud.getHomeyId()
+      .then(homeyId => this.setTags({ homeyId }))
+      .catch(err => Log._error('Error: could not get `homeyId`', err));
+
+    Log._log(`App ${this._manifest.id} v${this._manifest.version} logging on Homey v${this._homeyVersion}...`);
+    return this;
+  }
+
+  /**
+   * Set `tags` that will be sent as context with every message or error. See the Sentry Node.js
+   * documentation: https://docs.sentry.io/platforms/javascript/guides/node/enriching-events/tags/
+   * @param {object} tags
+   * @returns {Log}
+   */
+  setTags(tags) {
+    Sentry.setTags(tags);
+    return this;
+  }
+
+  /**
+   * Set `user` that will be sent as context with every message or error. See the Sentry Node.js
+   * documentation: https://docs.sentry.io/platforms/javascript/guides/node/enriching-events/identify-user/.
+   * @param {object} user
+   * @returns {Log}
+   */
+  setUser(user) {
+    Sentry.setUser(user);
+    return this;
+  }
+
+  /**
+   * Create and send message event to Sentry. See the Sentry Node.js documentation:
+   * https://docs.sentry.io/platforms/javascript/guides/node/usage/
+   * @param {string} message - Message to be sent
+   * @returns {Promise<string>|undefined}
+   */
+  async captureMessage(message) {
+    Log._log('captureMessage:', message);
+
+    if (this._capturedMessages.indexOf(message) > -1) {
+      Log._log('Prevented sending a duplicate message');
+      return;
+    }
+
+    this._capturedMessages.push(message);
+
+    // eslint-disable-next-line consistent-return
+    return new Promise((resolve, reject) => {
+      try {
+        resolve(Sentry.captureMessage(message));
+      } catch (e) {
+        reject(e);
+      }
+    });
+  }
+
+  /**
+   * Create and send exception event to Sentry. See the sentry Node.js documentation:
+   * https://docs.sentry.io/platforms/javascript/guides/node/usage/
+   * @param {Error} err - Error instance to be sent
+   * @returns {Promise<string>|undefined}
+   */
+  async captureException(err) {
+    Log._log('captureException:', err);
+
+    if (this._capturedExceptions.indexOf(err) > -1) {
+      Log._log('Prevented sending a duplicate log');
+      return;
+    }
+
+    this._capturedExceptions.push(err);
+
+    // eslint-disable-next-line consistent-return
+    return new Promise((resolve, reject) => {
+      try {
+        resolve(Sentry.captureException(err));
+      } catch (e) {
+        reject(e);
+      }
+    });
+  }
+
+  /**
+   * Mimic SDK log method.
+   * @private
+   */
+  static _log() {
+    // eslint-disable-next-line prefer-spread,prefer-rest-params,no-console
+    console.log.bind(null, Log._logTime(), '[homey-log]').apply(null, arguments);
+  }
+
+  /**
+   * Mimic SDK error method.
+   * @private
+   */
+  static _error() {
+    // eslint-disable-next-line prefer-spread,prefer-rest-params,no-console
+    console.error.bind(null, Log._logTime(), '[homey-log]').apply(null, arguments);
+  }
+
+  /**
+   * Mimic SDK timestamp.
+   * @returns {string}
+   * @private
+   */
+  static _logTime() {
+    return `\x1b[35m${(new Date()).toISOString()}\x1b[0m`;
+  }
+
+  /**
+   * Whether logging is forced.
+   * @returns {boolean}
+   * @private
+   */
+  static _isLogForced() {
+    switch (HomeyModule.env.HOMEY_LOG_FORCE) {
+      case '1':
+      case 'true':
+        return true;
+      default:
+        return false;
+    }
+  }
+
+}
+
+module.exports = { Log };

package/package.json

@@ -1,50 +1,48 @@
 {
   "name": "@drenso/homey-log",
-  "version": "3.0.0-beta.0",
+  "version": "8.37.1-cjs",
   "description": "Interface with Sentry for Homey",
-  "main": "index.js",
+  "main": "./build/index.js",
+  "module": "./build/index.mjs",
+  "types": "./build/index.d.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "node build.js",
     "lint": "eslint .",
-    "serve": "concurrently \"serve build/\" \"npm run jsdoc:watch\"",
-    "build": "npm run jsdoc:clean; npm run jsdoc;",
-    "jsdoc": "jsdoc --configure ./docs/jsdoc.json;",
-    "jsdoc:clean": "rm -rf ./build",
-    "jsdoc:watch": "watch \"npm run jsdoc:clean && npm run jsdoc\" lib docs \"node_modules/homey-jsdoc-template\"",
+    "jsdoc": "jsdoc --configure ./jsdoc.json",
+    "jsdoc:serve": "serve ./jsdoc",
+    "jsdoc:clean": "rm -rf ./jsdoc",
+    "jsdoc:watch": "watch \"npm run jsdoc:clean && npm run jsdoc\" lib",
     "typings:generate": "tsc"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/athombv/node-homey-log.git"
+    "url": "git+https://github.com/Drenso/homey-log.git"
   },
   "author": "Athom B.V.",
   "license": "ISC",
   "bugs": {
-    "url": "https://github.com/athombv/node-homey-log/issues"
+    "url": "https://github.com/Drenso/homey-log/issues"
   },
   "engines": {
-    "node": ">=12"
-  },
-  "homepage": "https://github.com/athombv/node-homey-log#readme",
-  "dependencies": {
-    "raven": "github:athombv/raven-node"
+    "node": ">=18"
   },
+  "homepage": "https://github.com/Drenso/homey-log#readme",
   "devDependencies": {
-    "@types/homey": "npm:homey-apps-sdk-v3-types@^0.3.0",
-    "@types/node": "^12.20.55",
-    "concurrently": "^5.1.0",
-    "eslint": "^7.2.0",
-    "eslint-config-athom": "^2.1.0",
-    "homey": "^2.4.0",
-    "homey-jsdoc-template": "github:athombv/homey-jsdoc-template#1.4",
-    "jsdoc": "^3.6.6",
+    "@sentry/node": "8.37.1",
+    "@types/homey": "npm:homey-apps-sdk-v3-types@0.3.9",
+    "@types/node": "^16.18.0",
+    "esbuild": "^0.24.0",
+    "eslint": "^7.32.0",
+    "eslint-config-athom": "^2.1.1",
+    "homey": "3.7.11",
+    "jsdoc": "^3.6.11",
     "jsdoc-ts-utils": "^1.1.2",
-    "npm-watch": "^0.6.0",
-    "serve": "^11.3.1",
+    "npm-watch": "^0.13.0",
+    "serve": "^14.2.3",
     "typescript": "^4.7.4",
     "watch": "^1.0.2"
   },
-  "types": "types/index.d.ts",
   "watch": {
     "jsdoc": {
       "patterns": [

package/lib/Log.js

@@ -1,236 +0,0 @@
-'use strict';
-
-const HomeyModule = require('homey');
-
-const Raven = require('raven');
-
-const DEFAULT_OPTIONS = {
-  // Start tracking unhandled promise rejections (not enabled by default)
-  captureUnhandledRejections: true,
-};
-
-class Log {
-
-  /**
-   * Construct a new Log instance.
-   * @param {object} args
-   * @param {HomeyModule} args.homey - `this.homey` instance in
-   * your app (e.g. `App#homey`/`Driver#homey`/`Device#homey`).
-   *
-   * @param {object} [args.options] - Additional options for Raven
-   *
-   * @example
-   * class MyApp extends Homey.App {
-   *   onInit() {
-   *     this.homeyLog = new Log({ homey: this.homey });
-   *   }
-   * }
-   */
-  constructor({ homey, options }) {
-    this._capturedMessages = [];
-    this._capturedExceptions = [];
-
-    if (typeof homey === 'undefined') {
-      return Log._error('Error: missing `homey` constructor parameter');
-    }
-
-    if (!HomeyModule.env) {
-      return Log._error('Error: could not access `HomeyModule.env`');
-    }
-
-    if (typeof HomeyModule.env.HOMEY_LOG_URL !== 'string') {
-      return Log._error('Error: expected `HOMEY_LOG_URL` env variable, homey-log is disabled');
-    }
-
-    // Check if debug mode is enabled
-    const disableRaven = process.env.DEBUG === '1' && HomeyModule.env.HOMEY_LOG_FORCE !== '1';
-    if (disableRaven) {
-      Log._log('App is running in debug mode, disabling Raven');
-    }
-
-    this._manifest = HomeyModule.manifest;
-    this._homeyVersion = homey.version;
-    this._managerCloud = homey.cloud;
-
-    // Init Raven, pass falsy value if raven is not enabled to prevent sending events upstream
-    // in debug mode
-    this.init(!disableRaven && HomeyModule.env.HOMEY_LOG_URL, { ...DEFAULT_OPTIONS, ...options });
-  }
-
-  /**
-   * Init Raven, provide falsy value as `url` to prevent sending events upstream in debug mode.
-   * @param {string|boolean} url
-   * @param {object} opts
-   * @param {boolean} opts.captureUnhandledRejections - Track unhandled promise rejections not
-   * enabled by default)
-   * @returns {Log}
-   * @private
-   */
-  init(url, opts) {
-    Raven.config(url, opts).install();
-
-    this.setTags({
-      appId: this._manifest.id,
-      appVersion: this._manifest.version,
-      homeyVersion: this._homeyVersion,
-    });
-
-    // Get homey cloud id and set as tag
-    this._managerCloud.getHomeyId()
-      .then(homeyId => this.setTags({ homeyId }))
-      .catch(err => Log._error('Error: could not get `homeyId`', err));
-
-    Log._log(`App ${this._manifest.id} v${this._manifest.version} logging on Homey v${this._homeyVersion}...`);
-    return this;
-  }
-
-  /**
-   * Set `tags` that will be send as context with every message or error. See the raven-node
-   * documentation: https://docs.sentry.io/clients/node/usage/#raven-node-additional-context.
-   * @param {object} tags
-   * @returns {Log}
-   */
-  setTags(tags) {
-    Log._mergeContext('tags', tags);
-    return this;
-  }
-
-  /**
-   * Set `extra` that will be send as context with every message or error. See the raven-node
-   * documentation: https://docs.sentry.io/clients/node/usage/#raven-node-additional-context.
-   * @param {object} extra
-   * @returns {Log}
-   */
-  setExtra(extra) {
-    Log._mergeContext('extra', extra);
-    return this;
-  }
-
-  /**
-   * Set `user` that will be send as context with every message or error. See the raven-node
-   * documentation: https://docs.sentry.io/clients/node/usage/#raven-node-additional-context.
-   * @param {object} user
-   * @returns {Log}
-   */
-  setUser(user) {
-    Log._mergeContext('user', user);
-    return this;
-  }
-
-  /**
-   * Create and send message event to Sentry. See the raven-node documentation:
-   * https://docs.sentry.io/clients/node/usage/#capturing-messages
-   * @param {string} message - Message to be sent
-   * @returns {Promise<string>|undefined}
-   */
-  async captureMessage(message) {
-    Log._log('captureMessage:', message);
-
-    if (this._capturedMessages.indexOf(message) > -1) {
-      Log._log('Prevented sending a duplicate message');
-      return;
-    }
-
-    this._capturedMessages.push(message);
-
-    // eslint-disable-next-line consistent-return
-    return new Promise((resolve, reject) => {
-      Raven.captureMessage(
-        message,
-        (err, result) => {
-          if (err) return reject(err);
-          return resolve(result);
-        },
-      );
-    });
-  }
-
-  /**
-   * Create and send exception event to Sentry. See the raven-node documentation:
-   * https://docs.sentry.io/clients/node/usage/#capturing-errors
-   * @param {Error} err - Error instance to be sent
-   * @returns {Promise<string>|undefined}
-   */
-  async captureException(err) {
-    Log._log('captureException:', err);
-
-    if (this._capturedExceptions.indexOf(err) > -1) {
-      Log._log('Prevented sending a duplicate log');
-      return;
-    }
-
-    this._capturedExceptions.push(err);
-
-    // eslint-disable-next-line consistent-return
-    return new Promise((resolve, reject) => {
-      Raven.captureException(
-        err,
-        (captureErr, result) => {
-          if (captureErr) return reject(captureErr);
-          return resolve(result);
-        },
-      );
-    });
-  }
-
-  /**
-   * Mimic SDK log method.
-   * @private
-   */
-  static _log() {
-    // eslint-disable-next-line prefer-spread,prefer-rest-params,no-console
-    console.log.bind(null, Log._logTime(), '[homey-log]').apply(null, arguments);
-  }
-
-  /**
-   * Mimic SDK error method.
-   * @private
-   */
-  static _error() {
-    // eslint-disable-next-line prefer-spread,prefer-rest-params,no-console
-    console.error.bind(null, Log._logTime(), '[homey-log]').apply(null, arguments);
-  }
-
-  /**
-   * Mimic SDK timestamp.
-   * @returns {string}
-   * @private
-   */
-  static _logTime() {
-    const date = new Date();
-
-    let mm = date.getMonth() + 1;
-    mm = (mm < 10 ? `0${mm}` : mm);
-    let dd = date.getDate();
-    dd = (dd < 10 ? `0${dd}` : dd);
-    let hh = date.getHours();
-    hh = (hh < 10 ? `0${hh}` : hh);
-    let min = date.getMinutes();
-    min = (min < 10 ? `0${min}` : min);
-    let sec = date.getSeconds();
-    sec = (sec < 10 ? `0${sec}` : sec);
-
-    return `${date.getFullYear()}-${mm}-${dd} ${hh}:${min}:${sec}`;
-  }
-
-  /**
-   * Raven.mergeContext covers only 1-level of the context (tags, extra, user)
-   * We need to merge a 2-level of the context
-   * see https://github.com/getsentry/raven-node/issues/228
-   * @param {string} key
-   * @param {object} value
-   * @private
-   */
-  static _mergeContext(key, value) {
-    const context = Raven.getContext();
-    if (!context[key]) {
-      context[key] = {};
-    }
-
-    Object.assign(context[key], value);
-    Raven.setContext(context);
-  }
-
-}
-
-module.exports = Log;

package/tsconfig.json

@@ -1,10 +0,0 @@
-{
-    "include": ["index.js"],
-    "compilerOptions": {
-      "allowJs": true,
-      "declaration": true,
-      "emitDeclarationOnly": true,
-      "esModuleInterop": true,
-      "outDir": "types"
-    }
-}

package/types/index.d.ts

@@ -1,2 +0,0 @@
-export { Log };
-import Log = require("./lib/Log");

package/types/lib/Log.d.ts

@@ -1,98 +0,0 @@
-export = Log;
-declare class Log {
-    /**
-     * Mimic SDK log method.
-     * @private
-     */
-    private static _log;
-    /**
-     * Mimic SDK error method.
-     * @private
-     */
-    private static _error;
-    /**
-     * Mimic SDK timestamp.
-     * @returns {string}
-     * @private
-     */
-    private static _logTime;
-    /**
-     * Raven.mergeContext covers only 1-level of the context (tags, extra, user)
-     * We need to merge a 2-level of the context
-     * see https://github.com/getsentry/raven-node/issues/228
-     * @param {string} key
-     * @param {object} value
-     * @private
-     */
-    private static _mergeContext;
-    /**
-     * Construct a new Log instance.
-     * @param {object} args
-     * @param {HomeyModule} args.homey - `this.homey` instance in
-     * your app (e.g. `App#homey`/`Driver#homey`/`Device#homey`).
-     *
-     * @param {object} [args.options] - Additional options for Raven
-     *
-     * @example
-     * class MyApp extends Homey.App {
-     *   onInit() {
-     *     this.homeyLog = new Log({ homey: this.homey });
-     *   }
-     * }
-     */
-    constructor({ homey, options }: {
-        homey: typeof HomeyModule;
-        options?: object;
-    });
-    _capturedMessages: any[];
-    _capturedExceptions: any[];
-    _manifest: any;
-    _homeyVersion: string;
-    _managerCloud: any;
-    /**
-     * Init Raven, provide falsy value as `url` to prevent sending events upstream in debug mode.
-     * @param {string|boolean} url
-     * @param {object} opts
-     * @param {boolean} opts.captureUnhandledRejections - Track unhandled promise rejections not
-     * enabled by default)
-     * @returns {Log}
-     * @private
-     */
-    private init;
-    /**
-     * Set `tags` that will be send as context with every message or error. See the raven-node
-     * documentation: https://docs.sentry.io/clients/node/usage/#raven-node-additional-context.
-     * @param {object} tags
-     * @returns {Log}
-     */
-    setTags(tags: object): Log;
-    /**
-     * Set `extra` that will be send as context with every message or error. See the raven-node
-     * documentation: https://docs.sentry.io/clients/node/usage/#raven-node-additional-context.
-     * @param {object} extra
-     * @returns {Log}
-     */
-    setExtra(extra: object): Log;
-    /**
-     * Set `user` that will be send as context with every message or error. See the raven-node
-     * documentation: https://docs.sentry.io/clients/node/usage/#raven-node-additional-context.
-     * @param {object} user
-     * @returns {Log}
-     */
-    setUser(user: object): Log;
-    /**
-     * Create and send message event to Sentry. See the raven-node documentation:
-     * https://docs.sentry.io/clients/node/usage/#capturing-messages
-     * @param {string} message - Message to be sent
-     * @returns {Promise<string>|undefined}
-     */
-    captureMessage(message: string): Promise<string> | undefined;
-    /**
-     * Create and send exception event to Sentry. See the raven-node documentation:
-     * https://docs.sentry.io/clients/node/usage/#capturing-errors
-     * @param {Error} err - Error instance to be sent
-     * @returns {Promise<string>|undefined}
-     */
-    captureException(err: Error): Promise<string> | undefined;
-}
-import HomeyModule = require("homey");