Skip to content

Feature/added alive page #2538

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
simonredfern merged 2 commits into from
Apr 29, 2025
Merged

Feature/added alive page #2538

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
86cf836
refactor/add aLiveHtml and related menu entry for enhanced API status…
hongwei1 Apr 24, 2025
6a9ab7c
refactor/add alive page to SiteMap for improved API status testing
hongwei1 Apr 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions obp-api/src/main/scala/bootstrap/liftweb/Boot.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -559,6 +559,9 @@ class Boot extends MdcLoggable {

logger.info (s"props_identifier is : ${APIUtil.getPropsValue("props_identifier", "NONE-SET")}")

// This will work for both portal and API modes. This page is used for testing if the API is running properly.
val alivePage = List( Menu.i("Alive") / "alive")

val commonMap = List(Menu.i("Home") / "index") ::: List(
Menu.i("Plain") / "plain",
Menu.i("Static") / "static",
Expand Down Expand Up @@ -595,12 +598,12 @@ class Boot extends MdcLoggable {
Menu.i("confirm-bg-consent-request-redirect-uri") / "confirm-bg-consent-request-redirect-uri" >> AuthUser.loginFirst,//OAuth consent page,
Menu.i("confirm-vrp-consent-request") / "confirm-vrp-consent-request" >> AuthUser.loginFirst,//OAuth consent page,
Menu.i("confirm-vrp-consent") / "confirm-vrp-consent" >> AuthUser.loginFirst //OAuth consent page
) ++ accountCreation ++ Admin.menus
) ++ accountCreation ++ Admin.menus++ alivePage

// Build SiteMap
val sitemap = APIUtil.getPropsValue("server_mode", "apis,portal") match {
case mode if mode == "portal" => commonMap
case mode if mode == "apis" => List()
case mode if mode == "apis" => alivePage
case mode if mode.contains("apis") && mode.contains("portal") => commonMap
case _ => commonMap
}
Expand Down
9 changes: 9 additions & 0 deletions obp-api/src/main/scala/code/snippet/WebUI.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,15 @@ class WebUI extends MdcLoggable{
def aboutText: CssSel = {
"#main-about-text *" #> scala.xml.Unparsed(getWebUiPropsValue("webui_index_page_about_section_text", ""))
}

def aLiveHtml: CssSel = {
"#get-disabled-versions *" #> scala.xml.Unparsed(APIUtil.getDisabledVersions.toString())&
"#get-enabled-versions *" #> scala.xml.Unparsed(APIUtil.getEnabledVersions.toString())&
"#get-disabled-endpoint-operation-ids *" #> scala.xml.Unparsed(APIUtil.getDisabledEndpointOperationIds.toString())&
"#get-enabled-endpoint-operation-ids *" #> scala.xml.Unparsed(APIUtil.getEnabledEndpointOperationIds.toString())&
"#alive-disabled-api-mode *" #> scala.xml.Unparsed(getWebUiPropsValue("server_mode", "apis,portal"))
}


def topText: CssSel = {
"#top-text *" #> scala.xml.Unparsed(getWebUiPropsValue("webui_top_text", ""))
Expand Down
14 changes: 14 additions & 0 deletions obp-api/src/main/webapp/alive.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<div data-lift="surround?with=default;at=content">
<div id="add-user-auth-context-update-request-div" data-lift="WebUI.aLiveHtml">
<h3> Disabled Versions: </h3>
<div id="get-disabled-versions"></div>
<h3> Enabled Versions: </h3>
<div id="get-enabled-versions"></div>
<h3> Disabled Endpoint Operation Ids: </h3>
<div id="get-disabled-endpoint-operation-ids"></div>
<h3> Enabled Endpoint Operation Ids: </h3>
<div id="get-enabled-endpoint-operation-ids"></div>
<h3> API Mode: </h3>
<div id="alive-disabled-api-mode"></div>
</div>
</div>