fix(cli-repl): Detect containerized environment and disable telemetry M…

…ONGOSH-1278 (#1326) * fix(cli-repl): Detect containerized environment and disable telemetry MONGOSH-1278 * test(cli-repl): Add tests for telemetry disabling * fix(cli-repl): Explicit return types and stricter regexp Co-authored-by: Anna Henningsen <[email protected]> Co-authored-by: Anna Henningsen <[email protected]>
mongodb-js · Jul 27, 2022 · 22b07d8 · 22b07d8
1 parent 567160b
commit 22b07d8
Show file tree

Hide file tree

Showing 4 changed files with 59 additions and 3 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/cli-repl/src/cli-repl.spec.ts b/packages/cli-repl/src/cli-repl.spec.ts
@@ -946,6 +946,18 @@ describe('CliRepl', () => {
           expect(requests).to.have.lengthOf(2);
         });
 
+        it('sends out telemetry if the repl is running in an interactive mode in a containerized environment', async() => {
+          cliRepl = new CliRepl(cliReplOptions);
+          cliRepl.getIsContainerizedEnvironment = () => {
+            return Promise.resolve(true);
+          };
+          await cliRepl.start(await testServer.connectionString(), {});
+          input.write('db.hello()\n');
+          input.write('exit\n');
+          await waitBus(cliRepl.bus, 'mongosh:closed');
+          expect(requests).to.have.lengthOf(2);
+        });
+
         it('does not send out telemetry if the user starts with a no-telemetry config', async() => {
           await fs.writeFile(path.join(tmpdir.path, 'config'), EJSON.stringify({ enableTelemetry: false }));
           await cliRepl.start(await testServer.connectionString(), {});
@@ -986,6 +998,19 @@ describe('CliRepl', () => {
           expect(requests).to.have.lengthOf(0);
         });
 
+        it('does not send out telemetry if the repl is running in non-interactive mode in a containerized environment', async() => {
+          cliReplOptions.shellCliOptions.eval = ['db.hello()'];
+          cliRepl = new CliRepl(cliReplOptions);
+          cliRepl.getIsContainerizedEnvironment = () => {
+            return Promise.resolve(true);
+          };
+          await startWithExpectedImmediateExit(
+            cliRepl,
+            await testServer.connectionString()
+          );
+          expect(requests).to.have.lengthOf(0);
+        });
+
         context('with a 5.0+ server', () => {
           skipIfServerVersion(testServer, '<= 4.4');
 

diff --git a/packages/cli-repl/src/cli-repl.ts b/packages/cli-repl/src/cli-repl.ts
@@ -95,6 +95,7 @@ class CliRepl implements MongoshIOProvider {
   warnedAboutInaccessibleFiles = false;
   onExit: (code?: number) => Promise<never>;
   closing = false;
+  isContainerizedEnvironment = false;
 
   /**
    * Instantiate the new CLI Repl.
@@ -155,6 +156,29 @@ class CliRepl implements MongoshIOProvider {
     });
   }
 
+  async getIsContainerizedEnvironment() {
+    // Check for dockerenv file first
+    try {
+      await fs.stat('/.dockerenv');
+      return true;
+    } catch {
+      try {
+        // Check if there is any mention of docker / lxc / k8s in control groups
+        const cgroup = await fs.readFile('/proc/self/cgroup', 'utf8');
+        return /\b(docker|lxc|kubepods)\b/.test(cgroup);
+      } catch {
+        return false;
+      }
+    }
+  }
+
+  get forceDisableTelemetry(): boolean {
+    return (
+      this.globalConfig?.forceDisableTelemetry ||
+      (this.isContainerizedEnvironment && !this.mongoshRepl.isInteractive)
+    );
+  }
+
   /**
    * Setup CLI environment: serviceProvider, ShellEvaluator, log connection
    * information, external editor, and finally start the repl.
@@ -167,6 +191,9 @@ class CliRepl implements MongoshIOProvider {
     const { version } = require('../package.json');
     await this.verifyNodeVersion();
 
+    this.isContainerizedEnvironment =
+      await this.getIsContainerizedEnvironment();
+
     if (!this.cliOptions.nodb) {
       const cs = new ConnectionString(driverUri);
       const searchParams = cs.typedSearchParams<DevtoolsConnectOptions>();
@@ -215,7 +242,8 @@ class CliRepl implements MongoshIOProvider {
       this.toggleableAnalytics,
       {
         platform: process.platform,
-        arch: process.arch
+        arch: process.arch,
+        is_containerized: this.isContainerizedEnvironment,
       },
       require('../package.json').version);
 
@@ -329,7 +357,7 @@ class CliRepl implements MongoshIOProvider {
       // case.
       return;
     }
-    if (enabled && !this.globalConfig.forceDisableTelemetry) {
+    if (enabled && !this.forceDisableTelemetry) {
       this.toggleableAnalytics.enable();
     } else {
       this.toggleableAnalytics.disable();

diff --git a/packages/cli-repl/src/mongosh-repl.ts b/packages/cli-repl/src/mongosh-repl.ts
@@ -167,6 +167,10 @@ class MongoshNodeRepl implements EvaluationListener {
     this.runtimeState().instanceState.isInteractive = value;
   }
 
+  get isInteractive(): boolean {
+    return this.runtimeState().instanceState.isInteractive;
+  }
+
   /**
    * Create a Node.js REPL instance that can run mongosh commands,
    * print greeting messages, and set up autocompletion and