Implement "runme beta session" #683

adambabik · 2024-10-13T12:49:34Z

It implements a new command that allows starting a session and collecting all exported environment variables throughout its lifetime.

Testing

As a prerequisite, add the following to your shell's startup script (.bashrc or .zshrc):

# runme
source <(runme beta session setup)

Then, you can start a new session in the terminal:

runme beta session

The session is a regular shell of your choice, inferred from $SHELL. You can use it like a normal shell, but any exported environment variables will be returned upon exiting the session via exit.

Currently, the collected variables are printed out, but in the future, they will be routed to a proper store.

adambabik · 2024-10-14T20:23:36Z

7351fbf can be cherry-picked to main safely. After one of the GitHub Actions update, the CI workflow does not work.

sourishkrout

Overall, this is the right direction. Essentially keeping it simple. See comments, please.

internal/cmd/beta/session_cmd.go

sourishkrout · 2024-10-16T20:56:06Z

I'm getting this locally on macOS with zsh:

# runme
source <(runme beta session setup)
/dev/fd/14:3: parse error near `\n'

Same happens when I source it inside of .zshrc.

adambabik · 2024-10-16T21:55:44Z

I'm getting this locally on macOS with zsh:
# runme
source <(runme beta session setup)
/dev/fd/14:3: parse error near `\n'
Same happens when I source it inside of .zshrc.

@sourishkrout can you paste the output of executing runme beta session setup, please?

sourishkrout · 2024-10-16T21:59:28Z

@sourishkrout can you paste the output of executing runme beta session setup, please?

here you go:

$ runme beta session setup
#!/bin/sh
/Users/sourishkrout/Projects/stateful/oss/runme/runme env dump --insecure > 
__cleanup() {
rv=$?
/Users/sourishkrout/Projects/stateful/oss/runme/runme env dump --insecure > 
exit $rv
}
trap -- "__cleanup" EXIT

oh, I see the problem now... no destinations for the redirects

adambabik · 2024-10-16T22:36:45Z

oh, I see the problem now... no destinations for the redirects

Thanks! Yeah, I will add a check to protect from this... Overall, RUNME_SESSION=1 is required to activate the session setup. Then, two envs from the env collector that define those redirects are used. This is all hidden from the user when using runme beta session, but these edge cases should be handled.

sourishkrout · 2024-10-21T15:35:10Z

It does not work for me. Can you provide step-by-step instructions on how to start with a clean slate? How are you running this locally?

I mainly don't understand how the setup command will work without RUNME_SESSION_PREPATH and RUNME_SESSION_POSTPATH present or how RUNME_SESSION=1 need to be 1?

Isn't this a chicken/egg problem @adambabik?

sourishkrout · 2024-10-21T15:51:28Z

I might misunderstand the purpose of session setup 🤔. That's probably why it's not "working" for me.

adambabik · 2024-10-27T06:26:07Z

@sourishkrout sorry, I missed your comment. It should work exactly as it's described in the PR description. In my case:

I put source <(/Users/myuser/path/to/runme/runme beta session setup) where runme is a binary build in the project root directory on this branch.
Do ./runme beta session and it should display Runme session active. When you're done, execute "exit"..
Export some env like export TEST=1
Type exit. It should print:

Collected env during the session:
TEST=1

All the shenanigans with the RUNME_ envs are handled by beta session setup and beta session.

sourishkrout · 2024-11-03T19:34:06Z

Collected env during the session:
TEST=1

It shows empty for me following the exact instructions 🤔. Not sure why, @adambabik.

sourishkrout · 2024-11-03T19:38:32Z

internal/cmd/beta/session_cmd.go

+					if err := requireEnvs(
+						command.EnvCollectorSessionEnvName,
+						command.EnvCollectorSessionPrePathEnvName,
+						command.EnvCollectorSessionPostPathEnvName,
+					); err != nil {
+						logger.Info("session setup is skipped because the environment variable is not set", zap.Error(err))
+						return writeNoopShellCommand(out)
+					}


One thing I don't get is how these won't ever produce an error? In other words how are they set in the first place if they are expected by setup @adambabik?

The order is that beta session starts a shell process with those envs provided first. This shell process starts and executes, in the case of zsh, the .zshrc file inside which beta session setup is called.

It's perfectly normal that it typically will error and output no-op shell command in .zshrc, but from the user point of view it should be invisible. We can recommend protecting source <(/path/to/runme beta session setup) with a conditional checking command.EnvCollectorSessionEnvName to avoid that.

sourishkrout · 2024-11-03T19:42:26Z

internal/cmd/beta/session_cmd.go

