Fix Bug

Use the YouTrack MCP tools to fetch issue details. Call mcp__youtrack__get_issue with the issue ID (e.g., EXPOSED-1234).

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 Exposed Gradle module is relevant
• Affected databases - identify which databases are affected by the issue, these databases could be used for reproducer tests first
• 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., EXPOSED-1234 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 1.1: Save the information about the issue to file

Save the issue as a json file under issues directory.

Github issues should be saved in the /issues/github/ directory. The json file of the issue should be named as the issue number github-<id>.json

Youtrack issues should be saved in the /issues/youtrack/ directory. The json file of the issue should be named as the issue number youtrack-<id>.json

Step 2: Understand the Codebase Context

Before creating a branch, understand the affected area:

• Check the CLAUDE.md file in the root of the project to get basic information about the project.
• 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

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 main branch for creating new branch that will be used for the PR with the fix

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

Branch naming rules:

• For YouTrack issues: claude/EXPOSED-1234-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 what it checks (e.g., `requestWithEmptyBodyDoesntCausesNPE`)
  • Comment of the test should say what is the issues that caused necessity in this test (e.g., /* EXPOSED-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:

• Primary test modules: exposed-tests (JDBC) and exposed-r2dbc-tests (R2DBC)
  • Core DSL and DAO functionality tests go here
  • Many features that work with both drivers should have tests in both modules
• Extension module tests: If the bug is in an extension module, add tests there:
  • exposed-java-time, exposed-jodatime, exposed-kotlin-datetime for date/time issues
  • exposed-json for JSON column type issues
  • exposed-crypt for encrypted column issues
  • exposed-money for monetary amount issues
  • exposed-migration-jdbc, exposed-migration-r2dbc for migration issues
  • exposed-spring-boot-starter, spring-transaction for Spring integration issues
• Database-specific tests: If the feature is only relevant to specific databases, exclude other databases from the test using the excludeSettings parameter in test helper functions

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

./gradlew gradle :exposed-tests:test --tests "fully.qualified.TestClassName.methodName"

./gradlew gradle :exposed-r2dbc-tests:test --tests "fully.qualified.TestClassName.methodName"

Tests for specific databases could be run in isolation. For example for the H2 it will be the following commands:

./gradlew gradle :exposed-tests:test_h2_v2 --tests "fully.qualified.TestClassName.methodName"

./gradlew gradle :exposed-r2dbc-tests:test_h2_v2 --tests "fully.qualified.TestClassName.methodName"

You must verify that the tests are compiled without errors. The tests should fail according to the test assertions only.

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. All the commit message should follow the Conventional Commits format:

git add <test-file>
git commit -m "fix: <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 EXPOSED-XXXX.

Step 6: Plan 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

Present your analysis and plan to the user for review. Include:

• Root cause: What is causing the bug?
• Proposed fix: What changes will be made and where?
• Approach: Why is this the right solution?
• Scope: Confirm the fix is minimal and focused

Wait for user approval before implementing.

If user provides additional context, concerns, or feedback, take it into account, and repeat Step 6 with the new input

Step 7: Implement the Fix

After receiving user approval, implement the planned fix. 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 8: Validate the Fix

Run the reproducer test to confirm it now passes. Use the same test commands from Step 4:

# For JDBC tests
./gradlew :exposed-tests:test_h2_v2 --tests "fully.qualified.TestClassName.methodName"

# For R2DBC tests
./gradlew :exposed-r2dbc-tests:test_h2_v2 --tests "fully.qualified.TestClassName.methodName"

After confirming the reproducer passes, optionally run the broader test suite for the affected module:

# Run all H2 tests for the module
./gradlew :exposed-tests:test_h2_v2
./gradlew :exposed-r2dbc-tests:test_h2_v2

# Or test against specific database if the fix is database-specific
./gradlew :exposed-tests:test_postgres
./gradlew :exposed-r2dbc-tests:test_postgres

Refer to Step 4 for the full list of available test commands and database-specific test tasks.

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

Step 9: Code Style Validation

Exposed uses Detekt for code style validation. Run the linter to check for any issues:

./gradlew detekt

This validates code style across all modules according to the rules defined in detekt/detekt-config.yml.

If Detekt reports any issues, fix them before proceeding. The build requires zero issues (max issues: 0).

Step 10: API Documentation Update

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

./gradlew apiDump

This command updates the Dokka API documentation files to reflect the public API changes.

Stage any updated API files (.api files) along with the fix:

git add <api-files>

If no public API changed, skip this step.

Step 11: Update Documentation Website

If the PR introduces a new feature or changes existing public API behavior, update the documentation website to reflect these changes.

When to Update Documentation

Update documentation when:

• A new public API is added (new methods, properties, or classes)
• Existing API behavior changes in a way users would notice
• A new feature is introduced that users need to learn about
• An example or best practice in the docs no longer applies

Skip this step when:

• The change is purely internal (bug fix with no API changes)
• The change only affects test code
• The documentation already accurately describes the new behavior

Documentation Structure

The documentation website is located in the documentation-website directory:

• Topic files: documentation-website/Writerside/topics/ - XML files for each documentation page

How to Update

1. Identify the relevant topic:

   • For DSL features: Look in topics related to table definitions, queries, or DDL
   • For DAO features: Look in DAO-related topics
   • For database-specific features: Check vendor-specific documentation sections

2. Update the content:

   • Add new sections for new features with clear examples
   • Update existing examples if API changed
   • Add notes or callouts for important behavior changes

3. Test locally (if possible):

   • Check if there's a preview or build command in the documentation-website directory
   • Verify that examples compile and make sense in context

Prefer modifying existing documentation files over creating new ones. Ask for user approval before creating new files in the documentation website.

Step 12: Commit the Fix

Exposed uses Conventional Commits for commit messages. If the fix has no breaking changes the prefix is fix:. If it introduces a breaking change, use fix!:.

Be aware that the commit message will be validated on CI by the following regex: "^(build|chore|ci|deprecate|docs|feat|fix|perf|refactor|revert|style|test)(!)?(\([^\)]*\))?:\s?(EXPOSED-[0-9]+\s?)?.+$" (it's defined in .github/workflows/commit-message-validation.yml file)

Stage and commit the fix:

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

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

Step 13: 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. The title should follow the Conventional Commits format and the the commit message should have the following structure:

gh pr create --title "fix: <ISSUE-ID> <Short fix description>" --body "$(cat <<'EOF'
#### Description

**Summary of the change**: Provide a concise summary of this PR. Describe the changes made in a single sentence or short paragraph.

**Detailed description**:
- **Why**: Explain the reasons behind the changes. Why were they necessary?
- **What**: Detail what changes have been made in the PR.
- **How**: Describe how the changes were implemented, including any key aspects of the code modified or new features added.

---

#### Type of Change

Please mark the relevant options with an "X":
- [ ] Bug fix
- [ ] New feature
- [ ] Documentation update

Updates/remove existing public API methods:
- [ ] Is breaking change

Affected databases:
- [ ] MariaDB
- [ ] Mysql5
- [ ] Mysql8
- [ ] Oracle
- [ ] Postgres
- [ ] SqlServer
- [ ] H2
- [ ] SQLite

#### Checklist

- [ ] Unit tests are in place
- [ ] The build is green (including the Detekt check)
- [ ] All public methods affected by my PR has up to date API docs
- [ ] Documentation for my change is up to date

---

#### Related Issues


🤖 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 EXPOSED-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 14: Documentation Issue (if needed)

Assess whether the fix changes behavior that users rely on or that is described in the Exposed 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, update the documentation in documentation-website directory.