risedev/task/
configure_tmux_service.rs

1// Copyright 2025 RisingWave Labs
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use std::env;
16use std::path::Path;
17use std::process::Command;
18
19use anyhow::{Context, Result};
20use console::style;
21
22use crate::util::{risedev_cmd, stylized_risedev_subcmd};
23use crate::{ExecuteContext, Task};
24
25pub struct ConfigureTmuxTask {
26    env: Vec<String>,
27}
28
29pub const RISEDEV_NAME: &str = "risedev";
30
31pub fn new_tmux_command() -> Command {
32    let mut cmd = Command::new("tmux");
33    cmd.arg("-L").arg(RISEDEV_NAME); // `-L` specifies a dedicated tmux server
34    cmd
35}
36
37impl ConfigureTmuxTask {
38    pub fn new(env: Vec<String>) -> Result<Self> {
39        Ok(Self { env })
40    }
41}
42
43impl Task for ConfigureTmuxTask {
44    fn execute(&mut self, ctx: &mut ExecuteContext<impl std::io::Write>) -> anyhow::Result<()> {
45        ctx.service(self);
46
47        ctx.pb.set_message("starting...");
48
49        let prefix_path = env::var("PREFIX")?;
50        let prefix_bin = env::var("PREFIX_BIN")?;
51
52        let mut cmd = new_tmux_command();
53        cmd.arg("-V");
54        ctx.run_command(cmd).with_context(|| {
55            format!(
56                "Failed to execute {} command. Did you install tmux?",
57                style("tmux").blue().bold()
58            )
59        })?;
60
61        let mut cmd = new_tmux_command();
62        cmd.arg("list-sessions");
63        if ctx.run_command(cmd).is_ok() {
64            ctx.pb.set_message("killing previous session...");
65
66            let mut cmd = Command::new(risedev_cmd());
67            cmd.arg("k");
68            ctx.run_command(cmd).with_context(|| {
69                format!(
70                    "A previous cluster is already running while `risedev-dev` failed to kill it. \
71                     Please kill it manually with {}.",
72                    stylized_risedev_subcmd("k")
73                )
74            })?;
75        }
76
77        ctx.pb.set_message("creating new session...");
78
79        let mut cmd = new_tmux_command();
80        cmd.arg("new-session") // this will automatically create the `risedev` tmux server
81            .arg("-d")
82            .arg("-s")
83            .arg(RISEDEV_NAME);
84        for e in &self.env {
85            cmd.arg("-e").arg(e);
86        }
87        cmd.arg("-c")
88            .arg(Path::new(&prefix_path))
89            .arg(Path::new(&prefix_bin).join("welcome.sh"));
90
91        ctx.run_command(cmd)?;
92
93        ctx.complete_spin();
94
95        ctx.pb.set_message(format!("session {}", RISEDEV_NAME));
96
97        Ok(())
98    }
99
100    fn id(&self) -> String {
101        "tmux".into()
102    }
103}
risedev/task/configure_tmux_service.rs

risedev/task/
configure_tmux_service.rs
