@better-openclaw/core 1.0.26 → 1.0.31

package/src/generators/postgres-init.test.ts

@@ -0,0 +1,116 @@
+import { describe, expect, it } from "vitest";
+import type { ResolverOutput } from "../types.js";
+import { generatePostgresInit, getDbRequirements } from "./postgres-init.js";
+
+function makeResolved(serviceIds: string[]): ResolverOutput {
+	return {
+		services: serviceIds.map((id) => ({
+			definition: {
+				id,
+				name: id.charAt(0).toUpperCase() + id.slice(1),
+				description: "",
+				icon: "",
+				category: "test",
+				image: `${id}:latest`,
+				ports: [],
+				volumes: [],
+				environment: [],
+				dependencies: [],
+				conflicts: [],
+				skills: [],
+				memoryMB: 256,
+				docsUrl: "",
+			},
+			addedBy: "user" as const,
+		})),
+		addedDependencies: [],
+		estimatedMemoryMB: 512,
+	} as unknown as ResolverOutput;
+}
+
+describe("getDbRequirements", () => {
+	it("returns empty array when no services need a DB", () => {
+		const resolved = makeResolved(["redis", "minio"]);
+		expect(getDbRequirements(resolved)).toEqual([]);
+	});
+
+	it("returns requirements for n8n", () => {
+		const resolved = makeResolved(["n8n", "redis"]);
+		const reqs = getDbRequirements(resolved);
+		expect(reqs).toHaveLength(1);
+		expect(reqs[0]).toEqual({
+			serviceId: "n8n",
+			serviceName: "N8n",
+			dbName: "n8n",
+			dbUser: "n8n",
+			passwordEnvVar: "N8N_DB_PASSWORD",
+		});
+	});
+
+	it("returns requirements for multiple services", () => {
+		const resolved = makeResolved(["n8n", "outline", "postiz", "redis"]);
+		const reqs = getDbRequirements(resolved);
+		expect(reqs).toHaveLength(3);
+		const ids = reqs.map((r) => r.serviceId);
+		expect(ids).toContain("n8n");
+		expect(ids).toContain("outline");
+		expect(ids).toContain("postiz");
+	});
+});
+
+describe("generatePostgresInit", () => {
+	it("returns null when PostgreSQL is not in the stack", () => {
+		const resolved = makeResolved(["n8n", "redis"]);
+		expect(generatePostgresInit(resolved)).toBeNull();
+	});
+
+	it("returns null when PostgreSQL is present but no services need DBs", () => {
+		const resolved = makeResolved(["postgresql", "redis", "minio"]);
+		expect(generatePostgresInit(resolved)).toBeNull();
+	});
+
+	it("generates init script when PostgreSQL and DB-needing services are present", () => {
+		const resolved = makeResolved(["postgresql", "n8n"]);
+		const script = generatePostgresInit(resolved);
+		expect(script).not.toBeNull();
+		expect(script).toContain("#!/bin/bash");
+		expect(script).toContain("create_db_and_user");
+		expect(script).toContain('"n8n"');
+		expect(script).toContain("N8N_DB_PASSWORD");
+	});
+
+	it("includes all services that need DBs", () => {
+		const resolved = makeResolved(["postgresql", "n8n", "outline", "dify"]);
+		const script = generatePostgresInit(resolved)!;
+		expect(script).toContain('"n8n"');
+		expect(script).toContain('"outline"');
+		expect(script).toContain('"dify"');
+	});
+
+	it("uses environment variable substitution for passwords (not literals)", () => {
+		const resolved = makeResolved(["postgresql", "n8n"]);
+		const script = generatePostgresInit(resolved)!;
+		// Passwords should be referenced as env vars, not hardcoded
+		expect(script).toContain("${N8N_DB_PASSWORD:-$POSTGRES_PASSWORD}");
+	});
+
+	it("script uses psql with ON_ERROR_STOP", () => {
+		const resolved = makeResolved(["postgresql", "n8n"]);
+		const script = generatePostgresInit(resolved)!;
+		expect(script).toContain("ON_ERROR_STOP=1");
+	});
+
+	it("script creates user with IF NOT EXISTS check", () => {
+		const resolved = makeResolved(["postgresql", "n8n"]);
+		const script = generatePostgresInit(resolved)!;
+		expect(script).toContain("IF NOT EXISTS");
+		expect(script).toContain("CREATE ROLE");
+	});
+
+	it("includes service names in summary line", () => {
+		const resolved = makeResolved(["postgresql", "n8n", "outline"]);
+		const script = generatePostgresInit(resolved)!;
+		expect(script).toContain("N8n");
+		expect(script).toContain("Outline");
+	});
+});

