Merge pull request #283 from evidence-dev/fix-telemetry-settings-default

update defaults, and replace bool with yes/no

.changeset/wicked-files-perform.md

@@ -0,0 +1,7 @@
+---
+'@evidence-dev/db-orchestrator': patch
+'@evidence-dev/telemetry': patch
+'@evidence-dev/components': patch
+---
+
+Update the telemetry settings panel to show the correct state on initial startup, and provide more environment variable friendly alternatives ("yes"/ "no") to opt out of telemetry in production.

packages/db-orchestrator/index.cjs

@@ -4,12 +4,12 @@ const chalk = require('chalk')
 const logEvent = require('@evidence-dev/telemetry')
 const readline = require('readline');
 
-const getCache = function (dev, queryString, queryTime) {
+const getCache = function (dev, queryString, queryTime, settings) {
     queryTime = md5(queryTime)
     if (dev) {
         const cache = readJSONSync("./.evidence-queries/cache/" + queryTime + "/" + md5(queryString) + ".json", { throws: false })
         if (cache) {
-            logEvent("cache-query", dev)
+            logEvent("cache-query", dev, settings)
             return cache
         }
     }
@@ -77,7 +77,7 @@ const runQueries = async function (routeHash, dev) {
         data["evidencemeta"] = {queries} // eventually move to seperate metadata API (md frontmatter etc.) 
         for (let query of queries) {
             let queryTime = new Date(new Date().getFullYear(), new Date().getMonth(), new Date().getDate(), new Date().getHours());              
-            let cache = getCache(dev, query.compiledQueryString, queryTime)
+            let cache = getCache(dev, query.compiledQueryString, queryTime, settings)
             if (cache) {
                 data[query.id] = cache
                 process.stdout.write(chalk.greenBright("✓ "+ query.id) +  chalk.grey(" from cache \n"))

packages/telemetry/index.cjs

@@ -32,9 +32,8 @@ const getProfile = async () => {
 
 const logEvent = async (eventName, dev, settings) => {
     try {
-        let usageStats = settings ? settings.database : process.env["SEND_ANONYMOUS_USAGE_STATS"] ?? process.env["send_anonymous_usage_stats"]
-        usageStats = usageStats ?? 'true' //optout
-        if(usageStats === 'true'){
+        let usageStats = settings ? settings.send_anonymous_usage_stats ?? 'yes' : process.env["SEND_ANONYMOUS_USAGE_STATS"] ?? process.env["send_anonymous_usage_stats"] ?? 'yes'
+        if(usageStats === 'yes'){
             projectProfile = await getProfile()
             var analytics = new Analytics(wK);
             analytics.track({

sites/example-project/src/components/ui/TelemetryOptOut/TelemetrySettingsPanel.svelte

@@ -1,18 +1,15 @@
 <script>
     export let settings
-    let usageStats = settings.send_anonymous_usage_stats
+    let usageStats = (settings.send_anonymous_usage_stats ?? 'yes') === 'yes'
 
     async function save() {
-        settings.send_anonymous_usage_stats = usageStats
+        settings.send_anonymous_usage_stats = usageStats ? 'yes' : 'no'
         const submitted = await fetch("/api/settings.json", {
 			method: "POST",
 			body: JSON.stringify({
                 settings
 			})
 		})
-        // reset the state of settings 
-        settings = await submitted.json()
-        existingCredentials = settings.credentials
     }
 </script>