Skip to content

feat: Add the ability to export a CSV representing a Entity x System timing matrix #399

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
codyward-skybox merged 1 commit into from
Jul 20, 2026
Merged

feat: Add the ability to export a CSV representing a Entity x System timing matrix #399

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
44 changes: 44 additions & 0 deletions webview-ui/src/diagnostics_panel/App.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,6 +397,50 @@ main {
padding-top: 16px;
}

.minecraft-entity-system-csv-dialog-backdrop {
position: fixed;
inset: 0;
z-index: 1000;
display: flex;
align-items: center;
justify-content: center;
padding: 20px;
background: color-mix(in srgb, var(--vscode-editor-background) 70%, transparent);
}

.minecraft-entity-system-csv-dialog {
box-sizing: border-box;
width: min(420px, 100%);
padding: 20px;
color: var(--vscode-editor-foreground);
background: var(--vscode-editorWidget-background);
border: 1px solid var(--vscode-editorWidget-border);
border-radius: 6px;
box-shadow: 0 8px 24px var(--vscode-widget-shadow);
}

.minecraft-entity-system-csv-dialog h3 {
margin: 0 0 8px;
}

.minecraft-entity-system-csv-dialog p {
margin: 0 0 16px;
color: var(--vscode-descriptionForeground);
}

.minecraft-entity-system-csv-dialog-options {
display: flex;
flex-direction: column;
gap: 10px;
}

.minecraft-entity-system-csv-dialog-actions {
display: flex;
justify-content: flex-end;
gap: 8px;
margin-top: 20px;
}

