feat(analytics): introduce @metamask/analytics-client package for analytics handling

- Created a new package `@metamask/analytics-client` to encapsulate analytics functionality.
- Added TypeScript types for analytics events and originator information in `@metamask/sdk-types`.
- Updated various SDK packages to utilize the new analytics client, enhancing modularity and maintainability.
- Refactored existing analytics code to leverage the new package, ensuring consistent event tracking across the SDK.
- Updated package dependencies and configurations to support the new structure.

Author: abretonc7s

package.json

@@ -15,6 +15,7 @@
     "packages/sdk-react-native",
     "packages/sdk-react-ui",
     "packages/sdk-ui",
+    "packages/sdk-types",
     "packages/sdk-lab",
     "packages/devsocket",
     "packages/devreact",

packages/analytics-client/.eslintrc.js

@@ -0,0 +1,34 @@
+const path = require('path');
+
+/**
+ * @type {import('eslint').Linter.Config}
+ */
+module.exports = {
+  extends: ['@metamask/eslint-config-typescript', '../../.eslintrc.js'],
+  root: true,
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: [path.resolve(__dirname, 'tsconfig.eslint.json')],
+  },
+
+  ignorePatterns: [
+    '.prettierrc.js',
+    '**/.eslintrc.js',
+    '**/jest.config.ts',
+    '**/dist*/',
+  ],
+
+  overrides: [
+    {
+      files: ['**/*.ts'],
+      rules: {
+        // Add any specific rule overrides for analytics-client here if needed
+        // Example:
+        // '@typescript-eslint/consistent-type-definitions': [
+        //   'error',
+        //   'interface',
+        // ],
+      },
+    },
+  ],
+}; 

packages/analytics-client/STEPS.md

