@mongodb-js/compass-logging 1.3.0 → 1.3.1

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,5 +1,5 @@
1
- export { createLoggerAndTelemetry } from './ipc-logger';
2
- export type { LoggerAndTelemetry } from './logger';
1
+ export { createLogger } from './ipc-logger';
2
+ export type { Logger } from './logger';
3
3
  export { mongoLogId } from 'mongodb-log-writer';
4
4
  import createDebug from 'debug';
5
5
  export declare const debug: createDebug.Debugger;
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AACxD,YAAY,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,WAAW,MAAM,OAAO,CAAC;AAChC,eAAO,MAAM,KAAK,sBAAiC,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,YAAY,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,WAAW,MAAM,OAAO,CAAC;AAChC,eAAO,MAAM,KAAK,sBAAiC,CAAC"}
package/dist/index.js CHANGED
@@ -3,9 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.debug = exports.mongoLogId = exports.createLoggerAndTelemetry = void 0;
6
+ exports.debug = exports.mongoLogId = exports.createLogger = void 0;
7
7
  var ipc_logger_1 = require("./ipc-logger");
8
- Object.defineProperty(exports, "createLoggerAndTelemetry", { enumerable: true, get: function () { return ipc_logger_1.createLoggerAndTelemetry; } });
8
+ Object.defineProperty(exports, "createLogger", { enumerable: true, get: function () { return ipc_logger_1.createLogger; } });
9
9
  var mongodb_log_writer_1 = require("mongodb-log-writer");
10
10
  Object.defineProperty(exports, "mongoLogId", { enumerable: true, get: function () { return mongodb_log_writer_1.mongoLogId; } });
11
11
  const debug_1 = __importDefault(require("debug"));
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,2CAAwD;AAA/C,sHAAA,wBAAwB,OAAA;AAEjC,yDAAgD;AAAvC,gHAAA,UAAU,OAAA;AACnB,kDAAgC;AACnB,QAAA,KAAK,GAAG,IAAA,eAAW,EAAC,iBAAiB,CAAC,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,2CAA4C;AAAnC,0GAAA,YAAY,OAAA;AAErB,yDAAgD;AAAvC,gHAAA,UAAU,OAAA;AACnB,kDAAgC;AACnB,QAAA,KAAK,GAAG,IAAA,eAAW,EAAC,iBAAiB,CAAC,CAAC"}
@@ -1,3 +1,2 @@
1
- import type { LoggingAndTelemetryPreferences } from './logger';
2
- export declare function createLoggerAndTelemetry(component: string, preferencesService?: LoggingAndTelemetryPreferences): import("./logger").LoggerAndTelemetry;
1
+ export declare function createLogger(component: string): import("./logger").Logger;
3
2
  //# sourceMappingURL=ipc-logger.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"ipc-logger.d.ts","sourceRoot":"","sources":["../src/ipc-logger.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,UAAU,CAAC;AAgB/D,wBAAgB,wBAAwB,CACtC,SAAS,EAAE,MAAM,EACjB,kBAAkB,CAAC,EAAE,8BAA8B,yCAYpD"}
1
+ {"version":3,"file":"ipc-logger.d.ts","sourceRoot":"","sources":["../src/ipc-logger.ts"],"names":[],"mappings":"AAiBA,wBAAgB,YAAY,CAAC,SAAS,EAAE,MAAM,6BAO7C"}
@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.createLoggerAndTelemetry = void 0;
6
+ exports.createLogger = void 0;
7
7
  const is_electron_renderer_1 = __importDefault(require("is-electron-renderer"));
8
8
  const logger_1 = require("./logger");
9
9
  function emit(ipc, event, data) {
@@ -12,12 +12,12 @@ function emit(ipc, event, data) {
12
12
  process.emit(event, data);
13
13
  }
14
14
  }
15
- function createLoggerAndTelemetry(component, preferencesService) {
15
+ function createLogger(component) {
16
16
  const ipc = is_electron_renderer_1.default
17
17
  ?
18
18
  require('hadron-ipc').ipcRenderer
19
19
  : null;
20
- return (0, logger_1.createGenericLoggerAndTelemetry)(component, emit.bind(null, ipc), preferencesService);
20
+ return (0, logger_1.createGenericLogger)(component, emit.bind(null, ipc));
21
21
  }
22
- exports.createLoggerAndTelemetry = createLoggerAndTelemetry;
22
+ exports.createLogger = createLogger;
23
23
  //# sourceMappingURL=ipc-logger.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"ipc-logger.js","sourceRoot":"","sources":["../src/ipc-logger.ts"],"names":[],"mappings":";;;;;;AAAA,gFAAsD;AAGtD,qCAA2D;AAE3D,SAAS,IAAI,CACX,GAAyC,EACzC,KAAa,EACb,IAAyB;IAIzB,KAAK,GAAG,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACnC,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,CACtC,SAAiB,EACjB,kBAAmD;IAGnD,MAAM,GAAG,GAAyC,8BAAkB;QAClE,CAAC;YACC,OAAO,CAAC,YAAY,CAAC,CAAC,WAAW;QACnC,CAAC,CAAC,IAAI,CAAC;IACT,OAAO,IAAA,wCAA+B,EACpC,SAAS,EACT,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,EACpB,kBAAkB,CACnB,CAAC;AACJ,CAAC;AAdD,4DAcC"}
1
+ {"version":3,"file":"ipc-logger.js","sourceRoot":"","sources":["../src/ipc-logger.ts"],"names":[],"mappings":";;;;;;AAAA,gFAAsD;AAEtD,qCAA+C;AAE/C,SAAS,IAAI,CACX,GAAyC,EACzC,KAAa,EACb,IAAyB;IAIzB,KAAK,GAAG,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACnC,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,YAAY,CAAC,SAAiB;IAE5C,MAAM,GAAG,GAAyC,8BAAkB;QAClE,CAAC;YACC,OAAO,CAAC,YAAY,CAAC,CAAC,WAAW;QACnC,CAAC,CAAC,IAAI,CAAC;IACT,OAAO,IAAA,4BAAmB,EAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;AAC9D,CAAC;AAPD,oCAOC"}
package/dist/logger.d.ts CHANGED
@@ -1,18 +1,9 @@
1
1
  import { MongoLogWriter, mongoLogId } from 'mongodb-log-writer';
2
2
  import createDebug from 'debug';
3
- export interface LoggingAndTelemetryPreferences {
4
- getPreferences(): {
5
- trackUsageStatistics: boolean;
6
- };
7
- }
8
- type TrackProps = Record<string, any> | (() => Record<string, any>);
9
- type TrackFunction = (event: string, properties?: TrackProps) => void;
10
- export type LoggerAndTelemetry = {
3
+ export type Logger = {
11
4
  log: ReturnType<MongoLogWriter['bindComponent']>;
12
5
  mongoLogId: typeof mongoLogId;
13
6
  debug: ReturnType<typeof createDebug>;
14
- track: TrackFunction;
15
7
  };
16
- export declare function createGenericLoggerAndTelemetry(component: string, emit: (event: string, arg: any) => void, preferencesService?: LoggingAndTelemetryPreferences): LoggerAndTelemetry;
17
- export {};
8
+ export declare function createGenericLogger(component: string, emit: (event: string, arg: any) => void): Logger;
18
9
  //# sourceMappingURL=logger.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,WAAW,MAAM,OAAO,CAAC;AAGhC,MAAM,WAAW,8BAA8B;IAC7C,cAAc,IAAI;QAAE,oBAAoB,EAAE,OAAO,CAAA;KAAE,CAAC;CACrD;AAED,KAAK,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;AACpE,KAAK,aAAa,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,UAAU,KAAK,IAAI,CAAC;AAEtE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,GAAG,EAAE,UAAU,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC,CAAC;IACjD,UAAU,EAAE,OAAO,UAAU,CAAC;IAC9B,KAAK,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,CAAC;IACtC,KAAK,EAAE,aAAa,CAAC;CACtB,CAAC;AAEF,wBAAgB,+BAA+B,CAC7C,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,KAAK,IAAI,EACvC,kBAAkB,CAAC,EAAE,8BAA8B,GAClD,kBAAkB,CAqFpB"}
1
+ {"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,WAAW,MAAM,OAAO,CAAC;AAGhC,MAAM,MAAM,MAAM,GAAG;IACnB,GAAG,EAAE,UAAU,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC,CAAC;IACjD,UAAU,EAAE,OAAO,UAAU,CAAC;IAC9B,KAAK,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,CAAC;CACvC,CAAC;AAEF,wBAAgB,mBAAmB,CACjC,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,KAAK,IAAI,GACtC,MAAM,CA8BR"}
package/dist/logger.js CHANGED
@@ -3,10 +3,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.createGenericLoggerAndTelemetry = void 0;
6
+ exports.createGenericLogger = void 0;
7
7
  const mongodb_log_writer_1 = require("mongodb-log-writer");
8
8
  const debug_1 = __importDefault(require("debug"));
9
- function createGenericLoggerAndTelemetry(component, emit, preferencesService) {
9
+ function createGenericLogger(component, emit) {
10
10
  const target = {
11
11
  write(line, callback) {
12
12
  emit('compass:log', { line });
@@ -18,40 +18,6 @@ function createGenericLoggerAndTelemetry(component, emit, preferencesService) {
18
18
  };
19
19
  const writer = new mongodb_log_writer_1.MongoLogWriter('', null, target);
20
20
  const log = writer.bindComponent(component);
21
- const track = (...args) => {
22
- void Promise.resolve()
23
- .then(() => trackAsync(...args))
24
- .catch((error) => debug('track failed', error));
25
- };
26
- const trackAsync = async (event, properties = {}) => {
27
- const { trackUsageStatistics = true } = preferencesService?.getPreferences() ?? {};
28
- if (!trackUsageStatistics) {
29
- return;
30
- }
31
- const data = {
32
- event,
33
- properties,
34
- };
35
- if (typeof properties === 'function') {
36
- try {
37
- data.properties = await properties();
38
- }
39
- catch (error) {
40
- emit('compass:track', {
41
- event: 'Error Fetching Attributes',
42
- properties: {
43
- event_name: event,
44
- },
45
- });
46
- log.error((0, mongodb_log_writer_1.mongoLogId)(1001000190), 'Telemetry', 'Error computing event properties for telemetry', {
47
- event,
48
- error: error.stack,
49
- });
50
- return;
51
- }
52
- }
53
- emit('compass:track', data);
54
- };
55
21
  const debug = (0, debug_1.default)(`mongodb-compass:${component.toLowerCase()}`);
56
22
  writer.on('log', ({ s, ctx, msg, attr }) => {
57
23
  if (attr) {
@@ -65,8 +31,7 @@ function createGenericLoggerAndTelemetry(component, emit, preferencesService) {
65
31
  log,
66
32
  mongoLogId: mongodb_log_writer_1.mongoLogId,
67
33
  debug,
68
- track,
69
34
  };
70
35
  }
71
- exports.createGenericLoggerAndTelemetry = createGenericLoggerAndTelemetry;
36
+ exports.createGenericLogger = createGenericLogger;
72
37
  //# sourceMappingURL=logger.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"logger.js","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":";;;;;;AACA,2DAAgE;AAChE,kDAAgC;AAiBhC,SAAgB,+BAA+B,CAC7C,SAAiB,EACjB,IAAuC,EACvC,kBAAmD;IAMnD,MAAM,MAAM,GAAG;QACb,KAAK,CAAC,IAAY,EAAE,QAAoB;YACtC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;YAC9B,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;IACpD,MAAM,GAAG,GAAG,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAE5C,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;QAIjB,MAAM,EAAE,oBAAoB,GAAG,IAAI,EAAE,GACnC,kBAAkB,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC;QAE7C,IAAI,CAAC,oBAAoB,EAAE;YACzB,OAAO;SACR;QAED,MAAM,IAAI,GAAG;YACX,KAAK;YACL,UAAU;SACX,CAAC;QACF,IAAI,OAAO,UAAU,KAAK,UAAU,EAAE;YACpC,IAAI;gBACF,IAAI,CAAC,UAAU,GAAG,MAAM,UAAU,EAAE,CAAC;aACtC;YAAC,OAAO,KAAK,EAAE;gBAKd,IAAI,CAAC,eAAe,EAAE;oBACpB,KAAK,EAAE,2BAA2B;oBAClC,UAAU,EAAE;wBACV,UAAU,EAAE,KAAK;qBAClB;iBACF,CAAC,CAAC;gBACH,GAAG,CAAC,KAAK,CACP,IAAA,+BAAU,EAAC,UAAa,CAAC,EACzB,WAAW,EACX,gDAAgD,EAChD;oBACE,KAAK;oBACL,KAAK,EAAG,KAAe,CAAC,KAAK;iBAC9B,CACF,CAAC;gBAEF,OAAO;aACR;SACF;QACD,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;IAC9B,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;QACH,UAAU,EAAV,+BAAU;QACV,KAAK;QACL,KAAK;KACN,CAAC;AACJ,CAAC;AAzFD,0EAyFC"}
1
+ {"version":3,"file":"logger.js","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":";;;;;;AACA,2DAAgE;AAChE,kDAAgC;AAShC,SAAgB,mBAAmB,CACjC,SAAiB,EACjB,IAAuC;IAMvC,MAAM,MAAM,GAAG;QACb,KAAK,CAAC,IAAY,EAAE,QAAoB;YACtC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;YAC9B,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;IACpD,MAAM,GAAG,GAAG,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAE5C,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;QACH,UAAU,EAAV,+BAAU;QACV,KAAK;KACN,CAAC;AACJ,CAAC;AAjCD,kDAiCC"}
@@ -1,21 +1,17 @@
1
1
  import React from 'react';
2
- import type { LoggerAndTelemetry, LoggingAndTelemetryPreferences } from './logger';
2
+ import type { Logger } from './logger';
3
3
  import type { MongoLogId } from 'mongodb-log-writer';
4
- export type { LoggerAndTelemetry } from './logger';
5
- export declare function createNoopLoggerAndTelemetry(component?: string): LoggerAndTelemetry;
6
- export declare const LoggerAndTelemetryProvider: React.Provider<{
7
- createLogger(component: string, preferences: LoggingAndTelemetryPreferences): LoggerAndTelemetry;
8
- preferences?: LoggingAndTelemetryPreferences | undefined;
4
+ export type { Logger } from './logger';
5
+ export declare function createNoopLogger(component?: string): Logger;
6
+ export declare const LoggerProvider: React.Provider<{
7
+ createLogger(component: string): Logger;
9
8
  }>;
10
- export declare function createLoggerAndTelemetryLocator(component: string): () => LoggerAndTelemetry;
11
- export declare function useLoggerAndTelemetry(component: string): LoggerAndTelemetry;
12
- export declare function useTrackOnChange(component: string, onChange: (track: LoggerAndTelemetry['track']) => void, dependencies: unknown[], options?: {
13
- skipOnMount: boolean;
14
- }): void;
9
+ export declare function createLoggerLocator(component: string): () => Logger;
10
+ export declare function useLogger(component: string): Logger;
15
11
  type FirstArgument<F> = F extends (...args: [infer A, ...any]) => any ? A : F extends {
16
12
  new (...args: [infer A, ...any]): any;
17
13
  } ? A : never;
18
- export declare function withLoggerAndTelemetry<T extends ((...args: any[]) => any) | {
14
+ export declare function withLogger<T extends ((...args: any[]) => any) | {
19
15
  new (...args: any[]): any;
20
16
  }>(ReactComponent: T, component: string): React.FunctionComponent<Omit<FirstArgument<T>, 'logger'>>;
21
17
  export declare function mongoLogId(id: number): MongoLogId;
@@ -1 +1 @@
1
- {"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,KAAK,EACV,kBAAkB,EAClB,8BAA8B,EAC/B,MAAM,UAAU,CAAC;AAClB,OAAO,KAAK,EAAE,UAAU,EAAkB,MAAM,oBAAoB,CAAC;AAGrE,YAAY,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAMnD,wBAAgB,4BAA4B,CAC1C,SAAS,SAAgB,GACxB,kBAAkB,CAkBpB;AAUD,eAAO,MAAM,0BAA0B;4BANxB,MAAM,eACJ,8BAA8B,GAC1C,kBAAkB;;EAIqD,CAAC;AAE7E,wBAAgB,+BAA+B,CAAC,SAAS,EAAE,MAAM,4BAKhE;AAED,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,MAAM,GAAG,kBAAkB,CAiB3E;AAED,wBAAgB,gBAAgB,CAC9B,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,CAAC,KAAK,EAAE,kBAAkB,CAAC,OAAO,CAAC,KAAK,IAAI,EACtD,YAAY,EAAE,OAAO,EAAE,EACvB,OAAO,GAAE;IAAE,WAAW,EAAE,OAAO,CAAA;CAA2B,QAa3D;AAED,KAAK,aAAa,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,GAAG,CAAC,KAAK,GAAG,GACjE,CAAC,GACD,CAAC,SAAS;IAAE,KAAK,GAAG,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,GAAG,CAAC,GAAG,GAAG,CAAA;CAAE,GACnD,CAAC,GACD,KAAK,CAAC;AAEV,wBAAgB,sBAAsB,CACpC,CAAC,SAAS,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,GAAG;IAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,GAAG,CAAA;CAAE,EAEnE,cAAc,EAAE,CAAC,EACjB,SAAS,EAAE,MAAM,GAChB,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAQ3D;AAQD,wBAAgB,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU,CAEjD;AAED,YAAY,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC"}
1
+ {"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAiB,MAAM,OAAO,CAAC;AACtC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,UAAU,EAAkB,MAAM,oBAAoB,CAAC;AAGrE,YAAY,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAMvC,wBAAgB,gBAAgB,CAAC,SAAS,SAAgB,GAAG,MAAM,CAiBlE;AAMD,eAAO,MAAM,cAAc;4BAHD,MAAM,GAAG,MAAM;EAGW,CAAC;AAErD,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,MAAM,gBAKpD;AAED,wBAAgB,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAUnD;AAED,KAAK,aAAa,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,GAAG,CAAC,KAAK,GAAG,GACjE,CAAC,GACD,CAAC,SAAS;IAAE,KAAK,GAAG,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,GAAG,CAAC,GAAG,GAAG,CAAA;CAAE,GACnD,CAAC,GACD,KAAK,CAAC;AAEV,wBAAgB,UAAU,CACxB,CAAC,SAAS,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,GAAG;IAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,GAAG,CAAA;CAAE,EAEnE,cAAc,EAAE,CAAC,EACjB,SAAS,EAAE,MAAM,GAChB,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAQ3D;AAQD,wBAAgB,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU,CAEjD;AAED,YAAY,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC"}
package/dist/provider.js CHANGED
@@ -1,14 +1,34 @@
1
1
  "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || function (mod) {
19
+ if (mod && mod.__esModule) return mod;
20
+ var result = {};
21
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
+ __setModuleDefault(result, mod);
23
+ return result;
4
24
  };
5
25
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.mongoLogId = exports.withLoggerAndTelemetry = exports.useTrackOnChange = exports.useLoggerAndTelemetry = exports.createLoggerAndTelemetryLocator = exports.LoggerAndTelemetryProvider = exports.createNoopLoggerAndTelemetry = void 0;
7
- const react_1 = __importDefault(require("react"));
26
+ exports.mongoLogId = exports.withLogger = exports.useLogger = exports.createLoggerLocator = exports.LoggerProvider = exports.createNoopLogger = void 0;
27
+ const react_1 = __importStar(require("react"));
8
28
  const hadron_app_registry_1 = require("hadron-app-registry");
9
29
  const noop = () => {
10
30
  };
11
- function createNoopLoggerAndTelemetry(component = 'NOOP-LOGGER') {
31
+ function createNoopLogger(component = 'NOOP-LOGGER') {
12
32
  return {
13
33
  log: {
14
34
  component,
@@ -23,55 +43,36 @@ function createNoopLoggerAndTelemetry(component = 'NOOP-LOGGER') {
23
43
  debug: noop,
24
44
  },
25
45
  debug: noop,
26
- track: noop,
27
46
  mongoLogId,
28
47
  };
29
48
  }
30
- exports.createNoopLoggerAndTelemetry = createNoopLoggerAndTelemetry;
31
- const LoggerAndTelemetryContext = react_1.default.createContext({ createLogger: createNoopLoggerAndTelemetry });
32
- exports.LoggerAndTelemetryProvider = LoggerAndTelemetryContext.Provider;
33
- function createLoggerAndTelemetryLocator(component) {
34
- return (0, hadron_app_registry_1.createServiceLocator)(useLoggerAndTelemetry.bind(null, component), 'createLoggerAndTelemetryLocator');
49
+ exports.createNoopLogger = createNoopLogger;
50
+ const LoggerContext = react_1.default.createContext({ createLogger: createNoopLogger });
51
+ exports.LoggerProvider = LoggerContext.Provider;
52
+ function createLoggerLocator(component) {
53
+ return (0, hadron_app_registry_1.createServiceLocator)(useLogger.bind(null, component), 'createLoggerLocator');
35
54
  }
36
- exports.createLoggerAndTelemetryLocator = createLoggerAndTelemetryLocator;
37
- function useLoggerAndTelemetry(component) {
38
- const context = react_1.default.useContext(LoggerAndTelemetryContext);
55
+ exports.createLoggerLocator = createLoggerLocator;
56
+ function useLogger(component) {
57
+ const context = react_1.default.useContext(LoggerContext);
39
58
  if (!context) {
40
- throw new Error('LoggerAndTelemetry service is missing from React context');
59
+ throw new Error('Logger service is missing from React context');
41
60
  }
42
- const loggerRef = react_1.default.createRef();
61
+ const loggerRef = (0, react_1.useRef)();
43
62
  if (!loggerRef.current) {
44
- loggerRef.current = context.createLogger(component, context.preferences ?? {
45
- getPreferences() {
46
- return { trackUsageStatistics: true };
47
- },
48
- });
63
+ loggerRef.current = context.createLogger(component);
49
64
  }
50
65
  return loggerRef.current;
51
66
  }
52
- exports.useLoggerAndTelemetry = useLoggerAndTelemetry;
53
- function useTrackOnChange(component, onChange, dependencies, options = { skipOnMount: false }) {
54
- const onChangeRef = react_1.default.useRef(onChange);
55
- onChangeRef.current = onChange;
56
- const { track } = useLoggerAndTelemetry(component);
57
- let initial = true;
58
- react_1.default.useEffect(() => {
59
- if (options.skipOnMount && initial) {
60
- initial = false;
61
- return;
62
- }
63
- onChangeRef.current(track);
64
- }, [...dependencies, track]);
65
- }
66
- exports.useTrackOnChange = useTrackOnChange;
67
- function withLoggerAndTelemetry(ReactComponent, component) {
68
- const WithLoggerAndTelemetry = (props) => {
69
- const logger = useLoggerAndTelemetry(component);
67
+ exports.useLogger = useLogger;
68
+ function withLogger(ReactComponent, component) {
69
+ const WithLogger = (props) => {
70
+ const logger = useLogger(component);
70
71
  return react_1.default.createElement(ReactComponent, { ...props, logger });
71
72
  };
72
- return WithLoggerAndTelemetry;
73
+ return WithLogger;
73
74
  }
74
- exports.withLoggerAndTelemetry = withLoggerAndTelemetry;
75
+ exports.withLogger = withLogger;
75
76
  function mongoLogId(id) {
76
77
  return { __value: id };
77
78
  }
@@ -1 +1 @@
1
- {"version":3,"file":"provider.js","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAM1B,6DAA2D;AAI3D,MAAM,IAAI,GAAG,GAAG,EAAE;AAElB,CAAC,CAAC;AAEF,SAAgB,4BAA4B,CAC1C,SAAS,GAAG,aAAa;IAEzB,OAAO;QACL,GAAG,EAAE;YACH,SAAS;YACT,IAAI,OAAO;gBACT,OAAO,IAAiC,CAAC;YAC3C,CAAC;YACD,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI;YACjB,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,IAAI;YACX,KAAK,EAAE,IAAI;YACX,KAAK,EAAE,IAAI;SACZ;QACD,KAAK,EAAE,IAA8C;QACrD,KAAK,EAAE,IAAI;QACX,UAAU;KACX,CAAC;AACJ,CAAC;AApBD,oEAoBC;AAED,MAAM,yBAAyB,GAAG,eAAK,CAAC,aAAa,CAMlD,EAAE,YAAY,EAAE,4BAA4B,EAAE,CAAC,CAAC;AAEtC,QAAA,0BAA0B,GAAG,yBAAyB,CAAC,QAAQ,CAAC;AAE7E,SAAgB,+BAA+B,CAAC,SAAiB;IAC/D,OAAO,IAAA,0CAAoB,EACzB,qBAAqB,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,EAC3C,iCAAiC,CAClC,CAAC;AACJ,CAAC;AALD,0EAKC;AAED,SAAgB,qBAAqB,CAAC,SAAiB;IACrD,MAAM,OAAO,GAAG,eAAK,CAAC,UAAU,CAAC,yBAAyB,CAAC,CAAC;IAC5D,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;KAC7E;IACD,MAAM,SAAS,GAAG,eAAK,CAAC,SAAS,EAAsB,CAAC;IACxD,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE;QACrB,SAAiB,CAAC,OAAO,GAAG,OAAO,CAAC,YAAY,CAC/C,SAAS,EACT,OAAO,CAAC,WAAW,IAAI;YACrB,cAAc;gBACZ,OAAO,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAAC;YACxC,CAAC;SACF,CACF,CAAC;KACH;IACD,OAAO,SAAS,CAAC,OAAQ,CAAC;AAC5B,CAAC;AAjBD,sDAiBC;AAED,SAAgB,gBAAgB,CAC9B,SAAiB,EACjB,QAAsD,EACtD,YAAuB,EACvB,UAAoC,EAAE,WAAW,EAAE,KAAK,EAAE;IAE1D,MAAM,WAAW,GAAG,eAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC3C,WAAW,CAAC,OAAO,GAAG,QAAQ,CAAC;IAC/B,MAAM,EAAE,KAAK,EAAE,GAAG,qBAAqB,CAAC,SAAS,CAAC,CAAC;IACnD,IAAI,OAAO,GAAG,IAAI,CAAC;IACnB,eAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,IAAI,OAAO,CAAC,WAAW,IAAI,OAAO,EAAE;YAClC,OAAO,GAAG,KAAK,CAAC;YAChB,OAAO;SACR;QACD,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC,EAAE,CAAC,GAAG,YAAY,EAAE,KAAK,CAAC,CAAC,CAAC;AAC/B,CAAC;AAjBD,4CAiBC;AAQD,SAAgB,sBAAsB,CAGpC,cAAiB,EACjB,SAAiB;IAEjB,MAAM,sBAAsB,GAAG,CAC7B,KAA0D,EAC1D,EAAE;QACF,MAAM,MAAM,GAAG,qBAAqB,CAAC,SAAS,CAAC,CAAC;QAChD,OAAO,eAAK,CAAC,aAAa,CAAC,cAAc,EAAE,EAAE,GAAG,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;IACnE,CAAC,CAAC;IACF,OAAO,sBAAsB,CAAC;AAChC,CAAC;AAbD,wDAaC;AAQD,SAAgB,UAAU,CAAC,EAAU;IACnC,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;AACzB,CAAC;AAFD,gCAEC"}
1
+ {"version":3,"file":"provider.js","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAAsC;AAGtC,6DAA2D;AAI3D,MAAM,IAAI,GAAG,GAAG,EAAE;AAElB,CAAC,CAAC;AAEF,SAAgB,gBAAgB,CAAC,SAAS,GAAG,aAAa;IACxD,OAAO;QACL,GAAG,EAAE;YACH,SAAS;YACT,IAAI,OAAO;gBACT,OAAO,IAAiC,CAAC;YAC3C,CAAC;YACD,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI;YACjB,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,IAAI;YACX,KAAK,EAAE,IAAI;YACX,KAAK,EAAE,IAAI;SACZ;QACD,KAAK,EAAE,IAAkC;QACzC,UAAU;KACX,CAAC;AACJ,CAAC;AAjBD,4CAiBC;AAED,MAAM,aAAa,GAAG,eAAK,CAAC,aAAa,CAEtC,EAAE,YAAY,EAAE,gBAAgB,EAAE,CAAC,CAAC;AAE1B,QAAA,cAAc,GAAG,aAAa,CAAC,QAAQ,CAAC;AAErD,SAAgB,mBAAmB,CAAC,SAAiB;IACnD,OAAO,IAAA,0CAAoB,EACzB,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,EAC/B,qBAAqB,CACtB,CAAC;AACJ,CAAC;AALD,kDAKC;AAED,SAAgB,SAAS,CAAC,SAAiB;IACzC,MAAM,OAAO,GAAG,eAAK,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IAChD,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;KACjE;IACD,MAAM,SAAS,GAAG,IAAA,cAAM,GAAU,CAAC;IACnC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE;QACtB,SAAS,CAAC,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;KACrD;IACD,OAAO,SAAS,CAAC,OAAO,CAAC;AAC3B,CAAC;AAVD,8BAUC;AAQD,SAAgB,UAAU,CAGxB,cAAiB,EACjB,SAAiB;IAEjB,MAAM,UAAU,GAAG,CACjB,KAA0D,EAC1D,EAAE;QACF,MAAM,MAAM,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;QACpC,OAAO,eAAK,CAAC,aAAa,CAAC,cAAc,EAAE,EAAE,GAAG,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;IACnE,CAAC,CAAC;IACF,OAAO,UAAU,CAAC;AACpB,CAAC;AAbD,gCAaC;AAQD,SAAgB,UAAU,CAAC,EAAU;IACnC,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;AACzB,CAAC;AAFD,gCAEC"}
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": "1.3.0",
16
+ "version": "1.3.1",
17
17
  "repository": {
18
18
  "type": "git",
19
19
  "url": "https://github.com/mongodb-js/compass.git"
@@ -52,14 +52,14 @@
52
52
  },
53
53
  "dependencies": {
54
54
  "debug": "^4.3.4",
55
- "hadron-app-registry": "^9.1.11",
56
- "hadron-ipc": "^3.2.15",
55
+ "hadron-app-registry": "^9.1.12",
56
+ "hadron-ipc": "^3.2.16",
57
57
  "is-electron-renderer": "^2.0.1",
58
58
  "mongodb-log-writer": "^1.4.2",
59
59
  "react": "^17.0.2"
60
60
  },
61
61
  "devDependencies": {
62
- "@mongodb-js/eslint-config-compass": "^1.1.1",
62
+ "@mongodb-js/eslint-config-compass": "^1.1.2",
63
63
  "@mongodb-js/mocha-config-compass": "^1.3.9",
64
64
  "@mongodb-js/prettier-config-compass": "^1.0.2",
65
65
  "@mongodb-js/tsconfig-compass": "^1.0.4",
@@ -79,5 +79,5 @@
79
79
  "optionalPeerDependencies": {
80
80
  "compass-preferences-model": "^2.0.0"
81
81
  },
82
- "gitHead": "0acfcb0d2533f0282b45e2bc24bdfb571d3dc797"
82
+ "gitHead": "c6f308665ee6096169843a5623def8158da0a32a"
83
83
  }