[core|serve] Migrate serve imports from ray._private to ray._common by MkDev11 · Pull Request #61363 · ray-project/ray

MkDev11 · 2026-02-26T19:15:42Z

Description

This PR continues the migration from ray._private to ray._common so that Ray Serve (and other libraries) do not depend on internal private APIs. It migrates tls_utils and logging constants out of _private into _common, and updates all consumers (Serve, dashboard, client server) to import from the new locations.

Changes:

ray._common.tls_utils
- Moved generate_self_signed_tls_certs() from _private.tls_utils into _common.tls_utils (it only depended on _common.network_utils).
- _private.tls_utils re-exports it for backward compatibility.
- Serve: serve/tests/test_https_proxy.py now imports from ray._common.tls_utils.
- Other consumers: _private/grpc_utils.py, _private/test_utils.py, dashboard/agent.py, util/client/server/proxier.py, util/client/server/server.py updated.
ray._common.logging_constants
- New module containing LOGRECORD_STANDARD_ATTRS (frozenset), LOGGER_FLATTEN_KEYS, and LogKey enum — all moved from _private.ray_logging.constants.
- _private.ray_logging.constants is deleted; _private.ray_logging.logging_config now imports from _common.
- Serve: serve/schema.py now imports LOGRECORD_STANDARD_ATTRS from ray._common.logging_constants.
ray._common.filters / ray._common.formatters
- Updated internal imports to use ray._common.logging_constants instead of ray._private.ray_logging.constants.

Tests:

New ray/_common/tests/test_logging_constants.py — tests the full LOGRECORD_STANDARD_ATTRS frozenset, all LogKey enum members, and LOGGER_FLATTEN_KEYS.
New ray/_common/tests/test_tls_utils.py — tests generate_self_signed_tls_certs.
Lint: ruff check and format pass on all changed files.

Related issues

Fixes #53478 (partial: migrates Serve-side imports for tls_utils and logging constants; remaining items like runtime_env_uri and worker_compat can be done in follow-up PRs).

Additional information

Backward compatibility: Existing code that imports generate_self_signed_tls_certs from _private.tls_utils continues to work via re-export. _private.ray_logging.constants is removed since all consumers have been updated.
Scope: Some Serve files still use ray._private.worker.* as attribute access (e.g. global_worker, _global_node) without a direct import; migrating those would require exposing them via _common and is left for a separate PR.
Sample PRs referenced in the issue: move signal and semaphore to _common/ #53457 (signal/semaphore to _common), [core] Migrate wait_for_condition and async_wait_for_condition from _private to _common #53652 (wait_for_condition to _common).

MkDev11 · 2026-02-26T19:17:15Z

@abrarsheikh please review the PR and let me know your feedback

gemini-code-assist

Code Review

This pull request effectively continues the migration of Serve imports from ray._private to ray._common, which is a great step towards a cleaner architecture and reducing dependencies on internal APIs. The changes are well-structured, moving utilities to _common and updating Serve's codebase to use them, while maintaining backward compatibility with re-exports. The addition of new tests and a verification script is also a solid contribution to ensure the migration is correct and prevent future regressions.

I have a few minor suggestions in the new test files to improve test specificity and code style, but overall this is a high-quality contribution.

python/ray/_common/tests/test_logging_constants.py

python/ray/_common/tests/test_runtime_env_uri.py

python/ray/_common/tests/test_tls_utils.py

python/ray/_common/logging_constants.py

python/ray/_common/tests/test_logging_constants.py

- Add ray._common.tls_utils with generate_self_signed_tls_certs (moved from _private; _private re-exports for backward compatibility). - Add ray._common.logging_constants with LOGRECORD_STANDARD_ATTRS; update _private.ray_logging.constants to import from _common. - Add ray._common.runtime_env_uri re-exporting parse_uri and Protocol from _private.runtime_env for use by Serve schema. - Add ray._common.worker_compat with set_blocking_get_inside_async_warned so Serve can mute the async warning without importing _private.worker. Serve now imports only from ray._common for these utilities: - serve/schema.py: LOGRECORD_STANDARD_ATTRS, parse_uri - serve/tests/test_https_proxy.py: generate_self_signed_tls_certs - serve/__init__.py: set_blocking_get_inside_async_warned Includes tests for tls_utils, logging_constants, and runtime_env_uri, plus a verification script for serve having no direct ray._private imports. Ref: ray-project#53478 Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

… error messages - test_logging_constants: assert exact count (23) instead of >= 20 - test_runtime_env_uri: use package_name, assert exact parse_uri output - test_tls_utils: single with + two temp files, no manual cleanup - schema.py, logging_config.py: format LOGRECORD_STANDARD_ATTRS as set() in error messages for readable output Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

…rify script Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

python/ray/_common/tests/test_logging_constants.py

python/ray/_common/tests/test_runtime_env_uri.py

python/ray/_common/tests/test_tls_utils.py

python/ray/_common/runtime_env_uri.py

