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.

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

Convert Sequence Diagram img to mermaid #51723

Merged
merged 4 commits into from
Jan 31, 2025
+28 −31
Merged

Convert Sequence Diagram img to mermaid #51723

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
825404c
Convert Sequence Diagram img to mermaid
n6y5 Jan 31, 2025
87d6c7f
Remove PTY communication documentation files
n6y5 Jan 31, 2025
82a4351
Merge branch 'master' into n6y5-teleterm-sequence-mermaid
n6y5 Jan 31, 2025
580f573
Merge branch 'master' into n6y5-teleterm-sequence-mermaid
n6y5 Jan 31, 2025
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
29 changes: 28 additions & 1 deletion web/packages/teleterm/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,34 @@ resource availability as possible.

### PTY communication overview (Renderer Process <=> Shared Process)

![PTY communication](docs/ptyCommunication.png)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should we delete this file too?

Copy link
Contributor Author

@n6y5 n6y5 Jan 31, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

@zmb3 We should!

When we do delete the image, I now notice that would only leave the txt source within the docs dir /docs/ptyCommunication.txt, which is redundant to the mermaid syntax we now have, inline, within the README.

Should we delete the entire dir in favor of keeping everything in the README?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed docs dir and contents: 87d6c7f

```mermaid
sequenceDiagram
autonumber
participant DT as Document Terminal
participant PS as PTY Service
participant PHS as PTY Host Service
participant PP as PTY Process

DT->>PS: wants new PTY
Note over PS,PHS: gRPC communication
PS->>PHS: createPtyProcess(options)
PHS->>PP: new PtyProcess()
PHS-->>PS: ptyId of the process is returned
PS->>PHS: establishExchangeEvents(ptyId) channel
Note right of DT: client has been created,<br/> so PTY Service can attach <br/> event handlers to the channel <br/>(onData/onOpen/onExit)
PS-->>DT: pty process object
DT->>PS: start()
PS->>PHS: exchangeEvents.start()
Note left of PP: exchangeEvents attaches event handlers<br/>to the PTY Process (onData/onOpen/onExit)
PHS->>PP: start()
PP-->>PHS: onOpen()
PHS-->>PS: exchangeEvents.onOpen()
PS-->>DT: onOpen()
DT->>PS: dispose()
PS->>PHS: end exchangeEvents channel
PHS->>PP: dispose process and remove it

```

### Overview of a deep link launch process

Expand Down
Loading