@mongodb-js/compass-logging 0.4.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,9 +1,11 @@
1
1
  import { MongoLogWriter, mongoLogId } from 'mongodb-log-writer';
2
2
  import createDebug from 'debug';
3
+ declare type TrackProps = Record<string, any> | (() => Record<string, any>);
4
+ declare type TrackFunction = (event: string, properties?: TrackProps) => void;
3
5
  export declare function createLoggerAndTelemetry(component: string): {
4
6
  log: ReturnType<MongoLogWriter['bindComponent']>;
5
7
  mongoLogId: typeof mongoLogId;
6
8
  debug: ReturnType<typeof createDebug>;
7
- track: (event: string, properties?: Record<string, any>) => void;
9
+ track: TrackFunction;
8
10
  };
9
11
  export default createLoggerAndTelemetry;
package/dist/index.js CHANGED
@@ -28,8 +28,25 @@ function createLoggerAndTelemetry(component) {
28
28
  },
29
29
  };
30
30
  const writer = new mongodb_log_writer_1.MongoLogWriter('', null, target);
31
- const track = (event, properties = {}) => {
32
- emit(ipc, 'compass:track', { event, properties });
31
+ const track = (...args) => {
32
+ void Promise.resolve()
33
+ .then(() => trackAsync(...args))
34
+ .catch((error) => debug('track failed', error));
35
+ };
36
+ const trackAsync = async (event, properties = {}) => {
37
+ var _a, _b;
38
+ const isTrackingEnabled = (_b = (_a = global) === null || _a === void 0 ? void 0 : _a.hadronApp) === null || _b === void 0 ? void 0 : _b.isFeatureEnabled('trackUsageStatistics');
39
+ if (!isTrackingEnabled) {
40
+ return;
41
+ }
42
+ const data = {
43
+ event,
44
+ properties,
45
+ };
46
+ if (typeof properties === 'function') {
47
+ data.properties = await properties();
48
+ }
49
+ emit(ipc, 'compass:track', data);
33
50
  };
34
51
  const debug = debug_1.default(`mongodb-compass:${component.toLowerCase()}`);
35
52
  writer.on('log', ({ s, ctx, msg, attr }) => {
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,2DAA+E;AAC/E,gFAAsD;AACtD,kDAAgC;AAIhC,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,KAAa,EAAE,aAAkC,EAAE,EAAQ,EAAE;QAC1E,IAAI,CAAC,GAAG,EAAE,eAAe,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC;IACpD,CAAC,CAAC;IAEF,MAAM,KAAK,GAAG,eAAW,CAAC,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;AA5CD,4DA4CC;AAED,kBAAe,wBAAwB,CAAC"}
1
+ {"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,eAAW,CAAC,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 CHANGED
@@ -13,7 +13,7 @@
13
13
  "email": "compass@mongodb.com"
14
14
  },
15
15
  "homepage": "https://github.com/mongodb-js/compass",
16
- "version": "0.4.0",
16
+ "version": "0.5.0",
17
17
  "repository": {
18
18
  "type": "git",
19
19
  "url": "https://github.com/mongodb-js/compass.git"
@@ -53,22 +53,22 @@
53
53
  "mongodb-log-writer": "^1.1.2"
54
54
  },
55
55
  "devDependencies": {
56
- "@mongodb-js/eslint-config-compass": "^0.4.0",
57
- "@mongodb-js/mocha-config-compass": "^0.5.0",
58
- "@mongodb-js/prettier-config-compass": "^0.3.0",
59
- "@mongodb-js/tsconfig-compass": "^0.3.0",
56
+ "@mongodb-js/eslint-config-compass": "^0.5.0",
57
+ "@mongodb-js/mocha-config-compass": "^0.6.0",
58
+ "@mongodb-js/prettier-config-compass": "^0.4.0",
59
+ "@mongodb-js/tsconfig-compass": "^0.4.0",
60
60
  "@types/chai": "^4.2.21",
61
61
  "@types/mocha": "^9.0.0",
62
62
  "@types/sinon-chai": "^3.2.5",
63
63
  "chai": "^4.3.4",
64
64
  "depcheck": "^1.4.1",
65
65
  "eslint": "^7.25.0",
66
- "hadron-ipc": "^2.6.0",
66
+ "hadron-ipc": "^2.7.0",
67
67
  "mocha": "^8.4.0",
68
68
  "nyc": "^15.1.0",
69
69
  "prettier": "2.3.2",
70
70
  "sinon": "^9.2.3",
71
71
  "typescript": "^4.3.5"
72
72
  },
73
- "gitHead": "8ef2cccaaab6d84a5fcd633ea8dfc4c7a4db551f"
73
+ "gitHead": "77166e3754e36e95c7ff7efb5a0ce5e0990b0ff7"
74
74
  }