Filter by service meta

__tests__/unit/lib/filters.test.js

@@ -108,6 +108,53 @@ describe("filterOnly", () => {
   })
 })
 
+describe("filterMeta", () => {
+  it("should return an empty array if meta is not provided", () => {
+    expect(filters.filterMeta()).toEqual([])
+  })
+  it("should return a query object with key and value if meta includes information", () => {
+    expect(
+      filters.filterMeta([
+        { key: "service-meta-key", value: "service-meta-value" },
+      ])
+    ).toEqual([
+      {
+        meta: {
+          $elemMatch: {
+            key: "service-meta-key",
+            value: "service-meta-value",
+          },
+        },
+      },
+    ])
+  })
+  it("should return a query object with each key and value if meta includes information", () => {
+    expect(
+      filters.filterMeta([
+        { key: "service-meta-key", value: "service-meta-value" },
+        { key: "service-meta-key-2", value: "service-meta-value-2" },
+      ])
+    ).toEqual([
+      {
+        meta: {
+          $elemMatch: {
+            key: "service-meta-key",
+            value: "service-meta-value",
+          },
+        },
+      },
+      {
+        meta: {
+          $elemMatch: {
+            key: "service-meta-key-2",
+            value: "service-meta-value-2",
+          },
+        },
+      },
+    ])
+  })
+})
+
 describe("filterTaxonomies", () => {
   it("should return an empty object if taxonomies is not provided", () => {
     expect(filters.filterTaxonomies()).toEqual({})

__tests__/unit/v1/services/routes/get-services.test.js

@@ -36,6 +36,7 @@ describe("get-services", () => {
         endDate: undefined,
         accessibilities: [],
         only: [],
+        meta: [],
         minAge: undefined,
         maxAge: undefined,
         interpreted_location: undefined,
@@ -424,6 +425,33 @@ describe("get-services", () => {
       })
     })
 
+    describe("meta", () => {
+      it("should return undefined if only are not provided", async () => {
+        const { meta } = await parseRequestParameters({})
+        expect(meta).toEqual([])
+      })
+      it("should return a unique array multiple targets are passed through", 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 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",
+        })
+        expect(new Set(meta)).toEqual(
+          new Set([
+            { key: "service-meta-key", value: "service-meta-value" },
+            { key: "service-meta-key-2", value: "service-meta-value-2" },
+          ])
+        )
+      })
+    })
+
     describe("minAge", () => {
       it("should return undefined if minAge is not provided", async () => {
         const { minAge } = await parseRequestParameters({})

src/controllers/v1/services/routes/get-services.js

@@ -44,6 +44,10 @@ 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 }))
+
     const minAge = parseInt(queryParams.min_age) || undefined
     const maxAge = parseInt(queryParams.max_age) || undefined
 
@@ -123,6 +127,7 @@ module.exports = {
       endDate,
       accessibilities,
       only,
+      meta,
       minAge,
       maxAge,
       interpreted_location,

src/lib/filters.js

@@ -71,6 +71,27 @@ const filters = {
     return query
   },
 
+  // filters by meta
+  // meta-service-meta-key=service-meta-value
+  filterMeta: meta => {
+    let query = []
+    if (meta) {
+      meta.forEach(m => {
+        if (m.key && m.value) {
+          query.push({
+            meta: {
+              $elemMatch: {
+                key: m.key,
+                value: m.value,
+              },
+            },
+          })
+        }
+      })
+    }
+    return query
+  },
+
   /**
    * Specify the taxonomies to search for services
    * We are using $in to match any of the taxonomies

src/lib/queries.js

@@ -65,6 +65,10 @@ module.exports = {
     const only = filters.filterOnly(parameters.only)
     query.$and.push(...only)
 
+    // apply meta filters
+    const meta = filters.filterMeta(parameters.meta)
+    query.$and.push(...meta)
+
     // apply visibility filtering
     const visibleNow = filters.visibleNow()
     query.$and.push(...visibleNow)

src/routes/parameters.yml

@@ -133,7 +133,7 @@ parameters:
   only:
     name: only
     in: query
-    description: Find services that are only x. Currently only free is supported. eg/ "free"
+    description: Find services that are only x. Currently only free, needs-referral and local-offer are supported. eg/ "free"
     required: false
     schema:
       type: enum
@@ -142,6 +142,14 @@ parameters:
         - "needs-referral"
         - "local-offer"
 
+  meta:
+    name: meta
+    in: query
+    description: Prefix the key with meta- to filter by meta data. eg/ "meta-foo=bar"
+    required: false
+    schema:
+      type: string
+
   min_age:
     name: min_age
     in: query

src/routes/routes.js

@@ -25,6 +25,7 @@ module.exports.setup = app => {
    *       - $ref: '#/parameters/accessibilities'
    *       - $ref: '#/parameters/days'
    *       - $ref: '#/parameters/only'
+   *       - $ref: '#/parameters/meta'
    *       - $ref: '#/parameters/min_age'
    *       - $ref: '#/parameters/max_age'
    *       - $ref: '#/parameters/start_time'