Merge pull request #7222 from usu/feat/cache-checklists

feat: enable caching for for camps/{campId}/checklists

Author: usu

api/config/packages/http_cache.yaml

@@ -1,5 +1,5 @@
 parameters:
-    app.httpCache.matchPath: '^/?($|index.jsonhal$|content_types|camps/[0-9a-f]*/categories|periods/[0-9a-f]*/schedule_entries|camps/[0-9a-f]*/activities)'
+    app.httpCache.matchPath: '^/?($|index.jsonhal$|content_types|camps/[0-9a-f]*/categories|periods/[0-9a-f]*/schedule_entries|camps/[0-9a-f]*/activities|camps/[0-9a-f]*/checklists)'
 
 fos_http_cache:
     debug:

e2e/specs/constants.js

@@ -3,6 +3,7 @@ export const cachedEndpoint = Cypress.env('API_ROOT_URL_CACHED')
 export const grgrCampId = '3c79b99ab424'
 export const loremIpsumCampId = '9c2447aefe38'
 export const skilagerCampId = '70ca971c992f'
+export const basiskursCampId = '5d28f99890bc'
 
 export const skilagerPeriodId = '7fa4564a5d5d'
 export const grgrPeriodId = '76be24bce434'

e2e/specs/httpCache/checklists.cy.js

@@ -0,0 +1,88 @@
+import { bipiUser, cachedEndpoint, castorUser, basiskursCampId } from '../constants'
+import collectionResponse from './responses/checklists_collection.json'
+
+const collectionXKeys =
+  /* campCollaboration for bipiUser */
+  '146c0608237f ' +
+  /* checklist entry */
+  'ebbd0c61eb85 ebbd0c61eb85#camp ' +
+  /* collection URI (for detecting addition of new checklists) */
+  '/api/camps/5d28f99890bc/checklists'
+
+describe('cache test: /camps/checklists', () => {
+  it('caches /camp/{campId}/checklists separately for each login', () => {
+    const uri = `/api/camps/${basiskursCampId}/checklists`
+
+    Cypress.session.clearAllSavedSessions()
+    cy.login(bipiUser)
+
+    // first request is a cache miss
+    cy.request(`${cachedEndpoint}${uri}.jsonhal`).then((response) => {
+      const headers = response.headers
+      expect(headers.xkey).to.eq(collectionXKeys)
+      expect(headers['x-cache']).to.eq('MISS')
+      expect(response.body).to.deep.equal(collectionResponse)
+    })
+
+    // second request is a cache hit
+    cy.expectCacheHit(uri)
+
+    // request with a new user is a cache miss
+    cy.login(castorUser)
+    cy.expectCacheMiss(uri)
+  })
+
+  it('invalidates /camp/{campId}/checklists on checklist patch', () => {
+    const uri = `/api/camps/${basiskursCampId}/checklists`
+
+    // bring data into defined state
+    Cypress.session.clearAllSavedSessions()
+    cy.login(bipiUser)
+    cy.apiPatch('/api/checklists/ebbd0c61eb85', {
+      name: 'Training targets',
+    })
+
+    // warm up cache
+    cy.waitForCacheMiss(uri)
+    cy.expectCacheHit(uri)
+
+    // touch checklist
+    cy.apiPatch('/api/checklists/ebbd0c61eb85', {
+      name: 'Ausbildungsziele',
+    })
+
+    // ensure cache was invalidated
+    cy.waitForCacheMiss(uri)
+    cy.expectCacheHit(uri)
+  })
+
+  it('invalidates /camp/{campId}/checklists for new checklist', () => {
+    const uri = `/api/camps/${basiskursCampId}/checklists`
+
+    Cypress.session.clearAllSavedSessions()
+    cy.login(bipiUser)
+
+    // warm up cache
+    cy.expectCacheMiss(uri)
+    cy.expectCacheHit(uri)
+
+    // add new checklist to camp
+    cy.apiPost('/api/checklists', {
+      camp: `/api/camps/${basiskursCampId}`,
+      name: 'new_checklist',
+    }).then((response) => {
+      const newChecklistUri = response.body._links.self.href
+
+      // ensure cache was invalidated
+      cy.waitForCacheMiss(uri)
+      cy.expectCacheHit(uri)
+
+      // delete newly created contentNode
+      cy.apiDelete(newChecklistUri)
+
+      // ensure cache was invalidated
+      cy.waitForCacheMiss(uri)
+      cy.expectCacheHit(uri)
+    })
+  })
+})

e2e/specs/httpCache/responses/checklists_collection.json

@@ -0,0 +1,33 @@
+{
+  "_links": {
+    "self": {
+      "href": "/api/camps/5d28f99890bc/checklists.jsonhal"
+    },
+    "items": [
+      {
+        "href": "/api/checklists/ebbd0c61eb85"
+      }
+    ]
+  },
+  "totalItems": 1,
+  "_embedded": {
+    "items": [
+      {
+        "_links": {
+          "self": {
+            "href": "/api/checklists/ebbd0c61eb85"
+          },
+          "camp": {
+            "href": "/api/camps/5d28f99890bc"
+          },
+          "checklistItems": {
+            "href": "/api/checklists/ebbd0c61eb85/checklist_items"
+          }
+        },
+        "name": "Ausbildungsziele",
+        "isPrototype": false,
+        "id": "ebbd0c61eb85"
+      }
+    ]
+  }
+}