Skip to content
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.

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

Provide explanation before session start #2367

Closed
aviramha opened this issue Apr 11, 2024 · 6 comments · Fixed by #2447
Closed

Provide explanation before session start #2367

aviramha opened this issue Apr 11, 2024 · 6 comments · Fixed by #2447
Assignees

Comments

@aviramha
Copy link
Member

When user starts a session, provide information to it about their config, and what it would do.

For example:

Running binary X with args Y. mirrord Configuration file is C.
mirrord will target PODNAME. It will load all of its environment variables, provide access to its file for read only and will mirror all ports you're listening on locally
@aviramha
Copy link
Member Author

Need to think how to add it later in the extensions.

@Razz4780 Razz4780 assigned Razz4780 and gememma and unassigned Razz4780 May 9, 2024
@gememma
Copy link
Contributor

gememma commented May 14, 2024

So far, using sub_progress.info to log config details at the end of setup, I can print something like the following (I've shown multiple options in square brackets, separated with slashes):

* Running binary "/path/to/binary with arguments: ["sample/node/app.mjs"]
* mirrord will target: pod/py-serv-deployment-xxxxxx, [no configuration file was loaded/a configuration file was loaded from: path/to/config]
* env: [all/not all] environment variables will be loaded
* fs: file operations will default to [read only from the remote/read and write from the remote/read and write locally]
* incoming: incoming traffic will be [mirrored/stolen/ignored]
* outgoing: forwarding is [enabled on TCP, UDP/enabled on TCP/enabled on UDP/disabled on TCP, UDP]

Is there any important information that is missing here? I wasn't so sure about the network.outgoing section

@eyalb181
Copy link
Member

I wonder if we need to display configurations that are set to their default value, @aviramha wdyt?
Also need to see how this displays on the extensions - if it looks bad we might want to disable it there, and find some more UI-y way to show it

@Razz4780
Copy link
Contributor

Razz4780 commented May 14, 2024

Is there any important information that is missing here?

I'd mention dns and operator settings as well

Also need to see how this displays on the extensions

This info can be reported to the IDEs using Progress:ide method, I think. This way we can pass it to extension code in JSON and handle however we want

@aviramha
Copy link
Member Author

I wonder if we need to display configurations that are set to their default value, @aviramha wdyt? Also need to see how this displays on the extensions - if it looks bad we might want to disable it there, and find some more UI-y way to show it

I think the idea is to explain what is going to happen, so even if default values are used it's useful to explain.

1 similar comment
@aviramha
Copy link
Member Author

I wonder if we need to display configurations that are set to their default value, @aviramha wdyt? Also need to see how this displays on the extensions - if it looks bad we might want to disable it there, and find some more UI-y way to show it

I think the idea is to explain what is going to happen, so even if default values are used it's useful to explain.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants