Changed endpoints, added some TS

-/api/get-repos and /api/get-orgs is now /orgs, and /orgs/repos
- Added some type script stuff
- Moved middleware to separate file

Author: kenerwin88

.gitignore

@@ -103,3 +103,41 @@ public/
 .dynamodb/
 
 # End of https://www.gitignore.io/api/node
+
+# compiled output
+/dist
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# Environment Files
+*.env

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}

app.js

@@ -1,59 +1,39 @@
-"use strict";
+'use strict';
 
-const express = require("express");
-const jwt = require("express-jwt");
-const jwksRsa = require("jwks-rsa");
-const getUserOrgs = require("./library/githubUser/getUserOrgs");
-const getUser = require("./library/githubUser/getUser");
-const getRepos = require("./library/githubUser/getRepos");
-const managementApiToken = require("./library/auth0/getManagementApiToken");
-const session = require("express-session");
-const redis = require("redis");
-let RedisStore = require("connect-redis")(session);
+const express = require('express');
+const getUserOrgs = require('./library/githubUser/getUserOrgs');
+const getUser = require('./library/githubUser/getUser');
+const getRepos = require('./library/githubUser/getRepos');
+const managementApiToken = require('./library/auth0/getManagementApiToken');
+const session = require('express-session');
+const redis = require('redis');
+let RedisStore = require('connect-redis')(session);
 let redisClient = redis.createClient();
-require("dotenv").config();
+require('dotenv').config();
 
 // Create a new Express app
 const app = express();
 
 // Logging
-const pino = require("pino");
-const expressPino = require("express-pino-logger");
-const logger = pino({ level: process.env.LOG_LEVEL || "info" });
+const pino = require('pino');
+const expressPino = require('express-pino-logger');
+const logger = pino({ level: process.env.LOG_LEVEL || 'info' });
 const expressLogger = expressPino({ logger });
 app.use(expressLogger);
 
-// Set up Auth0 configuration
-const authConfig = {
-  domain: "devopslibrary.auth0.com",
-  audience: "kondo-backend"
-};
-
 // Define middleware that validates incoming bearer tokens
-// using JWKS from devopslibrary.auth0.com
-const checkJwt = jwt({
-  secret: jwksRsa.expressJwtSecret({
-    cache: true,
-    rateLimit: true,
-    jwksRequestsPerMinute: 5,
-    jwksUri: `https://${authConfig.domain}/.well-known/jwks.json`
-  }),
-
-  audience: authConfig.audience,
-  issuer: `https://${authConfig.domain}/`,
-  algorithm: ["RS256"]
-});
+const checkJwt = require('./src/middleware/authGuard');
 
 // Use session https://github.com/expressjs/session
 var sess = {
   store: new RedisStore({ client: redisClient }),
-  secret: "I like Santa",
+  secret: 'I like Santa',
   cookie: {},
   resave: false,
-  saveUninitialized: false
+  saveUninitialized: false,
 };
