@powerhousedao/reactor-api 1.21.2 → 1.22.0

package/src/index.ts

@@ -1,7 +0,0 @@
-export * from "./server";
-export * from "./subgraphs/manager";
-export * from "./utils";
-export * from "./processors";
-export * from "./types";
-export * from "./subgraphs";
-export * from "@powerhousedao/analytics-engine-core";

package/src/processors/analytics-processor.ts

@@ -1,18 +0,0 @@
-import { IAnalyticsStore } from "@powerhousedao/analytics-engine-core";
-import { Document, OperationScope } from "document-model/document";
-import { Processor } from "./processor";
-import { ProcessorOptions, ProcessorSetupArgs } from "../types";
-
-export * from "@powerhousedao/analytics-engine-core";
-
-export abstract class AnalyticsProcessor<
-  D extends Document = Document,
-  S extends OperationScope = OperationScope,
-> extends Processor<D, S> {
-  protected analyticsStore: IAnalyticsStore;
-
-  constructor(args: ProcessorSetupArgs, options?: ProcessorOptions) {
-    super(args, options);
-    this.analyticsStore = args.analyticsStore;
-  }
-}

package/src/processors/index.ts

@@ -1,4 +0,0 @@
-export * from "./analytics-processor";
-export * from "./operational-processor";
-export * from "./processor";
-export * from "./manager";

package/src/processors/manager.ts

@@ -1,75 +0,0 @@
-import { IDocumentDriveServer } from "document-drive";
-import { DocumentDriveDocument } from "document-model-libs/document-drive";
-
-import {
-  Db,
-  IProcessor,
-  IProcessorManager,
-  ProcessorSetupArgs,
-} from "../types";
-import { IAnalyticsStore } from "./analytics-processor";
-import { isProcessorClass, ProcessorClass } from "./processor";
-
-export class ProcessorManager implements IProcessorManager {
-  private reactor: IDocumentDriveServer;
-  private processors: IProcessor[] = [];
-
-  constructor(
-    driveServer: IDocumentDriveServer,
-    private operationalStore: Db,
-    private analyticsStore: IAnalyticsStore,
-  ) {
-    this.reactor = driveServer;
-    driveServer.on("driveAdded", this.#onDriveAdded.bind(this));
-  }
-
-  async #onDriveAdded(drive: DocumentDriveDocument) {
-    await Promise.all(
-      this.processors.map((module) =>
-        this.reactor.addInternalListener(
-          drive.state.global.id,
-          {
-            onStrands: (strands) => module.onStrands(strands),
-            onDisconnect: () => module.onDisconnect(),
-          },
-          { ...module.getOptions() },
-        ),
-      ),
-    );
-  }
-
-  async #onProcessorAdded(processor: IProcessor) {
-    const drives = await this.reactor.getDrives();
-
-    const options = processor.getOptions();
-    await Promise.all(
-      drives.map((drive) =>
-        this.reactor.addInternalListener(
-          drive,
-          {
-            onStrands: (strands) => processor.onStrands(strands),
-            onDisconnect: () => processor.onDisconnect(),
-          },
-          options,
-        ),
-      ),
-    );
-
-    console.log(`> Registered ${options.label} processor.`);
-  }
-
-  async registerProcessor(module: IProcessor | ProcessorClass) {
-    const args: ProcessorSetupArgs = {
-      reactor: this.reactor,
-      operationalStore: this.operationalStore,
-      analyticsStore: this.analyticsStore,
-    };
-
-    const processor = isProcessorClass(module) ? new module(args) : module;
-    processor.onSetup?.(args);
-
-    await this.#onProcessorAdded(processor);
-    this.processors.push(processor);
-    return processor;
-  }
-}

package/src/processors/operational-processor.ts

@@ -1,20 +0,0 @@
-import { Document, OperationScope } from "document-model/document";
-import { Db, ProcessorOptions, ProcessorSetupArgs } from "src/types";
-import { Processor } from "./processor";
-
-export abstract class OperationalProcessor<
-  D extends Document = Document,
-  S extends OperationScope = OperationScope,
-> extends Processor<D, S> {
-  protected operationalStore: Db;
-
-  constructor(args: ProcessorSetupArgs, options?: ProcessorOptions) {
-    super(args, options);
-    this.operationalStore = args.operationalStore;
-  }
-
-  onSetup(args: ProcessorSetupArgs) {
-    super.onSetup(args);
-    this.operationalStore = args.operationalStore;
-  }
-}

package/src/processors/processor.ts

