feat(policy): Add sort functionality on key_status by elizabethhealy · Pull Request #3845 · opentdf/platform

elizabethhealy · 2026-08-06T20:41:11Z

Proposed Changes

Adds the ability to sort on key status

Checklist

I have added or updated unit tests
I have added or updated integration tests (if appropriate)
I have added or updated documentation

Testing Instructions

Summary by CodeRabbit

New Features
- Added sorting of KAS keys by key status.
- Supports ascending and descending alphabetical ordering by status name.
- Added a new key-status sorting option to the API.
- Updated API documentation to describe the new option and status ordering.
Tests
- Added coverage validating key-status sorting in ascending and descending order.
- Verified ordering across active, rotated, and unspecified key statuses.

coderabbitai · 2026-08-06T20:41:19Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: d90e6a0f-1534-4e1c-aedc-055c35929616

📥 Commits

Reviewing files that changed from the base of the PR and between 6072327 and a817b59.

📒 Files selected for processing (1)

service/integration/kas_registry_key_test.go

📝 Walkthrough

Walkthrough

Adds KEY_STATUS sorting for KAS key listings. The change updates the proto and API documentation, exposes the option in otdfctl, maps it to SQL ordering, and adds unit and integration coverage for ascending and descending results.

Changes

KAS key status sorting

Layer / File(s)	Summary
Sorting contract and CLI wiring `service/policy/kasregistry/key_access_server_registry.proto`, `otdfctl/pkg/handlers/kas-keys.go`, `docs/grpc/index.html`, `docs/openapi/.../key_access_server_registry.openapi.yaml`, `docs/openapi/policy/objects.openapi.yaml`, `docs/openapi/policy/unsafe/unsafe.openapi.yaml`, `service/policy/objects.proto`	Adds `SORT_KAS_KEYS_TYPE_KEY_STATUS = 4`, accepts `key_status` as a CLI sort field, and documents the required status mapping.
Database sort mapping and ordering `service/policy/db/utils.go`, `service/policy/db/queries/key_access_server_registry.sql`, `service/policy/db/key_access_server_registry.sql.go`	Maps the enum to `key_status` and applies ascending or descending alphabetical ordering.
Sort mapping and integration validation `service/policy/db/utils_test.go`, `service/integration/kas_registry_key_test.go`	Tests enum-to-SQL mapping and verifies ordering across ACTIVE and ROTATED keys.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Sequence Diagram(s)

sequenceDiagram
  participant CLI as otdfctl
  participant API as KAS key listing API
  participant DB as listKeys SQL query
  CLI->>API: Request key_status sort
  API->>DB: Apply key-status sort enum
  DB-->>API: Return ordered KAS keys

Possibly related PRs

opentdf/platform#3287: Changes the same KAS registry sorting infrastructure.
opentdf/platform#3344: Extends the KAS key sorting implementation through the same enum, SQL, handler, and test paths.

Suggested labels: comp:db, comp:policy, size/s, docs

Suggested reviewers: c-r33d

Poem

I sort the keys by status bright,
ACTIVE first or ROTATED right.
ASC and DESC now guide the way,
Tests check the order every day.
— A diligent rabbit 🐇

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly describes the primary change: adding sorting by key_status.
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.

✨ Finishing Touches 💡 1

📝 Generate docstrings 💡

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch dspx-3798-sort-on-key-status

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

github-actions · 2026-08-07T14:03:32Z

Benchmark results, click to expand

Benchmark authorization.GetDecisions Results:

Metric	Value
Approved Decision Requests	1000
Denied Decision Requests	0
Total Time	208.312958ms

Benchmark authorization.v2.GetMultiResourceDecision Results:

Metric	Value
Approved Decision Requests	1000
Denied Decision Requests	0
Total Time	110.967447ms

Benchmark Statistics

Name	№ Requests	Avg Duration	Min Duration	Max Duration

Bulk Benchmark Results

Metric	Value
Total Decrypts	100
Successful Decrypts	100
Failed Decrypts	0
Total Time	442.030032ms
Throughput	226.23 requests/second

TDF3 Benchmark Results:

Metric	Value
Total Requests	5000
Successful Requests	5000
Failed Requests	0
Concurrent Requests	50
Total Time	43.929160997s
Average Latency	438.531037ms
Throughput	113.82 requests/second

github-actions · 2026-08-07T14:10:19Z

X-Test Failure Report

✅ go@main-v0.9.0
✅ go@pull-3845-v0.9.0
✅ java@main-pull-3845
✅ go@pull-3845-main
✅ java@main-main
✅ js@main-main
✅ js@main-pull-3845
cukes-report
✅ java@main-v0.9.0
✅ js@main-v0.9.0
govulncheck-failure-8
opentdf~~platform~~UEPG9J.dockerbuild
govulncheck-failure-3
govulncheck-failure-5
govulncheck-failure-2
govulncheck-failure-1
govulncheck-failure-0

