@twasik4/pocket-service 1.0.3 → 1.1.0

package/src/workers/stream-handler.ts

@@ -1,25 +0,0 @@
-export type RedisStreamHandlerContext = {
-  service: string;
-  emit: (ev: {
-    type: string;
-    data: Record<string, string | number | boolean | null>;
-  }) => Promise<void>;
-  log: {
-    info: (msg: string) => void;
-    warn: (msg: string) => void;
-    error: (msg: string) => void;
-  };
-};
-export type RedisStreamEventHandler = {
-  type: string;
-  execute: (
-    ev: Record<string, any>,
-    ctx: RedisStreamHandlerContext,
-  ) => Promise<void>;
-};
-export function redisStreamHandler(
-  type: string,
-  fn: RedisStreamEventHandler["execute"],
-): RedisStreamEventHandler {
-  return { type, execute: fn };
-}

package/src/workers/types.ts

@@ -1,59 +0,0 @@
-import { NextFunction, Request, Response } from "express";
-import { Logger } from "winston";
-
-export type Message = {
-  type: string;
-  userId: string;
-  teamId: string;
-  timestamp: number;
-  payload: Record<string, string | number | boolean | null>;
-};
-export type ExpressMiddleware = (
-  req: Request,
-  res: Response,
-  next: NextFunction,
-) => void;
-export type BaseExpressOptions = {
-  /**
-   * Don't include the default health check and metrics routes.
-   */
-  omitDefaultRoutes?: boolean;
-  /**
-   * Whether to parse incoming request bodies as JSON.
-   */
-  asJson: boolean;
-  /**
-   * An array of custom Express middleware functions to apply to the Express app globally (before all routes).
-   */
-  customMiddleware?: ExpressMiddleware[];
-  /**
-   * Whether to allow CORS requests with credentials (cookies, authorization headers, etc.). This option is only relevant if CORS is enabled via either `corsFn` or `corsWhitelist`.
-   */
-  credentials?: boolean;
-};
-export type ExpressOptionsWithCorsFn = BaseExpressOptions & {
-  /**
-   * A function to determine whether to allow CORS requests from a given origin.
-   * @param origin The origin of the request.
-   * @param callback A callback function to indicate whether the origin is allowed.
-   */
-  corsFn: (
-    origin: string | undefined,
-    callback: (err: Error | null, allow?: boolean) => void,
-  ) => void;
-};
-export type ExpressOptionsWithCorsWhitelist = BaseExpressOptions & {
-  /**
-   * An array of allowed origins for CORS requests. If the origin of an incoming request is in this whitelist, the request will be allowed.
-   */
-  corsWhitelist: string[];
-};
-export type ExpressOptions =
-  | ExpressOptionsWithCorsFn
-  | ExpressOptionsWithCorsWhitelist;
-export type CustomModuleFactory = (log: Logger) => boolean | Promise<boolean>;
-export type CustomModules = {
-  init: CustomModuleFactory;
-  shutdown?: CustomModuleFactory;
-  name: string;
-}[];

package/src/workers/utils.ts

@@ -1,19 +0,0 @@
-import * as crypto from "crypto";
-
-export function generateRandomHexString(length: number): string {
-  if (length % 2 !== 0) {
-    throw new Error("Length must be an even number");
-  }
-
-  const numBytes = length / 2;
-  const randomBytes = crypto.randomBytes(numBytes);
-  return randomBytes.toString("hex");
-}
-
-export function getUseableDatesFromMs(ms: number) {
-  const seconds = Math.floor((ms / 1000) % 60);
-  const minutes = Math.floor((ms / (1000 * 60)) % 60);
-  const hours = Math.floor((ms / (1000 * 60 * 60)) % 24);
-  const days = Math.floor(ms / (1000 * 60 * 60 * 24));
-  return { days, hours, minutes, seconds };
-}

package/tests/mongo.spec.ts

