hardhat/src/internal/cli/telemetry/analytics/utils.ts

Hardhat is an extensible developer tool that helps smart contract developers increase productivity by reliably bringing together the tools they want.

import type { AnalyticsFile } from "./types.js";

import path from "node:path";

import {
  exists,
  readJsonFile,
  writeJsonFile,
} from "@nomicfoundation/hardhat-utils/fs";
import { getTelemetryDir } from "@nomicfoundation/hardhat-utils/global-dir";
import debug from "debug";

const log = debug("hardhat:cli:telemetry:analytics:utils");

const ANALYTICS_FILE_NAME = "analytics.json";

export async function getAnalyticsClientId(): Promise<string> {
  let clientId = await readAnalyticsClientId();

  if (clientId === undefined) {
    log("Client Id not found, generating a new one");

    clientId = crypto.randomUUID();
    await writeAnalyticsClientId(clientId);
  }

  return clientId;
}

async function readAnalyticsClientId(): Promise<string | undefined> {
  const globalTelemetryDir = await getTelemetryDir();
  const filePath = path.join(globalTelemetryDir, ANALYTICS_FILE_NAME);

  log(`Looking up Client Id at '${filePath}'`);

  if ((await exists(filePath)) === false) {
    return undefined;
  }

  const data: AnalyticsFile = await readJsonFile(filePath);
  const clientId = data.analytics.clientId;

  log(`Client Id found: ${clientId}`);

  return clientId;
}

async function writeAnalyticsClientId(clientId: string): Promise<void> {
  const globalTelemetryDir = await getTelemetryDir();
  const filePath = path.join(globalTelemetryDir, ANALYTICS_FILE_NAME);
  await writeJsonFile(filePath, {
    analytics: {
      clientId,
    },
  });

  log(`Stored clientId '${clientId}'`);
}