@token-dashboard/typeless-usage-uploader 0.1.0

package/README.md

@@ -0,0 +1,25 @@
+# Typeless 用量上报
+
+独立的 Typeless 去内容化用量采集与上报 CLI。
+
+默认读取：
+
+- `~/Library/Application Support/Typeless/typeless.db`
+- `~/Library/Application Support/Typeless/app-storage.json`
+
+采集端只上传明细记录的时间、字符长度和 Typeless 账号身份，不上传 `refined_text`、音频、窗口标题、URL、debug 信息、referral code 或公钥。
+
+```bash
+typeless-usage-uploader init --backend-url http://localhost:8086
+typeless-usage-uploader status
+typeless-usage-uploader logs
+```
+
+开发环境：
+
+```bash
+cd typeless-collector
+npm test
+npm run build
+npm run init
+```

package/dist/bin/typeless-usage-uploader.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+if(!process.env.NODE_NO_WARNINGS){process.env.NODE_NO_WARNINGS='1'}
+process.emitWarning=()=>{};
+const{main}=await import('../cli.js');
+await main(process.argv.slice(2));

package/dist/cli.js

@@ -0,0 +1,373 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { TypelessUsageUploader } from './collector.js';
+import {
+  CLI_NAME,
+  DEFAULT_BACKEND_URL,
+  DEFAULT_CONFIG_FILE,
+  PRODUCT_NAME,
+} from './constants.js';
+import { LaunchdServiceManager } from './launchd.js';
+import { formatStatusOutput, mergeRuntimeConfig, saveRuntimeConfig } from './runtime-config.js';
+import { StateDb } from './state-db.js';
+
+const HELP_TEXT = `${PRODUCT_NAME}
+
+Usage:
+  ${CLI_NAME} init [--backend-url <url>] [--interval 300] [--yes]
+  ${CLI_NAME} clear [--yes]
+  ${CLI_NAME} start
+  ${CLI_NAME} stop
+  ${CLI_NAME} restart
+  ${CLI_NAME} status
+  ${CLI_NAME} logs [--lines 100]
+  ${CLI_NAME} uninstall
+
+Common options:
+  --config-file <path>       Runtime config path. Default: ${DEFAULT_CONFIG_FILE}
+  --backend-url <url>        Dashboard backend URL
+  --interval <seconds>       Scan interval in seconds
+  --typeless-db <path>       Typeless typeless.db path
+  --typeless-storage <path>  Typeless app-storage.json path
+  --state-db <path>          Local SQLite state DB path
+  --yes                      Skip interactive prompts
+  --lines <n>                Number of log lines for service logs
+  -h, --help                 Show help
+`;
+
+class CliOperationalError extends Error {
+  constructor(message) {
+    super(message);
+    this.name = 'CliOperationalError';
+  }
+}
+
+export const cliDeps = {
+  createUploader(runtime) {
+    return new TypelessUsageUploader({
+      stateDbPath: runtime.stateDbPath,
+      backendUrl: runtime.backendUrl,
+      typelessDbPath: runtime.typelessDbPath,
+      typelessStoragePath: runtime.typelessStoragePath,
+      intervalSeconds: runtime.intervalSeconds,
+      persistentCollectorIdPath: runtime.persistentCollectorIdPath,
+    });
+  },
+  createServiceManager(runtime) {
+    return new LaunchdServiceManager(runtime);
+  },
+};
+
+export function parseCliArgs(argv) {
+  const options = {
+    configFile: DEFAULT_CONFIG_FILE,
+    interval: undefined,
+    yes: false,
+    lines: 100,
+  };
+  const positionals = [];
+
+  for (let index = 0; index < argv.length; index += 1) {
+    const token = argv[index];
+    if (!token.startsWith('-')) {
+      positionals.push(token);
+      continue;
+    }
+    if (token === '-h' || token === '--help') {
+      options.help = true;
+      continue;
+    }
+    if (token === '--yes') {
+      options.yes = true;
+      continue;
+    }
+
+    const [key, inlineValue] = token.split('=', 2);
+    const takesValue = new Set([
+      '--config-file',
+      '--backend-url',
+      '--interval',
+      '--typeless-db',
+      '--typeless-storage',
+      '--state-db',
+      '--lines',
+    ]);
+    if (!takesValue.has(key)) throw new Error(`Unknown argument: ${token}`);
+    const value = inlineValue ?? argv[++index];
+    if (value == null || value.startsWith('-')) throw new Error(`Missing value for ${key}`);
+    assignOption(options, key, value);
+  }
+
+  return {
+    command: positionals[0] ?? null,
+    subcommand: positionals[1] ?? null,
+    extraPositionals: positionals.slice(2),
+    options,
+  };
+}
+
+function assignOption(options, key, value) {
+  switch (key) {
+    case '--config-file':
+      options.configFile = value;
+      break;
+    case '--backend-url':
+      options.backendUrl = value;
+      break;
+    case '--interval':
+      options.interval = parsePositiveInt(value, '--interval');
+      break;
+    case '--typeless-db':
+      options.typelessDbPath = value;
+      break;
+    case '--typeless-storage':
+      options.typelessStoragePath = value;
+      break;
+    case '--state-db':
+      options.stateDbPath = value;
+      break;
+    case '--lines':
+      options.lines = parsePositiveInt(value, '--lines');
+      break;
+    default:
+      throw new Error(`Unknown argument: ${key}`);
+  }
+}
+
+function parsePositiveInt(value, label) {
+  const parsed = Number.parseInt(String(value), 10);
+  if (!Number.isFinite(parsed) || parsed <= 0) {
+    throw new Error(`${label} must be a positive integer`);
+  }
+  return parsed;
+}
+
+function runtimeOverrides(options) {
+  const overrides = {};
+  if (options.backendUrl !== undefined) overrides.backendUrl = options.backendUrl;
+  if (options.interval !== undefined) overrides.intervalSeconds = options.interval;
+  if (options.typelessDbPath !== undefined) overrides.typelessDbPath = options.typelessDbPath;
+  if (options.typelessStoragePath !== undefined) {
+    overrides.typelessStoragePath = options.typelessStoragePath;
+  }
+  if (options.stateDbPath !== undefined) overrides.stateDbPath = options.stateDbPath;
+  return overrides;
+}
+
+function printHelp() {
+  console.log(HELP_TEXT);
+}
+
+function currentEntryFile() {
+  return fileURLToPath(new URL('../bin/typeless-usage-uploader.js', import.meta.url));
+}
+
+async function runInit(options) {
+  const overrides = runtimeOverrides(options);
+  if (!overrides.backendUrl) overrides.backendUrl = DEFAULT_BACKEND_URL;
+  let runtime = mergeRuntimeConfig(options.configFile, overrides);
+  runtime.entryFile = currentEntryFile();
+  runtime = saveRuntimeConfig(runtime);
+
+  const uploader = cliDeps.createUploader(runtime);
+  try {
+    const scanResult = await uploader.scanTypeless();
+    scanResult.batchesQueued += uploader.stateDb.sealStaleBatches(true);
+    await uploader.flushPendingBatches({ failFast: false });
+    const manager = cliDeps.createServiceManager(runtime);
+    try {
+      manager.start();
+      console.log(`${PRODUCT_NAME} initialized and started.`);
+    } catch (error) {
+      console.log(`${PRODUCT_NAME} initialized. Service start skipped: ${error instanceof Error ? error.message : String(error)}`);
+    }
+    console.log(`Backend: ${runtime.backendUrl}`);
+    console.log(`Install root: ${runtime.installRoot}`);
+    console.log(`Config file: ${runtime.configFile}`);
+    console.log(`Collector ID: ${uploader.identity.collectorId}`);
+    console.log(
+      `Initial scan: account=${scanResult.accountFound ? 'yes' : 'no'} db=${scanResult.dbFound ? 'yes' : 'no'} changed=${scanResult.changedEvents} deleted=${scanResult.tombstoneEvents}`,
+    );
+  } finally {
+    uploader.close();
+  }
+}
+
+function loadQueueStats(stateDbPath) {
+  if (!fs.existsSync(stateDbPath)) {
+    return {
+      collectorId: null,
+      bufferingBatchCount: 0,
+      pendingBatchCount: 0,
+      retryingBatchCount: 0,
+      queuedEvents: 0,
+      oldestPendingAgeSeconds: null,
+    };
+  }
+  const stateDb = new StateDb(stateDbPath);
+  try {
+    const identity = stateDb.getIdentity();
+    return {
+      collectorId: identity.collectorId ?? null,
+      ...stateDb.getQueueStats(),
+    };
+  } finally {
+    stateDb.close();
+  }
+}
+
+function printStatus(runtime, status) {
+  const payload = {
+    ...formatStatusOutput(runtime, status),
+    ...loadQueueStats(runtime.stateDbPath),
+  };
+  const lines = [
+    ['Config exists', payload.configExists ? 'yes' : 'no'],
+    ['Loaded', payload.loaded ? 'yes' : 'no'],
+    ['Running', payload.running ? 'yes' : 'no'],
+    ['Auto start on login', payload.autoStartOnLogin ? 'yes' : 'no'],
+    ['PID', payload.pid ?? '-'],
+    ['State', payload.state ?? '-'],
+    ['Last exit code', payload.lastExitCode ?? '-'],
+    ['Collector ID', payload.collectorId ?? '-'],
+    ['Upload URL', payload.backendUrl ? `${payload.backendUrl}/typeless-usage/upload` : '-'],
+    ['Register URL', payload.backendUrl ? `${payload.backendUrl}/typeless-usage/collectors/register` : '-'],
+    ['Interval', `${payload.intervalSeconds}s`],
+    ['Typeless DB', payload.typelessDbPath],
+    ['Typeless storage', payload.typelessStoragePath],
+    ['Buffering batches', payload.bufferingBatchCount],
+    ['Pending batches', payload.pendingBatchCount],
+    ['Retrying batches', payload.retryingBatchCount],
+    ['Queued events', payload.queuedEvents],
+    [
+      'Oldest pending age',
+      payload.oldestPendingAgeSeconds == null
+        ? '-'
+        : `${payload.oldestPendingAgeSeconds}s`,
+    ],
+    ['Config file', payload.configFile],
+    ['State DB', payload.stateDbPath],
+    ['Stdout log', payload.stdoutLogPath],
+    ['Stderr log', payload.stderrLogPath],
+    ['Service plist', payload.plistPath],
+    ['LaunchAgent plist', payload.launchAgentPath],
+    ['Label', payload.label],
+  ];
+  for (const [label, value] of lines) console.log(`${label}: ${value}`);
+}
+
+function ensureInitialized(runtime) {
+  if (!fs.existsSync(runtime.configFile) || !runtime.entryFile) {
+    throw new CliOperationalError(
+      `Uploader is not initialized yet. Run \`${CLI_NAME} init\` first.`,
+    );
+  }
+}
+
+async function runClear(options) {
+  const runtime = mergeRuntimeConfig(options.configFile, runtimeOverrides(options));
+  const uploader = cliDeps.createUploader(runtime);
+  try {
+    uploader.resetBackfillState();
+  } finally {
+    uploader.close();
+  }
+  console.log('Local Typeless scan state has been cleared.');
+}
+
+function runLifecycleCommand(action, options) {
+  const runtime = mergeRuntimeConfig(options.configFile, runtimeOverrides(options));
+  const manager = cliDeps.createServiceManager(runtime);
+  switch (action) {
+    case 'start':
+      ensureInitialized(runtime);
+      manager.start();
+      console.log('Service started.');
+      break;
+    case 'stop':
+      manager.stop();
+      console.log('Service stopped.');
+      break;
+    case 'restart':
+      ensureInitialized(runtime);
+      manager.restart();
+      console.log('Service restarted.');
+      break;
+    case 'uninstall':
+      manager.uninstall();
+      console.log('Service uninstalled.');
+      break;
+  }
+}
+
+async function runInternalWorker(options) {
+  const runtime = mergeRuntimeConfig(options.configFile, runtimeOverrides(options));
+  const uploader = cliDeps.createUploader(runtime);
+  try {
+    console.log(
+      `[run] backend=${runtime.backendUrl ?? '-'} interval=${runtime.intervalSeconds}s typeless_db=${runtime.typelessDbPath}`,
+    );
+    await uploader.watch();
+  } finally {
+    uploader.close();
+  }
+}
+
+function tailFile(filePath, lines) {
+  if (!fs.existsSync(filePath)) return [];
+  return fs.readFileSync(filePath, 'utf8')
+    .split(/\r?\n/)
+    .filter((line, index, array) => !(index === array.length - 1 && line === ''))
+    .slice(-lines);
+}
+
+export async function main(argv = process.argv.slice(2)) {
+  const parsed = parseCliArgs(argv);
+  const { command, subcommand, extraPositionals, options } = parsed;
+  if (options.help || !command) {
+    printHelp();
+    return;
+  }
+  if (subcommand || extraPositionals.length) {
+    throw new Error('Unexpected extra arguments.');
+  }
+
+  switch (command) {
+    case 'init':
+      await runInit(options);
+      return;
+    case 'clear':
+      await runClear(options);
+      return;
+    case 'start':
+    case 'stop':
+    case 'restart':
+    case 'uninstall':
+      runLifecycleCommand(command, options);
+      return;
+    case 'status': {
+      const runtime = mergeRuntimeConfig(options.configFile, runtimeOverrides(options));
+      const manager = cliDeps.createServiceManager(runtime);
+      let status;
+      try {
+        status = manager.status();
+      } catch {
+        status = { loaded: false, running: false, pid: null, state: null, lastExitCode: null };
+      }
+      printStatus(runtime, status);
+      return;
+    }
+    case 'logs': {
+      const runtime = mergeRuntimeConfig(options.configFile, runtimeOverrides(options));
+      for (const line of tailFile(runtime.stdoutLogPath, options.lines)) console.log(line);
+      for (const line of tailFile(runtime.stderrLogPath, options.lines)) console.error(line);
+      return;
+    }
+    case 'run':
+      await runInternalWorker(options);
+      return;
+    default:
+      throw new Error(`Unknown command: ${command}`);
+  }
+}