python/ray/_private/tls_utils.py

abrarsheikh · 2026-02-27T08:47:46Z

python/ray/_common/worker_compat.py

+
+from typing import Any, Optional, Tuple
+
+from ray._private import worker


if common depends on _private, i dont think that is any better than directly accessing _private. defer to @edoakes for recommendations on what we want to do here.

agree with it. I reverted the worker_compat migration in this PR and deferred this direction pending @edoakes guidance

@edoakes also here

Rollback worker_compat/runtime_env_uri moves pending maintainer direction, remove redundant test module docstrings, and switch TLS cert helper callsites to ray._common without _private re-export. Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

MkDev11 · 2026-02-27T10:15:15Z

@abrarsheikh just pushed the changes, please review again

python/ray/_private/tls_utils.py

Re-export generate_self_signed_tls_certs from ray._private.tls_utils to preserve backward compatibility for existing import paths. Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

Revert assistant-applied commits from this chat session and restore branch contents to the pre-session baseline. Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

This reverts commit 85cf7d9. Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

Create an empty signed commit to retrigger premerge checks. Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

Remove python/ray/_private/tls_utils.py and python/ray/_private/ray_logging/constants.py since all call sites now import directly from ray._common. Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

MkDev11 · 2026-03-02T15:37:06Z

@abrarsheikh can you please review the changes again?

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

python/ray/serve/schema.py

Wrap LOGRECORD_STANDARD_ATTRS with set() in serve/schema.py error message to display {...} instead of frozenset({...}). Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

abrarsheikh · 2026-03-03T18:20:12Z

please fix the premerge

Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

MkDev11 · 2026-03-03T22:36:57Z

fixed

Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

MkDev11 · 2026-03-04T14:36:11Z

how ya doing? @abrarsheikh
can we merge this PR now?

abrarsheikh · 2026-03-04T14:50:10Z

Needs to be signed off from ray-core team members before merging. Someone will get to it soon :)

…ate-serve-from-private-to-common # Conflicts: # python/ray/serve/schema.py

MkDev11 · 2026-03-10T16:50:40Z

@abrarsheikh it's been 5 days since you approved the PR. can you please help me mege this PR asap?

abrarsheikh · 2026-03-10T19:00:37Z

premerge is failing. that's needs to be green before we can merge

Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

MkDev11 · 2026-03-11T05:09:42Z

premerge is failing. that's needs to be green before we can merge

all checks passed, can we merge it?

abrarsheikh · 2026-03-11T05:47:12Z

@edoakes for core review.

MkDev11 · 2026-03-12T01:05:07Z

hi @kouroshHakha can you please merge this PR?

MkDev11 · 2026-03-12T01:06:00Z

seems like that @edoakes is offline several days

MengjinYan

Looks good overall! Added nit comments.

Also, looks like the changes in the PR doesn't quite match the PR description. Can we update the PR description?

MengjinYan · 2026-03-12T02:27:09Z

python/ray/_common/tests/test_logging_constants.py

+
+
+def test_logrecord_standard_attrs_contains_standard_names():
+    expected = {"message", "levelname", "name", "pathname", "lineno", "exc_info"}


Minor: I'm wondering if we should test the whole set?

MengjinYan · 2026-03-12T02:27:32Z

python/ray/_common/tests/test_logging_constants.py

+    from enum import Enum
+
+    assert issubclass(LogKey, Enum)
+    assert LogKey.JOB_ID.value == "job_id"


Similar as above, wondering if we should test the full set of keys?

Test the complete LOGRECORD_STANDARD_ATTRS frozenset and all LogKey enum members instead of just a subset, as requested by MengjinYan. Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

MkDev11 · 2026-03-12T02:41:50Z

@MengjinYan thanks for your feedback, I implemented your comments and update the pr description again. can you please review again?

Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

MkDev11 requested review from a team, MengjinYan, edoakes and israbbani as code owners February 26, 2026 19:15

MkDev11 force-pushed the migrate-serve-from-private-to-common branch from db77238 to 330e601 Compare February 26, 2026 19:16

gemini-code-assist bot reviewed Feb 26, 2026

View reviewed changes

python/ray/_common/tests/test_logging_constants.py Outdated Show resolved Hide resolved

python/ray/_common/tests/test_runtime_env_uri.py Outdated Show resolved Hide resolved

python/ray/_common/tests/test_tls_utils.py Show resolved Hide resolved

cursor bot reviewed Feb 26, 2026

View reviewed changes

python/ray/_common/logging_constants.py Show resolved Hide resolved

cursor bot reviewed Feb 26, 2026

View reviewed changes

python/ray/_common/tests/test_logging_constants.py Show resolved Hide resolved

abrarsheikh added the go add ONLY when ready to merge, run all tests label Feb 26, 2026

MkDev11 added 7 commits February 26, 2026 22:22

Fix lint: noqa for re-exports, raw docstring, ruff format

9a495ef

Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

