Skip to content
This repository was archived by the owner on Feb 8, 2024. It is now read-only.

Fall back to leaf cluster id when restoring leaf cluster terminal document #920

Merged
gzdunek merged 3 commits into from
Jun 27, 2022
Merged

Fall back to leaf cluster id when restoring leaf cluster terminal document #920

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
19b387c
Fall back to leaf cluster id when restoring leaf cluster terminal doc…
gzdunek Jun 24, 2022
b1d8b0d
Improve error message
gzdunek Jun 27, 2022
c393b1e
Merge branch 'master' into gzdunek/restoring-leaf-terminal-documents
gzdunek Jun 27, 2022
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
34 changes: 30 additions & 4 deletions packages/teleterm/src/ui/DocumentTerminal/useDocumentTerminal.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ import { IPtyProcess } from 'teleterm/sharedProcess/ptyHost';
import { useAsync } from 'shared/hooks/useAsync';
import { useWorkspaceDocumentsService } from 'teleterm/ui/Documents';
import { routing } from 'teleterm/ui/uri';
import { getClusterName } from 'teleterm/ui/utils';
import { PtyCommand, PtyProcessCreationStatus } from 'teleterm/services/pty';

export default function useDocumentTerminal(doc: Doc) {
Expand All @@ -40,6 +39,15 @@ export default function useDocumentTerminal(doc: Doc) {
};
}, []);

useEffect(() => {
if (state.status === 'error') {
ctx.notificationsService.notifyError({
title: 'Could not open a terminal',
description: state.statusText,
});
}
}, [state.status]);

return state;
}

Expand All @@ -48,10 +56,28 @@ async function initState(
docsService: DocumentsService,
doc: Doc
) {
const getClusterActualName = () => {
const cluster = ctx.clustersService.findCluster(clusterUri);
if (cluster) {
return cluster.actualName;
}

/*
When restoring the documents, we do not always have the leaf clusters already fetched.
In that case we can fall back to `clusterId` from a leaf cluster URI
(for a leaf cluster `clusterId` === `actualName`)
*/
const parsed = routing.parseClusterUri(clusterUri);
Comment on lines +66 to +70

@ravicious ravicious Jun 27, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Good comment, thanks.


if (!parsed?.params?.leafClusterId) {
throw new Error('Incorrect cluster URI');

@ravicious ravicious Jun 27, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This error message could provide more information though. :D Maybe something that at this point a leaf cluster URI was expected but the URI doesn't seem to include a leaf cluster ID?

@gzdunek gzdunek Jun 27, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Good idea, thanks

}
return parsed.params.leafClusterId;
};

const clusterUri = routing.getClusterUri(doc);
const rootCluster = ctx.clustersService.findRootClusterByResource(clusterUri);
const cluster = ctx.clustersService.findCluster(clusterUri);
const cmd = createCmd(doc, rootCluster.proxyHost, cluster.actualName);
const cmd = createCmd(doc, rootCluster.proxyHost, getClusterActualName());
const ptyProcess = await createPtyProcess(ctx, cmd);
if (!ptyProcess) {
return;
Expand All @@ -67,7 +93,7 @@ async function initState(
const cwd = await ptyProcess.getCwd();
docsService.update(doc.uri, {
cwd,
title: `${cwd} · ${getClusterName(cluster)}`,
title: `${cwd} · ${getClusterActualName()}`,
});
};

Expand Down