Merge pull request #1677 from ral-facilities/add-ims-job-scheduler-api-url-to-config-#1676

add the ims-job-scheduler-api url to config #1676

Author: joshdimanteto

Dockerfile.prod

@@ -68,6 +68,7 @@ USER www-data
 
 ENV IMS_API_URL="/inventory-management-system-api"
 ENV OS_API_URL="/object-storage-api"
+ENV IMS_JS_API_URL="/ims-job-scheduler-api"
 ENV PLUGIN_HOST="/inventory-management-system"
 ENV MAX_ATTACHMENT_SIZE_BYTES=104857600
 ENV ATTACHMENT_ALLOWED_FILE_EXTENSIONS='[".csv", ".doc", ".docx", ".pdf", ".rtf", ".txt", ".xls", ".xlsx"]'

docker/docker-entrypoint.sh

@@ -7,6 +7,7 @@ TEMPFILE="$(mktemp)"
 jq \
   --arg imsApiUrl "$IMS_API_URL" \
   --arg osApiUrl "$OS_API_URL" \
+  --arg imsJsApiUrl "$IMS_JS_API_URL" \
   --argjson maxAttachmentSizeBytes $MAX_ATTACHMENT_SIZE_BYTES \
   --argjson attachmentAllowedFileExtensions "$ATTACHMENT_ALLOWED_FILE_EXTENSIONS" \
   --argjson imageAllowedFileExtensions "$IMAGE_ALLOWED_FILE_EXTENSIONS" \

public/inventory-management-system-settings.example.json

@@ -1,6 +1,7 @@
 {
   "imsApiUrl": "",
   "osApiUrl": "",
+  "imsJsApiUrl": "",
   "maxAttachmentSizeBytes": 104857600,
   "attachmentAllowedFileExtensions": [
     ".csv",

server/e2e-settings-with-api.json

@@ -1,6 +1,7 @@
 {
   "imsApiUrl": "http://127.0.0.1:8000",
   "osApiUrl": "http://127.0.0.1:8002",
+  "imsJsApiUrl": "",
   "maxAttachmentSizeBytes": 104857600,
   "attachmentAllowedFileExtensions": [
     ".csv",

server/e2e-settings.json

@@ -1,6 +1,7 @@
 {
   "imsApiUrl": "",
   "osApiUrl": "",
+  "imsJsApiUrl": "",
   "maxAttachmentSizeBytes": 104857600,
   "attachmentAllowedFileExtensions": [
     ".csv",

src/api/api.tsx

@@ -145,3 +145,7 @@ export const imsApi = createAuthenticatedClient({
 export const storageApi = createAuthenticatedClient({
   getURL: (settings) => settings.osApiUrl,
 });
+
+export const jobSchedulerApi = createAuthenticatedClient({
+  getURL: (settings) => settings.imsJsApiUrl,
+});

src/main.tsx

@@ -127,6 +127,11 @@ export const fetchSettings =
           throw new Error('osApiUrl is undefined in settings');
         }
 
+        // Ensure the imsJsApiUrl name exists.
+        if (!('imsJsApiUrl' in settings)) {
+          throw new Error('imsJsApiUrl is undefined in settings');
+        }
+
         // Ensure the maxAttachmentSizeBytes value exists.
         if (!('maxAttachmentSizeBytes' in settings)) {
           throw new Error('maxAttachmentSizeBytes is undefined in settings');
@@ -210,7 +215,8 @@ async function prepare() {
   if (
     import.meta.env.VITE_INCLUDE_MSW === 'true' ||
     settingsResult?.imsApiUrl === '' ||
-    settingsResult?.osApiUrl === ''
+    settingsResult?.osApiUrl === '' ||
+    settingsResult?.imsJsApiUrl === ''
   ) {
     // Need to use require instead of import as import breaks when loaded in SG
     const { worker } = await import('./mocks/browser');

src/settings.ts

@@ -3,6 +3,7 @@ import { PluginRoute } from './state/actions/actions.types';
 export interface InventoryManagementSystemSettings {
   imsApiUrl: string;
   osApiUrl: string;
+  imsJsApiUrl: string;
   maxAttachmentSizeBytes: number;
   attachmentAllowedFileExtensions: string[];
   imageAllowedFileExtensions: string[];

src/state/slices/configSlice.test.tsx

@@ -6,6 +6,7 @@ describe('configSlice', () => {
   const initialSettings: InventoryManagementSystemSettings = {
     imsApiUrl: '',
     osApiUrl: '',
+    imsJsApiUrl: '',
     maxAttachmentSizeBytes: 104857600,
     attachmentAllowedFileExtensions: [
       '.csv',

src/state/slices/configSlice.tsx

@@ -13,6 +13,7 @@ export interface ConfigState {
 const initialSettings: InventoryManagementSystemSettings = {
   imsApiUrl: '',
   osApiUrl: '',
+  imsJsApiUrl: '',
   maxAttachmentSizeBytes: 104857600,
   attachmentAllowedFileExtensions: [
     '.csv',