Register new _common tests in BUILD.bazel for CI

0bd1fef

Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

Apply pre-commit fixes: import order and multi-line imports

44a7c6f

Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

Remove all ray._private refs from serve via worker_compat; tighten ve…

50816c1

…rify script Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

Fix import order in test_metrics_2 (ruff)

a966037

Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

MkDev11 force-pushed the migrate-serve-from-private-to-common branch from e680d30 to a966037 Compare February 26, 2026 21:22

Apply black format to test_metrics_2.py

90afc70

Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

ray-gardener bot added the community-contribution Contributed by the community label Feb 27, 2026

abrarsheikh reviewed Feb 27, 2026

View reviewed changes

cursor bot reviewed Feb 27, 2026

View reviewed changes

python/ray/_private/tls_utils.py Show resolved Hide resolved

MkDev11 and others added 5 commits February 27, 2026 11:22

Restore tls_utils compatibility re-export.

ea2d215

Re-export generate_self_signed_tls_certs from ray._private.tls_utils to preserve backward compatibility for existing import paths. Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

Revert session changes from migrate-to-common branch work.

85cf7d9

Revert assistant-applied commits from this chat session and restore branch contents to the pre-session baseline. Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

Revert "Revert session changes from migrate-to-common branch work."

27db56c

This reverts commit 85cf7d9. Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

Trigger CI rerun.

fddb8c5

Create an empty signed commit to retrigger premerge checks. Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

Merge branch 'master' into migrate-serve-from-private-to-common

dd6d24b

Drop _private re-export modules per review feedback

597d12f

Remove python/ray/_private/tls_utils.py and python/ray/_private/ray_logging/constants.py since all call sites now import directly from ray._common. Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

cursor bot reviewed Mar 2, 2026

View reviewed changes

python/ray/serve/schema.py Outdated Show resolved Hide resolved

Fix frozenset display in error message

533e2db

Wrap LOGRECORD_STANDARD_ATTRS with set() in serve/schema.py error message to display {...} instead of frozenset({...}). Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

MkDev11 requested a review from abrarsheikh March 3, 2026 11:04

Fix ruff import order: group _common before _private

245d14b

Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

MkDev11 and others added 2 commits March 3, 2026 14:44

Merge branch 'master' into migrate-serve-from-private-to-common

76e0e9a

Apply black formatting to filters.py and proxier.py

02756a9

Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

abrarsheikh approved these changes Mar 4, 2026

View reviewed changes

Merge branch 'master' of https://github.com/ray-project/ray into migr…

c98ea3b

…ate-serve-from-private-to-common # Conflicts: # python/ray/serve/schema.py

Fix ruff import sorting: move ray._common import after pydantic block

52e24af

Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

MengjinYan reviewed Mar 12, 2026

View reviewed changes

Address review: test full sets for LOGRECORD_STANDARD_ATTRS and LogKey

4b55923

Test the complete LOGRECORD_STANDARD_ATTRS frozenset and all LogKey enum members instead of just a subset, as requested by MengjinYan. Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

MkDev11 requested a review from MengjinYan March 12, 2026 02:39

MkDev11 and others added 3 commits March 12, 2026 15:10

Retrigger CI

0b5ed74

Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

Merge branch 'master' into migrate-serve-from-private-to-common

3d99fdd

Retrigger CI (flaky wandb test)

872119b

Signed-off-by: mkdev11 <MkDev11@users.noreply.github.com>

edoakes approved these changes Mar 12, 2026

View reviewed changes

edoakes merged commit 51e923d into ray-project:master Mar 12, 2026
6 checks passed


		from typing import Any, Optional, Tuple

		from ray._private import worker



		def test_logrecord_standard_attrs_contains_standard_names():
		expected = {"message", "levelname", "name", "pathname", "lineno", "exc_info"}

Conversation

MkDev11 commented Feb 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related issues

Additional information

Uh oh!

MkDev11 commented Feb 26, 2026

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

abrarsheikh Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

MkDev11 Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

MkDev11 Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

MkDev11 commented Feb 27, 2026

Uh oh!

Uh oh!

MkDev11 commented Mar 2, 2026

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

abrarsheikh commented Mar 3, 2026

Uh oh!

MkDev11 commented Mar 3, 2026

Uh oh!

MkDev11 commented Mar 4, 2026

Uh oh!

abrarsheikh commented Mar 4, 2026

Uh oh!

MkDev11 commented Mar 10, 2026

Uh oh!

abrarsheikh commented Mar 10, 2026

Uh oh!

MkDev11 commented Mar 11, 2026

Uh oh!

abrarsheikh commented Mar 11, 2026

Uh oh!

MkDev11 commented Mar 12, 2026

Uh oh!

MkDev11 commented Mar 12, 2026

Uh oh!

MengjinYan left a comment

Choose a reason for hiding this comment

Uh oh!

MengjinYan Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

MengjinYan Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

MkDev11 commented Mar 12, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

MkDev11 commented Feb 26, 2026 •

edited

Loading