Skip to content

Commit fa8f06b

Browse files
feat: Expose runtime version in Feast UI (feast-dev#6843)
1 parent 640ac70 commit fa8f06b

11 files changed

Lines changed: 239 additions & 3 deletions

File tree

‎docs/reference/feature-servers/registry-server.md‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,27 @@ Most endpoints support these common query parameters:
4848
- `sort_by` (optional): Field to sort by
4949
- `sort_order` (optional): Sort order: "asc" or "desc" (default: "asc")
5050

51+
### System
52+
53+
#### Get Runtime Version
54+
55+
- **Endpoint**: `GET /api/v1/version`
56+
- **Description**: Return the Feast package version installed in the running server process
57+
- **Example**:
58+
```bash
59+
curl -H "Authorization: Bearer <token>" \
60+
"http://localhost:6572/api/v1/version"
61+
```
62+
- **Response Example**:
63+
```json
64+
{
65+
"version": "0.66.0"
66+
}
67+
```
68+
69+
The endpoint returns `"unknown"` when the running process cannot resolve installed package
70+
metadata.
71+
5172
### Entities
5273

5374
#### List Entities
@@ -1418,4 +1439,3 @@ feature_server:
14181439
- Only the most recent `limit` visits per user are stored
14191440
- Metrics endpoints (`/metrics/*`) are automatically excluded from logging to prevent circular references
14201441
- Visit data is stored per user and per project in the registry metadata
1421-

‎sdk/python/feast/api/registry/rest/__init__.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
from feast.api.registry.rest.projects import get_project_router, get_registry_router
1818
from feast.api.registry.rest.saved_datasets import get_saved_dataset_router
1919
from feast.api.registry.rest.search import get_search_router
20+
from feast.api.registry.rest.system import get_system_router
2021

2122
logger = logging.getLogger(__name__)
2223

@@ -31,6 +32,7 @@ def get_ol_processor() -> Optional[Any]:
3132

3233

3334
def register_all_routes(app: FastAPI, grpc_handler, server=None, store=None):
35+
app.include_router(get_system_router())
3436
app.include_router(get_entity_router(grpc_handler))
3537
app.include_router(get_data_source_router(grpc_handler))
3638
app.include_router(get_feature_service_router(grpc_handler))
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
from __future__ import annotations
2+
3+
from fastapi import APIRouter
4+
from pydantic import BaseModel
5+
6+
from feast.version import get_version
7+
8+
9+
class VersionResponse(BaseModel):
10+
"""Runtime version information for the Feast server."""
11+
12+
version: str
13+
14+
15+
def get_system_router() -> APIRouter:
16+
router = APIRouter()
17+
18+
@router.get("/version", response_model=VersionResponse, tags=["System"])
19+
def get_feast_version() -> VersionResponse:
20+
"""Return the installed Feast package version for this process."""
21+
return VersionResponse(version=get_version())
22+
23+
return router

‎sdk/python/tests/unit/api/test_api_rest_registry_server.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,4 +75,4 @@ def test_routes_registered_in_app():
7575
server = MagicMock()
7676
register_all_routes(app, grpc_handler, server)
7777

78-
assert app.include_router.call_count == 15
78+
assert app.include_router.call_count == 16
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
from unittest.mock import patch
2+
3+
import pytest
4+
from fastapi import Depends, FastAPI, HTTPException
5+
from fastapi.testclient import TestClient
6+
7+
from feast.api.registry.rest.system import get_system_router
8+
9+
10+
@pytest.mark.parametrize("version", ["0.66.0", "unknown"])
11+
def test_version_endpoint_returns_runtime_package_version(version: str) -> None:
12+
app = FastAPI()
13+
app.include_router(get_system_router())
14+
15+
with patch("feast.api.registry.rest.system.get_version", return_value=version):
16+
response = TestClient(app).get("/version")
17+
18+
assert response.status_code == 200
19+
assert response.json() == {"version": version}
20+
21+
22+
def test_version_endpoint_inherits_application_authentication() -> None:
23+
def require_authentication() -> None:
24+
raise HTTPException(status_code=401, detail="Authentication required")
25+
26+
app = FastAPI(dependencies=[Depends(require_authentication)])
27+
app.include_router(get_system_router())
28+
29+
response = TestClient(app).get("/version")
30+
31+
assert response.status_code == 401
32+
assert response.json() == {"detail": "Authentication required"}

‎sdk/python/tests/unit/test_ui_server.py‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,17 @@ def test_ui_server_health_endpoint(ui_app_with_registry):
105105
assertpy.assert_that(response.status_code).is_equal_to(EXPECTED_SUCCESS_STATUS)
106106

107107

108+
def test_ui_server_exposes_version_under_rest_api(ui_app_with_registry):
109+
"""Version endpoint is mounted under the authenticated REST API."""
110+
client = TestClient(ui_app_with_registry)
111+
112+
with patch("feast.api.registry.rest.system.get_version", return_value="1.2.3"):
113+
response = client.get("/api/v1/version")
114+
115+
assertpy.assert_that(response.status_code).is_equal_to(EXPECTED_SUCCESS_STATUS)
116+
assertpy.assert_that(response.json()).is_equal_to({"version": "1.2.3"})
117+
118+
108119
def test_ui_server_health_endpoint_with_unavailable_registry(ui_app_without_registry):
109120
"""Health endpoint returns 503 when registry is unavailable."""
110121
client = TestClient(ui_app_without_registry)
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
import React from "react";
2+
import { EuiProvider } from "@elastic/eui";
3+
import { QueryClient, QueryClientProvider } from "react-query";
4+
import { http, HttpResponse } from "msw";
5+
import { setupServer } from "msw/node";
6+
7+
import { render, screen, waitFor } from "@testing-library/react";
8+
import DataModeContext from "../contexts/DataModeContext";
9+
import FeastVersion from "./FeastVersion";
10+
11+
const server = setupServer();
12+
13+
beforeAll(() => server.listen());
14+
afterEach(() => server.resetHandlers());
15+
afterAll(() => server.close());
16+
17+
const renderVersion = () => {
18+
const queryClient = new QueryClient({
19+
defaultOptions: { queries: { retry: false } },
20+
});
21+
22+
return render(
23+
<QueryClientProvider client={queryClient}>
24+
<DataModeContext.Provider value={{}}>
25+
<EuiProvider>
26+
<FeastVersion registryPath="/api/v1" />
27+
</EuiProvider>
28+
</DataModeContext.Provider>
29+
</QueryClientProvider>,
30+
);
31+
};
32+
33+
test("renders the running Feast version", async () => {
34+
server.use(
35+
http.get("/api/v1/version", () => HttpResponse.json({ version: "1.2.3" })),
36+
);
37+
38+
renderVersion();
39+
40+
expect(await screen.findByText("Feast v1.2.3")).toBeInTheDocument();
41+
});
42+
43+
test("renders an explicit unknown runtime version", async () => {
44+
server.use(
45+
http.get("/api/v1/version", () =>
46+
HttpResponse.json({ version: "unknown" }),
47+
),
48+
);
49+
50+
renderVersion();
51+
52+
expect(await screen.findByText("Feast version unknown")).toBeInTheDocument();
53+
});
54+
55+
test("hides the version when the endpoint is unavailable", async () => {
56+
let requestHandled = false;
57+
server.use(
58+
http.get("/api/v1/version", () => {
59+
requestHandled = true;
60+
return HttpResponse.json({ detail: "Not found" }, { status: 404 });
61+
}),
62+
);
63+
64+
const { container } = renderVersion();
65+
66+
await waitFor(() => expect(requestHandled).toBe(true));
67+
expect(container).not.toHaveTextContent(/Feast v|Feast version unknown/);
68+
});
69+
70+
test("hides a malformed version response", async () => {
71+
let requestHandled = false;
72+
server.use(
73+
http.get("/api/v1/version", () => {
74+
requestHandled = true;
75+
return HttpResponse.json({ feast_version: "1.2.3" });
76+
}),
77+
);
78+
79+
const { container } = renderVersion();
80+
81+
await waitFor(() => expect(requestHandled).toBe(true));
82+
expect(container).not.toHaveTextContent(/Feast v|Feast version unknown/);
83+
});

‎ui/src/components/FeastVersion.tsx‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
import React from "react";
2+
import { EuiText } from "@elastic/eui";
3+
4+
import useFeastVersion from "../queries/useFeastVersion";
5+
6+
const FeastVersion = ({ registryPath }: { registryPath: string }) => {
7+
const { data, isError, isLoading } = useFeastVersion(registryPath);
8+
9+
if (
10+
isLoading ||
11+
isError ||
12+
!data ||
13+
typeof data.version !== "string" ||
14+
data.version.length === 0
15+
) {
16+
return null;
17+
}
18+
19+
const label =
20+
data.version === "unknown"
21+
? "Feast version unknown"
22+
: `Feast v${data.version}`;
23+
24+
return (
25+
<EuiText size="xs" color="subdued">
26+
<span>{label}</span>
27+
</EuiText>
28+
);
29+
};
30+
31+
export default FeastVersion;

‎ui/src/mocks/handlers.ts‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,10 @@ const restPermissions = http.get("/api/v1/permissions", () =>
119119
}),
120120
);
121121

