Introduce gRPC Interceptor Chain for transport-grpc by aparajita31pandey · Pull Request #19005 · opensearch-project/OpenSearch

aparajita31pandey · 2025-08-09T15:29:47Z

Description

This change introduces a gRPC Interceptor Chain into the transport-grpc module. The chain allows multiple interceptors to be applied in a defined order for every gRPC request. It lays the foundation for future needs (e.g., profiling, observability, logging), where ServerInterceptor provides a convenient hook.

Each interceptor can perform logic such as authentication, logging, or metrics collection before the request reaches the actual service. Interceptors are discovered using a provider interface and validated to ensure no duplicate order values.

If all interceptors succeed, the request proceeds to the service.
If any interceptor throws an exception, the chain logs the error, closes the call with an INTERNAL status, and stops further processing. This ensures a strict fail-fast model where faulty interceptors cannot be bypassed.This design makes gRPC extension points in OpenSearch opensearch-project/security#5379.

Related Issues

Resolves #5379

Test Plan

The changes are covered with unit tests to check interceptor ordering, duplicate detection, and error handling. Example scenarios include:

Verifying that interceptors execute in the correct sequence.
Ensuring that a failing interceptor stops the request when failures are not ignored.
Confirming that ignored failures allow the request to proceed to the next interceptor and service.
Checking that the system behaves the same when no interceptors are present.
Tested end to end with plugin having transport-grpc extension using gRPCInterceptor

Check List

Functionality includes testing.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

github-actions · 2025-08-09T15:35:45Z

❌ Gradle check result for 722ee62: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2025-08-24T17:15:24Z

❌ Gradle check result for fbee539: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2025-08-24T17:32:43Z

❌ Gradle check result for ca590a9: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2025-08-24T18:09:18Z

❌ Gradle check result for 99bbac2: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2025-09-11T16:36:41Z

❌ Gradle check result for 14301f8: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2025-09-17T09:45:30Z

❌ Gradle check result for 6a01d57: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2025-09-17T10:10:49Z

❌ Gradle check result for b924e76: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2025-09-18T04:27:56Z

❌ Gradle check result for 8492d65: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2025-09-18T07:17:38Z

❌ Gradle check result for 52dc73c: null

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2025-09-18T09:28:28Z

❌ Gradle check result for 5e22c55: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2025-09-18T14:19:38Z

❌ Gradle check result for 0ed5ca9: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2025-09-18T18:01:17Z

❌ Gradle check result for e05670e: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2025-09-18T18:18:23Z

❌ Gradle check result for 2ef40bc: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2025-09-19T01:32:40Z

❌ Gradle check result for 0951394: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

Signed-off-by: Aparajita Pandey <37636092+aparajita31pandey@users.noreply.github.com>

Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com>

github-actions · 2025-10-09T23:42:25Z

✅ Gradle check result for 9784239: SUCCESS

Signed-off-by: Aparajita Pandey <37636092+aparajita31pandey@users.noreply.github.com>

github-actions · 2025-10-10T02:27:24Z

❌ Gradle check result for 020a0aa: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2025-10-10T17:29:56Z

✅ Gradle check result for 020a0aa: SUCCESS

aparajita31pandey · 2025-10-13T21:51:30Z

@cwperks @karenyrx Have addressed all review feedback:

Changed SPI dependencies to implementation
Made OrderedGrpcInterceptor a nested interface
Updated README with build.gradle extension examples
All tests passing.

