feat: factor out counting into separate module

Author: BracketJohn

src/index.ts

@@ -5,6 +5,7 @@ import { getUserPreferences } from "./prompts"
 import { wrapInSpinner } from "./utils/spinner"
 import { getUserPkgManager } from "./utils/getUserPkgManager"
 import { cliOptions } from "./utils/parseCliOptions"
+import { count } from "./utils/count"
 
 
 const main = async () => {
@@ -18,6 +19,7 @@ const main = async () => {
   let preferences
   if (!ci) {
     preferences = await getUserPreferences()
+    count(preferences)
   } else {
     preferences = {
       setProjectName: "my-sidebase-app",

src/utils/count.ts

@@ -0,0 +1,26 @@
+import fetch from "node-fetch"
+import { Preferences } from "../prompts"
+import { cliOptions } from "./parseCliOptions"
+
+/**
+ * This method provides basic usage tracking. Note:
+ * - we use plausible as a privacy friendly tracker,
+ * - we only track: a) invocation count, b) what stack was selected, c) what modules were selected
+ *
+ * No identifiably information (such as project name, IP, user-agent) is transmitted in the process. You can opt out by passing `--nocounting` to the CLI on invocation.
+ */
+let alreadyCounted = false
+export const count = async (preferences: Preferences) => {
+  if (alreadyCounted || process.env.NODE_ENV === "development" || cliOptions.nocounting) {
+    return
+  }
+
+  // We do not want to know identifiable information, only pass: Stack + selected modules
+  const annonymizedPreferences = new URLSearchParams({ ref: preferences.setStack, utm_content: (preferences.addModules || []).join(",") || "null" })
+  const headers = { "User-Agent": "Mozilla/5.0", "X-Forwarded-For": `2.175.${Math.floor(Math.random() * 255)}.${Math.floor(Math.random() * 255)}` }
+  return fetch("https://plausible.io/api/event", {
+    method: "POST",
+    headers,
+    body: `{"name":"cli","url":"https://cli.sidebase.io/?${annonymizedPreferences}","domain":"cli.sidebase.io"}`
+  }).then(() => { alreadyCounted = true }).catch(() => { return })
+}

src/utils/getVersion.ts

@@ -1,5 +1,4 @@
 import fetch from "node-fetch"
-import { cliOptions } from "./parseCliOptions"
 
 // Adapted from: https://github.com/withastro/astro/blob/2552816d5fa14a191a73179698b4b6f574a9963f/packages/create-astro/src/messages.ts#L44-L58
 let v: string
@@ -8,18 +7,6 @@ export const getVersion = async () => {
     return v
   }
 
-  if (process.env.NODE_ENV != "development" && !cliOptions.nocounting) {
-    try {
-      fetch("https://plausible.io/api/event", {
-        method: "POST",
-        headers: { "User-Agent": "Mozilla/5.0", "X-Forwarded-For": `2.175.${Math.floor(Math.random() * 255)}.${Math.floor(Math.random() * 255)}` },
-        body: "{\"name\":\"cli\",\"url\":\"https://cli.sidebase.io/\",\"domain\":\"cli.sidebase.io\"}"
-      })
-    } catch (error) {
-      // pass
-    }
-  }
-
   let response: { version: string }
   try {
     response = await fetch("https://registry.npmjs.org/create-sidebase/latest").then(response => response.json() as unknown as { version: string } )

src/utils/parseCliOptions.ts

@@ -2,7 +2,7 @@ import { program } from "commander"
 
 program.option("--quick", "Quicker flow by skipping most of Diamonds interactions", false)
 program.option("--ci", "Set CI mode: Selects the merino stack and all options, non-interactive", false)
-program.option("--nocounting", "Only one datapoint is collected: 'An invocation happened'. No further data or meta-data is collected. Opt out of this by setting this flag.", false)
+program.option("--nocounting", "Only the following annonymous data is collected: a) an invocation happened, b) what stack was selected?, c) what modules were selected?. No further identifiable or unidentifiable data or meta-data (such as project name, ...) is collected. Opt out of this by setting this flag.", false)
 program.parse()
 
 export const cliOptions: { quick: boolean, nocounting: boolean, ci: boolean } = program.opts()