@terraforge/core 0.0.18 → 0.0.20

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import { S3Client } from "@aws-sdk/client-s3";
 import { DynamoDB } from "@aws-sdk/client-dynamodb";
+import { S3Client } from "@aws-sdk/client-s3";
 import { UUID } from "node:crypto";
 import { AwsCredentialIdentity, AwsCredentialIdentityProvider } from "@aws-sdk/types";
 
@@ -162,6 +162,11 @@ type ResourceStatusInfo = {
   tag: 'resource' | 'data';
   status: ResourceStatus;
 };
+type StackStatusInfo = {
+  name: string;
+  urn: URN;
+  resources: ResourceStatusInfo[];
+};
 //#endregion
 //#region src/backend/lock.d.ts
 type LockBackend = {
@@ -176,6 +181,7 @@ type AppState = {
   version?: number;
   idempotentToken?: UUID;
   stacks: Record<URN, StackState>;
+  pendingDeletes?: Record<URN, NodeState>;
 };
 type StackState = {
   name: string;
@@ -202,6 +208,20 @@ type StateBackend = {
   delete(urn: URN): Promise<void>;
 };
 //#endregion
+//#region src/backend/activity-log.d.ts
+type LogProps = {
+  action: 'deploy' | 'delete';
+  filters?: string[];
+};
+type Log = LogProps & {
+  user?: string;
+  date?: number;
+};
+type ActivityLogBackend = {
+  log(urn: URN, log: LogProps): Promise<void>;
+  tail(urn: URN): Promise<Log[]>;
+};
+//#endregion
 //#region src/provider.d.ts
 type CreateProps<T = State> = {
   type: string;
@@ -313,6 +333,7 @@ type WorkSpaceOptions = {
   backend: {
     state: StateBackend;
     lock: LockBackend;
+    activityLog?: ActivityLogBackend;
   };
   hooks?: Hooks;
 };
@@ -338,7 +359,7 @@ declare class WorkSpace {
   /**
    * Get the status of all resources in the app by comparing current config with state file.
    */
-  status(app: App): Promise<ResourceStatusInfo[]>;
+  status(app: App): Promise<StackStatusInfo[]>;
   protected destroyProviders(): Promise<void>;
 }
 //#endregion
@@ -361,6 +382,19 @@ declare class AppError extends Error {
 declare class ResourceNotFound extends Error {}
 declare class ResourceAlreadyExists extends Error {}
 //#endregion
+//#region src/backend/memory/activity-log.d.ts
+type Props$4 = {
+  user?: string;
+};
+declare class MemoryActivityLogBackend implements ActivityLogBackend {
+  private props;
+  protected groups: Map<`urn:${string}`, Log[]>;
+  constructor(props?: Props$4);
+  log(urn: URN, log: LogProps): Promise<void>;
+  private getLogGroup;
+  tail(urn: URN, limit?: number): Promise<Log[]>;
+}
+//#endregion
 //#region src/backend/memory/state.d.ts
 declare class MemoryStateBackend implements StateBackend {
   protected states: Map<`urn:${string}`, AppState>;
@@ -379,6 +413,20 @@ declare class MemoryLockBackend implements LockBackend {
   clear(): void;
 }
 //#endregion
+//#region src/backend/file/activity-log.d.ts
+type Props$3 = {
+  user?: string;
+  dir: string;
+};
+declare class FileActivityLogBackend implements ActivityLogBackend {
+  private props;
+  constructor(props: Props$3);
+  private logFile;
+  private mkdir;
+  log(urn: URN, log: LogProps): Promise<void>;
+  tail(urn: URN, limit?: number): Promise<Log[]>;
+}
+//#endregion
 //#region src/backend/file/state.d.ts
 declare class FileStateBackend implements StateBackend {
   private props;
@@ -405,23 +453,23 @@ declare class FileLockBackend implements LockBackend {
   lock(urn: URN): Promise<() => Promise<void>>;
 }
 //#endregion
-//#region src/backend/aws/s3-state.d.ts
-type Props$1 = {
+//#region src/backend/aws/dynamodb-activity-log.d.ts
+type Props$2 = {
   credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider;
   region: string;
-  bucket: string;
+  tableName: string;
+  user?: string;
 };
-declare class S3StateBackend implements StateBackend {
+declare class DynamoDBActivityLogBackend implements ActivityLogBackend {
   private props;
-  protected client: S3Client;
-  constructor(props: Props$1);
-  get(urn: URN): Promise<any>;
-  update(urn: URN, state: AppState): Promise<void>;
-  delete(urn: URN): Promise<void>;
+  protected client: DynamoDB;
+  constructor(props: Props$2);
+  log(urn: URN, log: LogProps): Promise<void>;
+  tail(urn: URN, limit?: number): Promise<Log[]>;
 }
 //#endregion
 //#region src/backend/aws/dynamodb-lock.d.ts
-type Props = {
+type Props$1 = {
   credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider;
   region: string;
   tableName: string;
@@ -429,12 +477,27 @@ type Props = {
 declare class DynamoLockBackend implements LockBackend {
   private props;
   protected client: DynamoDB;
-  constructor(props: Props);
+  constructor(props: Props$1);
   insecureReleaseLock(urn: URN): Promise<void>;
   locked(urn: URN): Promise<boolean>;
   lock(urn: URN): Promise<() => Promise<void>>;
 }
 //#endregion
+//#region src/backend/aws/s3-state.d.ts
+type Props = {
+  credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider;
+  region: string;
+  bucket: string;
+};
+declare class S3StateBackend implements StateBackend {
+  private props;
+  protected client: S3Client;
+  constructor(props: Props);
+  get(urn: URN): Promise<any>;
+  update(urn: URN, state: AppState): Promise<void>;
+  delete(urn: URN): Promise<void>;
+}
+//#endregion
 //#region src/helpers.d.ts
 declare const file: (path: string, encoding?: BufferEncoding) => Future<string>;
 declare const hash: (path: string, algo?: string) => Future<string>;
@@ -465,4 +528,4 @@ type CustomResourceProvider = Partial<{
 }>;
 declare const createCustomProvider: (providerId: string, resourceProviders: Record<string, CustomResourceProvider>) => Provider;
 //#endregion
-export { App, AppError, type Config, type CreateProps, type CustomResourceProvider, type DataSource, type DataSourceFunction, type DataSourceMeta, type DeleteProps, DynamoLockBackend, FileLockBackend, FileStateBackend, Future, type GetDataProps, type GetProps, Group, type Input, LockBackend, MemoryLockBackend, MemoryStateBackend, type Meta, type Node, type OptionalInput, type OptionalOutput, Output, type PlanProps, type ProcedureOptions, type Provider, type Resource, ResourceAlreadyExists, type ResourceClass, type ResourceConfig, ResourceError, type ResourceMeta, ResourceNotFound, type ResourceStatus, type ResourceStatusInfo, S3StateBackend, Stack, type State, StateBackend, type Tag, type URN, type UpdateProps, WorkSpace, type WorkSpaceOptions, createCustomProvider, createCustomResourceClass, createDebugger, createMeta, deferredOutput, enableDebug, findInputDeps, getMeta, isDataSource, isNode, isResource, nodeMetaSymbol, output, resolveInputs };
+export { ActivityLogBackend, App, AppError, type Config, type CreateProps, type CustomResourceProvider, type DataSource, type DataSourceFunction, type DataSourceMeta, type DeleteProps, DynamoDBActivityLogBackend, DynamoLockBackend, FileActivityLogBackend, FileLockBackend, FileStateBackend, Future, type GetDataProps, type GetProps, Group, type Input, LockBackend, Log, LogProps, MemoryActivityLogBackend, MemoryLockBackend, MemoryStateBackend, type Meta, type Node, type OptionalInput, type OptionalOutput, Output, type PlanProps, type ProcedureOptions, type Provider, type Resource, ResourceAlreadyExists, type ResourceClass, type ResourceConfig, ResourceError, type ResourceMeta, ResourceNotFound, type ResourceStatus, type ResourceStatusInfo, S3StateBackend, Stack, type StackStatusInfo, type State, StateBackend, type Tag, type URN, type UpdateProps, WorkSpace, type WorkSpaceOptions, createCustomProvider, createCustomResourceClass, createDebugger, createMeta, deferredOutput, enableDebug, findInputDeps, getMeta, isDataSource, isNode, isResource, nodeMetaSymbol, output, resolveInputs };

package/dist/index.mjs

@@ -4,12 +4,12 @@ import { DirectedGraph } from "graphology";
 import { topologicalGenerations, willCreateCycle } from "graphology-dag";
 import { v5 } from "uuid";
 import { get } from "get-wild";
-import { mkdir, readFile, rm, stat, writeFile } from "node:fs/promises";
+import { appendFile, mkdir, readFile, rm, stat, writeFile } from "node:fs/promises";
 import { join } from "node:path";
 import { lock } from "proper-lockfile";
-import { DeleteObjectCommand, GetObjectCommand, PutObjectCommand, S3Client, S3ServiceException } from "@aws-sdk/client-s3";
 import { DynamoDB } from "@aws-sdk/client-dynamodb";
 import { marshall, unmarshall } from "@aws-sdk/util-dynamodb";
+import { DeleteObjectCommand, GetObjectCommand, PutObjectCommand, S3Client, S3ServiceException } from "@aws-sdk/client-s3";
 import { createHash } from "node:crypto";
 
 //#region src/node.ts
@@ -605,6 +605,10 @@ const deleteResource = async (appToken, urn, state, opt) => {
 //#endregion
 //#region src/workspace/procedure/delete-app.ts
 const deleteApp = async (app, opt) => {
+	await opt.backend.activityLog?.log(app.urn, {
+		action: "delete",
+		filters: opt.filters
+	});
 	const latestState = await opt.backend.state.get(app.urn);
 	if (!latestState) throw new AppError(app.name, [], `App already deleted: ${app.name}`);
 	const appState = migrateAppState(latestState);
@@ -623,6 +627,16 @@ const deleteApp = async (app, opt) => {
 		delete stackState.nodes[urn];
 	});
 	const errors = await graph.run();
+	if (errors.length === 0 && appState.pendingDeletes) {
+		for (const [urn, nodeState] of entries(appState.pendingDeletes)) try {
+			await deleteResource(appState.idempotentToken, urn, nodeState, opt);
+			delete appState.pendingDeletes[urn];
+		} catch (error) {
+			if (error instanceof Error) errors.push(error);
+			else errors.push(/* @__PURE__ */ new Error(`${error}`));
+		}
+		if (Object.keys(appState.pendingDeletes).length === 0) delete appState.pendingDeletes;
+	}
 	removeEmptyStackStates(appState);
 	delete appState.idempotentToken;
 	await opt.backend.state.update(app.urn, appState);
@@ -813,7 +827,8 @@ const updateResource = async (resource, appToken, priorInputState, priorOutputSt
 	const idempotantToken = createIdempotantToken(appToken, meta.urn, "update");
 	let result;
 	debug$2(meta.type);
-	debug$2(proposedState);
+	debug$2("prior state", priorOutputState);
+	debug$2("proposed state", proposedState);
 	try {
 		await opt.hooks?.beforeResourceUpdate?.({
 			urn: resource.urn,
@@ -852,6 +867,10 @@ const updateResource = async (resource, appToken, priorInputState, priorOutputSt
 const debug$1 = createDebugger("Deploy App");
 const deployApp = async (app, opt) => {
 	debug$1(app.name, "start");
+	await opt.backend.activityLog?.log(app.urn, {
+		action: "deploy",
+		filters: opt.filters
+	});
 	const appState = migrateAppState(await opt.backend.state.get(app.urn) ?? {
 		name: app.name,
 		stacks: {}
@@ -883,7 +902,6 @@ const deployApp = async (app, opt) => {
 	}
 	const queue = createConcurrencyQueue(opt.concurrency ?? 10);
 	const graph = new DependencyGraph();
-	const replacementDeletes = /* @__PURE__ */ new Map();
 	const allNodes = {};
 	for (const stackState of Object.values(appState.stacks)) for (const [urn, nodeState] of entries(stackState.nodes)) allNodes[urn] = nodeState;
 	for (const stack of filteredOutStacks) {
@@ -966,10 +984,33 @@ const deployApp = async (app, opt) => {
 							let newResourceState;
 							const ignoreReplace = forcedUpdateDependents.has(meta$1.urn);
 							if (!ignoreReplace && requiresReplacement(nodeState.input, input, meta$1.config?.replaceOnChanges ?? [])) if (meta$1.config?.createBeforeReplace) {
+								for (const [dependentUrn, dependentNode] of nodeByUrn.entries()) {
+									if (!isResource(dependentNode)) continue;
+									const dependentMeta = getMeta(dependentNode);
+									if (!dependentMeta.dependencies.has(meta$1.urn)) continue;
+									const dependentStackState = stackStates.get(dependentMeta.stack.urn);
+									const dependentState = dependentStackState?.nodes[dependentUrn];
+									if (!dependentStackState || !dependentState) continue;
+									const dependencyPaths = findDependencyPaths(dependentMeta.input, meta$1.urn);
+									if (dependencyPaths.length === 0) continue;
+									const dependentProvider = findProvider(opt.providers, dependentMeta.provider);
+									if (dependentProvider.planResourceChange) {
+										if ((await dependentProvider.planResourceChange({
+											type: dependentMeta.type,
+											priorState: dependentState.output,
+											proposedState: input
+										})).requiresReplacement) {
+											if (!allowsDependentReplace(dependentMeta.config?.replaceOnChanges, dependencyPaths)) throw ResourceError.wrap(dependentMeta.urn, dependentMeta.type, "update", /* @__PURE__ */ new Error(`Replacing ${meta$1.urn} requires ${dependentMeta.urn} to set replaceOnChanges for its dependency fields.`));
+										}
+									}
+								}
 								const priorState = { ...nodeState };
 								newResourceState = await createResource(node, appState.idempotentToken, input, opt);
 								if (newResourceState.output) meta$1.resolve(newResourceState.output);
-								if (!meta$1.config?.retainOnDelete) replacementDeletes.set(meta$1.urn, priorState);
+								if (!meta$1.config?.retainOnDelete) {
+									appState.pendingDeletes ??= {};
+									appState.pendingDeletes[meta$1.urn] = priorState;
+								}
 							} else {
 								for (const [dependentUrn, dependentNode] of nodeByUrn.entries()) {
 									if (!isResource(dependentNode)) continue;
@@ -1028,11 +1069,15 @@ const deployApp = async (app, opt) => {
 		}
 	}
 	const errors = await graph.run();
-	if (errors.length === 0 && replacementDeletes.size > 0) for (const [urn, nodeState] of replacementDeletes.entries()) try {
-		await deleteResource(appState.idempotentToken, urn, nodeState, opt);
-	} catch (error) {
-		if (error instanceof Error) errors.push(error);
-		else errors.push(/* @__PURE__ */ new Error(`${error}`));
+	if (errors.length === 0 && appState.pendingDeletes) {
+		for (const [urn, nodeState] of entries(appState.pendingDeletes)) try {
+			await deleteResource(appState.idempotentToken, urn, nodeState, opt);
+			delete appState.pendingDeletes[urn];
+		} catch (error) {
+			if (error instanceof Error) errors.push(error);
+			else errors.push(/* @__PURE__ */ new Error(`${error}`));
+		}
+		if (Object.keys(appState.pendingDeletes).length === 0) delete appState.pendingDeletes;
 	}
 	removeEmptyStackStates(appState);
 	delete appState.idempotentToken;
@@ -1135,11 +1180,12 @@ const filterStateToMatchConfig = (state, config) => {
 };
 const status = async (app, opt) => {
 	const appState = await opt.backend.state.get(app.urn);
-	const resources = [];
+	const stacks = [];
 	const configuredUrns = /* @__PURE__ */ new Set();
 	for (const stack of app.stacks) for (const node of stack.nodes) configuredUrns.add(getMeta(node).urn);
 	for (const stack of app.stacks) {
 		const stackState = appState?.stacks[stack.urn];
+		const resources = [];
 		for (const node of stack.nodes) {
 			const meta = getMeta(node);
 			const nodeState = stackState?.nodes[meta.urn];
@@ -1172,18 +1218,31 @@ const status = async (app, opt) => {
 				status: "stale"
 			});
 		}
+		stacks.push({
+			name: stack.name,
+			urn: stack.urn,
+			resources
+		});
 	}
 	if (appState) {
 		const configuredStackUrns = new Set(app.stacks.map((s) => s.urn));
-		for (const [stackUrn, stackState] of Object.entries(appState.stacks)) if (!configuredStackUrns.has(stackUrn)) for (const [urn, nodeState] of Object.entries(stackState.nodes)) resources.push({
-			urn,
-			type: nodeState.type,
-			provider: nodeState.provider,
-			tag: nodeState.tag,
-			status: "stale"
-		});
+		for (const [stackUrn, stackState] of Object.entries(appState.stacks)) if (!configuredStackUrns.has(stackUrn)) {
+			const resources = [];
+			for (const [urn, nodeState] of Object.entries(stackState.nodes)) resources.push({
+				urn,
+				type: nodeState.type,
+				provider: nodeState.provider,
+				tag: nodeState.tag,
+				status: "stale"
+			});
+			stacks.push({
+				name: stackState.name,
+				urn: stackUrn,
+				resources
+			});
+		}
 	}
-	return resources;
+	return stacks;
 };
 
 //#endregion
@@ -1253,6 +1312,29 @@ var WorkSpace = class {
 	}
 };
 
+//#endregion
+//#region src/backend/memory/activity-log.ts
+var MemoryActivityLogBackend = class {
+	groups = /* @__PURE__ */ new Map();
+	constructor(props = {}) {
+		this.props = props;
+	}
+	async log(urn, log) {
+		this.getLogGroup(urn).push({
+			user: this.props.user,
+			date: Date.now(),
+			...log
+		});
+	}
+	getLogGroup(urn) {
+		if (!this.groups.has(urn)) this.groups.set(urn, []);
+		return this.groups.get(urn);
+	}
+	async tail(urn, limit = 10) {
+		return this.getLogGroup(urn).slice(-limit);
+	}
+};
+
 //#endregion
 //#region src/backend/memory/state.ts
 var MemoryStateBackend = class {
@@ -1294,6 +1376,34 @@ var MemoryLockBackend = class {
 	}
 };
 
+//#endregion
+//#region src/backend/file/activity-log.ts
+var FileActivityLogBackend = class {
+	constructor(props) {
+		this.props = props;
+	}
+	logFile(urn) {
+		return join(this.props.dir, `${urn}.log.jsonl`);
+	}
+	async mkdir() {
+		await mkdir(this.props.dir, { recursive: true });
+	}
+	async log(urn, log) {
+		const json = JSON.stringify({
+			user: this.props.user,
+			date: Date.now(),
+			...log
+		});
+		await this.mkdir();
+		await appendFile(this.logFile(urn), `${json}\n`);
+	}
+	async tail(urn, limit = 10) {
+		const file$1 = this.logFile(urn);
+		if (!(await stat(file$1)).isFile()) return [];
+		return (await readFile(file$1, "utf8")).split("\n").filter(Boolean).slice(-limit).map((line) => JSON.parse(line));
+	}
+};
+
 //#endregion
 //#region src/backend/file/state.ts
 const debug = createDebugger("State");
@@ -1302,7 +1412,7 @@ var FileStateBackend = class {
 		this.props = props;
 	}
 	stateFile(urn) {
-		return join(this.props.dir, `${urn}.json`);
+		return join(this.props.dir, `${urn}.state.json`);
 	}
 	async mkdir() {
 		await mkdir(this.props.dir, { recursive: true });
@@ -1354,40 +1464,35 @@ var FileLockBackend = class {
 };
 
 //#endregion
-//#region src/backend/aws/s3-state.ts
-var S3StateBackend = class {
+//#region src/backend/aws/dynamodb-activity-log.ts
+var DynamoDBActivityLogBackend = class {
 	client;
 	constructor(props) {
 		this.props = props;
-		this.client = new S3Client(props);
-	}
-	async get(urn) {
-		let result;
-		try {
-			result = await this.client.send(new GetObjectCommand({
-				Bucket: this.props.bucket,
-				Key: `${urn}.state`
-			}));
-		} catch (error) {
-			if (error instanceof S3ServiceException && error.name === "NoSuchKey") return;
-			throw error;
-		}
-		if (!result.Body) return;
-		const body = await result.Body.transformToString("utf8");
-		return JSON.parse(body);
+		this.client = new DynamoDB(props);
 	}
-	async update(urn, state) {
-		await this.client.send(new PutObjectCommand({
-			Bucket: this.props.bucket,
-			Key: `${urn}.state`,
-			Body: JSON.stringify(state)
-		}));
+	async log(urn, log) {
+		await this.client.putItem({
+			TableName: this.props.tableName,
+			Item: marshall({
+				urn,
+				user: this.props.user,
+				date: Date.now(),
+				...log
+			})
+		});
 	}
-	async delete(urn) {
-		await this.client.send(new DeleteObjectCommand({
-			Bucket: this.props.bucket,
-			Key: `${urn}.state`
-		}));
+	async tail(urn, limit = 10) {
+		return (await this.client.query({
+			TableName: this.props.tableName,
+			KeyConditionExpression: "#urn = :urn",
+			ExpressionAttributeNames: { "#urn": "urn" },
+			ExpressionAttributeValues: { ":urn": marshall(urn) },
+			ScanIndexForward: false,
+			Limit: limit
+		})).Items?.map((item) => {
+			return unmarshall(item);
+		}) ?? [];
 	}
 };
 
@@ -1438,6 +1543,44 @@ var DynamoLockBackend = class {
 	}
 };
 
+//#endregion
+//#region src/backend/aws/s3-state.ts
+var S3StateBackend = class {
+	client;
+	constructor(props) {
+		this.props = props;
+		this.client = new S3Client(props);
+	}
+	async get(urn) {
+		let result;
+		try {
+			result = await this.client.send(new GetObjectCommand({
+				Bucket: this.props.bucket,
+				Key: `${urn}.state`
+			}));
+		} catch (error) {
+			if (error instanceof S3ServiceException && error.name === "NoSuchKey") return;
+			throw error;
+		}
+		if (!result.Body) return;
+		const body = await result.Body.transformToString("utf8");
+		return JSON.parse(body);
+	}
+	async update(urn, state) {
+		await this.client.send(new PutObjectCommand({
+			Bucket: this.props.bucket,
+			Key: `${urn}.state`,
+			Body: JSON.stringify(state)
+		}));
+	}
+	async delete(urn) {
+		await this.client.send(new DeleteObjectCommand({
+			Bucket: this.props.bucket,
+			Key: `${urn}.state`
+		}));
+	}
+};
+
 //#endregion
 //#region src/helpers.ts
 const file = (path, encoding = "utf8") => {
@@ -1548,4 +1691,4 @@ const createCustomProvider = (providerId, resourceProviders) => {
 };
 
 //#endregion
-export { App, AppError, DynamoLockBackend, FileLockBackend, FileStateBackend, Future, Group, MemoryLockBackend, MemoryStateBackend, Output, ResourceAlreadyExists, ResourceError, ResourceNotFound, S3StateBackend, Stack, WorkSpace, createCustomProvider, createCustomResourceClass, createDebugger, createMeta, deferredOutput, enableDebug, findInputDeps, getMeta, isDataSource, isNode, isResource, nodeMetaSymbol, output, resolveInputs };
+export { App, AppError, DynamoDBActivityLogBackend, DynamoLockBackend, FileActivityLogBackend, FileLockBackend, FileStateBackend, Future, Group, MemoryActivityLogBackend, MemoryLockBackend, MemoryStateBackend, Output, ResourceAlreadyExists, ResourceError, ResourceNotFound, S3StateBackend, Stack, WorkSpace, createCustomProvider, createCustomResourceClass, createDebugger, createMeta, deferredOutput, enableDebug, findInputDeps, getMeta, isDataSource, isNode, isResource, nodeMetaSymbol, output, resolveInputs };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@terraforge/core",
-	"version": "0.0.18",
+	"version": "0.0.20",
 	"type": "module",
 	"repository": {
 		"type": "git",