Merge pull request #49 from solace-iot-team/feat-uc-3

Feat uc 3

Author: ricardojosegomezulmke

.github/workflows/integration-test.yml

@@ -18,8 +18,8 @@ on:
     branches:
       - main
 env:
-  # DEBUG_FLAG: ${{ true }}
-  DEBUG_FLAG: ${{ false }}
+  DEBUG_FLAG: ${{ true }}
+  # DEBUG_FLAG: ${{ false }}
   APIM_SERVER_DIR: "apim-server"
   APIM_SERVER_TEST_LOGS_DIR: "apim-server/test/logs"
   APIM_SERVER_TEST_LOGS_OUTPUT_NAME: "apim-server-test-logs"
@@ -68,6 +68,7 @@ jobs:
           echo "node --version: "; node --version
           echo "npm --version: "; npm --version
           echo "docker --version"; docker --version
+          echo "docker-compose --version"; docker-compose --version
 
       - name: "server: npm install"
         run: |

README.md

@@ -10,8 +10,6 @@
 
 # Solace Async API Management
 
-> :warning: UNDER CONSTRUCTION
-
 Solace Async API Management.
 
 

ReleaseNotes.md

@@ -2,6 +2,54 @@
 
 Solace Async API Management.
 
+## Version 0.3.6
+  * [API-M Admin & Developer Portal](https://github.com/solace-iot-team/async-apim/tree/main/apim-portal): 0.3.6
+  * [API-M Server OpenAPI](https://github.com/solace-iot-team/async-apim/blob/main/apim-server/server/common/api.yml): 0.3.2
+  * [API-M Server](https://github.com/solace-iot-team/async-apim/tree/main/apim-server): 0.3.3
+  * [API-M Connector OpenAPI](https://github.com/solace-iot-team/platform-api): 0.11.1
+
+**New Features:**
+- **Download API asset zip file**
+  - asset zip file download added to:
+    - apis, api products, apps
+- **Organization Settings**
+  - option to configure max number of environments per api product
+  - display of asset version increment strategy: bump_patch (edit is disabled)
+
+**Enhancements:**
+- **API Products: Policies: Guaranteed Messaging**
+  - if disabled, deletes previous GM settings, mqtt bindings in API spec are set to qos=0 (drawback: previous settings are lost)
+- **Apps: Connection Endpoints**
+  - for mqtt: added note: clientId can be found in Async API Spec (servers section)
+
+**Changes:**
+- **APIs**
+  - validation of Async API change to:
+    - portal validates: title exists, version in semver format
+    - connector validates everything else (including url $refs)
+- **API Products: new version number**
+  - increment patch version on edit instead of minor version
+
+**Fixes:**
+- **Organization Status**
+  - restrict access to organization resources if organization connectivity is down (e.g. expired token)
+- **Active Connector**
+  - fixed bug updating cache when updating active connector object
+
+**APIM Server:**
+- **Connectors:Bootstrap**
+  - fixed error handling and logging for non-existent connector bootstrap file & non-existent active connector
+- **Active Connector:Healthcheck**
+  - improved error handling when connector is not healthy:
+    - error: ConnectorProxyError, carries details of original error
+    - logged and sent back to caller
+  - added periodic healthcheck of active connector
+    - if connector not healthy, log warning,  code: "ACTIVE_CONNECTOR_TEST_ERROR"
+
+**Releases:**
+- **APIM Portal**
+  - changed to unprivileged nginx docker image: nginxinc/nginx-unprivileged:1.23.0
+
 ## Version 0.3.5
   * [API-M Admin & Developer Portal](https://github.com/solace-iot-team/async-apim/tree/main/apim-portal): 0.3.5
   * [API-M Server OpenAPI](https://github.com/solace-iot-team/async-apim/blob/main/apim-server/server/common/api.yml): 0.3.1

apim-portal/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "async-apim-portal",
-  "version": "0.3.5",
+  "version": "0.3.6",
   "description": "Solace Async API Management Portal",
   "repository": {
     "type": "git",
@@ -23,9 +23,8 @@
     "url": "https://github.com/solace-iot-team/async-apim/issues"
   },
   "dependencies": {
-    "@asyncapi/parser": "^1.15.1",
     "@asyncapi/react-component": "1.0.0-next.33",
-    "@solace-iot-team/apim-connector-openapi-browser": "^0.7.19",
+    "@solace-iot-team/apim-connector-openapi-browser": "^0.11.1",
     "async-mutex": "^0.3.2",
     "base-64": "^1.0.0",
     "dompurify": "^2.3.8",

apim-portal/package.json

@@ -7,9 +7,11 @@ import { PanelMenu } from 'primereact/panelmenu';
 import { AuthContext } from "../../../components/AuthContextProvider/AuthContextProvider";
 import { UserContext } from "../../../components/APContextProviders/APUserContextProvider";
 import { APHealthCheckSummaryContext } from "../../../components/APHealthCheckSummaryContextProvider";
+import { OrganizationContext } from "../../../components/APContextProviders/APOrganizationContextProvider";
 import { EAPHealthCheckSuccess } from "../../../utils/APHealthCheck";
 import { AuthHelper } from "../../../auth/AuthHelper";
 import { EUIAdminPortalResourcePaths, EUICombinedResourcePaths, EUIDeveloperPortalResourcePaths } from '../../../utils/Globals';
+import { EAPOrganizationConfigStatus } from "../../../displayServices/APOrganizationsDisplayService/APOrganizationsDisplayService";
 
 import '../../../components/APComponents.css';
 
@@ -24,6 +26,7 @@ export const AdminPortalSideBar: React.FC<IAdminPortalSideBarProps> = (props: IA
   const [authContext] = React.useContext(AuthContext);
   const [userContext] = React.useContext(UserContext);
   const [healthCheckSummaryContext] = React.useContext(APHealthCheckSummaryContext);
+  const [organizationContext] = React.useContext(OrganizationContext);
 
   const navigateTo = (path: string): void => { history.push(path); }
 
@@ -35,7 +38,8 @@ export const AdminPortalSideBar: React.FC<IAdminPortalSideBarProps> = (props: IA
   const isDisabledWithoutOrg = (resourcePath: EUICombinedResourcePaths): boolean => {
     return ( 
       !AuthHelper.isAuthorizedToAccessResource(authContext.authorizedResourcePathsAsString, resourcePath) ||
-      !userContext.runtimeSettings.currentOrganizationEntityId
+      !userContext.runtimeSettings.currentOrganizationEntityId ||
+      organizationContext.apOrganizationConfigStatus !== EAPOrganizationConfigStatus.OPERATIONAL
     );
   }
   const isDisabledWithConnectorUnavailable = (isDisabledFunc: (resourcePath: EUICombinedResourcePaths) => boolean, resourcePath: EUICombinedResourcePaths): boolean => {

apim-portal/src/admin-portal/components/AdminPortalSideBar/AdminPortalSideBar.tsx

@@ -175,13 +175,20 @@ export const ListMaintainApiProducts: React.FC<IListMaintainApiProductsProps> =
     return row.apLifecycleStageInfo.stage;
   }
   const renderManagedObjectDataTable = () => {
-    const dataKey = APAdminPortalApiProductsDisplayService.nameOf_ApEntityId('id');
-    const sortField = APAdminPortalApiProductsDisplayService.nameOf_ApEntityId('displayName');
-    const filterField = APAdminPortalApiProductsDisplayService.nameOf<TAPAdminPortalApiProductDisplay>('apSearchContent');
-    // const approvalTypeSortField = APAdminPortalApiProductsDisplayService.nameOf<TAPAdminPortalApiProductDisplay>('apApprovalType');
-    const accessLevelSortField = APAdminPortalApiProductsDisplayService.nameOf<TAPAdminPortalApiProductDisplay>('apAccessLevel');    
-    const stateSortField = APAdminPortalApiProductsDisplayService.nameOf_ApLifecycleStageInfo('stage');
-    const businessGroupSortField = APAdminPortalApiProductsDisplayService.nameOf_ApBusinessGroupInfo_ApOwningBusinessGroupEntityId('displayName');
+    // const dataKey = APAdminPortalApiProductsDisplayService.nameOf_ApEntityId('id');
+    // const sortField = APAdminPortalApiProductsDisplayService.nameOf_ApEntityId('displayName');
+    // const filterField = APAdminPortalApiProductsDisplayService.nameOf<TAPAdminPortalApiProductDisplay>('apSearchContent');
+    // // const approvalTypeSortField = APAdminPortalApiProductsDisplayService.nameOf<TAPAdminPortalApiProductDisplay>('apApprovalType');
+    // const accessLevelSortField = APAdminPortalApiProductsDisplayService.nameOf<TAPAdminPortalApiProductDisplay>('apAccessLevel');    
+    // const stateSortField = APAdminPortalApiProductsDisplayService.nameOf_ApLifecycleStageInfo('stage');
+    // const businessGroupSortField = APAdminPortalApiProductsDisplayService.nameOf_ApBusinessGroupInfo_ApOwningBusinessGroupEntityId('displayName');
+    const dataKey = APDisplayUtils.nameOf<TAPAdminPortalApiProductDisplay>('apEntityId.id');
+    const sortField = APDisplayUtils.nameOf<TAPAdminPortalApiProductDisplay>('apEntityId.displayName');
+    const filterField = APDisplayUtils.nameOf<TAPAdminPortalApiProductDisplay>('apSearchContent');
+    const accessLevelSortField = APDisplayUtils.nameOf<TAPAdminPortalApiProductDisplay>('apAccessLevel');
+    const stateSortField = APDisplayUtils.nameOf<TAPAdminPortalApiProductDisplay>('apLifecycleStageInfo.stage');
+    const businessGroupSortField = APDisplayUtils.nameOf<TAPAdminPortalApiProductDisplay>('apBusinessGroupInfo.apOwningBusinessGroupEntityId.displayName');
+
     return (
       <div className="card">
         <DataTable

apim-portal/src/admin-portal/components/MaintainApiProducts/ListMaintainApiProducts.tsx

@@ -149,12 +149,19 @@ export const ListMaintainApis: React.FC<IListMaintainApisProps> = (props: IListM
     return(<>{mo.apApiProductReferenceEntityIdList.length}</>);
   }
   const renderManagedObjectDataTable = () => {
-    const dataKey = APApisDisplayService.nameOf_ApEntityId('id');
-    const sortField = APApisDisplayService.nameOf_ApEntityId('displayName');
-    const filterField = APApisDisplayService.nameOf<IAPApiDisplay>('apSearchContent');
-    const stateSortField = APApisDisplayService.nameOf_ApLifecycleStageInfo('stage');
-    const sourceSortField = APApisDisplayService.nameOf_ConnectorApiInfo('source');
-    const businessGroupSortField = APApisDisplayService.nameOf_ApBusinessGroupInfo_ApOwningBusinessGroupEntityId('displayName');
+    // const dataKey = APApisDisplayService.nameOf_ApEntityId('id');
+    // const sortField = APApisDisplayService.nameOf_ApEntityId('displayName');
+    // const filterField = APApisDisplayService.nameOf<IAPApiDisplay>('apSearchContent');
+    // const stateSortField = APApisDisplayService.nameOf_ApLifecycleStageInfo('stage');
+    // const sourceSortField = APApisDisplayService.nameOf_ConnectorApiInfo('source');
+    // const businessGroupSortField = APApisDisplayService.nameOf_ApBusinessGroupInfo_ApOwningBusinessGroupEntityId('displayName');
+    const dataKey = APDisplayUtils.nameOf<IAPApiDisplay>('apEntityId.id');
+    const sortField = APDisplayUtils.nameOf<IAPApiDisplay>('apEntityId.displayName');
+    const filterField = APDisplayUtils.nameOf<IAPApiDisplay>('apSearchContent');
+    const stateSortField = APDisplayUtils.nameOf<IAPApiDisplay>('apLifecycleStageInfo.stage');
+    const sourceSortField = APDisplayUtils.nameOf<IAPApiDisplay>('connectorApiInfo.source');
+    const businessGroupSortField = APDisplayUtils.nameOf<IAPApiDisplay>('apBusinessGroupInfo.apOwningBusinessGroupEntityId.displayName');
+
     return (
       <div className="card">
         <DataTable

apim-portal/src/admin-portal/components/MaintainApis/ListMaintainApis.tsx

@@ -73,7 +73,9 @@ export const DisplayAdminPortalApiProduct: React.FC<IDisplayAdminPortalApiProduc
 
   const [organizationContext] = React.useContext(OrganizationContext);
   const IsSingleApiSelection: boolean = organizationContext.apMaxNumApis_Per_ApiProduct === 1;
+  const IsSingleEnvSelection: boolean = organizationContext.apMaxNumEnvs_Per_ApiProduct === 1;
   const ApiTabHeader: string = IsSingleApiSelection ? "API" : "API(s)";
+  const EnvTabHeader: string = IsSingleEnvSelection ? "Environment" : "Environment(s)";
   const viewAppReferenceHistory = useHistory<TAPPageNavigationInfo>();
   const ReferencedByTabIndex: number = 5;
 
@@ -134,6 +136,40 @@ export const DisplayAdminPortalApiProduct: React.FC<IDisplayAdminPortalApiProduc
     return callState;
   }
 
+  const apiGetApiZipContents = async(apiId: string, apiDisplayName: string): Promise<Blob | undefined> => {
+    const funcName = 'apiGetApiZipContents';
+    const logName = `${ComponentName}.${funcName}()`;
+    if(managedObject === undefined) throw new Error(`${logName}: managedObject === undefined`);
+    let callState: TApiCallState = ApiCallState.getInitialCallState(E_CALL_STATE_ACTIONS.API_GET_API_SPEC, `retrieve zip contents for api: ${apiDisplayName}`);
+    let zipContents: Blob | undefined = undefined;
+    try { 
+      switch(props.scope) {
+        case E_DISPLAY_ADMIN_PORTAL_API_PRODUCT_SCOPE.VIEW_EXISTING:
+        case E_DISPLAY_ADMIN_PORTAL_API_PRODUCT_SCOPE.VIEW_REFEREMCED_BY:
+        case E_DISPLAY_ADMIN_PORTAL_API_PRODUCT_SCOPE.VIEW_EXISTING_MAINTAIN:
+          zipContents = await APApiSpecsDisplayService.apiGet_ApiProduct_ApiSpec_ZipContents({
+            organizationId: props.organizationId, 
+            apiProductId: managedObject.apEntityId.id,
+            apiEntityId: { id: apiId, displayName: apiDisplayName }
+          });
+          break;
+        case E_DISPLAY_ADMIN_PORTAL_API_PRODUCT_SCOPE.REVIEW_AND_CREATE:
+          zipContents = await APApiSpecsDisplayService.apiGet_Api_ApiSpec_ZipContents({ 
+            organizationId: props.organizationId,
+            apiEntityId: { id: apiId, displayName: apiDisplayName }
+          });
+          break;
+        default:
+          Globals.assertNever(logName, props.scope);
+      }
+    } catch(e) {
+      APClientConnectorOpenApi.logError(logName, e);
+      callState = ApiCallState.addErrorToApiCallState(e, callState);
+    }
+    setApiCallStatus(callState);
+    return zipContents;
+  }
+
   const doInitialize = async () => {
     setManagedObject(props.apAdminPortalApiProductDisplay);
   }
@@ -182,6 +218,16 @@ export const DisplayAdminPortalApiProduct: React.FC<IDisplayAdminPortalApiProduc
     props.onLoadingChange(false);
   }
 
+  const doFetchZipContents = async(): Promise<Blob | undefined> => {
+    const funcName = 'doFetchZipContents';
+    const logName = `${ComponentName}.${funcName}()`;
+    if(showApiId === undefined) throw new Error(`${logName}: showApiId === undefined`);
+    props.onLoadingChange(true);
+    const zipContents: Blob | undefined = await apiGetApiZipContents(showApiId, showApiId);
+    props.onLoadingChange(false);
+    if(zipContents !== undefined) return zipContents;
+  }
+
   React.useEffect(() => {
     if(showApiId === undefined) return;
     doFetchApiSpec(showApiId);
@@ -417,6 +463,7 @@ export const DisplayAdminPortalApiProduct: React.FC<IDisplayAdminPortalApiProduc
                 schemaId={showApiId} 
                 onDownloadSuccess={props.onSuccess}
                 onDownloadError={props.onError}
+                fetchZipContentsFunc={doFetchZipContents}
               />
             </React.Fragment>  
           }
@@ -436,9 +483,9 @@ export const DisplayAdminPortalApiProduct: React.FC<IDisplayAdminPortalApiProduc
       </TabPanel>
     );
     tabPanels.push(
-      <TabPanel header='Environments'>
+      <TabPanel header={EnvTabHeader}>
         <React.Fragment>
-          <div className="p-text-bold">Environments:</div>
+          <div className="p-text-bold">{EnvTabHeader}:</div>
           <div className="p-ml-2">
             {APEntityIdsService.create_SortedDisplayNameList_From_ApDisplayObjectList(managedObject.apEnvironmentDisplayList).join(', ')}
           </div>

apim-portal/src/admin-portal/components/ManageApiProducts/DisplayApiProduct.tsx

@@ -63,14 +63,17 @@ export const EditAccessAndState: React.FC<IEditAccessAndStateProps> = (props: IE
     const logName = `${ComponentName}.${funcName}()`;
     let callState: TApiCallState = ApiCallState.getInitialCallState(E_CALL_STATE_ACTIONS.API_UPDATE_API_PRODUCT, `update api product: ${mo.apEntityId.displayName}`);
     try {
-      await APAdminPortalApiProductsDisplayService.apiUpdate_ApApiProductDisplay({
+      await APAdminPortalApiProductsDisplayService.apiUpdate_ApApiProductDisplay_AccessAndState({
         organizationId: props.organizationId,
-        apApiProductDisplay: APAdminPortalApiProductsDisplayService.set_ApApiProductDisplay_AccessAndState({
-          apApiProductDisplay: props.apAdminPortalApiProductDisplay,
-          apApiProductDisplay_AccessAndState: mo
-        }),
         userId: userContext.apLoginUserDisplay.apEntityId.id,
+        apApiProductDisplay: props.apAdminPortalApiProductDisplay,
+        apApiProductDisplay_AccessAndState: mo
       });  
+    // TODO: set the new values - required?
+    // apApiProductDisplay: APAdminPortalApiProductsDisplayService.set_ApApiProductDisplay_AccessAndState({
+    //   apApiProductDisplay: props.apAdminPortalApiProductDisplay,
+    //   apApiProductDisplay_AccessAndState: mo
+    // }),
     } catch(e: any) {
       APSClientOpenApi.logError(logName, e);
       callState = ApiCallState.addErrorToApiCallState(e, callState);