hub/analytics: configure if cookie is set or not

Author: haraldschilly

src/.claude/settings.local.json

@@ -9,8 +9,10 @@
       "Bash(tsc --noEmit)",
       "Bash(git fetch:*)",
       "Bash(git merge:*)",
-      "Bash(prettier -w:*)"
+      "Bash(prettier -w:*)",
+      "Bash(git push:*)",
+      "Bash(gh pr view:*)"
     ],
     "deny": []
   }
-}
+}

src/packages/frontend/account/settings/email-address-setting.tsx

@@ -73,7 +73,7 @@ export const EmailAddressSetting = ({
       return;
     }
     try {
-      // anonymouse users will get the "welcome" email
+      // anonymous users will get the "welcome" email
       await webapp_client.account_client.send_verification_email(!is_anonymous);
     } catch (error) {
       const err_msg = `Problem sending welcome email: ${error}`;

src/packages/frontend/user-tracking.ts

@@ -7,20 +7,19 @@
 // client code doesn't have to import webapp_client everywhere, and we can
 // completely change this if we want.
 
-import { query, server_time } from "./frame-editors/generic/client";
+import { redux } from "@cocalc/frontend/app-framework";
+import {
+  query,
+  server_time,
+} from "@cocalc/frontend/frame-editors/generic/client";
+import { get_cookie } from "@cocalc/frontend/misc";
+import { webapp_client } from "@cocalc/frontend/webapp-client";
 import { uuid } from "@cocalc/util/misc";
-import { redux } from "./app-framework";
 import { version } from "@cocalc/util/smc-version";
-import { get_cookie } from "./misc";
-import { webapp_client } from "./webapp-client";
 
-import { ANALYTICS_COOKIE_NAME, ANALYTICS_ENABLED } from "@cocalc/util/consts";
+import { ANALYTICS_COOKIE_NAME } from "@cocalc/util/consts";
 
 export async function log(eventName: string, payload: any): Promise<void> {
-  if (!ANALYTICS_ENABLED) {
-    return;
-  }
-
   const central_log = {
     id: uuid(),
     event: `webapp-${eventName}`,
@@ -32,12 +31,9 @@ export async function log(eventName: string, payload: any): Promise<void> {
     },
     time: server_time(),
   };
+
   try {
-    await query({
-      query: {
-        central_log,
-      },
-    });
+    await query({ query: { central_log } });
   } catch (err) {
     console.warn("WARNING: Failed to write log event -- ", central_log);
   }
@@ -49,10 +45,6 @@ export default async function track(
   event: string,
   value: object,
 ): Promise<void> {
-  if (!ANALYTICS_ENABLED) {
-    return;
-  }
-
   // Replace all dashes with underscores in the event argument for consistency
   event = event.replace(/-/g, "_");
 

src/packages/hub/analytics.ts

@@ -22,7 +22,7 @@ import { is_valid_uuid_string, uuid } from "@cocalc/util/misc";
 import { pii_retention_to_future } from "@cocalc/database/postgres/pii";
 import { get_server_settings } from "@cocalc/database/postgres/server-settings";
 import type { PostgreSQL } from "@cocalc/database/postgres/types";
-import { ANALYTICS_COOKIE_NAME, ANALYTICS_ENABLED } from "@cocalc/util/consts";
+import { ANALYTICS_COOKIE_NAME } from "@cocalc/util/consts";
 
 import { getLogger } from "./logger";
 
@@ -243,6 +243,7 @@ export async function initAnalytics(
   const DNS = settings.dns;
   const dns_parsed = parseDomain(DNS);
   const pii_retention = settings.pii_retention;
+  const analytics_enabled = settings.analytics_cookie;
 
   if (
     dns_parsed.type !== ParseResultType.Listed &&
@@ -288,17 +289,17 @@ export async function initAnalytics(
       `/analytics.js GET analytics_cookie='${req.cookies[ANALYTICS_COOKIE_NAME]}'`,
     );
 
-    if (!req.cookies[ANALYTICS_COOKIE_NAME] && ANALYTICS_ENABLED) {
+    if (!req.cookies[ANALYTICS_COOKIE_NAME] && analytics_enabled) {
       // No analytics cookie is set and cookies are enabled, so we set one.
-      // When ANALYTICS_ENABLED is false, we skip setting cookies to enable
+      // When analytics_enabled is false, we skip setting cookies to enable
       // cookieless tracking for better privacy.
       setAnalyticsCookie(res /* DNS */);
     }
 
     // Return NOOP if DNS is invalid, or if cookies are enabled and already exist
     if (
       dns_parsed.type !== ParseResultType.Listed ||
-      (ANALYTICS_ENABLED && req.cookies[ANALYTICS_COOKIE_NAME])
+      (analytics_enabled && req.cookies[ANALYTICS_COOKIE_NAME])
     ) {
       // cache for 6 hours -- max-age has unit seconds
       res.header(
@@ -320,7 +321,7 @@ export async function initAnalytics(
     res.write(`var NAME = '${ANALYTICS_COOKIE_NAME}';\n`);
     res.write(`var ID = '${uuid()}';\n`);
     res.write(`var DOMAIN = '${DOMAIN}';\n`);
-    res.write(`var ANALYTICS_ENABLED = ${ANALYTICS_ENABLED};\n`);
+    res.write(`var ANALYTICS_ENABLED = ${analytics_enabled};\n`);
     //  BASE_PATH
     if (req.query.fqd === "false") {
       res.write(`var PREFIX = '${base_path}';\n`);

src/packages/next/pages/api/v2/jupyter/execute.ts

@@ -20,13 +20,16 @@ The OUTPUT is:
 - a list of messages that describe the output of the last code execution.
 
 */
+import type { Request, Response } from "express";
+
 import { execute } from "@cocalc/server/jupyter/execute";
 import getAccountId from "lib/account/get-account";
 import getParams from "lib/api/get-params";
 
-import { ANALYTICS_COOKIE_NAME, ANALYTICS_ENABLED } from "@cocalc/util/consts";
+import { ANALYTICS_COOKIE_NAME } from "@cocalc/util/consts";
+import { getServerSettings } from "@cocalc/database/settings/server-settings";
 
-export default async function handle(req, res) {
+export default async function handle(req: Request, res: Response) {
   try {
     const result = await doIt(req);
     res.json({ ...result, success: true });
@@ -36,11 +39,12 @@ export default async function handle(req, res) {
   }
 }
 
-async function doIt(req) {
+async function doIt(req: Request) {
   const { input, kernel, history, tag, noCache, hash, project_id, path } =
     getParams(req);
   const account_id = await getAccountId(req);
-  const analytics_cookie = ANALYTICS_ENABLED
+  const { analytics_cookie: analytics_enabled } = await getServerSettings();
+  const analytics_cookie = analytics_enabled
     ? req.cookies[ANALYTICS_COOKIE_NAME]
     : undefined;
   return await execute({

src/packages/next/pages/api/v2/llm/evaluate.ts

@@ -1,12 +1,15 @@
 // This is the new endpoint for querying any LLM
 // Previously, this has been in openai/chatgpt
 
+import type { Request, Response } from "express";
+
+import { getServerSettings } from "@cocalc/database/settings/server-settings";
 import { evaluate } from "@cocalc/server/llm/index";
-import { ANALYTICS_COOKIE_NAME, ANALYTICS_ENABLED } from "@cocalc/util/consts";
+import { ANALYTICS_COOKIE_NAME } from "@cocalc/util/consts";
 import getAccountId from "lib/account/get-account";
 import getParams from "lib/api/get-params";
 
-export default async function handle(req, res) {
+export default async function handle(req: Request, res: Response) {
   try {
     const result = await doIt(req);
     res.json({ ...result, success: true });
@@ -16,10 +19,11 @@ export default async function handle(req, res) {
   }
 }
 
-async function doIt(req) {
+async function doIt(req: Request) {
   const { input, system, history, model, tag } = getParams(req);
   const account_id = await getAccountId(req);
-  const analytics_cookie = ANALYTICS_ENABLED
+  const { analytics_cookie: analytics_enabled } = await getServerSettings();
+  const analytics_cookie = analytics_enabled
     ? req.cookies[ANALYTICS_COOKIE_NAME]
     : undefined;
   return {

src/packages/util/consts/index.ts

@@ -13,4 +13,4 @@ export { DUMMY_SECRET } from "./project";
 
 export { SERVER_SETTINGS_ENV_PREFIX } from "./server_settings";
 
-export { ANALYTICS_COOKIE_NAME, ANALYTICS_ENABLED } from "./tracking";
+export { ANALYTICS_COOKIE_NAME } from "./tracking";

src/packages/util/consts/tracking.ts

@@ -5,6 +5,3 @@
 
 // Cookie name for analytics tracking
 export const ANALYTICS_COOKIE_NAME = "CC_ANA";
-
-// Global flag to disable analytics tracking
-export const ANALYTICS_ENABLED: boolean = false;

src/packages/util/db-schema/site-settings-extras.ts

@@ -184,6 +184,7 @@ function custom_llm_display(value: string): string {
 
 export type SiteSettingsExtrasKeys =
   | "pii_retention"
+  | "analytics_cookie"
   | "conat_heading"
   | "conat_password"
   | "stripe_heading"
@@ -405,6 +406,13 @@ export const EXTRAS: SettingsExtras = {
     to_val: pii_retention_parse,
     to_display: pii_retention_display,
   },
+  analytics_cookie: {
+    name: "Analytics Cookie",
+    desc: "Tag browser sessions visiting a website via an analytics.js script with a cookie",
+    default: "no",
+    valid: only_booleans,
+    to_val: to_bool,
+  },
   stripe_heading: {
     // this is consmetic, otherwise it looks weird.
     name: "Stripe Keys",