From 7425b1dd0285f3eca8eb37ba7c1ec4dbda809134 Mon Sep 17 00:00:00 2001 From: Friedrich482 Date: Sat, 25 Jul 2026 22:44:21 +0200 Subject: [PATCH 1/6] feat: telemetry table - added the schema or the new telemetry table in the api - generated and ran migrations scripts --- .../drizzle/0023_numerous_james_howlett.sql | 13 + apps/api/drizzle/meta/0023_snapshot.json | 980 ++++++++++++++++++ apps/api/drizzle/meta/_journal.json | 7 + apps/api/src/drizzle/schema/telemetry.ts | 30 + 4 files changed, 1030 insertions(+) create mode 100644 apps/api/drizzle/0023_numerous_james_howlett.sql create mode 100644 apps/api/drizzle/meta/0023_snapshot.json create mode 100644 apps/api/src/drizzle/schema/telemetry.ts diff --git a/apps/api/drizzle/0023_numerous_james_howlett.sql b/apps/api/drizzle/0023_numerous_james_howlett.sql new file mode 100644 index 00000000..4585c146 --- /dev/null +++ b/apps/api/drizzle/0023_numerous_james_howlett.sql @@ -0,0 +1,13 @@ +CREATE TABLE "telemetry" ( + "id" varchar(26) PRIMARY KEY NOT NULL, + "user_id" varchar(26) NOT NULL, + "machine_id" text NOT NULL, + "extension_version" text NOT NULL, + "vscode_version" text NOT NULL, + "created_at" timestamp DEFAULT now() NOT NULL, + "updated_at" timestamp DEFAULT now() NOT NULL +); +--> statement-breakpoint +ALTER TABLE "telemetry" ADD CONSTRAINT "telemetry_user_id_users_id_fk" FOREIGN KEY ("user_id") REFERENCES "public"."users"("id") ON DELETE cascade ON UPDATE no action;--> statement-breakpoint +CREATE INDEX "telemetry_user_id_index" ON "telemetry" USING btree ("user_id");--> statement-breakpoint +CREATE INDEX "telemetry_vscode_version_index" ON "telemetry" USING btree ("vscode_version"); \ No newline at end of file diff --git a/apps/api/drizzle/meta/0023_snapshot.json b/apps/api/drizzle/meta/0023_snapshot.json new file mode 100644 index 00000000..27158776 --- /dev/null +++ b/apps/api/drizzle/meta/0023_snapshot.json @@ -0,0 +1,980 @@ +{ + "id": "e6cc36b0-6236-44ac-98d0-11d41ef251df", + "prevId": "5c08d2b8-7808-4f64-afc9-5c2b4aac00ab", + "version": "7", + "dialect": "postgresql", + "tables": { + "public.branches": { + "name": "branches", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "varchar(26)", + "primaryKey": true, + "notNull": true + }, + "project_id": { + "name": "project_id", + "type": "varchar(26)", + "primaryKey": false, + "notNull": true + }, + "name": { + "name": "name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "time_spent": { + "name": "time_spent", + "type": "integer", + "primaryKey": false, + "notNull": true, + "default": 0 + }, + "created_at": { + "name": "created_at", + "type": "timestamp", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "branch_project_id_index": { + "name": "branch_project_id_index", + "columns": [ + { + "expression": "project_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + }, + "branch_name_index": { + "name": "branch_name_index", + "columns": [ + { + "expression": "name", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "branches_project_id_projects_id_fk": { + "name": "branches_project_id_projects_id_fk", + "tableFrom": "branches", + "tableTo": "projects", + "columnsFrom": [ + "project_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.daily_data": { + "name": "daily_data", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "varchar(26)", + "primaryKey": true, + "notNull": true + }, + "user_id": { + "name": "user_id", + "type": "varchar(26)", + "primaryKey": false, + "notNull": true + }, + "date": { + "name": "date", + "type": "date", + "primaryKey": false, + "notNull": true + }, + "time_spent": { + "name": "time_spent", + "type": "integer", + "primaryKey": false, + "notNull": true + }, + "created_at": { + "name": "created_at", + "type": "timestamp", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "daily_data_user_id_index": { + "name": "daily_data_user_id_index", + "columns": [ + { + "expression": "user_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + }, + "daily_data_date_index": { + "name": "daily_data_date_index", + "columns": [ + { + "expression": "date", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "daily_data_user_id_users_id_fk": { + "name": "daily_data_user_id_users_id_fk", + "tableFrom": "daily_data", + "tableTo": "users", + "columnsFrom": [ + "user_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.email_verifications": { + "name": "email_verifications", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "varchar(26)", + "primaryKey": true, + "notNull": true + }, + "email": { + "name": "email", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "code": { + "name": "code", + "type": "varchar(8)", + "primaryKey": false, + "notNull": true + }, + "attempts": { + "name": "attempts", + "type": "integer", + "primaryKey": false, + "notNull": true, + "default": 0 + }, + "expires_at": { + "name": "expires_at", + "type": "timestamp", + "primaryKey": false, + "notNull": true, + "default": "now() + interval '30 minutes'" + }, + "verified_at": { + "name": "verified_at", + "type": "timestamp", + "primaryKey": false, + "notNull": false, + "default": "NULL" + }, + "created_at": { + "name": "created_at", + "type": "timestamp", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": { + "email_verifications_email_unique": { + "name": "email_verifications_email_unique", + "nullsNotDistinct": false, + "columns": [ + "email" + ] + } + }, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.files": { + "name": "files", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "varchar(26)", + "primaryKey": true, + "notNull": true + }, + "branch_id": { + "name": "branch_id", + "type": "varchar(26)", + "primaryKey": false, + "notNull": true + }, + "language_id": { + "name": "language_id", + "type": "varchar(26)", + "primaryKey": false, + "notNull": true + }, + "name": { + "name": "name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "path": { + "name": "path", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "time_spent": { + "name": "time_spent", + "type": "integer", + "primaryKey": false, + "notNull": true, + "default": 0 + }, + "created_at": { + "name": "created_at", + "type": "timestamp", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "language_id_index": { + "name": "language_id_index", + "columns": [ + { + "expression": "language_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + }, + "file_name_index": { + "name": "file_name_index", + "columns": [ + { + "expression": "name", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + }, + "file_path_index": { + "name": "file_path_index", + "columns": [ + { + "expression": "path", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "files_branch_id_branches_id_fk": { + "name": "files_branch_id_branches_id_fk", + "tableFrom": "files", + "tableTo": "branches", + "columnsFrom": [ + "branch_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "files_language_id_languages_id_fk": { + "name": "files_language_id_languages_id_fk", + "tableFrom": "files", + "tableTo": "languages", + "columnsFrom": [ + "language_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.languages": { + "name": "languages", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "varchar(26)", + "primaryKey": true, + "notNull": true + }, + "daily_data_id": { + "name": "daily_data_id", + "type": "varchar(26)", + "primaryKey": false, + "notNull": true + }, + "language_slug": { + "name": "language_slug", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "time_spent": { + "name": "time_spent", + "type": "integer", + "primaryKey": false, + "notNull": true, + "default": 0 + }, + "created_at": { + "name": "created_at", + "type": "timestamp", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "language_daily_data_id_index": { + "name": "language_daily_data_id_index", + "columns": [ + { + "expression": "daily_data_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + }, + "language_slug_index": { + "name": "language_slug_index", + "columns": [ + { + "expression": "language_slug", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "languages_daily_data_id_daily_data_id_fk": { + "name": "languages_daily_data_id_daily_data_id_fk", + "tableFrom": "languages", + "tableTo": "daily_data", + "columnsFrom": [ + "daily_data_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.password_resets": { + "name": "password_resets", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "varchar(26)", + "primaryKey": true, + "notNull": true + }, + "user_id": { + "name": "user_id", + "type": "varchar(26)", + "primaryKey": false, + "notNull": true + }, + "email": { + "name": "email", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "code": { + "name": "code", + "type": "varchar(8)", + "primaryKey": false, + "notNull": true + }, + "attempts": { + "name": "attempts", + "type": "integer", + "primaryKey": false, + "notNull": true, + "default": 0 + }, + "expires_at": { + "name": "expires_at", + "type": "timestamp", + "primaryKey": false, + "notNull": true, + "default": "now() + interval '15 minutes'" + }, + "created_at": { + "name": "created_at", + "type": "timestamp", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "password_resets_user_id_index": { + "name": "password_resets_user_id_index", + "columns": [ + { + "expression": "user_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + }, + "password_resets_email_index": { + "name": "password_resets_email_index", + "columns": [ + { + "expression": "email", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "password_resets_user_id_users_id_fk": { + "name": "password_resets_user_id_users_id_fk", + "tableFrom": "password_resets", + "tableTo": "users", + "columnsFrom": [ + "user_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": { + "password_resets_email_unique": { + "name": "password_resets_email_unique", + "nullsNotDistinct": false, + "columns": [ + "email" + ] + } + }, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.projects": { + "name": "projects", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "varchar(26)", + "primaryKey": true, + "notNull": true + }, + "daily_data_id": { + "name": "daily_data_id", + "type": "varchar(26)", + "primaryKey": false, + "notNull": true + }, + "name": { + "name": "name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "path": { + "name": "path", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "time_spent": { + "name": "time_spent", + "type": "integer", + "primaryKey": false, + "notNull": true, + "default": 0 + }, + "created_at": { + "name": "created_at", + "type": "timestamp", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "project_daily_data_id_index": { + "name": "project_daily_data_id_index", + "columns": [ + { + "expression": "daily_data_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + }, + "project_name_index": { + "name": "project_name_index", + "columns": [ + { + "expression": "name", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + }, + "project_path_index": { + "name": "project_path_index", + "columns": [ + { + "expression": "path", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "projects_daily_data_id_daily_data_id_fk": { + "name": "projects_daily_data_id_daily_data_id_fk", + "tableFrom": "projects", + "tableTo": "daily_data", + "columnsFrom": [ + "daily_data_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.users": { + "name": "users", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "varchar(26)", + "primaryKey": true, + "notNull": true + }, + "username": { + "name": "username", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "email": { + "name": "email", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "hashed_password": { + "name": "hashed_password", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "profile_picture": { + "name": "profile_picture", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "google_id": { + "name": "google_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "google_email": { + "name": "google_email", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "auth_method": { + "name": "auth_method", + "type": "auth_method", + "typeSchema": "public", + "primaryKey": false, + "notNull": true + }, + "email_verified_at": { + "name": "email_verified_at", + "type": "timestamp", + "primaryKey": false, + "notNull": false, + "default": "NULL" + }, + "created_at": { + "name": "created_at", + "type": "timestamp", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": { + "users_username_unique": { + "name": "users_username_unique", + "nullsNotDistinct": false, + "columns": [ + "username" + ] + }, + "users_email_unique": { + "name": "users_email_unique", + "nullsNotDistinct": false, + "columns": [ + "email" + ] + }, + "users_google_id_unique": { + "name": "users_google_id_unique", + "nullsNotDistinct": false, + "columns": [ + "google_id" + ] + }, + "users_google_email_unique": { + "name": "users_google_email_unique", + "nullsNotDistinct": false, + "columns": [ + "google_email" + ] + } + }, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.telemetry": { + "name": "telemetry", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "varchar(26)", + "primaryKey": true, + "notNull": true + }, + "user_id": { + "name": "user_id", + "type": "varchar(26)", + "primaryKey": false, + "notNull": true + }, + "machine_id": { + "name": "machine_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "extension_version": { + "name": "extension_version", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "vscode_version": { + "name": "vscode_version", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "created_at": { + "name": "created_at", + "type": "timestamp", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "telemetry_user_id_index": { + "name": "telemetry_user_id_index", + "columns": [ + { + "expression": "user_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + }, + "telemetry_vscode_version_index": { + "name": "telemetry_vscode_version_index", + "columns": [ + { + "expression": "vscode_version", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "telemetry_user_id_users_id_fk": { + "name": "telemetry_user_id_users_id_fk", + "tableFrom": "telemetry", + "tableTo": "users", + "columnsFrom": [ + "user_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + } + }, + "enums": { + "public.auth_method": { + "name": "auth_method", + "schema": "public", + "values": [ + "email", + "google", + "both" + ] + } + }, + "schemas": {}, + "sequences": {}, + "roles": {}, + "policies": {}, + "views": {}, + "_meta": { + "columns": {}, + "schemas": {}, + "tables": {} + } +} \ No newline at end of file diff --git a/apps/api/drizzle/meta/_journal.json b/apps/api/drizzle/meta/_journal.json index 7d735e04..dfdc372b 100644 --- a/apps/api/drizzle/meta/_journal.json +++ b/apps/api/drizzle/meta/_journal.json @@ -162,6 +162,13 @@ "when": 1783453691330, "tag": "0022_sparkling_mephisto", "breakpoints": true + }, + { + "idx": 23, + "version": "7", + "when": 1785011440413, + "tag": "0023_numerous_james_howlett", + "breakpoints": true } ] } \ No newline at end of file diff --git a/apps/api/src/drizzle/schema/telemetry.ts b/apps/api/src/drizzle/schema/telemetry.ts new file mode 100644 index 00000000..9d621778 --- /dev/null +++ b/apps/api/src/drizzle/schema/telemetry.ts @@ -0,0 +1,30 @@ +import { varchar } from "drizzle-orm/pg-core"; +import { pgTable } from "drizzle-orm/pg-core"; +import { text } from "drizzle-orm/pg-core"; +import { index } from "drizzle-orm/pg-core"; +import { ulid } from "ulid"; + +import { timestamps } from "../columns.helpers"; +import { users } from "./users"; + +export const telemetry = pgTable( + "telemetry", + { + id: varchar("id", { length: 26 }) + .primaryKey() + .notNull() + .$defaultFn(() => ulid().toLowerCase()), + userId: varchar("user_id", { length: 26 }) + .notNull() + .references(() => users.id, { onDelete: "cascade" }), + + machineId: text("machine_id").notNull(), + extensionVersion: text("extension_version").notNull(), + vscodeVersion: text("vscode_version").notNull(), + ...timestamps, + }, + (table) => [ + index("telemetry_user_id_index").on(table.userId), + index("telemetry_vscode_version_index").on(table.vscodeVersion), + ], +); From 99d91ce1348f4d1e06698cf25590d8adc05310ca Mon Sep 17 00:00:00 2001 From: Friedrich482 Date: Sun, 26 Jul 2026 00:17:26 +0200 Subject: [PATCH 2/6] feat: telemetry - added a telemetry module with a module, service and dtos and two methods in the service: create and findOne telemetry event - updated the extensionService to add a new method `collectTelemetryData` and its dto - created a new protected procedure `collectTelemetryData` calling that method in the extension router - added a new common dto `SemVerDto` to validate semantic versioned strings --- apps/api/src/app.module.ts | 2 + apps/api/src/common/dto.ts | 8 +++ apps/api/src/extension/extension.dto.ts | 13 ++++- apps/api/src/extension/extension.module.ts | 2 + apps/api/src/extension/extension.router.ts | 11 ++++ .../src/extension/extension.service.test.ts | 12 +++++ apps/api/src/extension/extension.service.ts | 32 ++++++++++++ apps/api/src/telemetry/telemetry.dto.ts | 19 +++++++ apps/api/src/telemetry/telemetry.module.ts | 11 ++++ apps/api/src/telemetry/telemetry.service.ts | 52 +++++++++++++++++++ 10 files changed, 161 insertions(+), 1 deletion(-) create mode 100644 apps/api/src/telemetry/telemetry.dto.ts create mode 100644 apps/api/src/telemetry/telemetry.module.ts create mode 100644 apps/api/src/telemetry/telemetry.service.ts diff --git a/apps/api/src/app.module.ts b/apps/api/src/app.module.ts index 64f0d1bb..5a6b2547 100644 --- a/apps/api/src/app.module.ts +++ b/apps/api/src/app.module.ts @@ -20,6 +20,7 @@ import { FilesModule } from "./files/files.module"; import { LanguagesModule } from "./languages/languages.module"; import { PasswordResetsModule } from "./password-resets/password-resets.module"; import { ProjectsModule } from "./projects/projects.module"; +import { TelemetryModule } from "./telemetry/telemetry.module"; import { TrpcModule } from "./trpc/trpc.module"; import { UsersModule } from "./users/users.module"; @@ -54,6 +55,7 @@ import { UsersModule } from "./users/users.module"; AnalyticsModule, ExtensionModule, BranchesModule, + TelemetryModule, ], controllers: [AppController], providers: [ diff --git a/apps/api/src/common/dto.ts b/apps/api/src/common/dto.ts index b789f731..5a2116b4 100644 --- a/apps/api/src/common/dto.ts +++ b/apps/api/src/common/dto.ts @@ -1,3 +1,5 @@ +import z from "zod"; + import { IsoDateStringSchema } from "@repo/common/types-schemas"; import { JwtPayload as JwtPayloadDtoType } from "@repo/common/types-schemas"; import * as trpcExpress from "@trpc/server/adapters/express"; @@ -5,6 +7,12 @@ import * as trpcExpress from "@trpc/server/adapters/express"; export const DateStringDto = IsoDateStringSchema; export const environmentEnum = ["development", "production"] as const; +export const SemVerDto = z + .string() + .regex( + /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/, + { error: "Must be a semantic version" }, + ); export type Environment = (typeof environmentEnum)[number]; diff --git a/apps/api/src/extension/extension.dto.ts b/apps/api/src/extension/extension.dto.ts index 43b65665..eacd5231 100644 --- a/apps/api/src/extension/extension.dto.ts +++ b/apps/api/src/extension/extension.dto.ts @@ -1,8 +1,14 @@ import { z } from "zod"; -import { DateStringDto } from "@/common/dto"; +import { DateStringDto, SemVerDto } from "@/common/dto"; import { UserId } from "@repo/common/types-schemas"; +export const CollectTelemetryDataDto = z.object({ + machineId: z.string().min(1), + extensionVersion: SemVerDto, + vscodeVersion: SemVerDto, +}); + export const GetLanguagesTimeForDayDto = z.object({ dateString: DateStringDto, }); @@ -65,6 +71,11 @@ export const UpsertFilesDto = z.discriminatedUnion("type", [ }), ]); +export type CollectTelemetryDataDtoType = z.infer< + typeof CollectTelemetryDataDto +> & + UserId; + export type GetLanguagesTimeForDayDtoType = z.infer< typeof GetLanguagesTimeForDayDto > & diff --git a/apps/api/src/extension/extension.module.ts b/apps/api/src/extension/extension.module.ts index 6a550060..2eed0dd7 100644 --- a/apps/api/src/extension/extension.module.ts +++ b/apps/api/src/extension/extension.module.ts @@ -3,6 +3,7 @@ import { DailyDataModule } from "@/daily-data/daily-data.module"; import { FilesModule } from "@/files/files.module"; import { LanguagesModule } from "@/languages/languages.module"; import { ProjectsModule } from "@/projects/projects.module"; +import { TelemetryModule } from "@/telemetry/telemetry.module"; import { Module } from "@nestjs/common"; import { ExtensionRouter } from "./extension.router"; @@ -10,6 +11,7 @@ import { ExtensionService } from "./extension.service"; @Module({ imports: [ + TelemetryModule, DailyDataModule, LanguagesModule, ProjectsModule, diff --git a/apps/api/src/extension/extension.router.ts b/apps/api/src/extension/extension.router.ts index 765320ef..931a5e37 100644 --- a/apps/api/src/extension/extension.router.ts +++ b/apps/api/src/extension/extension.router.ts @@ -2,6 +2,7 @@ import { TrpcService } from "@/trpc/trpc.service"; import { Injectable } from "@nestjs/common"; import { + CollectTelemetryDataDto, GetFilesForDayDto, GetLanguagesTimeForDayDto, UpsertFilesDto, @@ -19,6 +20,16 @@ export class ExtensionRouter { procedures() { return { extension: this.trpcService.trpc.router({ + collectTelemetryData: this.trpcService + .protectedProcedure() + .input(CollectTelemetryDataDto) + .mutation(async ({ ctx, input }) => + this.extensionService.collectTelemetryData({ + ...input, + userId: ctx.user.sub, + }), + ), + getLanguagesTimeForDay: this.trpcService .protectedProcedure() .input(GetLanguagesTimeForDayDto) diff --git a/apps/api/src/extension/extension.service.test.ts b/apps/api/src/extension/extension.service.test.ts index ce3ef0fa..c7b24c7a 100644 --- a/apps/api/src/extension/extension.service.test.ts +++ b/apps/api/src/extension/extension.service.test.ts @@ -5,6 +5,7 @@ import { DailyDataService } from "@/daily-data/daily-data.service"; import { FilesService } from "@/files/files.service"; import { LanguagesService } from "@/languages/languages.service"; import { ProjectsService } from "@/projects/projects.service"; +import { TelemetryService } from "@/telemetry/telemetry.service"; import { Test } from "@nestjs/testing"; import { Procedure } from "@vitest/spy"; @@ -13,6 +14,11 @@ import { ExtensionService } from "./extension.service"; describe("ExtensionService", () => { let extensionService: ExtensionService; + let telemetryService: { + findOne: Mock; + create: Mock; + }; + let dailyDataService: { findOne: Mock; update: Mock; @@ -48,6 +54,11 @@ describe("ExtensionService", () => { beforeEach(async () => { vi.clearAllMocks(); + telemetryService = { + create: vi.fn(), + findOne: vi.fn(), + }; + dailyDataService = { findOne: vi.fn(), update: vi.fn(), @@ -83,6 +94,7 @@ describe("ExtensionService", () => { const moduleRef = await Test.createTestingModule({ providers: [ ExtensionService, + { provide: TelemetryService, useValue: telemetryService }, { provide: DailyDataService, useValue: dailyDataService }, { provide: LanguagesService, useValue: languagesService }, { provide: ProjectsService, useValue: projectsService }, diff --git a/apps/api/src/extension/extension.service.ts b/apps/api/src/extension/extension.service.ts index 61aa531a..2c7fd03d 100644 --- a/apps/api/src/extension/extension.service.ts +++ b/apps/api/src/extension/extension.service.ts @@ -3,9 +3,11 @@ import { DailyDataService } from "@/daily-data/daily-data.service"; import { FilesService } from "@/files/files.service"; import { LanguagesService } from "@/languages/languages.service"; import { ProjectsService } from "@/projects/projects.service"; +import { TelemetryService } from "@/telemetry/telemetry.service"; import { Injectable } from "@nestjs/common"; import { + CollectTelemetryDataDtoType, GetFilesForDayDtoType, GetLanguagesTimeForDayDtoType, NewExpectedFilesDataDtoType, @@ -16,6 +18,7 @@ import { @Injectable() export class ExtensionService { constructor( + private readonly telemetryService: TelemetryService, private readonly dailyDataService: DailyDataService, private readonly languagesService: LanguagesService, private readonly projectsService: ProjectsService, @@ -23,6 +26,35 @@ export class ExtensionService { private readonly filesService: FilesService, ) {} + async collectTelemetryData( + collectTelemetryDataDto: CollectTelemetryDataDtoType, + ) { + const { userId, machineId, extensionVersion, vscodeVersion } = + collectTelemetryDataDto; + + const existingTelemetryEntry = await this.telemetryService.findOne({ + userId, + machineId, + }); + + if ( + !existingTelemetryEntry || + existingTelemetryEntry.extensionVersion !== extensionVersion || + existingTelemetryEntry.vscodeVersion !== vscodeVersion + ) { + const createdTelemetryEntry = await this.telemetryService.create({ + userId, + machineId, + vscodeVersion, + extensionVersion, + }); + + return createdTelemetryEntry; + } + + return existingTelemetryEntry; + } + async getLanguagesTimeForDay( getLanguagesTimeForDayDto: GetLanguagesTimeForDayDtoType, ) { diff --git a/apps/api/src/telemetry/telemetry.dto.ts b/apps/api/src/telemetry/telemetry.dto.ts new file mode 100644 index 00000000..b274341e --- /dev/null +++ b/apps/api/src/telemetry/telemetry.dto.ts @@ -0,0 +1,19 @@ +import z from "zod"; + +import { SemVerDto } from "@/common/dto"; + +export const CreateTelemetryDto = z.object({ + machineId: z.string().min(1), + extensionVersion: SemVerDto, + vscodeVersion: SemVerDto, + userId: z.ulid(), +}); + +export const FindTelemetryDto = z.object({ + machineId: z.string().min(1), + userId: z.ulid(), +}); + +export type CreateTelemetryDtoType = z.infer; + +export type FindTelemetryDtoType = z.infer; diff --git a/apps/api/src/telemetry/telemetry.module.ts b/apps/api/src/telemetry/telemetry.module.ts new file mode 100644 index 00000000..687abbb4 --- /dev/null +++ b/apps/api/src/telemetry/telemetry.module.ts @@ -0,0 +1,11 @@ +import { DrizzleModule } from "@/drizzle/drizzle.module"; +import { Module } from "@nestjs/common"; + +import { TelemetryService } from "./telemetry.service"; + +@Module({ + imports: [DrizzleModule], + providers: [TelemetryService], + exports: [TelemetryService], +}) +export class TelemetryModule {} diff --git a/apps/api/src/telemetry/telemetry.service.ts b/apps/api/src/telemetry/telemetry.service.ts new file mode 100644 index 00000000..d8af0079 --- /dev/null +++ b/apps/api/src/telemetry/telemetry.service.ts @@ -0,0 +1,52 @@ +import { and, eq } from "drizzle-orm"; +import { NodePgDatabase } from "drizzle-orm/node-postgres"; + +import { DRIZZLE_ASYNC_PROVIDER } from "@/drizzle/constants"; +import { telemetry } from "@/drizzle/schema/telemetry"; +import { Inject, Injectable } from "@nestjs/common"; + +import { CreateTelemetryDtoType, FindTelemetryDtoType } from "./telemetry.dto"; + +@Injectable() +export class TelemetryService { + constructor( + @Inject(DRIZZLE_ASYNC_PROVIDER) + private readonly db: NodePgDatabase, + ) {} + async create(createTelemetryDto: CreateTelemetryDtoType) { + const { userId, machineId, extensionVersion, vscodeVersion } = + createTelemetryDto; + + const [createdTelemetry] = await this.db + .insert(telemetry) + .values({ extensionVersion, machineId, vscodeVersion, userId }) + .returning({ + machineId: telemetry.machineId, + extensionVersion: telemetry.extensionVersion, + vscodeVersion: telemetry.vscodeVersion, + }); + + return createdTelemetry; + } + + async findOne(findTelemetryDto: FindTelemetryDtoType) { + const { userId, machineId } = findTelemetryDto; + + const [telemetryEntry] = await this.db + .select({ + machineId: telemetry.machineId, + extensionVersion: telemetry.extensionVersion, + vscodeVersion: telemetry.vscodeVersion, + }) + .from(telemetry) + .where( + and(eq(telemetry.userId, userId), eq(telemetry.machineId, machineId)), + ); + + if (!telemetryEntry) { + return null; + } + + return telemetryEntry; + } +} From 72bc1e52611dcec05860bf80bdc7d8c14701e507 Mon Sep 17 00:00:00 2001 From: Friedrich482 Date: Sun, 26 Jul 2026 01:36:22 +0200 Subject: [PATCH 3/6] feat: extension telemetry - added a `collectTelemetryData` function in the extension to get the telemetry data and send them to the api at the extension startup - moved the SemVerSchema in the @repo/common types-schemas instead of the api because we use it in the `collectTelemetryData` to validate the raw extension version extracted from its `package.json` (it is typed as any) - added more constraint on the machineId schema because it is a "sha256" hash --- apps/api/src/common/dto.ts | 8 ---- apps/api/src/extension/extension.dto.ts | 6 +-- apps/api/src/telemetry/telemetry.dto.ts | 6 +-- apps/vscode-extension/src/extension.ts | 3 ++ .../utils/telemetry/collect-telemetry-data.ts | 48 +++++++++++++++++++ packages/common/src/types-schemas.ts | 7 +++ 6 files changed, 64 insertions(+), 14 deletions(-) create mode 100644 apps/vscode-extension/src/utils/telemetry/collect-telemetry-data.ts diff --git a/apps/api/src/common/dto.ts b/apps/api/src/common/dto.ts index 5a2116b4..b789f731 100644 --- a/apps/api/src/common/dto.ts +++ b/apps/api/src/common/dto.ts @@ -1,5 +1,3 @@ -import z from "zod"; - import { IsoDateStringSchema } from "@repo/common/types-schemas"; import { JwtPayload as JwtPayloadDtoType } from "@repo/common/types-schemas"; import * as trpcExpress from "@trpc/server/adapters/express"; @@ -7,12 +5,6 @@ import * as trpcExpress from "@trpc/server/adapters/express"; export const DateStringDto = IsoDateStringSchema; export const environmentEnum = ["development", "production"] as const; -export const SemVerDto = z - .string() - .regex( - /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/, - { error: "Must be a semantic version" }, - ); export type Environment = (typeof environmentEnum)[number]; diff --git a/apps/api/src/extension/extension.dto.ts b/apps/api/src/extension/extension.dto.ts index eacd5231..e4a0a754 100644 --- a/apps/api/src/extension/extension.dto.ts +++ b/apps/api/src/extension/extension.dto.ts @@ -1,10 +1,10 @@ import { z } from "zod"; -import { DateStringDto, SemVerDto } from "@/common/dto"; -import { UserId } from "@repo/common/types-schemas"; +import { DateStringDto } from "@/common/dto"; +import { SemVerSchema as SemVerDto, UserId } from "@repo/common/types-schemas"; export const CollectTelemetryDataDto = z.object({ - machineId: z.string().min(1), + machineId: z.hash("sha256"), extensionVersion: SemVerDto, vscodeVersion: SemVerDto, }); diff --git a/apps/api/src/telemetry/telemetry.dto.ts b/apps/api/src/telemetry/telemetry.dto.ts index b274341e..c91fb598 100644 --- a/apps/api/src/telemetry/telemetry.dto.ts +++ b/apps/api/src/telemetry/telemetry.dto.ts @@ -1,16 +1,16 @@ import z from "zod"; -import { SemVerDto } from "@/common/dto"; +import { SemVerSchema as SemVerDto } from "@repo/common/types-schemas"; export const CreateTelemetryDto = z.object({ - machineId: z.string().min(1), + machineId: z.hash("sha256"), extensionVersion: SemVerDto, vscodeVersion: SemVerDto, userId: z.ulid(), }); export const FindTelemetryDto = z.object({ - machineId: z.string().min(1), + machineId: z.hash("sha256"), userId: z.ulid(), }); diff --git a/apps/vscode-extension/src/extension.ts b/apps/vscode-extension/src/extension.ts index 49eb9133..666302fd 100644 --- a/apps/vscode-extension/src/extension.ts +++ b/apps/vscode-extension/src/extension.ts @@ -12,6 +12,7 @@ import { logInfo } from "./utils/logger/logger"; import { periodicSyncData } from "./utils/periodic-sync-data"; import { addStatusBarItem } from "./utils/status-bar/add-status-bar-item"; import { setStatusBarItem } from "./utils/status-bar/set-status-bar-item"; +import { collectTelemetryData } from "./utils/telemetry/collect-telemetry-data"; import { calculateTime } from "./utils/time/calculate-time"; let extensionContext: vscode.ExtensionContext; @@ -27,6 +28,8 @@ export async function activate(context: vscode.ExtensionContext) { statusBarItem = addStatusBarItem(); + collectTelemetryData(); + const { timeSpent, initialFilesData } = await fetchInitialData(); const isLoggedIn = getLoginContext(); diff --git a/apps/vscode-extension/src/utils/telemetry/collect-telemetry-data.ts b/apps/vscode-extension/src/utils/telemetry/collect-telemetry-data.ts new file mode 100644 index 00000000..9f9d0116 --- /dev/null +++ b/apps/vscode-extension/src/utils/telemetry/collect-telemetry-data.ts @@ -0,0 +1,48 @@ +import vscode from "vscode"; + +import { getExtensionContext } from "@/extension"; +import { SemVerSchema } from "@repo/common/types-schemas"; +import { isTRPCClientError } from "@trpc/client"; + +import { handleInvalidTokenError } from "../errors/handle-invalid-token-error"; +import { logDir, logError } from "../logger/logger"; +import { trpc } from "../trpc/client"; + +export const collectTelemetryData = async () => { + if (!vscode.env.isTelemetryEnabled) { + return; + } + + const context = getExtensionContext(); + + const rawExtensionVersion = context.extension.packageJSON.version; + + const parsedExtensionVersion = SemVerSchema.safeParse(rawExtensionVersion); + if (!parsedExtensionVersion.success) { + logError(`Invalid extension version: ${rawExtensionVersion}`); + return; + } + + const extensionVersion = parsedExtensionVersion.data; + const vscodeVersion = vscode.version; + const machineId = vscode.env.machineId; + + logDir({ extensionVersion, vscodeVersion, machineId }); + + try { + await trpc.extension.collectTelemetryData.mutate({ + machineId, + extensionVersion, + vscodeVersion, + }); + } catch (error) { + if (isTRPCClientError(error)) { + logError( + `tRPC Error: ${error.message}, Cause: ${error.cause}, Code: ${error.data?.code}.`, + ); + await handleInvalidTokenError(error); + } else { + logError(`Unknown error during telemetry data collection: ${error}`); + } + } +}; diff --git a/packages/common/src/types-schemas.ts b/packages/common/src/types-schemas.ts index 04cf13de..ffcab311 100644 --- a/packages/common/src/types-schemas.ts +++ b/packages/common/src/types-schemas.ts @@ -157,6 +157,13 @@ export const WsDataSchema = z.discriminatedUnion("type", [ }), ]); +export const SemVerSchema = z + .string() + .regex( + /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/, + { error: "Must be a semantic version" }, + ); + export const GroupByEnum = ["days", "weeks", "months"] as const; export type GroupBy = (typeof GroupByEnum)[number]; export type UserId = { userId: string }; From 33b509b8aef7610a11d9d758df34046334c246cb Mon Sep 17 00:00:00 2001 From: Friedrich482 Date: Sun, 26 Jul 2026 21:23:55 +0200 Subject: [PATCH 4/6] test: telemetry - added tests for the methods of the TelemetryService - added tests for the `collectTelemetryData` method of the ExtensionService - bumped zod to `v4.4.3` in all apps and packages (api, dashboard, vscode-extension and @repo/common) --- apps/api/package.json | 2 +- .../src/extension/extension.router.test.ts | 39 ++++++ .../src/extension/extension.service.test.ts | 127 ++++++++++++++++++ .../src/telemetry/telemetry.service.test.ts | 107 +++++++++++++++ apps/api/src/telemetry/telemetry.service.ts | 3 +- apps/dashboard/package.json | 2 +- apps/vscode-extension/package.json | 2 +- package-lock.json | 16 +-- packages/common/package.json | 2 +- 9 files changed, 287 insertions(+), 13 deletions(-) create mode 100644 apps/api/src/telemetry/telemetry.service.test.ts diff --git a/apps/api/package.json b/apps/api/package.json index 824d5e73..c3e0825e 100644 --- a/apps/api/package.json +++ b/apps/api/package.json @@ -45,7 +45,7 @@ "resend": "^6.9.1", "superjson": "^2.2.6", "ulid": "^3.0.2", - "zod": "^4.3.6" + "zod": "^4.4.3" }, "devDependencies": { "@eslint/js": "^9.39.2", diff --git a/apps/api/src/extension/extension.router.test.ts b/apps/api/src/extension/extension.router.test.ts index edf9a7e3..a73f138f 100644 --- a/apps/api/src/extension/extension.router.test.ts +++ b/apps/api/src/extension/extension.router.test.ts @@ -18,6 +18,7 @@ describe("ExtensionRouter", () => { let trpcService: TrpcService; let extensionService: { + collectTelemetryData: Mock; getLanguagesTimeForDay: Mock; getFilesForDay: Mock; upsertLanguages: Mock; @@ -51,6 +52,7 @@ describe("ExtensionRouter", () => { vi.clearAllMocks(); extensionService = { + collectTelemetryData: vi.fn(), getLanguagesTimeForDay: vi.fn(), getFilesForDay: vi.fn(), upsertLanguages: vi.fn(), @@ -84,6 +86,43 @@ describe("ExtensionRouter", () => { vi.spyOn(trpcService, "getPayload").mockResolvedValue(mockedPayload); }); + describe("collectTelemetryData", () => { + const mockedEntry = { + machineId: + "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad", + extensionVersion: "0.0.71", + vscodeVersion: "1.130.0", + userId: mockedPayload.sub, + }; + + const mockedOutput = { + machineId: + "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad", + extensionVersion: "0.0.71", + vscodeVersion: "1.130.0", + }; + + it("should call the collectTelemetryData method of the extensionService", async () => { + extensionService.collectTelemetryData.mockResolvedValue(mockedOutput); + + await caller.collectTelemetryData(mockedEntry); + + expect(extensionService.collectTelemetryData).toHaveBeenCalled(); + expect(extensionService.collectTelemetryData).toHaveBeenCalledWith( + mockedEntry, + ); + }); + + it("should return the telemetry event created or found", async () => { + extensionService.collectTelemetryData.mockResolvedValue(mockedOutput); + + const telemetryEvent = await caller.collectTelemetryData(mockedEntry); + + expect(telemetryEvent).toBeDefined(); + expect(telemetryEvent).toEqual(mockedOutput); + }); + }); + describe("getLanguagesTimeForDay", () => { const mockedEntry = { dateString: "2026-06-22", diff --git a/apps/api/src/extension/extension.service.test.ts b/apps/api/src/extension/extension.service.test.ts index c7b24c7a..fd6eadc4 100644 --- a/apps/api/src/extension/extension.service.test.ts +++ b/apps/api/src/extension/extension.service.test.ts @@ -106,6 +106,133 @@ describe("ExtensionService", () => { extensionService = moduleRef.get(ExtensionService); }); + describe("collectTelemetryData", () => { + it("should return the matching telemetry event if it already exists", async () => { + const mockedEntry = { + userId: "1", + machineId: + "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad", + extensionVersion: "0.0.71", + vscodeVersion: "1.129.1", + }; + + const mockedExistingTelemetryEvent = { + machineId: + "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad", + extensionVersion: "0.0.71", + vscodeVersion: "1.129.1", + }; + + telemetryService.findOne.mockResolvedValue(mockedExistingTelemetryEvent); + + const telemetryEvent = + await extensionService.collectTelemetryData(mockedEntry); + + expect(telemetryEvent).toBeDefined(); + expect(telemetryEvent).toEqual(mockedExistingTelemetryEvent); + }); + + it("should create the telemetry event if it doesn't already exists for that specific machine", async () => { + const mockedEntry = { + userId: "1", + machineId: + "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad", + extensionVersion: "0.0.71", + vscodeVersion: "1.129.1", + }; + + const mockedCreatedTelemetryEvent = { + machineId: + "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad", + extensionVersion: "0.0.71", + vscodeVersion: "1.129.1", + }; + + telemetryService.findOne.mockResolvedValue(null); + telemetryService.create.mockResolvedValue(mockedCreatedTelemetryEvent); + + const telemetryEvent = + await extensionService.collectTelemetryData(mockedEntry); + + expect(telemetryService.create).toHaveBeenCalled(); + expect(telemetryService.create).toHaveBeenCalledWith({ ...mockedEntry }); + + expect(telemetryEvent).toBeDefined(); + expect(telemetryEvent).toEqual(mockedCreatedTelemetryEvent); + }); + + it("should create the telemetry event if it exists for that specific machine but the extension version has changed", async () => { + const mockedEntry = { + userId: "1", + machineId: + "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad", + extensionVersion: "0.0.72", + vscodeVersion: "1.129.1", + }; + + const mockedFoundTelemetryEvent = { + machineId: + "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad", + extensionVersion: "0.0.71", + vscodeVersion: "1.129.1", + }; + + const mockedCreatedTelemetryEvent = { + machineId: + "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad", + extensionVersion: "0.0.72", + vscodeVersion: "1.129.1", + }; + + telemetryService.findOne.mockResolvedValue(mockedFoundTelemetryEvent); + telemetryService.create.mockResolvedValue(mockedCreatedTelemetryEvent); + + const telemetryEvent = + await extensionService.collectTelemetryData(mockedEntry); + + expect(telemetryService.create).toHaveBeenCalled(); + expect(telemetryService.create).toHaveBeenCalledWith({ ...mockedEntry }); + + expect(telemetryEvent).toBeDefined(); + expect(telemetryEvent).toEqual(mockedCreatedTelemetryEvent); + }); + + it("should create the telemetry event if it exists for that specific machine but the vscode version has changed", async () => { + const mockedEntry = { + userId: "1", + machineId: + "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad", + extensionVersion: "0.0.72", + vscodeVersion: "1.130.0", + }; + + const mockedFoundTelemetryEvent = { + machineId: + "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad", + extensionVersion: "0.0.72", + vscodeVersion: "1.129.1", + }; + + const mockedCreatedTelemetryEvent = { + machineId: + "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad", + extensionVersion: "0.0.72", + vscodeVersion: "1.130.0", + }; + + telemetryService.findOne.mockResolvedValue(mockedFoundTelemetryEvent); + telemetryService.create.mockResolvedValue(mockedCreatedTelemetryEvent); + + const telemetryEvent = + await extensionService.collectTelemetryData(mockedEntry); + + expect(telemetryEvent).toBeDefined(); + expect(telemetryService.create).toHaveBeenCalled(); + expect(telemetryService.create).toHaveBeenCalledWith({ ...mockedEntry }); + expect(telemetryEvent).toEqual(mockedCreatedTelemetryEvent); + }); + }); + describe("getLanguagesTimeForDay", () => { const mockedEntry = { userId: "1", diff --git a/apps/api/src/telemetry/telemetry.service.test.ts b/apps/api/src/telemetry/telemetry.service.test.ts new file mode 100644 index 00000000..5526fd07 --- /dev/null +++ b/apps/api/src/telemetry/telemetry.service.test.ts @@ -0,0 +1,107 @@ +import { beforeEach, describe, expect, it, vi } from "vitest"; + +import { MockedDrizzle } from "@/common/tests/types"; +import { DRIZZLE_ASYNC_PROVIDER } from "@/drizzle/constants"; +import { Test } from "@nestjs/testing"; + +import { TelemetryService } from "./telemetry.service"; + +describe("TelemetryService", () => { + let telemetryService: TelemetryService; + + let mockedDrizzle: MockedDrizzle; + + beforeEach(async () => { + mockedDrizzle = { + select: vi.fn().mockReturnThis(), + from: vi.fn().mockReturnThis(), + where: vi.fn().mockReturnThis(), + limit: vi.fn(), + insert: vi.fn().mockReturnThis(), + values: vi.fn().mockReturnThis(), + returning: vi.fn(), + update: vi.fn().mockReturnThis(), + set: vi.fn().mockReturnThis(), + delete: vi.fn().mockReturnThis(), + orderBy: vi.fn().mockReturnThis(), + innerJoin: vi.fn().mockReturnThis(), + groupBy: vi.fn().mockReturnThis(), + offset: vi.fn().mockReturnThis(), + as: vi.fn(), + execute: vi.fn(), + }; + + vi.clearAllMocks(); + + const moduleRef = await Test.createTestingModule({ + providers: [ + TelemetryService, + { + provide: DRIZZLE_ASYNC_PROVIDER, + useValue: mockedDrizzle, + }, + ], + }).compile(); + + telemetryService = moduleRef.get(TelemetryService); + }); + + describe("create", () => { + it("should return the created telemetry event", async () => { + const mockedEntry = { + userId: "1", + machineId: + "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad", + extensionVersion: "0.0.71", + vscodeVersion: "1.129.1", + }; + + const mockedCreatedTelemetryEvent = { + machineId: + "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad", + extensionVersion: "0.0.71", + vscodeVersion: "1.129.1", + }; + + mockedDrizzle.returning.mockResolvedValue([mockedCreatedTelemetryEvent]); + + const createdTelemetryEvent = await telemetryService.create(mockedEntry); + + expect(createdTelemetryEvent).toBeDefined(); + expect(createdTelemetryEvent).toEqual(mockedCreatedTelemetryEvent); + }); + }); + + describe("findOne", () => { + const mockedEntry = { + userId: "1", + machineId: + "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad", + }; + + it("should return the telemetry event found if it exists", async () => { + const mockedTelemetryEventFound = { + machineId: + "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad", + extensionVersion: "0.0.71", + vscodeVersion: "1.129.1", + }; + + mockedDrizzle.limit.mockResolvedValue([mockedTelemetryEventFound]); + + const telemetryEventFound = await telemetryService.findOne(mockedEntry); + + expect(telemetryEventFound).toBeDefined(); + expect(telemetryEventFound).toEqual(mockedTelemetryEventFound); + }); + + it("should return null if the telemetry event doesn't exists", async () => { + mockedDrizzle.limit.mockResolvedValue([]); + + const telemetryEventFound = await telemetryService.findOne(mockedEntry); + + expect(telemetryEventFound).toBeDefined(); + expect(telemetryEventFound).toBeNull(); + }); + }); +}); diff --git a/apps/api/src/telemetry/telemetry.service.ts b/apps/api/src/telemetry/telemetry.service.ts index d8af0079..2b8df899 100644 --- a/apps/api/src/telemetry/telemetry.service.ts +++ b/apps/api/src/telemetry/telemetry.service.ts @@ -41,7 +41,8 @@ export class TelemetryService { .from(telemetry) .where( and(eq(telemetry.userId, userId), eq(telemetry.machineId, machineId)), - ); + ) + .limit(1); if (!telemetryEntry) { return null; diff --git a/apps/dashboard/package.json b/apps/dashboard/package.json index 82531de4..f17c11ff 100644 --- a/apps/dashboard/package.json +++ b/apps/dashboard/package.json @@ -32,7 +32,7 @@ "react-spinners": "^0.17.0", "recharts": "^2.15.4", "superjson": "^2.2.6", - "zod": "^4.3.6", + "zod": "^4.4.3", "zustand": "^5.0.11" }, "devDependencies": { diff --git a/apps/vscode-extension/package.json b/apps/vscode-extension/package.json index ab11d788..c6a1c734 100644 --- a/apps/vscode-extension/package.json +++ b/apps/vscode-extension/package.json @@ -150,6 +150,6 @@ "get-port": "^7.1.0", "superjson": "^2.2.6", "ws": "^8.19.0", - "zod": "^4.3.6" + "zod": "^4.4.3" } } diff --git a/package-lock.json b/package-lock.json index 421ca0cc..f8521931 100644 --- a/package-lock.json +++ b/package-lock.json @@ -44,7 +44,7 @@ "resend": "^6.9.1", "superjson": "^2.2.6", "ulid": "^3.0.2", - "zod": "^4.3.6" + "zod": "^4.4.3" }, "devDependencies": { "@eslint/js": "^9.39.2", @@ -108,7 +108,7 @@ "react-spinners": "^0.17.0", "recharts": "^2.15.4", "superjson": "^2.2.6", - "zod": "^4.3.6", + "zod": "^4.4.3", "zustand": "^5.0.11" }, "devDependencies": { @@ -163,7 +163,7 @@ }, "apps/vscode-extension": { "name": "mooncode", - "version": "0.0.67", + "version": "0.0.72", "license": "MIT", "dependencies": { "@repo/common": "*", @@ -176,7 +176,7 @@ "get-port": "^7.1.0", "superjson": "^2.2.6", "ws": "^8.19.0", - "zod": "^4.3.6" + "zod": "^4.4.3" }, "devDependencies": { "@types/dotenv": "^6.1.1", @@ -27065,9 +27065,9 @@ } }, "node_modules/zod": { - "version": "4.3.6", - "resolved": "https://registry.npmjs.org/zod/-/zod-4.3.6.tgz", - "integrity": "sha512-rftlrkhHZOcjDwkGlnUtZZkvaPHCsDATp4pGpuOOMDaTdDDXF91wuVDJoWoPsKX/3YPQ5fHuF3STjcYyKr+Qhg==", + "version": "4.4.3", + "resolved": "https://registry.npmjs.org/zod/-/zod-4.4.3.tgz", + "integrity": "sha512-ytENFjIJFl2UwYglde2jchW2Hwm4GJFLDiSXWdTrJQBIN9Fcyp7n4DhxJEiWNAJMV1/BqWfW/kkg71UDcHJyTQ==", "license": "MIT", "funding": { "url": "https://github.com/sponsors/colinhacks" @@ -27120,7 +27120,7 @@ "version": "0.0.0", "dependencies": { "date-fns": "^4.1.0", - "zod": "^4.3.6" + "zod": "^4.4.3" }, "devDependencies": { "@repo/typescript-config": "*", diff --git a/packages/common/package.json b/packages/common/package.json index 76bc49dc..f06cb024 100644 --- a/packages/common/package.json +++ b/packages/common/package.json @@ -40,6 +40,6 @@ }, "dependencies": { "date-fns": "^4.1.0", - "zod": "^4.3.6" + "zod": "^4.4.3" } } From 7a57daa421800b06752f97faa9d3b7e14095ccf2 Mon Sep 17 00:00:00 2001 From: Friedrich482 Date: Sun, 26 Jul 2026 21:45:50 +0200 Subject: [PATCH 5/6] chore: removed logging - removed the call to logDir in the `collectTelemetryData` function of the extension --- .../src/utils/telemetry/collect-telemetry-data.ts | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/apps/vscode-extension/src/utils/telemetry/collect-telemetry-data.ts b/apps/vscode-extension/src/utils/telemetry/collect-telemetry-data.ts index 9f9d0116..b4fb745a 100644 --- a/apps/vscode-extension/src/utils/telemetry/collect-telemetry-data.ts +++ b/apps/vscode-extension/src/utils/telemetry/collect-telemetry-data.ts @@ -5,7 +5,7 @@ import { SemVerSchema } from "@repo/common/types-schemas"; import { isTRPCClientError } from "@trpc/client"; import { handleInvalidTokenError } from "../errors/handle-invalid-token-error"; -import { logDir, logError } from "../logger/logger"; +import { logError } from "../logger/logger"; import { trpc } from "../trpc/client"; export const collectTelemetryData = async () => { @@ -27,8 +27,6 @@ export const collectTelemetryData = async () => { const vscodeVersion = vscode.version; const machineId = vscode.env.machineId; - logDir({ extensionVersion, vscodeVersion, machineId }); - try { await trpc.extension.collectTelemetryData.mutate({ machineId, From b7a38142ed097a36a62f283c401a7bb16d838c3e Mon Sep 17 00:00:00 2001 From: Friedrich482 Date: Sun, 26 Jul 2026 22:05:34 +0200 Subject: [PATCH 6/6] chore: extension version - bumped the extension version to `v0.0.73` --- apps/vscode-extension/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/vscode-extension/package.json b/apps/vscode-extension/package.json index c6a1c734..d8d9e4e4 100644 --- a/apps/vscode-extension/package.json +++ b/apps/vscode-extension/package.json @@ -2,7 +2,7 @@ "name": "mooncode", "displayName": "MoonCode", "description": "MoonCode is an extension that tracks your coding time (like WakaTime) and gives you a detailed summary about all your coding statistics. With MoonCode, developers get the full history of their coding activity.", - "version": "0.0.72", + "version": "0.0.73", "icon": "./public/moon.png", "publisher": "Friedrich482", "author": {