Skip to content

Add an env var for controlling whether to enable GraphQL routes authorization#19504

Merged
WeichenXu123 merged 3 commits intomlflow:masterfrom
WeichenXu123:graphql-auth-flag
Dec 19, 2025
Merged

Add an env var for controlling whether to enable GraphQL routes authorization#19504
WeichenXu123 merged 3 commits intomlflow:masterfrom
WeichenXu123:graphql-auth-flag

Conversation

@WeichenXu123
Copy link
Collaborator

@WeichenXu123 WeichenXu123 commented Dec 19, 2025

🛠 DevTools 🛠

Open in GitHub Codespaces

Install mlflow from this PR

# mlflow
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/19504/merge
# mlflow-skinny
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/19504/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/19504/merge

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Add an env var for controlling whether to enable GraphQL routes authorization

follow-up for #19278 (comment)

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: Weichen Xu <weichen.xu@databricks.com>
Copilot AI review requested due to automatic review settings December 19, 2025 02:55
@github-actions github-actions bot added area/tracking Tracking service, tracking client APIs, autologging rn/none List under Small Changes in Changelogs. labels Dec 19, 2025
@WeichenXu123 WeichenXu123 added v3.8.0 and removed rn/none List under Small Changes in Changelogs. area/tracking Tracking service, tracking client APIs, autologging labels Dec 19, 2025
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds an environment variable to control whether GraphQL routes authorization is enabled in the MLflow server, as a follow-up to PR #19278. The default value is True, maintaining existing behavior while allowing users to opt-out if needed.

  • Added MLFLOW_SERVER_ENABLE_GRAPHQL_AUTH environment variable with a default value of True
  • Modified get_graphql_authorization_middleware() to check this environment variable before checking if auth is enabled

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
mlflow/environment_variables.py Defines the new MLFLOW_SERVER_ENABLE_GRAPHQL_AUTH boolean environment variable with default value True
mlflow/server/auth/__init__.py Imports and uses the new environment variable in get_graphql_authorization_middleware() to allow disabling GraphQL authorization

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
#: Whether to enable authorization for graphQL routes in MLflow server.
#: (default: ``True``)
MLFLOW_SERVER_ENABLE_GRAPHQL_AUTH = _BooleanEnvironmentVariable(
"MLFLOW_SERVER_ENABLE_GRAPHQL_AUTH", True
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should we default to False?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

for addressing the CVE, we should make default True. (i.e. the default configure shouldn't have CVE)

Copy link
Collaborator

Choose a reason for hiding this comment

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

I see

@WeichenXu123 WeichenXu123 added the rn/none List under Small Changes in Changelogs. label Dec 19, 2025
Copy link
Collaborator

@serena-ruan serena-ruan left a comment

Choose a reason for hiding this comment

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

LGTM!

@github-actions
Copy link
Contributor

Documentation preview for 7af0dce 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.

@WeichenXu123 WeichenXu123 added this pull request to the merge queue Dec 19, 2025
Merged via the queue into mlflow:master with commit 322152b Dec 19, 2025
55 of 58 checks passed
@WeichenXu123 WeichenXu123 deleted the graphql-auth-flag branch December 19, 2025 03:34
WeichenXu123 added a commit to WeichenXu123/mlflow that referenced this pull request Dec 19, 2025
…rization (mlflow#19504)

Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
WeichenXu123 added a commit that referenced this pull request Dec 19, 2025
…rization (#19504)

Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

rn/none List under Small Changes in Changelogs. v3.8.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants