René's URL Explorer Experiment


Title: fix(api): widen the cancel-execution reason contract to what the route emits by waleedlatif1 · Pull Request #6592 · simstudioai/sim · GitHub

Open Graph Title: fix(api): widen the cancel-execution reason contract to what the route emits by waleedlatif1 · Pull Request #6592 · simstudioai/sim

X Title: fix(api): widen the cancel-execution reason contract to what the route emits by waleedlatif1 · Pull Request #6592 · simstudioai/sim

Description: Summary cancelWorkflowExecutionReasonSchema enumerated only the five reasons the cancellation service produces, but the internal cancel route mints four more (queue_cancelled, already_cancelled, active_resume_signal_failed, cancellation_not_finalized). requestJson validates every 2xx against the contract, so a stop that genuinely applied threw on the client — killing pollForTerminalExecution and rolling back the optimistic cancelling row in the logs list Regression vs main, introduced by #5273, which tightened reason from z.string().optional() to the enum without touching the route. Not on main, so it never reached prod Kept the service enum narrow for the public v2 contract — cancelWorkflowRun delegates wholly to the service and structurally cannot emit the other four, and the v2 OpenAPI schema documents the enum value by value. Added a superset enum for the internal contract instead. check:openapi confirms the published spec is unchanged Routed the route's seven success bodies through one contract-typed constructor, so an unknown reason is now a compile error rather than a runtime surprise Deleted the dead duplicate cancelWorkflowExecutionContract in contracts/logs.ts — zero importers, and a stricter wrong copy (narrow enum and reason required), waiting to reintroduce this exact bug Type of Change Bug fix Testing route.test.ts now drives every case through a wrapper that parses each success body against the contract, so all 47 tests are contract-checked Verified the tests can fail: reverting the enum turns 11 red, including "treats an already-cancelled execution as an idempotent success" — the user-visible bug Verified the compile-time guard: an invented reason fails typecheck at a site no test exercises (paused_database_cancel_failed appears in zero tests, so the runtime wrapper alone did not cover it) 2137 tests pass across lib/api, app/api/workflows, hooks/queries, lib/execution, lib/logs check:api-validation:strict, check:openapi, and bun run lint all pass Follow-up (not in this PR) 968 of 1098 route.ts files export a raw withRouteHandler, and 637 of those already parseRequest a contract while never validating their response — this route was one instance. The tractable lever is a ratcheted counter in scripts/check-api-validation-contracts.ts for that class. Migrating this route to defineInternalJsonRoute is separately blocked: no builder auth policy covers checkHybridAuth, and its ~600 lines of orchestration have no application use case yet. Checklist Code follows project style guidelines Self-reviewed my changes Tests added/updated and passing No new warnings introduced I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

