Skip to content

Fix shared cluster Py4j statefulness issue#19139

Merged
BenWilson2 merged 4 commits intomlflow:masterfrom
BenWilson2:serverless
Dec 3, 2025
Merged

Fix shared cluster Py4j statefulness issue#19139
BenWilson2 merged 4 commits intomlflow:masterfrom
BenWilson2:serverless

Conversation

@BenWilson2
Copy link
Member

@BenWilson2 BenWilson2 commented Dec 1, 2025

🛠 DevTools 🛠

Open in GitHub Codespaces

Install mlflow from this PR

# mlflow
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/19139/merge
# mlflow-skinny
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/19139/merge#subdirectory=libs/skinny

For Databricks, use the following command:

%sh curl -LsSf https://raw.githubusercontent.com/mlflow/mlflow/HEAD/dev/install-skinny.sh | sh -s pull/19139/merge

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Fix for shared clusters issue with py4j rejected connection timeouts when saving / logging models.

How is this PR tested?

  • Existing unit/integration tests
  • New unit/integration tests
  • Manual tests

Does this PR require documentation update?

  • No. You can skip the rest of this section.
  • Yes. I've updated:
    • Examples
    • API references
    • Instructions

Release Notes

Is this a user-facing change?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release notes for MLflow users.

What component(s), interfaces, languages, and integrations does this PR affect?

Components

  • area/tracking: Tracking Service, tracking client APIs, autologging
  • area/models: MLmodel format, model serialization/deserialization, flavors
  • area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
  • area/scoring: MLflow Model server, model deployment tools, Spark UDFs
  • area/evaluation: MLflow model evaluation features, evaluation metrics, and evaluation workflows
  • area/gateway: MLflow AI Gateway client APIs, server, and third-party integrations
  • area/prompts: MLflow prompt engineering features, prompt templates, and prompt management
  • area/tracing: MLflow Tracing features, tracing APIs, and LLM tracing functionality
  • area/projects: MLproject format, project running backends
  • area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
  • area/build: Build and test infrastructure for MLflow
  • area/docs: MLflow documentation pages

How should the PR be classified in the release notes? Choose one:

  • rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section
  • rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
  • rn/feature - A new user-facing feature worth mentioning in the release notes
  • rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
  • rn/documentation - A user-facing documentation change worth mentioning in the release notes

Should this PR be included in the next patch release?

Yes should be selected for bug fixes, documentation updates, and other small changes. No should be selected for new features and larger changes. If you're unsure about the release classification of this PR, leave this unchecked to let the maintainers decide.

What is a minor/patch release?
  • Minor release: a release that increments the second part of the version number (e.g., 1.2.0 -> 1.3.0).
    Bug fixes, doc updates and new features usually go into minor releases.
  • Patch release: a release that increments the third part of the version number (e.g., 1.2.0 -> 1.2.1).
    Bug fixes and doc updates usually go into patch releases.
  • Yes (this PR will be cherry-picked and included in the next patch release)
  • No (this PR will be included in the next minor release)

Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
@github-actions github-actions bot added v3.7.0 area/models MLmodel format, model serialization/deserialization, flavors rn/bug-fix Mention under Bug Fixes in Changelogs. labels Dec 1, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Dec 1, 2025

Documentation preview for 3ca9258 is available at:

More info
  • Ignore this comment if this PR does not change the documentation.
  • The preview is updated when a new commit is pushed to this PR.
  • This comment was created by this workflow run.
  • The documentation was built by this workflow run.

Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
@BenWilson2 BenWilson2 changed the title [ Testing ] Attempt shared cluster py4j state corruption fix Fix shared cluster Py4j statefulness issue Dec 1, 2025
@BenWilson2 BenWilson2 added the team-review Trigger a team review request label Dec 1, 2025
Comment on lines +749 to +752
try:
_capture_imported_modules("fake/model/path", "pyfunc")
except MlflowException:
pass
Copy link
Member

@harupy harupy Dec 2, 2025

Choose a reason for hiding this comment

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

It's unclear whether this should succeed or fail. Let's use pytest.raises.

@harupy
Copy link
Member

harupy commented Dec 2, 2025

/review


🚀 Review workflow started


✅ Review completed.

Review Output

Perfect! I've completed the PR review. I found one issue that violates the Python style guide:

Review Summary

PR: #19139 - Fix shared cluster Py4j statefulness issue

Issues Found: 1

Issue Details

  1. Missing mock assertion in tests/utils/test_requirements_utils.py:748
    • The test mocks _run_command but doesn't verify it was called
    • This violates the style guide rule: "Always Verify Mock Calls with Assertions"
    • I've added a comment with a suggestion to add mock_run.assert_called_once()

The implementation itself looks good - it correctly removes the PySpark gateway environment variables to prevent subprocess corruption of the parent process's py4j connection. The comments clearly explain why this is necessary.

"mlflow.utils.requirements_utils._download_artifact_from_uri",
return_value=str(tmp_path),
),
):
Copy link
Contributor

Choose a reason for hiding this comment

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

The mocked _run_command function should have an assertion to verify it was called. Without this, the test could pass even if _run_command is never invoked.

Consider adding an assertion after the try-except block:

Suggested change
):
with (
mock.patch(
"mlflow.utils.requirements_utils._run_command",
side_effect=mock_run_command,
) as mock_run,
mock.patch(
"mlflow.utils.requirements_utils._download_artifact_from_uri",
return_value=str(tmp_path),
),
):
try:
_capture_imported_modules("fake/model/path", "pyfunc")
except MlflowException:
pass
mock_run.assert_called_once()
assert "PYSPARK_GATEWAY_PORT" not in captured_env
assert "PYSPARK_GATEWAY_SECRET" not in captured_env

This follows the Python style guide rule: "Always Verify Mock Calls with Assertions" (see dev/guides/python.md).

🤖 Generated with Claude Code

Copy link
Member

Choose a reason for hiding this comment

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

let's validate that the mock for _download_artifact_from_uri is used too.

Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
@BenWilson2 BenWilson2 requested a review from harupy December 2, 2025 19:17
@BenWilson2 BenWilson2 added this pull request to the merge queue Dec 3, 2025
Merged via the queue into mlflow:master with commit f0cd3e9 Dec 3, 2025
66 of 69 checks passed
@BenWilson2 BenWilson2 deleted the serverless branch December 3, 2025 01:43
BenWilson2 added a commit to BenWilson2/mlflow that referenced this pull request Dec 4, 2025
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
BenWilson2 added a commit that referenced this pull request Dec 4, 2025
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/models MLmodel format, model serialization/deserialization, flavors rn/bug-fix Mention under Bug Fixes in Changelogs. team-review Trigger a team review request v3.7.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants