Merge pull request #68 from wearefuturegov/TOP-251-meta-filter

update structure
wearefuturegov · Nov 12, 2024 · cb80cac · cb80cac
2 parents 7561d86 + f21a91f
commit cb80cac
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 8 deletions.
diff --git a/__tests__/unit/v1/services/routes/get-services.test.js b/__tests__/unit/v1/services/routes/get-services.test.js
@@ -430,19 +430,30 @@ describe("get-services", () => {
         const { meta } = await parseRequestParameters({})
         expect(meta).toEqual([])
       })
-      it("should return a unique array multiple targets are passed through", async () => {
+      it("should cope with multiple dividers", async () => {
+        const { meta } = await parseRequestParameters({
+          meta: "service-meta-key:service-meta:-value",
+        })
+        expect(new Set(meta)).toEqual(
+          new Set([{ key: "service-meta-key", value: "service-meta:-value" }])
+        )
+      })
+      it("should return a unique array if one target is passed through", async () => {
         const { meta } = await parseRequestParameters({
-          "meta-service-meta-key": "service-meta-value",
+          meta: "service-meta-key:service-meta-value",
         })
         expect(new Set(meta)).toEqual(
           new Set([{ key: "service-meta-key", value: "service-meta-value" }])
         )
       })
       it("should return a unique array one target is passed through", async () => {
         const { meta } = await parseRequestParameters({
-          "meta-service-meta-key": "service-meta-value",
-          "meta-service-meta-key-2": "service-meta-value-2",
+          meta: [
+            "service-meta-key:service-meta-value",
+            "service-meta-key-2:service-meta-value-2",
+          ],
         })
+        console.log(meta)
         expect(new Set(meta)).toEqual(
           new Set([
             { key: "service-meta-key", value: "service-meta-value" },

diff --git a/src/controllers/v1/services/routes/get-services.js b/src/controllers/v1/services/routes/get-services.js
@@ -44,9 +44,7 @@ module.exports = {
     // days = days=Monday&days=Tuesday -  deprecated
     let daysDeprecated = queryParams?.days ? [].concat(queryParams.days) : []
     let only = queryParams?.only ? [].concat(queryParams.only) : []
-    let meta = Object.entries(queryParams)
-      .filter(([key]) => key.startsWith("meta-"))
-      .map(([key, value]) => ({ key: key.replace("meta-", ""), value }))
+    let meta = queryParams?.meta ? [].concat(queryParams.meta) : []
 
     const minAge = parseInt(queryParams.min_age) || undefined
     const maxAge = parseInt(queryParams.max_age) || undefined
@@ -76,6 +74,14 @@ module.exports = {
     ]
     daysDeprecated = [...new Set(daysDeprecated.flatMap(str => str.split(",")))]
     only = [...new Set(only.flatMap(str => str.split(",")))]
+    meta = [...new Set(meta.flatMap(str => str.split(",")))]
+
+    // split meta into key values
+    meta = meta.map(str => {
+      const [key, ...valueParts] = str.split(":")
+      const value = valueParts.join(":") // Join the rest of the parts to handle cases where the value contains colons
+      return { key, value }
+    })
 
     // we dont de-dupe these as they are used in pairs
     startTime = [...startTime.flatMap(str => str.split(","))]

diff --git a/src/routes/parameters.yml b/src/routes/parameters.yml
@@ -145,7 +145,7 @@ parameters:
   meta:
     name: meta
     in: query
-    description: Prefix the key with meta- to filter by meta data. eg/ "meta-foo=bar"
+    description: Filter by meta data. eg/ "meta=foo:bar"
     required: false
     schema:
       type: string