package/src/generators/postgres-init.ts

@@ -52,7 +52,16 @@ const DB_REQUIREMENTS: Record<string, Omit<DbRequirement, "serviceId" | "service
 	openpanel: { dbName: "openpanel", dbUser: "openpanel", passwordEnvVar: "OPENPANEL_DB_PASSWORD" },
 	usesend: { dbName: "usesend", dbUser: "usesend", passwordEnvVar: "USESEND_DB_PASSWORD" },
 	nextcloud: { dbName: "nextcloud", dbUser: "nextcloud", passwordEnvVar: "NEXTCLOUD_DB_PASSWORD" },
+	// ── CRM ────────────────────────────────────────────────────────────────
+	twenty: { dbName: "twenty", dbUser: "twenty", passwordEnvVar: "TWENTY_DB_PASSWORD" },
+	relaticle: {
+		dbName: "relaticle",
+		dbUser: "relaticle",
+		passwordEnvVar: "RELATICLE_DB_PASSWORD",
+	},
 	// ── Agent Memory ────────────────────────────────────────────────────────
+	mem0: { dbName: "mem0", dbUser: "mem0", passwordEnvVar: "MEM0_DB_PASSWORD" },
+	memu: { dbName: "memu", dbUser: "memu", passwordEnvVar: "MEMU_DB_PASSWORD" },
 	hindsight: { dbName: "hindsight", dbUser: "hindsight", passwordEnvVar: "HINDSIGHT_DB_PASSWORD" },
 	// ── SaaS Boilerplates ────────────────────────────────────────────────────
 	"open-saas": { dbName: "opensaas", dbUser: "opensaas", passwordEnvVar: "OPENSAAS_DB_PASSWORD" },

package/src/generators/prometheus.test.ts