@@ -1,75 +0,0 @@
-import {
-  IDocumentDriveServer,
-  InternalTransmitterUpdate,
-} from "document-drive";
-import { Document, OperationScope } from "document-model/document";
-import { IProcessor, ProcessorOptions, ProcessorSetupArgs } from "../types";
-
-export type ProcessorUpdate<
-  D extends Document = Document,
-  S extends OperationScope = OperationScope,
-> = InternalTransmitterUpdate<D, S>;
-
-export abstract class Processor<
-  D extends Document = Document,
-  S extends OperationScope = OperationScope,
-> implements IProcessor<D, S>
-{
-  protected reactor: IDocumentDriveServer;
-  protected processorOptions: ProcessorOptions = {
-    listenerId: "processor",
-    filter: {
-      branch: ["main"],
-      documentId: ["*"],
-      documentType: ["*"],
-      scope: ["global"],
-    },
-    block: false,
-    label: "processor",
-    system: true,
-  };
-
-  constructor(args: ProcessorSetupArgs, options?: ProcessorOptions) {
-    this.reactor = args.reactor;
-    if (options) {
-      this.processorOptions = { ...this.processorOptions, ...options };
-    }
-  }
-
-  onSetup(args: ProcessorSetupArgs): void {
-    this.reactor = args.reactor;
-  }
-
-  abstract onStrands(strands: ProcessorUpdate<D, S>[]): Promise<void>;
-
-  abstract onDisconnect(): Promise<void>;
-
-  getOptions() {
-    return this.processorOptions;
-  }
-}
-
-export class BaseProcessor extends Processor {
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  async onStrands(strands: ProcessorUpdate[]): Promise<void> {}
-  async onDisconnect(): Promise<void> {}
-}
-
-export type ProcessorClass = typeof BaseProcessor;
-
-// checks if the provided candidate is a descendant of the Processor class.
-export function isProcessorClass(
-  candidate: unknown,
-): candidate is ProcessorClass {
-  if (typeof candidate !== "function") return false;
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-  let proto = Object.getPrototypeOf(candidate);
-
-  while (proto) {
-    if (Object.prototype.isPrototypeOf.call(proto, Processor)) return true;
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-    proto = Object.getPrototypeOf(proto);
-  }
-
-  return false;
-}

package/src/server.ts

@@ -1,65 +0,0 @@
-import { PGlite } from "@electric-sql/pglite";
-import {
-  KnexAnalyticsStore,
-  KnexQueryExecutor,
-} from "@powerhousedao/analytics-engine-knex";
-import { IDocumentDriveServer } from "document-drive";
-import express, { Express } from "express";
-import fs from "node:fs";
-import https from "node:https";
-import path from "node:path";
-import { Pool } from "pg";
-import { IAnalyticsStore, ProcessorManager } from "./processors";
-import { SubgraphManager } from "./subgraphs/manager";
-import { API } from "./types";
-import { getDbClient } from "./utils/db";
-
-type Options = {
-  express?: Express;
-  port?: number;
-  dbPath: string | undefined;
-  client?: PGlite | typeof Pool | undefined;
-  https?: {
-    keyPath: string;
-    certPath: string;
-  };
-};
-
-const DEFAULT_PORT = 4000;
-
-export async function startAPI(
-  reactor: IDocumentDriveServer,
-  options: Options,
-): Promise<API> {
-  const port = options.port ?? DEFAULT_PORT;
-  const app = options.express ?? express();
-  const db = getDbClient(options.dbPath);
-  const analyticsStore = new KnexAnalyticsStore({
-    executor: new KnexQueryExecutor(),
-    knex: db,
-  }) as unknown as IAnalyticsStore; // TODO update @powerhousedao/analytics-engine-pg to use @powerhousedao/analytics-engine-core@0.3.2
-  const subgraphManager = new SubgraphManager(
-    "/",
-    app,
-    reactor,
-    db,
-    analyticsStore,
-  );
-  await subgraphManager.init();
-  const processorManager = new ProcessorManager(reactor, db, analyticsStore);
-
-  if (options.https) {
-    const currentDir = process.cwd();
-    const server = https.createServer(
-      {
-        key: fs.readFileSync(path.join(currentDir, options.https.keyPath)),
-        cert: fs.readFileSync(path.join(currentDir, options.https.certPath)),
-      },
-      app,
-    );
-    server.listen(port);
-  } else {
-    app.listen(port);
-  }
-  return { app, subgraphManager, processorManager };
-}

package/src/subgraphs/analytics/index.ts

