Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Split dashboard-viewer-session.ts: a 1857-line file whose 1354-line closure holds every concern

Đang mở
  • Có gì không ổn?
#453 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
42/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
typescript
Lĩnh vực
frontend, testing-qa

Hướng nghiên cứu

Chờ phase 1 của #447, sau đó đọc src/dashboard/application/dashboard-viewer-session.ts và tests/unit/dashboard-viewer-session.test.ts cùng với các ranh giới runtime và state được đề xuất. Trước tiên, chạy các unit test hiện có và kiểm tra các thiết lập coverage trong tests/vitest.config.ts. Công việc được xem là hoàn tất khi các module được tách với input rõ ràng, behavior và public API không thay đổi, mỗi file mới đạt coverage, và npm run check:arch chạy thành công.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

enhancement

Found while planning #447 phase 1. Deferred: doing it now would relocate code that #447 phase 1 deletes.

What

src/dashboard/application/dashboard-viewer-session.ts is 1857 lines, of which
1354 are a single factory closure — createDashboardViewerSession starts at line 503 and runs
to the end of the file. tests/unit/dashboard-viewer-session.test.ts is 3441 lines.

The closure holds ~65 members with no internal boundary: tile runtime construction, the parameter
analysis, target resolution, the option-source/provider wave engine, published-state assembly, the
execution pool, the commit API, and the session lifecycle all capture the same scope.

That has three concrete costs:

  • Review surface. Any change to one concern reads as a change to the whole session.
  • The 90% branch floor (tests/vitest.config.ts, perFile: true, 100/95/90/100) is enforced
    over the whole 1857-line file, so a defensive branch in one concern can only be covered through
    the public session API, via a fixture that sets up every other concern too. That is a large part
    of why the spec is 3441 lines.
  • Closure capture instead of parameters. Members read tiles, filters, analysis,
    documentRef and friends directly from scope, so there is no stated contract between concerns.

Why after #447, not before

#447 phase 1 removes the curated-filter/provider infrastructure, which accounts for roughly
500 lines (~27%) of this file:

Region Lines What
FilterSourceRuntime 405-424 provider record
filterInitialActive / filterDefaultValue 458-468 persisted-default readers
sourceBackedParams, filterSources 610-640 provider index
curatedControls, staticFilterDiagnostics, mergeControls 730-807 provider/control merge
optionsSignature … runFilterSourceWave 1105-1466 the whole option-source wave engine

Splitting first would mean carefully extracting code that is about to be deleted, and would put two
large diffs on the same file back to back. After phase 1 the file is ~1350 lines with a clearer set
of responsibilities, and the extraction boundaries below fall out of what remains.

Proposed split (post-#447)

File Contents
dashboard-viewer-session.ts public facade + lifecycle: start/refresh/refreshTile/syncDocument/destroy/setTileSearch/cancelTile/setGridRenderMode/setDashboardStyle/preflight
viewer-tile-runtime.ts TileRuntime, buildTileRuntime, runTile, tileResultMeta, markTextAndErrorTiles, runnableTiles, isRunnableTileRuntime, runPool, supersede
viewer-variable-runtime.ts variable runtime records, rawValues/activeMap/committedRootValues/prepareBatch, the commit API (setFilter/applyFilter/applyFilters/clearFilter/clearAllFilters/resetFilters), commitAndRerun/runAffectedWave/reserveAffected
viewer-state.ts ViewerTileState/ViewerFilterState/DashboardViewState + buildState/publish
dashboard-viewer-session.types.ts DashboardViewerDeps, ViewerExecutor, ViewerConnection, ViewerReadRequest (type-only seam contract, per ADR-0002 phase 0)

tests/unit/dashboard-viewer-session.test.ts splits alongside, one spec per new module.

Acceptance

  • No behaviour change; the existing session public API is byte-identical to callers
    (src/ui/dashboard.ts is the only consumer).
  • Each new file independently meets 100/95/90/100. This is the real work — extracted
    collaborators must take explicit inputs rather than capture closure scope, and each one must be
    reachable from its own spec without standing up the whole session.
  • npm run check:arch still passes: src/dashboard/application may not import src/ui,
    src/editor, src/application, src/state.ts, src/net, src/dashboard/ui
    (build/check-boundaries.mjs), and the new siblings inherit that rule.
  • No new runtime dependency; no seam changes.

Non-goals

  • Changing the session's public API or the published DashboardViewState shape.
  • Splitting src/ui/dashboard.ts (2641 lines) — related, but a separate call.
Ngôn ngữ chính
TypeScript
Star
8
Fork
2
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Altinity/altinity-sql-browser

Tất cả issue của Altinity/altinity-sql-browser

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.