Add track & risk path parameters for SnapcraftVersion

enhancing control and clarity
badges · Mar 2, 2024 · 9ddcf16 · 9ddcf16
1 parent 8361fec
commit 9ddcf16
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 15 deletions.
diff --git a/services/snapcraft/snapcraft-version.service.js b/services/snapcraft/snapcraft-version.service.js
@@ -1,11 +1,15 @@
 import Joi from 'joi'
-import { BaseJsonService, pathParams } from '../index.js'
+import { BaseJsonService, NotFound, pathParams } from '../index.js'
 import { renderVersionBadge } from '../version.js'
 
 const versionSchema = Joi.object({
   'channel-map': Joi.array()
     .items(
       Joi.object({
+        channel: Joi.object({
+          risk: Joi.string().required(),
+          track: Joi.string().required(),
+        }),
         version: Joi.string().required(),
       }).required(),
     )
@@ -18,24 +22,25 @@ export default class SnapcraftVersion extends BaseJsonService {
 
   static route = {
     base: 'snapcraft/v',
-    pattern: ':package',
+    pattern: ':package/:track/:risk',
   }
 
   static defaultBadgeData = { label: 'snapcraft' }
 
   static openApi = {
-    '/snapcraft/v/{package}': {
+    '/snapcraft/v/{package}/{track}/{risk}': {
       get: {
         summary: 'Snapcraft version',
-        parameters: pathParams({
-          name: 'package',
-          example: 'vim-editor',
-        }),
+        parameters: pathParams(
+          { name: 'package', example: 'chromium' },
+          { name: 'track', example: 'latest' },
+          { name: 'risk', example: 'stable' },
+        ),
       },
     },
   }
 
-  async handle({ package: packageName }) {
+  async handle({ package: packageName, track, risk }) {
     const parsedData = await this._requestJson({
       schema: versionSchema,
       options: {
@@ -47,8 +52,20 @@ export default class SnapcraftVersion extends BaseJsonService {
       },
     })
 
-    const version = parsedData['channel-map'][0].version
+    const channelMap = parsedData['channel-map']
+    let filteredChannelMap = channelMap.filter(
+      ({ channel }) => channel.track === track,
+    )
+    if (filteredChannelMap.length === 0) {
+      throw new NotFound({ prettyMessage: 'track not found' })
+    }
+    filteredChannelMap = channelMap.filter(
+      ({ channel }) => channel.risk === risk,
+    )
+    if (filteredChannelMap.length === 0) {
+      throw new NotFound({ prettyMessage: 'risk not found' })
+    }
 
-    return renderVersionBadge({ version })
+    return renderVersionBadge({ version: filteredChannelMap[0].version })
   }
 }
diff --git a/services/snapcraft/snapcraft-version.tester.js b/services/snapcraft/snapcraft-version.tester.js
@@ -2,14 +2,30 @@ import { isSemver } from '../test-validators.js'
 import { createServiceTester } from '../tester.js'
 export const t = await createServiceTester()
 
-t.create('Snapcraft Version for redis').get('/redis.json').expectBadge({
-  label: 'snapcraft',
-  message: isSemver,
-})
+t.create('Snapcraft Version for redis')
+  .get('/redis/latest/stable.json')
+  .expectBadge({
+    label: 'snapcraft',
+    message: isSemver,
+  })
 
 t.create('Snapcraft Version for redis (invalid package)')
-  .get('/this_package_doesnt_exist.json')
+  .get('/this_package_doesnt_exist/fake/fake.json')
   .expectBadge({
     label: 'snapcraft',
     message: 'package not found',
   })
+
+t.create('Snapcraft Version for redis (invalid track)')
+  .get('/redis/notfound/stable.json')
+  .expectBadge({
+    label: 'snapcraft',
+    message: 'track not found',
+  })
+
+t.create('Snapcraft Version for redis (invalid risk)')
+  .get('/redis/latest/notfound.json')
+  .expectBadge({
+    label: 'snapcraft',
+    message: 'risk not found',
+  })