@mongosh/logging 3.0.0 → 3.4.0

package/src/helpers.spec.ts

@@ -0,0 +1,26 @@
+import { expect } from 'chai';
+import { toSnakeCase } from './helpers';
+
+describe('logging helpers', function () {
+  describe('toSnakeCase', function () {
+    const useCases = [
+      { input: 'MongoDB REPL', output: 'mongo_db_repl' },
+      {
+        input: 'Node.js REPL Instantiation',
+        output: 'node_js_repl_instantiation',
+      },
+      { input: 'A', output: 'a' },
+      {
+        input: 'OneLongThingInPascalCase',
+        output: 'one_long_thing_in_pascal_case',
+      },
+      { input: 'Removes .Dots in Node.js', output: 'removes_dots_in_node_js' },
+    ];
+
+    for (const { input, output } of useCases) {
+      it(`should convert ${input} to ${output}`, function () {
+        expect(toSnakeCase(input)).to.equal(output);
+      });
+    }
+  });
+});

package/src/helpers.ts

@@ -0,0 +1,49 @@
+/**
+ * A helper class for keeping track of how often specific events occurred.
+ */
+export class MultiSet<T extends Record<string, unknown>> {
+  _entries: Map<string, number> = new Map();
+
+  add(entry: T): void {
+    const key = JSON.stringify(Object.entries(entry).sort());
+    this._entries.set(key, (this._entries.get(key) ?? 0) + 1);
+  }
+
+  clear(): void {
+    this._entries.clear();
+  }
+
+  *[Symbol.iterator](): Iterator<[T, number]> {
+    for (const [key, count] of this._entries) {
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+      yield [Object.fromEntries(JSON.parse(key)) as T, count];
+    }
+  }
+}
+
+/**
+ * It transforms a random string into snake case. Snake case is completely
+ * lowercase and uses '_' to separate words. For example:
+ *
+ * This function defines a "word" as a sequence of characters until the next `.` or capital letter.
+ *
+ * 'Random String' => 'random_string'
+ *
+ * It will also remove any non alphanumeric characters to ensure the string
+ * is compatible with Segment. For example:
+ *
+ * 'Node.js REPL Instantiation' => 'node_js_repl_instantiation'
+ *
+ * @param str Any non snake-case formatted string
+ * @returns The snake-case formatted string
+ */
+export function toSnakeCase(str: string): string {
+  const matches = str.match(
+    /[A-Z]{2,}(?=[A-Z][a-z]+[0-9]*|\b)|[A-Z]?[a-z]+[0-9]*|[A-Z]|[0-9]+/g
+  );
+  if (!matches) {
+    return str;
+  }
+
+  return matches.map((x) => x.toLowerCase()).join('_');
+}

package/src/index.ts

@@ -1,4 +1,3 @@
-export { setupLoggerAndTelemetry } from './setup-logger-and-telemetry';
 export {
   MongoshAnalytics,
   ToggleableAnalytics,
@@ -6,3 +5,5 @@ export {
   NoopAnalytics,
   ThrottledAnalytics,
 } from './analytics-helpers';
+export { MongoshLoggingAndTelemetry } from './types';
+export { setupLoggingAndTelemetry } from './logging-and-telemetry';