Merge pull request #8 from solace-iot-team/feature-server-misc

Feature server misc

Author: Ricardo Gomez-Ulmke

ReleaseNotes.md

@@ -2,10 +2,35 @@
 
 Solace Async API Management.
 
+## Version 0.0.28
+  * [API-M Admin & Developer Portal](https://github.com/solace-iot-team/async-apim/tree/main/apim-portal): 0.0.28
+  * [API-M Server OpenAPI](https://github.com/solace-iot-team/async-apim/blob/main/apim-server/server/common/api.yml): 0.0.14
+  * [API-M Server](https://github.com/solace-iot-team/async-apim/tree/main/apim-server): 0.0.8
+
+#### API-M Admin & Developer Portal
+**No Changes.**
+
+#### API-M Server OpenAPI
+
+**New:**
+- **error-id**
+  - `serverNotOperational`: returned for api calls when server is not ready
+
+#### API-M Server
+**New:**
+- **monitor**
+  - re-initializes server after failed healthcheck
+- **startup/initialization**
+  - exits server for unrecoverable errors, e.g.:
+    - mal-formed DB connection string
+    - DB authentication error
+  - log of DB server and client info
+  - bootstrap users
+
 ## Version 0.0.27
   * [API-M Admin & Developer Portal](https://github.com/solace-iot-team/async-apim/tree/main/apim-portal): 0.0.27
   * [API-M Server OpenAPI](https://github.com/solace-iot-team/async-apim/blob/main/apim-server/server/common/api.yml): 0.0.13
-  * [API-M Server](https://github.com/solace-iot-team/async-apim/tree/main/apim-server): 0.0.8
+  * [API-M Server](https://github.com/solace-iot-team/async-apim/tree/main/apim-server): 0.0.7
 
 #### API-M Admin & Developer Portal
 **New:**

apim-portal/package.json

@@ -1,6 +1,6 @@
 {
   "name": "async-apim-portal",
-  "version": "0.0.27",
+  "version": "0.0.28",
   "description": "Solace Async API Management Portal",
   "repository": {
     "type": "git",

apim-portal/src/components/APAbout/APDisplayAbout.tsx

@@ -222,6 +222,13 @@ export const APDisplayAbout: React.FC<IAPDisplayAboutProps> = (props: IAPDisplay
     );
   }
 
+  const renderDescription = () => {
+    return (
+      <div className="p-mb-4">
+        Concept Portal for Solace Async API Management.
+      </div>
+    );
+  }
   const renderComponent = (): JSX.Element => {
     return(
       <Dialog 
@@ -235,6 +242,7 @@ export const APDisplayAbout: React.FC<IAPDisplayAboutProps> = (props: IAPDisplay
         // resizable={true}
       >
         <div className="p-m-0">
+          {renderDescription()}
           {renderAdminPortalAbout()}
           {renderDeveloperPortalAbout()}
           {renderApimServerAbout()}

apim-server/.env

@@ -1,5 +1,11 @@
 APIM_SERVER_PORT=3003
 APIM_SERVER_MONGO_CONNECTION_STRING=mongodb://localhost:27019/?retryWrites=true&w=majority
+
+# wrong format of connection string
+# APIM_SERVER_MONGO_CONNECTION_STRING=mongodb:/localhost:27019/?retryWrites=true&w=majority
+# wrong user/pwd
+# APIM_SERVER_MONGO_CONNECTION_STRING=mongodb://uname:pwd@localhost:27019/?retryWrites=true&w=majority
+
 APIM_SERVER_MONGO_DB=solace-apim-server
 APIM_SERVER_OPENAPI_ENABLE_RESPONSE_VALIDATION=true
 APIM_SERVER_LOGGER_APP_ID=devel-apim-server
@@ -9,4 +15,4 @@ APIM_SERVER_REQUEST_SIZE_LIMIT=100kb
 APIM_SERVER_SECRET=mySecret
 APIM_SERVER_ROOT_USER=[email protected]
 APIM_SERVER_ROOT_USER_PWD=admin123!
-APIM_SERVER_DATA_PATH=./data
+APIM_SERVER_DATA_PATH=./data

apim-server/data/bootstrap/apsUsers/apsUserList.json

@@ -0,0 +1,62 @@
+[
+  {
+    "userId": "[email protected]",
+    "password": "[email protected]",
+    "roles": ["apiConsumer", "apiTeam", "loginAs", "organizationAdmin", "systemAdmin"],
+    "isActivated": true,
+    "profile": {
+      "first": "Master",
+      "last": "User",
+      "email": "[email protected]"
+    },
+    "memberOfOrganizations": ["apim-quickstart"]
+  },
+  {
+    "userId": "[email protected]",
+    "password": "[email protected]",
+    "roles": ["apiConsumer"],
+    "isActivated": true,
+    "profile": {
+      "first": "Api",
+      "last": "Consumer",
+      "email": "[email protected]"
+    },
+    "memberOfOrganizations": ["apim-quickstart"]
+  },
+  {
+    "userId": "[email protected]",
+    "password": "[email protected]",
+    "roles": ["apiTeam"],
+    "isActivated": true,
+    "profile": {
+      "first": "Api",
+      "last": "Team",
+      "email": "[email protected]"
+    },
+    "memberOfOrganizations": ["apim-quickstart"]
+  },
+  {
+    "userId": "[email protected]",
+    "password": "[email protected]",
+    "roles": ["organizationAdmin"],
+    "isActivated": true,
+    "profile": {
+      "first": "Org",
+      "last": "Admin",
+      "email": "[email protected]"
+    },
+    "memberOfOrganizations": ["apim-quickstart"]
+  },
+  {
+    "userId": "[email protected]",
+    "password": "[email protected]",
+    "roles": ["systemAdmin", "loginAs"],
+    "isActivated": true,
+    "profile": {
+      "first": "System",
+      "last": "Admin",
+      "email": "[email protected]"
+    },
+    "memberOfOrganizations": ["apim-quickstart"]
+  }
+]

apim-server/devel/README.md

@@ -12,6 +12,14 @@ brew install node@16
 brew unlink node
 brew link node@14
 ````
+## Build & Run
+````bash
+npm install
+npm run build
+npm start
+# or
+npm run start:pretty
+````
 
 ## Development Build & Run
 ### Devel Build
@@ -82,10 +90,8 @@ vi test/source.env.sh
 # adjust the settings for openapi & inline tests
 ````
 ### Run All Tests
-- starts server
-- runs all tests
-
 ````bash
+npm run dev:build
 npm test
 # with pretty print server output:
 npm run test:pretty

apim-server/package-lock.json

@@ -1,9 +1,10 @@
 {
   "name": "@solace-iot-team/apim-server",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "description": "Async API Management Server",
   "scripts": {
     "start": "node dist/server/index.js",
+    "start:pretty": "node dist/server/index.js | pino-pretty",
     "build": "tsc && ts-node build.ts",
     "dev:build:types": "ts-node dev-build-types.ts",
     "dev:build": "ts-node dev-build-types.ts && ts-node dev-build.ts",
@@ -43,7 +44,7 @@
     "dotenv": "^10.0.0",
     "express": "^4.17.1",
     "express-openapi-validator": "^4.12.11",
-    "express-requests-logger": "^3.0.4",
+    "express-requests-logger": "^3.0.3",
     "form-data": "^4.0.0",
     "mongodb": "^4.1.0",
     "node-fetch": "^2.6.1",

apim-server/package.json

@@ -10,6 +10,7 @@ export class ApsUsersController {
   public static all = (req: Request, res: Response, next: NextFunction): void => {
     APSUsersService.all(ApiQueryHelper.getPagingInfoFromQuery(req.query), ApiQueryHelper.getSortInfoFromQuery(req.query), ApiQueryHelper.getSearchInfoFromQuery(req.query))
     .then( (r: TAPSListUserResponse) => {
+      // res.status(200).type('application/json').json(r);
       res.status(200).json(r);
     })
     .catch( (e) => {

apim-server/server/api/controllers/apsUsers/ApsUsersController.ts

@@ -26,25 +26,24 @@ export default function errorHandler(
     if(err instanceof MongoError) internalServerError = new ApiInternalServerErrorFromMongoError(err, logName);
     else if(err instanceof OpenApiValidatorHttpError) {
       internalServerError = new ApiServerErrorFromOpenApiRequestValidatorError(logName, err, req.body, ServerLogger.getRequestInfo(req));
-    }
-    else internalServerError = new ApiInternalServerErrorFromError(err, logName);
+    } else internalServerError = new ApiInternalServerErrorFromError(err, logName);
     serverErrorHandler(internalServerError, req, res, next);
   } 
 }
 
 const serverErrorHandler = (apiServerError: ApiServerError, _req: Request, res: Response, _next: NextFunction) => {
   const funcName = 'serverErrorHandler';
   const logName = `${componentName}.${funcName}()`;
-  const logEntry: TServerLogEntry = ServerLogger.createLogEntry(logName, { code: EServerStatusCodes.Api_Service_Error, message: apiServerError.message, details: apiServerError.toObject() });
+  const logEntry: TServerLogEntry = ServerLogger.createLogEntry(logName, { code: EServerStatusCodes.API_SERVICE_ERROR, message: apiServerError.message, details: apiServerError.toObject() });
 
   if(apiServerError instanceof ApiInternalServerError) 
-    ServerLogger.error(logEntry);  
+    ServerLogger.warn(logEntry);  
   else 
     ServerLogger.debug(logEntry);
 
   for (const responseHeader of apiServerError.getAPSErrorHeaders()) {
     res.header(responseHeader.headerField, responseHeader.headerValue);
   }
-  res.status(apiServerError.apiStatusCode).json(apiServerError.toAPSError());
+  res.status(apiServerError.apiStatusCode).json(apiServerError.toAPSError()); 
 }
 

apim-server/server/api/controllers/examples/controller.ts

@@ -0,0 +1,20 @@
+import { Request, Response, NextFunction } from 'express';
+import { ApiInternalServerErrorNotOperational } from '../../common/ServerError';
+import { EServerStatusCodes, ServerLogger } from '../../common/ServerLogger';
+import ServerStatus from '../../common/ServerStatus';
+
+const componentName = "middleware";
+
+export default function verifyServerStatus(
+  _req: Request,
+  _res: Response,
+  next: NextFunction
+): void {
+  const funcName = 'verifyServerStatus';
+  const logName = `${componentName}.${funcName}()`;
+  if(!ServerStatus.getStatus().isReady) {
+    ServerLogger.warn(ServerLogger.createLogEntry(logName, { code: EServerStatusCodes.API_SERVICE_ERROR, message: 'server status', details: ServerStatus.getStatus() }));
+    throw new ApiInternalServerErrorNotOperational(logName);
+  }
+  next();
+}