Skip to content

[ Gateway 5/10 ]Add endpoint listing page and tab layout#19474

Merged
BenWilson2 merged 1 commit intomlflow:masterfrom
BenWilson2:stack/gateway-ui/endpoint-list-page
Dec 23, 2025
Merged

[ Gateway 5/10 ]Add endpoint listing page and tab layout#19474
BenWilson2 merged 1 commit intomlflow:masterfrom
BenWilson2:stack/gateway-ui/endpoint-list-page

Conversation

@BenWilson2
Copy link
Member

@BenWilson2 BenWilson2 commented Dec 17, 2025

🥞 Stacked PR

Use this link to review incremental changes.


Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Add the Endpoints Listing page and the Tab-based navigation layout for endpoints and api key listing pages.
Updated the page for handling if there are issues with the security configuration or required dependencies to make the AI Gateway UI work.

Screenshot 2025-12-17 at 11 48 30 AM Screenshot 2025-12-17 at 12 24 18 PM

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)

@BenWilson2 BenWilson2 changed the title Add endpoint listing page and tab layout [ Gateway 5/10 ]Add endpoint listing page and tab layout Dec 17, 2025
@BenWilson2 BenWilson2 marked this pull request as ready for review December 17, 2025 22:07
Copilot AI review requested due to automatic review settings December 17, 2025 22:07
@github-actions github-actions bot added area/uiux Front-end, user experience, plotting, JavaScript, JavaScript dev server rn/feature Mention under Features in Changelogs. labels Dec 17, 2025
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 the Endpoints Listing page and tab-based navigation layout for the AI Gateway UI. It updates the masked secret value handling to store structured JSON data instead of plain strings, increases the database field size to accommodate multi-key credentials, and implements comprehensive UI components for managing endpoints and API keys.

Key Changes

  • Refactored secret masking to return dictionaries preserving key structure instead of concatenated strings
  • Increased masked_value database column from VARCHAR(100) to VARCHAR(500) to support JSON-serialized credential maps
  • Added endpoints listing page with filtering, search, and model/binding management
  • Implemented tab-based side navigation between Endpoints and API Keys pages

Reviewed changes

Copilot reviewed 89 out of 94 changed files in this pull request and generated no comments.

Show a summary per file
File Description
mlflow/utils/crypto.py Refactored masking functions to return dict structures, split into _mask_string_value and _mask_secret_value
mlflow/store/tracking/gateway/sqlalchemy_mixin.py Updated to JSON-serialize masked values before storage
mlflow/store/tracking/dbmodels/models.py Increased masked_value column size and updated documentation, added JSON deserialization
mlflow/store/db_migrations/versions/*.py Database migration to increase masked_value column from 100 to 500 characters
mlflow/server/handlers.py Fixed API endpoint path from /mlflow/secrets/config to /mlflow/gateway/secrets/config
tests/utils/test_crypto.py Updated tests to reflect new dict-based masking behavior
tests/tracking/test_rest_tracking.py Updated assertions to expect dict masked values
tests/store/tracking/test_gateway_sql_store.py Updated to verify dict structure in masked values
tests/entities/test_gateway_secrets.py Added tests for multi-key masked values
mlflow/server/js/src/gateway/types.ts Updated type definitions to reflect dict masked values and corrected field names
mlflow/server/js/src/gateway/routes.ts Added new route definitions for endpoints and API keys pages
mlflow/server/js/src/gateway/pages/GatewayPage.tsx Implemented tab-based navigation and setup guide for missing dependencies
mlflow/server/js/src/gateway/pages/ApiKeysPage.tsx New API Keys page with comprehensive key management UI
mlflow/server/js/src/gateway/hooks/* Added React hooks for data fetching, mutations, and business logic
mlflow/server/js/src/gateway/components/* Implemented reusable components for endpoints, API keys, secrets, and common UI elements
mlflow/server/js/src/gateway/utils/* Added utility functions for provider formatting, date handling, and secret parsing
mlflow/server/js/src/lang/default/en.json Added localization strings for new UI components

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

@github-actions
Copy link
Contributor

github-actions bot commented Dec 17, 2025

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

@BenWilson2 BenWilson2 force-pushed the stack/gateway-ui/endpoint-list-page branch from 948bda9 to ea03066 Compare December 18, 2025 00:30
@BenWilson2 BenWilson2 force-pushed the stack/gateway-ui/endpoint-list-page branch 3 times, most recently from e467e43 to 9154595 Compare December 18, 2025 19:25
/>
);
}
if (isEmptyList) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: do we need this check since empty state is displayed only when there's no row?

css={{ flex: 0, minWidth: 96, maxWidth: 96 }}
/>
</TableRow>
{filteredEndpoints.map((endpoint) => (
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: maybe it's clearer to extract a row as a separate component

);
};

const ProviderCell = ({ modelMappings }: { modelMappings: Endpoint['model_mappings'] }) => {
Copy link
Collaborator

Choose a reason for hiding this comment

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

I prefer to have just one component per tsx file. Shall we define them in separate files? cc: @daniellok-db let me know if this is MLflow/Databricks convention.

Copy link
Member Author

Choose a reason for hiding this comment

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

This makes sense for clarity. I'll refactor since it requires less mental overhead to find where things are.

TomeHirata

This comment was marked as duplicate.

Copy link
Collaborator

@TomeHirata TomeHirata left a comment

Choose a reason for hiding this comment

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

Overall LGTM

Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
@BenWilson2 BenWilson2 force-pushed the stack/gateway-ui/endpoint-list-page branch from c412f33 to 07e1abf Compare December 23, 2025 00:27
@BenWilson2 BenWilson2 added this pull request to the merge queue Dec 23, 2025
Merged via the queue into mlflow:master with commit 4bd5a57 Dec 23, 2025
72 of 74 checks passed
@BenWilson2 BenWilson2 deleted the stack/gateway-ui/endpoint-list-page branch December 23, 2025 01:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/uiux Front-end, user experience, plotting, JavaScript, JavaScript dev server rn/feature Mention under Features in Changelogs.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants