CMR-11039: reshard API validates that index exists #2372

zimzoom · 2026-01-15T19:17:42Z

Overview

What is the objective?

Fix bug that allows calling the start reshard endpoint on an index that no longer exists.

What are the changes?

Added new validation step for checking existence of index/alias earlier in flow, at the API receiving function where it was already doing other validation.

What areas of the application does this impact?

bootstrap-app

Required Checklist

[x ] New and existing unit and int tests pass locally and remotely
[x ] clj-kondo has been run locally and all errors in changed files are corrected
I have commented my code, particularly in hard-to-understand areas
I have made changes to the documentation (if necessary)
[x ] My changes generate no new warnings

Additional Checklist

[x ] I have removed unnecessary/dead code and imports in files I have changed
I have cleaned up integration tests by doing one or more of the following:
- migrated any are2 tests to are3 in files I have changed
- de-duped, consolidated, removed dead int tests
- transformed applicable int tests into unit tests
- reduced number of system state resets by updating fixtures. Ex) (use-fixtures :each (ingest/reset-fixture {})) to be :once instead of :each

Summary by CodeRabbit

Bug Fixes
- Index existence is now validated as part of resharding operations, preventing attempts to operate on missing indexes and reducing failed jobs.
- Error messages for missing indexes now include the Elasticsearch cluster name, giving clearer context in 404 responses and simplifying troubleshooting.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2026-01-15T19:17:58Z

📝 Walkthrough

Walkthrough

The resharding API now validates that the Elasticsearch index or alias exists before starting resharding. A new private function obtains an ES connection and checks index existence, returning a not-found service error that includes the Elasticsearch cluster name when the index is missing.

Changes

Cohort / File(s)	Summary
Resharding API Implementation `bootstrap-app/src/cmr/bootstrap/api/resharding.clj`	Adds `es-helper` and `es-index` requires; adds `validate-index-exists` (uses `es-index/context->conn` and `es-helper/exists?`); calls validation at start of `start` flow; minor require reflow
Integration Test `system-int-test/test/cmr/system_int_test/bootstrap/reshard_index_test.clj`	Updates test expectation for the "index must exist" case to include Elasticsearch cluster name in the error message

Sequence Diagram(s)

sequenceDiagram
    participant Client as Client
    participant API as Resharding API
    participant ESIdx as es-index (conn)
    participant ES as Elasticsearch
    Client->>API: POST /reshard/start (index)
    API->>API: validate-index-exists(context, index, es-cluster-name)
    API->>ESIdx: context->conn(context, es-cluster-name)
    ESIdx->>ES: exists?(index or alias)
    ES-->>ESIdx: exists? result (true/false)
    ESIdx-->>API: connection + exists? result
    alt index exists
        API->>API: proceed with existing validations and start resharding
        API-->>Client: 200/started
    else index missing
        API-->>Client: 404 "Index or alias [name] does not exist in the Elasticsearch cluster [cluster-name]"
    end

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Cmr 10769 - Resharding start endpoint #2316 — Modifies the same resharding start function logic in resharding.clj
CMR-11024: Fix reshard logic to have granules save to both old and new index during reshard #2370 — Updates resharding test expectations/error handling in reshard_index_test.clj

Suggested labels

hacktoberfest-accepted

Suggested reviewers

eereiter
daniel-zamora
ygliuvt

Poem

🐰 I checked the index before the hop,
No missing shards to make me stop,
With a hop and a sniff and a careful cheer,
The cluster's named — the path is clear! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically summarizes the main change: adding index existence validation to the reshard API.
Description check	✅ Passed	The description covers the objective, changes, and impacted areas with reasonable completeness, though some optional checklist items are unchecked.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

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.}

daniel-zamora · 2026-01-16T14:50:35Z

bootstrap-app/src/cmr/bootstrap/api/resharding.clj

  (when (string/blank? es-cluster-name)
    (errors/throw-service-error :bad-request "Empty elastic cluster name is not allowed.")))

+(defn- validate-index-exists


jmaeng72 · 2026-01-16T15:49:42Z

bootstrap-app/src/cmr/bootstrap/api/resharding.clj

+  [context index es-cluster-name]
+  (let [conn (es-index/context->conn context es-cluster-name)]
+    (when-not (or (es-helper/exists? conn index)
+                  (es-helper/alias-exists? conn index))


I do not think we allow resharding based on alias names. Can you check this?

Good call, I tested it and it does not allow aliases, it returns index doesn't exist error. I will remove the alias check to avoid confusion

codecov-commenter · 2026-01-16T22:24:00Z

Codecov Report

❌ Patch coverage is 12.50000% with 7 lines in your changes missing coverage. Please review.
✅ Project coverage is 29.13%. Comparing base (1f955f4) to head (cfc07e4).
⚠️ Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
bootstrap-app/src/cmr/bootstrap/api/resharding.clj	12.50%	7 Missing ⚠️

❗ There is a different number of reports uploaded between BASE (1f955f4) and HEAD (cfc07e4). Click for more details.

HEAD has 8 uploads less than BASE

Flag BASE (1f955f4) HEAD (cfc07e4)

12 4

Additional details and impacted files

@@             Coverage Diff             @@
##           master    #2372       +/-   ##
===========================================
- Coverage   58.01%   29.13%   -28.88%     
===========================================
  Files        1063     1003       -60     
  Lines       72765    69349     -3416     
  Branches     2113     1196      -917     
===========================================
- Hits        42215    20207    -22008     
- Misses      28580    48007    +19427     
+ Partials     1970     1135      -835

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

CMR-11039: reshard API validates that index exists

847de00

jceaser self-requested a review January 15, 2026 21:26

jceaser approved these changes Jan 15, 2026

View reviewed changes

zimzoom requested review from eereiter, jceaser and jmaeng72 January 15, 2026 21:29

daniel-zamora reviewed Jan 16, 2026

View reviewed changes

daniel-zamora approved these changes Jan 16, 2026

View reviewed changes

jmaeng72 reviewed Jan 16, 2026

View reviewed changes

CMR-11039: pr feedback, remove alias check

cfc07e4

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

CMR-11039: reshard API validates that index exists #2372

CMR-11039: reshard API validates that index exists #2372

zimzoom commented Jan 15, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jan 15, 2026 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Uh oh!

daniel-zamora Jan 16, 2026

Uh oh!

jmaeng72 Jan 16, 2026

Uh oh!

zimzoom Jan 16, 2026

Uh oh!

codecov-commenter commented Jan 16, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

CMR-11039: reshard API validates that index exists #2372

Are you sure you want to change the base?

CMR-11039: reshard API validates that index exists #2372

Conversation

zimzoom commented Jan 15, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

What is the objective?

What are the changes?

What areas of the application does this impact?

Required Checklist

Additional Checklist

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jan 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Uh oh!

daniel-zamora Jan 16, 2026

Choose a reason for hiding this comment

Uh oh!

jmaeng72 Jan 16, 2026

Choose a reason for hiding this comment

Uh oh!

zimzoom Jan 16, 2026

Choose a reason for hiding this comment

Uh oh!

codecov-commenter commented Jan 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

zimzoom commented Jan 15, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 15, 2026 •

edited

Loading

codecov-commenter commented Jan 16, 2026 •

edited

Loading