0075 add available update detection (#109)

joncage · web-flow · commit 6d530523718b · 2020-10-05T22:49:40.000+01:00
* Added the basis for a version check to the back end.
* Fixed the backend so we only send an update once the client has connected.
* Altered the front end to display an alert if a new version is available.
* Added some protection to the back end in case the version check has problems.
diff --git a/EDScoutWebUI/EDScout.py b/EDScoutWebUI/EDScout.py
@@ -6,6 +6,10 @@
 import tempfile
 import psutil
 import time
+import threading
+import requests
+import re
+
 from datetime import datetime
 from pathlib import Path
 
@@ -87,6 +91,34 @@ def configure_logger(logger_to_configure, log_path, log_level_override=None):
         logger_to_configure.addHandler(ch)
 
 
+def version_check(current_version):
+    latest_release_url = 'https://github.com/joncage/ed-scout/releases/latest'
+    try:
+        r = requests.get(latest_release_url)
+    except Exception as pass_on_failure:
+        log.exception(pass_on_failure)
+        return
+
+    latest_version = r.url.split('/')[-1]
+
+    regex = r"[vV]?\d+\.\d+\.\d+\.?\d?"
+    if re.search(regex, latest_version) is not None:
+        new_version_available = latest_version != current_version
+        content = {
+            'current_version': current_version,
+            'latest_version': latest_version,
+            'new_release_detected': new_version_available,
+            'url': latest_release_url
+        }
+
+        version_check_description = 'New version available: '+latest_version if new_version_available else 'Up to date'
+        log.info(f"Version check: {version_check_description}")
+
+        socketio.emit('version', content, broadcast=True)
+    else:
+        log.error(f"Failed to identify latest version from '{latest_version}'")
+
+
 # Work out where to stick the logs and make sure it exists
 logging_dir = os.path.join(os.path.expanduser('~'), 'AppData', 'Local', 'EDScout', 'Logs')
 if not os.path.isdir(logging_dir):
@@ -160,6 +192,10 @@ def receive_and_forward(scout):
     r = Receiver(port=scout.port)
     scout.trigger_current_journal_check()
 
+    # Launch the version check. Note that we only do this after the client has connected to avoid them missing this.
+    version_check_thread = threading.Thread(target=version_check, args=(__version__,))
+    version_check_thread.start()
+
     while True:
         message = r.receive().decode('ascii')
         try:
@@ -171,7 +207,7 @@ def receive_and_forward(scout):
             log.exception(pass_on_failure)
 
 
-@app.route('/')Disabling caching
+@app.route('/')
 def index():
     return render_template('index.html',
                            version=__version__,
@@ -237,6 +273,7 @@ def remap_css_to_match_hud():
         # Enable toggling
         toggler = WindowToggler.ScoutToggler()
 
+
         # Launch the web server either directly or as an app
         if ui:
             ui.run()
diff --git a/EDScoutWebUI/static/style.css b/EDScoutWebUI/static/style.css
@@ -104,3 +104,8 @@ div b.active.landable {
 .next-system hr {
     border-color: #17EFF9;
 }
+
+.alert {
+    top: 1em;
+    bottom: 1em;
+}
diff --git a/EDScoutWebUI/templates/index.html b/EDScoutWebUI/templates/index.html
@@ -20,7 +20,18 @@
 
 <body>
 
-
+    <div class="container-fluid">
+        <div class="row">
+            <div class="col">
+                <div id="new-version-alert-wrapper" class="alert alert-info alert-dismissible fade show" role="alert" hidden>
+                  <span>New Version Available</span>: <strong id="version-link-wrapper"></strong>
+                  <button type="button" class="close" data-dismiss="alert" aria-label="Close">
+                    <span aria-hidden="true">&times;</span>
+                  </button>
+                </div>
+            </div>
+        </div>
+    </div>
 
     <div class="container-fluid">
         <div class="row separator align-items-center">
@@ -801,9 +812,28 @@
 
             /**/
 
+            function versionCheckReport(versionCheck) {
+                console.log(versionCheck);
+
+                if (versionCheck['new_release_detected']) {
+                    let versionInfoElement = document.getElementById('version-link-wrapper')
+                    let link = document.createElement('a')
+                    link.href = versionCheck['url']
+                    link.text = versionCheck['latest_version']
+                    link.target = '_blank'
+                    link.classList.add('alert-link')
+                    versionInfoElement.innerHTML = link.outerHTML
+
+                    let alertDiv = document.getElementById('new-version-alert-wrapper')
+                    alertDiv.hidden = false;
+                }
+            }
+
+
             if (enableBackendConnections) {
                 var socket = io()
                 socket.on('log', postData)
+                socket.on('version', versionCheckReport)
 
                 document.addEventListener('DOMContentLoaded', function() {
                     var url = 'http://'+window.location.hostname+':5001/GUI-is-still-open';

Original file line number	Diff line number	Diff line change
`@@ -104,3 +104,8 @@ div b.active.landable {`
`104`	`104`	`.next-system hr {`
`105`	`105`	`border-color: #17EFF9;`
`106`	`106`	`}`
	`107`	`+`
	`108`	`+.alert {`
	`109`	`+ top: 1em;`
	`110`	`+ bottom: 1em;`
	`111`	`+}`