Merge pull request #32 from davewalker5/MC-204-Ensure-Maps-Key-Retrieved

MC-204 Improve reliability of Google Maps API key retrieval and storage

docker/ui/Dockerfile

@@ -1,6 +1,6 @@
 FROM node:20-alpine
-COPY musiccatalogue.ui-1.21.0.0 /opt/musiccatalogue.ui-1.21.0.0
-WORKDIR /opt/musiccatalogue.ui-1.21.0.0
+COPY musiccatalogue.ui-1.22.0.0 /opt/musiccatalogue.ui-1.22.0.0
+WORKDIR /opt/musiccatalogue.ui-1.22.0.0
 RUN npm install
 RUN npm run build
 ENTRYPOINT [ "npm", "start" ]

src/MusicCatalogue.Data/Migrations/20231119165005_ReportId.cs

@@ -5,6 +5,7 @@
 
 namespace MusicCatalogue.Data.Migrations
 {
+    [ExcludeFromCodeCoverage]
     /// <inheritdoc />
     public partial class ReportId : Migration
     {

src/music-catalogue-ui/components/app.js

@@ -1,11 +1,12 @@
-import React, { useCallback, useEffect, useState } from "react";
+import React, { useCallback, useState } from "react";
 import Login from "./login";
 import pages from "@/helpers/navigation";
 import ComponentPicker from "./componentPicker";
 import { apiClearToken } from "@/helpers/apiToken";
 import useIsLoggedIn from "@/hooks/useIsLoggedIn";
 import MenuBar from "./menuBar";
-import { apiFetchSecret } from "@/helpers/apiSecrets";
+import { clearStorageValue } from "@/helpers/storage";
+import secrets from "@/helpers/secrets";
 
 /**
  * Default application state:
@@ -32,9 +33,6 @@ const App = () => {
   // Application state
   const [context, setContext] = useState(defaultContext);
 
-  // Google Maps API key
-  const [mapsApiKey, setMapsApiKey] = useState(null);
-
   // Callback to set the context
   const navigate = ({
     page = pages.artists,
@@ -65,22 +63,11 @@ const App = () => {
   }, [setIsLoggedIn]);
 
   const logout = useCallback(() => {
+    clearStorageValue(secrets.mapsApiKey);
     apiClearToken();
     setIsLoggedIn(false);
   }, [setIsLoggedIn]);
 
-  // Get the Google Maps API key and store it in state
-  useEffect(() => {
-    const fetchMapsApiKey = async () => {
-      try {
-        var fetchedKey = await apiFetchSecret("Maps API Key", logout);
-        setMapsApiKey(fetchedKey);
-      } catch {}
-    };
-
-    fetchMapsApiKey();
-  }, [logout]);
-
   // If the user's logged in, show the banner and current component. Otherwise,
   // show the login page
   return (
@@ -93,7 +80,6 @@ const App = () => {
           <div>
             <ComponentPicker
               context={context}
-              mapsApiKey={mapsApiKey}
               navigate={navigate}
               logout={logout}
             />

src/music-catalogue-ui/components/componentPicker.js

@@ -21,7 +21,7 @@ import RetailerEditor from "./retailerEditor";
  * @param {*} logout
  * @returns
  */
-const ComponentPicker = ({ context, mapsApiKey, navigate, logout }) => {
+const ComponentPicker = ({ context, navigate, logout }) => {
   switch (context.page) {
     case pages.artists:
       return (
@@ -80,7 +80,6 @@ const ComponentPicker = ({ context, mapsApiKey, navigate, logout }) => {
     case pages.retailerDetails:
       return (
         <RetailerDetails
-          mapsApiKey={mapsApiKey}
           retailer={context.retailer}
           navigate={navigate}
           logout={logout}

src/music-catalogue-ui/components/locationMap.js

@@ -1,17 +1,19 @@
 import GoogleMapReact from "google-map-react";
-import { useState } from "react";
 import styles from "./locationMap.module.css";
+import secrets from "@/helpers/secrets";
 import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
 import { faMapMarkerAlt } from "@fortawesome/free-solid-svg-icons";
+import { getStorageValue } from "@/helpers/storage";
 
-const LocationMap = ({ apiKey, latitude, longitude }) => {
-  const [location, setLocation] = useState({ lat: latitude, lng: longitude });
+const LocationMap = ({ latitude, longitude }) => {
+  const location = { lat: latitude, lng: longitude };
+  const mapsApiKey = getStorageValue(secrets.mapsApiKey);
 
   return (
     <>
       <div className={styles.locationMapContainer}>
         <GoogleMapReact
-          bootstrapURLKeys={{ key: apiKey }}
+          bootstrapURLKeys={{ key: mapsApiKey }}
           defaultCenter={location}
           defaultZoom={15}
         >

src/music-catalogue-ui/components/login.js

@@ -1,7 +1,10 @@
 import styles from "./login.module.css";
+import secrets from "@/helpers/secrets";
 import { React, useState, useCallback } from "react";
 import { apiAuthenticate } from "@/helpers/apiAuthenticate";
 import { apiSetToken } from "@/helpers/apiToken";
+import { apiFetchSecret } from "@/helpers/apiSecrets";
+import { setStorageValue } from "@/helpers/storage";
 
 /**
  * Component to render the login page
@@ -24,6 +27,14 @@ const Login = ({ login }) => {
       if (token != null) {
         // Successful, so store the token
         apiSetToken(token);
+
+        // Now attempt to get the Google Maps API key
+        const apiKey = await apiFetchSecret(secrets.mapsApiKey);
+        if (apiKey != null) {
+          // Successful, so store it
+          setStorageValue(secrets.mapsApiKey, apiKey);
+        }
+
         login(true);
       }
     },

src/music-catalogue-ui/components/retailerDetails.js

@@ -1,13 +1,17 @@
+import { getStorageValue } from "@/helpers/storage";
 import pages from "../helpers/navigation";
 import LocationMap from "./locationMap";
 import styles from "./retailerDetails.module.css";
+import secrets from "@/helpers/secrets";
 
 /**
  * Component to show retailer addressing and web site details and map location
- * @param {*} param0
+ * @param {*} retailer
+ * @param {*} navigate
+ * @param {*} logout
  * @returns
  */
-const RetailerDetails = ({ mapsApiKey, retailer, navigate, logout }) => {
+const RetailerDetails = ({ retailer, navigate, logout }) => {
   // Set a flag indicating if we have enough data to show the map
   const canShowMap = retailer.latitude != null && retailer.longitude != null;
 
@@ -23,7 +27,6 @@ const RetailerDetails = ({ mapsApiKey, retailer, navigate, logout }) => {
       </div>
       {canShowMap == true ? (
         <LocationMap
-          apiKey={mapsApiKey}
           latitude={retailer.latitude}
           longitude={retailer.longitude}
           logout={logout}

src/music-catalogue-ui/components/retailerList.js

@@ -3,12 +3,11 @@ import RetailerRow from "./retailerRow";
 
 /**
  * Component to render a table listing all the retailers in the catalogue
- * @param {*} mapsApiKey
  * @param {*} navigate
  * @param {*} logout
  * @returns
  */
-const RetailerList = ({ mapsApiKey, navigate, logout }) => {
+const RetailerList = ({ navigate, logout }) => {
   const { retailers: retailers, setRetailers } = useRetailers(logout);
 
   return (
@@ -30,12 +29,7 @@ const RetailerList = ({ mapsApiKey, navigate, logout }) => {
         {retailers != null && (
           <tbody>
             {retailers.map((r) => (
-              <RetailerRow
-                key={r.id}
-                mapsApiKey={mapsApiKey}
-                retailer={r}
-                navigate={navigate}
-              />
+              <RetailerRow key={r.id} retailer={r} navigate={navigate} />
             ))}
           </tbody>
         )}

src/music-catalogue-ui/components/retailerRow.js

@@ -4,20 +4,18 @@ import { faPenToSquare } from "@fortawesome/free-solid-svg-icons";
 
 /**
  * Component to render a row containing the details for a single retailer
- * @param {*} mapsApiKey
  * @param {*} artist
  * @param {*} navigate
  * @returns
  */
-const RetailerRow = ({ mapsApiKey, retailer, navigate }) => {
+const RetailerRow = ({ retailer, navigate }) => {
   return (
     <tr>
       <td
         onClick={() =>
           navigate({
             page: pages.retailerDetails,
             retailer: retailer,
-            mapsApiKey: mapsApiKey,
           })
         }
       >
@@ -28,7 +26,6 @@ const RetailerRow = ({ mapsApiKey, retailer, navigate }) => {
           navigate({
             page: pages.retailerDetails,
             retailer: retailer,
-            mapsApiKey: mapsApiKey,
           })
         }
       >
@@ -39,7 +36,6 @@ const RetailerRow = ({ mapsApiKey, retailer, navigate }) => {
           navigate({
             page: pages.retailerDetails,
             retailer: retailer,
-            mapsApiKey: mapsApiKey,
           })
         }
       >
@@ -50,7 +46,6 @@ const RetailerRow = ({ mapsApiKey, retailer, navigate }) => {
           navigate({
             page: pages.retailerDetails,
             retailer: retailer,
-            mapsApiKey: mapsApiKey,
           })
         }
       >

src/music-catalogue-ui/helpers/apiToken.js

@@ -1,33 +1,21 @@
+import { setStorageValue, getStorageValue, clearStorageValue } from "./storage";
+
 /**
  * Store the JWT token
  * @param {*} token
  */
-const apiSetToken = (token) => {
-  // TODO: Move to HTTP Cookie
-  localStorage.setItem("token", token);
-};
+const apiSetToken = (token) => setStorageValue("token", token);
 
 /**
  * Retrieve the current JWT token
  * @param {*} token
  * @returns
  */
-const apiGetToken = () => {
-  try {
-    // TODO: Move to HTTP Cookie
-    const token = localStorage.getItem("token");
-    return token;
-  } catch {
-    return null;
-  }
-};
+const apiGetToken = () => getStorageValue("token");
 
 /**
  * Clear the current JWT token
  */
-const apiClearToken = () => {
-  // TODO: Move to HTTP Cookie
-  localStorage.removeItem("token");
-};
+const apiClearToken = () => clearStorageValue("token");
 
 export { apiClearToken, apiSetToken, apiGetToken };

src/music-catalogue-ui/helpers/secrets.js

@@ -0,0 +1,5 @@
+const secrets = {
+  mapsApiKey: "Maps API Key",
+};
+
+export default secrets;

src/music-catalogue-ui/helpers/storage.js

@@ -0,0 +1,45 @@
+/**
+ * Convert a name that may be mixed case and with spaces to a local storage key
+ * @param {*} name
+ * @returns
+ */
+const getStorageKey = (name) => {
+  const key = name.toLowerCase().replace(/ /g, "-");
+  return key;
+};
+
+/**
+ * Store a named value
+ * @param {*} token
+ * @param {*} value
+ */
+const setStorageValue = (name, value) => {
+  const key = getStorageKey(name);
+  localStorage.setItem(key, value);
+};
+
+/**
+ * Retrieve a stored value
+ * @param {*} name
+ * @returns
+ */
+const getStorageValue = (name) => {
+  try {
+    const key = getStorageKey(name);
+    const token = localStorage.getItem(key);
+    return token;
+  } catch {
+    return null;
+  }
+};
+
+/**
+ * Clear a named storage value
+ * @param {*} name
+ */
+const clearStorageValue = (name) => {
+  const key = getStorageKey(name);
+  localStorage.removeItem(key);
+};
+
+export { setStorageValue, getStorageValue, clearStorageValue };