fix: Wrong version order in package diff

* fix: Incorrect version diffing

* fix: Add request methods to README

.github/workflows/build.yml

@@ -18,7 +18,7 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v5
       with:
-        go-version: 1.21
+        go-version: 1.22
 
     - name: Install dependencies
       run: |
@@ -38,7 +38,7 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v5
       with:
-        go-version: 1.21
+        go-version: 1.22
 
     - name: Install test dependencies
       run: |
@@ -47,4 +47,4 @@ jobs:
 
     - name: Test
       run: |
-        go test -v ./...
+        go test -v ./.../...

Makefile

@@ -3,6 +3,9 @@ all: clean differ
 differ:
 	go build -o differ -tags="sonic avx" .
 
+test:
+	go test -v ./.../...
+
 .PHONY: clean
 
 clean:

README.md

@@ -48,6 +48,7 @@ $ podman run --env 'admin_user=user' --env 'admin_password=password' differ path
 
 Simple check to see if the server is running correctly.
 
+*Method:* `GET`
 *Endpoint:* `http://[base_url]/status`
 
 *Parameters:* None
@@ -71,6 +72,7 @@ For example, a distro can ship both GNOME and a KDE versions as separate images,
 
 Creates a new image in the dabatase. Every release (see subsection below) is attached to an image.
 
+*Method:* `POST`
 *Endpoint:* `http://[base_url]/images/new`
 
 *Parameters:*
@@ -93,7 +95,8 @@ Creates a new image in the dabatase. Every release (see subsection below) is att
 
 Retrieves information about an image given its name.
 
-**Endpoint:* `http://[base_url]/images/[name]`
+*Method:* `GET`
+*Endpoint:* `http://[base_url]/images/[name]`
 
 *Parameters:* None
 
@@ -119,6 +122,7 @@ Retrieves information about an image given its name.
 
 Retrieves information about all images.
 
+*Method:* `GET`
 *Endpoint:* `http://[base_url]/images`
 
 *Parameters:* None
@@ -156,6 +160,7 @@ A release is a new version of some image, where packages can be added, removed,
 
 Creates a new release for the given image.
 
+*Method:* `POST`
 *Endpoint:*`http://[base_url]/images/[image]/new`
 
 *Parameters:*
@@ -184,6 +189,7 @@ Creates a new release for the given image.
 
 Retrieves the most recent release from the image.
 
+*Method:* `GET`
 *Endpoint:* `http://[base_url]/images/[image]/latest`
 
 *Parameters:* None
@@ -208,6 +214,7 @@ Retrieves the most recent release from the image.
 
 Searches for a specific release by its digest.
 
+*Method:* `GET`
 *Endpoint:* `http://[base_url]/images/[image]/[digest]`
 
 *Parameters:* None
@@ -234,6 +241,7 @@ Searches for a specific release by its digest.
 
 The most important endpoint in the API. Given two digests, generates a list of changed packages. This information is cached so future queries are nearly instant.
 
+*Method:* `GET`
 *Endpoint:* `http://[base_url]/images/[image]/diff`
 
 *Parameters:*

core/handlers/handle_releases.go

@@ -140,7 +140,7 @@ func HandleGetReleaseDiff(c *gin.Context) {
 		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
 		return
 	}
-	added, upgraded, downgraded, removed := newRelease.DiffPackages(oldRelease)
+	added, upgraded, downgraded, removed := oldRelease.DiffPackages(newRelease)
 
 	cacheDiffEntry := struct {
 		Added, Upgraded, Downgraded, Removed []diff.PackageDiff

diff/diff.go

@@ -7,6 +7,12 @@ import (
 	"sync"
 )
 
+const (
+	Upgraded   = -1
+	Downgraded = 1
+	Added      = 2
+)
+
 type Package map[string]string
 
 type PackageDiff struct {
@@ -51,15 +57,15 @@ func CompareVersions(a, b string) int {
 		// If a has component but b doesn't, package was upgraded, unless it's prerelease
 		if aOk && !bOk {
 			if comp == "prerelease" {
-				compResult = -1
+				compResult = Downgraded
 			} else {
-				compResult = 1
+				compResult = Upgraded
 			}
 			break
 		}
 		// If b has component but a doesn't, package was downgraded
 		if !aOk && bOk {
-			compResult = -1
+			compResult = Downgraded
 			break
 		}
 
@@ -73,11 +79,10 @@ func CompareVersions(a, b string) int {
 		} else {
 			abComp = cmp.Compare(aValue, bValue)
 		}
-		if abComp == 0 {
-			continue
+		if abComp != 0 {
+			compResult = abComp
+			break
 		}
-		compResult = abComp
-		break
 	}
 
 	return compResult
@@ -86,7 +91,8 @@ func CompareVersions(a, b string) int {
 func processPackage(pkg, oldVersion, newVersion string, c chan<- struct {
 	PackageDiff
 	int
-}, wg *sync.WaitGroup) {
+}, wg *sync.WaitGroup,
+) {
 	defer wg.Done()
 
 	result := CompareVersions(oldVersion, newVersion)
@@ -103,27 +109,27 @@ func DiffPackages(oldPackages, newPackages Package) ([]PackageDiff, []PackageDif
 	c := make(chan struct {
 		PackageDiff
 		int
-	}, len(oldPackages))
+	}, len(newPackages))
 
-	for pkg, oldVersion := range oldPackages {
+	for pkg, newVersion := range newPackages {
 		wg.Add(1)
 
-		if newVersion, ok := newPackages[pkg]; ok {
+		if oldVersion, ok := oldPackages[pkg]; ok {
 			go processPackage(pkg, oldVersion, newVersion, c, &wg)
 		} else {
 			c <- struct {
 				PackageDiff
 				int
-			}{PackageDiff{pkg, oldVersion, ""}, 2}
+			}{PackageDiff{pkg, newVersion, ""}, Added}
 			wg.Done()
 		}
 	}
 
 	removed := []PackageDiff{}
 	wg.Add(1)
 	go func() {
-		for pkg, version := range newPackages {
-			if _, ok := oldPackages[pkg]; !ok {
+		for pkg, version := range oldPackages {
+			if _, ok := newPackages[pkg]; !ok {
 				removed = append(removed, PackageDiff{pkg, "", version})
 			}
 		}
@@ -140,11 +146,11 @@ func DiffPackages(oldPackages, newPackages Package) ([]PackageDiff, []PackageDif
 	downgraded := []PackageDiff{}
 	for pkgResult := range c {
 		switch pkgResult.int {
-		case -1:
+		case Downgraded:
 			downgraded = append(downgraded, pkgResult.PackageDiff)
-		case 1:
+		case Upgraded:
 			upgraded = append(upgraded, pkgResult.PackageDiff)
-		case 2:
+		case Added:
 			added = append(added, pkgResult.PackageDiff)
 		}
 	}

diff/diff_test.go

@@ -0,0 +1,49 @@
+package diff
+
+import (
+	"fmt"
+	"slices"
+	"testing"
+)
+
+func TestDiffPackages(t *testing.T) {
+	newPackages := Package{
+		"libei1":                   "1.2.1-1",
+		"xdg-desktop-portal-gnome": "46.2-1",
+		"libdisplay-info1":         "0.1.1-1",
+	}
+
+	oldPackages := Package{
+		"libwinpr2-2t64":           "2.11.5+dfsg1-1",
+		"xdg-desktop-portal-gnome": "44.2-4+b1",
+		"libdisplay-info1":         "0.1.1-2+b1",
+	}
+
+	expected := struct {
+		added, upgraded, downgraded, removed []PackageDiff
+	}{
+		[]PackageDiff{{Name: "libei1", NewVersion: "1.2.1-1"}},
+		[]PackageDiff{{Name: "xdg-desktop-portal-gnome", NewVersion: "46.2-1", PreviousVersion: "44.2-4+b1"}},
+		[]PackageDiff{{Name: "libdisplay-info1", NewVersion: "0.1.1-1", PreviousVersion: "0.1.1-2+b1"}},
+		[]PackageDiff{{Name: "libwinpr2-2t64", PreviousVersion: "2.11.5+dfsg1-1"}},
+	}
+
+	added, upgraded, downgraded, removed := DiffPackages(oldPackages, newPackages)
+
+	if !slices.Equal(expected.added, added) {
+		fmt.Printf("Incorrect parsing of added. Expected %v, got %v\n", expected.added, added)
+		t.Fail()
+	}
+	if !slices.Equal(expected.upgraded, upgraded) {
+		fmt.Printf("Incorrect parsing of upgraded. Expected %v, got %v\n", expected.upgraded, upgraded)
+		t.Fail()
+	}
+	if !slices.Equal(expected.downgraded, downgraded) {
+		fmt.Printf("Incorrect parsing of downgraded. Expected %v, got %v\n", expected.downgraded, downgraded)
+		t.Fail()
+	}
+	if !slices.Equal(expected.removed, removed) {
+		fmt.Printf("Incorrect parsing of removed. Expected %v, got %v\n", expected.removed, removed)
+		t.Fail()
+	}
+}