#762 Version Info (#778)

* Infrastructure for showing version info

* Show the git commit

* Detect if in docker

* Don't bother showing the version info on docker

* fix linting issues

* fix security issues by replacing GitPython with a subprocess command

* fix linting issues

Author: lprichar

poetry.lock

@@ -93,6 +93,7 @@
     MODE_KEY,
     PORT_KEY,
     ServiceBase,
+    VersionService,
     announce_guardians,
     authorization_service,
     backup_to_dict,
@@ -139,6 +140,7 @@
     status_descriptions,
     to_ballot_share_raw,
     verification_to_dict,
+    version_service,
 )
 from electionguard_gui.start import (
     run,
@@ -192,6 +194,7 @@
     "PORT_KEY",
     "ServiceBase",
     "UploadBallotsComponent",
+    "VersionService",
     "ViewDecryptionComponent",
     "ViewElectionComponent",
     "ViewSpoiledBallotComponent",
@@ -271,6 +274,7 @@
     "upload_ballots_component",
     "utc_to_str",
     "verification_to_dict",
+    "version_service",
     "view_decryption_component",
     "view_election_component",
     "view_spoiled_ballot_component",

src/electionguard_gui/__init__.py

@@ -35,6 +35,7 @@
     DecryptionService,
     DbWatcherService,
     ConfigurationService,
+    VersionService,
 )
 from electionguard_gui.services.decryption_stages import (
     DecryptionS1JoinService,
@@ -58,6 +59,9 @@ class Container(containers.DeclarativeContainer):
     config_service: Factory[ConfigurationService] = providers.Factory(
         ConfigurationService
     )
+    version_service: Factory[VersionService] = providers.Factory(
+        VersionService, log_service=log_service
+    )
     db_service: Singleton[DbService] = providers.Singleton(
         DbService, log_service=log_service, config_service=config_service
     )
@@ -302,4 +306,5 @@ class Container(containers.DeclarativeContainer):
         export_election_record_component=export_election_record_component,
         view_tally_component=view_tally_component,
         view_spoiled_ballot_component=view_spoiled_ballot_component,
+        version_service=version_service,
     )

src/electionguard_gui/containers.py

@@ -25,6 +25,7 @@
     EelLogService,
     ServiceBase,
     ConfigurationService,
+    VersionService,
 )
 
 
@@ -55,6 +56,7 @@ def __init__(
         export_election_record_component: ExportElectionRecordComponent,
         view_tally_component: ViewTallyComponent,
         view_spoiled_ballot_component: ViewSpoiledBallotComponent,
+        version_service: VersionService,
     ) -> None:
         super().__init__()
 
@@ -83,6 +85,7 @@ def __init__(
             authorization_service,
             db_service,
             log_service,
+            version_service,
         ]
 
     def start(self) -> None:

src/electionguard_gui/main_app.py

@@ -17,6 +17,7 @@
 from electionguard_gui.services import key_ceremony_state_service
 from electionguard_gui.services import plaintext_ballot_service
 from electionguard_gui.services import service_base
+from electionguard_gui.services import version_service
 
 from electionguard_gui.services.authorization_service import (
     AuthorizationService,
@@ -113,6 +114,9 @@
 from electionguard_gui.services.service_base import (
     ServiceBase,
 )
+from electionguard_gui.services.version_service import (
+    VersionService,
+)
 
 __all__ = [
     "AuthorizationService",
@@ -145,6 +149,7 @@
     "MODE_KEY",
     "PORT_KEY",
     "ServiceBase",
+    "VersionService",
     "announce_guardians",
     "authorization_service",
     "backup_to_dict",
@@ -191,4 +196,5 @@
     "status_descriptions",
     "to_ballot_share_raw",
     "verification_to_dict",
+    "version_service",
 ]

src/electionguard_gui/services/__init__.py

@@ -0,0 +1,29 @@
+from os import path
+from subprocess import check_output
+from typing import Optional
+import eel
+from electionguard_gui.services.eel_log_service import EelLogService
+from electionguard_gui.services.service_base import ServiceBase
+
+
+class VersionService(ServiceBase):
+    """Responsible for retrieving version information"""
+
+    _log: EelLogService
+
+    def __init__(self, log_service: EelLogService) -> None:
+        self._log = log_service
+
+    def expose(self) -> None:
+        eel.expose(self.get_version)
+
+    def get_version(self) -> Optional[str]:
+        if not path.exists(".git"):
+            return None
+        commit_hash = (
+            check_output(["git", "rev-parse", "--short", "HEAD"])
+            .decode("ascii")
+            .strip()
+        )
+        self._log.info(f"Version: {commit_hash}")
+        return commit_hash

src/electionguard_gui/services/version_service.py

@@ -0,0 +1,19 @@
+export default {
+  data() {
+    return {
+      version: null,
+    };
+  },
+  async mounted() {
+    this.version = await eel.get_version()();
+  },
+  template: /*html*/ `
+  <nav class="navbar fixed-bottom bg-light" v-if="version">
+    <div class="container-fluid">
+        <div class="col-12 pe-0 text-end text-secondary text-opacity-75">
+          ElectionGuard version {{version}}
+        </div>
+    </div>
+  </nav>
+  `,
+};

src/electionguard_gui/web/components/shared/footer-component.js

@@ -20,10 +20,11 @@
 
     <div id="app">
       <navbar :user-id="userId"></navbar>
-      <div class="container mt-3">
+      <div class="container mt-3 mb-4">
         <Login @login="login" v-if="showLogin"></Login>
         <component :is="currentView" v-bind="currentViewProperties" />
       </div>
+      <eg-footer></eg-footer>
     </div>
 
     <script type="module">
@@ -32,6 +33,7 @@
       // components
       import Navbar from "./components/shared/navbar-component.js";
       import Login from "./components/shared/login-component.js";
+      import EgFooter from "./components/shared/footer-component.js";
 
       // services
       import AuthorizationService from "./services/authorization-service.js";
@@ -83,6 +85,7 @@
         components: {
           Navbar,
           Login,
+          EgFooter,
         },
       }).mount("#app");
     </script>