structured-metadata.ts

import { LogLevel } from "ubiquibot-logger/pretty-logs";
import { COMMIT_HASH } from "../../commit-hash";

function createStructuredMetadata(className: string, metadata: any) {
  const jsonPretty = JSON.stringify(metadata, null, 2);
  const stackLine = new Error().stack?.split("\n")[2] ?? "";
  const caller = stackLine.match(/at (\S+)/)?.[1] ?? "";
  const revision = COMMIT_HASH?.substring(0, 7) ?? null;
  const ubiquityMetadataHeader = `<!-- Ubiquity - ${className} - ${caller} - ${revision}`;

  let metadataSerialized: string;
  const metadataSerializedVisible = ["```json", jsonPretty, "```"].join("\n");
  const metadataSerializedHidden = [ubiquityMetadataHeader, jsonPretty, "-->"].join("\n");

  if (metadata?.logMessage?.type === LogLevel.FATAL) {
    // if the log message is fatal, then we want to show the metadata
    metadataSerialized = [metadataSerializedVisible, metadataSerializedHidden].join("\n");
  } else {
    // otherwise we want to hide it
    metadataSerialized = metadataSerializedHidden;
  }

  return metadataSerialized;
}

function parseStructuredMetadata(comment: string) {
  const regex = /<!-- Ubiquity - (.+?) - (.+?) - (.+?)\n(.*?)-->/gs;

  const match = regex.exec(comment);

  if (!match) {
    return null;
  }

  const [, type, caller, revision, jsonString] = match;

  let metadata;
  try {
    // TODO: fix metadata writing to encode html comments inside json without the html parser getting confused
    metadata = JSON.parse(jsonString.trim());
  } catch (error) {
    console.trace(jsonString);
    console.error("Failed to parse JSON:", error);

    return null;
  }

  return {
    className: type.trim(),
    caller: caller.trim(),
    revision: revision.trim(),
    metadata,
  };
}

export default {
  create: createStructuredMetadata,
  parse: parseStructuredMetadata,
};