Merge pull request #122 from aroskanalen/feature/add-max-age-to-json-…

…files Added max-age and expires 1 hour to config.json and release.json
os2display · Apr 18, 2024 · 3e25a74 · 3e25a74
2 parents 530e777 + 21ce42d
commit 3e25a74
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 49 deletions.
diff --git a/.docker/vhost.conf b/.docker/vhost.conf
@@ -8,4 +8,12 @@ server {
         proxy_set_header   Host $http_host;
         proxy_pass         http://node:3000;
     }
+
+    location ~* ^/client/(config|release)\.json$ {
+        proxy_set_header   X-Forwarded-For $remote_addr;
+        proxy_set_header   Host $http_host;
+        proxy_pass         http://node:3000;
+        add_header Cache-Control "public, max-age=3600";
+        expires 1h;
+    }
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 All notable changes to this project will be documented in this file.
 
+- [#122](https://github.com/os2display/display-client/pull/122)
+  - Added max-age and expires 1 hour to config.json and release.json.
 - [#121](https://github.com/os2display/display-client/pull/120)
   - Add releaseVersion, releaseTimestamp and screenId searchParams when starting app.
 

diff --git a/infrastructure/itkdev/etc/confd/templates/default.conf.tmpl b/infrastructure/itkdev/etc/confd/templates/default.conf.tmpl
@@ -16,6 +16,12 @@ server {
        return 200 "User-agent: *\nDisallow: /\n";
     }
 
+    location ~* ^{{ getenv "APP_SCREEN_CLIENT_PATH" "" }}/(config|release)\.json$ {
+        add_header Cache-Control "public, max-age=3600";
+        expires 1h;
+        try_files $uri $uri/ =404;
+    }
+
     error_log /var/log/nginx/error.log;
     access_log /var/log/nginx/access.log;
 }

diff --git a/infrastructure/os2display/etc/confd/templates/default.conf.tmpl b/infrastructure/os2display/etc/confd/templates/default.conf.tmpl
@@ -16,6 +16,12 @@ server {
        return 200 "User-agent: *\nDisallow: /\n";
     }
 
+    location ~* ^{{ getenv "APP_SCREEN_CLIENT_PATH" "" }}/(config|release)\.json$ {
+        add_header Cache-Control "public, max-age=3600";
+        expires 1h;
+        try_files $uri $uri/ =404;
+    }
+
     error_log /var/log/nginx/error.log;
     access_log /var/log/nginx/access.log;
 }

diff --git a/src/app.spec.js b/src/app.spec.js
@@ -10,9 +10,16 @@ describe('Client tests', () => {
       fixture: 'awaiting-bind-key-response.json',
     }).as('bindKey');
 
+    cy.intercept('GET', '**/config.json', {
+      statusCode: 200,
+      fixture: 'config.json',
+    }).as('config');
+
     cy.visit('/');
 
-    cy.wait('@bindKey');
+    // After this point we assume the config file is served from the browser
+    // cache, since it the nginx setup has a 1h caching set for config.json.
+    cy.wait(['@bindKey', '@config']);
 
     cy.get('.bind-key').should('exist');
     cy.get('.bind-key')
@@ -26,11 +33,6 @@ describe('Client tests', () => {
       fixture: 'screen-response.json',
     }).as('bindKey');
 
-    cy.intercept('GET', '**/config.json', {
-      statusCode: 200,
-      fixture: 'config.json',
-    }).as('config');
-
     cy.intercept('GET', '**/screens/01FYEDW1N133SG516JVJ3VG5FY', {
       statusCode: 200,
       fixture: 'screen-empty.json',
@@ -55,7 +57,6 @@ describe('Client tests', () => {
 
     cy.wait([
       '@bindKey',
-      '@config',
       '@screen',
       '@groups',
       '@campaigns',
@@ -71,11 +72,6 @@ describe('Client tests', () => {
       fixture: 'screen-response.json',
     }).as('bindKey');
 
-    cy.intercept('GET', '**/config.json', {
-      statusCode: 200,
-      fixture: 'config.json',
-    }).as('config');
-
     cy.intercept('GET', '**/screens/01FYEDW1N133SG516JVJ3VG5FY', {
       statusCode: 200,
       fixture: 'screen.json',
@@ -124,7 +120,7 @@ describe('Client tests', () => {
 
     cy.wait([
       '@bindKey',
-      '@config',
+      // '@config',
       '@screen',
       '@groups',
       '@campaigns',
@@ -147,11 +143,6 @@ describe('Client tests', () => {
       fixture: 'screen-response.json',
     }).as('bindKey');
 
-    cy.intercept('GET', '**/config.json', {
-      statusCode: 200,
-      fixture: 'config.json',
-    }).as('config');
-
     cy.intercept('GET', '**/screens/01FYEDW1N133SG516JVJ3VG5FY', {
       statusCode: 200,
       fixture: 'screen.json',
@@ -180,7 +171,6 @@ describe('Client tests', () => {
     cy.visit('/');
     cy.wait([
       '@bindKey',
-      '@config',
       '@screen',
       '@groups',
       '@campaigns',
@@ -200,11 +190,6 @@ describe('Client tests', () => {
       fixture: 'screen-response.json',
     }).as('bindKey');
 
-    cy.intercept('GET', '**/config.json', {
-      statusCode: 201,
-      fixture: 'config.json',
-    }).as('config');
-
     cy.intercept('GET', '**/screens/01FYEDW1N133SG516JVJ3VG5FY', {
       statusCode: 201,
       fixture: 'screen.json',
@@ -247,7 +232,6 @@ describe('Client tests', () => {
     cy.visit('/');
     cy.wait([
       '@bindKey',
-      '@config',
       '@screen',
       '@screen-groups',
       '@screen-campaigns',
@@ -272,11 +256,6 @@ describe('Client tests', () => {
       fixture: 'screen-response.json',
     }).as('bindKey');
 
-    cy.intercept('GET', '**/config.json', {
-      statusCode: 201,
-      fixture: 'config.json',
-    }).as('config');
-
     cy.intercept('GET', '**/screens/01FYEDW1N133SG516JVJ3VG5FY', {
       statusCode: 201,
       fixture: 'screen.json',
@@ -333,7 +312,6 @@ describe('Client tests', () => {
     cy.visit('/');
     cy.wait([
       '@bindKey',
-      '@config',
       '@screen',
       '@groups',
       '@campaigns',
@@ -356,11 +334,6 @@ describe('Client tests', () => {
       fixture: 'screen-response.json',
     }).as('bindKey');
 
-    cy.intercept('GET', '**/config.json', {
-      statusCode: 201,
-      fixture: 'config.json',
-    }).as('config');
-
     cy.intercept('GET', '**/screens/01FYEDW1N133SG516JVJ3VG5FY', {
       statusCode: 201,
       fixture: 'screen.json',
@@ -417,7 +390,6 @@ describe('Client tests', () => {
     cy.visit('/');
     cy.wait([
       '@bindKey',
-      '@config',
       '@screen',
       '@groups',
       '@campaigns',
@@ -440,11 +412,6 @@ describe('Client tests', () => {
       fixture: 'screen-response.json',
     }).as('bindKey');
 
-    cy.intercept('GET', '**/config.json', {
-      statusCode: 201,
-      fixture: 'config.json',
-    }).as('config');
-
     cy.intercept('GET', '**/screens/01FYEDW1N133SG516JVJ3VG5FY', {
       statusCode: 201,
       fixture: 'screen-diff-layout.json',
@@ -493,7 +460,11 @@ describe('Client tests', () => {
     }).as('layout');
 
     cy.visit('/');
-    cy.wait(['@bindKey', '@config', '@screen', '@layout']);
+    cy.wait([
+      '@bindKey',
+      '@screen',
+      '@layout',
+    ]);
 
     cy.get('.region')
       .eq(0)
@@ -511,11 +482,6 @@ describe('Client tests', () => {
       fixture: 'screen-response.json',
     }).as('bindKey');
 
-    cy.intercept('GET', '**/config.json', {
-      statusCode: 201,
-      fixture: 'config.json',
-    }).as('config');
-
     cy.intercept('GET', '**/screens/01FYEDW1N133SG516JVJ3VG5FY', {
       statusCode: 201,
       fixture: 'screen.json',
@@ -577,7 +543,6 @@ describe('Client tests', () => {
     cy.visit('/');
     cy.wait([
       '@bindKey',
-      '@config',
       '@screen',
       '@groups',
       '@campaigns',