Skip to content

refactor(telemetry): rename camelcase document pane events to title case#12969

Open
jordanl17 wants to merge 1 commit into
mainfrom
refactor/sapp-3817-title-case-telemetry-events
Open

refactor(telemetry): rename camelcase document pane events to title case#12969
jordanl17 wants to merge 1 commit into
mainfrom
refactor/sapp-3817-title-case-telemetry-events

Conversation

@jordanl17

@jordanl17 jordanl17 commented Jun 8, 2026

Copy link
Copy Markdown
Member

Description

Renames four document-pane telemetry event name strings from camelCase to Title Case, per SAPP-3817. The exported JS identifiers (DocumentURLCopied, etc.) are unchanged - only the emitted event name values change.

  • DocumentURLCopied -> Document URL Copied
  • DocumentIDCopied -> Document ID Copied
  • InlineChangesSwitchedOn -> Inline Changes Switched On
  • InlineChangesSwitchedOff -> Inline Changes Switched Off

Resolves SAPP-3817.

What to review

  • Confirm only the name: literals changed in documentPanes.telemetry.ts and that the exported identifiers are untouched.
  • Confirm the two updated assertions in CopyDocumentActions.test.tsx match the new Title Case names.
  • Most importantly: confirm the downstream dbt/Looker migration is planned and sequenced (see warning above) before this is marked ready.

Testing

pnpm run test run CopyDocumentActions - 13 passed. The two assertions covering the URL- and ID-copied events were updated to the new names and pass.

Notes for release

N/A

Copilot AI review requested due to automatic review settings June 8, 2026 12:24
@vercel

vercel Bot commented Jun 8, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
auth-test-studio Ready Ready Preview, Comment Jun 8, 2026 12:26pm
page-building-studio Ready Ready Preview, Comment Jun 8, 2026 12:26pm
test-studio Ready Ready Preview, Comment Jun 8, 2026 12:26pm

Request Review

@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

📦 Bundle Stats — sanity

Compared against main (fcd6dacf) · v5.30.0 (npm)

sanity

Metric Value vs main (fcd6dac) vs v5.30.0
Internal (raw) 4.55 MB - +1.5 KB, +0.0%
Internal (gzip) 1.05 MB - +678 B, +0.1%
Bundled (raw) 12.33 MB - -4.8 KB, -0.0%
Bundled (gzip) 2.77 MB - -751 B, -0.0%
Import time 1.57s +15ms, +0.9% +38ms, +2.5%

bin:sanity

Metric Value vs main (fcd6dac) vs v5.30.0
Internal (raw) 7.1 KB - -
Internal (gzip) 2.9 KB - -
Bundled (raw) 7.1 KB - -
Bundled (gzip) 2.8 KB - -
Import time 5ms +0ms, +2.3% +0ms, +4.2%

🗺️ View treemap · Artifacts

Details
  • Import time regressions over 10% are flagged with ⚠️
  • Sizes shown as raw / gzip 🗜️. Internal bytes = own code only. Total bytes = with all dependencies. Import time = Node.js cold-start median.

@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

📚 TypeDoc Generation Result

TypeDoc generated successfully!

  • File size: 8.2M
  • Total exports: 1067
  • Artifact: sanity-typedoc-e575f9fc49c09bac3d1dd69dec6652ca53b4eca0

The TypeDoc JSON file has been generated and validated. All documentation scripts completed successfully.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot wasn't able to review any files in this pull request.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

⚡️ Editor Performance Report

Updated Mon, 08 Jun 2026 12:31:58 GMT

Benchmark reference
latency of sanity@latest
experiment
latency of this branch
Δ (%)
latency difference
arrayI18n (simple-en) 47.6 efps (21ms) 52.6 efps (19ms) -2ms (-9.5%)
article (title) 38.5 efps (26ms) 37.0 efps (27ms) +1ms (+3.8%)
article (body) 50.5 efps (20ms) 50.5 efps (20ms) +0ms (+0.0%)
article (string inside object) 45.5 efps (22ms) 42.6 efps (24ms) +2ms (+6.8%)
article (string inside array) 41.7 efps (24ms) 41.7 efps (24ms) +0ms (-/-%)
recipe (name) 95.2 efps (11ms) 95.2 efps (11ms) +0ms (-/-%)
recipe (description) 45.5 efps (22ms) 43.5 efps (23ms) +1ms (+4.5%)
recipe (instructions) 99.9+ efps (10ms) 99.9+ efps (10ms) +0ms (-/-%)
singleString (stringField) 99.9+ efps (7ms) 99.9+ efps (8ms) +1ms (-/-%)
synthetic (title) 55.6 efps (18ms) 55.6 efps (18ms) +0ms (-/-%)
synthetic (string inside object) 50.0 efps (20ms) 47.6 efps (21ms) +1ms (+5.0%)