…ct#19005) * Introduce Interceptor to Grpc Plugin - Signed-off-by: Aparajita Pandey <aparajita29pandey@gmail.com> Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> * This is a combination of 7 commits. Add testcases for gRPC Interceptor Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> Ran spotlessAppy Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> refactor Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> spotlesssCheck Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> check if it verified Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> Added GrpcInterceptorChain check if it verified Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> revert Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> empty commit Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> Added GrpcInterceptorChain Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> Added GrpcInterceptorChain Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> Added GrpcInterceptorChain Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> testCases Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> logger Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> Resolve Conflict Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> javadoc Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> * javadoc Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> * cleanuo Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> * move GrpcInterceptor Interface to spi Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> * move GrpcInterceptor Interface to spi Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> * build.gradle fixes Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> * GrpcInterceptorChain refactoring Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> * GrpcInterceptorChain refactoring Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> * rebase Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> * coverage Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> * spotless Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> * Add logic to throw exception on workload group deletion with associated rules (opensearch-project#19502) Signed-off-by: Kaushal Kumar <ravi.kaushal97@gmail.com> Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> * add documentation about debug-server-jvm in testing.md (opensearch-project#19567) Signed-off-by: Vigya Sharma <vigya.work@gmail.com> Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> * Adds a mapper for context aware segments grouping criteria (opensearch-project#19233) * Adds Context aware grouping mapper The change also stores grouping criteria for each doc in parsed context Signed-off-by: Tejas Shah <shatejas@amazon.com> * Adds a test for ContextAwareGroupingScript Signed-off-by: Tejas Shah <shatejas@amazon.com> * Adds ContextAwareGroupingScript support in mockScriptEngine to fix integ tests Signed-off-by: Tejas Shah <shatejas@amazon.com> * Corrects CHANGELOG.md Signed-off-by: Tejas Shah <shatejas@amazon.com> * Fixes LangPainlessClientYamlTestSuiteIT Signed-off-by: Tejas Shah <shatejas@amazon.com> --------- Signed-off-by: Tejas Shah <shatejas@amazon.com> Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> * Refactor README.md and GrpcInterceptorChain Constructor Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> * UpdateREADME & switch to implmentation Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> * refactoring Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> * refactoring Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> * Address PR review comments - Changed SPI dependencies from api to implementation - Made OrderedGrpcInterceptor a nested interface inside GrpcInterceptorProvider - Updated README with build.gradle extension declaration examples - Simplified duplicate order handling documentation Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> * empty commit Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> * resolve conflict Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> --------- Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com> Signed-off-by: Kaushal Kumar <ravi.kaushal97@gmail.com> Signed-off-by: Vigya Sharma <vigya.work@gmail.com> Signed-off-by: Tejas Shah <shatejas@amazon.com> Signed-off-by: Aparajita Pandey <37636092+aparajita31pandey@users.noreply.github.com> Co-authored-by: Kaushal Kumar <ravi.kaushal97@gmail.com> Co-authored-by: Vigya Sharma <vigyas@amazon.com> Co-authored-by: Tejas Shah <shatejas@amazon.com>

aparajita31pandey · 2025-11-12T10:29:46Z

@karenyrx @cwperks Can we backport this to 2.19 version?

aparajita31pandey requested a review from a team as a code owner August 9, 2025 15:29

aparajita31pandey changed the title ~~WIP: Introduce gprc interceptor~~ WIP: gprc interceptor Aug 19, 2025

aparajita31pandey force-pushed the introduceGprcInterceptor branch from 722ee62 to fbee539 Compare August 24, 2025 17:08

aparajita31pandey force-pushed the introduceGprcInterceptor branch 3 times, most recently from 6433438 to 99bbac2 Compare August 24, 2025 17:58

aparajita31pandey marked this pull request as draft August 24, 2025 18:02

aparajita31pandey changed the title ~~WIP: gprc interceptor~~ WIP: gRPC interceptor Sep 8, 2025

aparajita31pandey force-pushed the introduceGprcInterceptor branch from 14301f8 to 6a01d57 Compare September 17, 2025 09:39

aparajita31pandey marked this pull request as ready for review September 18, 2025 07:25

opensearch-ci-bot mentioned this pull request Sep 14, 2025

[AUTOCUT] Gradle Check Flaky Test Report for WorkloadManagementIT #17154

Open