@@ -1,92 +0,0 @@
-/// <reference types="vitest/globals" />
-import z from "zod";
-import {
-  defineMongoCollection,
-  MongoCollectionDefinition,
-} from "../src/workers/db/mongo/mongo";
-import { MongoMemoryServer } from "mongodb-memory-server";
-import { Service } from "../src/workers/service";
-
-describe("MongoDB Dependency", () => {
-  let service: Service<{
-    testCollection: MongoCollectionDefinition<
-      {
-        name: string;
-      },
-      {}
-    >;
-  }>;
-  let mongoServer: MongoMemoryServer;
-
-  beforeAll(async () => {
-    mongoServer = await MongoMemoryServer.create();
-    const uri = mongoServer.getUri();
-    service = new Service()
-      .withName("admin-service")
-      .withPort(4120)
-      .withRedis("redis://localhost:6379")
-      .withMongo({
-        dbName: "test",
-        uri,
-        collections: {
-          testCollection: defineMongoCollection({
-            schema: z.object({
-              name: z.string(),
-            }),
-          }),
-        },
-      })
-      .build();
-  });
-
-  afterEach(async () => {
-    await service.db.testCollection.delete({});
-  });
-
-  afterAll(async () => {
-    await mongoServer.stop();
-  });
-
-  it("Should contain the custom collection", () => {
-    expect(service.db).toHaveProperty("testCollection");
-  });
-
-  it("Should not contain undefined collection", () => {
-    expect(() => service.db).not.toHaveProperty("undefinedCollection");
-  });
-
-  it("Should be initialized", () => {
-    expect(() => service.mongo).not.toThrow();
-  });
-
-  it("Should return an empty array when getting from an empty collection", async () => {
-    const res = await service.db.testCollection.get();
-    expect(res).toEqual([]);
-  });
-
-  it("Should insert and retrieve documents correctly", async () => {
-    await service.db.testCollection.insert({ name: "test" });
-    const res = await service.db.testCollection.get({});
-    expect(res.length).toBe(1);
-    expect(res[0].name).toEqual("test");
-  });
-
-  it("Should delete documents correctly", async () => {
-    await service.db.testCollection.insert({ name: "toDelete" });
-    await service.db.testCollection.delete({ name: "toDelete" });
-    const res = await service.db.testCollection.get({ name: "toDelete" });
-    expect(res).toEqual([]);
-  });
-
-  it("Should update documents correctly", async () => {
-    await service.db.testCollection.insert({ name: "toUpdate" });
-    await service.db.testCollection.updateOne(
-      { name: "toUpdate" },
-      { name: "updated" },
-    );
-    const res = await service.db.testCollection.get({ name: "updated" });
-    expect(res.length).toBe(1);
-    expect(res[0].name).toEqual("updated");
-    console.log("Updated document:", res[0]);
-  });
-});

package/tests/redis.spec.ts

@@ -1,36 +0,0 @@
-/// <reference types="vitest/globals" />
-import { Service } from "../src/workers/service";
-
-describe.only("Redis Dependency", () => {
-  let service: Service<{}>;
-
-  beforeAll(async () => {
-    service = new Service()
-      .withName("admin-service")
-      .withPort(3103)
-      .withRedis("redis://localhost:6379")
-      .build();
-  });
-
-  it("Should not throw an error when accessing redis", () => {
-    expect(() => service.redis).not.toThrow();
-  });
-
-  it.skip("Should automatically register the service to redis", async () => {
-    const value = await service.redis.get("services:registry:admin-service");
-    expect(value).toBeDefined();
-    const parsedValue = JSON.parse(value!);
-    expect(parsedValue.name).equal("admin-service");
-    expect(parsedValue.streamKey).equal("admin:events");
-    expect(parsedValue.url).equal("http://admin-service:3103");
-    expect(parsedValue.dependencies).toEqual([]);
-    expect(parsedValue.routes).toBeInstanceOf(Array);
-    expect(
-      parsedValue.routes.some(
-        (s: any) => s.method === "GET" && s.path === "/health",
-      ),
-    ).toBeTruthy();
-    expect(parsedValue.routes.length).toBeGreaterThan(0);
-    expect(parsedValue.lastHeartbeat).toBeDefined();
-  });
-});

