@mongodb-js/compass-logging 0.2.0 → 0.6.0

package/dist/index.d.ts

@@ -1,6 +1,11 @@
 import { MongoLogWriter, mongoLogId } from 'mongodb-log-writer';
-declare function createLogger(component: string): {
+import createDebug from 'debug';
+declare type TrackProps = Record<string, any> | (() => Record<string, any>);
+declare type TrackFunction = (event: string, properties?: TrackProps) => void;
+export declare function createLoggerAndTelemetry(component: string): {
     log: ReturnType<MongoLogWriter['bindComponent']>;
     mongoLogId: typeof mongoLogId;
+    debug: ReturnType<typeof createDebug>;
+    track: TrackFunction;
 };
-export = createLogger;
+export default createLoggerAndTelemetry;

package/dist/index.js

@@ -2,24 +2,68 @@
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createLoggerAndTelemetry = void 0;
 const mongodb_log_writer_1 = require("mongodb-log-writer");
-const stream_1 = require("stream");
-const hadron_ipc_1 = __importDefault(require("hadron-ipc"));
-function createLogger(component) {
-    const target = new stream_1.Writable({
-        decodeStrings: false,
-        write(line, encoding, callback) {
-            var _a;
-            (_a = hadron_ipc_1.default.call) === null || _a === void 0 ? void 0 : _a.call(hadron_ipc_1.default, 'compass:log', { line });
-            process.emit('compass:log', { line });
+const is_electron_renderer_1 = __importDefault(require("is-electron-renderer"));
+const debug_1 = __importDefault(require("debug"));
+function emit(ipc, event, data) {
+    var _a;
+    (_a = ipc === null || ipc === void 0 ? void 0 : ipc.callQuiet) === null || _a === void 0 ? void 0 : _a.call(ipc, event, data);
+    if (typeof process !== 'undefined' && typeof process.emit === 'function') {
+        process.emit(event, data);
+    }
+}
+function createLoggerAndTelemetry(component) {
+    const ipc = is_electron_renderer_1.default
+        ? require('hadron-ipc')
+        : null;
+    const target = {
+        write(line, callback) {
+            emit(ipc, 'compass:log', { line });
             callback();
         },
-    });
+        end(callback) {
+            callback();
+        },
+    };
     const writer = new mongodb_log_writer_1.MongoLogWriter('', null, target);
+    const track = (...args) => {
+        void Promise.resolve()
+            .then(() => trackAsync(...args))
+            .catch((error) => debug('track failed', error));
+    };
+    const trackAsync = async (event, properties = {}) => {
+        var _a, _b;
+        const isTrackingEnabled = (_b = (_a = global) === null || _a === void 0 ? void 0 : _a.hadronApp) === null || _b === void 0 ? void 0 : _b.isFeatureEnabled('trackUsageStatistics');
+        if (!isTrackingEnabled) {
+            return;
+        }
+        const data = {
+            event,
+            properties,
+        };
+        if (typeof properties === 'function') {
+            data.properties = await properties();
+        }
+        emit(ipc, 'compass:track', data);
+    };
+    const debug = (0, debug_1.default)(`mongodb-compass:${component.toLowerCase()}`);
+    writer.on('log', ({ s, ctx, msg, attr }) => {
+        if (attr) {
+            debug(msg, { s, ctx, ...attr });
+        }
+        else {
+            debug(msg, { s, ctx });
+        }
+    });
     return {
         log: writer.bindComponent(component),
         mongoLogId: mongodb_log_writer_1.mongoLogId,
+        debug,
+        track,
     };
 }
-module.exports = createLogger;
+exports.createLoggerAndTelemetry = createLoggerAndTelemetry;
+exports.default = createLoggerAndTelemetry;
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,2DAAgE;AAChE,mCAAkC;AAClC,4DAA6B;AAE7B,SAAS,YAAY,CAAC,SAAiB;IAIrC,MAAM,MAAM,GAAG,IAAI,iBAAQ,CAAC;QAC1B,aAAa,EAAE,KAAK;QACpB,KAAK,CAAC,IAAY,EAAE,QAAiB,EAAE,QAAoB;;YAEzD,MAAA,oBAAG,CAAC,IAAI,+CAAR,oBAAG,EAAQ,aAAa,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;YACnC,OAAe,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;YAC/C,QAAQ,EAAE,CAAC;QACb,CAAC;KACF,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,IAAI,mCAAc,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACpD,OAAO;QACL,GAAG,EAAE,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC;QACpC,UAAU,EAAV,+BAAU;KACX,CAAC;AACJ,CAAC;AAED,iBAAS,YAAY,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,2DAA+E;AAC/E,gFAAsD;AACtD,kDAAgC;AAOhC,SAAS,IAAI,CACX,GAA6B,EAC7B,KAAa,EACb,IAAyB;;IAIzB,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,SAAS,+CAAd,GAAG,EAAc,KAAK,EAAE,IAAI,CAAC,CAAC;IAC9B,IAAI,OAAO,OAAO,KAAK,WAAW,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,UAAU,EAAE;QACvE,OAAe,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;KACpC;AACH,CAAC;AAED,SAAgB,wBAAwB,CAAC,SAAiB;IAOxD,MAAM,GAAG,GAA6B,8BAAkB;QACtD,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC;QACvB,CAAC,CAAC,IAAI,CAAC;IAMT,MAAM,MAAM,GAAG;QACb,KAAK,CAAC,IAAY,EAAE,QAAoB;YACtC,IAAI,CAAC,GAAG,EAAE,aAAa,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;YACnC,QAAQ,EAAE,CAAC;QACb,CAAC;QACD,GAAG,CAAC,QAAoB;YACtB,QAAQ,EAAE,CAAC;QACb,CAAC;KACU,CAAC;IACd,MAAM,MAAM,GAAG,IAAI,mCAAc,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IAEpD,MAAM,KAAK,GAAG,CAAC,GAAG,IAA2B,EAAE,EAAE;QAC/C,KAAK,OAAO,CAAC,OAAO,EAAE;aACnB,IAAI,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;aAC/B,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC;IAEF,MAAM,UAAU,GAAG,KAAK,EACtB,KAAa,EACb,aAAyB,EAAE,EACZ,EAAE;;QACjB,MAAM,iBAAiB,GAAG,MAAA,MAAC,MAAc,0CAAE,SAAS,0CAAE,gBAAgB,CACpE,sBAAsB,CACvB,CAAC;QACF,IAAI,CAAC,iBAAiB,EAAE;YACtB,OAAO;SACR;QACD,MAAM,IAAI,GAAG;YACX,KAAK;YACL,UAAU;SACX,CAAC;QACF,IAAI,OAAO,UAAU,KAAK,UAAU,EAAE;YACpC,IAAI,CAAC,UAAU,GAAG,MAAM,UAAU,EAAE,CAAC;SACtC;QACD,IAAI,CAAC,GAAG,EAAE,eAAe,EAAE,IAAI,CAAC,CAAC;IACnC,CAAC,CAAC;IAEF,MAAM,KAAK,GAAG,IAAA,eAAW,EAAC,mBAAmB,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;IACxE,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAiB,EAAE,EAAE;QACxD,IAAI,IAAI,EAAE;YACR,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;SACjC;aAAM;YACL,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;SACxB;IACH,CAAC,CAAC,CAAC;IACH,OAAO;QACL,GAAG,EAAE,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC;QACpC,UAAU,EAAV,+BAAU;QACV,KAAK;QACL,KAAK;KACN,CAAC;AACJ,CAAC;AAlED,4DAkEC;AAED,kBAAe,wBAAwB,CAAC"}

package/package.json

@@ -13,7 +13,7 @@
     "email": "compass@mongodb.com"
   },
   "homepage": "https://github.com/mongodb-js/compass",
-  "version": "0.2.0",
+  "version": "0.6.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/mongodb-js/compass.git"
@@ -26,6 +26,10 @@
     "hadron-ipc": "*"
   },
   "main": "dist/index.js",
+  "exports": {
+    "webpack": "./src/index.ts",
+    "require": "./dist/index.js"
+  },
   "types": "./dist/index.d.ts",
   "scripts": {
     "bootstrap": "npm run compile",
@@ -44,25 +48,27 @@
     "reformat": "npm run prettier -- --write ."
   },
   "dependencies": {
-    "mongodb-log-writer": "^1.0.3"
+    "debug": "4.3.0",
+    "is-electron-renderer": "^2.0.1",
+    "mongodb-log-writer": "^1.1.2"
   },
   "devDependencies": {
-    "@mongodb-js/eslint-config-compass": "^0.3.0",
-    "@mongodb-js/mocha-config-compass": "^0.3.0",
-    "@mongodb-js/prettier-config-compass": "^0.2.0",
-    "@mongodb-js/tsconfig-compass": "^0.2.0",
+    "@mongodb-js/eslint-config-compass": "^0.5.0",
+    "@mongodb-js/mocha-config-compass": "^0.7.0",
+    "@mongodb-js/prettier-config-compass": "^0.4.0",
+    "@mongodb-js/tsconfig-compass": "^0.4.0",
     "@types/chai": "^4.2.21",
     "@types/mocha": "^9.0.0",
     "@types/sinon-chai": "^3.2.5",
     "chai": "^4.3.4",
     "depcheck": "^1.4.1",
     "eslint": "^7.25.0",
-    "hadron-ipc": "^2.5.0",
+    "hadron-ipc": "^2.7.0",
     "mocha": "^8.4.0",
     "nyc": "^15.1.0",
     "prettier": "2.3.2",
     "sinon": "^9.2.3",
     "typescript": "^4.3.5"
   },
-  "gitHead": "455c6523f99a08c6796480d59727b53bdfa441f0"
+  "gitHead": "542e3fa07d48435b1a7acc21c96de20562b843b3"
 }