efps — editor "frames per second". The number of updates assumed to be possible within a second.

Derived from input latency. efps = 1000 / input_latency

Detailed information

🏠 Reference result

The performance result of sanity@latest

Benchmark latency p75 p90 p99 blocking time test duration
arrayI18n (simple-en) 21ms 26ms 34ms 58ms 5ms 7.0s
article (title) 26ms 29ms 38ms 75ms 38ms 8.0s
article (body) 20ms 24ms 35ms 97ms 214ms 5.6s
article (string inside object) 22ms 27ms 39ms 76ms 34ms 6.7s
article (string inside array) 24ms 26ms 29ms 66ms 2ms 7.0s
recipe (name) 11ms 13ms 15ms 36ms 2ms 5.4s
recipe (description) 22ms 26ms 31ms 53ms 0ms 4.8s
recipe (instructions) 10ms 12ms 13ms 29ms 0ms 3.2s
singleString (stringField) 7ms 11ms 13ms 21ms 0ms 4.7s
synthetic (title) 18ms 19ms 23ms 87ms 1399ms 9.3s
synthetic (string inside object) 20ms 24ms 84ms 102ms 1329ms 9.5s

🧪 Experiment result

The performance result of this branch

Benchmark latency p75 p90 p99 blocking time test duration
arrayI18n (simple-en) 19ms 26ms 42ms 79ms 37ms 6.8s
article (title) 27ms 31ms 35ms 71ms 24ms 7.9s
article (body) 20ms 26ms 37ms 89ms 227ms 5.4s
article (string inside object) 24ms 27ms 39ms 61ms 28ms 6.7s
article (string inside array) 24ms 27ms 37ms 73ms 14ms 7.2s
recipe (name) 11ms 13ms 16ms 38ms 0ms 5.5s
recipe (description) 23ms 24ms 27ms 48ms 0ms 4.7s
recipe (instructions) 10ms 12ms 15ms 36ms 0ms 3.3s
singleString (stringField) 8ms 10ms 12ms 24ms 0ms 4.8s
synthetic (title) 18ms 21ms 26ms 93ms 1498ms 9.7s
synthetic (string inside object) 21ms 28ms 44ms 97ms 1351ms 9.7s

📚 Glossary

column definitions

  • benchmark — the name of the test, e.g. "article", followed by the label of the field being measured, e.g. "(title)".
  • latency — the time between when a key was pressed and when it was rendered. derived from a set of samples. the median (p50) is shown to show the most common latency.
  • p75 — the 75th percentile of the input latency in the test run. 75% of the sampled inputs in this benchmark were processed faster than this value. this provides insight into the upper range of typical performance.
  • p90 — the 90th percentile of the input latency in the test run. 90% of the sampled inputs were faster than this. this metric helps identify slower interactions that occurred less frequently during the benchmark.
  • p99 — the 99th percentile of the input latency in the test run. only 1% of sampled inputs were slower than this. this represents the worst-case scenarios encountered during the benchmark, useful for identifying potential performance outliers.
  • blocking time — the total time during which the main thread was blocked, preventing user input and UI updates. this metric helps identify performance bottlenecks that may cause the interface to feel unresponsive.
  • test duration — how long the test run took to complete.

@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 42.99% 29483 / 68580
🔵 Statements 35.8% 39693 / 110857
🔵 Functions 33.29% 6275 / 18844
🔵 Branches 26.81% 23858 / 88973
File CoverageNo changed files found.
Generated in workflow #56955 for commit 53b6ef0 by the Vitest Coverage Report Action

@jordanl17 jordanl17 marked this pull request as ready for review June 8, 2026 18:56
@jordanl17 jordanl17 requested review from a team as code owners June 8, 2026 18:56
@jordanl17 jordanl17 requested review from stipsan and removed request for a team June 8, 2026 18:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants