Read maven relocation information instead of assuming extensions with the same artifact id have a relationship

Author: holly-cummins

gatsby-node.js

@@ -6,7 +6,7 @@ const {
   getStream,
 } = require("./src/components/util/pretty-platform")
 const { sortableName } = require("./src/components/util/sortable-name")
-const { extensionSlug } = require("./src/components/util/extension-slugger")
+const { extensionSlug, extensionSlugFromCoordinates } = require("./src/components/util/extension-slugger")
 const { generateMavenInfo } = require("./src/maven/maven-info")
 const { createRemoteFileNode } = require("gatsby-source-filesystem")
 const { rewriteGuideUrl } = require("./src/components/util/guide-url-rewriter")
@@ -137,37 +137,45 @@ exports.sourceNodes = async ({
 
     // Look for extensions which are not the same, but which have the same artifact id
     // (artifactId is just the 'a' part of the gav, artifact is the whole gav string)
+
+    const relocation = node.metadata.maven?.relocation
+    node.isSuperseded = false
+
+    if (relocation) {
+      node.duplicates = [{
+        artifactId: relocation.artifactId,
+        groupId: relocation.groupId,
+        slug: extensionSlugFromCoordinates(relocation),
+        relationship: "newer",
+        differentId: relocation.artifactId !== node.metadata.maven?.artifactId ? relocation.artifactId : relocation.groupId,
+        differenceReason: relocation.artifactId !== node.metadata?.maven?.artifactId ? "artifact id" : "group id"
+      }]
+
+      node.isSuperseded = true
+    }
+
+// Look for things that mark this extension as a duplicate
     const duplicates = extensions.filter(
       ext =>
-        ext.metadata.maven?.artifactId === node.metadata.maven?.artifactId &&
-        ext.artifact !== node.artifact
+        ext.metadata.maven?.relocation?.artifactId === node.metadata.maven?.artifactId &&
+        ext.metadata.maven?.relocation?.groupId === node.metadata.maven?.groupId
     )
-    if (duplicates && duplicates.length > 0) {
+    if (duplicates) {
       const condensedDuplicates = duplicates.map(dupe => {
-        // If we're missing a timestamp because we couldn't get it from maven, all we can do is describe the versions as 'different' from each other.
-        const relationship =
-          dupe.metadata.maven.timestamp && extension.metadata.maven.timestamp
-            ? dupe.metadata.maven.timestamp > extension.metadata.maven.timestamp
-              ? "newer"
-              : "older"
-            : "different"
+        // It's possible both might be different, but we've never seen it, so in that case just mention the different artifact id
 
         return {
           artifact: dupe.artifact,
-          groupId: dupe.metadata.maven.groupId,
+          artifactId: dupe.metadata.maven?.artifactId,
+          groupId: dupe.metadata.maven?.groupId,
           slug: extensionSlug(dupe.artifact),
-          timestamp: dupe.metadata.maven.timestamp,
-          relationship,
+          relationship: "older",
+          differentId: dupe.metadata.maven?.artifactId !== node.metadata.maven?.artifactId ? dupe.metadata.maven?.artifactId : dupe.metadata.maven?.groupId,
+          differenceReason: dupe.metadata.maven?.artifactId !== node.metadata?.maven?.artifactId ? "artifact id" : "group id"
         }
       })
-      node.duplicates = condensedDuplicates
+      node.duplicates = node.duplicates ? [...condensedDuplicates, ...node.duplicates] : condensedDuplicates
 
-      if (
-        condensedDuplicates &&
-        condensedDuplicates.find(dupe => dupe.relationship === "newer")
-      ) {
-        node.isSuperseded = true
-      }
     }
 
     return createNode(node)
@@ -305,6 +313,11 @@ exports.createSchemaCustomization = ({ actions }) => {
       url: String
       version: String
       timestamp: String
+      relocation: RelocationInfo
+    }
+    
+    type RelocationInfo {
+       artifactId: String
     }
  
   `)

gatsby-node.test.js

@@ -13,11 +13,22 @@ const resolvedMavenUrl = "http://reallygoodurl.mvn"
 const { generateMavenInfo } = require("./src/maven/maven-info")
 jest.mock("./src/maven/maven-info")
 
+const dataCatRelocation = {
+  artifactId: "quarkus-micrometer-registry-datadog",
+  groupId: "io.quarkiverse.micrometer.registry"
+}
+
 generateMavenInfo.mockImplementation(artifactId => {
   const coordinates = parse(artifactId)
   // This is totally unscientific and arbitrary, but it's reproducible
   coordinates.timestamp = artifactId.length
   coordinates.url = resolvedMavenUrl
+
+  // Special case the datacat artifact by doing some hardcoding
+  if (artifactId.includes("datacat")) {
+    coordinates.relocation = dataCatRelocation
+  }
+
   return coordinates
 })
 
@@ -433,7 +444,7 @@ describe("the main gatsby entrypoint", () => {
     })
   })
 
-  describe("for an extension with an other extension sharing the artifact id", () => {
+  describe("for an extension with a relocation to another extension", () => {
     const extension = {
       artifact:
         "io.quarkiverse.micrometer.registry:quarkus-micrometer-registry-datadog::jar:2.12.0",
@@ -443,10 +454,10 @@ describe("the main gatsby entrypoint", () => {
     }
     const olderExtension = {
       artifact:
-        "io.quarkelsewhere:quarkus-micrometer-registry-datadog::jar:3.12.0",
+        "io.quarkelsewhere:quarkus-micrometer-registry-datacat::jar:3.12.0",
       origins: [
         "io.quarkus.platform:quarkus-bom-quarkus-platform-descriptor:3.0.0.Alpha3:json:3.0.0.Alpha3",
-      ],
+      ]
     }
 
     // A cut down version of what the registry returns us, with just the relevant bits
@@ -473,27 +484,28 @@ describe("the main gatsby entrypoint", () => {
       expect(createNodeId).toHaveBeenCalledTimes(2)
     })
 
-    it("adds a link to the older extension from the new one", () => {
+    it("adds a link to the newer extension from the older one", () => {
       expect(createNode).toHaveBeenCalledWith(
         expect.objectContaining({
           artifact: extension.artifact,
           duplicates: [
             expect.objectContaining({
               groupId: "io.quarkelsewhere",
-              slug: "io.quarkelsewhere/quarkus-micrometer-registry-datadog",
+              slug: "io.quarkelsewhere/quarkus-micrometer-registry-datacat",
             }),
           ],
         })
       )
     })
 
-    it("adds a link to the newer extension from the old one", () => {
+    it("adds a link to the older extension from the new one", () => {
       expect(createNode).toHaveBeenCalledWith(
         expect.objectContaining({
           artifact: olderExtension.artifact,
           duplicates: [
             expect.objectContaining({
               groupId: "io.quarkiverse.micrometer.registry",
+              slug: "io.quarkiverse.micrometer.registry/quarkus-micrometer-registry-datadog",
             }),
           ],
         })
@@ -507,7 +519,20 @@ describe("the main gatsby entrypoint", () => {
           duplicates: [
             expect.objectContaining({
               relationship: "older",
-              timestamp: 65,
+            }),
+          ],
+        })
+      )
+    })
+
+    it("adds data to the older one explaining what is different", () => {
+      expect(createNode).toHaveBeenCalledWith(
+        expect.objectContaining({
+          artifact: extension.artifact,
+          duplicates: [
+            expect.objectContaining({
+              differenceReason: "artifact id",
+              differentId: "quarkus-micrometer-registry-datacat"
             }),
           ],
         })
@@ -521,7 +546,20 @@ describe("the main gatsby entrypoint", () => {
           duplicates: [
             expect.objectContaining({
               relationship: "newer",
-              timestamp: 82,
+            }),
+          ],
+        })
+      )
+    })
+
+    it("adds data to the newer one explaining what is different", () => {
+      expect(createNode).toHaveBeenCalledWith(
+        expect.objectContaining({
+          artifact: olderExtension.artifact,
+          duplicates: [
+            expect.objectContaining({
+              differenceReason: "artifact id",
+              differentId: "quarkus-micrometer-registry-datadog"
             }),
           ],
         })
@@ -545,100 +583,5 @@ describe("the main gatsby entrypoint", () => {
         })
       )
     })
-
-    describe("when maven conks out and does not give a timestamp", () => {
-      beforeAll(async () => {
-        // Clear any history from the parent beforeAll()
-        jest.clearAllMocks()
-
-        generateMavenInfo.mockImplementation(artifactId => {
-          const coordinates = parse(artifactId)
-          // This is totally unscientific and arbitrary, but it's reproducible
-          coordinates.timestamp = undefined
-          coordinates.url = resolvedMavenUrl
-          return coordinates
-        })
-
-        axios.get = jest.fn().mockReturnValue({
-          data: {
-            extensions: [extension, olderExtension],
-            platforms: currentPlatforms.platforms,
-          },
-        })
-
-        await sourceNodes({ actions, createNodeId, createContentDigest })
-      })
-
-      it("adds a link to the older extension from the new one", () => {
-        expect(createNode).toHaveBeenCalledWith(
-          expect.objectContaining({
-            artifact: extension.artifact,
-            duplicates: [
-              expect.objectContaining({
-                groupId: "io.quarkelsewhere",
-                slug: "io.quarkelsewhere/quarkus-micrometer-registry-datadog",
-              }),
-            ],
-          })
-        )
-      })
-
-      it("does not mark the new extension as superseded", () => {
-        expect(createNode).not.toHaveBeenCalledWith(
-          expect.objectContaining({
-            artifact: extension.artifact,
-            isSuperseded: true,
-          })
-        )
-      })
-
-      it("adds a link to the newer extension from the old one", () => {
-        expect(createNode).toHaveBeenCalledWith(
-          expect.objectContaining({
-            artifact: olderExtension.artifact,
-            duplicates: [
-              expect.objectContaining({
-                groupId: "io.quarkiverse.micrometer.registry",
-              }),
-            ],
-          })
-        )
-      })
-
-      it("does not mark the older extension as superseded", () => {
-        expect(createNode).not.toHaveBeenCalledWith(
-          expect.objectContaining({
-            artifact: olderExtension.artifact,
-            isSuperseded: true,
-          })
-        )
-      })
-
-      it("marks the older duplicate as just different", () => {
-        expect(createNode).toHaveBeenCalledWith(
-          expect.objectContaining({
-            artifact: extension.artifact,
-            duplicates: [
-              expect.objectContaining({
-                relationship: "different",
-              }),
-            ],
-          })
-        )
-      })
-
-      it("marks the newer duplicate as just different", () => {
-        expect(createNode).toHaveBeenCalledWith(
-          expect.objectContaining({
-            artifact: olderExtension.artifact,
-            duplicates: [
-              expect.objectContaining({
-                relationship: "different",
-              }),
-            ],
-          })
-        )
-      })
-    })
   })
 })

package-lock.json

@@ -54,6 +54,7 @@
     "tmp-promise": "^3.0.3",
     "url-exist": "^2.0.0",
     "values.js": "^2.1.1",
+    "xml2js": "^0.6.2",
     "yaml-jest": "^1.2.0"
   },
   "devDependencies": {

package.json

@@ -18,7 +18,6 @@ describe.skip("real data contributor information", () => {
 
   it("correctly counts contributors for iron jacamar", async () => {
     const answer = await getContributors("quarkiverse", "quarkus-ironjacamar")
-    console.log("answer", answer)
     // This expectation will change over time, obviously
     expect(answer).toEqual(expect.arrayContaining([{
       "contributions": 145,

plugins/github-enricher/sponsorFinder.realdata.test.js

@@ -90,7 +90,7 @@ describe("extension list", () => {
   })
 
   it("displays a brief message about how many extensions there are", async () => {
-    // The superceded extension should not be counted
+    // The superseded extension should not be counted
     const num = extensions.length - 1
     expect(screen.getByText(`Showing ${num} extensions`)).toBeTruthy()
   })

src/components/extensions-list.test.js

@@ -12,17 +12,20 @@ const extensionSlug = gav => {
     let string
     if (gav.includes(":")) {
       const coordinates = parse(gav)
-      // slugs can have slashes in them, so use folders to group extensions in the same group
-      // slugify strips slashes, so slugify before adding the slashes
-      string =
-        slugifyPart(coordinates.groupId) +
-        "/" +
-        slugifyPart(coordinates.artifactId)
+      string = extensionSlugFromCoordinates(coordinates)
     } else {
       string = slugifyPart(gav)
     }
-
     return string
   }
 }
-module.exports = { extensionSlug }
+
+const extensionSlugFromCoordinates = coordinates => {
+
+  // slugs can have slashes in them, so use folders to group extensions in the same group
+  // slugify strips slashes, so slugify before adding the slashes
+  return slugifyPart(coordinates.groupId) + "/" + slugifyPart(coordinates.artifactId)
+
+}
+
+module.exports = { extensionSlug, extensionSlugFromCoordinates }