.minecraft-grouped-statistic-table-root {
width: 100%;
}
Expand Down
109 changes: 107 additions & 2 deletions webview-ui/src/diagnostics_panel/prefabs/tabs/ClientEntitySystems.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import {
import { DebuggerRequestResultBanner } from '../../controls/DebuggerRequestResult';
import { MultipleStatisticProvider, StatisticUpdatedMessage } from '../../StatisticProvider';
import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
import { VSCodeButton, VSCodeDropdown, VSCodeOption } from '@vscode/webview-ui-toolkit/react';
import { VSCodeButton, VSCodeCheckbox, VSCodeDropdown, VSCodeOption } from '@vscode/webview-ui-toolkit/react';
import { CsvCellValue, TableCsvExporter } from '../../exporters/TableCsvExporter';
import { sendExportDataRequest } from '../../utilities/exportData';
import { SparklineCell } from '../../controls/SparklineCell';
Expand All @@ -35,6 +35,7 @@ const START_ENTITY_SYSTEM_PROFILER_REQUEST = 'Start Entity System Profiler';
const FILTER_MULTI_ENTITY_REQUEST = 'Filter Multi Entity System Profiler';
const FILTER_SINGLE_ENTITY_REQUEST = 'Filter Single Entity System Profiler';
const FILTER_BY_SYSTEM_REQUEST = 'Filter By System Entity System Profiler';
const REQUEST_CSV_ENTITY_SYSTEM_PROFILER_REQUEST = 'Request CSV Entity System Profiler';

const DEBUGGER_REQUEST_COMMANDS = [
{ command: START_ENTITY_SYSTEM_PROFILER_REQUEST, label: 'Start' },
Expand Down Expand Up @@ -145,8 +146,12 @@ function buildExportFileName(tableType: DiagnosticsExportTableType, now: Date):
return `${tableType}-trends-${formatExportTimestamp(now)}.csv`;
}

function buildEntitySystemMatrixCsvFileName(now: Date): string {
return `entity-system-profiler-${formatExportTimestamp(now)}.csv`;
}

function getFilterSelectionModeTooltip(ecsVersion: number): string {
if (ecsVersion === 2 || ecsVersion === 3) {
if (ecsVersion >= 2) {
return (
'Select Filtering Mode:\n' +
'\u2022 "No Filter" will display system and entity timings for all entities and systems.\n' +
Expand Down Expand Up @@ -349,6 +354,11 @@ const StatsTab: TabPrefab = {
const [ecsVersion, setECSVersion] = useState<number>(1);
const [isStarted, setIsStarted] = useState<boolean>(false);
const [trendDurationPoints, setTrendDurationPoints] = useState<number>(DEFAULT_TREND_DURATION_POINTS);
const [isEntitySystemMatrixCsvExportPending, setIsEntitySystemMatrixCsvExportPending] =
useState<boolean>(false);
const [isEntitySystemMatrixCsvDialogOpen, setIsEntitySystemMatrixCsvDialogOpen] = useState<boolean>(false);
const [groupEntitySystemMatrixCsvEntities, setGroupEntitySystemMatrixCsvEntities] = useState<boolean>(false);
const [groupEntitySystemMatrixCsvSystems, setGroupEntitySystemMatrixCsvSystems] = useState<boolean>(false);
const entityTimingsTableRef = useRef<MinecraftGroupedStatisticTableHandle | null>(null);
const systemTimingsTableRef = useRef<MinecraftGroupedStatisticTableHandle | null>(null);
const isMountRef = useRef(true);
Expand Down Expand Up @@ -603,6 +613,7 @@ const StatsTab: TabPrefab = {
const lastResult: DebuggerRequestResultMessage | undefined = lastRequestedCommand
? getDebuggerRequestResult(lastRequestedCommand)
: undefined;
const entitySystemMatrixCsvResult = getDebuggerRequestResult(REQUEST_CSV_ENTITY_SYSTEM_PROFILER_REQUEST);

useEffect(() => {
if (lastRequestedCommand !== START_ENTITY_SYSTEM_PROFILER_REQUEST) {
Expand All @@ -618,6 +629,51 @@ const StatsTab: TabPrefab = {
console.log(`Entity System Profiler is started: ${isStarted}`);
}, [lastResult, lastRequestedCommand]);

useEffect(() => {
if (
!isEntitySystemMatrixCsvExportPending ||
isDebuggerRequestInFlight(REQUEST_CSV_ENTITY_SYSTEM_PROFILER_REQUEST)
) {
return;
}

setIsEntitySystemMatrixCsvExportPending(false);

if (
entitySystemMatrixCsvResult?.response?.success !== true ||
typeof entitySystemMatrixCsvResult.response.args !== 'string'
) {
return;
}

sendExportDataRequest({
format: csvExporter.format,
mimeType: csvExporter.mimeType,
suggestedFileName: buildEntitySystemMatrixCsvFileName(new Date()),
content: entitySystemMatrixCsvResult.response.args,
});
}, [entitySystemMatrixCsvResult, csvExporter, isEntitySystemMatrixCsvExportPending]);

const openEntitySystemMatrixCsvDialog = useCallback((): void => {
setIsEntitySystemMatrixCsvDialogOpen(true);
}, []);

const closeEntitySystemMatrixCsvDialog = useCallback((): void => {
setIsEntitySystemMatrixCsvDialogOpen(false);
}, []);

const requestEntitySystemMatrixCsv = useCallback((): void => {
setIsEntitySystemMatrixCsvExportPending(true);
setIsEntitySystemMatrixCsvDialogOpen(false);
setLastRequestedCommand(REQUEST_CSV_ENTITY_SYSTEM_PROFILER_REQUEST);
sendDebuggerRequest(REQUEST_CSV_ENTITY_SYSTEM_PROFILER_REQUEST, {
csvArgs: {
groupEntities: groupEntitySystemMatrixCsvEntities,
groupSystems: groupEntitySystemMatrixCsvSystems,
},
});
}, [groupEntitySystemMatrixCsvEntities, groupEntitySystemMatrixCsvSystems]);

const exportTableData = useCallback(
(tableType: DiagnosticsExportTableType): void => {
const tableHandle =
Expand Down Expand Up @@ -832,6 +888,17 @@ const StatsTab: TabPrefab = {
<VSCodeButton onClick={() => exportTableData('system')} disabled={!isStarted}>
Export System CSV
</VSCodeButton>
{ecsVersion >= 4 && (
<VSCodeButton
onClick={openEntitySystemMatrixCsvDialog}
disabled={
!isStarted ||
isDebuggerRequestInFlight(REQUEST_CSV_ENTITY_SYSTEM_PROFILER_REQUEST)
}
>
Export Entity System Matrix CSV
</VSCodeButton>
)}
</div>
</div>
)}
Expand Down Expand Up @@ -1063,6 +1130,44 @@ const StatsTab: TabPrefab = {
</div>
</div>
)}
{isEntitySystemMatrixCsvDialogOpen && (
<div className="minecraft-entity-system-csv-dialog-backdrop">
<div
className="minecraft-entity-system-csv-dialog"
role="dialog"
aria-modal="true"
aria-labelledby="ecs-client-csv-dialog-title"
>
<h3 id="ecs-client-csv-dialog-title">Export Entity System Matrix CSV</h3>
<p>Select which data should be grouped in the CSV.</p>
<div className="minecraft-entity-system-csv-dialog-options">
<VSCodeCheckbox
checked={groupEntitySystemMatrixCsvEntities}
onChange={() =>
setGroupEntitySystemMatrixCsvEntities(currentValue => !currentValue)
}
>
Group Entities
</VSCodeCheckbox>
<VSCodeCheckbox
checked={groupEntitySystemMatrixCsvSystems}
onChange={() => setGroupEntitySystemMatrixCsvSystems(currentValue => !currentValue)}
>
Group Systems
</VSCodeCheckbox>
</div>
<div className="minecraft-entity-system-csv-dialog-actions">
<VSCodeButton onClick={closeEntitySystemMatrixCsvDialog}>Cancel</VSCodeButton>
<VSCodeButton
onClick={requestEntitySystemMatrixCsv}
disabled={isDebuggerRequestInFlight(REQUEST_CSV_ENTITY_SYSTEM_PROFILER_REQUEST)}
>
Export CSV
</VSCodeButton>
</div>
</div>
</div>
)}
</div>
);
},
Expand Down
Loading