add http test server

.vscode/launch.json

@@ -41,6 +41,20 @@
             "restart": true,
             "autoAttachChildProcesses": true
         },
+        {
+            "address": "127.0.0.1",
+            "localRoot": "${workspaceFolder}/TestServer",
+            "name": "Test Server: Debug with Docker",
+            "port": 9141,
+            "remoteRoot": "/usr/src/app",
+            "request": "attach",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "type": "node",
+            "restart": true,
+            "autoAttachChildProcesses": true
+        },
         {
             "address": "127.0.0.1",
             "localRoot": "${workspaceFolder}/Probe",

CommonServer/Infrastructure/LocalCache.ts

@@ -21,6 +21,15 @@ export default abstract class LocalCache {
         this.cache[namespace + '.' + key] = value;
     }
 
+
+    public static setNumber(
+        namespace: string,
+        key: string,
+        value: number
+    ): void {
+        this.cache[namespace + '.' + key] = value;
+    }
+
     public static setModel(
         namespace: string,
         key: string,
@@ -44,6 +53,10 @@ export default abstract class LocalCache {
         return this.cache[namespace + '.' + key] as string;
     }
 
+    public static getNumber(namespace: string, key: string): number {
+        return this.cache[namespace + '.' + key] as number;
+    }
+
     public static async getOrSetString(
         namespace: string,
         key: string,

CommonServer/Utils/Response.ts

@@ -69,6 +69,27 @@ export default class Response {
         return this.logResponse(req, res, undefined);
     }
 
+    public static sendCustomResponse(
+        req: ExpressRequest,
+        res: ExpressResponse,
+        statusCode: number,
+        body: JSONObject | string,
+
+    ): void {
+        const oneUptimeRequest: OneUptimeRequest = req as OneUptimeRequest;
+        const oneUptimeResponse: OneUptimeResponse = res as OneUptimeResponse;
+
+        oneUptimeResponse.set(
+            'ExpressRequest-Id',
+            oneUptimeRequest.id.toString()
+        );
+        oneUptimeResponse.set('Pod-Id', process.env['POD_NAME']);
+
+        oneUptimeResponse.status(statusCode).send(body);
+
+        return this.logResponse(req, res, undefined);
+    }
+
     public static async sendFileResponse(
         req: ExpressRequest | ExpressRequest,
         res: ExpressResponse,

TestServer/.dockerignore

@@ -0,0 +1,56 @@
+.git
+
+node_modules
+# See https://help.github.com/ignore-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+node_modules
+
+.idea
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+
+env.js
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+yarn.lock
+Untitled-1
+*.local.sh
+*.local.yaml
+run
+stop
+
+nohup.out*
+
+encrypted-credentials.tar
+encrypted-credentials/
+
+_README.md
+
+# Important Add production values to gitignore.
+values-saas-production.yaml
+kubernetes/values-saas-production.yaml
+
+/private
+
+/tls_cert.pem
+/tls_key.pem
+/keys
+
+temp_readme.md
+
+tests/coverage
+
+settings.json
+
+GoSDK/tester/

TestServer/.env.tpl

@@ -0,0 +1 @@
+PORT={{ .Env.TEST_SERVER_PORT }}

TestServer/.gitattributes

@@ -0,0 +1 @@
+*.js text eol=lf

TestServer/.gitignore

@@ -0,0 +1,16 @@
+# See https://help.github.com/ignore-files/ for more about ignoring files.
+
+# dependencies
+#/backend/node_modules
+/kubernetes
+/node_modules
+.idea
+
+# misc
+.DS_Store
+
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+yarn.lock

TestServer/.gitignore copy

@@ -0,0 +1,29 @@
+# See https://help.github.com/ignore-files/ for more about ignoring files.
+
+# dependencies
+#/backend/node_modules
+/kubernetes
+/node_modules
+.idea
+
+# misc
+.DS_Store
+
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+yarn.lock
+
+**/*/paymentService.test.js
+apiTest.rest
+
+application_security_dir
+container_security_dir
+
+# coverage
+/coverage
+/.nyc_output
+
+/greenlock.d/config.json
+/greenlock.d/config.json.bak

TestServer/API/Main.ts

@@ -0,0 +1,39 @@
+import LocalCache from 'CommonServer/Infrastructure/LocalCache';
+import Express, {
+    ExpressRequest,
+    ExpressResponse,
+    ExpressRouter,
+    NextFunction,
+} from 'CommonServer/Utils/Express';
+import Response from 'CommonServer/Utils/Response';
+import Sleep from 'Common/Types/Sleep';
+
+const router: ExpressRouter = Express.getRouter();
+
+router.get(
+    '/',
+    async (
+        req: ExpressRequest,
+        res: ExpressResponse,
+        next: NextFunction
+    ): Promise<void> => {
+        try {
+
+            const responseCode: number | undefined =LocalCache.getNumber('TestServer', 'responseCode') || 200;
+            const responseTime: number | undefined =LocalCache.getNumber('TestServer', 'responseTime') || 0;
+            const responseBody: string | undefined =LocalCache.getString('TestServer', 'responseBody') || '';
+
+            if(responseTime > 0){
+                await Sleep.sleep(responseTime);
+            }
+
+            // middleware marks the probe as alive.
+            // so we dont need to do anything here.
+            return Response.sendCustomResponse(req, res, responseCode, responseBody);
+        } catch (err) {
+            return next(err);
+        }
+    }
+);
+
+export default router;

TestServer/API/Settings.ts

@@ -0,0 +1,45 @@
+import LocalCache from 'CommonServer/Infrastructure/LocalCache';
+import Express, {
+    ExpressRequest,
+    ExpressResponse,
+    ExpressRouter,
+    NextFunction,
+} from 'CommonServer/Utils/Express';
+import Response from 'CommonServer/Utils/Response';
+import { JSONObject} from 'Common/Types/JSON';
+
+const router: ExpressRouter = Express.getRouter();
+
+router.post(
+    '/settings',
+    async (
+        req: ExpressRequest,
+        res: ExpressResponse,
+        next: NextFunction
+    ): Promise<void> => {
+        try {
+
+
+            const data: JSONObject = req.body;
+
+            const responseType: string | undefined = data['responseType'] as string | undefined;
+            const responseCode: number | undefined = data['responseCode'] as number | undefined;
+            const responseTime: number | undefined = data['responseTime'] as number | undefined;
+            const responseBody: string | undefined = data['responseBody'] as string | undefined;
+        
+
+            LocalCache.setString('TestServer', 'responseType', responseType || 'JSON');
+            LocalCache.setNumber('TestServer', 'responseCode', responseCode || 200);
+            LocalCache.setNumber('TestServer', 'responseTime', responseTime || 0);
+            LocalCache.setString('TestServer', 'responseBody', responseBody || '');
+
+            // middleware marks the probe as alive.
+            // so we dont need to do anything here.
+            return Response.sendEmptyResponse(req, res);
+        } catch (err) {
+            return next(err);
+        }
+    }
+);
+
+export default router;

TestServer/Dockerfile.tpl

@@ -0,0 +1,76 @@
+#
+# OneUptime-probe-api Dockerfile
+#
+
+# Pull base image nodejs image.
+FROM node:18.13.0-alpine
+USER root
+RUN mkdir /tmp/npm &&  chmod 2777 /tmp/npm && chown 1000:1000 /tmp/npm && npm config set cache /tmp/npm --global
+
+
+# Install bash. 
+RUN apk update && apk add bash && apk add curl
+
+
+# Install python
+RUN apk update && apk add --no-cache --virtual .gyp python3 make g++
+
+#Use bash shell by default
+SHELL ["/bin/bash", "-c"]
+
+
+RUN mkdir /usr/src
+
+# Install common
+RUN mkdir /usr/src/Common
+WORKDIR /usr/src/Common
+COPY ./Common/package*.json /usr/src/Common/
+RUN npm install
+COPY ./Common /usr/src/Common
+
+
+# Install Model
+RUN mkdir /usr/src/Model
+WORKDIR /usr/src/Model
+COPY ./Model/package*.json /usr/src/Model/
+RUN npm install
+COPY ./Model /usr/src/Model
+
+
+
+# Install CommonServer
+RUN mkdir /usr/src/CommonServer
+WORKDIR /usr/src/CommonServer
+COPY ./CommonServer/package*.json /usr/src/CommonServer/
+RUN npm install
+COPY ./CommonServer /usr/src/CommonServer
+
+
+
+#SET ENV Variables
+ENV PRODUCTION=true
+
+RUN mkdir /usr/src/app
+
+WORKDIR /usr/src/app
+
+# Install app dependencies
+COPY ./TestServer/package*.json /usr/src/app/
+RUN npm install
+
+# Expose ports.
+#   - 3800: OneUptime-probe-api
+EXPOSE 3800
+
+{{ if eq .Env.ENVIRONMENT "development" }}
+#Run the app
+CMD [ "npm", "run", "dev" ]
+{{ else }}
+# Copy app source
+COPY ./TestServer /usr/src/app
+# Bundle app source
+RUN npm run compile
+#Run the app
+CMD [ "npm", "start" ]
+{{ end }}
+

TestServer/Index.ts

@@ -0,0 +1,25 @@
+import 'ejs';
+import Express, { ExpressApplication } from 'CommonServer/Utils/Express';
+import logger from 'CommonServer/Utils/Logger';
+import App from 'CommonServer/Utils/StartServer';
+import MainAPI from './API/Main';
+import SettingsAPI from './API/Settings';
+
+const app: ExpressApplication = Express.getExpressApp();
+
+const APP_NAME: string = '';
+
+app.use([`/${APP_NAME}`, '/'], MainAPI);
+app.use([`/${APP_NAME}`, '/'], SettingsAPI);
+
+const init: Function = async (): Promise<void> => {
+    try {
+        // init the app
+        await App(APP_NAME);
+    } catch (err) {
+        logger.error('App Init Failed:');
+        logger.error(err);
+    }
+};
+
+init();

TestServer/jest.config.json

@@ -0,0 +1,27 @@
+{
+    "preset": "ts-jest",
+    "verbose": true,
+    "globals": {
+        "ts-jest": {
+            "tsconfig": "tsconfig.json",
+            "babelConfig": false
+        }
+    },
+    "moduleFileExtensions": ["ts", "js", "json"],
+    "transform": {
+        ".(ts|tsx)": "ts-jest"
+    },
+    "testEnvironment": "node",
+    "collectCoverage": true,
+    "coverageReporters": ["text"],
+    "testRegex": "./Tests/(.*).test.ts",
+    "collectCoverageFrom": ["./**/*.(tsx||ts)"],
+    "coverageThreshold": {
+        "global": {
+            "lines": 0,
+            "functions": 0,
+            "branches": 0,
+            "statements": 0
+        }
+    }
+}

TestServer/nodemon.json

@@ -0,0 +1,5 @@
+{
+    "watch": ["./","../Common", "../CommonServer", "../Model"],
+        "ext": "ts,json,tsx,env,js,jsx,hbs",
+        "exec": "node --inspect=0.0.0.0:9229 --require ts-node/register Index.ts"
+    }

TestServer/package.json

@@ -0,0 +1,31 @@
+{
+    "name": "test-server",
+    "version": "1.0.0",
+    "description": "",
+    "main": "index.js",
+    "scripts": {
+        "start": "node --require ts-node/register Index.ts",
+        "compile": "tsc",
+        "dev": "npx nodemon",
+        "audit": "npm audit --audit-level=low",
+        "dep-check": "depcheck ./ --skip-missing=true",
+        "test": "jest --passWithNoTests"
+    },
+    "author": "",
+    "license": "ISC",
+    "dependencies": {
+        "Common": "file:../Common",
+        "CommonServer": "file:../CommonServer",
+        "cron-parser": "^4.8.1",
+        "ejs": "^3.1.8",
+        "Model": "file:../Model",
+        "ts-node": "^10.9.1"
+    },
+    "devDependencies": {
+        "@types/jest": "^27.5.0",
+        "@types/node": "^17.0.31",
+        "jest": "^28.1.0",
+        "nodemon": "^2.0.20",
+        "ts-jest": "^28.0.2"
+    }
+}

TestServer/tsconfig.json

@@ -0,0 +1,113 @@
+{
+    "ts-node": {
+        // these options are overrides used only by ts-node
+        // same as the --compilerOptions flag and the TS_NODE_COMPILER_OPTIONS environment variable
+        "compilerOptions": {
+            "module": "commonjs"
+        }
+    },
+    "compilerOptions": {
+        /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+        /* Projects */
+        // "incremental": true,                              /* Enable incremental compilation */
+        // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+        // "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
+        // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
+        // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+        // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+        /* Language and Environment */
+        "target": "es2017" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+        // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+        "jsx": "react" /* Specify what JSX code is generated. */,
+        "experimentalDecorators": true /* Enable experimental support for TC39 stage 2 draft decorators. */,
+        "emitDecoratorMetadata": true /* Emit design-type metadata for decorated declarations in source files. */,
+        // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
+        // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+        // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
+        // "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
+        // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+        // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+
+        /* Modules */
+        // "module": "es2022" /* Specify what module code is generated. */,
+        "rootDir": "" /* Specify the root folder within your source files. */,
+        "moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */,
+        // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+        // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+        // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+        "typeRoots": [
+            "./node_modules/@types"
+        ] /* Specify multiple folders that act like `./node_modules/@types`. */,
+        "types": [
+            "node",
+            "jest"
+        ] /* Specify type package names to be included without being referenced in a source file. */,
+        // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+        // "resolveJsonModule": true,                        /* Enable importing .json files */
+        // "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
+
+        /* JavaScript Support */
+        // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
+        // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+        // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
+
+        /* Emit */
+        // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+        // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+        // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+        "sourceMap": true /* Create source map files for emitted JavaScript files. */,
+        // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
+        "outDir": "build/dist" /* Specify an output folder for all emitted files. */,
+        // "removeComments": true,                           /* Disable emitting comments. */
+        // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+        // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+        // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
+        // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+        // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+        // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+        // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+        // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+        // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+        // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+        // "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
+        // "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
+        // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+        // "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
+        // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+        // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+        /* Interop Constraints */
+        // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+        // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+        "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */,
+        // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+        "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+
+        /* Type Checking */
+        "strict": true /* Enable all strict type-checking options. */,
+        "noImplicitAny": true /* Enable error reporting for expressions and declarations with an implied `any` type.. */,
+        "strictNullChecks": true /* When type checking, take into account `null` and `undefined`. */,
+        "strictFunctionTypes": true /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */,
+        "strictBindCallApply": true /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */,
+        "strictPropertyInitialization": true /* Check for class properties that are declared but not set in the constructor. */,
+        "noImplicitThis": true /* Enable error reporting when `this` is given the type `any`. */,
+        "useUnknownInCatchVariables": true /* Type catch clause variables as 'unknown' instead of 'any'. */,
+        "alwaysStrict": true /* Ensure 'use strict' is always emitted. */,
+        "noUnusedLocals": true /* Enable error reporting when a local variables aren't read. */,
+        "noUnusedParameters": true /* Raise an error when a function parameter isn't read */,
+        "exactOptionalPropertyTypes": true /* Interpret optional property types as written, rather than adding 'undefined'. */,
+        "noImplicitReturns": true /* Enable error reporting for codepaths that do not explicitly return in a function. */,
+        "noFallthroughCasesInSwitch": true /* Enable error reporting for fallthrough cases in switch statements. */,
+        "noUncheckedIndexedAccess": true /* Include 'undefined' in index signature results */,
+        "noImplicitOverride": true /* Ensure overriding members in derived classes are marked with an override modifier. */,
+        "noPropertyAccessFromIndexSignature": true /* Enforces using indexed accessors for keys declared using an indexed type */,
+        // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+        // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+        /* Completeness */
+        // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+        "skipLibCheck": true /* Skip type checking all .d.ts files. */
+    }
+}

config.tpl.env

@@ -47,6 +47,7 @@ DASHBOARD_API_HOSTNAME=dashboard-api:3002
 WORKFLOW_HOSTNAME=workflow:3099
 ALERT_HOSTNAME=alert:3088
 PROBE_API_HOSTNAME=probe-api:3400
+TEST_SERVER_HOSTNAME=test-server:3800
 DATA_INGESTOR_HOSTNAME=data-ingestor:3200
 ACCOUNTS_HOSTNAME=accounts:3003
 HOME_HOSTNAME=home:1444
@@ -61,6 +62,7 @@ DASHBOARD_ROUTE=/dashboard
 DASHBOARD_API_ROUTE=/api
 WORKFLOW_ROUTE=/workflow
 ALERT_ROUTE=/alert
+TEST_SERVER_API_ROUTE=/test-server
 PROBE_API_ROUTE=/probe-api
 DATA_INGESTOR_ROUTE=/data-ingestor
 ACCOUNTS_ROUTE=/accounts
@@ -78,6 +80,7 @@ WORKFLOW_PORT=3099
 ALERT_PORT=3088
 PROBE_API_PORT=3400
 PROBE_PORT=3500
+TEST_SERVER_PORT=3800
 FILE_PORT=3125
 HOME_PORT=1444
 IDENTITY_PORT=3087

docker-compose.tpl.yml

@@ -646,6 +646,29 @@ services:
             - /usr/src/Model/node_modules/
         {{ end }}
 
+
+    {{ if or (eq .Env.ENVIRONMENT "development") (eq .Env.ENVIRONMENT "test")  }}
+    test-server:
+        ports:
+            - '3800:3800'
+            {{ if eq .Env.ENVIRONMENT "development" }}
+            - '9141:9229' # Debugging port.
+            {{ end }}
+        {{ if or (eq .Env.ENVIRONMENT "development") (eq .Env.ENVIRONMENT "ci")  }}
+        build:
+            network: host
+            context: .
+            dockerfile: ./TestServer/Dockerfile
+        {{ else }}
+        image:  oneuptime/test-server:{{ .Env.APP_TAG }}
+        {{ end }}
+        restart: always
+        env_file:
+            - ./Common/.env
+            - ./CommonServer/.env
+            - ./TestServer/.env
+    {{ end }}
+
     nginx:
         depends_on:
             - identity