Add event bus and storage layer

This commit is contained in:
dirtydishes 2025-12-27 19:14:27 -05:00
parent 9ba51d8e96
commit 488ae82ed6
19 changed files with 537 additions and 21 deletions

3
apps/README.md Normal file
View file

@ -0,0 +1,3 @@
# Apps
Next.js app(s) live here. Scaffold pending.

View file

@ -13,6 +13,12 @@
"react-dom": "^18.3.1",
},
},
"packages/bus": {
"name": "@islandflow/bus",
"dependencies": {
"nats": "^2.24.0",
},
},
"packages/config": {
"name": "@islandflow/config",
"dependencies": {
@ -22,6 +28,13 @@
"packages/observability": {
"name": "@islandflow/observability",
},
"packages/storage": {
"name": "@islandflow/storage",
"dependencies": {
"@clickhouse/client": "^0.2.6",
"@islandflow/types": "workspace:*",
},
},
"packages/types": {
"name": "@islandflow/types",
"dependencies": {
@ -45,8 +58,11 @@
"services/compute": {
"name": "@islandflow/compute",
"dependencies": {
"@islandflow/bus": "workspace:*",
"@islandflow/config": "workspace:*",
"@islandflow/observability": "workspace:*",
"@islandflow/types": "workspace:*",
"zod": "^3.23.8",
},
},
"services/eod-enricher": {
@ -66,8 +82,12 @@
"services/ingest-options": {
"name": "@islandflow/ingest-options",
"dependencies": {
"@islandflow/bus": "workspace:*",
"@islandflow/config": "workspace:*",
"@islandflow/observability": "workspace:*",
"@islandflow/storage": "workspace:*",
"@islandflow/types": "workspace:*",
"zod": "^3.23.8",
},
},
"services/refdata": {
@ -79,8 +99,14 @@
},
},
"packages": {
"@clickhouse/client": ["@clickhouse/client@0.2.10", "", { "dependencies": { "@clickhouse/client-common": "0.2.10" } }, "sha512-ZwBgzjEAFN/ogS0ym5KHVbR7Hx/oYCX01qGp2baEyfN2HM73kf/7Vp3GvMHWRy+zUXISONEtFv7UTViOXnmFrg=="],
"@clickhouse/client-common": ["@clickhouse/client-common@0.2.10", "", {}, "sha512-BvTY0IXS96y9RUeNCpKL4HUzHmY80L0lDcGN0lmUD6zjOqYMn78+xyHYJ/AIAX7JQsc+/KwFt2soZutQTKxoGQ=="],
"@islandflow/api": ["@islandflow/api@workspace:services/api"],
"@islandflow/bus": ["@islandflow/bus@workspace:packages/bus"],
"@islandflow/candles": ["@islandflow/candles@workspace:services/candles"],
"@islandflow/compute": ["@islandflow/compute@workspace:services/compute"],
@ -97,6 +123,8 @@
"@islandflow/refdata": ["@islandflow/refdata@workspace:services/refdata"],
"@islandflow/storage": ["@islandflow/storage@workspace:packages/storage"],
"@islandflow/types": ["@islandflow/types@workspace:packages/types"],
"@islandflow/web": ["@islandflow/web@workspace:apps/web"],
@ -139,8 +167,12 @@
"nanoid": ["nanoid@3.3.11", "", { "bin": { "nanoid": "bin/nanoid.cjs" } }, "sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w=="],
"nats": ["nats@2.29.3", "", { "dependencies": { "nkeys.js": "1.1.0" } }, "sha512-tOQCRCwC74DgBTk4pWZ9V45sk4d7peoE2njVprMRCBXrhJ5q5cYM7i6W+Uvw2qUrcfOSnuisrX7bEx3b3Wx4QA=="],
"next": ["next@14.2.35", "", { "dependencies": { "@next/env": "14.2.35", "@swc/helpers": "0.5.5", "busboy": "1.6.0", "caniuse-lite": "^1.0.30001579", "graceful-fs": "^4.2.11", "postcss": "8.4.31", "styled-jsx": "5.1.1" }, "optionalDependencies": { "@next/swc-darwin-arm64": "14.2.33", "@next/swc-darwin-x64": "14.2.33", "@next/swc-linux-arm64-gnu": "14.2.33", "@next/swc-linux-arm64-musl": "14.2.33", "@next/swc-linux-x64-gnu": "14.2.33", "@next/swc-linux-x64-musl": "14.2.33", "@next/swc-win32-arm64-msvc": "14.2.33", "@next/swc-win32-ia32-msvc": "14.2.33", "@next/swc-win32-x64-msvc": "14.2.33" }, "peerDependencies": { "@opentelemetry/api": "^1.1.0", "@playwright/test": "^1.41.2", "react": "^18.2.0", "react-dom": "^18.2.0", "sass": "^1.3.0" }, "optionalPeers": ["@opentelemetry/api", "@playwright/test", "sass"], "bin": { "next": "dist/bin/next" } }, "sha512-KhYd2Hjt/O1/1aZVX3dCwGXM1QmOV4eNM2UTacK5gipDdPN/oHHK/4oVGy7X8GMfPMsUTUEmGlsy0EY1YGAkig=="],
"nkeys.js": ["nkeys.js@1.1.0", "", { "dependencies": { "tweetnacl": "1.0.3" } }, "sha512-tB/a0shZL5UZWSwsoeyqfTszONTt4k2YS0tuQioMOD180+MbombYVgzDUYHlx+gejYK6rgf08n/2Df99WY0Sxg=="],
"picocolors": ["picocolors@1.1.1", "", {}, "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA=="],
"postcss": ["postcss@8.4.31", "", { "dependencies": { "nanoid": "^3.3.6", "picocolors": "^1.0.0", "source-map-js": "^1.0.2" } }, "sha512-PS08Iboia9mts/2ygV3eLpY5ghnUcfLV/EXTOW1E2qYxJKGGBUtNjN76FYHnMs36RmARn41bC0AZmn+rR0OVpQ=="],
@ -159,6 +191,8 @@
"tslib": ["tslib@2.8.1", "", {}, "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w=="],
"tweetnacl": ["tweetnacl@1.0.3", "", {}, "sha512-6rt+RN7aOi1nGMyC4Xa5DdYiukl2UWCbcJft7YhxReBGQD7OAM8Pbxw6YMo4r2diNEA8FEmu32YOn9rhaiE5yw=="],
"zod": ["zod@3.25.76", "", {}, "sha512-gzUt/qt81nXsFGKIFcC3YnfEAx5NkunCfnDlvuBSSFS02bcXu4Lmea0AFIUwbLWxWPx3d9p8S5QoaujKcNQxcQ=="],
}
}

View file

@ -3,7 +3,6 @@ services:
image: clickhouse/clickhouse-server:23.8
ports:
- "8123:8123"
- "9000:9000"
volumes:
- clickhouse-data:/var/lib/clickhouse
ulimits:
@ -13,7 +12,7 @@ services:
redis:
image: redis:7.2
ports:
- "6379:6379"
- "6380:6379"
volumes:
- redis-data:/data
nats:

11
packages/bus/package.json Normal file
View file

@ -0,0 +1,11 @@
{
"name": "@islandflow/bus",
"private": true,
"type": "module",
"exports": {
".": "./src/index.ts"
},
"dependencies": {
"nats": "^2.24.0"
}
}

View file

@ -0,0 +1,2 @@
export * from "./jetstream";
export * from "./subjects";

View file

@ -0,0 +1,125 @@
import {
connect,
consumerOpts,
type ConsumerOptsBuilder,
type JetStreamClient,
type JetStreamManager,
type NatsConnection,
type StreamConfig,
JSONCodec,
type JsMsg,
createInbox
} from "nats";
export type NatsConnectionOptions = {
servers: string | string[];
name?: string;
timeoutMs?: number;
};
export type JetStreamConnection = {
nc: NatsConnection;
js: JetStreamClient;
jsm: JetStreamManager;
};
export type RetryOptions = {
attempts: number;
delayMs: number;
};
const sleep = (delayMs: number): Promise<void> => {
return new Promise((resolve) => setTimeout(resolve, delayMs));
};
export const connectJetStream = async (
options: NatsConnectionOptions
): Promise<JetStreamConnection> => {
const nc = await connect({
servers: options.servers,
name: options.name,
timeout: options.timeoutMs
});
const js = nc.jetstream();
const jsm = await nc.jetstreamManager();
return { nc, js, jsm };
};
export const connectJetStreamWithRetry = async (
options: NatsConnectionOptions,
retry: RetryOptions
): Promise<JetStreamConnection> => {
let lastError: unknown;
for (let attempt = 1; attempt <= retry.attempts; attempt += 1) {
try {
return await connectJetStream(options);
} catch (error) {
lastError = error;
if (attempt < retry.attempts) {
await sleep(retry.delayMs);
}
}
}
throw lastError ?? new Error("Failed to connect to NATS");
};
export const ensureStream = async (
jsm: JetStreamManager,
config: StreamConfig
): Promise<void> => {
try {
await jsm.streams.info(config.name);
return;
} catch (error) {
if (error instanceof Error && error.message.includes("not found")) {
await jsm.streams.add(config);
return;
}
throw error;
}
};
export const buildDurableConsumer = (
durableName: string,
deliverSubject: string = createInbox()
): ConsumerOptsBuilder => {
const opts = consumerOpts();
opts.durable(durableName);
opts.manualAck();
opts.ackExplicit();
opts.deliverTo(deliverSubject);
return opts;
};
export const publishJson = async <T>(
js: JetStreamClient,
subject: string,
payload: T
): Promise<void> => {
const codec = JSONCodec<T>();
await js.publish(subject, codec.encode(payload));
};
export type JsonSubscription<T> = {
messages: AsyncIterable<JsMsg>;
decode: (msg: JsMsg) => T;
};
export const subscribeJson = async <T>(
js: JetStreamClient,
subject: string,
opts: ConsumerOptsBuilder
): Promise<JsonSubscription<T>> => {
const codec = JSONCodec<T>();
const sub = await js.subscribe(subject, opts);
return {
messages: sub,
decode: (msg) => codec.decode(msg.data)
};
};

View file

@ -0,0 +1,2 @@
export const STREAM_OPTION_PRINTS = "OPTIONS_PRINTS";
export const SUBJECT_OPTION_PRINTS = "options.prints";

View file

@ -0,0 +1,7 @@
{
"extends": "../../tsconfig.base.json",
"compilerOptions": {
"types": []
},
"include": ["src/**/*.ts"]
}

View file

@ -0,0 +1,12 @@
{
"name": "@islandflow/storage",
"private": true,
"type": "module",
"exports": {
".": "./src/index.ts"
},
"dependencies": {
"@clickhouse/client": "^0.2.6",
"@islandflow/types": "workspace:*"
}
}

View file

@ -0,0 +1,39 @@
import { createClient, type ClickHouseClient } from "@clickhouse/client";
import type { OptionPrint } from "@islandflow/types";
import { normalizeOptionPrint, optionPrintsTableDDL, OPTION_PRINTS_TABLE } from "./option-prints";
export type ClickHouseOptions = {
url: string;
database?: string;
username?: string;
password?: string;
};
export const createClickHouseClient = (options: ClickHouseOptions): ClickHouseClient => {
return createClient({
url: options.url,
database: options.database,
username: options.username,
password: options.password
});
};
export const ensureOptionPrintsTable = async (
client: ClickHouseClient
): Promise<void> => {
await client.exec({
query: optionPrintsTableDDL()
});
};
export const insertOptionPrint = async (
client: ClickHouseClient,
print: OptionPrint
): Promise<void> => {
const record = normalizeOptionPrint(print);
await client.insert({
table: OPTION_PRINTS_TABLE,
values: [record],
format: "JSONEachRow"
});
};

View file

@ -0,0 +1,2 @@
export * from "./clickhouse";
export * from "./option-prints";

View file

@ -0,0 +1,29 @@
import type { OptionPrint } from "@islandflow/types";
export const OPTION_PRINTS_TABLE = "option_prints";
export const optionPrintsTableDDL = (): string => {
return `
CREATE TABLE IF NOT EXISTS ${OPTION_PRINTS_TABLE} (
source_ts UInt64,
ingest_ts UInt64,
seq UInt64,
trace_id String,
ts UInt64,
option_contract_id String,
price Float64,
size UInt32,
exchange String,
conditions Array(String)
)
ENGINE = MergeTree
ORDER BY (ts, option_contract_id)
`;
};
export const normalizeOptionPrint = (print: OptionPrint): OptionPrint => {
return {
...print,
conditions: print.conditions ?? []
};
};

View file

@ -0,0 +1,27 @@
import { describe, expect, it } from "bun:test";
import { normalizeOptionPrint, optionPrintsTableDDL, OPTION_PRINTS_TABLE } from "../src/option-prints";
const basePrint = {
source_ts: 100,
ingest_ts: 200,
seq: 1,
trace_id: "trace-1",
ts: 100,
option_contract_id: "SPY-2025-01-17-450-C",
price: 1.25,
size: 10,
exchange: "TEST"
};
describe("option-prints storage helpers", () => {
it("normalizes missing conditions to empty array", () => {
const normalized = normalizeOptionPrint(basePrint);
expect(normalized.conditions).toEqual([]);
});
it("includes the correct table name in the DDL", () => {
const ddl = optionPrintsTableDDL();
expect(ddl).toContain(OPTION_PRINTS_TABLE);
expect(ddl).toContain("CREATE TABLE IF NOT EXISTS");
});
});

View file

@ -0,0 +1,7 @@
{
"extends": "../../tsconfig.base.json",
"compilerOptions": {
"types": []
},
"include": ["src/**/*.ts", "tests/**/*.ts"]
}

3
services/README.md Normal file
View file

@ -0,0 +1,3 @@
# Services
Ingest, compute, API, and other runtime services live here. Scaffold pending.

View file

@ -6,7 +6,10 @@
"dev": "bun run src/index.ts"
},
"dependencies": {
"@islandflow/bus": "workspace:*",
"@islandflow/config": "workspace:*",
"@islandflow/observability": "workspace:*"
"@islandflow/observability": "workspace:*",
"@islandflow/types": "workspace:*",
"zod": "^3.23.8"
}
}

View file

@ -1,17 +1,78 @@
import { readEnv } from "@islandflow/config";
import { createLogger } from "@islandflow/observability";
import {
SUBJECT_OPTION_PRINTS,
STREAM_OPTION_PRINTS,
buildDurableConsumer,
connectJetStreamWithRetry,
ensureStream,
subscribeJson
} from "@islandflow/bus";
import { OptionPrintSchema } from "@islandflow/types";
import { z } from "zod";
const service = "compute";
const logger = createLogger({ service });
logger.info("service starting");
const envSchema = z.object({
NATS_URL: z.string().default("nats://localhost:4222")
});
const shutdown = (signal: string) => {
logger.info("service stopping", { signal });
process.exit(0);
const env = readEnv(envSchema);
const run = async () => {
logger.info("service starting");
const { nc, js, jsm } = await connectJetStreamWithRetry(
{
servers: env.NATS_URL,
name: service
},
{ attempts: 20, delayMs: 500 }
);
await ensureStream(jsm, {
name: STREAM_OPTION_PRINTS,
subjects: [SUBJECT_OPTION_PRINTS],
retention: "limits",
storage: "file",
discard: "old",
max_msgs_per_subject: -1,
max_msgs: -1,
max_bytes: -1,
max_age: 0,
num_replicas: 1
});
const opts = buildDurableConsumer("compute-option-prints");
const subscription = await subscribeJson(js, SUBJECT_OPTION_PRINTS, opts);
const shutdown = async (signal: string) => {
logger.info("service stopping", { signal });
await nc.drain();
process.exit(0);
};
process.on("SIGINT", () => void shutdown("SIGINT"));
process.on("SIGTERM", () => void shutdown("SIGTERM"));
for await (const msg of subscription.messages) {
try {
const print = OptionPrintSchema.parse(subscription.decode(msg));
logger.info("received option print", {
trace_id: print.trace_id,
seq: print.seq,
option_contract_id: print.option_contract_id
});
msg.ack();
} catch (error) {
logger.error("failed to process option print", {
error: error instanceof Error ? error.message : String(error)
});
msg.term();
}
}
};
process.on("SIGINT", () => shutdown("SIGINT"));
process.on("SIGTERM", () => shutdown("SIGTERM"));
// Keep the process alive until real listeners are wired.
setInterval(() => {}, 60_000);
await run();

View file

@ -6,7 +6,11 @@
"dev": "bun run src/index.ts"
},
"dependencies": {
"@islandflow/bus": "workspace:*",
"@islandflow/config": "workspace:*",
"@islandflow/observability": "workspace:*"
"@islandflow/observability": "workspace:*",
"@islandflow/storage": "workspace:*",
"@islandflow/types": "workspace:*",
"zod": "^3.23.8"
}
}