github-actions · 2026-08-07T14:14:37Z

Benchmark results, click to expand

Benchmark authorization.GetDecisions Results:

Metric	Value
Approved Decision Requests	1000
Denied Decision Requests	0
Total Time	213.88764ms

Benchmark authorization.v2.GetMultiResourceDecision Results:

Metric	Value
Approved Decision Requests	1000
Denied Decision Requests	0
Total Time	117.939716ms

Benchmark Statistics

Name	№ Requests	Avg Duration	Min Duration	Max Duration

Bulk Benchmark Results

Metric	Value
Total Decrypts	100
Successful Decrypts	100
Failed Decrypts	0
Total Time	417.164803ms
Throughput	239.71 requests/second

TDF3 Benchmark Results:

Metric	Value
Total Requests	5000
Successful Requests	5000
Failed Requests	0
Concurrent Requests	50
Total Time	43.155860312s
Average Latency	431.061326ms
Throughput	115.86 requests/second

github-actions · 2026-08-07T14:26:04Z

github-actions · 2026-08-07T14:30:29Z

Benchmark results, click to expand

Benchmark authorization.GetDecisions Results:

Metric	Value
Approved Decision Requests	1000
Denied Decision Requests	0
Total Time	231.132451ms

Benchmark authorization.v2.GetMultiResourceDecision Results:

Metric	Value
Approved Decision Requests	1000
Denied Decision Requests	0
Total Time	114.727488ms

Benchmark Statistics

Name	№ Requests	Avg Duration	Min Duration	Max Duration

Bulk Benchmark Results

Metric	Value
Total Decrypts	100
Successful Decrypts	100
Failed Decrypts	0
Total Time	407.646446ms
Throughput	245.31 requests/second

TDF3 Benchmark Results:

Metric	Value
Total Requests	5000
Successful Requests	5000
Failed Requests	0
Concurrent Requests	50
Total Time	43.124181241s
Average Latency	429.942923ms
Throughput	115.94 requests/second

github-actions · 2026-08-07T14:42:08Z

github-actions · 2026-08-07T15:51:24Z

Benchmark results, click to expand

Benchmark authorization.GetDecisions Results:

Metric	Value
Approved Decision Requests	1000
Denied Decision Requests	0
Total Time	281.852716ms

Benchmark authorization.v2.GetMultiResourceDecision Results:

Metric	Value
Approved Decision Requests	1000
Denied Decision Requests	0
Total Time	103.348944ms

Benchmark Statistics

Name	№ Requests	Avg Duration	Min Duration	Max Duration

Bulk Benchmark Results

Metric	Value
Total Decrypts	100
Successful Decrypts	100
Failed Decrypts	0
Total Time	672.601957ms
Throughput	148.68 requests/second

TDF3 Benchmark Results:

Metric	Value
Total Requests	5000
Successful Requests	5000
Failed Requests	0
Concurrent Requests	50
Total Time	42.692762508s
Average Latency	426.224958ms
Throughput	117.12 requests/second

github-actions · 2026-08-07T16:01:08Z

github-actions · 2026-08-07T17:02:40Z

Benchmark results, click to expand

Benchmark authorization.GetDecisions Results:

Metric	Value
Approved Decision Requests	1000
Denied Decision Requests	0
Total Time	210.642386ms

Benchmark authorization.v2.GetMultiResourceDecision Results:

Metric	Value
Approved Decision Requests	1000
Denied Decision Requests	0
Total Time	110.059409ms

Benchmark Statistics

Name	№ Requests	Avg Duration	Min Duration	Max Duration

Bulk Benchmark Results

Metric	Value
Total Decrypts	100
Successful Decrypts	100
Failed Decrypts	0
Total Time	406.827353ms
Throughput	245.80 requests/second

TDF3 Benchmark Results:

Metric	Value
Total Requests	5000
Successful Requests	5000
Failed Requests	0
Concurrent Requests	50
Total Time	43.371413905s
Average Latency	432.92009ms
Throughput	115.28 requests/second

github-actions · 2026-08-07T17:10:43Z

github-actions · 2026-08-10T14:38:21Z

Benchmark results, click to expand

Benchmark authorization.GetDecisions Results:

Metric	Value
Approved Decision Requests	1000
Denied Decision Requests	0
Total Time	192.393469ms

Benchmark authorization.v2.GetMultiResourceDecision Results:

Metric	Value
Approved Decision Requests	1000
Denied Decision Requests	0
Total Time	108.092293ms

Benchmark Statistics

Name	№ Requests	Avg Duration	Min Duration	Max Duration

Bulk Benchmark Results

