flow-framework icon indicating copy to clipboard operation
flow-framework copied to clipboard

Conditionally include ddb-client dependency only if env variable set

Open dbwiddis opened this issue 6 months ago • 3 comments

Description

Adds a configuration to include the remote metadata ddb-client dependency if an environment variable is set.

Allows build-time inclusion of the dependency in locations where it is required, and doesn't include extra dependencies in other cases.

Check List

  • [x] New functionality includes testing.
  • [x] Commits are signed per the DCO using --signoff.

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.

dbwiddis avatar May 12 '25 19:05 dbwiddis

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 77.37%. Comparing base (6fd68b2) to head (7174f38). Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##               main    #1141   +/-   ##
=========================================
  Coverage     77.37%   77.37%           
  Complexity     1099     1099           
=========================================
  Files           101      101           
  Lines          5318     5318           
  Branches        511      511           
=========================================
  Hits           4115     4115           
  Misses          954      954           
  Partials        249      249           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codecov[bot] avatar May 12 '25 19:05 codecov[bot]

Do dependent plugins like ml-commons/flow framework need to do anything based on this change?

dhrubo-os avatar May 12 '25 21:05 dhrubo-os

Do dependent plugins like ml-commons/flow framework need to do anything based on this change?

The only change upstream is aligning bom version with OpenSearch which is getting version bumps that were otherwise frozen. I think ML Commons also uses BOM-related dependencies and I'd recommend using the version catalog if you aren't already.

But otherwise no change. It's your call at ML commons if you want to conditionally include DDB dependencies, or just have it there all the time even if unused. But adding it may (as seen here) introduce some jar hell with the java client runtime vs. test dependencies.

dbwiddis avatar May 14 '25 05:05 dbwiddis