[Test PR] Implemented API Key For Federated APIs

portals/admin/src/main/webapp/site/public/locales/en.json

@@ -574,6 +574,7 @@
   "GatewayEnvironments.AddEditGWEnvironment.general.details.description.platform": "Provide display name and description of the Gateway Environment",
   "GatewayEnvironments.AddEditGWEnvironment.mode": "Gateway Mode",
   "GatewayEnvironments.AddEditGWEnvironment.mode.description": "Deployability or discoverabilty of APIs",
+  "GatewayEnvironments.AddEditGWEnvironment.save.failed": "Save failed",
   "GatewayEnvironments.AddEditGWEnvironment.type.description": "Key type supported by the Gateway Environment",
   "GatewayEnvironments.AddEditGWEnvironment.visibility.add.description": "Configure vhosts",
   "GatewayEnvironments.AddEditVhost.add.vhost.btn": "New VHost",
@@ -591,6 +592,15 @@
   "GatewayEnvironments.AddEditVhost.httpsPort": "HTTPS Port",
   "GatewayEnvironments.AddEditVhost.wsPort": "WS Port",
   "GatewayEnvironments.AddEditVhost.wssPort": "WSS Port",
+  "GatewayEnvironments.GatewayConfiguration.advancedSettings": "Advanced Settings",
+  "GatewayEnvironments.PlanMapping.action": "Action",
+  "GatewayEnvironments.PlanMapping.addValidationError": "Provide a local subscription policy and remote plan name.",
+  "GatewayEnvironments.PlanMapping.alreadyExists": "Plan Mapping already exists.",
+  "GatewayEnvironments.PlanMapping.loadingPolicies": "Loading local subscription plans...",
+  "GatewayEnvironments.PlanMapping.localPolicyRequired": "Select a local subscription policy.",
+  "GatewayEnvironments.PlanMapping.noCompatibleLocalPlans": "No local subscription plans match the supported API types of this gateway.",
+  "GatewayEnvironments.PlanMapping.noPoliciesLeft": "No local subscription policies left to map",
+  "GatewayEnvironments.PlanMapping.remotePlanRequired": "Enter a remote plan name.",
   "Gateways.AddEditGateway.back.to.gateways": "Back to Gateways",
   "Gateways.AddEditGateway.loading.gateway.details": "Loading gateway details...",
   "Gateways.AddEditGateway.loading.platform.gateway.details": "Loading platform gateway details...",

portals/admin/src/main/webapp/source/src/app/components/GatewayEnvironments/AddEditGWEnvironment.jsx

@@ -80,6 +80,7 @@
 } from './PlatformGatewayUtils';
 
 const PREFIX = 'AddEditGWEnvironment';
+const FEDERATED_GATEWAY_VALIDATION_ERROR_CODE = 900520;
 
 const classes = {
     pageContent: `${PREFIX}-pageContent`,
@@ -365,6 +366,23 @@
     return false;
 };
 
