central-log.ts

/*
 *  This file is part of CoCalc: Copyright © 2020 Sagemath, Inc.
 *  License: MS-RSL – see LICENSE.md for details
 */

import { Table } from "./types";

Table({
  name: "central_log",
  fields: {
    id: {
      type: "uuid",
      desc: "Random id for this event",
    },
    event: {
      type: "string",
      desc: "Event name which must start with 'webapp-' to not conflict with other names that might be used already (e.g., by the backend).",
    },
    value: {
      type: "map",
      desc: "Any JSON-type data for this event",
    },
    time: {
      type: "timestamp",
      desc: "When the event took place",
    },
    expire: {
      type: "timestamp",
      desc: "future date, when the entry will be deleted",
    },
  },
  rules: {
    desc: "Table for logging system stuff that happens.  Meant for analytics, to help in running and understanding CoCalc better.  Not read by the frontend clients at all, except admins.",
    primary_key: "id",
    durability: "soft", // loss of some log data not serious, since used only for analytics
    pg_indexes: ["time", "event"],
    user_query: {
      get: {
        admin: true,
        fields: {
          id: null,
          event: null,
          value: null,
          time: null,
        },
      },
      set: {
        fields: {
          id: true,
          event: true,
          value: true,
          time: true,
        },
        check_hook: (_db, query, _account_id, _project_id, cb): void => {
          if (!query.event.startsWith("webapp-")) {
            cb("event must start with 'webapp-'");
          } else {
            cb();
          }
        },
      },
    },
  },
});