Merge pull request #110 from sebadob/ui-version-check

UI version check
sebadob · Oct 28, 2023 · 41b4c9c · 41b4c9c
2 parents b338f26 + 7041587
commit 41b4c9c
Show file tree

Hide file tree

Showing 13 changed files with 224 additions and 57 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/frontend/src/components/AppVersion.svelte b/frontend/src/components/AppVersion.svelte
@@ -0,0 +1,57 @@
+<script>
+    import {onMount} from "svelte";
+    import {getAppVersion} from "../utils/dataFetching.js";
+
+    let version = '';
+    let lastCheck;
+    let latestVersion;
+    let newVersionAvailable = false;
+    let updateUrl = '';
+
+    onMount(() => {
+        fetchVersion();
+    })
+
+    async function fetchVersion() {
+        let res = await getAppVersion();
+        if (res.ok) {
+            let body = await res.json();
+            version = body.current;
+            lastCheck = body.last_check;
+            latestVersion = body.latest;
+            updateUrl = body.latest_url;
+            newVersionAvailable = body.update_available;
+        }
+    }
+
+</script>
+
+{#if newVersionAvailable}
+    <div class="ver upd">
+        <a href={updateUrl} target="_blank">
+            v{version}⚠️
+        </a>
+    </div>
+{:else}
+    <div class="ver">
+        v{version}
+    </div>
+{/if}
+
+<style>
+    .upd {
+        cursor: pointer;
+    }
+
+    .ver {
+        margin: 0 .25rem;
+        display: flex;
+        align-items: center;
+        font-size: .85rem;
+    }
+
+    .ver > a {
+        text-decoration: none;
+        color: var(--col-text);
+    }
+</style>
diff --git a/frontend/src/lib/nav/Nav.svelte b/frontend/src/lib/nav/Nav.svelte
@@ -6,6 +6,7 @@
     import {tweened} from "svelte/motion";
     import {cubicOut} from "svelte/easing";
     import {onMount} from "svelte";
+    import AppVersion from "../../components/AppVersion.svelte";
 
     export let selected = '';
     export let widthExpanded = 180;
@@ -56,48 +57,60 @@
         style:width="{$width}px"
         style:padding={isExpanded ? '20px 10px' : '10px 3px'}
 >
-    {#if isExpanded}
-        <div
-                role="button"
-                tabindex="0"
-                class="close"
-                style:left="calc({$width}px - 22px)"
-                in:fade|global={{ delay: 500, duration: 200 }}
-                out:fade|global={{ duration: 100 }}
-                on:click={toggle}
-                on:keypress={toggle}
-        >
-            <IconClose/>
+    <div>
+        {#if isExpanded}
+            <div
+                    role="button"
+                    tabindex="0"
+                    class="close"
+                    style:left="calc({$width}px - 22px)"
+                    in:fade={{ delay: 500, duration: 200 }}
+                    out:fade={{ duration: 100 }}
+                    on:click={toggle}
+                    on:keypress={toggle}
+            >
+                <IconClose/>
+            </div>
+
+            <div class="logo" in:fade={{ delay: 250, duration: 100 }} out:fade={{ duration: 20 }}>
+                <slot name="logo"></slot>
+            </div>
+        {:else}
+            <div
+                    role="button"
+                    tabindex="0"
+                    class="burger"
+                    style:left="3px"
+                    in:fade={{ delay: 500, duration: 200 }}
+                    out:fade={{ duration: 100 }}
+                    on:click={toggle}
+                    on:keypress={toggle}
+            >
+                <IconBurger width={24}/>
+            </div>
+            <div style:height="10px"></div>
+            <div class="logo" in:fade={{ delay: 250, duration: 100 }} out:fade={{ duration: 20 }}>
+                <slot name="logo"></slot>
+            </div>
+        {/if}
+
+        <div class="menu">
+            <div class="links">
+                <slot name="entries"></slot>
+            </div>
         </div>
+    </div>
 
-        <div class="logo" in:fade|global={{ delay: 250, duration: 100 }} out:fade|global={{ duration: 20 }}>
-            <slot name="logo"></slot>
-        </div>
-    {:else}
+    {#if isExpanded}
         <div
-                role="button"
-                tabindex="0"
-                class="burger"
-                style:left="3px"
-                in:fade|global={{ delay: 500, duration: 200 }}
-                out:fade|global={{ duration: 100 }}
-                on:click={toggle}
-                on:keypress={toggle}
+                class="version"
+                in:fade={{ delay: 500, duration: 200 }}
+                out:fade={{ duration: 100 }}
         >
-            <IconBurger width={24}/>
-        </div>
-        <div style:height="10px"></div>
-        <div class="logo" in:fade|global={{ delay: 250, duration: 100 }} out:fade|global={{ duration: 20 }}>
-            <slot name="logo"></slot>
+            <AppVersion />
         </div>
     {/if}
 
-    <div class="menu">
-        <div class="links">
-            <slot name="entries"></slot>
-        </div>
-    </div>
-
 </nav>
 
 <style>
@@ -134,5 +147,12 @@
         height: 100vh;
         border-right: 1px solid var(--col-gmid);
         box-shadow: 1px 0 5px var(--col-gmid);
+        display: flex;
+        flex-direction: column;
+        justify-content: space-between;
+    }
+
+    .version {
+        margin: 0 0 -15px -5px;
     }
 </style>
diff --git a/frontend/src/routes/index/+page.svelte b/frontend/src/routes/index/+page.svelte
@@ -4,6 +4,7 @@
     import BrowserCheck from "../../components/BrowserCheck.svelte";
     import WithI18n from "$lib/WithI18n.svelte";
     import LangSelector from "$lib/LangSelector.svelte";
+    import AppVersion from "../../components/AppVersion.svelte";
 
     const btnWidth = "9rem";
 
@@ -44,6 +45,10 @@
             <Button on:click={redirectToAdmin} width={btnWidth}>{t.adminLogin.toUpperCase()}</Button>
         </div>
         <LangSelector absolute />
+
+        <div class="version">
+            <AppVersion />
+        </div>
     </WithI18n>
 </BrowserCheck>
 
@@ -52,4 +57,10 @@
         display: flex;
         flex-direction: column;
     }
+
+    .version {
+        position: absolute;
+        bottom: 0;
+        right: 0;
+    }
 </style>
diff --git a/frontend/src/utils/dataFetching.js b/frontend/src/utils/dataFetching.js
@@ -46,6 +46,14 @@ export async function authorizeRefresh(data) {
 	return res;
 }
 
+
+export async function getAppVersion() {
+	return await fetch('/auth/v1/version', {
+		method: 'GET',
+		headers: HEADERS.json,
+	});
+}
+
 export async function checkAdminAccess() {
 	return await fetch('/auth/v1/auth_check_admin', {
 		method: 'GET',

diff --git a/frontend/vite.config.js b/frontend/vite.config.js
@@ -31,6 +31,7 @@ const config = {
 			'/auth/v1/scopes': 'http://127.0.0.1:8080',
 			'/auth/v1/sessions': 'http://127.0.0.1:8080',
 			'/auth/v1/update_language': 'http://127.0.0.1:8080',
+			'/auth/v1/version': 'http://127.0.0.1:8080',
 			'/docs/v1/': 'http://127.0.0.1:8080',
 		}
 	}

diff --git a/rauthy-handlers/Cargo.toml b/rauthy-handlers/Cargo.toml
@@ -22,6 +22,7 @@ rauthy-models = { path = "../rauthy-models" }
 rauthy-service = { path = "../rauthy-service" }
 redhac = { workspace = true }
 rust-embed = { version = "6.8", features = ["actix-web", "tokio"] }
+semver = { workspace = true }
 time = { workspace = true }
 tracing = { workspace = true }
 tokio = { workspace = true }

diff --git a/rauthy-handlers/src/generic.rs b/rauthy-handlers/src/generic.rs
@@ -4,12 +4,13 @@ use actix_web::http::{header, StatusCode};
 use actix_web::web::Json;
 use actix_web::{get, post, put, web, HttpRequest, HttpResponse, Responder};
 use rauthy_common::constants::{
-    APPLICATION_JSON, CACHE_NAME_LOGIN_DELAY, HEADER_HTML, IDX_LOGIN_TIME,
+    APPLICATION_JSON, CACHE_NAME_LOGIN_DELAY, HEADER_HTML, IDX_LOGIN_TIME, RAUTHY_VERSION,
 };
 use rauthy_common::error_response::ErrorResponse;
 use rauthy_common::utils::build_csp_header;
 use rauthy_models::app_state::AppState;
 use rauthy_models::entity::api_keys::{AccessGroup, AccessRights};
+use rauthy_models::entity::app_version::LatestAppVersion;
 use rauthy_models::entity::colors::ColorEntity;
 use rauthy_models::entity::is_db_alive;
 use rauthy_models::entity::password::{PasswordHashTimes, PasswordPolicy};
@@ -30,7 +31,7 @@ use rauthy_models::request::{
     EncKeyMigrateRequest, I18nContent, I18nRequest, PasswordHashTimesRequest, PasswordPolicyRequest,
 };
 use rauthy_models::response::{
-    Argon2ParamsResponse, EncKeysResponse, HealthResponse, LoginTimeResponse,
+    AppVersionResponse, Argon2ParamsResponse, EncKeysResponse, HealthResponse, LoginTimeResponse,
     PasswordPolicyResponse,
 };
 use rauthy_models::templates::{
@@ -40,7 +41,10 @@ use rauthy_models::templates::{
 };
 use rauthy_service::encryption;
 use redhac::{cache_get, cache_get_from, cache_get_value, QuorumHealth, QuorumState};
+use semver::Version;
 use std::borrow::Cow;
+use std::str::FromStr;
+use tracing::error;
 
 #[get("/")]
 pub async fn get_index(
@@ -679,3 +683,42 @@ pub async fn whoami(req: HttpRequest) -> impl Responder {
     });
     HttpResponse::Ok().body(resp)
 }
+
+//github.com/ Returns the current Rauthy Version
+#[utoipa::path(
+    get,
+    path = "/version",
+    tag = "generic",
+    responses(
+        (status = 200, description = "Ok"),
+    ),
+)]
+#[get("/version")]
+pub async fn get_version(data: web::Data<AppState>) -> Result<HttpResponse, ErrorResponse> {
+    let resp = match LatestAppVersion::find(&data).await {
+        Some(latest) => {
+            let update_available = match Version::from_str(RAUTHY_VERSION) {
+                Ok(current) => latest.latest_version > current,
+                Err(err) => {
+                    error!("Cannot parse RAUTHY_VERSION: {:?}", err);
+                    false
+                }
+            };
+            AppVersionResponse {
+                current: RAUTHY_VERSION.to_string(),
+                last_check: Some(latest.timestamp),
+                latest: Some(latest.latest_version.to_string()),
+                latest_url: Some(latest.release_url.to_string()),
+                update_available,
+            }
+        }
+        None => AppVersionResponse {
+            current: RAUTHY_VERSION.to_string(),
+            last_check: None,
+            latest: None,
+            latest_url: None,
+            update_available: false,
+        },
+    };
+    Ok(HttpResponse::Ok().json(resp))
+}
diff --git a/rauthy-handlers/src/openapi.rs b/rauthy-handlers/src/openapi.rs
@@ -57,6 +57,7 @@ use utoipa::{openapi, OpenApi};
         generic::get_ready,
         generic::ping,
         generic::whoami,
+        generic::get_version,
 
         groups::get_groups,
         groups::post_group,
@@ -176,6 +177,7 @@ use utoipa::{openapi, OpenApi};
             request::WebauthnAuthStartRequest,
             request::WebauthnAuthFinishRequest,
 
+            response::AppVersionResponse,
             response::BlacklistResponse,
             response::BlacklistedIp,
             response::LoginTimeResponse,

diff --git a/rauthy-main/src/main.rs b/rauthy-main/src/main.rs
@@ -409,6 +409,7 @@ async fn actix_main(app_state: web::Data<AppState>) -> std::io::Result<()> {
                         .service(generic::get_auth_check_admin)
                         .service(generic::post_i18n)
                         .service(generic::post_update_language)
+                        .service(generic::get_version)
                         .service(oidc::get_authorize)
                         .service(oidc::post_authorize)
                         .service(oidc::get_callback_html)