Skip to content

fix(web-console): open a new tab when query param exists and metrics tab is open #415

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

Merged
emrberk merged 1 commit into from
Apr 9, 2025
Merged

fix(web-console): open a new tab when query param exists and metrics tab is open #415

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
18 changes: 18 additions & 0 deletions packages/browser-tests/cypress/integration/console/editor.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,24 @@ describe("&query URL param", () => {
.invoke("text")
.should("match", /hello.world$/); // not matching on appendedQuery, because query should be selected for which Monaco adds special chars between words
});

it("should open a new editor tab when the last active buffer is a metrics buffer", () => {
// when
cy.getByDataHook("schema-add-metrics-button").click();
// then
cy.getByDataHook("metrics-root").should("be.visible");

// when
cy.visit(`${baseUrl}?query=${encodeURIComponent("select x from long_sequence(1)")}`);

// then
cy.getEditorContent().should("be.visible");
cy.getEditorTabs().should("have.length", 3);
cy.getEditorTabByTitle("Metrics 1").should("be.visible");
cy.getEditorTabByTitle("Query")
.should("be.visible")
.should("have.attr", "active");
});
});

describe("autocomplete", () => {
Expand Down
2 changes: 1 addition & 1 deletion packages/browser-tests/questdb
Open in desktop
Submodule questdb updated 12 files
+24 −11 core/src/main/java/io/questdb/cairo/ColumnType.java
+10 −8 core/src/main/java/io/questdb/cairo/wal/WalWriter.java
+10 −0 core/src/main/java/io/questdb/griffin/FunctionFactoryDescriptor.java
+5 −6 core/src/main/java/io/questdb/griffin/FunctionParser.java
+1 −1 core/src/main/java/io/questdb/griffin/engine/functions/IntervalFunction.java
+1 −1 core/src/main/java/io/questdb/griffin/engine/functions/VarcharFunction.java
+120 −36 core/src/test/java/io/questdb/test/cairo/wal/WalWriterTest.java
+2 −2 core/src/test/java/io/questdb/test/griffin/FunctionParserTest.java
+21 −7 core/src/test/java/io/questdb/test/griffin/IPv4Test.java
+112 −0 core/src/test/java/io/questdb/test/griffin/SqlCodeGeneratorTest.java
+2 −2 core/src/test/java/io/questdb/test/griffin/engine/functions/VarcharFunctionTest.java
+28 −0 core/src/test/java/io/questdb/test/griffin/engine/window/WindowFunctionTest.java
4 changes: 3 additions & 1 deletion packages/web-console/src/providers/EditorProvider/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,9 +205,11 @@ export const EditorProvider = ({ children }: PropsWithChildren<{}>) => {

const updateBuffer: EditorContext["updateBuffer"] = async (id, payload) => {
const editorViewState = editorRef.current?.saveViewState()
const bufferType = await bufferStore.getBufferTypeById(id)

await bufferStore.update(id, {
...payload,
...(editorViewState && !payload?.metricsViewState
...(editorViewState && bufferType === BufferType.SQL
? { editorViewState }
: {}),
})
Expand Down
293 changes: 149 additions & 144 deletions packages/web-console/src/scenes/Editor/Metrics/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,39 @@ const GlobalInfo = styled(Box).attrs({
}
`

const MetricsUnavailable = () => {
return (
<GlobalInfo>
<Box gap="1.5rem" flexDirection="column">
<Header>Metrics unavailable</Header>
<Text color="foreground">
Enable Telemetry to access WAL table metrics.
</Text>
<Text color="foreground">
Set <code>telemetry.enabled=true</code> in your server.conf file
and restart the server.
</Text>
<Text color="foreground">
Alternatively, set <code>QDB_TELEMETRY_ENABLED=true</code> ENV var
for the same effect.
</Text>
<Link
color="cyan"
hoverColor="cyan"
href="https://questdb.io/docs/configuration/#telemetry"
rel="noreferrer"
target="_blank"
>
<Box align="center" gap="0.25rem">
<ExternalLink size="16px" />
Documentation
</Box>
</Link>
</Box>
</GlobalInfo>
)
}

export const Metrics = () => {
const { activeBuffer, updateBuffer, buffers } = useEditor()
const [metricViewMode, setMetricViewMode] = useState<MetricViewMode>(
Expand All @@ -100,6 +133,7 @@ export const Metrics = () => {
const [dialogOpen, setDialogOpen] = useState(false)
const [metrics, setMetrics] = useState<Metric[]>([])
const telemetryConfig = useSelector(selectors.telemetry.getConfig)
const telemetryEnabled = telemetryConfig && telemetryConfig.enabled

const tabInFocusRef = React.useRef<boolean>(true)
const refreshRateRef = React.useRef<RefreshRate>()
Expand Down Expand Up @@ -300,156 +334,127 @@ export const Metrics = () => {
}
}, [])

if (telemetryConfig && !telemetryConfig.enabled) {
return (
<Root>
<GlobalInfo>
<Box gap="1.5rem" flexDirection="column">
<Header>Metrics unavailable</Header>
<Text color="foreground">
Enable Telemetry to access WAL table metrics.
</Text>
<Text color="foreground">
Set <code>telemetry.enabled=true</code> in your server.conf file
and restart the server.
</Text>
<Text color="foreground">
Alternatively, set <code>QDB_TELEMETRY_ENABLED=true</code> ENV var
for the same effect.
</Text>
<Link
color="cyan"
hoverColor="cyan"
href="https://questdb.io/docs/configuration/#telemetry"
rel="noreferrer"
target="_blank"
>
<Box align="center" gap="0.25rem">
<ExternalLink size="16px" />
Documentation
</Box>
</Link>
</Box>
</GlobalInfo>
</Root>
)
}

return (
<Root ref={elementRef}>
<Toolbar>
<AddMetricDialog open={dialogOpen} onOpenChange={setDialogOpen} />
<Box align="center" gap="1rem">
<Box gap="0.5rem" style={{ flexShrink: 0 }}>
<IconWithTooltip
icon={
<Button skin="secondary" onClick={handleFullRefresh}>
<Refresh size="20px" />
</Button>
}
tooltip="Refresh all widgets"
placement="bottom"
/>
<IconWithTooltip
icon={
<Select
name="refresh_rate"
value={refreshRate}
options={Object.values(RefreshRate).map((rate) => ({
label: `Refresh: ${rate}`,
value: rate,
}))}
onChange={(e: any) =>
setRefreshRate(e.target.value as RefreshRate)
<Root data-hook="metrics-root" {...(telemetryEnabled ? {} : { ref: elementRef })}>
{!telemetryEnabled ? (
<MetricsUnavailable />
) : (
<>
<Toolbar>
<AddMetricDialog open={dialogOpen} onOpenChange={setDialogOpen} />
<Box align="center" gap="1rem">
<Box gap="0.5rem" style={{ flexShrink: 0 }}>
<IconWithTooltip
icon={
<Button skin="secondary" onClick={handleFullRefresh}>
<Refresh size="20px" />
</Button>
}
tooltip="Refresh all widgets"
placement="bottom"
/>
}
tooltip="Widget refresh rate"
placement="bottom"
/>
</Box>
<IconWithTooltip
icon={
<ForwardRef>
<DateTimePicker
dateFrom={dateFrom}
dateTo={dateTo}
onDateFromToChange={handleDateFromToChange}
<IconWithTooltip
icon={
<Select
name="refresh_rate"
value={refreshRate}
options={Object.values(RefreshRate).map((rate) => ({
label: `Refresh: ${rate}`,
value: rate,
}))}
onChange={(e: any) =>
setRefreshRate(e.target.value as RefreshRate)
}
/>
}
tooltip="Widget refresh rate"
placement="bottom"
/>
</ForwardRef>
}
tooltip="Time duration"
placement="bottom"
/>
<IconWithTooltip
icon={
<Button
skin="secondary"
onClick={() =>
setMetricViewMode(
metricViewMode === MetricViewMode.GRID
? MetricViewMode.LIST
: MetricViewMode.GRID,
)
</Box>
<IconWithTooltip
icon={
<ForwardRef>
<DateTimePicker
dateFrom={dateFrom}
dateTo={dateTo}
onDateFromToChange={handleDateFromToChange}
/>
</ForwardRef>
}
>
{metricViewMode === MetricViewMode.LIST ? (
<GridAlt size="18px" />
) : (
<Menu size="18px" />
)}
</Button>
}
tooltip={
<>
Toggle view mode
<br />
to {metricViewMode === MetricViewMode.GRID ? "column" : "grid"}
</>
}
placement="bottom"
textAlign="center"
/>
</Box>
</Toolbar>
<Charts noMetrics={metrics.length === 0} viewMode={metricViewMode}>
{metrics.length === 0 && (
<GlobalInfo>
<Box gap="1.5rem" flexDirection="column">
<Header>Add your first widget to see metrics</Header>
<Button
skin="secondary"
onClick={() => setDialogOpen(true)}
prefixIcon={<AddChart size="18px" />}
>
Add widget
</Button>
tooltip="Time duration"
placement="bottom"
/>
<IconWithTooltip
icon={
<Button
skin="secondary"
onClick={() =>
setMetricViewMode(
metricViewMode === MetricViewMode.GRID
? MetricViewMode.LIST
: MetricViewMode.GRID,
)
}
>
{metricViewMode === MetricViewMode.LIST ? (
<GridAlt size="18px" />
) : (
<Menu size="18px" />
)}
</Button>
}
tooltip={
<>
Toggle view mode
<br />
to {metricViewMode === MetricViewMode.GRID ? "column" : "grid"}
</>
}
placement="bottom"
textAlign="center"
/>
</Box>
</GlobalInfo>
)}
{metrics &&
metrics
.sort((a: Metric, b: Metric) => a.position - b.position)
.filter(
(metric: Metric) => widgets[metric.metricType] && !metric.removed,
)
.map((metric: Metric, index: number) => {
return (
<MetricComponent
dateFrom={dateFrom}
dateTo={dateTo}
// key is not used by the metric component, but
// is required to comply with React requirements for
// components that are being added to a list
key={index}
metric={metric}
onRemove={handleRemoveMetric}
onTableChange={handleTableChange}
onColorChange={handleColorChange}
/>
)
})}
</Charts>
</Toolbar>
<Charts noMetrics={metrics.length === 0} viewMode={metricViewMode}>
{metrics.length === 0 && (
<GlobalInfo>
<Box gap="1.5rem" flexDirection="column">
<Header>Add your first widget to see metrics</Header>
<Button
skin="secondary"
onClick={() => setDialogOpen(true)}
prefixIcon={<AddChart size="18px" />}
>
Add widget
</Button>
</Box>
</GlobalInfo>
)}
{metrics &&
metrics
.sort((a: Metric, b: Metric) => a.position - b.position)
.filter(
(metric: Metric) => widgets[metric.metricType] && !metric.removed,
)
.map((metric: Metric, index: number) => {
return (
<MetricComponent
dateFrom={dateFrom}
dateTo={dateTo}
// key is not used by the metric component, but
// is required to comply with React requirements for
// components that are being added to a list
key={index}
metric={metric}
onRemove={handleRemoveMetric}
onTableChange={handleTableChange}
onColorChange={handleColorChange}
/>
)
})}
</Charts>
</>
)}
</Root>
)
}
2 changes: 2 additions & 0 deletions packages/web-console/src/scenes/Editor/Monaco/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,6 +317,8 @@ const MonacoEditor = () => {
// otherwise, append the query
} else {
appendQuery(editor, query, { appendAt: "end" })
const newValue = editor.getValue()
updateBuffer(activeBuffer.id as number, { value: newValue })
}
}

Expand Down
12 changes: 10 additions & 2 deletions packages/web-console/src/scenes/Editor/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
*
******************************************************************************/

import React, { CSSProperties, forwardRef, Ref } from "react"
import React, { CSSProperties, forwardRef, Ref, useEffect } from "react"
import styled from "styled-components"

import { PaneWrapper } from "../../components"
Expand All @@ -46,7 +46,15 @@ const Editor = ({
innerRef,
...rest
}: Props & { innerRef: Ref<HTMLDivElement> }) => {
const { activeBuffer } = useEditor()
const { activeBuffer, addBuffer, setActiveBuffer } = useEditor()

useEffect(() => {
const params = new URLSearchParams(window.location.search)
const query = params.get("query")
if (query && activeBuffer.metricsViewState) {
addBuffer({ label: "Query" }).then(setActiveBuffer)
}
}, [])

return (
<EditorPaneWrapper ref={innerRef} {...rest}>
Expand Down
Loading