feat: Add an analytics module and local and posthog providers (#12505)

* feat: Add an analytics module and local and posthog providers

* fix: Add tests and wire up in missing places

* fix: Address feedback and add missing module typing

* fix: Address feedback and add missing module typing

---------

Co-authored-by: Adrien de Peretti <adrien.deperetti@gmail.com>
Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>

packages/modules/providers/analytics-local/CHANGELOG.md

@@ -0,0 +1 @@
+# @medusajs/analytics-local

packages/modules/providers/analytics-local/jest.config.js

@@ -0,0 +1,6 @@
+const defineJestConfig = require("../../../../define_jest_config")
+module.exports = defineJestConfig({
+  moduleNameMapper: {
+    "^@services": "<rootDir>/src/services",
+  },
+})

packages/modules/providers/analytics-local/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@medusajs/analytics-local",
+  "version": "2.8.2",
+  "description": "Local analytics provider for Medusa",
+  "main": "dist/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/medusajs/medusa",
+    "directory": "packages/modules/providers/analytics-local"
+  },
+  "files": [
+    "dist",
+    "!dist/**/__tests__",
+    "!dist/**/__mocks__",
+    "!dist/**/__fixtures__"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "author": "Medusa",
+  "license": "MIT",
+  "scripts": {
+    "test": "jest --passWithNoTests src",
+    "build": "rimraf dist && tsc --build ./tsconfig.json",
+    "watch": "tsc --watch"
+  },
+  "devDependencies": {
+    "@medusajs/framework": "2.8.2",
+    "@swc/core": "^1.7.28",
+    "@swc/jest": "^0.2.36",
+    "jest": "^29.7.0",
+    "rimraf": "^5.0.1",
+    "typescript": "^5.6.2"
+  },
+  "peerDependencies": {
+    "@medusajs/framework": "2.8.2"
+  },
+  "keywords": [
+    "medusa-plugin",
+    "medusa-plugin-analytics"
+  ]
+}

packages/modules/providers/analytics-local/src/index.ts

@@ -0,0 +1,8 @@
+import { ModuleProvider, Modules } from "@medusajs/framework/utils"
+import { LocalAnalyticsService } from "./services/local-analytics"
+
+const services = [LocalAnalyticsService]
+
+export default ModuleProvider(Modules.ANALYTICS, {
+  services,
+})

packages/modules/providers/analytics-local/src/services/local-analytics.ts

@@ -0,0 +1,44 @@
+import {
+  LocalAnalyticsServiceOptions,
+  Logger,
+  ProviderIdentifyAnalyticsEventDTO,
+  ProviderTrackAnalyticsEventDTO,
+} from "@medusajs/framework/types"
+import { AbstractAnalyticsProviderService } from "@medusajs/framework/utils"
+
+type InjectedDependencies = {
+  logger: Logger
+}
+
+export class LocalAnalyticsService extends AbstractAnalyticsProviderService {
+  static identifier = "analytics-local"
+  protected config_: LocalAnalyticsServiceOptions
+  protected logger_: Logger
+
+  constructor(
+    { logger }: InjectedDependencies,
+    options: LocalAnalyticsServiceOptions
+  ) {
+    super()
+    this.config_ = options
+    this.logger_ = logger
+  }
+
+  async track(data: ProviderTrackAnalyticsEventDTO): Promise<void> {
+    this.logger_.debug(
+      `Tracking event: '${data.event}', actor_id: '${
+        data.actor_id ?? "-"
+      }', group: '${data.group?.id ?? "-"}', properties: '${JSON.stringify(
+        data.properties
+      )}'`
+    )
+  }
+
+  async identify(data: ProviderIdentifyAnalyticsEventDTO): Promise<void> {
+    this.logger_.debug(
+      `Identifying user: '${data.actor_id ?? "-"}', group: '${
+        "group" in data ? data.group.id : "-"
+      }', properties: '${JSON.stringify(data.properties)}'`
+    )
+  }
+}

packages/modules/providers/analytics-local/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../../../_tsconfig.base.json",
+  "compilerOptions": {
+    "paths": {
+      "@services": ["./src/services"]
+    }
+  }
+}