Fix Bug

If the YouTrack MCP server is not configured (tool calls fail), instruct the user to set it up:

claude mcp add --header "Authorization: Bearer <token>" --transport http youtrack https://youtrack.jetbrains.com/mcp

The permanent token can be created in JetBrains Hub account security settings (linked from YouTrack profile).

From the issue, extract:

• Title and description of the bug
• Steps to reproduce (if provided)
• Expected vs actual behavior
• Affected module(s) — identify which Ktor Gradle module is relevant
• Issue comments — read through comments as they might contain useful information (reproduction details, workarounds, related context)
• Issue ID for branch naming and commit messages (e.g., KTOR-9352 or #123)

Step 1: Assign Issue and Set In Progress

For YouTrack issues only, update the issue status to reflect that work is starting:

1. Call mcp__youtrack__get_current_user to get the current user's login.
2. Call mcp__youtrack__change_issue_assignee to assign the issue to the current user.
3. Call mcp__youtrack__update_issue with customFields: {"State": "In Progress"} to mark work as started.

If any of these calls fail because the YouTrack MCP is not configured, inform the user how to set it up (see "Fetching YouTrack Issues" section above) and continue with the rest of the workflow — issue tracking updates are not blocking.

Skip this step for GitHub-only issues.

Step 2: Understand the Codebase Context

Before creating a branch, understand the affected area:

• Identify the Gradle module from the issue description or affected APIs
• Read existing tests in that module to understand test patterns and conventions
• Identify whether this needs a unit test or integration test based on the bug nature
• Remember: this project uses a flattened Gradle structure (e.g., ktor-client/ktor-client-curl → :ktor-client-curl)

Use the Explore agent or direct file reads to understand:

• The relevant source code where the bug likely lives
• Existing test infrastructure (test utilities, base classes, server setup patterns)
• How similar tests are structured in the same module

Step 3: Create branch

Determine the base branch:

• Use release/3.x for bug fixes that do not introduce new public APIs (patch release)
• Use main for fixes that require new public APIs or are targeted at the next minor release

git checkout <base-branch> && git pull && git checkout -b claude/<issue-id>-<short-description>

Branch naming rules:

• For YouTrack issues: claude/KTOR-9352-short-description
• For GitHub issues: claude/123-short-description
• The short description is 3 words max, lowercase, hyphenated, derived from the issue title

Step 4: Write a Failing Reproducer Test

Write a test that demonstrates the bug as described in the issue. The goal is:

• Minimal: Only test the specific buggy behavior, nothing extra
• Clear: Test name in backticks should describe the bug (e.g., `KTOR-9352 request with empty body causes NPE`)
• Failing: The test MUST fail on the current codebase to confirm the bug exists

Place the test appropriately:

• Near existing tests for the same module/feature
• If no test suite exists for this area, create a new test class following the module's conventions
• For integration tests, place near other integration tests in the module
• For unit tests, place near other unit tests
• If the bug is platform-specific, place the test in the corresponding platform source set (e.g., jvm/test, posix/test)
• If the bug affects common/shared code, place the test in common/test so it runs on all platforms

After writing the test, run it to confirm it fails:

./gradlew :module-name:jvmTest --tests "fully.qualified.TestClassName.methodName"

If the test is in common/test or touches multiplatform code, also run on other affected platforms:

./gradlew :module-name:allTests

If the test passes (bug is already fixed or test doesn't reproduce correctly):

• Re-read the issue carefully
• Adjust the test to more precisely match the reported scenario
• If the bug truly cannot be reproduced, inform the user and stop

Step 5: Commit the Reproducer

Stage and commit the failing test:

git add <test-file>
git commit -m "<ISSUE-ID> Add failing test for <short bug description>

Co-Authored-By: Claude Opus 4.6 <[email protected]>"

For GitHub issues, use #NUMBER in the commit message. For YouTrack, use KTOR-XXXX.

Step 6: Plan and Implement the Fix

Analyze the bug based on what you learned from the issue and the reproducer test:

• Trace the code path that leads to the failure
• Identify the root cause
• Plan the minimal fix

Implement the fix directly — do not present the plan to the user for approval. Keep changes minimal and focused:

• Fix only the bug, do not refactor surrounding code
• Do not add features beyond what's needed
• Preserve existing comments and code style

Step 7: Validate the Fix

Run the reproducer test to confirm it passes:

./gradlew :module-name:jvmTest --tests "fully.qualified.TestClassName.methodName"

Then run the full test suite for the affected module. Choose the scope based on where the changes are:

• JVM-only changes (test and fix both in jvm/):

  ./gradlew :module-name:jvmTest
  

• Common/multiplatform changes (test or fix in common/, or the bug affects multiple platforms):

  ./gradlew :module-name:allTests
  

If any tests fail, investigate and fix. Do not skip or disable tests.

Step 8: Format and Lint

./gradlew :module-name:formatKotlin :module-name:lintKotlin

Fix any lint issues before proceeding.

Step 9: ABI Validation

If the fix changed any public or protected API (new methods, changed signatures, etc.):

./gradlew :module-name:checkLegacyAbi

If it fails, update the ABI dumps:

./gradlew :module-name:updateLegacyAbi

Stage the updated .api files along with the fix.

If no public API changed, skip this step.

Step 10: Commit the Fix

git add <changed-files>
git commit -m "<ISSUE-ID> <Imperative description of the fix>

Co-Authored-By: Claude Opus 4.6 <[email protected]>"

Step 11: Push and Create PR

Push the branch and create a PR:

git push -u origin claude/<issue-id>-<short-description>

Create the PR targeting the base branch chosen in Step 3 (main or release/3.x):

gh pr create --title "<ISSUE-ID> <Short fix description>" --body "$(cat <<'EOF'
## Summary
- Fixes <link-to-issue>
- <1-2 bullet points describing the root cause and fix>

Closes <issue-reference>

## Test plan
- Added failing reproducer test that validates the fix
- All existing tests in the module continue to pass

🤖 Generated with [Claude Code](https://claude.com/claude-code)
EOF
)"

The Closes line auto-closes the issue when the PR is merged for GitHub issues only:

• For GitHub issues: Closes #NUMBER
• For YouTrack issues: include KTOR-XXXX as a plain cross-reference (GitHub will not close YouTrack tickets automatically)

Report the PR URL to the user when done.

After the PR is created, for YouTrack issues only, update the issue state:

Call mcp__youtrack__update_issue with customFields: {"State": "Ready for Review"} to signal the fix is ready for code review.

If the YT MCP call fails, skip silently — the status update is not blocking.

Step 12: Documentation Issue (if needed)

Assess whether the fix changes behavior that users rely on or that is described in the Ktor documentation. A documentation update is needed when:

• A public API signature changed (new parameter, changed default, new overload)
• Behavior that users observe changed (different error message, different default, different timing)
• A workaround that users might have adopted is no longer necessary
• A new feature or configuration option was added as part of the fix

If none of the above apply (e.g., an internal-only fix, a crash fix with no API change), skip this step.

When documentation is needed, create a GitHub issue in the ktorio/ktor-documentation repository:

gh issue create --repo ktorio/ktor-documentation \
  --title "Document behavior change: <ISSUE-ID> <short description>" \
  --body "$(cat <<'EOF'
## Context

PR: <link-to-the-PR-created-in-step-11>
Issue: <link-to-the-original-issue>

## What changed

<1-3 sentences explaining what behavior changed and why>

## What should be documented

<Describe specifically what a technical writer should add or update in the docs.
Include the affected API, module, and any relevant configuration options.>

## Suggested code snippet

```kotlin
// Include a short usage example if relevant, showing the correct new usage
```

🤖 Generated with [Claude Code](https://claude.com/claude-code)
EOF
)"

Report the documentation issue URL to the user alongside the PR URL.