Adding RAW data to the VulnerabilityView (#2741)

saveourtool · Oct 18, 2023 · b6ae0c9 · b6ae0c9
1 parent 3db81fa
commit b6ae0c9
Show file tree

Hide file tree

Showing 16 changed files with 232 additions and 32 deletions.
diff --git a/save-cloud-common/src/commonMain/kotlin/com/saveourtool/save/validation/FrontendRoutes.kt b/save-cloud-common/src/commonMain/kotlin/com/saveourtool/save/validation/FrontendRoutes.kt
@@ -31,7 +31,6 @@ enum class FrontendRoutes(val path: String) {
     INDEX(""),
     MANAGE_ORGANIZATIONS("organizations"),
     NOT_FOUND("not-found"),
-    PROFILE("profile"),
     PROJECTS("projects"),
     REGISTRATION("registration"),
     SANDBOX("sandbox"),
@@ -48,6 +47,7 @@ enum class FrontendRoutes(val path: String) {
     VULNERABILITIES("$VULN/list"),
     VULNERABILITY_SINGLE("$VULN/collection"),
     VULN_COSV_SCHEMA("$VULN/schema"),
+    VULN_PROFILE("$VULN/profile"),
     VULN_TOP_RATING("$VULN/top-rating"),
     ;
 

diff --git a/save-frontend/build.gradle.kts b/save-frontend/build.gradle.kts
@@ -113,6 +113,7 @@ kotlin {
             implementation(npm("react-avatar-image-cropper", "^1.4.2"))
             implementation(npm("react-circle", "^1.1.1"))
             implementation(npm("react-diff-viewer-continued", "^3.2.6"))
+            implementation(npm("react-json-view", "^1.21.3"))
             implementation(npm("multi-range-slider-react", "^2.0.5"))
             // react-sigma
             implementation(npm("@react-sigma/core", "^3.1.0"))

diff --git a/...rontend/src/main/kotlin/com/saveourtool/save/frontend/components/basic/AvatarRenderers.kt b/...rontend/src/main/kotlin/com/saveourtool/save/frontend/components/basic/AvatarRenderers.kt
@@ -95,7 +95,7 @@ fun ChildrenBuilder.renderAvatar(
     isLinkActive: Boolean = true,
     styleBuilder: CSSProperties.() -> Unit,
 ) {
-    val newLink = (link ?: "/${FrontendRoutes.PROFILE}/${userInfo?.name}").takeIf { userInfo?.status != UserStatus.DELETED && isLinkActive }
+    val newLink = (link ?: "/${FrontendRoutes.VULN_PROFILE}/${userInfo?.name}").takeIf { userInfo?.status != UserStatus.DELETED && isLinkActive }
     return renderAvatar(
         userInfo?.avatar?.avatarRenderer() ?: AVATAR_PROFILE_PLACEHOLDER,
         classes,
@@ -151,7 +151,7 @@ fun ChildrenBuilder.renderUserAvatarWithName(
     }
     return if (userInfo.status != UserStatus.DELETED) {
         Link {
-            to = "/${FrontendRoutes.PROFILE}/${userInfo.name}"
+            to = "/${FrontendRoutes.VULN_PROFILE}/${userInfo.name}"
             renderImg()
         }
     } else {

diff --git a/save-frontend/src/main/kotlin/com/saveourtool/save/frontend/components/basic/Forum.kt b/save-frontend/src/main/kotlin/com/saveourtool/save/frontend/components/basic/Forum.kt
@@ -210,7 +210,7 @@ private fun ChildrenBuilder.renderLeftColumn(
                                 width = 80.0
                                 onError = { setAvatar(AVATAR_PLACEHOLDER) }
                             }
-                            to = "/${FrontendRoutes.PROFILE}/$name"
+                            to = "/${FrontendRoutes.VULN_PROFILE}/$name"
                         }
                     }
                     div {
@@ -230,7 +230,7 @@ private fun ChildrenBuilder.renderLeftColumn(
                         h1 {
                             className = ClassName("col-12 text-center font-weight-bold h5")
                             Link {
-                                to = "/${FrontendRoutes.PROFILE}/$name"
+                                to = "/${FrontendRoutes.VULN_PROFILE}/$name"
                                 +name
                             }
                         }

diff --git a/save-frontend/src/main/kotlin/com/saveourtool/save/frontend/components/basic/UserBoard.kt b/save-frontend/src/main/kotlin/com/saveourtool/save/frontend/components/basic/UserBoard.kt
@@ -30,7 +30,7 @@ val userBoard: FC<UserBoardProps> = FC { props ->
                 div {
                     className = ClassName(props.avatarOuterClasses.orEmpty())
                     figure {
-                        renderAvatar(user, props.avatarInnerClasses.orEmpty(), "/${FrontendRoutes.PROFILE}/${user.name}") {
+                        renderAvatar(user, props.avatarInnerClasses.orEmpty(), "/${FrontendRoutes.VULN_PROFILE}/${user.name}") {
                             // just some default values in case you don't want to provide value
                             // in this case you will get small avatar
                             width = props.widthAndHeight ?: 4.rem

diff --git a/...ontend/src/main/kotlin/com/saveourtool/save/frontend/components/topbar/TopBarUserField.kt b/...ontend/src/main/kotlin/com/saveourtool/save/frontend/components/topbar/TopBarUserField.kt
@@ -101,7 +101,7 @@ val topBarUserField: FC<TopBarUserFieldProps> = FC { props ->
                 props.userInfo?.name?.let { name ->
                     dropdownEntry(faUser, "Profile".t()) { attrs ->
                         attrs.onClick = {
-                            navigate(to = "/${FrontendRoutes.PROFILE}/$name")
+                            navigate(to = "/${FrontendRoutes.VULN_PROFILE}/$name")
                         }
                     }
                     dropdownEntry(faCog, "Settings".t()) { attrs ->

diff --git a/...frontend/src/main/kotlin/com/saveourtool/save/frontend/components/views/index/CardUser.kt b/...frontend/src/main/kotlin/com/saveourtool/save/frontend/components/views/index/CardUser.kt
@@ -82,7 +82,7 @@ val cardUser: FC<IndexViewProps> = FC { props ->
                 }
                 +"${"Welcome".t()}${props.userInfo?.name?.let { ", " } ?: ""}"
                 Link {
-                    to = "/${FrontendRoutes.PROFILE}/${props.userInfo?.name}"
+                    to = "/${FrontendRoutes.VULN_PROFILE}/${props.userInfo?.name}"
                     b {
                         +(props.userInfo?.name?.let { " @$it " } ?: "")
                     }
@@ -242,7 +242,7 @@ val cardUser: FC<IndexViewProps> = FC { props ->
                         className = ClassName("col-3")
                         p {
                             Link {
-                                to = "/${FrontendRoutes.PROFILE}/${props.userInfo?.name}"
+                                to = "/${FrontendRoutes.VULN_PROFILE}/${props.userInfo?.name}"
                                 +countVulnerability.toString()
                             }
                         }

diff --git a/...main/kotlin/com/saveourtool/save/frontend/components/views/userprofile/UserProfileView.kt b/...main/kotlin/com/saveourtool/save/frontend/components/views/userprofile/UserProfileView.kt
@@ -137,7 +137,7 @@ enum class UserProfileTab {
     companion object : TabMenuBar<UserProfileTab> {
         override val nameOfTheHeadUrlSection = ""
         override val defaultTab: UserProfileTab = VULNERABILITIES
-        override val regexForUrlClassification = "/${FrontendRoutes.PROFILE}"
+        override val regexForUrlClassification = "/${FrontendRoutes.VULN_PROFILE}"
         override fun valueOf(elem: String): UserProfileTab = UserProfileTab.valueOf(elem)
         override fun values(): Array<UserProfileTab> = UserProfileTab.values()
     }

diff --git a/...lin/com/saveourtool/save/frontend/components/views/usersettings/SettingsViewLeftColumn.kt b/...lin/com/saveourtool/save/frontend/components/views/usersettings/SettingsViewLeftColumn.kt
@@ -80,7 +80,7 @@ val leftSettingsColumn: FC<SettingsProps> = FC { props ->
                                     className = ClassName("row justify-content-center")
                                     h6 {
                                         Link {
-                                            to = "/${FrontendRoutes.PROFILE}/${props.userInfo?.name}"
+                                            to = "/${FrontendRoutes.VULN_PROFILE}/${props.userInfo?.name}"
                                             style = jso {
                                                 textDecoration = TextDecoration.underline
                                             }

diff --git a/...ain/kotlin/com/saveourtool/save/frontend/components/views/vuln/VulnerabilityChangesTab.kt b/...ain/kotlin/com/saveourtool/save/frontend/components/views/vuln/VulnerabilityChangesTab.kt
@@ -20,7 +20,7 @@ import kotlinx.serialization.json.Json
 
 private val json = Json { prettyPrint = true }
 
-val vulnerabilityChangesTab: FC<VulnerabilityChangesTabProps> = FC { props ->
+val vulnerabilityChangesTab: FC<VulnerabilityChangesTab> = FC { props ->
 
     val (cosvVersions, setCosvVersions) = useState(emptyList<CosvFileDto>())
 
@@ -126,7 +126,7 @@ val vulnerabilityChangesTab: FC<VulnerabilityChangesTabProps> = FC { props ->
 /**
  * [Props] of vulnerability changes tab component
  */
-external interface VulnerabilityChangesTabProps : Props {
+external interface VulnerabilityChangesTab : Props {
     /**
      * Vulnerability identifier
      */

diff --git a/...rc/main/kotlin/com/saveourtool/save/frontend/components/views/vuln/VulnerabilityHeader.kt b/...rc/main/kotlin/com/saveourtool/save/frontend/components/views/vuln/VulnerabilityHeader.kt
@@ -244,17 +244,16 @@ internal val headerMenu: FC<HeaderMenuProps> = FC { props ->
                             props.setIsTableView { !it }
                         }
                     }
-                    if (props.selectedMenu == VulnerabilityTab.INFO) {
-                        a {
-                            buttonBuilder(
-                                faDownload,
-                                "secondary",
-                                classes = "mr-2",
-                                isOutline = true,
-                                title = "Download vulnerability in COSV".t(),
-                            ) { }
-                            href = "$apiUrl/vulnerabilities/download?identifier=${props.vulnerability.cosv.id}"
-                        }
+
+                    a {
+                        buttonBuilder(
+                            faDownload,
+                            "secondary",
+                            classes = "mr-2",
+                            isOutline = true,
+                            title = "Download vulnerability in COSV".t(),
+                        ) { }
+                        href = "$apiUrl/vulnerabilities/download?identifier=${props.vulnerability.cosv.id}"
                     }
 
                     if (props.permissions.isSuperAdmin ||

diff --git a/...ain/kotlin/com/saveourtool/save/frontend/components/views/vuln/VulnerabilityRawDataTab.kt b/...ain/kotlin/com/saveourtool/save/frontend/components/views/vuln/VulnerabilityRawDataTab.kt
@@ -0,0 +1,29 @@
+@file:Suppress("FILE_NAME_MATCH_CLASS", "HEADER_MISSING_IN_NON_SINGLE_CLASS_FILE")
+
+package com.saveourtool.save.frontend.components.views.vuln
+
+import com.saveourtool.save.entities.cosv.VulnerabilityExt
+import com.saveourtool.save.frontend.externals.jsonview.reactJson
+import react.FC
+import react.Props
+
+import kotlinx.serialization.encodeToString
+import kotlinx.serialization.json.Json
+
+val vulnerabilityRawDataTab: FC<VulnerabilityRawDataTabProps> = FC { props ->
+    reactJson {
+        src = JSON.parse(Json.encodeToString(props.vulnerability.cosv))
+        name = false
+        theme = "bright:inverted"
+    }
+}
+
+/**
+ * [Props] of vulnerability changes tab component
+ */
+external interface VulnerabilityRawDataTabProps : Props {
+    /**
+     * Vulnerability identifier
+     */
+    var vulnerability: VulnerabilityExt
+}
diff --git a/.../src/main/kotlin/com/saveourtool/save/frontend/components/views/vuln/VulnerabilityView.kt b/.../src/main/kotlin/com/saveourtool/save/frontend/components/views/vuln/VulnerabilityView.kt
@@ -147,6 +147,10 @@ val vulnerabilityView: FC<VulnerabilitiesViewProps> = FC { props ->
                         VulnerabilityTab.CHANGES -> vulnerabilityChangesTab {
                             this.identifier = props.identifier
                         }
+
+                        VulnerabilityTab.RAW -> vulnerabilityRawDataTab {
+                            this.vulnerability = vulnerability
+                        }
                     }
                 }
             }
@@ -163,13 +167,14 @@ enum class VulnerabilityTab {
     COMMENTS,
     HISTORY,
     CHANGES,
+    RAW,
     // PROPOSED_CHANGES,
     ;
 
     companion object : TabMenuBar<VulnerabilityTab> {
         override val nameOfTheHeadUrlSection = ""
         override val defaultTab: VulnerabilityTab = INFO
-        override val regexForUrlClassification = "/${FrontendRoutes.PROFILE}"
+        override val regexForUrlClassification = "/${FrontendRoutes.VULN_PROFILE}"
         override fun valueOf(elem: String): VulnerabilityTab = VulnerabilityTab.valueOf(elem)
         override fun values(): Array<VulnerabilityTab> = VulnerabilityTab.values()
     }

diff --git a/save-frontend/src/main/kotlin/com/saveourtool/save/frontend/externals/jsonview/JsonView.kt b/save-frontend/src/main/kotlin/com/saveourtool/save/frontend/externals/jsonview/JsonView.kt
@@ -0,0 +1,38 @@
+@file:Suppress("HEADER_MISSING_IN_NON_SINGLE_CLASS_FILE", "FILE_NAME_MATCH_CLASS")
+@file:JsModule("react-json-view")
+@file:JsNonModule
+
+package com.saveourtool.save.frontend.externals.jsonview
+
+import react.FC
+import react.Props
+import kotlin.js.Json
+
+/**
+ * External declaration of [reactJson] react component
+ */
+@JsName("default")
+external val reactJson: FC<ReactJsonViewProps>
+
+/**
+ * Props of [ReactJsonViewProps]
+ */
+external interface ReactJsonViewProps : Props {
+    /**
+     * Input JSON
+     */
+    var src: Json
+
+    /**
+     * name : {} or no name in case of false
+     */
+    var name: Boolean
+
+    /**
+     * theme for the background
+     */
+    var theme: String
+    // FixMe:   onAdd?: ((add: InteractionProps) => false | any) | false;
+    // FixMe:   onEdit?: ((edit: InteractionProps) => false | any) | false;
+    // FixMe:   onDelete?: ((del: InteractionProps) => false | any) | false;
+}
diff --git a/save-frontend/src/main/kotlin/com/saveourtool/save/frontend/routing/BasicRouting.kt b/save-frontend/src/main/kotlin/com/saveourtool/save/frontend/routing/BasicRouting.kt
@@ -206,7 +206,7 @@ val basicRouting: FC<AppProps> = FC { props ->
             uploadVulnerabilityView.create() to UPLOAD_VULNERABILITY,
             vulnerabilityView.create() to "$VULNERABILITY_SINGLE/:identifier",
             demoCollectionView.create() to DEMO,
-            userProfileView.create() to "$PROFILE/:name",
+            userProfileView.create() to "$VULN_PROFILE/:name",
             topRatingView.create() to VULN_TOP_RATING,
             termsOfUsageView.create() to TERMS_OF_USE,
             cookieTermsOfUse.create() to COOKIE,