-if (app.get("env") === "production") {
-  app.set("trust proxy", 1); // trust first proxy
+if (app.get('env') === 'production') {
+  app.set('trust proxy', 1); // trust first proxy
   sess.cookie.secure = true; // serve secure cookies
 }
 app.use(session(sess));
@@ -62,36 +42,36 @@ app.use(session(sess));
 // Get management token from Auth0
 let authToken;
 app.use(express.json());
-app.listen(3001, async function() {
-  logger.info("App is ready");
+app.listen(3000, async function() {
+  logger.info('App is ready');
   await managementApiToken.token.then(function(token) {
     authToken = token;
   });
 });
 
 // Retrieve Org Information
-app.get("/api/get-orgs", checkJwt, async (req, res) => {
+app.get('/orgs', checkJwt, async (req, res) => {
   if (!req.session.orgs) {
-    const userId = req.user.sub.split("|")[1];
+    const userId = req.user.sub.split('|')[1];
     const githubUser = await getUser(authToken, userId);
     const githubToken = githubUser.identities[0].access_token;
     const orgs = await getUserOrgs(githubToken);
     req.session.orgs = orgs;
   }
-  req.log.info("Returning cached Github Orgs");
+  req.log.info('Returning cached Github Orgs');
   res.send(req.session.orgs);
 });
 
 // Receive Repo Information
-app.get("/api/get-repos", checkJwt, async (req, res) => {
-  const userId = req.user.sub.split("|")[1];
+app.get('/orgs/repos', checkJwt, async (req, res) => {
+  const userId = req.user.sub.split('|')[1];
   const githubUser = await getUser(authToken, userId);
   const githubToken = githubUser.identities[0].access_token;
   const repos = await getRepos(req.query.org, githubToken);
   res.send(repos);
 });
 
-process.on("SIGINT", function() {
+process.on('SIGINT', function() {
   redisClient.quit();
-  console.log("redis client quit");
+  console.log('redis client quit');
 });

package.json

@@ -11,6 +11,8 @@
   "author": "DevOps Library",
   "license": "ISC",
   "dependencies": {
+    "@hapi/joi": "^16.1.7",
+    "@types/jest": "^24.0.23",
     "async-redis": "^1.1.7",
     "backpack-core": "^0.8.4",
     "connect-redis": "^4.0.3",
@@ -35,22 +37,36 @@
   "jest": {
     "collectCoverage": true,
     "collectCoverageFrom": [
-      "**/*.js"
+      "**/*.js",
+      "**/*.ts"
+    ],
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
     ],
-    "testEnvironment": "node",
     "testResultsProcessor": "jest-sonar-reporter",
     "coveragePathIgnorePatterns": [
       "/node_modules/",
       "/coverage/",
       "backpack.config.js",
       "/build/"
-    ]
+    ],
+    "rootDir": "src",
+    "testRegex": ".spec.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "coverageDirectory": "./coverage",
+    "testEnvironment": "node"
   },
   "devDependencies": {
     "eslint": "^6.6.0",
     "eslint-config-prettier": "^6.5.0",
     "jest": "^24.9.0",
     "jest-sonar-reporter": "^2.0.0",
-    "supertest": "^4.0.2"
+    "supertest": "^4.0.2",
+    "ts-jest": "^24.1.0",
+    "typescript": "^3.7.2"
   }
 }

src/config/config.service.spec.ts

@@ -0,0 +1,7 @@
+import { ConfigService } from './config.service';
+
+describe('Config', () => {
+  it('should be defined', () => {
+    expect(new ConfigService('development.env')).toBeDefined();
+  });
+});

src/config/config.service.ts

@@ -0,0 +1,43 @@
+import * as dotenv from 'dotenv';
+const Joi = require('@hapi/joi');
+import * as fs from 'fs';
+
+export type EnvConfig = Record<string, string>;
+
+export class ConfigService {
+  private readonly envConfig: EnvConfig;
+
+  constructor(filePath: string) {
+    const config = dotenv.parse(fs.readFileSync(filePath));
+    this.envConfig = this.validateInput(config);
+  }
+
+  /**
+   * Ensures all needed variables are set, and returns the validated JavaScript object
+   * including the applied default values.
+   */
+  private validateInput(envConfig: EnvConfig): EnvConfig {
+    const envVarsSchema = Joi.object({
+      NODE_ENV: Joi.string()
+        .valid('development', 'production', 'test', 'provision')
+        .default('development'),
+      PORT: Joi.number().default(3000),
+      AUTH0_CLIENT_ID: Joi.string().required(),
+      AUTH0_CLIENT_SECRET: Joi.string().required(),
+      AUTH0_AUDIENCE: Joi.string().required(),
+      AUTH0_DOMAIN: Joi.string().required(),
+    });
+
+    const { error, value: validatedEnvConfig } = envVarsSchema.validate(
+      envConfig,
+    );
+    if (error) {
+      throw new Error(`Config validation error: ${error.message}`);
+    }
+    return validatedEnvConfig;
+  }
+
+  get(key: string): string {
+    return this.envConfig[key];
+  }
+}

src/middleware/authGuard.ts

@@ -0,0 +1,21 @@
+import jwt from 'express-jwt';
+import jwksRsa from 'jwks-rsa';
+import { ConfigService } from '../config/config.service';
+
+// Set up Auth0 configuration
+let config: ConfigService = new ConfigService(
+  `${process.env.NODE_ENV || 'development'}.env`,
+);
+
+const checkJwt = jwt({
+  secret: jwksRsa.expressJwtSecret({
+    cache: true,
+    rateLimit: true,
+    jwksRequestsPerMinute: 5,
+    jwksUri: `https://${config.get('AUTH0_DOMAIN')}/.well-known/jwks.json`,
+  }),
+
+  audience: config.get('AUTH0_AUDIENCE'),
+  issuer: `https://${config.get('AUTH0_DOMAIN')}/`,
+  algorithm: ['RS256'],
+});

tsconfig.build.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["node_modules", "test", "dist", "**/*spec.ts"]
+}

tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "target": "es2017",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "incremental": true
+  },
+  "exclude": ["node_modules", "dist"]
+}

tslint.json

@@ -0,0 +1,18 @@
+{
+  "defaultSeverity": "error",
+  "extends": ["tslint:recommended"],
+  "jsRules": {
+    "no-unused-expression": true
+  },
+  "rules": {
+    "quotemark": [true, "single"],
+    "member-access": [false],
+    "ordered-imports": [false],
+    "max-line-length": [true, 150],
+    "member-ordering": [false],
+    "interface-name": [false],
+    "arrow-parens": false,
+    "object-literal-sort-keys": false
+  },
+  "rulesDirectory": []
+}