📦 NEW: Handle old format memory config (#134)

* 📦 NEW: Backward compat for old config

* 📦 NEW: Handle old format config

* 👌 IMPROVE: Logs

Author: ahmadbilaldev

packages/baseai/src/deploy/index.ts

@@ -24,6 +24,10 @@ import {
 	updateDeployedCommitHash
 } from '@/utils/memory/git-sync/handle-git-sync-memories';
 import { handleSingleDocDeploy } from './document';
+import {
+	generateUpgradeInstructions,
+	isOldMemoryConfigFormat
+} from '@/utils/memory/handle-old-memory-config';
 
 export interface Account {
 	login: string;
@@ -482,6 +486,14 @@ export async function deployMemory({
 
 		p.log.step(`Processing documents for memory: ${memoryNameWithoutExt}`);
 
+		if (isOldMemoryConfigFormat(memoryObject)) {
+			p.note(generateUpgradeInstructions(memoryObject));
+			p.cancel(
+				'Deployment cancelled. Please update your memory config file to the new format.'
+			);
+			process.exit(1);
+		}
+
 		let filesToDeploy: string[] = [];
 		let filesToDelete: string[] = [];
 		let memoryDocs: MemoryDocumentI[] = [];
@@ -1184,7 +1196,7 @@ export async function deploySingleMemory({
 		});
 
 		p.outro(`Successfully deployed memory: ${memoryName}`);
-		process.exit(1);
+		process.exit(0);
 	} catch (error) {
 		if (error instanceof Error) {
 			if ((error as NodeJS.ErrnoException).code === 'ENOENT') {

packages/baseai/src/utils/memory/handle-old-memory-config.ts

@@ -0,0 +1,107 @@
+/**
+ * Represents the old memory configuration format for backward compatibility.
+ */
+export interface OldMemoryConfig {
+	name: string;
+	description?: string;
+	config?: OldConfigObject;
+}
+
+interface OldConfigObject {
+	useGitRepo: boolean;
+	dirToTrack: string;
+	extToTrack: string[] | ['*'];
+	deployedCommitHash?: string;
+	embeddedCommitHash?: string;
+}
+
+/**
+ * Type guard to check if an object is of type `OldConfigObject`.
+ *
+ * @param obj - The object to check.
+ * @returns `true` if the object is an `OldConfigObject`, otherwise `false`.
+ */
+function isOldConfigObject(obj: unknown): obj is OldConfigObject {
+	return (
+		typeof obj === 'object' &&
+		obj !== null &&
+		'useGitRepo' in obj &&
+		typeof (obj as OldConfigObject).useGitRepo === 'boolean' &&
+		'dirToTrack' in obj &&
+		typeof (obj as OldConfigObject).dirToTrack === 'string' &&
+		'extToTrack' in obj &&
+		Array.isArray((obj as OldConfigObject).extToTrack)
+	);
+}
+
+/**
+ * Checks if an object conforms to the old memory configuration format.
+ *
+ * @param obj - The object to check.
+ * @returns `true` if the object is in the old memory configuration format, otherwise `false`.
+ */
+export function isOldMemoryConfigFormat(obj: unknown): boolean {
+	if (
+		typeof obj !== 'object' ||
+		obj === null ||
+		!('name' in obj) ||
+		!('config' in obj)
+	) {
+		return false;
+	}
+
+	const typedObj = obj as { name: unknown; config: unknown };
+
+	return (
+		typeof typedObj.name === 'string' &&
+		(typedObj.config === undefined || isOldConfigObject(typedObj.config))
+	);
+}
+
+/**
+ * Generates upgrade instructions for converting an old memory configuration to the new format.
+ *
+ * @param oldConfig - The old memory configuration.
+ * @returns A string containing the upgrade instructions.
+ */
+export function generateUpgradeInstructions(
+	oldConfig: OldMemoryConfig
+): string {
+	if (!oldConfig.config) {
+		return 'Invalid memory config.';
+	}
+
+	const newConfigExample = {
+		name: oldConfig.name,
+		description: oldConfig.description || 'Your memory description',
+		git: {
+			enabled: oldConfig.config.useGitRepo,
+			include:
+				oldConfig.config.extToTrack[0] === '*'
+					? [`${oldConfig.config.dirToTrack}/**/*`]
+					: oldConfig.config.extToTrack.map(
+							ext => `${oldConfig.config?.dirToTrack}/**/*${ext}`
+						),
+			gitignore: true,
+			deployedAt: oldConfig.config.deployedCommitHash || '',
+			embeddedAt: oldConfig.config.embeddedCommitHash || ''
+		}
+	};
+
+	return `
+Your memory config is using an outdated format in baseai/memory/${oldConfig.name}/index.ts. Please update the file to this new format:
+
+${JSON.stringify(newConfigExample, null, 2)}
+
+Key changes:
+- Removed nested 'config' object structure
+- Git-related fields are now grouped under a 'git' object
+- 'useGitRepo' is now 'git.enabled'
+- 'dirToTrack' and 'extToTrack' are combined into 'git.include' glob patterns
+- 'deployedCommitHash' is now 'git.deployedAt'
+- 'embeddedCommitHash' is now 'git.embeddedAt'
+- Added new 'git.gitignore' field (defaults to true)
+
+For more information, refer to the documentation: https://baseai.dev/docs/guides/memory-from-git
+`;
+}

packages/baseai/src/utils/memory/load-memory-config.ts

@@ -2,6 +2,11 @@ import fs from 'fs/promises';
 import path from 'path';
 import * as p from '@clack/prompts';
 import { memoryConfigSchema, type MemoryConfigI } from 'types/memory';
+import {
+	generateUpgradeInstructions,
+	isOldMemoryConfigFormat,
+	type OldMemoryConfig
+} from './handle-old-memory-config';
 
 function extractConfigObject(fileContents: string): unknown {
 	try {
@@ -38,22 +43,7 @@ function extractConfigObject(fileContents: string): unknown {
 
 		// Create a new Function that returns the object literal
 		const fn = new Function(`return ${memoryObjStr}`);
-		const memoryObj = fn();
-
-		// Extract memory config properties
-		const configObj: MemoryConfigI = {
-			name: memoryObj.name,
-			description: memoryObj.description,
-			git: {
-				enabled: memoryObj.git.enabled,
-				include: memoryObj.git.include,
-				gitignore: memoryObj.git.gitignore,
-				deployedAt: memoryObj.git.deployedAt || '',
-				embeddedAt: memoryObj.git.embeddedAt || ''
-			}
-		};
-
-		return configObj;
+		return fn();
 	} catch (error) {
 		console.error('Parsing error:', error);
 		console.error('File contents:', fileContents);
@@ -79,7 +69,26 @@ export default async function loadMemoryConfig(
 		const fileContents = await fs.readFile(indexFilePath, 'utf-8');
 		const configObj = extractConfigObject(fileContents);
 
-		return memoryConfigSchema.parse(configObj);
+		// Try to parse with new schema first
+		try {
+			return memoryConfigSchema.parse(configObj);
+		} catch (parseError) {
+			if (!configObj) throw parseError;
+
+			// If parsing fails, check if it's an old format
+			if (isOldMemoryConfigFormat(configObj)) {
+				p.note(
+					generateUpgradeInstructions(configObj as OldMemoryConfig)
+				);
+				p.cancel(
+					'Deployment cancelled. Please update your memory config file to the new format.'
+				);
+				process.exit(1);
+			}
+
+			// If it's neither new nor old format, throw the original error
+			throw parseError;
+		}
 	} catch (error) {
 		if (error instanceof Error) {
 			p.cancel(`Failed to load memory '${memoryName}': ${error.message}`);