@@ -0,0 +1,61 @@
+# Analytics Client Migration Plan
+
+This plan outlines the steps to extract the analytics client logic from `@metamask/sdk-communication-layer` into this new `@metamask/analytics-client` package.
+
+1.  **Configure `package.json` for Public Release (`packages/analytics-client/package.json`):**
+
+    - Ensure `name` is `@metamask/analytics-client`.
+    - Set a starting `version` (e.g., `0.1.0`).
+    - Set `private: false`.
+    - Add essential public package fields: `description`, `license`, `homepage`, `bugs`, `repository`, `author` (copy/adapt from another public package like `@metamask/sdk-communication-layer`).
+    - Define `main: "dist/src/index.js"` and `types: "dist/src/index.d.ts"`.
+    - Add build/lint/test/clean scripts (copy/adapt from another package).
+    - Add `dependencies`: `"cross-fetch": "latest"`, `"@metamask/sdk-communication-layer": "workspace:^"`.
+    - Add standard `devDependencies` (`typescript`, `@types/node`, etc., adapt from another package).
+    - Add `publishConfig: { "access": "public" }`.
+    - Ensure `files` includes `dist/`.
+
+2.  **Verify & Configure `tsconfig.json` (`packages/analytics-client/tsconfig.json`):**
+
+    - Ensure it extends a base config if applicable (e.g., `../../tsconfig.base.json`).
+    - Set `compilerOptions.outDir` to `"./dist"`.
+    - Set `compilerOptions.rootDir` to `"./src"`.
+    - Include `"src/**/*"` and exclude `node_modules`, `dist`.
+
+3.  **Move Analytics Code:**
+
+    - Move the file `packages/sdk-communication-layer/src/Analytics.ts` to `packages/analytics-client/src/Analytics.ts`.
+
+4.  **Refactor Moved Code (`packages/analytics-client/src/Analytics.ts`):**
+
+    - Update import paths for types (`TrackingEvents`, `OriginatorInfo`, `CommunicationLayerPreference`) to point to `@metamask/sdk-communication-layer`.
+    - Remove the import and usage of the `logger` from `sdk-communication-layer`. (Logging within `SendAnalytics` can be revisited if necessary).
+
+5.  **Export from New Package (`packages/analytics-client/src/index.ts`):**
+
+    - Export `SendAnalytics` and `AnalyticsProps` from `./Analytics`.
+    - Re-export `TrackingEvents`, `OriginatorInfo`, `CommunicationLayerPreference` from `@metamask/sdk-communication-layer` for consumer convenience.
+
+6.  **Update Dependencies in Consuming Packages:**
+
+    - In `packages/sdk/package.json`: Add `"@metamask/analytics-client": "workspace:^"` to `dependencies`.
+    - In `packages/sdk-communication-layer/package.json`: Remove `"cross-fetch"` from `dependencies` (if it's no longer used elsewhere in that package).
+
+7.  **Update SDK Code (`packages/sdk/src/services/Analytics.ts` & `Analytics.test.ts`):**
+
+    - Change imports of `SendAnalytics`, `AnalyticsProps`, `TrackingEvents` from `@metamask/sdk-communication-layer` to `@metamask/analytics-client`.
+    - Keep the import for `DEFAULT_SERVER_URL` pointing to `@metamask/sdk-communication-layer`.
+    - Update the `jest.mock` path in `Analytics.test.ts` to `@metamask/analytics-client`.
+
+8.  **Clean Up Communication Layer (`packages/sdk-communication-layer`):**
+
+    - Delete the original `packages/sdk-communication-layer/src/Analytics.ts` file.
+    - In `packages/sdk-communication-layer/src/index.ts`, remove the exports for `SendAnalytics` and `AnalyticsProps`. Keep exports for the shared types (`TrackingEvents`, `OriginatorInfo`, etc.).
+
+9.  **Install & Build:**
+
+    - Run `yarn install` at the workspace root to link the new package and update dependencies.
+    - Run `yarn build` (or the appropriate workspace build command) at the root to compile the new package and check for errors.
+
+10. **Test:**
+    - Run `yarn test` (or the appropriate workspace test command) at the root. Address any test failures, particularly in `packages/sdk`.

packages/analytics-client/package.json

@@ -1,4 +1,58 @@
 {
-  "name": "analytics-client",
+  "name": "@metamask/analytics-client",
+  "version": "0.1.0",
+  "description": "Client library for sending analytics events for MetaMask SDK",
+  "homepage": "https://github.com/MetaMask/metamask-sdk#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/metamask-sdk/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/metamask-sdk.git",
+    "directory": "packages/analytics-client"
+  },
+  "license": "MIT",
+  "author": "MetaMask",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "build": "yarn build:clean && tsc --project tsconfig.json",
+    "build:types": "tsc --project tsconfig.json --emitDeclarationOnly --outDir dist/types",
+    "build:clean": "rimraf ./dist && rimraf tsconfig.tsbuildinfo",
+    "clean": "rimraf ./dist && rimraf tsconfig.tsbuildinfo",
+    "lint": "yarn lint:eslint && yarn lint:misc --check",
+    "lint:eslint": "eslint . --cache --ext js,ts",
+    "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write",
+    "lint:misc": "prettier '**/*.json' '**/*.md' '!CHANGELOG.md' --ignore-path ../../.gitignore",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@metamask/sdk-types": "workspace:^",
+    "cross-fetch": "^4.0.0"
+  },
+  "devDependencies": {
+    "@lavamoat/allow-scripts": "^2.3.1",
+    "@types/analytics-node": "^3.1.13",
+    "@types/body-parser": "^1.19.4",
+    "@types/cors": "^2.8.15",
+    "@types/express": "^4.17.20",
+    "@types/node": "^20.4.1",
+    "@typescript-eslint/eslint-plugin": "^4.20.0",
+    "@typescript-eslint/parser": "^4.20.0",
+    "eslint": "^7.30.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^3.4.0",
+    "prettier": "^2.8.8",
+    "rimraf": "^6.0.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.3.5"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
   "packageManager": "[email protected]"
 }

packages/sdk-communication-layer/src/Analytics.ts renamed to packages/analytics-client/src/Analytics.ts

@@ -1,19 +1,17 @@
 import crossFetch from 'cross-fetch';
-import { CommunicationLayerPreference } from './types/CommunicationLayerPreference';
-import { OriginatorInfo } from './types/OriginatorInfo';
-import { TrackingEvents } from './types/TrackingEvent';
-import { logger } from './utils/logger';
+import { type OriginatorInfo, TrackingEvent } from '@metamask/sdk-types'; // Use types package
 
-export interface AnalyticsProps {
+// Changed to type as per lint rule
+export type AnalyticsProps = {
   id: string;
-  event: TrackingEvents;
-  originatorInfo?: OriginatorInfo;
-  commLayer?: CommunicationLayerPreference;
+  event: TrackingEvent; // Reverted back to enum type
+  originatorInfo?: OriginatorInfo; // Now uses local type
+  // commLayer?: CommunicationLayerPreference; // Removed prop
   sdkVersion?: string;
   commLayerVersion?: string;
   walletVersion?: string;
   params?: Record<string, unknown>;
-}
+};
 
 // Buffer for storing events
 let analyticsBuffer: AnalyticsProps[] = [];