@@ -1,119 +0,0 @@
-import {
-  AnalyticsQueryEngine,
-  IAnalyticsStore,
-} from "@powerhousedao/analytics-engine-core";
-import {
-  AnalyticsModel,
-  typedefs,
-  AnalyticsResolvers,
-} from "@powerhousedao/analytics-engine-graphql";
-import gql from "graphql-tag";
-import { Subgraph } from "../base/index.js";
-import { Context, SubgraphArgs } from "../index.js";
-import { GraphQLResolverMap } from "@apollo/subgraph/dist/schema-helper/resolverMap.js";
-
-export class AnalyticsSubgraph extends Subgraph {
-  analyticsStore: IAnalyticsStore;
-  analyticsModel: AnalyticsModel;
-
-  name = "analytics";
-  typeDefs = gql`
-    ${typedefs}
-  `;
-
-  resolvers = AnalyticsResolvers as GraphQLResolverMap<Context>;
-
-  constructor(args: SubgraphArgs) {
-    super(args);
-    this.analyticsStore = args.analyticsStore;
-
-    this.analyticsModel = new AnalyticsModel(
-      new AnalyticsQueryEngine(this.analyticsStore),
-    );
-
-    args.subgraphManager.setAdditionalContextFields({
-      dataSources: {
-        db: {
-          Analytics: this.analyticsModel,
-        },
-      },
-    });
-  }
-
-  async onSetup() {
-    await this.#createTables();
-  }
-
-  async #createTables() {
-    if (!(await this.operationalStore.schema.hasTable("AnalyticsDimension"))) {
-      await this.operationalStore.schema.createTable(
-        "AnalyticsDimension",
-        (table) => {
-          table.increments("id").primary();
-          table
-            .string("dimension")
-            .notNullable()
-            .index("analyticsdimension_dimension_index");
-          table
-            .string("path")
-            .notNullable()
-            .index("analyticsdimension_path_index");
-          table.string("label").nullable();
-          table.string("icon").nullable();
-          table.text("description").nullable();
-        },
-      );
-    }
-
-    if (!(await this.operationalStore.schema.hasTable("AnalyticsSeries"))) {
-      await this.operationalStore.schema.createTable(
-        "AnalyticsSeries",
-        (table) => {
-          table.increments("id").primary();
-          table
-            .string("source")
-            .notNullable()
-            .index("analyticsseries_source_index");
-          table
-            .timestamp("start")
-            .notNullable()
-            .index("analyticsseries_start_index");
-          table.timestamp("end").nullable().index("analyticsseries_end_index");
-          table
-            .string("metric")
-            .notNullable()
-            .index("analyticsseries_metric_index");
-          table
-            .float("value")
-            .notNullable()
-            .index("analyticsseries_value_index");
-          table.string("unit").nullable().index("analyticsseries_unit_index");
-          table.string("fn").notNullable().index("analyticsseries_fn_index");
-          table.json("params").nullable();
-        },
-      );
-    }
-
-    if (
-      !(await this.operationalStore.schema.hasTable(
-        "AnalyticsSeries_AnalyticsDimension",
-      ))
-    ) {
-      await this.operationalStore.schema.createTable(
-        "AnalyticsSeries_AnalyticsDimension",
-        (table) => {
-          table
-            .integer("seriesId")
-            .references("AnalyticsSeries.id")
-            .onDelete("CASCADE")
-            .index("analyticsseries_analyticsdimension_seriesid_index");
-          table
-            .integer("dimensionId")
-            .references("AnalyticsDimension.id")
-            .onDelete("CASCADE")
-            .index("analyticsseries_analyticsdimension_dimensionid_index");
-        },
-      );
-    }
-  }
-}

package/src/subgraphs/auth/env/getters.ts

@@ -1,30 +0,0 @@
-import ms from "ms";
-
-export const getJwtSecret = (): string => {
-  if (!process.env.JWT_SECRET) {
-    if (process.env.NODE_ENV === "production") {
-      throw new Error("JWT_SECRET is not defined");
-    }
-  }
-  return process.env.JWT_SECRET || "dev";
-};
-
-export const getJwtExpirationPeriod = (): string => {
-  if (!process.env.JWT_EXPIRATION_PERIOD) {
-    return "7d";
-  }
-  // check if number of seconds is provided
-  const expirationSeconds = Number(process.env.JWT_EXPIRATION_PERIOD);
-  if (!Number.isNaN(expirationSeconds)) {
-    // https://www.npmjs.com/package/jsonwebtoken for `expiresIn` format
-    return ms(expirationSeconds * 1000);
-  }
-  // check if a valid time string is provided
-  const expirationMs = ms(process.env.JWT_EXPIRATION_PERIOD);
-  if (!expirationMs) {
-    throw new Error(
-      "JWT_EXPIRATION_PERIOD must be a number of seconds or ms string",
-    );
-  }
-  return process.env.JWT_EXPIRATION_PERIOD;
-};