browser/libs/common/src/tools/log/logger.ts

import { BehaviorSubject, SubjectLike, filter, first, from, map, zip } from "rxjs";
import { Primitive } from "type-fest";

import { Account, AccountService } from "../../auth/abstractions/account.service";
import { AppIdService } from "../../platform/abstractions/app-id.service";
import { PlatformUtilsService } from "../../platform/abstractions/platform-utils.service";
import { UserActionEvent } from "../achievements/types";

import { ServiceFormat, UserFormat, EcsEventType } from "./ecs-format";
import { SemanticLogger } from "./semantic-logger.abstraction";

export abstract class UserEventLogProvider {
  abstract create: (account: Account) => UserEventLogger;
}

type BaselineType = Omit<ServiceFormat & UserFormat, "@timestamp">;

type EventInfo = {
  action: string;
  labels?: Record<string, Primitive>;
  tags?: Array<string>;
};

export class UserEventLogger {
  constructor(
    idService: AppIdService,
    utilService: PlatformUtilsService,
    accountService: AccountService,
    private now: () => number,
    private log: SemanticLogger,
    private events$: SubjectLike<UserActionEvent>,
  ) {
    zip(
      from(idService.getAppId()),
      from(utilService.getApplicationVersion()),
      accountService.activeAccount$.pipe(
        filter((account) => !!account),
        first(),
      ),
    )
      .pipe(
        map(
          ([appId, version, account]) =>
            ({
              event: {
                kind: "event",
                category: "session",
              },
              service: {
                name: utilService.getDeviceString(),
                type: "client",
                node: {
                  name: appId,
                },
                environment: "local",
                version,
              },
              user: {
                // `account` verified not-null via `filter`
                id: account!.id,
                email: (account!.emailVerified && account!.email) || undefined,
              },
            }) satisfies BaselineType,
        ),
      )
      .subscribe((next) => this.baseline$.next(next));
  }

  private readonly baseline$ = new BehaviorSubject<BaselineType | null>(null);

  creation(event: EventInfo) {
    this.collect("creation", event);
  }

  deletion(event: EventInfo) {
    this.collect("deletion", event);
  }

  info(event: EventInfo) {
    this.collect("info", event);
  }

  access(event: EventInfo) {
    this.collect("access", event);
  }

  private collect(type: EcsEventType, info: EventInfo) {
    const { value: baseline } = this.baseline$;

    if (!baseline) {
      // TODO: buffer logs and stream them when `baseline$` becomes available.
      this.log.error("baseline log not available; dropping user event");
      return;
    }

    const event = structuredClone(this.baseline$.value) as UserActionEvent;
    event["@timestamp"] = this.now();

    event.event.type = type;
    event.action = info.action;
    event.tags = info.tags && info.tags.filter((t) => !!t);

    if (info.labels) {
      const entries = Object.keys(info.labels)
        .filter((k) => !!info.labels![k])
        .map((k) => [k, info.labels![k]] as const);
      const labels = Object.fromEntries(entries);
      event.labels = labels;
    }

    this.events$.next(event);
  }
}