@contentful/app-scripts 1.6.0 → 1.7.1

package/README.md

@@ -217,3 +217,13 @@ When passing the `--ci` argument adding all variables as arguments is required
 | `--host`            | Optional, the Contentful CMA-endpoint to use |
 
 **Note:** You can also pass all arguments in interactive mode to skip being asked for it.
+
+### Tracking
+
+We gather depersonalized usage data of our CLI tools in order to improve experience. If you do not want your data to be gathered, you can opt out by providing an env variable `DISABLE_ANALYTICS` set to any value:
+
+> **Example**
+>
+> ```
+> DISABLE_ANALYTICS=true npx create-contentful-app
+> ```

package/bin/app-scripts

@@ -3,7 +3,7 @@
 const { program } = require('commander');
 const { version } = require('../package.json');
 
-const { createAppDefinition, upload, activate, cleanup, open } = require('../');
+const { createAppDefinition, upload, activate, cleanup, open, track } = require('../');
 
 async function runCommand(command, options) {
   const { ci } = program.opts();
@@ -64,6 +64,10 @@ async function runCommand(command, options) {
       await runCommand(cleanup, options);
     });
 
+  program.hook('preAction', (thisCommand) => {
+    track({ command: thisCommand.args[0], ci: thisCommand._optionValues.ci })
+  })
+
   await program.parseAsync(process.argv);
 })().catch((e) => {
   console.error(e);

package/lib/index.js

@@ -3,6 +3,7 @@ const upload = require('./upload');
 const activate = require('./activate');
 const cleanup = require('./clean-up');
 const open = require('./open');
+const track = require('../utils/analytics');
 
 module.exports = {
   createAppDefinition,
@@ -10,4 +11,5 @@ module.exports = {
   activate,
   cleanup,
   open,
+  track,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/app-scripts",
-  "version": "1.6.0",
+  "version": "1.7.1",
   "description": "A collection of scripts for building Contentful Apps",
   "author": "Contentful GmbH",
   "license": "MIT",
@@ -49,10 +49,11 @@
   },
   "dependencies": {
     "adm-zip": "0.5.9",
+    "analytics-node": "^6.2.0",
     "bottleneck": "2.19.5",
     "chalk": "4.1.2",
-    "commander": "9.4.1",
-    "contentful-management": "10.26.0",
+    "commander": "9.5.0",
+    "contentful-management": "10.27.0",
     "dotenv": "16.0.3",
     "ignore": "5.2.4",
     "inquirer": "8.2.5",
@@ -60,5 +61,5 @@
     "open": "8.4.0",
     "ora": "5.4.1"
   },
-  "gitHead": "9db3c2b2fb5289ea3c17f6d9ad85cf0c184ed531"
+  "gitHead": "6bc2e2e5a1c2764debb87bfbfde1b234e667771e"
 }

package/utils/analytics.js

@@ -0,0 +1,33 @@
+const Analytics = require('analytics-node');
+
+// Public write key scoped to data source
+const SEGMENT_WRITE_KEY = 'IzCq3j4dQlTAgLdMykRW9oBHQKUy1xMm';
+
+/**
+ *
+ * @param {object} properties tracking properties
+ * @param {string} properties.command triggered command e.g create-app-definition, upload, etc.
+ * @param {boolean} properties.ci value if --ci flag has been set
+ * @returns
+ */
+function track(properties) {
+  if (process.env.DISABLE_ANALYTICS) {
+    return;
+  }
+
+  const client = new Analytics(SEGMENT_WRITE_KEY);
+
+  try {
+    client.track({
+      event: 'app-cli-app-scripts',
+      properties,
+      anonymousId: Date.now(), // generate a random id
+      timestamp: new Date(),
+    });
+    // eslint-disable-next-line no-empty
+  } catch (e) {
+    // ignore any error, to not block the call
+  }
+}
+
+module.exports = track;