aparajita31pandey force-pushed the introduceGprcInterceptor branch from 5e22c55 to 0ed5ca9 Compare September 18, 2025 13:35

opensearch-ci-bot mentioned this pull request Sep 18, 2025

[AUTOCUT] Gradle Check Flaky Test Report for LeafSorterOptimizationTests #18898

Closed

aparajita31pandey marked this pull request as draft September 18, 2025 16:25

aparajita31pandey force-pushed the introduceGprcInterceptor branch 2 times, most recently from 5cd49dc to 02e7cd7 Compare September 19, 2025 02:10

aparajita31pandey requested review from Rishikesh1159, mch2, msfroh, owaiskazi19, reta, sachinpkale, saratvemulapalli, shwetathareja and sohami as code owners October 9, 2025 22:08

aparajita31pandey and others added 2 commits October 10, 2025 03:39

Merge branch 'main' into introduceGprcInterceptor

e8c7e4d

Signed-off-by: Aparajita Pandey <37636092+aparajita31pandey@users.noreply.github.com>

resolve conflict

9784239

Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com>

aparajita31pandey requested a review from cwperks October 9, 2025 22:15

aparajita31pandey requested a review from karenyrx October 9, 2025 23:47

Merge branch 'main' into introduceGprcInterceptor

020a0aa

Signed-off-by: Aparajita Pandey <37636092+aparajita31pandey@users.noreply.github.com>

cwperks approved these changes Oct 13, 2025

View reviewed changes

karenyrx approved these changes Oct 13, 2025

View reviewed changes

karenyrx merged commit 821045f into opensearch-project:main Oct 14, 2025
34 of 36 checks passed

This was referenced Oct 22, 2025

[AUTOCUT] Gradle Check Flaky Test Report for SearchWeightedRoutingIT #15843

Open

[AUTOCUT] Gradle Check Flaky Test Report for AzureBlobContainerRetriesTests #14318

Open

aparajita31pandey mentioned this pull request Oct 27, 2025

Preserve Thread Context by gRPC Interceptor #19776

Merged

1 task

finnegancarroll mentioned this pull request Nov 10, 2025

[FEATURE] Provide gRPC interceptor alternative to RestHandler opensearch-project/security#5785

Closed

BrewTestBot mentioned this pull request Dec 17, 2025

opensearch 3.4.0 Homebrew/homebrew-core#258986

Merged

opensearch-ci-bot mentioned this pull request Mar 18, 2026

[AUTOCUT] Gradle Check Flaky Test Report for TransferManagerBlobContainerReaderTests #18872

Closed

Conversation

aparajita31pandey commented Aug 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Check List

Uh oh!

github-actions bot commented Aug 9, 2025

Uh oh!

github-actions bot commented Aug 24, 2025

Uh oh!

github-actions bot commented Aug 24, 2025

Uh oh!

github-actions bot commented Aug 24, 2025

Uh oh!

github-actions bot commented Sep 11, 2025

Uh oh!

github-actions bot commented Sep 17, 2025

Uh oh!

github-actions bot commented Sep 17, 2025

Uh oh!

github-actions bot commented Sep 18, 2025

Uh oh!

github-actions bot commented Sep 18, 2025

Uh oh!

github-actions bot commented Sep 18, 2025

Uh oh!

github-actions bot commented Sep 18, 2025

Uh oh!

github-actions bot commented Sep 18, 2025

Uh oh!

github-actions bot commented Sep 18, 2025

Uh oh!

github-actions bot commented Sep 19, 2025

Uh oh!

github-actions bot commented Oct 9, 2025

Uh oh!

github-actions bot commented Oct 10, 2025

Uh oh!

github-actions bot commented Oct 10, 2025

Uh oh!

aparajita31pandey commented Oct 13, 2025

Uh oh!

Uh oh!

aparajita31pandey commented Nov 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

aparajita31pandey commented Aug 9, 2025 •

edited

Loading