@@ -0,0 +1,108 @@
+import { describe, expect, it } from "vitest";
+import { parse } from "yaml";
+import { generate } from "../generate.js";
+import type { ResolverOutput } from "../types.js";
+import { generatePrometheusConfig } from "./prometheus.js";
+
+function makeResolved(serviceIds: string[]): ResolverOutput {
+	return {
+		services: serviceIds.map((id) => ({
+			definition: {
+				id,
+				name: id.charAt(0).toUpperCase() + id.slice(1),
+				description: "",
+				icon: "📦",
+				category: "test",
+				image: `${id}:latest`,
+				ports: [],
+				volumes: [],
+				environment: [],
+				dependencies: [],
+				conflicts: [],
+				skills: [],
+				memoryMB: 256,
+				docsUrl: "",
+			},
+			addedBy: "user" as const,
+		})),
+		addedDependencies: [],
+		estimatedMemoryMB: 512,
+	} as unknown as ResolverOutput;
+}
+
+describe("generatePrometheusConfig", () => {
+	it("always includes prometheus self-monitoring", () => {
+		const config = generatePrometheusConfig(makeResolved(["redis"]));
+		expect(config).toContain('job_name: "prometheus"');
+		expect(config).toContain("localhost:9090");
+	});
+
+	it("includes scrape config for redis", () => {
+		const config = generatePrometheusConfig(makeResolved(["redis"]));
+		expect(config).toContain('job_name: "redis"');
+		expect(config).toContain("redis:9121");
+	});
+
+	it("includes scrape config for postgresql", () => {
+		const config = generatePrometheusConfig(makeResolved(["postgresql"]));
+		expect(config).toContain('job_name: "postgresql"');
+		expect(config).toContain("postgresql:9187");
+	});
+
+	it("includes scrape configs for multiple services", () => {
+		const config = generatePrometheusConfig(makeResolved(["redis", "n8n", "minio"]));
+		expect(config).toContain('job_name: "redis"');
+		expect(config).toContain('job_name: "n8n"');
+		expect(config).toContain('job_name: "minio"');
+	});
+
+	it("skips services without known metrics endpoints", () => {
+		const config = generatePrometheusConfig(makeResolved(["ffmpeg"]));
+		expect(config).not.toContain('job_name: "ffmpeg"');
+	});
+
+	it("does not duplicate prometheus job", () => {
+		const config = generatePrometheusConfig(makeResolved(["prometheus", "redis"]));
+		const matches = config.match(/job_name: "prometheus"/g);
+		expect(matches).toHaveLength(1);
+	});
+
+	it("always includes openclaw gateway metrics", () => {
+		const config = generatePrometheusConfig(makeResolved(["redis"]));
+		expect(config).toContain('job_name: "openclaw-gateway"');
+		expect(config).toContain("openclaw:18789");
+	});
+
+	it("is valid YAML", () => {
+		const config = generatePrometheusConfig(makeResolved(["redis", "postgresql"]));
+		const parsed = parse(config);
+		expect(parsed).toBeDefined();
+		expect(parsed.global).toBeDefined();
+		expect(parsed.scrape_configs).toBeInstanceOf(Array);
+	});
+
+	it("sets correct metrics paths per service", () => {
+		const config = generatePrometheusConfig(makeResolved(["minio"]));
+		expect(config).toContain("/minio/v2/metrics/cluster");
+	});
+});
+
+describe("prometheus via generate()", () => {
+	it("generates prometheus config when monitoring is enabled", () => {
+		const result = generate({
+			projectName: "prom-test",
+			services: ["redis"],
+			skillPacks: [],
+			proxy: "none",
+			gpu: false,
+			platform: "linux/amd64",
+			deployment: "local",
+			generateSecrets: true,
+			openclawVersion: "latest",
+			monitoring: true,
+		});
+		expect(result.files).toHaveProperty("prometheus/prometheus.yml");
+		const promConfig = parse(result.files["prometheus/prometheus.yml"]!);
+		expect(promConfig.scrape_configs.length).toBeGreaterThan(0);
+	});
+});

package/src/generators/readme.ts

@@ -1,3 +1,4 @@
+import { getFrameworkById } from "../frameworks/index.js";
 import type { ResolverOutput } from "../types.js";
 
 /**
@@ -13,6 +14,8 @@ export interface ReadmeOptions {
 	hasNativeServices?: boolean;
 	/** How OpenClaw itself is installed: docker (container) or direct (host). */
 	openclawInstallMethod?: "docker" | "direct";
+	/** Primary agent framework (defaults to "openclaw"). */
+	primaryFramework?: string;
 }
 
 /**
@@ -22,19 +25,29 @@ export interface ReadmeOptions {
  * service URLs, skill packs, and scripts documentation.
  */
 export function generateReadme(resolved: ResolverOutput, options: ReadmeOptions): string {
-	const { projectName, domain, proxy, deploymentType, hasNativeServices, openclawInstallMethod } =
-		options;
+	const {
+		projectName,
+		domain,
+		proxy,
+		deploymentType,
+		hasNativeServices,
+		openclawInstallMethod,
+		primaryFramework,
+	} = options;
 	const isDirectInstall = openclawInstallMethod === "direct";
+	const framework = getFrameworkById(primaryFramework ?? "openclaw");
+	const frameworkName = framework?.name ?? "OpenClaw";
+	const isOpenClaw = (primaryFramework ?? "openclaw") === "openclaw";
 	const sections: string[] = [];
 
 	// ── Title & Description ─────────────────────────────────────────────────
 
 	sections.push(`# ${projectName}
 
-> Self-hosted AI agent infrastructure powered by [OpenClaw](https://openclaw.dev).
+> Self-hosted AI agent infrastructure powered by **${frameworkName}**${isOpenClaw ? " — [openclaw.dev](https://openclaw.dev)" : ""}.
 
-This project provides a fully configured Docker Compose stack with ${resolved.services.length} services, ready to deploy on any server.${isDirectInstall ? " OpenClaw itself runs directly on the host (not in Docker)." : ""}
-${deploymentType === "bare-metal" && hasNativeServices ? "\n\n**Bare-metal (native + Docker):** Some services run natively on the host; the rest (including the OpenClaw gateway) run in Docker. Use the top-level `install.sh` or `install.ps1` to install/start native services first, then start the Docker stack." : ""}
+This project provides a fully configured Docker Compose stack with ${resolved.services.length} services, ready to deploy on any server.${isDirectInstall ? ` ${frameworkName} itself runs directly on the host (not in Docker).` : ""}
+${deploymentType === "bare-metal" && hasNativeServices ? `\n\n**Bare-metal (native + Docker):** Some services run natively on the host; the rest (including the ${frameworkName} gateway) run in Docker. Use the top-level \`install.sh\` or \`install.ps1\` to install/start native services first, then start the Docker stack.` : ""}
 
 ---`);
 
@@ -131,7 +144,7 @@ docker compose ps
 ### 5. View Logs
 
 \`\`\`bash
-docker compose logs -f openclaw-gateway
+docker compose logs -f ${primaryFramework ?? "openclaw"}-gateway
 \`\`\`
 `
 }
