🐛 DepReport aggregated by name. (#558)

Update /analyses/report/dependencies to group by (provider, name) instead of (name, version, sha). Currently, provider is always "". Removes DepReport fields: - version - sha Also fixes DepAppReport.SHA JSON field name. fixes: #557 --------- Signed-off-by: Jeff Ortel <jortel@redhat.com>
konveyor · Nov 15, 2023 · ce5a30e · ce5a30e
1 parent 3072c25
commit ce5a30e
Show file tree

Hide file tree

Showing 7 changed files with 1,475 additions and 1,386 deletions.
diff --git a/api/analysis.go b/api/analysis.go
@@ -16,6 +16,7 @@ import (
 	"io"
 	"net/http"
 	"os"
+	"sort"
 	"strconv"
 	"strings"
 )
@@ -1364,8 +1365,7 @@ func (h AnalysisHandler) Deps(ctx *gin.Context) {
 // @description sort:
 // @description - provider
 // @description - name
-// @description - version
-// @description - sha
+// @description - labels
 // @tags dependencies
 // @produce json
 // @success 200 {object} []api.TechDependency
@@ -1406,16 +1406,15 @@ func (h AnalysisHandler) DepReports(ctx *gin.Context) {
 	// Inner Query
 	q := h.DB(ctx)
 	q = q.Select(
-		"Provider",
-		"Name",
-		"Version",
-		"SHA",
-		"Labels",
-		"COUNT(distinct AnalysisID) Applications")
-	q = q.Model(&model.TechDependency{})
-	q = q.Where("AnalysisID IN (?)", h.analysisIDs(ctx, filter))
-	q = q.Where("ID IN (?)", h.depIDs(ctx, filter))
-	q = q.Group("Name,SHA")
+		"d.Provider",
+		"d.Name",
+		"json_group_array(distinct j.value) Labels",
+		"COUNT(distinct d.AnalysisID) Applications")
+	q = q.Table("TechDependency d")
+	q = q.Joins(",json_each(Labels) j")
+	q = q.Where("d.AnalysisID IN (?)", h.analysisIDs(ctx, filter))
+	q = q.Where("d.ID IN (?)", h.depIDs(ctx, filter))
+	q = q.Group("d.Provider, d.Name")
 	// Find
 	db := h.DB(ctx)
 	db = db.Select("*")
@@ -1448,12 +1447,16 @@ func (h AnalysisHandler) DepReports(ctx *gin.Context) {
 		r := DepReport{
 			Provider:     m.Provider,
 			Name:         m.Name,
-			Version:      m.Version,
-			SHA:          m.SHA,
 			Applications: m.Applications,
 		}
 		if m.Labels != nil {
-			_ = json.Unmarshal(m.Labels, &r.Labels)
+			var aggregated []string
+			_ = json.Unmarshal(m.Labels, &aggregated)
+			for _, s := range aggregated {
+				if s != "" {
+					r.Labels = append(r.Labels, s)
+				}
+			}
 		}
 		resources = append(resources, r)
 	}
@@ -1964,6 +1967,7 @@ func (r *TechDependency) With(m *model.TechDependency) {
 //
 // Model builds a model.
 func (r *TechDependency) Model() (m *model.TechDependency) {
+	sort.Strings(r.Labels)
 	m = &model.TechDependency{}
 	m.Name = r.Name
 	m.Version = r.Version
@@ -2083,8 +2087,6 @@ type FileReport struct {
 type DepReport struct {
 	Provider     string   `json:"provider"`
 	Name         string   `json:"name"`
-	Version      string   `json:"version"`
-	SHA          string   `json:"sha"`
 	Labels       []string `json:"labels"`
 	Applications int      `json:"applications"`
 }
@@ -2101,7 +2103,7 @@ type DepAppReport struct {
 		Provider string   `json:"provider"`
 		Name     string   `json:"name"`
 		Version  string   `json:"version"`
-		SHA      string   `json:"rule"`
+		SHA      string   `json:"sha"`
 		Indirect bool     `json:"indirect"`
 		Labels   []string `json:"labels"`
 	} `json:"dependency"`

diff --git a/docs/docs.go b/docs/docs.go
@@ -1,4 +1,5 @@
-// Package docs Code generated by swaggo/swag. DO NOT EDIT
+// Package docs GENERATED BY SWAG; DO NOT EDIT
+// This file was generated by swaggo/swag
 package docs
 
 import "github.com/swaggo/swag"
@@ -139,7 +140,7 @@ const docTemplate = `{
         },
         "/analyses/dependencies": {
             "get": {
-                "description": "Each report collates dependencies by name and SHA.\nfilters:\n- provider\n- name\n- version\n- sha\n- indirect\n- labels\n- application.id\n- application.name\n- businessService.id\n- businessService.name\n- tag.id\nsort:\n- provider\n- name\n- version\n- sha",
+                "description": "Each report collates dependencies by name and SHA.\nfilters:\n- provider\n- name\n- version\n- sha\n- indirect\n- labels\n- application.id\n- application.name\n- businessService.id\n- businessService.name\n- tag.id\nsort:\n- provider\n- name\n- labels",
                 "produces": [
                     "application/json"
                 ],
@@ -5849,7 +5850,7 @@ const docTemplate = `{
                         "provider": {
                             "type": "string"
                         },
-                        "rule": {
+                        "sha": {
                             "type": "string"
                         },
                         "version": {
@@ -7429,8 +7430,6 @@ var SwaggerInfo = &swag.Spec{
 	Description:      "",
 	InfoInstanceName: "swagger",
 	SwaggerTemplate:  docTemplate,
-	LeftDelim:        "{{",
-	RightDelim:       "}}",
 }
 
 func init() {

diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/openapi3.json b/docs/openapi3.json
@@ -140,7 +140,7 @@
           "dependencies"
         ],
         "summary": "List dependency reports.",
-        "description": "Each report collates dependencies by name and SHA.\nfilters:\n- provider\n- name\n- version\n- sha\n- indirect\n- labels\n- application.id\n- application.name\n- businessService.id\n- businessService.name\n- tag.id\nsort:\n- provider\n- name\n- version\n- sha",
+        "description": "Each report collates dependencies by name and SHA.\nfilters:\n- provider\n- name\n- version\n- sha\n- indirect\n- labels\n- application.id\n- application.name\n- businessService.id\n- businessService.name\n- tag.id\nsort:\n- provider\n- name\n- labels",
         "responses": {
           "200": {
             "description": "OK",
@@ -6240,7 +6240,7 @@
               "provider": {
                 "type": "string"
               },
-              "rule": {
+              "sha": {
                 "type": "string"
               },
               "version": {
@@ -6297,10 +6297,12 @@
         }
       },
       "api.FactMap": {
-        "type": "object"
+        "type": "object",
+        "additionalProperties": true
       },
       "api.Fields": {
-        "type": "object"
+        "type": "object",
+        "additionalProperties": true
       },
       "api.File": {
         "type": "object",
@@ -6388,7 +6390,8 @@
         }
       },
       "api.Import": {
-        "type": "object"
+        "type": "object",
+        "additionalProperties": true
       },
       "api.ImportSummary": {
         "type": "object",
@@ -7812,5 +7815,6 @@
         }
       }
     }
-  }
+  },
+  "x-original-swagger-version": "2.0"
 }
diff --git a/docs/swagger.json b/docs/swagger.json
@@ -130,7 +130,7 @@
         },
         "/analyses/dependencies": {
             "get": {
-                "description": "Each report collates dependencies by name and SHA.\nfilters:\n- provider\n- name\n- version\n- sha\n- indirect\n- labels\n- application.id\n- application.name\n- businessService.id\n- businessService.name\n- tag.id\nsort:\n- provider\n- name\n- version\n- sha",
+                "description": "Each report collates dependencies by name and SHA.\nfilters:\n- provider\n- name\n- version\n- sha\n- indirect\n- labels\n- application.id\n- application.name\n- businessService.id\n- businessService.name\n- tag.id\nsort:\n- provider\n- name\n- labels",
                 "produces": [
                     "application/json"
                 ],
@@ -5840,7 +5840,7 @@
                         "provider": {
                             "type": "string"
                         },
-                        "rule": {
+                        "sha": {
                             "type": "string"
                         },
                         "version": {

diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -260,7 +260,7 @@ definitions:
             type: string
           provider:
             type: string
-          rule:
+          sha:
             type: string
           version:
             type: string
@@ -1431,8 +1431,7 @@ paths:
         sort:
         - provider
         - name
-        - version
-        - sha
+        - labels
       produces:
       - application/json
       responses:

diff --git a/hack/add/analysis.sh b/hack/add/analysis.sh
@@ -156,11 +156,19 @@ done
 file=${dPath}
 echo -n "---
 name: github.com/jboss
-version: 5.0
+version: 4.0
 labels:
-- konveyor.io/dep-source
+- konveyor.io/language=java
+- konveyor.io/otherA=dog
 " > ${file}
 echo -n "---
+name: github.com/jboss
+version: 5.0
+labels:
+- konveyor.io/language=java
+- konveyor.io/otherA=cat
+" >> ${file}
+echo -n "---
 name: github.com/hybernate
 indirect: "true"
 version: 4.6