Skip to content

refactor(telemetry): rename Schema deploy action executed event to Schema Deployed#1142

Open
jordanl17 wants to merge 3 commits into
mainfrom
sapp-3865
Open

refactor(telemetry): rename Schema deploy action executed event to Schema Deployed#1142
jordanl17 wants to merge 3 commits into
mainfrom
sapp-3865

Conversation

@jordanl17
Copy link
Copy Markdown
Member

@jordanl17 jordanl17 commented May 28, 2026

Description

A March 2026 audit of Studio telemetry by data and analytics flagged SAPP-3865 - the Schema deploy action executed event uses the wrong tense and pattern relative to the rest of our event vocabulary. This is the follow-up to SAPP-3818, which covered the Canvas rename in the studio repo.

This PR renames the event to Schema Deployed. No payload or trigger changes, just the event name.


Note

Low Risk
Single string change on a telemetry trace name; no runtime or security impact beyond analytics possibly treating it as a new event label.

Overview
Renames the SchemaDeploy telemetry trace’s display name from Schema deploy action executed to Schema Deployed in extractSchema.telemetry.ts, aligning Studio telemetry vocabulary with past-tense event naming (e.g. Schema Extracted). The SchemaDeploy export, payload shape, and when the trace fires are unchanged.

Reviewed by Cursor Bugbot for commit 2dced76. Bugbot is set up for automated code reviews on this repo. Configure here.

@claude
Copy link
Copy Markdown

claude Bot commented May 28, 2026

Claude finished @jordanl17's task in 49s —— View job


Review

One-line telemetry event rename. Aligns with the Schema Extracted naming pattern in the same file (line 35). No code or behavior issues.

Findings

  • Changeset: Not needed. The change only affects an internal telemetry event name (no public API or CLI behavior impact). The existing changesets in .changeset/ are for unrelated PRs.
  • Trace version unchanged at 1: The schema/payload of the trace is identical, so keeping the version is correct. The event-name change is what consumers (analytics dashboards) need to handle, not a payload migration.
  • Minor (optional): The description field at packages/@sanity/cli/src/telemetry/extractSchema.telemetry.ts:47 still reads "Schema deploy action was executed…" — past-tense narration of the old name. Not blocking, but if you want full alignment, consider rewording to e.g. 'Trace emitted when a schema is deployed, either via sanity schema deploy or as sanity deploy' to mirror the style of SchemaExtractedTrace (line 34) and SchemaExtractionWatchModeTrace (line 40).

No other issues.
| Branch: sapp-3865

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 28, 2026

📦 Bundle Stats — @sanity/cli

Compared against main (6165c80c)

@sanity/cli

Metric Value vs main (6165c80)
Internal (raw) 2.1 KB -
Internal (gzip) 799 B -
Bundled (raw) 10.97 MB -
Bundled (gzip) 2.06 MB -
Import time 758ms +9ms, +1.2%

bin:sanity

Metric Value vs main (6165c80)
Internal (raw) 1023 B -
Internal (gzip) 486 B -
Bundled (raw) 9.87 MB -
Bundled (gzip) 1.77 MB -
Import time 849ms +15ms, +1.8%

🗺️ 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.

📦 Bundle Stats — @sanity/cli-core

Compared against main (6165c80c)

Metric Value vs main (6165c80)
Internal (raw) 96.3 KB -
Internal (gzip) 22.7 KB -
Bundled (raw) 21.64 MB -
Bundled (gzip) 3.43 MB -
Import time 718ms -1ms, -0.1%

🗺️ 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.

📦 Bundle Stats — create-sanity

Compared against main (6165c80c)

Metric Value vs main (6165c80)
Internal (raw) 908 B -
Internal (gzip) 483 B -
Bundled (raw) 931 B -
Bundled (gzip) 491 B -
Import time ❌ ChildProcess denied: node -
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
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 28, 2026

Coverage Delta

File Statements
packages/@sanity/cli-build/src/telemetry/extractSchema.telemetry.ts 100.0% (±0%)

Comparing 1 changed file against main @ 7d2118d4509f4d0a7406b1e262d17f4b531d1d07

Overall Coverage

Metric Coverage
Statements 84.3% (±0%)
Branches 74.3% (±0%)
Functions 84.2% (±0%)
Lines 84.8% (±0%)

@jordanl17 jordanl17 marked this pull request as ready for review May 28, 2026 10:53
@jordanl17 jordanl17 requested a review from a team as a code owner May 28, 2026 10:53
runeb
runeb previously approved these changes May 28, 2026
@jordanl17
Copy link
Copy Markdown
Member Author

@copilot resolve the merge conflicts in this pull request

Copy link
Copy Markdown
Contributor

Copilot AI commented May 29, 2026

@copilot resolve the merge conflicts in this pull request

Resolved. I merged main into this branch to clear the PR conflicts in commit 2dced76a.

@jordanl17
Copy link
Copy Markdown
Member Author

@copilot fix the lint checks now in CI

Copy link
Copy Markdown
Contributor

Copilot AI commented May 29, 2026

@copilot fix the lint checks now in CI

Fixed in b664eb6. I updated Turbo task ordering so publint depends on each package’s local build:types, which prevents the @sanity/cli-core publint failure in CI.

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit b664eb6. Configure here.

Comment thread turbo.json
"lint": {},
"publint": {
"dependsOn": ["^build:types", "^publint"],
"dependsOn": ["build:types", "^build:types", "^publint"],
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Unrelated turbo.json build config change in rename PR

Low Severity

The publint task's dependsOn now includes same-package "build:types" (without ^ prefix), in addition to the existing "^build:types". This build pipeline change is unrelated to the stated PR goal of renaming a telemetry event. It was likely introduced during Copilot's automated merge conflict resolution and may not have been intentionally reviewed.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit b664eb6. Configure here.

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.

3 participants