Skip to content

Fix public api visiblity for datarouter targets - #439

Merged
rmaddikery merged 17 commits into
mainfrom
rama_datarouterconf_public_api
Nov 20, 2026
Merged

rmaddikery merged 17 commits into
mainfrom
rama_datarouterconf_public_api

Conversation

@rmaddikery

@rmaddikery rmaddikery commented Nov 19, 2026 •

Copy link
Copy Markdown
Contributor

Notes for Reviewer

  • datarouter clients use unix_domain apis which need to be public. But the exisiting implmentation exposes even the internal parts which needed to be seperated out.
  • file_transfer_trigger_lib is public hence the visibliltiy is fixed for the same
  • This is a breaking change for the datarouter clients.

Pre-Review Checklist for the PR Author

  • PR title is short, expressive and meaningful
  • Commits are properly organized
  • Relevant issues are linked in the References section
  • Tests are conducted
  • Unit tests are added

Checklist for the PR Reviewer

  • Commits are properly organized and messages are according to the guideline
  • Unit tests have been written for new behavior
  • Public API is documented
  • PR title describes the changes

Post-review Checklist for the PR Author

  • All open points are addressed and tracked via issues

References

Closes #

@github-actions

github-actions Bot commented Nov 19, 2026 •

Copy link
Copy Markdown
Contributor

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run --lockfile_mode=error //:license-check

Status: ⚠️ Needs Review

Click to expand output
[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.8.2) and connecting to it...
INFO: Invocation ID: 85a7626c-6016-4d3c-a4a7-cdeac56de15d
Computing main repo mapping: 
Computing main repo mapping: 
WARNING: For repository 'rules_cc', the root module requires module version rules_cc@0.2.17, but got rules_cc@0.2.25 in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
WARNING: For repository 'score_process_description', the root module requires module version score_process_description@2.2.4, but got score_process_description@2.2.5 in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
WARNING: /home/runner/.bazel/external/score_baselibs+/score/json/BUILD:25:12: target '@@score_baselibs+//score/json:base_library' is deprecated: base_library no longer has any effect, vaJson is the only parser backend. Remove this flag from your build configuration; it will be deleted in a future release.
Loading: 
Loading: 4 packages loaded
WARNING: Target pattern parsing failed.
ERROR: Skipping '//:license-check': no such target '//:license-check': target 'license-check' not declared in package '' defined by /home/runner/work/logging/logging/BUILD
ERROR: no such target '//:license-check': target 'license-check' not declared in package '' defined by /home/runner/work/logging/logging/BUILD
INFO: Elapsed time: 15.186s
INFO: 0 processes.
ERROR: Build did NOT complete successfully
ERROR: Build failed. Not running target

@rmaddikery
rmaddikery force-pushed the rama_datarouterconf_public_api branch from ede8931 to f5ba5da Compare November 19, 2026 12:46
@rmaddikery
rmaddikery deployed to workflow-approval November 19, 2026 12:46 — with GitHub Actions Active
@github-actions

Copy link
Copy Markdown
Contributor

Documentation preview for this pull request is available at:
pr-439: https://eclipse-score.github.io/logging/pr-439/

@rmaddikery
rmaddikery deployed to workflow-approval November 19, 2026 14:37 — with GitHub Actions Active
@rmaddikery rmaddikery changed the title Fix public api visiblity Fix public api visiblity for datarouter targets Nov 19, 2026
@rmaddikery
rmaddikery force-pushed the rama_datarouterconf_public_api branch from 23af0a8 to 9eb030d Compare November 20, 2026 07:52
@rmaddikery
rmaddikery deployed to workflow-approval November 20, 2026 07:52 — with GitHub Actions Active
@rmaddikery
rmaddikery marked this pull request as ready for review November 20, 2026 07:54

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file has no file ending. Is it supposed to be header?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch!

Comment thread score/datarouter/BUILD Resolved
kSharedMemoryFileHandle = 1,
};

struct SocketMessangerHeader // __attribute__((packed)) // TODO: deal with packed

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is meant here by "dealt with it"? Do we have a ticket for this TODO?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this was a legacy take over. I added a comment instead.

- Both targets only carry constants (command and return codes,
socket and client names) that form the contract between datarouter
and the clients configuring it.
- External datarouter clients use UnixDomainSockAddr,
SendSocketMessage and RecvSocketMessage to talk to the
 datarouter socket, which is most of the public surface
of this target.
- Remove the entries instead of leaving lists that
suggest access which is not granted.
Include <string> and define the constants inline. This makes the header

self-contained and avoids per-translation-unit copies.
- The target is the client API for triggering DLT file
transfers.
Use "Datarouter Configurator Client" as the IPC diagram node label.
Introduce data_router_cfg as the canonical target. Preserve the

libdrconfighdrs label with an alias and retain the short include path

until external consumers migrate.
- Switch the in-repo dependencies from the libdrconfighdrs
alias to data_router_cfg and include the header
via its repo-root-relative path, so only external consumers
still rely on the transitional alias and includes.
Remove the visibility label for a package that does not exist in this

repository. Consumers depend on dlt_filetransfer_trigger_lib and do not

use these message headers directly.
- Add a datarouter-private target and header for the unix
domain declarations that are not part of the client API.
- Migrate the client, the server and their tests to it.
The header still forwards to unix_domain_common.h,
so no declaration moves yet.
- Move internals to unix_domain_internal.h.
The public header keeps UnixDomainSockAddr,
SendSocketMessage and RecvSocketMessage,
so existing external consumers need no change.
- avoid leaking transitive deps for public targets
- The target is private and has no dependents, and nothing includes the
extension-less StructDataSource header that it exports.
- Drop the target from the datarouter dependency report scope as well.
- The header is sent as raw bytes, and packing it would
change the wire format.
- Fix deprecation warning comment for legacy label
@rmaddikery
rmaddikery force-pushed the rama_datarouterconf_public_api branch from 40d9519 to e8759d0 Compare November 20, 2026 10:09
@rmaddikery
rmaddikery deployed to workflow-approval November 20, 2026 10:09 — with GitHub Actions Active
@github-project-automation github-project-automation Bot moved this from Backlog to On Hold in LOG - Logging FT Nov 20, 2026
@rmaddikery
rmaddikery added this pull request to the merge queue Nov 20, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Nov 20, 2026
@rmaddikery
rmaddikery merged commit 320fd73 into main Nov 20, 2026
23 checks passed
@rmaddikery
rmaddikery deleted the rama_datarouterconf_public_api branch November 20, 2026 13:42
@github-project-automation github-project-automation Bot moved this from On Hold to Done in LOG - Logging FT Nov 20, 2026

This branch was successfully deployed

1 active deployment
workflow-approval — e8759d05 Deployed Nov 20, 2026 by rmaddikery via run-tests / coverage approval gate #1842
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants