create-sonicjs 2.0.10 → 2.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-sonicjs",
-  "version": "2.0.10",
+  "version": "2.2.0",
   "description": "Create a new SonicJS application with zero configuration",
   "type": "module",
   "bin": {
@@ -43,7 +43,8 @@
     "ora": "^8.1.3",
     "execa": "^9.6.0",
     "fs-extra": "^11.2.0",
-    "validate-npm-package-name": "^7.0.0"
+    "validate-npm-package-name": "^7.0.0",
+    "posthog-node": "^4.0.0"
   },
   "engines": {
     "node": ">=18.0.0"

package/src/cli.js

@@ -8,6 +8,8 @@ import kleur from 'kleur'
 import ora from 'ora'
 import { execa } from 'execa'
 import validatePackageName from 'validate-npm-package-name'
+import { initTelemetry, track, shutdown, isEnabled } from './telemetry.js'
+import { displayTelemetryNotice } from './telemetry-notice.js'
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url))
 
@@ -52,23 +54,67 @@ const flags = {
 }
 
 async function main() {
+  const startTime = Date.now()
+
   try {
+    // Initialize telemetry
+    await initTelemetry()
+
+    // Show telemetry notice if enabled
+    if (isEnabled()) {
+      displayTelemetryNotice()
+    }
+
+    // Track installation started
+    await track('installation_started', {
+      template: flags.template || 'starter',
+      skipInstall: flags.skipInstall || false,
+      skipGit: flags.skipGit || false,
+      skipCloudflare: flags.skipCloudflare || false
+    })
+
     // Get project details
     const answers = await getProjectDetails(projectName)
 
     // Create project
     await createProject(answers, flags)
 
+    // Track installation completed
+    const duration = Date.now() - startTime
+    await track('installation_completed', {
+      duration,
+      template: answers.template,
+      createResources: answers.createResources || false,
+      initGit: answers.initGit || false,
+      skipInstall: answers.skipInstall || false,
+      includeExample: answers.includeExample || false
+    })
+
     // Success message
     printSuccessMessage(answers)
 
+    // Shutdown telemetry (flush events)
+    await shutdown()
+
   } catch (error) {
     if (error.message === 'cancelled') {
+      // Track cancellation
+      await track('installation_cancelled')
+      await shutdown()
+
       console.log()
       console.log(kleur.yellow('⚠ Cancelled'))
       process.exit(0)
     }
 
+    // Track failure
+    const duration = Date.now() - startTime
+    await track('installation_failed', {
+      duration,
+      errorType: error.message.split(':')[0].trim()
+    })
+    await shutdown()
+
     console.error()
     console.error(kleur.red('✖ Error:'), error.message)
     console.error()
@@ -372,7 +418,7 @@ async function copyTemplate(templateName, targetDir, options) {
 
   // Add @sonicjs-cms/core dependency
   packageJson.dependencies = {
-    '@sonicjs-cms/core': '^2.0.8',
+    '@sonicjs-cms/core': '^2.2.0',
     ...packageJson.dependencies
   }
 

package/src/telemetry-notice.js

@@ -0,0 +1,43 @@
+/**
+ * Telemetry Notice
+ *
+ * Displays privacy-respecting telemetry notice to users
+ */
+
+import kleur from 'kleur'
+
+/**
+ * Display telemetry notice
+ */
+export function displayTelemetryNotice() {
+  console.log()
+  console.log(kleur.dim('━'.repeat(60)))
+  console.log()
+  console.log(kleur.bold('📊 Anonymous Usage Analytics'))
+  console.log()
+  console.log(kleur.dim('SonicJS collects anonymous telemetry to improve the product.'))
+  console.log(kleur.dim('We do NOT collect any personally identifiable information.'))
+  console.log()
+  console.log(kleur.dim('Collected data includes:'))
+  console.log(kleur.dim('  • Installation success/failure rates'))
+  console.log(kleur.dim('  • OS and Node.js version'))
+  console.log(kleur.dim('  • Anonymous installation ID'))
+  console.log()
+  console.log(kleur.dim('To disable telemetry, set:'))
+  console.log(kleur.cyan('  export SONICJS_TELEMETRY=false'))
+  console.log()
+  console.log(kleur.dim('Learn more: https://docs.sonicjs.com/telemetry'))
+  console.log()
+  console.log(kleur.dim('━'.repeat(60)))
+  console.log()
+}
+
+/**
+ * Display opt-out reminder in success message
+ */
+export function displayOptOutReminder() {
+  console.log()
+  console.log(kleur.dim('💡 Tip: To disable anonymous analytics, run:'))
+  console.log(kleur.cyan('   export SONICJS_TELEMETRY=false'))
+  console.log()
+}

package/src/telemetry.js

@@ -0,0 +1,160 @@
+/**
+ * Telemetry for create-sonicjs CLI
+ *
+ * Privacy-first telemetry to track installation metrics
+ * - Anonymous installation IDs
+ * - No PII collection
+ * - Opt-out via environment variable
+ */
+
+import { randomUUID } from 'crypto'
+import os from 'os'
+import fs from 'fs-extra'
+import path from 'path'
+
+const TELEMETRY_ENABLED = process.env.SONICJS_TELEMETRY !== 'false' && process.env.DO_NOT_TRACK !== '1'
+const TELEMETRY_API_KEY = process.env.POSTHOG_API_KEY || 'phc_VuhFUIJLXzwyGjlgQ67dbNeSh5x4cp9F8i15hZFIDhs'
+const TELEMETRY_HOST = process.env.POSTHOG_HOST || 'https://us.i.posthog.com'
+const DEBUG = process.env.DEBUG === 'true'
+
+/**
+ * Get or create installation ID
+ */
+function getInstallationId() {
+  const telemetryDir = path.join(os.homedir(), '.sonicjs')
+  const telemetryFile = path.join(telemetryDir, 'telemetry.json')
+
+  try {
+    // Try to read existing ID
+    if (fs.existsSync(telemetryFile)) {
+      const data = fs.readJsonSync(telemetryFile)
+      if (data.installationId) {
+        return data.installationId
+      }
+    }
+
+    // Create new ID
+    const installationId = randomUUID()
+    fs.ensureDirSync(telemetryDir)
+    fs.writeJsonSync(telemetryFile, { installationId, createdAt: new Date().toISOString() })
+
+    return installationId
+  } catch (error) {
+    // If we can't read/write the file, generate a temporary ID
+    if (DEBUG) {
+      console.error('[Telemetry] Failed to get/create installation ID:', error)
+    }
+    return randomUUID()
+  }
+}
+
+/**
+ * Initialize telemetry
+ */
+let telemetryClient = null
+let installationId = null
+
+async function initTelemetry() {
+  if (!TELEMETRY_ENABLED) {
+    if (DEBUG) {
+      console.log('[Telemetry] Disabled via environment variable')
+    }
+    return null
+  }
+
+  try {
+    installationId = getInstallationId()
+
+    // Initialize PostHog
+    if (TELEMETRY_API_KEY) {
+      const { PostHog } = await import('posthog-node')
+      telemetryClient = new PostHog(TELEMETRY_API_KEY, {
+        host: TELEMETRY_HOST,
+        flushAt: 1,  // Flush immediately for CLI
+        flushInterval: 1000
+      })
+
+      if (DEBUG) {
+        console.log('[Telemetry] Initialized with ID:', installationId)
+      }
+    } else if (DEBUG) {
+      console.log('[Telemetry] No API key, tracking will be logged only')
+    }
+
+    return { client: telemetryClient, installationId }
+  } catch (error) {
+    if (DEBUG) {
+      console.error('[Telemetry] Initialization failed:', error)
+    }
+    return null
+  }
+}
+
+/**
+ * Track an event
+ */
+async function track(event, properties = {}) {
+  if (!TELEMETRY_ENABLED) return
+
+  try {
+    if (!installationId) {
+      await initTelemetry()
+    }
+
+    const enrichedProperties = {
+      ...properties,
+      timestamp: new Date().toISOString(),
+      os: os.platform(),
+      nodeVersion: process.version.split('.').slice(0, 2).join('.'), // e.g., "v18.0"
+    }
+
+    if (telemetryClient && installationId) {
+      telemetryClient.capture({
+        distinctId: installationId,
+        event,
+        properties: enrichedProperties
+      })
+
+      if (DEBUG) {
+        console.log('[Telemetry] Tracked:', event, enrichedProperties)
+      }
+    } else if (DEBUG) {
+      console.log('[Telemetry] Event (no client):', event, enrichedProperties)
+    }
+  } catch (error) {
+    // Silent fail - telemetry should never break the CLI
+    if (DEBUG) {
+      console.error('[Telemetry] Failed to track event:', error)
+    }
+  }
+}
+
+/**
+ * Shutdown telemetry (flush pending events)
+ */
+async function shutdown() {
+  if (telemetryClient) {
+    try {
+      await telemetryClient.shutdown()
+    } catch (error) {
+      if (DEBUG) {
+        console.error('[Telemetry] Shutdown failed:', error)
+      }
+    }
+  }
+}
+
+/**
+ * Check if telemetry is enabled
+ */
+function isEnabled() {
+  return TELEMETRY_ENABLED
+}
+
+export {
+  initTelemetry,
+  track,
+  shutdown,
+  isEnabled,
+  getInstallationId
+}