Skip to content

feat(cli): changes to run to work better with detached stdin (no shell) #426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tuler merged 1 commit into from
Feb 23, 2026
Merged

feat(cli): changes to run to work better with detached stdin (no shell) #426

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/tame-cobras-kick.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@cartesi/cli": patch
---

changes to run to work better with detached stdin (no shell)
106 changes: 69 additions & 37 deletions apps/cli/src/commands/run.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import { DEFAULT_SDK_VERSION, PREFERRED_PORT } from "../config.js";
import {
AVAILABLE_SERVICES,
deployApplication,
host,
removeApplication,
type RollupsDeployment,
startEnvironment,
Expand All @@ -38,32 +39,17 @@ const commaSeparatedList = (value: string) => value.split(",");

const shell = async (options: {
build?: CommandUnknownOpts;
deployment?: RollupsDeployment;
epochLength: number;
log?: CommandUnknownOpts;
projectName: string;
prt?: boolean;
salt: number;
}) => {
const { build, epochLength, log, projectName, prt } = options;

// keep track of last deployment
let lastDeployment: RollupsDeployment | undefined;
let salt = 0;

// deploy for the first time
const hash = getMachineHash();
if (hash) {
lastDeployment = await deploy({
epochLength,
hash,
projectName,
prt,
salt: numberToHex(salt++, { size: 32 }),
});
} else {
console.warn(
chalk.yellow("machine snapshot not found, waiting for build"),
);
}
let lastDeployment = options.deployment;
let salt = options.salt;

while (true) {
try {
Expand Down Expand Up @@ -313,11 +299,15 @@ export const createRunCommand = () => {
// configure optional anvil fork
const forkConfig = await configureFork(options);

// if TTY is not attached, run on foreground (not detached)
const detach = process.stdin.isTTY;

// run compose environment (detached)
const { address, config } = await startEnvironment({
const { cmd, config } = await startEnvironment({
blockTime,
cpus,
defaultBlock,
detach,
dryRun,
forkConfig,
memory,
Expand All @@ -328,6 +318,9 @@ export const createRunCommand = () => {
verbose,
});

// host address
const address = `${host}:${port}`;

if (dryRun && config) {
// just show the docker compose configuration and quit
process.stdout.write(config);
Expand All @@ -346,6 +339,27 @@ export const createRunCommand = () => {
services,
});

// deploy the application
let deployment: RollupsDeployment | undefined;
let salt = 0;
const prt = !authority;
const hash = getMachineHash();
if (hash) {
deployment = await deploy({
epochLength,
hash,
projectName,
prt,
salt: numberToHex(salt++, { size: 32 }),
});
} else {
console.warn(
chalk.yellow(
"machine snapshot not found, waiting for build",
),
);
}

const shutdown = async () => {
progress.start(`${chalk.cyan(projectName)} stopping...`);
try {
Expand All @@ -359,23 +373,41 @@ export const createRunCommand = () => {
process.exit(0);
};

// inhibit SIGINT and SIGTERM, will be handled gracefully by the shell
process.on("SIGINT", () => {});
process.on("SIGTERM", () => {});
if (detach) {
// inhibit SIGINT and SIGTERM, will be handled gracefully by the shell
process.on("SIGINT", () => {});
process.on("SIGTERM", () => {});

const log = program.parent?.commands.find(
(c) => c.name() === "logs",
);
const build = program.parent?.commands.find(
(c) => c.name() === "build",
);
await shell({
build,
epochLength,
log,
projectName,
prt: !authority,
});
await shutdown();
const log = program.parent?.commands.find(
(c) => c.name() === "logs",
);
const build = program.parent?.commands.find(
(c) => c.name() === "build",
);
await shell({
build,
deployment,
epochLength,
log,
projectName,
prt,
salt,
});
await shutdown();
} else {
process.on("SIGINT", shutdown);
process.on("SIGTERM", shutdown);
try {
await cmd;
} catch (error: unknown) {
if (error instanceof ExecaError) {
// just continue gracefully
if (error.exitCode === 130) {
return;
}
throw error;
}
}
}
});
};
37 changes: 18 additions & 19 deletions apps/cli/src/exec/rollups.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ type Service = {
errorTitle?: string; // title of the service when it is not healthy
};

const host = "http://127.0.0.1";
export const host = "http://127.0.0.1";

// services configuration
const baseServices: Service[] = [
Expand Down Expand Up @@ -242,6 +242,7 @@ export const startEnvironment = async (options: {
blockTime: number;
cpus?: number;
defaultBlock: "latest" | "safe" | "pending" | "finalized";
detach: boolean;
dryRun: boolean;
forkConfig?: ForkConfig;
memory?: number;
Expand All @@ -255,6 +256,7 @@ export const startEnvironment = async (options: {
blockTime,
cpus,
defaultBlock,
detach,
dryRun,
forkConfig,
memory,
Expand All @@ -265,25 +267,26 @@ export const startEnvironment = async (options: {
verbose,
} = options;

const address = `${host}:${port}`;

// setup the environment variable used in docker compose
const env: NodeJS.ProcessEnv = {
CARTESI_BLOCKCHAIN_DEFAULT_BLOCK: defaultBlock,
CARTESI_LISTEN_PORT: port.toString(),
CARTESI_LOG_LEVEL: verbose ? "debug" : "info",
};

// local dev environment, we don't need security
const databasePassword = "password";

const files = [
anvil({
blockTime,
forkConfig,
imageTag: runtimeVersion,
}),
database({ imageTag: runtimeVersion, password: "password" }),
database({ imageTag: runtimeVersion, password: databasePassword }),
node({
cpus,
databasePassword: "password",
databasePassword,
defaultBlock,
forkChainId: forkConfig?.chainId,
imageTag: runtimeVersion,
Expand All @@ -298,7 +301,7 @@ export const startEnvironment = async (options: {
explorer({
imageTag: "1.4.0",
apiTag: "1.1.0",
databasePassword: "password",
databasePassword,
port,
}),
);
Expand All @@ -316,7 +319,7 @@ export const startEnvironment = async (options: {
const composeArgs = ["compose", "-f", "-", "--project-directory", "."];

// run in detached mode (background)
const upArgs = ["--detach"];
const upArgs = detach ? ["--detach"] : [];

// merge files, following Docker Compose merge rules
const composeFile = concat([{ name: projectName }, ...files]);
Expand All @@ -330,25 +333,21 @@ export const startEnvironment = async (options: {
{ env, input: stringify(composeFile, { lineWidth: 0, indent: 2 }) },
);

return { address, config };
return { config };
}

// pull images first
// const pullArgs = ["--policy", "missing"];
// await execa("docker", [...composeArgs, "pull", ...pullArgs], {
// env,
////FIXME: stdio and input won't work together
// stdio: "inherit",
// input: composeFile.build()
// });

Copy link
Contributor

@endersonmaia endersonmaia Feb 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was commented when migrated from YAML to TS, and compose file being passed via stdin.

When executed for the first time, it downloads on the backgound but it doesn' t gives any feedback to the user, looks like it's stuck.

We need a solution for this, but won't blok this PR for that.

// run compose
await execa("docker", [...composeArgs, "up", ...upArgs], {
const cmd = execa("docker", [...composeArgs, "up", ...upArgs], {
env,
input: stringify(composeFile, { lineWidth: 0, indent: 2 }),
});

return { address };
// if detached, wait to finish
if (detach) {
await cmd;
}

return { cmd };
};

/**
Expand Down
Loading