Implement function for retrieving environment variables

DiSSCo · Dec 6, 2024 · 76d67c1 · 76d67c1
1 parent d3cadcb
commit 76d67c1
Show file tree

Hide file tree

Showing 24 changed files with 115 additions and 46 deletions.
diff --git a/src/api/annotation/DeleteAnnotation.ts b/src/api/annotation/DeleteAnnotation.ts
@@ -2,6 +2,9 @@
 import axios from 'axios';
 import KeycloakService from 'app/Keycloak';
 
+/* Import Utilities */
+import { RetrieveEnvVariable } from 'app/Utilities';
+
 /* Import Types */
 import { Dict } from 'app/Types';
 
@@ -22,7 +25,7 @@ const DeleteAnnotation = async ({ annotationId }: { annotationId: string }): Pro
     try {
         const result = await axios({
             method: 'delete',
-            url: `annotation/${annotationId.replace(import.meta.env.VITE_HANDLE_URL, '')}`,
+            url: `annotation/${annotationId.replace(RetrieveEnvVariable('HANDLE_URL'), '')}`,
             responseType: 'json',
             headers: {
                 'Content-type': 'application/json',

diff --git a/src/api/annotation/PatchAnnotation.ts b/src/api/annotation/PatchAnnotation.ts
@@ -2,6 +2,9 @@
 import axios from 'axios';
 import KeycloakService from 'app/Keycloak';
 
+/* Import Utilities */
+import { RetrieveEnvVariable } from 'app/Utilities';
+
 /* Import Types */
 import { Annotation } from 'app/types/Annotation';
 import { AnnotationTemplate, JSONResult } from 'app/Types';
@@ -37,7 +40,7 @@ const PatchAnnotation = async ({ annotationId, updatedAnnotation }: { annotation
     try {
         const result = await axios({
             method: 'patch',
-            url: `annotation/${annotationId.replace(import.meta.env.VITE_HANDLE_URL, '')}`,
+            url: `annotation/${annotationId.replace(RetrieveEnvVariable('HANDLE_URL'), '')}`,
             responseType: 'json',
             data: patchAnnotation,
             headers: {

diff --git a/src/api/digitalMedia/GetDigitalMediaMasJobRecords.ts b/src/api/digitalMedia/GetDigitalMediaMasJobRecords.ts
@@ -1,6 +1,9 @@
 /* Import Dependencies */
 import axios from 'axios';
 
+/* Import Utilities */
+import { RetrieveEnvVariable } from 'app/Utilities';
+
 /* Import Types */
 import { MasJobRecord, JSONResultArray, Dict } from 'app/Types';
 
@@ -23,7 +26,7 @@ const GetDigitalMediaMasJobRecords = async ({ handle, pageSize, pageNumber, stat
     };
 
     if (handle) {
-        const endPoint: string = `/digital-media/${handle.replace(import.meta.env.VITE_DOI_URL, '')}/mjr`;
+        const endPoint: string = `/digital-media/${handle.replace(RetrieveEnvVariable('DOI_URL'), '')}/mjr`;
 
         try {
             const result = await axios({

diff --git a/src/api/digitalMedia/ScheduleDigitalMediaMas.ts b/src/api/digitalMedia/ScheduleDigitalMediaMas.ts
@@ -2,6 +2,9 @@
 import axios from 'axios';
 import KeycloakService from 'app/Keycloak';
 
+/* Import Utilities */
+import { RetrieveEnvVariable } from 'app/Utilities';
+
 /* Import Exceptions */
 import { PostException } from 'app/Exceptions';
 
@@ -42,7 +45,7 @@ const ScheduleDigitalMediaMas = async ({ handle, masList }: { handle: string, ma
         try {
             const result = await axios({
                 method: 'post',
-                url: `digital-media/${handle.replace(import.meta.env.VITE_DOI_URL, '')}/mas`,
+                url: `digital-media/${handle.replace(RetrieveEnvVariable('DOI_URL'), '')}/mas`,
                 responseType: 'json',
                 data: masRecord,
                 headers: {

diff --git a/src/api/digitalSpecimen/GetDigitalSpecimenMasJobRecords.ts b/src/api/digitalSpecimen/GetDigitalSpecimenMasJobRecords.ts
@@ -1,6 +1,9 @@
 /* Import Dependencies */
 import axios from 'axios';
 
+/* Import Utilities */
+import { RetrieveEnvVariable } from 'app/Utilities';
+
 /* Import Types */
 import { MasJobRecord, JSONResultArray, Dict } from 'app/Types';
 
@@ -23,7 +26,7 @@ const GetDigitalSpecimenMasJobRecords = async ({ handle, pageSize, pageNumber, s
     };
 
     if (handle) {
-        const endPoint: string = `/digital-specimen/${handle.replace(import.meta.env.VITE_DOI_URL, '')}/mjr`;
+        const endPoint: string = `/digital-specimen/${handle.replace(RetrieveEnvVariable('DOI_URL'), '')}/mjr`;
 
         try {
             const result = await axios({

diff --git a/src/api/digitalSpecimen/ScheduleDigitalSpecimenMas.ts b/src/api/digitalSpecimen/ScheduleDigitalSpecimenMas.ts
@@ -2,6 +2,9 @@
 import axios from 'axios';
 import KeycloakService from 'app/Keycloak';
 
+/* Import Utilities */
+import { RetrieveEnvVariable } from 'app/Utilities';
+
 /* Import Exceptions */
 import { PostException } from 'app/Exceptions';
 
@@ -42,7 +45,7 @@ const ScheduleDigitalSpecimenMas = async ({ handle, masList }: { handle: string,
         try {
             const result = await axios({
                 method: 'post',
-                url: `digital-specimen/${handle.replace(import.meta.env.VITE_DOI_URL, '')}/mas`,
+                url: `digital-specimen/${handle.replace(RetrieveEnvVariable('DOI_URL'), '')}/mas`,
                 responseType: 'json',
                 data: masRecord,
                 headers: {

diff --git a/src/app/Utilities.ts b/src/app/Utilities.ts
@@ -1,5 +1,5 @@
 /* Import Dependencies */
-import { startCase } from "lodash";
+import { startCase, toUpper } from "lodash";
 
 
 /**
@@ -40,7 +40,16 @@ const MobileCheck = (): boolean => {
     return isMobile;
 };
 
+/**
+ * Function for retieving an environment variable by name
+ * @param name The name of the environment variable
+ */
+const RetrieveEnvVariable = (name: string) => {
+    return import.meta.env[`VITE_${toUpper(name)}`];
+};
+
 export {
     MobileCheck,
-    MakeReadableString
+    MakeReadableString,
+    RetrieveEnvVariable
 };
diff --git a/src/app/config/table/SearchResultsTableConfig.tsx b/src/app/config/table/SearchResultsTableConfig.tsx
@@ -2,6 +2,9 @@
 import { createColumnHelper } from '@tanstack/react-table';
 import { useState } from 'react';
 
+/* Import Utilities */
+import { RetrieveEnvVariable } from 'app/Utilities';
+
 /* Import Hooks */
 import { useAppSelector } from 'app/Hooks';
 
@@ -74,7 +77,7 @@ const SearchResultsTableConfig = () => {
             }
         }),
         columnHelper.accessor('DOI', {
-            cell: info => info.getValue()?.replace(import.meta.env.VITE_DOI_URL as string, ''),
+            cell: info => info.getValue()?.replace(RetrieveEnvVariable('DOI_URL') as string, ''),
             meta: {
                 widthInRem: 10,
                 pinned: true

diff --git a/src/components/demo/DOITooltipDemo.tsx b/src/components/demo/DOITooltipDemo.tsx
@@ -1,6 +1,9 @@
 /* Import Dependencies */
 import { useState, useEffect, useRef } from "react";
 
+/* Import Utilities */
+import { RetrieveEnvVariable } from 'app/Utilities';
+
 /* Import Styles */
 import './DOITooltip.css';
 
@@ -105,14 +108,14 @@ const DOITooltipDemo = (props: Props) => {
             if (doi.includes('TEST') || doi.includes('SANDBOX')) {
                 let environment: string = doi.includes('SANDBOX') ? 'sandbox' : 'dev';
 
-                const response = await fetch(`https://${environment}.dissco.tech/handle-manager/api/v1/pids/${doi.replace(import.meta.env.VITE_DOI_URL as string, '')}`);
+                const response = await fetch(`https://${environment}.dissco.tech/handle-manager/api/v1/pids/${doi.replace(RetrieveEnvVariable('DOI_URL') as string, '')}`);
                 const record = await response.json();
 
                 if (record.data) {
                     setRecord(record);
                 }
             } else if (doi.includes('20.5000.1025')) {
-                const respone = await fetch(`https://hdl.handle.net/api/handles/${doi.replace(import.meta.env.VITE_DOI_URL as string, '')}`);
+                const respone = await fetch(`https://hdl.handle.net/api/handles/${doi.replace(RetrieveEnvVariable('DOI_URL') as string, '')}`);
                 const responseRecord = await respone.json();
 
                 if (responseRecord.values.length) {
@@ -121,7 +124,7 @@ const DOITooltipDemo = (props: Props) => {
                     setRecord(record);
                 }
             } else if (doi.includes('10.3535')) {
-                const response = await fetch(`https://doi.org/api/handles/${doi.replace(import.meta.env.VITE_DOI_URL as string, '')}`);
+                const response = await fetch(`https://doi.org/api/handles/${doi.replace(RetrieveEnvVariable('DOI_URL') as string, '')}`);
                 const responseRecord = await response.json();
 
                 if (responseRecord.values.length) {

diff --git a/src/components/digitalMedia/components/contentBlock/components/DigitalMediaFrame.tsx b/src/components/digitalMedia/components/contentBlock/components/DigitalMediaFrame.tsx
@@ -1,6 +1,9 @@
 /* Import Dependencies */
 import { Annotorious } from "@annotorious/react";
 
+/* Import Utilities */
+import { RetrieveEnvVariable } from "app/Utilities";
+
 /* Import Components */
 import { ImageViewer } from "components/elements/Elements";
 
@@ -34,7 +37,7 @@ const DigitalMediaFrame = (props: Props) => {
             <Annotorious>
                 <ImageViewer digitalMedia={digitalMedia}
                     annotoriousMode={annotoriousMode}
-                    GetAnnotations={() => GetDigitalMediaAnnotations({ handle: digitalMedia["@id"].replace(import.meta.env.VITE_DOI_URL, '') })}
+                    GetAnnotations={() => GetDigitalMediaAnnotations({ handle: digitalMedia["@id"].replace(RetrieveEnvVariable('DOI_URL'), '') })}
                     SetAnnotoriousMode={SetAnnotoriousMode}
                 />
             </Annotorious>

diff --git a/src/components/digitalMedia/components/contentBlock/components/DigitalMediaList.tsx b/src/components/digitalMedia/components/contentBlock/components/DigitalMediaList.tsx
@@ -1,6 +1,9 @@
 /* Import Dependencies */
 import { useState } from "react";
 
+/* Import Utilities */
+import { RetrieveEnvVariable } from "app/Utilities";
+
 /* Import Hooks */
 import { useNavigate } from "react-router-dom";
 import { useFetch } from "app/Hooks";
@@ -44,7 +47,7 @@ const DigitalMediaList = (props: Props) => {
         params: {
             handle: digitalMedia["ods:hasEntityRelationships"]?.find(
                 entityRelationship => entityRelationship['dwc:relationshipOfResource'] === 'hasDigitalSpecimen'
-            )?.["dwc:relatedResourceID"].replace(import.meta.env.VITE_DOI_URL, '')
+            )?.["dwc:relatedResourceID"].replace(RetrieveEnvVariable('DOI_URL'), '')
         },
         Method: GetDigitalSpecimenDigitalMedia,
         Handler: (digitalSpecimenDigitalMedia: DigitalMedia[]) => setDigitalSpecimenDigitalMedia(digitalSpecimenDigitalMedia)
@@ -60,7 +63,7 @@ const DigitalMediaList = (props: Props) => {
                         <Button type="button"
                             variant="blank"
                             className="h-100 w-100 px-0 py-0"
-                            OnClick={() => navigate(`/dm/${digitalSpecimenDigitalMedia["@id"].replace(import.meta.env.VITE_DOI_URL, '')}`)}
+                            OnClick={() => navigate(`/dm/${digitalSpecimenDigitalMedia["@id"].replace(RetrieveEnvVariable('DOI_URL'), '')}`)}
                         >
                             <DigitalMediaItem digitalMedia={digitalSpecimenDigitalMedia} />
                         </Button>

diff --git a/src/components/digitalMedia/components/topBar/TopBar.tsx b/src/components/digitalMedia/components/topBar/TopBar.tsx
@@ -4,6 +4,9 @@ import { useState } from "react";
 import { Row, Col } from "react-bootstrap";
 import { useNavigate } from "react-router-dom";
 
+/* Import Utilities */
+import { RetrieveEnvVariable } from "app/Utilities";
+
 /* Import Hooks */
 import { useFetch } from "app/Hooks";
 
@@ -71,7 +74,7 @@ const TopBar = (props: Props) => {
     /* OnLoad: fetch digital media versions */
     fetch.Fetch({
         params: {
-            handle: digitalMedia["@id"].replace(import.meta.env.VITE_DOI_URL, '')
+            handle: digitalMedia["@id"].replace(RetrieveEnvVariable('DOI_URL'), '')
         },
         Method: GetDigitalMediaVersions,
         Handler: (versions: number[]) => {
@@ -84,7 +87,7 @@ const TopBar = (props: Props) => {
      */
     const ViewDigitalMediaJSON = () => {
         window.open(`${window.location.protocol}//${window.location.hostname}${window.location.port ? ':' + window.location.port : ''}` +
-            `/api/v1/digital-media/${digitalMedia["@id"].replace(import.meta.env.VITE_DOI_URL, '')}`
+            `/api/v1/digital-media/${digitalMedia["@id"].replace(RetrieveEnvVariable('DOI_URL'), '')}`
         );
     };
 
@@ -102,7 +105,7 @@ const TopBar = (props: Props) => {
         const link = document.createElement("a");
         link.href = URL.createObjectURL(jsonFile);
 
-        link.download = `${digitalMedia["@id"].replace(import.meta.env.VITE_DOI_URL as string, '')}_${digitalMedia['ods:version']}.json`;
+        link.download = `${digitalMedia["@id"].replace(RetrieveEnvVariable('DOI_URL') as string, '')}_${digitalMedia['ods:version']}.json`;
 
         link.click();
     };
@@ -113,7 +116,7 @@ const TopBar = (props: Props) => {
             <Row>
                 <Col>
                     <h2 className="fs-pageTitle">
-                        {digitalMedia["dcterms:title"] ?? digitalMedia["@id"].replace(import.meta.env.VITE_DOI_URL, '')}
+                        {digitalMedia["dcterms:title"] ?? digitalMedia["@id"].replace(RetrieveEnvVariable('DOI_URL'), '')}
                     </h2>
                 </Col>
             </Row>
@@ -136,7 +139,7 @@ const TopBar = (props: Props) => {
                                         borderRadius: '999px'
                                     }}
                                     OnChange={(dropdownItem: DropdownItem) =>
-                                        navigate(`/dm/${digitalMedia["@id"].replace(import.meta.env.VITE_DOI_URL, '')}/${dropdownItem.value}`)}
+                                        navigate(`/dm/${digitalMedia["@id"].replace(RetrieveEnvVariable('DOI_URL'), '')}/${dropdownItem.value}`)}
                                 />
                             </Col>
                         }

diff --git a/...onents/digitalSpecimen/components/contentBlock/components/DigitalSpecimenDigitalMedia.tsx b/...onents/digitalSpecimen/components/contentBlock/components/DigitalSpecimenDigitalMedia.tsx
@@ -3,7 +3,7 @@ import { Row, Col, Card } from 'react-bootstrap';
 import { useNavigate } from 'react-router-dom';
 
 /* Import Utilities */
-import { MakeReadableString } from 'app/Utilities';
+import { MakeReadableString, RetrieveEnvVariable } from 'app/Utilities';
 
 /* Import Types */
 import { DigitalMedia } from 'app/types/DigitalMedia';
@@ -44,7 +44,7 @@ const DigitalSpecimenDigitalMedia = (props: Props) => {
                     <Button type="button"
                         variant="blank"
                         className="h-100 w-100 px-0 py-0 object-fit-contain"
-                        OnClick={() => navigate(`/dm/${digitalMedia['@id'].replace(import.meta.env.VITE_DOI_URL, '')}`)}
+                        OnClick={() => navigate(`/dm/${digitalMedia['@id'].replace(RetrieveEnvVariable('DOI_URL'), '')}`)}
                     >
                         <Image accessURI={digitalMedia['ac:accessURI']}
                             sizeOrientation="height"

diff --git a/src/components/digitalSpecimen/components/topBar/TopBar.tsx b/src/components/digitalSpecimen/components/topBar/TopBar.tsx
@@ -5,6 +5,7 @@ import { Row, Col } from "react-bootstrap";
 import { useNavigate } from "react-router-dom";
 
 /* Import Utilities */
+import { RetrieveEnvVariable } from "app/Utilities";
 import { GetSpecimenNameHTMLLabel } from "app/utilities/NomenclaturalUtilities";
 
 /* Import Hooks */
@@ -71,7 +72,7 @@ const TopBar = (props: Props) => {
     /* OnLoad: fetch digital specimen versions */
     fetch.Fetch({
         params: {
-            handle: digitalSpecimen['@id'].replace(import.meta.env.VITE_DOI_URL, '')
+            handle: digitalSpecimen['@id'].replace(RetrieveEnvVariable('DOI_URL'), '')
         },
         Method: GetDigitalSpecimenVersions,
         Handler: (versions: number[]) => {
@@ -84,7 +85,7 @@ const TopBar = (props: Props) => {
      */
     const ViewDigitalSpecimenJSON = () => {
         window.open(`${window.location.protocol}//${window.location.hostname}${window.location.port ? ':' + window.location.port : ''}` +
-            `/api/v1/digital-specimen/${digitalSpecimen['@id'].replace(import.meta.env.VITE_DOI_URL, '')}`
+            `/api/v1/digital-specimen/${digitalSpecimen['@id'].replace(RetrieveEnvVariable('DOI_URL'), '')}`
         );
     };
 
@@ -102,7 +103,7 @@ const TopBar = (props: Props) => {
         const link = document.createElement("a");
         link.href = URL.createObjectURL(jsonFile);
 
-        link.download = `${digitalSpecimen['@id'].replace(import.meta.env.VITE_DOI_URL as string, '')}_${digitalSpecimen['ods:version']}.json`;
+        link.download = `${digitalSpecimen['@id'].replace(RetrieveEnvVariable('DOI_URL') as string, '')}_${digitalSpecimen['ods:version']}.json`;
 
         link.click();
     };
@@ -150,7 +151,7 @@ const TopBar = (props: Props) => {
                                         borderRadius: '999px'
                                     }}
                                     OnChange={(dropdownItem: DropdownItem) =>
-                                        navigate(`/ds/${digitalSpecimen["@id"].replace(import.meta.env.VITE_DOI_URL, '')}/${dropdownItem.value}`)}
+                                        navigate(`/ds/${digitalSpecimen["@id"].replace(RetrieveEnvVariable('DOI_URL'), '')}/${dropdownItem.value}`)}
                                 />
                             </Col>
                         }

diff --git a/src/components/elements/annotationSidePanel/AnnotationSidePanel.tsx b/src/components/elements/annotationSidePanel/AnnotationSidePanel.tsx
@@ -3,6 +3,9 @@ import classNames from 'classnames';
 import { useState } from 'react';
 import { Row, Col } from 'react-bootstrap';
 
+/* Import Utilities */
+import { RetrieveEnvVariable } from 'app/Utilities';
+
 /* Import Hooks */
 import { useAppDispatch, useAppSelector, useFetch } from 'app/Hooks';
 
@@ -79,7 +82,7 @@ const AnnotationSidePanel = (props: Props) => {
     /* OnLoad: fetch annotations of super class with provided method */
     fetch.Fetch({
         params: {
-            handle: superClass?.['@id'].replace(import.meta.env.VITE_DOI_URL, '')
+            handle: superClass?.['@id'].replace(RetrieveEnvVariable('DOI_URL'), '')
         },
         triggers: [superClass, annotationWizardToggle],
         Method: GetAnnotations,
@@ -95,7 +98,7 @@ const AnnotationSidePanel = (props: Props) => {
         setLoading(true);
 
         const annotations = await GetAnnotations({
-            handle: superClass?.['@id'].replace(import.meta.env.VITE_DOI_URL, '')
+            handle: superClass?.['@id'].replace(RetrieveEnvVariable('DOI_URL'), '')
         });
 
         setAnnotations(annotations);