@@ -218,10 +231,63 @@ Skills are located in \`openclaw/workspace/skills/\`. Each skill provides a \`SK
 `);
 	}
 
+	// ── AI Memory Integration ──────────────────────────────────────────────
+
+	const memoryServiceIds = ["mem0", "memu", "hindsight"];
+	const vectorDbIds = ["qdrant", "chromadb", "weaviate", "milvus"];
+
+	const memoryServices = resolved.services.filter(({ definition }) =>
+		memoryServiceIds.includes(definition.id),
+	);
+	const vectorDbs = resolved.services.filter(({ definition }) =>
+		vectorDbIds.includes(definition.id),
+	);
+
+	if (memoryServices.length > 0 || vectorDbs.length > 0) {
+		let memSection = `## AI Memory Integration
+
+This stack includes integrated AI memory services. The ${frameworkName} agent framework is automatically configured to use them via \`openclaw/config/openclaw.json\`.
+`;
+
+		if (memoryServices.length > 0) {
+			const memList = memoryServices
+				.map(
+					({ definition }) =>
+						`- ${definition.icon} **${definition.name}** — ${definition.description.split(".")[0]}`,
+				)
+				.join("\n");
+			memSection += `
+### Memory Services
+
+${memList}
+`;
+		}
+
+		if (vectorDbs.length > 0) {
+			const vecList = vectorDbs
+				.map(
+					({ definition }) =>
+						`- ${definition.icon} **${definition.name}** — ${definition.description.split(".")[0]}`,
+				)
+				.join("\n");
+			memSection += `
+### Vector Databases
+
+${vecList}
+`;
+		}
+
+		memSection += `
+Skills for interacting with these services are in \`openclaw/workspace/skills/\`.
+`;
+
+		sections.push(memSection);
+	}
+
 	// ── Onboarding & Channels ──────────────────────────────────────────────
-	// Based on openclaw_docker-setup.sh post-deploy instructions
+	// Only show OpenClaw-specific onboarding instructions for OpenClaw stacks
 
-	if (isDirectInstall) {
+	if (isOpenClaw && isDirectInstall) {
 		sections.push(`## OpenClaw Setup
 
 OpenClaw is installed directly on the host (not in Docker). After running the install script:\n
@@ -253,7 +319,7 @@ openclaw channels add --channel discord --token <BOT_TOKEN>
 
 See [Channel Docs](https://docs.openclaw.ai/channels) for more providers.
 `);
-	} else {
+	} else if (isOpenClaw) {
 		sections.push(`## Onboarding & Channel Setup
 
 After starting the stack, complete the gateway onboarding:

package/src/generators/scripts.test.ts

@@ -20,7 +20,7 @@ describe("generateScripts", () => {
 
 		for (const script of expectedScripts) {
 			expect(result).toHaveProperty(script);
-			expect(result[script]!.length).toBeGreaterThan(0);
+			expect(result[script]?.length).toBeGreaterThan(0);
 		}
 	});