122+
const restVersion = http.get("/api/v1/version", () =>
123+
HttpResponse.json({ version: "0.66.0" }),
124+
);
125+
122126
// Detail endpoints
123127
const restFeatureViewDetail = http.get(
124128
"/api/v1/feature_views/:name",
@@ -304,6 +308,7 @@ const allRestHandlers = [
304308
restLabelViews,
305309
restLabels,
306310
restPermissions,
311+
restVersion,
307312
// Detail endpoints
308313
restFeatureViewDetail,
309314
restEntityDetail,

‎ui/src/pages/Layout.tsx‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ import ProjectSelector from "../components/ProjectSelector";
2929
import Sidebar from "./Sidebar";
3030
import FeastWordMark from "../graphics/FeastWordMark";
3131
import ThemeToggle from "../components/ThemeToggle";
32+
import FeastVersion from "../components/FeastVersion";
3233
import RegistrySearch, {
3334
RegistrySearchRef,
3435
} from "../components/RegistrySearch";
@@ -198,11 +199,13 @@ const Layout = () => {
198199
<div
199200
style={{
200201
display: "flex",
201-
justifyContent: "flex-start",
202+
justifyContent: "space-between",
202203
alignItems: "center",
204+
gap: 8,
203205
}}
204206
>
205207
<ThemeToggle />
208+
<FeastVersion registryPath={registryPath} />
206209
</div>
207210
</React.Fragment>
208211
)}

0 commit comments

Comments
 (0)