From f47aa07c60cccde1e8606c25a2f71a821094a45c Mon Sep 17 00:00:00 2001
From: Matthew White <matthew-white@users.noreply.github.com>
Date: Fri, 13 Dec 2024 12:20:30 -0500
Subject: [PATCH] Show Central version in modal

---
 src/components/app.vue                  | 34 ++++++-----
 src/components/central-version.vue      | 75 +++++++++++++++++++++++++
 src/components/navbar.vue               |  7 ++-
 src/components/navbar/help-dropdown.vue |  5 +-
 src/components/selectable.vue           | 13 ++++-
 src/main.js                             |  5 +-
 transifex/strings_en.json               | 12 ++++
 7 files changed, 130 insertions(+), 21 deletions(-)
 create mode 100644 src/components/central-version.vue

diff --git a/src/components/app.vue b/src/components/app.vue
index d71310e14..b91a6b20b 100644
--- a/src/components/app.vue
+++ b/src/components/app.vue
@@ -45,9 +45,10 @@ import Navbar from './navbar.vue';
 import useCallWait from '../composables/call-wait';
 import useDisabled from '../composables/disabled';
 import useFeatureFlags from '../composables/feature-flags';
+import { loadAsync } from '../util/load-async';
+import { noop } from '../util/util';
 import { useRequestData } from '../request-data';
 import { useSessions } from '../util/session';
-import { loadAsync } from '../util/load-async';
 
 export default {
   name: 'App',
@@ -73,9 +74,12 @@ export default {
 
     const { features } = useFeatureFlags();
 
-    const { centralVersion } = useRequestData();
+    const { centralVersion, createResource } = useRequestData();
+    // Used to re-fetch version.txt in order to check for a version change.
+    const latestVersion = createResource('latestVersion');
+
     const { callWait } = useCallWait();
-    return { visiblyLoggedIn, centralVersion, callWait, features };
+    return { visiblyLoggedIn, centralVersion, latestVersion, callWait, features };
   },
   computed: {
     routerReady() {
@@ -87,23 +91,28 @@ export default {
     },
   },
   created() {
+    setTimeout(this.requestVersion, 15000);
     this.callWait('checkVersion', this.checkVersion, (tries) =>
-      (tries === 0 ? 15000 : 60000));
+      (tries === 0 ? 75000 : 60000));
   },
   // Reset backgroundColor after each test.
   beforeUnmount() {
     document.documentElement.style.backgroundColor = '';
   },
   methods: {
-    checkVersion() {
-      const previousVersion = this.centralVersion.versionText;
-      return this.centralVersion.request({
+    requestVersion() {
+      this.centralVersion.request({
         url: '/version.txt',
-        clear: false,
+        resend: false,
         alert: false
-      })
+      }).catch(noop);
+    },
+    checkVersion() {
+      if (!this.centralVersion.dataExists)
+        return !this.centralVersion.awaitingResponse;
+      return this.latestVersion.request({ url: '/version.txt', alert: false })
         .then(() => {
-          if (previousVersion == null || this.centralVersion.versionText === previousVersion)
+          if (this.latestVersion.data === this.centralVersion.versionText)
             return false;
 
           // Alert the user about the version change, then keep alerting them.
@@ -116,10 +125,7 @@ export default {
           );
           return true;
         })
-        // This error could be the result of logout, which will cancel all
-        // requests.
-        .catch(error =>
-          (error.response != null && error.response.status === 404));
+        .catch(noop);
     },
     hideAlertAfterClick(event) {
       if (this.alert.state && event.target.closest('a[target="_blank"]') != null &&
diff --git a/src/components/central-version.vue b/src/components/central-version.vue
new file mode 100644
index 000000000..856300f97
--- /dev/null
+++ b/src/components/central-version.vue
@@ -0,0 +1,75 @@
+<!--
+Copyright 2024 ODK Central Developers
+See the NOTICE file at the top-level directory of this distribution and at
+https://github.com/getodk/central-frontend/blob/master/NOTICE.
+
+This file is part of ODK Central. It is subject to the license terms in
+the LICENSE file found in the top-level directory of this distribution and at
+https://www.apache.org/licenses/LICENSE-2.0. No part of ODK Central,
+including this file, may be copied, modified, propagated, or distributed
+except according to the terms contained in the LICENSE file.
+-->
+<template>
+  <modal id="central-version" :state="state" hideable backdrop
+    @hide="$emit('hide')">
+    <template #title>{{ $t('title') }}</template>
+    <template #body>
+      <loading :state="centralVersion.initiallyLoading"/>
+      <div v-if="centralVersion.dataExists" class="modal-introduction">
+        <p>{{ $t('shortVersion', { version: centralVersion.currentVersion }) }}</p>
+        <p>{{ $t('longVersion') }}</p>
+        <pre><code><selectable wrap>{{ centralVersion.versionText }}</selectable></code></pre>
+      </div>
+      <div class="modal-actions">
+        <button type="button" class="btn btn-primary" @click="$emit('hide')">
+          {{ $t('action.close') }}
+        </button>
+      </div>
+    </template>
+  </modal>
+</template>
+
+<script setup>
+import { watch } from 'vue';
+
+import Loading from './loading.vue';
+import Modal from './modal.vue';
+import Selectable from './selectable.vue';
+
+import { noop } from '../util/util';
+import { useRequestData } from '../request-data';
+
+defineOptions({
+  name: 'CentralVersion'
+});
+const props = defineProps({
+  state: Boolean
+});
+defineEmits(['hide']);
+
+const { centralVersion } = useRequestData();
+
+watch(() => props.state, (state) => {
+  if (state)
+    centralVersion.request({ url: '/version.txt', resend: false })
+      .catch(noop);
+});
+</script>
+
+<style lang="scss">
+#central-version {
+  .loading { min-height: 120px; }
+}
+</style>
+
+<i18n lang="json5">
+{
+  "en": {
+    // This is the title at the top of a pop-up. It refers to the version of ODK
+    // Central that the user is using.
+    "title": "Central Version",
+    "shortVersion": "You are using version {version} of ODK Central.",
+    "longVersion": "You can find more detailed version information below:"
+  }
+}
+</i18n>
diff --git a/src/components/navbar.vue b/src/components/navbar.vue
index f4dd8fa85..480953979 100644
--- a/src/components/navbar.vue
+++ b/src/components/navbar.vue
@@ -32,7 +32,7 @@ except according to the terms contained in the LICENSE file.
               {{ $t('analyticsNotice') }}
             </a>
             <ul class="nav navbar-nav">
-              <navbar-help-dropdown/>
+              <navbar-help-dropdown @show-version="versionModal.show()"/>
               <navbar-locale-dropdown/>
               <navbar-actions/>
             </ul>
@@ -40,6 +40,8 @@ except according to the terms contained in the LICENSE file.
         </div>
       </div>
     </nav>
+
+    <central-version v-bind="versionModal" @hide="versionModal.hide()"/>
     <analytics-introduction v-if="config.loaded && config.showsAnalytics"
       v-bind="analyticsIntroduction" @hide="analyticsIntroduction.hide()"/>
   </div>
@@ -48,6 +50,7 @@ except according to the terms contained in the LICENSE file.
 <script>
 import { defineAsyncComponent } from 'vue';
 
+import CentralVersion from './central-version.vue';
 import NavbarActions from './navbar/actions.vue';
 import NavbarHelpDropdown from './navbar/help-dropdown.vue';
 import NavbarLinks from './navbar/links.vue';
@@ -62,6 +65,7 @@ export default {
   name: 'Navbar',
   components: {
     AnalyticsIntroduction: defineAsyncComponent(loadAsync('AnalyticsIntroduction')),
+    CentralVersion,
     NavbarActions,
     NavbarHelpDropdown,
     NavbarLinks,
@@ -77,6 +81,7 @@ export default {
   },
   data() {
     return {
+      versionModal: modalData(),
       analyticsIntroduction: modalData('AnalyticsIntroduction')
     };
   },
diff --git a/src/components/navbar/help-dropdown.vue b/src/components/navbar/help-dropdown.vue
index ba063caf5..4e4b7344d 100644
--- a/src/components/navbar/help-dropdown.vue
+++ b/src/components/navbar/help-dropdown.vue
@@ -23,7 +23,9 @@ except according to the terms contained in the LICENSE file.
         <a href="https://forum.getodk.org/" target="_blank">{{ $t('common.forum') }}</a>
       </li>
       <li>
-        <a href="/version.txt" target="_blank">{{ $t('common.version') }}</a>
+        <a href="#" @click.prevent="$emit('show-version')">
+          {{ $t('common.version') }}
+        </a>
       </li>
     </ul>
   </li>
@@ -35,6 +37,7 @@ import DocLink from '../doc-link.vue';
 defineOptions({
   name: 'NavbarHelpDropdown'
 });
+defineEmits(['show-version']);
 </script>
 
 <i18n lang="json5">
diff --git a/src/components/selectable.vue b/src/components/selectable.vue
index 7aa79de73..4270e196c 100644
--- a/src/components/selectable.vue
+++ b/src/components/selectable.vue
@@ -10,7 +10,7 @@ including this file, may be copied, modified, propagated, or distributed
 except according to the terms contained in the LICENSE file.
 -->
 <template>
-  <div ref="el" class="selectable" @click="select"><!-- eslint-disable-line vuejs-accessibility/click-events-have-key-events, vue/multiline-html-element-content-newline -->
+  <div ref="el" class="selectable" :class="{ scroll: !wrap }" @click="select"><!-- eslint-disable-line vuejs-accessibility/click-events-have-key-events, vue/multiline-html-element-content-newline -->
     <slot></slot>
   </div>
 </template>
@@ -18,6 +18,10 @@ except according to the terms contained in the LICENSE file.
 <script setup>
 import { ref } from 'vue';
 
+defineProps({
+  wrap: Boolean
+});
+
 const el = ref(null);
 const select = () => {
   const selection = getSelection();
@@ -31,7 +35,10 @@ const select = () => {
 
 .selectable {
   font-family: $font-family-monospace;
-  overflow-x: auto;
-  white-space: nowrap;
+
+  &.scroll {
+    overflow-x: auto;
+    white-space: nowrap;
+  }
 }
 </style>
diff --git a/src/main.js b/src/main.js
index bff5590cb..6bd8a3c28 100644
--- a/src/main.js
+++ b/src/main.js
@@ -15,8 +15,6 @@ import { createApp } from 'vue';
 // components' styles.
 import './styles';
 
-import App from './components/app.vue';
-
 import createContainer from './container';
 import vTooltip from './directives/tooltip';
 // ./jquery must be imported before any of Bootstrap's JavaScript plugins,
@@ -24,6 +22,9 @@ import vTooltip from './directives/tooltip';
 import './jquery';
 import './bootstrap';
 
+// App must be imported after the Bootstrap modal plugin.
+import App from './components/app.vue';
+
 createApp(App)
   .use(createContainer())
   .directive('tooltip', vTooltip)
diff --git a/transifex/strings_en.json b/transifex/strings_en.json
index 645e37cf4..389fe9508 100644
--- a/transifex/strings_en.json
+++ b/transifex/strings_en.json
@@ -1479,6 +1479,18 @@
         }
       }
     },
+    "CentralVersion": {
+      "title": {
+        "string": "Central Version",
+        "developer_comment": "This is the title at the top of a pop-up. It refers to the version of ODK Central that the user is using."
+      },
+      "shortVersion": {
+        "string": "You are using version {version} of ODK Central."
+      },
+      "longVersion": {
+        "string": "You can find more detailed version information below:"
+      }
+    },
     "CollectQr": {
       "draft": {
         "string": "Temporary Testing Code",