+					sessionSetupEnabled := os.Getenv(command.EnvCollectorSessionEnvName)
+					if val, err := strconv.ParseBool(sessionSetupEnabled); err != nil || !val {
+						logger.Debug("session setup is skipped", zap.Error(err), zap.Bool("value", val))
+						return writeNoopShellCommand(out)
+					}


Also, is RUNME_SESSION expected to be a bool (serialized)? We are using the env var to hold the session ID all over the place so a semantic clash here is bad if bool <> SessionID (both string).

Oh yeah, that's a good point. I didn't notice the clash. I will change it to something like RUNME_TERM_SESSION_ENABLED.

adambabik · 2024-11-03T22:21:59Z

Collected env during the session:
TEST=1

It shows empty for me following the exact instructions 🤔. Not sure why, @adambabik.

In order to debug it, try tail -f /tmp/runme.log in another terminal window and then e.g. source ~/.zshrc or opening a new terminal window. The path is taken from experimental/runme.yaml. I noticed that it's too chatty for some logs but overall should contain an answer.

sonarcloud · 2024-11-09T15:12:26Z

Quality Gate failed

Failed conditions
32.1% Coverage on New Code (required ≥ 50%)

See analysis details on SonarCloud

adambabik force-pushed the adamb/beta-session branch from d76e4ee to d4bfd83 Compare October 13, 2024 12:56

adambabik changed the title ~~Implement "beta session"~~ Implement "runme beta session" Oct 13, 2024

adambabik marked this pull request as ready for review October 14, 2024 20:22

adambabik requested a review from sourishkrout October 14, 2024 20:22

sourishkrout requested changes Oct 16, 2024

View reviewed changes

sourishkrout reviewed Oct 16, 2024

View reviewed changes

internal/cmd/beta/session_cmd.go Outdated Show resolved Hide resolved

adambabik force-pushed the adamb/beta-session branch from d9d4b71 to 7a12f2d Compare October 18, 2024 19:16

adambabik requested a review from sourishkrout October 18, 2024 19:20

adambabik force-pushed the adamb/beta-session branch from 7a12f2d to b571b10 Compare October 27, 2024 08:59

sourishkrout reviewed Nov 3, 2024

View reviewed changes

adambabik added 8 commits November 9, 2024 15:52

beta session: start terminal from CLI with session

70e89ef

Working version

031a759

F

f898779

F

7b31104

Update unit tests for env collectors

59de037

Cleanup

575afc9

Fix TestCommand_SetWinsize

575b31a

Fix after rebase

2f89508

adambabik force-pushed the adamb/beta-session branch from 50b3adb to 2f89508 Compare November 9, 2024 15:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement "runme beta session" #683

Implement "runme beta session" #683

adambabik commented Oct 13, 2024

adambabik commented Oct 14, 2024

sourishkrout left a comment

sourishkrout commented Oct 16, 2024 •

edited

Loading

adambabik commented Oct 16, 2024

sourishkrout commented Oct 16, 2024 •

edited

Loading

adambabik commented Oct 16, 2024

sourishkrout commented Oct 21, 2024

sourishkrout commented Oct 21, 2024

adambabik commented Oct 27, 2024

sourishkrout commented Nov 3, 2024

sourishkrout Nov 3, 2024

adambabik Nov 3, 2024

sourishkrout Nov 3, 2024

adambabik Nov 3, 2024

adambabik commented Nov 3, 2024

sonarcloud bot commented Nov 9, 2024

Implement "runme beta session" #683

Are you sure you want to change the base?

Implement "runme beta session" #683

Conversation

adambabik commented Oct 13, 2024

Testing

adambabik commented Oct 14, 2024

sourishkrout left a comment

Choose a reason for hiding this comment

sourishkrout commented Oct 16, 2024 • edited Loading

adambabik commented Oct 16, 2024

sourishkrout commented Oct 16, 2024 • edited Loading

adambabik commented Oct 16, 2024

sourishkrout commented Oct 21, 2024

sourishkrout commented Oct 21, 2024

adambabik commented Oct 27, 2024

sourishkrout commented Nov 3, 2024

sourishkrout Nov 3, 2024

Choose a reason for hiding this comment

adambabik Nov 3, 2024

Choose a reason for hiding this comment

sourishkrout Nov 3, 2024

Choose a reason for hiding this comment

adambabik Nov 3, 2024

Choose a reason for hiding this comment

adambabik commented Nov 3, 2024

sonarcloud bot commented Nov 9, 2024

Quality Gate failed

sourishkrout commented Oct 16, 2024 •

edited

Loading

sourishkrout commented Oct 16, 2024 •

edited

Loading