Metric	Value
Total Decrypts	100
Successful Decrypts	100
Failed Decrypts	0
Total Time	430.135734ms
Throughput	232.48 requests/second

TDF3 Benchmark Results:

Metric	Value
Total Requests	5000
Successful Requests	5000
Failed Requests	0
Concurrent Requests	50
Total Time	44.729974277s
Average Latency	446.495639ms
Throughput	111.78 requests/second

github-actions · 2026-08-10T14:40:36Z

⚠️ Govulncheck found vulnerabilities ⚠️

The following modules have known vulnerabilities:

examples
otdfctl
sdk
service
lib/fixtures
tests-bdd

See the workflow run for details.

github-actions · 2026-08-10T14:47:31Z

key sort on status

13104ac

trigger ci

99f490a

lint

ad5780b

elizabethhealy marked this pull request as ready for review August 7, 2026 14:12

elizabethhealy requested review from a team as code owners August 7, 2026 14:12

fix test

2bbc5d4

c-r33d reviewed Aug 7, 2026

View reviewed changes

Comment thread service/integration/kas_registry_key_test.go

c-r33d reviewed Aug 7, 2026

View reviewed changes

Comment thread service/integration/kas_registry_key_test.go Outdated

c-r33d reviewed Aug 7, 2026

View reviewed changes

Comment thread service/policy/kasregistry/key_access_server_registry.proto Outdated

order after migration

2fca889

handle in sql case

6072327

remove helper

a817b59

elizabethhealy requested a review from c-r33d August 10, 2026 17:40

c-r33d approved these changes Aug 12, 2026

View reviewed changes

elizabethhealy added this pull request to the merge queue Aug 12, 2026

Merged via the queue into main with commit 2ca20ff Aug 12, 2026
45 checks passed

elizabethhealy deleted the dspx-3798-sort-on-key-status branch August 12, 2026 13:51

This was referenced Aug 11, 2026

chore(main): release otdfctl 0.37.0 #3842

Open

chore(main): release protocol/go 0.41.0 #3861

Merged

chore(main): release service 0.26.0 #3862

Open

This was referenced Aug 14, 2026

fix(sdk): Updates to proto version v0.41.0 opentdf/java-sdk#389

Open

fix(sdk): Updates to proto version protocol/go/v0.41.0 opentdf/web-sdk#964

Open

Uh oh!

Conversation

elizabethhealy commented Aug 6, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed Changes

Checklist

Testing Instructions

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Aug 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Walkthrough

Changes

Sequence Diagram(s)

❌ Failed checks (1 warning)

Uh oh!

github-actions Bot commented Aug 7, 2026

Benchmark authorization.GetDecisions Results:

Benchmark authorization.v2.GetMultiResourceDecision Results:

Benchmark Statistics

Bulk Benchmark Results

TDF3 Benchmark Results:

Uh oh!

github-actions Bot commented Aug 7, 2026

X-Test Failure Report

Uh oh!

github-actions Bot commented Aug 7, 2026

Benchmark authorization.GetDecisions Results:

Benchmark authorization.v2.GetMultiResourceDecision Results:

Benchmark Statistics

Bulk Benchmark Results

TDF3 Benchmark Results:

Uh oh!

github-actions Bot commented Aug 7, 2026

X-Test Failure Report

Uh oh!

github-actions Bot commented Aug 7, 2026

Benchmark authorization.GetDecisions Results:

Benchmark authorization.v2.GetMultiResourceDecision Results:

Benchmark Statistics

Bulk Benchmark Results

TDF3 Benchmark Results:

Uh oh!

Uh oh!

github-actions Bot commented Aug 7, 2026

X-Test Results

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Aug 7, 2026

Benchmark authorization.GetDecisions Results:

Benchmark authorization.v2.GetMultiResourceDecision Results:

Benchmark Statistics

Bulk Benchmark Results

TDF3 Benchmark Results:

Uh oh!

github-actions Bot commented Aug 7, 2026

X-Test Results

Uh oh!

github-actions Bot commented Aug 7, 2026

Benchmark authorization.GetDecisions Results:

Benchmark authorization.v2.GetMultiResourceDecision Results:

Benchmark Statistics

Bulk Benchmark Results

TDF3 Benchmark Results:

Uh oh!

github-actions Bot commented Aug 7, 2026

X-Test Results

Uh oh!

github-actions Bot commented Aug 10, 2026

Benchmark authorization.GetDecisions Results:

Benchmark authorization.v2.GetMultiResourceDecision Results:

Benchmark Statistics

Bulk Benchmark Results

TDF3 Benchmark Results:

Uh oh!

github-actions Bot commented Aug 10, 2026

⚠️ Govulncheck found vulnerabilities ⚠️

Uh oh!

elizabethhealy commented Aug 6, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Aug 6, 2026 •

edited

Loading