+const extractPlanMappingErrors = (responseBody) => {
+    const rowErrors = {};
+    if (!responseBody
+        || responseBody.code !== FEDERATED_GATEWAY_VALIDATION_ERROR_CODE
+        || !Array.isArray(responseBody.error)) {
+        return rowErrors;
+    }
+
+    responseBody.error.forEach((errorItem) => {
+        const fieldKey = errorItem?.message;
+        if (fieldKey && fieldKey.startsWith('plan_mapping.')) {
+            rowErrors[fieldKey] = errorItem.description || 'Invalid external plan assignment';
+        }
+    });
+    return rowErrors;
+};
+
 /**
  * Reducer
  * @param {JSON} state State
@@ -411,9 +429,11 @@
     const [invalidRoles, setInvalidRoles] = useState([]);
     const [roleValidity, setRoleValidity] = useState(true);
     const [gatewayConfigurations, setGatewayConfiguration] = useState([]);
+    const [selectedGatewaySupportedApiTypes, setSelectedGatewaySupportedApiTypes] = useState([]);
     const [supportedModes, setSupportedModes] = useState([]);
     const [validating, setValidating] = useState(false);
     const [saving, setSaving] = useState(false);
+    const [planMappingErrors, setPlanMappingErrors] = useState({});
     const { gatewayTypes } = settings;
     const gatewayVersions = useMemo(() => getPlatformGatewayVersions(settings), [settings]);
     const {
@@ -638,6 +658,10 @@
         }
     }, [permissions]);
 
+    useEffect(() => {
+        setPlanMappingErrors({});
+    }, [gatewayType]);
+
     useEffect(() => {
         if (!platformHeaderEditMode) {
             setPlatformDisplayNameDraft(
@@ -657,7 +681,7 @@
     ]);
 
     useEffect(() => {
-        const config = settings.gatewayConfiguration.filter(
+        const config = (settings.gatewayConfiguration || []).filter(
             (t) => t.type === gatewayType,
         )[0];
         if (
@@ -667,11 +691,13 @@
         ) {
             setGatewayConfiguration([]);
             setSupportedModes([]);
+            setSelectedGatewaySupportedApiTypes([]);
         } else {
             setGatewayConfiguration(config.configurations || []);
             setSupportedModes(config.supportedModes || []);
+            setSelectedGatewaySupportedApiTypes(config.supportedApiTypes || []);
         }
-    }, [gatewayType]);
+    }, [gatewayType, settings.gatewayConfiguration]);
 
     let permissionType = '';
     if (permissions) {
@@ -881,6 +907,13 @@
     };
 
     const setAdditionalProperties = (key, value) => {
+        if (key && planMappingErrors[key]) {
+            setPlanMappingErrors((prevErrors) => {
+                const updatedErrors = { ...prevErrors };
+                delete updatedErrors[key];
+                return updatedErrors;
+            });
+        }
         const clonedAdditionalProperties = cloneDeep(additionalProperties);
         if (value === undefined) {
             delete clonedAdditionalProperties[key];
@@ -1189,6 +1222,7 @@
 
         promiseAPICall
             .then((result) => {
+                setPlanMappingErrors({});
                 if (id) {
                     Alert.success(
                         `${name} ${intl.formatMessage({
@@ -1226,8 +1260,28 @@
             })
             .catch((error) => {
                 const { response } = error;
-                if (response.body) {
-                    Alert.error(response.body.description);
+                if (response?.body) {
+                    setPlanMappingErrors(extractPlanMappingErrors(response.body));
+                    Alert.error(
+                        response.body.description
+                        || error?.message
+                        || intl.formatMessage({
+                            id: 'GatewayEnvironments.AddEditGWEnvironment.save.failed',
+                            defaultMessage: 'Save failed',
+                        }),
+                    );
+                } else {
+                    setPlanMappingErrors({});
+                    const statusSuffix = response?.status
+                        ? ` (${response.status}${response?.statusText ? ` ${response.statusText}` : ''})`
+                        : '';
+                    Alert.error(
+                        error?.message
+                        || `${intl.formatMessage({
+                            id: 'GatewayEnvironments.AddEditGWEnvironment.save.failed',
+                            defaultMessage: 'Save failed',
+                        })}${statusSuffix}`,
+                    );
                 }
                 setSaving(false);
             });
@@ -2371,6 +2425,7 @@
                                                         gatewayConfigurations={
                                                             gatewayConfigurations
                                                         }
+                                                        supportedApiTypes={selectedGatewaySupportedApiTypes}
                                                         additionalProperties={cloneDeep(
                                                             additionalProperties,
                                                         )}
@@ -2383,6 +2438,9 @@
                                                         validating={
                                                             validating
                                                         }
+                                                        planMappingErrors={
+                                                            planMappingErrors
+                                                        }
                                                         gatewayId={cloneDeep(
                                                             id,
                                                         )}

portals/admin/src/main/webapp/source/src/app/components/GatewayEnvironments/GatewayConfiguration.jsx

@@ -1,4 +1,4 @@
-import React, { useEffect } from 'react';
+import React, { useEffect, useMemo } from 'react';
 import { styled } from '@mui/material/styles';
 import TextField from '@mui/material/TextField';
 import FormControlLabel from '@mui/material/FormControlLabel';
@@ -10,9 +10,15 @@
 import { FormattedMessage } from 'react-intl';
 import InputLabel from '@mui/material/InputLabel';
 import FormHelperText from '@mui/material/FormHelperText';
+import Accordion from '@mui/material/Accordion';
+import AccordionSummary from '@mui/material/AccordionSummary';
+import AccordionDetails from '@mui/material/AccordionDetails';
+import ExpandMoreIcon from '@mui/icons-material/ExpandMore';
 import CustomGatewayInputField from 'AppComponents/GatewayEnvironments/CustomGatewayInputField';
+import GatewayPlanMapping from './GatewayPlanMapping';
 
 const StyledSpan = styled('span')(({ theme }) => ({ color: theme.palette.error.dark }));
+const PLAN_MAPPING_CONFIG_TYPE = 'plan_mapping';
 
 // Styled wrapper to mimic TextField's outlined style
 const StyledFormControl = styled(FormControl)(({ theme }) => ({
@@ -42,9 +48,15 @@
 export default function GatewayConfiguration(props) {
     const {
         gatewayConfigurations, additionalProperties = {}, setAdditionalProperties = () => {}, gatewayId,
-        hasErrors, validating,
+        hasErrors, validating, planMappingErrors = {}, supportedApiTypes = [],
     } = props;
 
+    const mappingConfigurationNames = useMemo(() => {
+        return gatewayConfigurations
+            .filter((config) => config.type === PLAN_MAPPING_CONFIG_TYPE)
+            .map((config) => config.name);
+    }, [gatewayConfigurations]);
+
     const getAllNestedGatewayConfigPropertyNames = (connectorConfigurations, parentKey = '') => {
         const gatewayConfigPropertyNames = [];
 
@@ -167,7 +179,13 @@
 
         // Clear any properties in additionalProperties that are not in the current valid set
         Object.keys(additionalProperties).forEach((propName) => {
-            if (!currentValidProperties.includes(propName)) {
+            const isMappingProperty = mappingConfigurationNames.some((configName) => (
+                propName.startsWith(`${configName}.`)
+            ));
+            if (
+                !currentValidProperties.includes(propName)
+                && !isMappingProperty
+            ) {
                 setAdditionalProperties(propName, undefined);
             }
         });
@@ -207,7 +225,17 @@
                 });
             }
         }
-        if (gatewayConfiguration.type === 'input') {
+        if (gatewayConfiguration.type === PLAN_MAPPING_CONFIG_TYPE) {
+            return (
+                <GatewayPlanMapping
+                    gatewayConfiguration={gatewayConfiguration}
+                    supportedApiTypes={supportedApiTypes}
+                    additionalProperties={additionalProperties}
+                    setAdditionalProperties={setAdditionalProperties}
+                    planMappingErrors={planMappingErrors}
+                />
+            );
+        } else if (gatewayConfiguration.type === 'input') {
             if (gatewayConfiguration.mask) {
                 return (
                     <FormControl variant='outlined' fullWidth disabled={disabled}>
@@ -333,9 +361,29 @@
         });
     };
 
+    const regularConfigurations = gatewayConfigurations.filter(
+        (config) => config.type !== PLAN_MAPPING_CONFIG_TYPE,
+    );
+    const mappingConfigurations = gatewayConfigurations.filter(
+        (config) => config.type === PLAN_MAPPING_CONFIG_TYPE,
+    );
+
     return (
         <div>
-            {renderConnectorConfigurations(gatewayConfigurations)}
+            {renderConnectorConfigurations(regularConfigurations)}
+            {mappingConfigurations.length > 0 && (
+                <Accordion sx={{ mt: 2 }}>
+                    <AccordionSummary expandIcon={<ExpandMoreIcon />}>
+                        <FormattedMessage
+                            id='GatewayEnvironments.GatewayConfiguration.advancedSettings'
+                            defaultMessage='Advanced Settings'
+                        />
+                    </AccordionSummary>
+                    <AccordionDetails>
+                        {renderConnectorConfigurations(mappingConfigurations)}
+                    </AccordionDetails>
+                </Accordion>
+            )}
         </div>
     );
 }
@@ -350,4 +398,6 @@
     />,
     hasErrors: () => {},
     validating: false,
+    planMappingErrors: {},
+    supportedApiTypes: [],
 };