mirror of
https://github.com/AutoMaker-Org/automaker.git
synced 2026-02-03 08:53:36 +00:00
feat: enhance development environment with Docker support and UI improvements
- Introduced a new `docker-compose.dev.yml` for development mode, enabling live reload and improved container management. - Updated `dev.mjs` to utilize `launchDockerDevContainers` for starting development containers with live reload capabilities. - Refactored `printModeMenu` to differentiate between development and production Docker options. - Enhanced the `BoardView` and `KanbanBoard` components by streamlining props and improving UI interactions. - Removed the `start.mjs` script, consolidating production launch logic into `dev.mjs` for a more unified approach.
This commit is contained in:
webdevcody
@@ -1,5 +1,5 @@
|
||||
/**
|
||||
* Shared utilities for Automaker launcher scripts (dev.mjs and start.mjs)
|
||||
* Shared utilities for Automaker launcher scripts (dev.mjs)
|
||||
*
|
||||
* This module contains cross-platform utilities for:
|
||||
* - Process management (ports, killing processes)
|
||||
@@ -489,14 +489,20 @@ export function printHeader(title) {
|
||||
|
||||
/**
|
||||
* Print the application mode menu
|
||||
* @param {object} options - Menu options
|
||||
* @param {boolean} options.isDev - Whether this is dev mode (changes Docker option description)
|
||||
*/
|
||||
export function printModeMenu() {
|
||||
export function printModeMenu({ isDev = false } = {}) {
|
||||
console.log('═══════════════════════════════════════════════════════');
|
||||
console.log(' Select Application Mode:');
|
||||
console.log('═══════════════════════════════════════════════════════');
|
||||
console.log(' 1) Web Application (Browser)');
|
||||
console.log(' 2) Desktop Application (Electron)');
|
||||
console.log(' 3) Docker Container (Isolated)');
|
||||
if (isDev) {
|
||||
console.log(' 3) Docker Container (Dev with Live Reload)');
|
||||
} else {
|
||||
console.log(' 3) Docker Container (Isolated)');
|
||||
}
|
||||
console.log('═══════════════════════════════════════════════════════');
|
||||
console.log('');
|
||||
}
|
||||
@@ -678,19 +684,58 @@ export function sanitizeProjectName(name) {
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if Docker images need to be rebuilt based on Dockerfile or package.json changes
|
||||
* @param {string} baseDir - Base directory containing Dockerfile and package.json
|
||||
* @returns {boolean} - Whether images need to be rebuilt
|
||||
* Get the current git commit SHA
|
||||
* @param {string} baseDir - Base directory of the git repository
|
||||
* @returns {string|null} - Current commit SHA or null if not available
|
||||
*/
|
||||
export function getCurrentCommitSha(baseDir) {
|
||||
try {
|
||||
const sha = execSync('git rev-parse HEAD', {
|
||||
encoding: 'utf-8',
|
||||
cwd: baseDir,
|
||||
stdio: ['pipe', 'pipe', 'pipe'],
|
||||
}).trim();
|
||||
return sha || null;
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the commit SHA from a Docker image label
|
||||
* @param {string} imageName - Docker image name
|
||||
* @returns {string|null} - Commit SHA from image label or null if not found
|
||||
*/
|
||||
export function getImageCommitSha(imageName) {
|
||||
try {
|
||||
const labelValue = execSync(
|
||||
`docker image inspect ${imageName} --format "{{index .Config.Labels \\"automaker.git.commit.sha\\"}}" 2>/dev/null`,
|
||||
{ encoding: 'utf-8' }
|
||||
).trim();
|
||||
return labelValue && labelValue !== 'unknown' && labelValue !== '' ? labelValue : null;
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if Docker images need to be rebuilt based on git commit SHA
|
||||
* Compares the current git commit with the commit SHA stored in the image labels
|
||||
* @param {string} baseDir - Base directory containing Dockerfile and docker-compose.yml
|
||||
* @returns {{needsRebuild: boolean, reason: string, currentSha: string|null, imageSha: string|null}}
|
||||
*/
|
||||
export function shouldRebuildDockerImages(baseDir) {
|
||||
try {
|
||||
const dockerfilePath = path.join(baseDir, 'Dockerfile');
|
||||
const packageJsonPath = path.join(baseDir, 'package.json');
|
||||
|
||||
// Get modification times of source files
|
||||
const dockerfileMtime = statSync(dockerfilePath).mtimeMs;
|
||||
const packageJsonMtime = statSync(packageJsonPath).mtimeMs;
|
||||
const latestSourceMtime = Math.max(dockerfileMtime, packageJsonMtime);
|
||||
// Get current git commit SHA
|
||||
const currentSha = getCurrentCommitSha(baseDir);
|
||||
if (!currentSha) {
|
||||
return {
|
||||
needsRebuild: true,
|
||||
reason: 'Could not determine current git commit',
|
||||
currentSha: null,
|
||||
imageSha: null,
|
||||
};
|
||||
}
|
||||
|
||||
// Get project name from docker-compose config, falling back to directory name
|
||||
let projectName;
|
||||
@@ -701,76 +746,94 @@ export function shouldRebuildDockerImages(baseDir) {
|
||||
});
|
||||
const config = JSON.parse(composeConfig);
|
||||
projectName = config.name;
|
||||
} catch (error) {
|
||||
} catch {
|
||||
// Fallback handled below
|
||||
}
|
||||
|
||||
// Sanitize project name (whether from config or fallback)
|
||||
// This prevents command injection and ensures valid Docker image names
|
||||
// Sanitize project name
|
||||
const sanitizedProjectName = sanitizeProjectName(projectName || path.basename(baseDir));
|
||||
const serverImageName = `${sanitizedProjectName}_server`;
|
||||
const uiImageName = `${sanitizedProjectName}_ui`;
|
||||
const serverImageName = `${sanitizedProjectName}-server`;
|
||||
const uiImageName = `${sanitizedProjectName}-ui`;
|
||||
|
||||
// Check if images exist and get their creation times
|
||||
let needsRebuild = false;
|
||||
// Check if images exist
|
||||
const serverExists = checkImageExists(serverImageName);
|
||||
const uiExists = checkImageExists(uiImageName);
|
||||
|
||||
try {
|
||||
// Check server image
|
||||
const serverImageInfo = execSync(
|
||||
`docker image inspect ${serverImageName} --format "{{.Created}}" 2>/dev/null || echo ""`,
|
||||
{ encoding: 'utf-8', cwd: baseDir }
|
||||
).trim();
|
||||
|
||||
// Check UI image
|
||||
const uiImageInfo = execSync(
|
||||
`docker image inspect ${uiImageName} --format "{{.Created}}" 2>/dev/null || echo ""`,
|
||||
{ encoding: 'utf-8', cwd: baseDir }
|
||||
).trim();
|
||||
|
||||
// If either image doesn't exist, we need to rebuild
|
||||
if (!serverImageInfo || !uiImageInfo) {
|
||||
return true;
|
||||
}
|
||||
|
||||
// Parse image creation times (ISO 8601 format)
|
||||
const serverCreated = new Date(serverImageInfo).getTime();
|
||||
const uiCreated = new Date(uiImageInfo).getTime();
|
||||
const oldestImageTime = Math.min(serverCreated, uiCreated);
|
||||
|
||||
// If source files are newer than images, rebuild
|
||||
needsRebuild = latestSourceMtime > oldestImageTime;
|
||||
} catch (error) {
|
||||
// If images don't exist or inspect fails, rebuild
|
||||
needsRebuild = true;
|
||||
if (!serverExists || !uiExists) {
|
||||
return {
|
||||
needsRebuild: true,
|
||||
reason: 'Docker images do not exist',
|
||||
currentSha,
|
||||
imageSha: null,
|
||||
};
|
||||
}
|
||||
|
||||
return needsRebuild;
|
||||
// Get commit SHA from server image (both should have the same)
|
||||
const imageSha = getImageCommitSha(serverImageName);
|
||||
|
||||
if (!imageSha) {
|
||||
return {
|
||||
needsRebuild: true,
|
||||
reason: 'Docker images have no commit SHA label (legacy build)',
|
||||
currentSha,
|
||||
imageSha: null,
|
||||
};
|
||||
}
|
||||
|
||||
// Compare commit SHAs
|
||||
if (currentSha !== imageSha) {
|
||||
return {
|
||||
needsRebuild: true,
|
||||
reason: `Code changed: ${imageSha.substring(0, 8)} -> ${currentSha.substring(0, 8)}`,
|
||||
currentSha,
|
||||
imageSha,
|
||||
};
|
||||
}
|
||||
|
||||
return {
|
||||
needsRebuild: false,
|
||||
reason: 'Images are up to date',
|
||||
currentSha,
|
||||
imageSha,
|
||||
};
|
||||
} catch (error) {
|
||||
// If we can't check, err on the side of rebuilding
|
||||
log('Could not check Docker image status, will rebuild to be safe', 'yellow');
|
||||
return true;
|
||||
return {
|
||||
needsRebuild: true,
|
||||
reason: 'Could not check Docker image status',
|
||||
currentSha: null,
|
||||
imageSha: null,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Launch Docker containers with docker-compose
|
||||
* Check if a Docker image exists
|
||||
* @param {string} imageName - Docker image name
|
||||
* @returns {boolean} - Whether the image exists
|
||||
*/
|
||||
function checkImageExists(imageName) {
|
||||
try {
|
||||
execSync(`docker image inspect ${imageName} 2>/dev/null`, {
|
||||
encoding: 'utf-8',
|
||||
stdio: ['pipe', 'pipe', 'pipe'],
|
||||
});
|
||||
return true;
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Launch Docker containers for development with live reload
|
||||
* Uses docker-compose.dev.yml which volume mounts the source code
|
||||
* Also includes docker-compose.override.yml if it exists (for workspace mounts)
|
||||
* @param {object} options - Configuration options
|
||||
* @param {string} options.baseDir - Base directory containing docker-compose.yml
|
||||
* @param {string} options.baseDir - Base directory containing docker-compose.dev.yml
|
||||
* @param {object} options.processes - Processes object to track docker process
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
export async function launchDockerContainers({ baseDir, processes }) {
|
||||
log('Launching Docker Container (Isolated Mode)...', 'blue');
|
||||
|
||||
// Check if Dockerfile or package.json changed and rebuild if needed
|
||||
const needsRebuild = shouldRebuildDockerImages(baseDir);
|
||||
const buildFlag = needsRebuild ? ['--build'] : [];
|
||||
|
||||
if (needsRebuild) {
|
||||
log('Dockerfile or package.json changed - rebuilding images...', 'yellow');
|
||||
} else {
|
||||
log('Starting Docker containers...', 'yellow');
|
||||
}
|
||||
export async function launchDockerDevContainers({ baseDir, processes }) {
|
||||
log('Launching Docker Container (Development Mode with Live Reload)...', 'blue');
|
||||
console.log('');
|
||||
|
||||
// Check if ANTHROPIC_API_KEY is set
|
||||
@@ -781,9 +844,26 @@ export async function launchDockerContainers({ baseDir, processes }) {
|
||||
console.log('');
|
||||
}
|
||||
|
||||
// Start containers with docker-compose
|
||||
// Will rebuild if Dockerfile or package.json changed
|
||||
processes.docker = crossSpawn('docker', ['compose', 'up', ...buildFlag], {
|
||||
log('Starting development container...', 'yellow');
|
||||
log('Source code is volume mounted for live reload', 'yellow');
|
||||
log('Running npm install inside container (this may take a moment on first run)...', 'yellow');
|
||||
console.log('');
|
||||
|
||||
// Build compose file arguments
|
||||
// Start with dev compose file, then add override if it exists
|
||||
const composeArgs = ['compose', '-f', 'docker-compose.dev.yml'];
|
||||
|
||||
// Check if docker-compose.override.yml exists and include it for workspace mounts
|
||||
const overridePath = path.join(baseDir, 'docker-compose.override.yml');
|
||||
if (fsNative.existsSync(overridePath)) {
|
||||
composeArgs.push('-f', 'docker-compose.override.yml');
|
||||
log('Using docker-compose.override.yml for workspace mount', 'yellow');
|
||||
}
|
||||
|
||||
composeArgs.push('up', '--build');
|
||||
|
||||
// Use docker-compose.dev.yml for development
|
||||
processes.docker = crossSpawn('docker', composeArgs, {
|
||||
stdio: 'inherit',
|
||||
cwd: baseDir,
|
||||
env: {
|
||||
@@ -791,6 +871,96 @@ export async function launchDockerContainers({ baseDir, processes }) {
|
||||
},
|
||||
});
|
||||
|
||||
log('Development container starting...', 'blue');
|
||||
log('UI will be available at: http://localhost:3007 (with HMR)', 'green');
|
||||
log('API will be available at: http://localhost:3008', 'green');
|
||||
console.log('');
|
||||
log('Changes to source files will automatically reload.', 'yellow');
|
||||
log('Press Ctrl+C to stop the container.', 'yellow');
|
||||
|
||||
await new Promise((resolve) => {
|
||||
processes.docker.on('close', resolve);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Launch Docker containers with docker-compose (production mode)
|
||||
* Uses git commit SHA to determine if rebuild is needed
|
||||
* @param {object} options - Configuration options
|
||||
* @param {string} options.baseDir - Base directory containing docker-compose.yml
|
||||
* @param {object} options.processes - Processes object to track docker process
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
export async function launchDockerContainers({ baseDir, processes }) {
|
||||
log('Launching Docker Container (Isolated Mode)...', 'blue');
|
||||
|
||||
// Check if ANTHROPIC_API_KEY is set
|
||||
if (!process.env.ANTHROPIC_API_KEY) {
|
||||
log('Warning: ANTHROPIC_API_KEY environment variable is not set.', 'yellow');
|
||||
log('The server will require an API key to function.', 'yellow');
|
||||
log('Set it with: export ANTHROPIC_API_KEY=your-key', 'yellow');
|
||||
console.log('');
|
||||
}
|
||||
|
||||
// Check if rebuild is needed based on git commit SHA
|
||||
const rebuildCheck = shouldRebuildDockerImages(baseDir);
|
||||
|
||||
if (rebuildCheck.needsRebuild) {
|
||||
log(`Rebuild needed: ${rebuildCheck.reason}`, 'yellow');
|
||||
|
||||
if (rebuildCheck.currentSha) {
|
||||
log(`Building images for commit: ${rebuildCheck.currentSha.substring(0, 8)}`, 'blue');
|
||||
}
|
||||
console.log('');
|
||||
|
||||
// Build with commit SHA label
|
||||
const buildArgs = ['compose', 'build'];
|
||||
if (rebuildCheck.currentSha) {
|
||||
buildArgs.push('--build-arg', `GIT_COMMIT_SHA=${rebuildCheck.currentSha}`);
|
||||
}
|
||||
|
||||
const buildProcess = crossSpawn('docker', buildArgs, {
|
||||
stdio: 'inherit',
|
||||
cwd: baseDir,
|
||||
});
|
||||
|
||||
await new Promise((resolve, reject) => {
|
||||
buildProcess.on('close', (code) => {
|
||||
if (code !== 0) {
|
||||
log('Build failed. Exiting.', 'red');
|
||||
reject(new Error(`Docker build failed with code ${code}`));
|
||||
} else {
|
||||
log('Build complete. Starting containers...', 'green');
|
||||
console.log('');
|
||||
resolve();
|
||||
}
|
||||
});
|
||||
buildProcess.on('error', (err) => reject(err));
|
||||
});
|
||||
|
||||
// Start containers (already built above)
|
||||
processes.docker = crossSpawn('docker', ['compose', 'up'], {
|
||||
stdio: 'inherit',
|
||||
cwd: baseDir,
|
||||
env: {
|
||||
...process.env,
|
||||
},
|
||||
});
|
||||
} else {
|
||||
log(`Images are up to date (commit: ${rebuildCheck.currentSha?.substring(0, 8) || 'unknown'})`, 'green');
|
||||
log('Starting Docker containers...', 'yellow');
|
||||
console.log('');
|
||||
|
||||
// Start containers without rebuilding
|
||||
processes.docker = crossSpawn('docker', ['compose', 'up'], {
|
||||
stdio: 'inherit',
|
||||
cwd: baseDir,
|
||||
env: {
|
||||
...process.env,
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
log('Docker containers starting...', 'blue');
|
||||
log('UI will be available at: http://localhost:3007', 'green');
|
||||
log('API will be available at: http://localhost:3008', 'green');
|
||||
|
||||
Reference in New Issue
Block a user