Fixes for analyticsPrompt

Stirling-Tools · Oct 22, 2024 · a40fdd5 · a40fdd5
1 parent 6ea7ffc
commit a40fdd5
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 30 deletions.
diff --git a/build.gradle b/build.gradle
@@ -22,7 +22,7 @@ ext {
 }
 
 group = "stirling.software"
-version = "0.30.0"
+version = "0.30.1"
 
 java {
     // 17 is lowest but we support and recommend 21

diff --git a/src/main/java/stirling/software/SPDF/config/AppConfig.java b/src/main/java/stirling/software/SPDF/config/AppConfig.java
@@ -15,6 +15,7 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Lazy;
+import org.springframework.context.annotation.Scope;
 import org.springframework.core.io.ClassPathResource;
 import org.springframework.core.io.Resource;
 import org.springframework.core.io.ResourceLoader;
@@ -162,12 +163,14 @@ public String accessibilityStatement() {
     }
 
     @Bean(name = "analyticsPrompt")
+    @Scope("request")
     public boolean analyticsPrompt() {
         return applicationProperties.getSystem().getEnableAnalytics() == null
                 || "undefined".equals(applicationProperties.getSystem().getEnableAnalytics());
     }
 
     @Bean(name = "analyticsEnabled")
+    @Scope("request")
     public boolean analyticsEnabled() {
         if (applicationProperties.getEnterpriseEdition().isEnabled()) return true;
         return applicationProperties.getSystem().getEnableAnalytics() != null

diff --git a/src/main/java/stirling/software/SPDF/controller/api/SettingsController.java b/src/main/java/stirling/software/SPDF/controller/api/SettingsController.java
@@ -32,6 +32,7 @@ public ResponseEntity<String> updateApiKey(@RequestBody Boolean enabled) throws
         }
         GeneralUtils.saveKeyToConfig("system.enableAnalytics", String.valueOf(enabled), false);
         applicationProperties.getSystem().setEnableAnalytics(String.valueOf(enabled));
+
         return ResponseEntity.ok("Updated");
     }
 }
diff --git a/src/main/resources/templates/home.html b/src/main/resources/templates/home.html
@@ -374,10 +374,10 @@ <h5 class="modal-title" id="analyticsModalLabel" th:text="#{analytics.title}">Do
           <p th:text="#{analytics.paragraph2}">Please consider enabling analytics to help Stirling-PDF grow and to allow us to understand our users better.</p>
           <p th:text="#{analytics.settings}">You can change the settings for analytics in the config/settings.yml file</p>
         </div>
-        <div class="modal-footer">
-          <button type="button" class="btn btn-primary" th:text="#{analytics.enable}" onclick="setAnalytics(true)">Enable analytics</button>
-          <button type="button" class="btn btn-secondary" data-bs-dismiss="modal" onclick="setAnalytics(false)" th:text="#{analytics.disable}">Disable analytics</button>
-        </div>
+        <div class="modal-footer justify-content-between">
+                <button type="button" class="btn btn-secondary" data-bs-dismiss="modal" onclick="setAnalytics(false)" th:text="#{analytics.disable}">Disable analytics</button>
+                <button type="button" class="btn btn-primary" th:text="#{analytics.enable}" onclick="setAnalytics(true)">Enable analytics</button>
+            </div>
       </div>
     </div>
   </div>
@@ -426,50 +426,60 @@ <h5 class="modal-title" id="analyticsModalLabel" th:text="#{analytics.title}">Do
 
 
 
-    document.addEventListener("DOMContentLoaded", function() {
-      const surveyVersion = "2.0";
-      const modal = new bootstrap.Modal(document.getElementById('surveyModal'));
-      const dontShowAgain = document.getElementById('dontShowAgain');
-      const takeSurveyButton = document.getElementById('takeSurvey');
+document.addEventListener("DOMContentLoaded", function() {
+    const surveyVersion = "2.0";
+    const modal = new bootstrap.Modal(document.getElementById('surveyModal'));
+    const dontShowAgain = document.getElementById('dontShowAgain');
+    const takeSurveyButton = document.getElementById('takeSurvey');
+
+    const viewThresholds = [5, 10, 15, 22, 30, 50, 75, 100, 150, 200];
+
+    // Check if survey version changed and reset page views if it did
+    const storedVersion = localStorage.getItem('surveyVersion');
+    if (storedVersion && storedVersion !== surveyVersion) {
+        localStorage.setItem('pageViews', '0');
+    }
 
-      const viewThresholds = [5, 15, 30, 50, 75, 100, 150, 200];
-      let pageViews = parseInt(localStorage.getItem('pageViews') || '0');
+    let pageViews = parseInt(localStorage.getItem('pageViews') || '0');
 
-      pageViews++;
-      localStorage.setItem('pageViews', pageViews.toString());
+    pageViews++;
+    localStorage.setItem('pageViews', pageViews.toString());
 
-      function shouldShowSurvey() {
-        if (localStorage.getItem('dontShowSurvey') === 'true' || localStorage.getItem('surveyTaken') === 'true') {
-          return false;
+    function shouldShowSurvey() {
+        if (localStorage.getItem('dontShowSurvey') === 'true' ||
+            localStorage.getItem('surveyTaken') === 'true') {
+            return false;
         }
 
-        if (localStorage.getItem('surveyVersion') !== surveyVersion) {
-          return true;
+        // If survey version changed and we hit a threshold, show the survey
+        if (localStorage.getItem('surveyVersion') !== surveyVersion &&
+            viewThresholds.includes(pageViews)) {
+            return true;
         }
 
         return viewThresholds.includes(pageViews);
-      }
+    }
 
-      if (shouldShowSurvey()) {
+    if (shouldShowSurvey()) {
         modal.show();
-      }
+    }
 
-      dontShowAgain.addEventListener('change', function() {
+    dontShowAgain.addEventListener('change', function() {
         if (this.checked) {
-          localStorage.setItem('dontShowSurvey', 'true');
-          localStorage.setItem('surveyVersion', surveyVersion);
+            localStorage.setItem('dontShowSurvey', 'true');
+            localStorage.setItem('surveyVersion', surveyVersion);
         } else {
-          localStorage.removeItem('dontShowSurvey');
-          localStorage.removeItem('surveyVersion');
+            localStorage.removeItem('dontShowSurvey');
+            localStorage.removeItem('surveyVersion');
         }
-      });
+    });
 
-      takeSurveyButton.addEventListener('click', function() {
+    takeSurveyButton.addEventListener('click', function() {
         localStorage.setItem('surveyTaken', 'true');
         localStorage.setItem('surveyVersion', surveyVersion);
         modal.hide();
-      });
     });
+});
   </script>