risingwave_meta_dashboard/
lib.rs

1// Copyright 2025 RisingWave Labs
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15#![allow(clippy::doc_markdown)]
16
17use axum::Router;
18
19mod embed;
20mod proxy;
21
22/// The router for the dashboard.
23///
24/// Based on the configuration, it will either serve the assets embedded in the binary,
25/// or proxy all requests to the latest static files built and hosted on GitHub.
26///
27/// - If env var `ENABLE_BUILD_DASHBOARD` is not set during the build, the requests to
28///   the dashboard will be proxied. This is to reduce the build time and eliminate the
29///   dependency on `node`, so that the developer experience can be better. This is the
30///   default behavior for CI and development builds.
31///
32/// - If env var `ENABLE_BUILD_DASHBOARD` is set during the build, the assets will be
33///   built in the build script and embedded in the binary. This is to make the
34///   deployment easier and the dashboard more reliable without relying on external or
35///   remote resources. This is the default behavior for versioned releases, and can be
36///   manually enabled for development builds with RiseDev.
37///
38/// If you're going to develop with the dashboard, see `dashboard/README.md` for more
39/// details.
40pub fn router() -> Router {
41    // We use `cfg!` instead of `#[cfg]` here to ensure both branches can be checked
42    // by the compiler no matter which one is actually used.
43    if cfg!(dashboard_built) {
44        tracing::info!("using embedded dashboard assets");
45        embed::router()
46    } else {
47        tracing::info!("using proxied dashboard assets");
48        proxy::router()
49    }
50}
risingwave_meta_dashboard/lib.rs

risingwave_meta_dashboard/
lib.rs