Open Graph Description: Summary cancelWorkflowExecutionReasonSchema enumerated only the five reasons the cancellation service produces, but the internal cancel route mints four more (queue_cancelled, already_cancelled, a...

X Description: Summary cancelWorkflowExecutionReasonSchema enumerated only the five reasons the cancellation service produces, but the internal cancel route mints four more (queue_cancelled, already_cancelled, a...

Opengraph URL: https://github.com/simstudioai/sim/pull/6592

X: @github

direct link

Domain: github.com

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react-reconciler,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@d5750093facf
route-pattern/:user_id/:repository/pull/:id/files(.:format)
route-controllerpull_requests
route-actionfiles
fetch-noncev2:5f4f9d83-2111-f539-1e5d-c9e6bec6a86b
current-catalog-service-hashae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b
request-idBB4E:295278:5CA341:83A6EC:6AFB42DB
html-safe-nonce67d53cd2089d97a5fd9955dd8b74350123b3673f18251439d64e7886d3cc79c4
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCQjRFOjI5NTI3ODo1Q0EzNDE6ODNBNkVDOjZBRkI0MkRCIiwidmlzaXRvcl9pZCI6IjE3OTY1Mzk3OTMyNzQ1MjAyODMiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmac86a6a88bc2a0d969c323f9f1aaef39aee45fbec01e477fde56ddf0c6d32ab736
hovercard-subject-tagpull_request:4259081299
github-keyboard-shortcutsrepository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///pull_requests/show/files
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/simstudioai/sim/pull/6592/files
twitter:imagehttps://avatars.githubusercontent.com/u/40672544?s=400&v=4
twitter:cardsummary_large_image
og:imagehttps://avatars.githubusercontent.com/u/40672544?s=400&v=4
og:image:altSummary cancelWorkflowExecutionReasonSchema enumerated only the five reasons the cancellation service produces, but the internal cancel route mints four more (queue_cancelled, already_cancelled, a...
og:site_nameGitHub
og:typeobject
hostnamegithub.com
expected-hostnamegithub.com
Noned849b928f455c800985398e7f1b659425adb312a5fa14fba5d9a14e62e9fe5dd
turbo-cache-controlno-preview
diff-viewunified
go-importgithub.com/simstudioai/sim git https://github.com/simstudioai/sim.git
octolytics-dimension-user_id199344406
octolytics-dimension-user_loginsimstudioai
octolytics-dimension-repository_id912559512
octolytics-dimension-repository_nwosimstudioai/sim
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id912559512
octolytics-dimension-repository_network_root_nwosimstudioai/sim
turbo-body-classeslogged-out env-production page-responsive full-width
disable-turbotrue
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
releasea6c2f87cbcb6414452377b4967858ed6a66f1109
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/simstudioai/sim/pull/6592/files#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fsimstudioai%2Fsim%2Fpull%2F6592%2Ffiles
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fsimstudioai%2Fsim%2Fpull%2F6592%2Ffiles
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fpull_requests%2Fshow%2Ffiles&source=header-repo&source_repo=simstudioai%2Fsim
Reloadhttps://github.com/simstudioai/sim/pull/6592/files
Reloadhttps://github.com/simstudioai/sim/pull/6592/files
Reloadhttps://github.com/simstudioai/sim/pull/6592/files
simstudioaihttps://github.com/simstudioai
simhttps://github.com/simstudioai/sim
Codehttps://github.com/simstudioai/sim
Issues129 (129)https://github.com/simstudioai/sim/issues
Pull requests200 (200)https://github.com/simstudioai/sim/pulls
Actionshttps://github.com/simstudioai/sim/actions
Projectshttps://github.com/simstudioai/sim/projects
Security and qualityhttps://github.com/simstudioai/sim/security
Insightshttps://github.com/simstudioai/sim/pulse
Sign up for GitHub https://github.com/signup?return_to=%2Fsimstudioai%2Fsim%2Fissues%2Fnew%2Fchoose
terms of servicehttps://docs.github.com/terms
privacy statementhttps://docs.github.com/privacy
Sign inhttps://github.com/login?return_to=%2Fsimstudioai%2Fsim%2Fissues%2Fnew%2Fchoose
waleedlatif1https://github.com/waleedlatif1
staginghttps://github.com/simstudioai/sim/tree/staging
fix/cancel-reason-contracthttps://github.com/simstudioai/sim/tree/fix/cancel-reason-contract
Conversation 3 https://github.com/simstudioai/sim/pull/6592
Commits 1 https://github.com/simstudioai/sim/pull/6592/commits
Checks 30 https://github.com/simstudioai/sim/pull/6592/checks
Files changed https://github.com/simstudioai/sim/pull/6592/files
Please reload this pagehttps://github.com/simstudioai/sim/pull/6592/files
fix(api): widen the cancel-execution reason contract to what the route emits https://github.com/simstudioai/sim/pull/6592/files#top
Show all changes 1 commit https://github.com/simstudioai/sim/pull/6592/files
fac8b3b fix(api): widen the cancel-execution reason contract to what the rout… waleedlatif1 Aug 12, 2026 https://github.com/simstudioai/sim/pull/6592/commits/fac8b3b4eb4247468cc44014d6acace26f91cf68
Clear filters https://github.com/simstudioai/sim/pull/6592/files
Please reload this pagehttps://github.com/simstudioai/sim/pull/6592/files
Please reload this pagehttps://github.com/simstudioai/sim/pull/6592/files
route.test.ts https://github.com/simstudioai/sim/pull/6592/files#diff-13ee98aff8faa23229b43caf956471767ba043eb58fe9dd3dae7f24b40d19886
route.ts https://github.com/simstudioai/sim/pull/6592/files#diff-6276e3e602de8f65c65d92c4b1d7319a3385ffc7bd214947a94b39a60a0a40bd
logs.ts https://github.com/simstudioai/sim/pull/6592/files#diff-ec222ffca9b6d4eaf1d8ef6dd498a8731506841d4ed4a81c404815b9322b1b54
workflows.test.ts https://github.com/simstudioai/sim/pull/6592/files#diff-ad98890884605487fbf54889ea89ce46d9ce93d8b7e6cdbb2145bf3854ae4984
workflows.ts https://github.com/simstudioai/sim/pull/6592/files#diff-29bb15f0acc725362f6756e12f9ffce0a49b3d2068334d2e10f18e5986e46411
cancel-workflow-execution.ts https://github.com/simstudioai/sim/pull/6592/files#diff-9d9920803ab82adaed6a74e928462a1f717dca01c69da3757d211c0cdb215637
apps/sim/app/api/workflows/[id]/executions/[executionId]/cancel/route.test.tshttps://github.com/simstudioai/sim/pull/6592/files#diff-13ee98aff8faa23229b43caf956471767ba043eb58fe9dd3dae7f24b40d19886
View file https://github.com/simstudioai/sim/blob/fac8b3b4eb4247468cc44014d6acace26f91cf68/apps/sim/app/api/workflows/%5Bid%5D/executions/%5BexecutionId%5D/cancel/route.test.ts
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/simstudioai/sim/pull/6592/{{ revealButtonHref }}
https://github.com/simstudioai/sim/pull/6592/files#diff-13ee98aff8faa23229b43caf956471767ba043eb58fe9dd3dae7f24b40d19886
https://github.com/simstudioai/sim/pull/6592/files#diff-13ee98aff8faa23229b43caf956471767ba043eb58fe9dd3dae7f24b40d19886
apps/sim/app/api/workflows/[id]/executions/[executionId]/cancel/route.tshttps://github.com/simstudioai/sim/pull/6592/files#diff-6276e3e602de8f65c65d92c4b1d7319a3385ffc7bd214947a94b39a60a0a40bd
View file https://github.com/simstudioai/sim/blob/fac8b3b4eb4247468cc44014d6acace26f91cf68/apps/sim/app/api/workflows/%5Bid%5D/executions/%5BexecutionId%5D/cancel/route.ts
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/simstudioai/sim/pull/6592/{{ revealButtonHref }}
https://github.com/simstudioai/sim/pull/6592/files#diff-6276e3e602de8f65c65d92c4b1d7319a3385ffc7bd214947a94b39a60a0a40bd
https://github.com/simstudioai/sim/pull/6592/files#diff-6276e3e602de8f65c65d92c4b1d7319a3385ffc7bd214947a94b39a60a0a40bd
https://github.com/simstudioai/sim/pull/6592/files#diff-6276e3e602de8f65c65d92c4b1d7319a3385ffc7bd214947a94b39a60a0a40bd
https://github.com/simstudioai/sim/pull/6592/files#diff-6276e3e602de8f65c65d92c4b1d7319a3385ffc7bd214947a94b39a60a0a40bd
https://github.com/simstudioai/sim/pull/6592/files#diff-6276e3e602de8f65c65d92c4b1d7319a3385ffc7bd214947a94b39a60a0a40bd
https://github.com/simstudioai/sim/pull/6592/files#diff-6276e3e602de8f65c65d92c4b1d7319a3385ffc7bd214947a94b39a60a0a40bd
https://github.com/simstudioai/sim/pull/6592/files#diff-6276e3e602de8f65c65d92c4b1d7319a3385ffc7bd214947a94b39a60a0a40bd
https://github.com/simstudioai/sim/pull/6592/files#diff-6276e3e602de8f65c65d92c4b1d7319a3385ffc7bd214947a94b39a60a0a40bd
https://github.com/simstudioai/sim/pull/6592/files#diff-6276e3e602de8f65c65d92c4b1d7319a3385ffc7bd214947a94b39a60a0a40bd
https://github.com/simstudioai/sim/pull/6592/files#diff-6276e3e602de8f65c65d92c4b1d7319a3385ffc7bd214947a94b39a60a0a40bd
https://github.com/simstudioai/sim/pull/6592/files#diff-6276e3e602de8f65c65d92c4b1d7319a3385ffc7bd214947a94b39a60a0a40bd
https://github.com/simstudioai/sim/pull/6592/files#diff-6276e3e602de8f65c65d92c4b1d7319a3385ffc7bd214947a94b39a60a0a40bd
https://github.com/simstudioai/sim/pull/6592/files#diff-6276e3e602de8f65c65d92c4b1d7319a3385ffc7bd214947a94b39a60a0a40bd
https://github.com/simstudioai/sim/pull/6592/files#diff-6276e3e602de8f65c65d92c4b1d7319a3385ffc7bd214947a94b39a60a0a40bd
https://github.com/simstudioai/sim/pull/6592/files#diff-6276e3e602de8f65c65d92c4b1d7319a3385ffc7bd214947a94b39a60a0a40bd
https://github.com/simstudioai/sim/pull/6592/files#diff-6276e3e602de8f65c65d92c4b1d7319a3385ffc7bd214947a94b39a60a0a40bd
https://github.com/simstudioai/sim/pull/6592/files#diff-6276e3e602de8f65c65d92c4b1d7319a3385ffc7bd214947a94b39a60a0a40bd
apps/sim/lib/api/contracts/logs.tshttps://github.com/simstudioai/sim/pull/6592/files#diff-ec222ffca9b6d4eaf1d8ef6dd498a8731506841d4ed4a81c404815b9322b1b54
View file https://github.com/simstudioai/sim/blob/fac8b3b4eb4247468cc44014d6acace26f91cf68/apps/sim/lib/api/contracts/logs.ts
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/simstudioai/sim/pull/6592/{{ revealButtonHref }}
https://github.com/simstudioai/sim/pull/6592/files#diff-ec222ffca9b6d4eaf1d8ef6dd498a8731506841d4ed4a81c404815b9322b1b54
https://github.com/simstudioai/sim/pull/6592/files#diff-ec222ffca9b6d4eaf1d8ef6dd498a8731506841d4ed4a81c404815b9322b1b54
https://github.com/simstudioai/sim/pull/6592/files#diff-ec222ffca9b6d4eaf1d8ef6dd498a8731506841d4ed4a81c404815b9322b1b54
https://github.com/simstudioai/sim/pull/6592/files#diff-ec222ffca9b6d4eaf1d8ef6dd498a8731506841d4ed4a81c404815b9322b1b54
https://github.com/simstudioai/sim/pull/6592/files#diff-ec222ffca9b6d4eaf1d8ef6dd498a8731506841d4ed4a81c404815b9322b1b54
apps/sim/lib/api/contracts/workflows.test.tshttps://github.com/simstudioai/sim/pull/6592/files#diff-ad98890884605487fbf54889ea89ce46d9ce93d8b7e6cdbb2145bf3854ae4984
View file https://github.com/simstudioai/sim/blob/fac8b3b4eb4247468cc44014d6acace26f91cf68/apps/sim/lib/api/contracts/workflows.test.ts
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/simstudioai/sim/pull/6592/{{ revealButtonHref }}
https://github.com/simstudioai/sim/pull/6592/files#diff-ad98890884605487fbf54889ea89ce46d9ce93d8b7e6cdbb2145bf3854ae4984
https://github.com/simstudioai/sim/pull/6592/files#diff-ad98890884605487fbf54889ea89ce46d9ce93d8b7e6cdbb2145bf3854ae4984
apps/sim/lib/api/contracts/workflows.tshttps://github.com/simstudioai/sim/pull/6592/files#diff-29bb15f0acc725362f6756e12f9ffce0a49b3d2068334d2e10f18e5986e46411
View file https://github.com/simstudioai/sim/blob/fac8b3b4eb4247468cc44014d6acace26f91cf68/apps/sim/lib/api/contracts/workflows.ts
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/simstudioai/sim/pull/6592/{{ revealButtonHref }}
https://github.com/simstudioai/sim/pull/6592/files#diff-29bb15f0acc725362f6756e12f9ffce0a49b3d2068334d2e10f18e5986e46411
https://github.com/simstudioai/sim/pull/6592/files#diff-29bb15f0acc725362f6756e12f9ffce0a49b3d2068334d2e10f18e5986e46411
https://github.com/simstudioai/sim/pull/6592/files#diff-29bb15f0acc725362f6756e12f9ffce0a49b3d2068334d2e10f18e5986e46411
apps/sim/lib/execution/cancel-workflow-execution.tshttps://github.com/simstudioai/sim/pull/6592/files#diff-9d9920803ab82adaed6a74e928462a1f717dca01c69da3757d211c0cdb215637
View file https://github.com/simstudioai/sim/blob/fac8b3b4eb4247468cc44014d6acace26f91cf68/apps/sim/lib/execution/cancel-workflow-execution.ts
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/simstudioai/sim/pull/6592/{{ revealButtonHref }}
https://github.com/simstudioai/sim/pull/6592/files#diff-9d9920803ab82adaed6a74e928462a1f717dca01c69da3757d211c0cdb215637
https://github.com/simstudioai/sim/pull/6592/files#diff-9d9920803ab82adaed6a74e928462a1f717dca01c69da3757d211c0cdb215637
Please reload this pagehttps://github.com/simstudioai/sim/pull/6592/files
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.