Skip to content

DRY up shortcut and link rendering in DevSessionUI #7260

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

Open
nickwesselman wants to merge 1 commit into
base: nwesselman/dev-footer-hyperlinks
Choose a base branch
from
+69 −81
Open

DRY up shortcut and link rendering in DevSessionUI #7260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
145 changes: 65 additions & 80 deletions packages/app/src/cli/services/dev/ui/components/DevSessionUI.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import {Spinner} from './Spinner.js'
import {TabPanel, Tab} from './TabPanel.js'
import {TabPanel, Tab, TabShortcut} from './TabPanel.js'
import metadata from '../../../../metadata.js'
import {
DevSessionStatus,
Expand Down Expand Up @@ -119,85 +119,78 @@ const DevSessionUI: FunctionComponent<DevSesionUIProps> = ({
}
}

const devStatusShortcuts: TabShortcut[] = [
{
key: 'p',
shortcutLabel: 'Open app preview',
linkLabel: 'Preview',
url: status.previewURL,
condition: () => Boolean(status.isReady && status.previewURL),
action: async () => {
await metadata.addPublicMetadata(() => ({
cmd_dev_preview_url_opened: true,
}))
if (status.previewURL) {
await openURL(status.previewURL)
}
},
},
{
key: 'c',
shortcutLabel: 'Open Dev Console for extension previews',
linkLabel: 'Dev Console',
url: buildDevConsoleURL(shopFqdn),
condition: () => Boolean(status.isReady && !status.appEmbedded && status.hasExtensions),
action: async () => {
await metadata.addPublicMetadata(() => ({
cmd_dev_preview_url_opened: true,
}))
await openURL(buildDevConsoleURL(shopFqdn))
},
},
{
key: 'g',
shortcutLabel: 'Open GraphiQL (Admin API)',
linkLabel: 'GraphiQL',
url: status.graphiqlURL,
condition: () => Boolean(status.isReady && status.graphiqlURL),
action: async () => {
await metadata.addPublicMetadata(() => ({
cmd_dev_graphiql_opened: true,
}))
if (status.graphiqlURL) {
await openURL(status.graphiqlURL)
}
},
},
]

const activeShortcuts = devStatusShortcuts.filter((shortcut) => shortcut.condition?.() ?? true)

const tabs: {[key: string]: Tab} = {
// eslint-disable-next-line id-length
d: {
label: 'Dev status',
shortcuts: [
{
key: 'p',
condition: () => Boolean(status.isReady && status.previewURL),
action: async () => {
await metadata.addPublicMetadata(() => ({
cmd_dev_preview_url_opened: true,
}))
if (status.previewURL) {
await openURL(status.previewURL)
}
},
},
{
key: 'g',
condition: () => Boolean(status.isReady && status.graphiqlURL),
action: async () => {
await metadata.addPublicMetadata(() => ({
cmd_dev_graphiql_opened: true,
}))
if (status.graphiqlURL) {
await openURL(status.graphiqlURL)
}
},
},
{
key: 'c',
condition: () => Boolean(status.isReady && !status.appEmbedded && status.hasExtensions),
action: async () => {
await metadata.addPublicMetadata(() => ({
cmd_dev_preview_url_opened: true,
}))
await openURL(buildDevConsoleURL(shopFqdn))
},
},
],
shortcuts: devStatusShortcuts,
content: (
<>
{status.statusMessage && (
<Text>
{getStatusIndicator(status.statusMessage.type)} {status.statusMessage.message}
</Text>
)}
{canUseShortcuts && (
{canUseShortcuts && activeShortcuts.length > 0 && (
<Box marginTop={1} flexDirection="column">
{status.isReady && status.previewURL ? (
<Text>
{figures.pointerSmall} <Text bold>(p)</Text>{' '}
{terminalSupportsHyperlinks() ? (
<Link url={status.previewURL} label="Open app preview" />
) : (
'Open app preview'
)}
</Text>
) : null}
{status.isReady && !status.appEmbedded && status.hasExtensions ? (
<Text>
{figures.pointerSmall} <Text bold>(c)</Text>{' '}
{terminalSupportsHyperlinks() ? (
<Link url={buildDevConsoleURL(shopFqdn)} label="Open Dev Console for extension previews" />
) : (
'Open Dev Console for extension previews'
)}
</Text>
) : null}
{status.isReady && status.graphiqlURL ? (
<Text>
{figures.pointerSmall} <Text bold>(g)</Text>{' '}
{terminalSupportsHyperlinks() ? (
<Link url={status.graphiqlURL} label="Open GraphiQL (Admin API)" />
{activeShortcuts.map((shortcut) => (
<Text key={shortcut.key}>
{figures.pointerSmall} <Text bold>({shortcut.key})</Text>{' '}
{terminalSupportsHyperlinks() && shortcut.url ? (
<Link url={shortcut.url} label={shortcut.shortcutLabel} />
) : (
'Open GraphiQL (Admin API)'
shortcut.shortcutLabel
)}
</Text>
) : null}
))}
</Box>
)}
<Box marginTop={canUseShortcuts ? 1 : 0} flexDirection="column">
Expand All @@ -207,21 +200,13 @@ const DevSessionUI: FunctionComponent<DevSesionUIProps> = ({
<>
{status.isReady && !(canUseShortcuts && terminalSupportsHyperlinks()) && (
<>
{status.previewURL ? (
<Text>
Preview URL: <Link url={status.previewURL} />
</Text>
) : null}
{status.appEmbedded === false && status.hasExtensions ? (
<Text>
Dev Console URL: <Link url={buildDevConsoleURL(shopFqdn)} />
</Text>
) : null}
{status.graphiqlURL ? (
<Text>
GraphiQL URL: <Link url={status.graphiqlURL} />
</Text>
) : null}
{activeShortcuts
.filter((shortcut) => shortcut.url)
.map((shortcut) => (
<Text key={shortcut.key}>
{shortcut.linkLabel} URL: <Link url={shortcut.url!} />
</Text>
))}
</>
)}
</>
Expand Down
5 changes: 4 additions & 1 deletion packages/app/src/cli/services/dev/ui/components/TabPanel.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,11 @@ export interface Tab {
action?: () => Promise<void>
}

interface TabShortcut {
export interface TabShortcut {
key: string
shortcutLabel?: string
linkLabel?: string
url?: string
condition?: () => boolean
action: () => Promise<void>
}
Expand Down
Loading