@@ -63,10 +61,6 @@ async function sendBufferedEvents(parameters: AnalyticsProps) {
 
   const body = JSON.stringify(flatParams);
 
-  logger.RemoteCommunication(
-    `[sendBufferedEvents] Sending ${analyticsBuffer.length} analytics events to ${serverUrl}`,
-  );
-
   try {
     const response = await crossFetch(serverUrl, {
       method: 'POST',
@@ -77,14 +71,22 @@ async function sendBufferedEvents(parameters: AnalyticsProps) {
       body,
     });
 
-    const text = await response.text();
-    logger.RemoteCommunication(`[sendBufferedEvents] Response: ${text}`);
+    // Check if the request was successful before clearing the buffer
+    if (!response.ok) {
+      // Log a warning if the request failed
+      console.warn(
+        `[Analytics] Failed to send analytics event: ${response.status} ${response.statusText}`,
+      );
+      // Optionally, handle the error differently, e.g., retry or log more details
+      // For now, we proceed to clear the buffer even on failure to prevent buildup
+    }
 
     // Clear the processed buffer --- operation is atomic and no race condition can happen since we use a separate buffer
     // eslint-disable-next-line require-atomic-updates
     analyticsBuffer.length = 0;
   } catch (error) {
-    console.warn(`Error sending analytics`, error);
+    // console.warn is kept as a basic logging mechanism for now
+    console.warn(`[Analytics] Error sending analytics`, error);
   }
 }
 

packages/analytics-client/src/index.ts

@@ -0,0 +1,9 @@
+export { SendAnalytics } from './Analytics';
+export type { AnalyticsProps } from './Analytics';
+
+// Removed re-exports from communication-layer
+// export type {
+//   TrackingEvents,
+//   OriginatorInfo,
+//   CommunicationLayerPreference,
+// } from '@metamask/sdk-communication-layer';

packages/analytics-client/tsconfig.eslint.json

@@ -0,0 +1,12 @@
+{
+  "extends": "./tsconfig.json",
+  "include": [
+    "src/**/*.ts",
+    "*.js"
+    // Include test files if applicable and not covered by the main tsconfig
+    // "test/**/*.ts"
+  ],
+  "compilerOptions": {
+    "noEmit": true // Important: ESLint only needs parsing, not compilation output
+  }
+}

packages/analytics-client/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "composite": true
+    // Override or add any specific compiler options for this package if needed
+    // e.g., "lib": ["es2020", "dom"]
+  },
+  "include": ["src/**/*"],
+  "exclude": [
+    "node_modules",
+    "dist",
+    "**/*.test.ts" // Exclude tests from main build if separate test command used
+  ],
+  "references": [
+    // Add references to other workspace packages this package depends on
+    { "path": "../sdk-types" } // Added reference to sdk-types
+  ]
+}

packages/analytics-server/.eslintrc.js

@@ -1,19 +1,31 @@
+const path = require('path');
+
+/**
+ * @type {import('eslint').Linter.Config}
+ */
 module.exports = {
-  root: true,
-  parser: '@typescript-eslint/parser',
-  plugins: ['@typescript-eslint'],
   extends: [
-    'eslint:recommended',
-    'plugin:@typescript-eslint/recommended',
-    'prettier',
+    '@metamask/eslint-config-nodejs', // Use nodejs config for server
+    '@metamask/eslint-config-typescript',
+    '../../.eslintrc.js' // Extend the root config
   ],
-  env: {
-    node: true,
-    es6: true,
+  root: true,
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: [path.resolve(__dirname, 'tsconfig.eslint.json')], // Point to eslint tsconfig
   },
+
+  ignorePatterns: [
+    '.prettierrc.js',
+    '**/.eslintrc.js',
+    '**/jest.config.ts',
+    '**/dist*/',
+  ],
+  
+  // Remove env and basic rules as they are likely handled by extended configs
+  // Keep specific overrides if necessary
   rules: {
-    '@typescript-eslint/explicit-module-boundary-types': 'off',
-    '@typescript-eslint/no-explicit-any': 'warn',
-    '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
-  },
+    // Example override (if needed):
+    // '@typescript-eslint/no-explicit-any': 'warn',
+  }
 }; 

packages/analytics-server/tsconfig.eslint.json

@@ -0,0 +1,11 @@
+{
+  "extends": "./tsconfig.json", // Assuming analytics-server has a tsconfig.json
+  "include": [
+    "src/**/*.ts",
+    "*.js"
+    // Include test files if applicable
+  ],
+  "compilerOptions": {
+    "noEmit": true
+  }
+}