View file

@ -1,17 +1,163 @@
import { readEnv } from "@islandflow/config";
import { createLogger } from "@islandflow/observability";
import {
SUBJECT_OPTION_PRINTS,
STREAM_OPTION_PRINTS,
connectJetStreamWithRetry,
ensureStream,
publishJson
} from "@islandflow/bus";
import {
createClickHouseClient,
ensureOptionPrintsTable,
insertOptionPrint
} from "@islandflow/storage";
import { OptionPrintSchema, type OptionPrint } from "@islandflow/types";
import { z } from "zod";
const service = "ingest-options";
const logger = createLogger({ service });
logger.info("service starting");
const envSchema = z.object({
NATS_URL: z.string().default("nats://localhost:4222"),
CLICKHOUSE_URL: z.string().default("http://localhost:8123"),
CLICKHOUSE_DATABASE: z.string().default("default"),
EMIT_INTERVAL_MS: z.coerce.number().int().positive().default(1000)
});
const shutdown = (signal: string) => {
logger.info("service stopping", { signal });
process.exit(0);
const env = readEnv(envSchema);
const state = {
shuttingDown: false,
seq: 0,
timer: null as ReturnType<typeof setInterval> | null
};
process.on("SIGINT", () => shutdown("SIGINT"));
process.on("SIGTERM", () => shutdown("SIGTERM"));
const retry = async <T>(
label: string,
attempts: number,
delayMs: number,
task: () => Promise<T>
): Promise<T> => {
let lastError: unknown;
// Keep the process alive until real listeners are wired.
setInterval(() => {}, 60_000);
for (let attempt = 1; attempt <= attempts; attempt += 1) {
try {
return await task();
} catch (error) {
lastError = error;
logger.warn(`${label} attempt failed`, {
attempt,
error: error instanceof Error ? error.message : String(error)
});
if (attempt < attempts) {
await new Promise((resolve) => setTimeout(resolve, delayMs));
}
}
}
throw lastError ?? new Error(`${label} failed after retries`);
};
const buildSyntheticPrint = (): OptionPrint => {
const now = Date.now();
state.seq += 1;
return {
source_ts: now,
ingest_ts: now,
seq: state.seq,
trace_id: `ingest-options-${state.seq}`,
ts: now,
option_contract_id: "SPY-2025-01-17-450-C",
price: 1.25,
size: 10,
exchange: "TEST",
conditions: ["TEST"]
};
};
const run = async () => {
logger.info("service starting");
const { nc, js, jsm } = await connectJetStreamWithRetry(
{
servers: env.NATS_URL,
name: service
},
{ attempts: 20, delayMs: 500 }
);
await ensureStream(jsm, {
name: STREAM_OPTION_PRINTS,
subjects: [SUBJECT_OPTION_PRINTS],
retention: "limits",
storage: "file",
discard: "old",
max_msgs_per_subject: -1,
max_msgs: -1,
max_bytes: -1,
max_age: 0,
num_replicas: 1
});
const clickhouse = createClickHouseClient({
url: env.CLICKHOUSE_URL,
database: env.CLICKHOUSE_DATABASE
});
await retry("clickhouse table init", 20, 500, async () => {
await ensureOptionPrintsTable(clickhouse);
});
const emit = async () => {
if (state.shuttingDown) {
return;
}
const candidate = buildSyntheticPrint();
const print = OptionPrintSchema.parse(candidate);
try {
await insertOptionPrint(clickhouse, print);
await publishJson(js, SUBJECT_OPTION_PRINTS, print);
logger.info("published option print", {
trace_id: print.trace_id,
seq: print.seq,
option_contract_id: print.option_contract_id
});
} catch (error) {
logger.error("failed to publish option print", {
error: error instanceof Error ? error.message : String(error),
trace_id: print.trace_id
});
}
};
state.timer = setInterval(() => {
void emit();
}, env.EMIT_INTERVAL_MS);
const shutdown = async (signal: string) => {
if (state.shuttingDown) {
return;
}
state.shuttingDown = true;
if (state.timer) {
clearInterval(state.timer);
}
logger.info("service stopping", { signal });
await nc.drain();
await clickhouse.close();
process.exit(0);
};
process.on("SIGINT", () => void shutdown("SIGINT"));
process.on("SIGTERM", () => void shutdown("SIGTERM"));
};
await run();