package/tests/service.spec.ts

@@ -1,82 +0,0 @@
-/// <reference types="vitest/globals" />
-import z from "zod";
-import { defineMongoCollection } from "../src/workers/db/mongo/mongo";
-import { MongoMemoryServer } from "mongodb-memory-server";
-import { Service } from "../src/workers/service";
-import { CustomDependencies } from "../src/workers/types";
-
-describe("Service Class", () => {
-  it("Should be able to be initialized", async () => {
-    const service = new Service()
-      .withName("admin-service")
-      .withPort(3000)
-      .build();
-    expect(service.simpleName).toBe("admin");
-    expect(() => service.log.info("Service initialized")).not.toThrow();
-  });
-
-  it("Should throw error if accessing uninitialized dependencies", async () => {
-    const service = new Service().withName("admin-service").build();
-    expect(() => service.redis).toThrow("Redis module has not been added.");
-    expect(() => service.clickhouse).toThrow(
-      "Clickhouse module has not been added.",
-    );
-  });
-
-  it("Should initialize Redis dependency", async () => {
-    const service = new Service()
-      .withName("admin-service")
-      .withRedis("redis://localhost:6379")
-      .build();
-    expect(() => service.redis).not.toThrow();
-  });
-
-  it("Should initialize MongoDB dependency", async () => {
-    const mongoServer = await MongoMemoryServer.create();
-    const uri = mongoServer.getUri();
-    const service = new Service()
-      .withName("admin-service")
-      .withPort(4120)
-      .withRedis("redis://localhost:6379")
-      .withMongo({
-        dbName: "test",
-        uri,
-        collections: {
-          testCollection: defineMongoCollection({
-            schema: z.object({
-              name: z.string(),
-            }),
-          }),
-        },
-      })
-      .build();
-
-    expect(() => service.mongo).not.toThrow();
-    await mongoServer.stop();
-  });
-
-  it("Should allow custom dependencies", async () => {
-    const service = new Service()
-      .withName("admin-service")
-      .withPort(4120)
-      .withModules([
-        {
-          name: "doSomething",
-          init: async (log) => {
-            log.info("Initializing custom dependency");
-            return true;
-          },
-        },
-      ])
-      .withRedis("redis://localhost:6379")
-      .build();
-    expect(service["dependencies"].has("customDependencies")).toBe(true);
-    const customDeps = service["dependencies"].get(
-      "customDependencies",
-    ) as CustomDependencies;
-    expect(customDeps).toBeDefined();
-    expect(customDeps[0].name).toBe("doSomething");
-    expect(await customDeps[0].init(service.log)).toBe(true);
-    expect(customDeps[0].shutdown).toBeUndefined();
-  });
-});

package/tsconfig.json

@@ -1,12 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "rootDir": "src",
-    "outDir": "dist",
-    "declaration": true,
-    "declarationMap": true,
-    "emitDeclarationOnly": false
-  },
-  "include": ["src"],
-  "exclude": ["node_modules", "dist"]
-}

package/tsup.config.ts

@@ -1,11 +0,0 @@
-import { defineConfig } from "tsup";
-
-export default defineConfig({
-  entry: ["src/index.ts", "src/worker-thread.ts"],
-  format: ["esm"],
-  dts: true,
-  sourcemap: true,
-  clean: true,
-  minify: true,
-  outDir: "dist",
-});

package/vitest.config.ts

@@ -1,8 +0,0 @@
-import { defineConfig } from "vitest/config";
-
-export default defineConfig({
-  test: {
-    globals: true,
-    include: ["tests/**/*.spec.ts"],
-  },
-});