Skip to content

release(sdk): cut alpha.11 + drop internal warnings from public create result#4818

Merged
saddlepaddle merged 4 commits into
mainfrom
release-sdk-alpha-11
May 21, 2026
Merged

release(sdk): cut alpha.11 + drop internal warnings from public create result#4818
saddlepaddle merged 4 commits into
mainfrom
release-sdk-alpha-11

Conversation

@saddlepaddle
Copy link
Copy Markdown
Collaborator

@saddlepaddle saddlepaddle commented May 21, 2026

Cuts @superset_sh/sdk 0.0.1-alpha.11 and removes the internal warnings[] field from the public workspace-create surface.

Why

WorkspaceCreateResult.warnings was added after alpha.10 (#4643) and never published. Nothing consumes it:

  • Desktop only reads warnings from the destroy/cleanup flow, not create.
  • CLI returns the raw result as data, so it leaked the field with no consumer.
  • The create-time warnings are already console.warn'd server-side, so removing the field loses no signal.

CLI / SDK / MCP shouldn't carry this internal detail, so it's removed at the source.

Changes

  • host-service workspaces.create: drop the warnings[] array + return field (kept the console.warn logging)
  • sdk WorkspaceCreateResult: remove warnings
  • mcp-v2 workspaces/create: remove warnings from the result type
  • release: bump packages/sdk/package.json0.0.1-alpha.11 (+ bun.lock)

Verify

  • typecheck: host-service, sdk, mcp-v2 all pass
  • sdk bun run build → dist clean, no warnings in emitted .d.ts
  • publish: cd packages/sdk/dist && npm publish --access public (manual, after merge — needs npm auth)

Left untouched: destroy/cleanup warnings (separate feature, user-facing in desktop) and the internal adopt/CheckoutResult types (not part of the public surface).

Summary by CodeRabbit

  • Version Updates

    • SDK package bumped to v0.0.1-alpha.11.
  • Changes

    • Workspace creation no longer returns user-visible warnings; warnings are logged instead.
    • Create response now includes an explicit "already exists" indicator and focuses on workspace, terminals, and agents status.
  • Tests

    • Integration tests updated to match the new create-response behavior and removed assertions about returned warnings.

Review Change Stack

@stage-review
Copy link
Copy Markdown

stage-review Bot commented May 21, 2026

Ready to review this PR? Stage has broken it down into 6 individual chapters for you:

Title
1 Remove warnings from WorkspaceCreateResult SDK type
2 Drop warnings from host-service workspace creation
3 Update MCP workspace creation tool type
4 Update integration tests for workspace creation
5 Bump SDK version to alpha.11
6 Other changes
Open in Stage

Chapters generated by Stage for commit b70b471 on May 21, 2026 10:36pm UTC.

@capy-ai
Copy link
Copy Markdown

capy-ai Bot commented May 21, 2026

Capy auto-review is paused for this organization because the monthly auto-review limit has been reached. Increase the limit or turn it off in billing settings to resume automatic reviews.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 21, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: cdc5c066-1f68-40b4-8b0a-be2777ab339b

📥 Commits

Reviewing files that changed from the base of the PR and between f740ff6 and b70b471.

📒 Files selected for processing (1)
  • packages/host-service/test/integration/workspace-create-pr.integration.test.ts

📝 Walkthrough

Walkthrough

Removed the aggregated warnings array from workspace creation (now logged immediately), adjusted the create response to drop warnings and include alreadyExists/txid, updated MCP caller typings, and bumped @superset/sdk to 0.0.1-alpha.11.

Changes

Workspace create + SDK updates

Layer / File(s) Summary
Version field update
packages/sdk/package.json
The package manifest version field is incremented from 0.0.1-alpha.10 to 0.0.1-alpha.11.
Remove aggregated warnings & adjust response
packages/host-service/src/trpc/router/workspaces/workspaces.ts
Deleted local warnings accumulator, now console.warn is used immediately for PR materialization and terminal setup; workspacesRouter.create response no longer includes warnings and returns {workspace, terminals, agents, alreadyExists, txid}.
SDK resource and MCP caller typing updates
packages/sdk/src/resources/workspaces.ts, packages/mcp-v2/src/tools/workspaces/create.ts
WorkspaceCreateResult no longer exposes warnings: string[] and includes alreadyExists: boolean; MCP hostServiceCall generic updated to expect the revised create response shape.
Integration tests
packages/host-service/test/integration/workspace-create-pr.integration.test.ts
Removed assertions that checked result.warnings and renamed one test to remove mention of a user-visible warning; replaced some warning assertions with explicit branch expectations.

Sequence Diagram(s)

(omitted — changes are primarily logging and response-shape adjustments; no new multi-component control flow requiring additional visualization)

Possibly related PRs

  • superset-sh/superset#4643: Related change removing warnings propagation from workspaces.create and handling PR worktree materialization warnings.
  • superset-sh/superset#4495: Also bumps @superset/sdk package version; may overlap on package version changes.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 I hop through code with revision cheer,
Warnings now spoken, no list to appear,
SDK ticks forward, alpha eleven's the call,
Small logs whisper where arrays used to sprawl,
A bunny's nibble—cleanup for all.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and concisely summarizes the main changes: releasing alpha.11 and removing the internal warnings field from the public workspace create API.
Description check ✅ Passed The description is comprehensive and well-structured, covering rationale, changes, verification steps, and notes on what was left untouched, though it doesn't strictly follow the template sections.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch release-sdk-alpha-11

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

No issues found across 2 files

Re-trigger cubic

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 21, 2026

Greptile Summary

This PR cuts the @superset_sh/sdk 0.0.1-alpha.11 release by bumping packages/sdk/package.json and updating bun.lock. The PR-described type changes (WorkspaceCreateResult.warnings and the WorkspaceCreateParams.pr doc fix) are present in the source.

  • packages/sdk/package.json version is correctly incremented from alpha.10 → alpha.11; the publishConfig / private: true pattern is consistent with the alpha.8–10 convention of publishing from the built dist/ folder.
  • src/version.ts was not updated and still reads \"0.0.1-alpha.7\" — a constant used in the User-Agent header and X-Stainless-Package-Version header on every API call; this regression has been carried through alpha.8, alpha.9, and alpha.10 as well.
  • bun.lock also absorbs stale lock entries for apps/desktop and packages/host-service, which were already at the newer versions in their respective package.json files.

Confidence Score: 3/5

Safe to merge structurally, but the published package will continue to misreport its version to the server on every API call.

The src/version.ts constant has been frozen at "0.0.1-alpha.7" through four consecutive releases. It feeds the X-Stainless-Package-Version header and the client User-Agent string sent with every SDK request, so the server cannot distinguish alpha.8 through alpha.11 clients from alpha.7 clients. The fix is a one-line change, but without it the published alpha.11 package will propagate the same incorrect telemetry that alpha.8–10 already shipped.

packages/sdk/src/version.ts needs to be updated to match the version in package.json before this is published.

Important Files Changed

Filename Overview
packages/sdk/package.json Version bumped from 0.0.1-alpha.10 to 0.0.1-alpha.11; private: true + publishConfig pattern is consistent with prior alphas and the manual publish-from-dist workflow.
bun.lock SDK lock entry updated to alpha.11; also catches up stale entries for apps/desktop (1.10.1→1.10.2) and packages/host-service (0.8.9→0.8.10) which were already at those versions in their package.json files.

Sequence Diagram

sequenceDiagram
    participant C as SDK Client
    participant D as detect-platform.ts
    participant V as version.ts
    participant API as Superset API

    C->>D: getDefaultHeaders()
    D->>V: import VERSION
    V-->>D: "0.0.1-alpha.7" (stale)
    D-->>C: "{ X-Stainless-Package-Version: 0.0.1-alpha.7 }"
    C->>API: HTTP request with stale version headers
    Note over API: Sees alpha.7 instead of alpha.11
Loading
Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 1
bun.lock:113-114
Lock file silently absorbs unrelated workspace version changes

The diff shows `apps/desktop` bumped from `1.10.1``1.10.2` and `packages/host-service` from `0.8.9``0.8.10` inside this release PR, even though only `packages/sdk/package.json` is mentioned in the checklist. Those packages' `package.json` files were already at the newer versions on `main` (the lock file was just stale). The changes are benign — `bun install` caught them up — but it means this PR silently carries lock-file churn for two unrelated packages. Worth confirming these bumps were intentional before merge. Were the `apps/desktop` (1.10.2) and `packages/host-service` (0.8.10) version entries in `bun.lock` picked up intentionally, or are they incidental drift from running `bun install`?

Reviews (1): Last reviewed commit: "release(sdk): cut alpha.11" | Re-trigger Greptile

Comment thread bun.lock
Comment on lines 113 to +114
"name": "@superset/desktop",
"version": "1.10.1",
"version": "1.10.2",
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.

P2 Lock file silently absorbs unrelated workspace version changes

The diff shows apps/desktop bumped from 1.10.11.10.2 and packages/host-service from 0.8.90.8.10 inside this release PR, even though only packages/sdk/package.json is mentioned in the checklist. Those packages' package.json files were already at the newer versions on main (the lock file was just stale). The changes are benign — bun install caught them up — but it means this PR silently carries lock-file churn for two unrelated packages. Worth confirming these bumps were intentional before merge. Were the apps/desktop (1.10.2) and packages/host-service (0.8.10) version entries in bun.lock picked up intentionally, or are they incidental drift from running bun install?

Prompt To Fix With AI
This is a comment left during a code review.
Path: bun.lock
Line: 113-114

Comment:
Lock file silently absorbs unrelated workspace version changes

The diff shows `apps/desktop` bumped from `1.10.1``1.10.2` and `packages/host-service` from `0.8.9``0.8.10` inside this release PR, even though only `packages/sdk/package.json` is mentioned in the checklist. Those packages' `package.json` files were already at the newer versions on `main` (the lock file was just stale). The changes are benign — `bun install` caught them up — but it means this PR silently carries lock-file churn for two unrelated packages. Worth confirming these bumps were intentional before merge. Were the `apps/desktop` (1.10.2) and `packages/host-service` (0.8.10) version entries in `bun.lock` picked up intentionally, or are they incidental drift from running `bun install`?

How can I resolve this? If you propose a fix, please make it concise.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 21, 2026

🚀 Preview Deployment

🔗 Preview Links

Service Status Link
Neon Database (Neon) View Branch
Vercel API (Vercel) Open Preview
Vercel Web (Vercel) Open Preview
Vercel Marketing (Vercel) Open Preview
Vercel Admin (Vercel) Open Preview
Vercel Docs (Vercel) Open Preview

Preview updates automatically with new commits

The workspace-create result's warnings[] was added post-alpha.10 (never
published) and is consumed by nobody — desktop only reads cleanup/destroy
warnings, and the create warnings are already console.warn'd server-side.
Remove it from the host-service create return and the SDK / MCP type
surfaces so CLI / SDK / MCP don't expose this internal detail.
@saddlepaddle saddlepaddle changed the title release(sdk): cut alpha.11 release(sdk): cut alpha.11 + drop internal warnings from public create result May 21, 2026
… test

Follows the removal of warnings[] from the create result. The synthetic-ref
fallback is still covered by the branch-merge-config and HEAD-OID assertions;
the warning is now only console.warn'd, so the redundant warnings checks and
the 'user-visible warning' wording are removed.
Keeps the create result asserted (result.workspace.branch) so the binding
isn't an unused-variable lint warning after dropping the warnings checks.
@saddlepaddle saddlepaddle merged commit d3c23b7 into main May 21, 2026
16 checks passed
MocA-Love added a commit to MocA-Love/superset that referenced this pull request May 29, 2026
MocA-Love added a commit to MocA-Love/superset that referenced this pull request May 29, 2026
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.

1 participant