typescript refactor (#62)

* typescript refactor

* tyescript modifications

* cleanup

Author: Burnett2k

Diff for: .gitignore

@@ -20,4 +20,5 @@ yarn-error.log*
 
 # server
 /server/.env
-/server/node_modules
+/server/node_modules
+/server/dist

Diff for: server/Dockerfile

@@ -5,14 +5,10 @@ FROM node:12-alpine
 LABEL maintainer="Sawyer Blue Burnett"
 
 # Copy dependencies
-COPY package.json yarn.lock ./
+COPY package.json yarn.lock tsconfig.json ./
 # Install dependencies
 RUN yarn
-
-COPY passport-setup.js server.js ./
-# Copy rest of files
-COPY models/ ./models
-COPY routes/ ./routes
-COPY controllers/ ./controllers
+COPY src/ ./src
+RUN yarn build
 
 EXPOSE 80

Diff for: server/models/user.js

@@ -0,0 +1,9 @@
+{
+  "watch": ["src/"],
+  "ext": "ts",
+  "execMap": {
+    "ts": "node -r ts-node/register"
+  },
+  "restartable": "rs",
+  "ignore": [".git", "node_modules/", "dist/"]
+}

Diff for: server/nodemon.json

@@ -5,8 +5,9 @@
   "main": "server.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "start": "node server.js",
-    "dev": "nodemon server.js"
+    "build": "tsc",
+    "start": "node dist/server.js",
+    "dev": "nodemon --config nodemon.json src/server.ts"
   },
   "keywords": [],
   "author": "",
@@ -26,5 +27,16 @@
     "nodemon": "^1.19.3",
     "passport": "^0.4.0",
     "passport-google-oauth20": "^2.0.0"
+  },
+  "devDependencies": {
+    "@types/cors": "^2.8.10",
+    "@types/dotenv": "^8.2.0",
+    "@types/express": "^4.17.11",
+    "@types/mongoose": "^5.10.3",
+    "@types/node": "^14.14.35",
+    "@types/passport": "^1.0.6",
+    "@types/passport-google-oauth20": "^2.0.7",
+    "ts-node": "^9.1.1",
+    "typescript": "^4.2.3"
   }
 }

Diff for: server/package.json

@@ -1,12 +1,15 @@
-const passport = require('passport');
+import passport from 'passport';
+import { NextFunction, Request, Response } from 'express';
 const CLIENT_HOME_PAGE_URL = process.env.CLIENT_HOME_PAGE_URL;
 const GOOGLE_STRATEGY = 'google';
 
-exports.loginSuccess = function(req, res) {
+export const loginSuccess = function(req: Request, res: Response) {
   if (req.user) {
+    const message = 'user has successfully authenticated';
+    console.log(message);
     res.json({
       success: true,
-      message: 'user has successfully authenticated',
+      message: message,
       user: req.user,
       cookies: req.cookies,
     });
@@ -15,27 +18,37 @@ exports.loginSuccess = function(req, res) {
   }
 };
 
-exports.loginFailed = function(req, res) {
+export const loginFailed = function(req: Request, res: Response) {
+  console.log('failed authentication attempt');
   res.status(401).json({
     success: false,
     message: 'user failed to authenticate.',
   });
 };
 
-exports.logout = function(req, res) {
+export const logout = function(req: Request, res: Response) {
+  console.log('logout attempted');
   req.logout();
   res.redirect(CLIENT_HOME_PAGE_URL);
 };
 
-exports.authenticate = function(req, res, next) {
+export const authenticate = function(
+  req: Request,
+  res: Response,
+  next: NextFunction
+) {
   passport.authenticate(GOOGLE_STRATEGY, { scope: ['profile', 'email'] })(
     req,
     res,
     next
   );
 };
 
-exports.redirect = function(req, res, next) {
+export const redirect = function(
+  req: Request,
+  res: Response,
+  next: NextFunction
+) {
   passport.authenticate(GOOGLE_STRATEGY, {
     failureRedirect: '/login/failed',
     successRedirect: CLIENT_HOME_PAGE_URL,

Diff for: server/routes/auth-routes.js

@@ -1,8 +1,9 @@
-const Session = require('../models/session');
+import { Session } from '../models/session';
+import { Request, Response } from 'express';
 
-exports.retrieveSessions = async function(req, res) {
-  // move auth checks into a helper function
+export const retrieveSessions = async function(req: Request, res: Response) {
   if (req.user) {
+    console.log('retrieving sessions for user');
     Session.find(
       { userId: req.user.id },
       null,
@@ -22,7 +23,8 @@ exports.retrieveSessions = async function(req, res) {
   }
 };
 
-exports.saveSessions = async function(req, res) {
+export const saveSessions = async function(req: Request, res: Response) {
+  console.log('saving a user session');
   const body = req.body;
 
   if (!body.notes || !body.notes.text) {
@@ -46,8 +48,9 @@ exports.saveSessions = async function(req, res) {
   }
 };
 
-exports.getSessionSummary = async function(req, res) {
+export const getSessionSummary = async function(req: Request, res: Response) {
   if (req.user) {
+    console.log('retrieving session summary for user');
     const aggregate = await Session.aggregate([
       { $match: { userId: req.user.id } },
       {

Diff for: server/routes/session-routes.js

@@ -0,0 +1,6 @@
+declare module Express {
+  interface AuthInfo {}
+  interface User {
+    id?: string;
+  }
+}

Diff for: server/controllers/authController.js renamed to server/src/controllers/authController.ts

@@ -1,5 +1,4 @@
-const mongoose = require('mongoose');
-const Schema = mongoose.Schema;
+import { Schema, model } from 'mongoose';
 
 const sessionSchema = new Schema({
   userId: String,
@@ -10,6 +9,4 @@ const sessionSchema = new Schema({
   },
 });
 
-const Session = mongoose.model('session', sessionSchema);
-
-module.exports = Session;
+export const Session = model('session', sessionSchema);

Diff for: server/controllers/sessionController.js renamed to server/src/controllers/sessionController.ts

@@ -0,0 +1,19 @@
+import { Schema, model, Document } from 'mongoose';
+
+export type UserDocument = Document & {
+  firstName: string;
+  lastName: string;
+  screenName: string;
+  googleId: string;
+  emailAddress: string;
+};
+
+const userSchema = new Schema<UserDocument>({
+  firstName: String,
+  lastName: String,
+  screenName: String,
+  googleId: String,
+  emailAddress: String,
+});
+
+export const User = model<UserDocument>('User', userSchema);

Diff for: server/src/index.d.ts

@@ -1,9 +1,9 @@
-const passport = require('passport');
-const GoogleStrategy = require('passport-google-oauth20').Strategy;
-const User = require('./models/user');
+import passport from 'passport';
+import { Strategy } from 'passport-google-oauth20';
+import { User } from './models/user';
 
 passport.use(
-  new GoogleStrategy(
+  new Strategy(
     {
       clientID: process.env.CLIENT_ID,
       clientSecret: process.env.CLIENT_SECRET,
@@ -32,11 +32,11 @@ passport.use(
   )
 );
 
-passport.serializeUser(function(user, done) {
+passport.serializeUser((user, done) => {
   done(null, user.id);
 });
 
-passport.deserializeUser(function(id, done) {
+passport.deserializeUser((id, done) => {
   User.findById(id)
     .then((user) => {
       done(null, user);

Diff for: server/models/session.js renamed to server/src/models/session.ts

@@ -0,0 +1,31 @@
+import { NextFunction, Request, Response, Router } from 'express';
+
+import {
+  loginFailed,
+  authenticate,
+  loginSuccess,
+  logout,
+  redirect,
+} from '../controllers/authController';
+
+export const router = Router();
+
+router.use((req: Request, res: Response, next: NextFunction) => {
+  console.log('request to auth endpoint at Time: ', new Date().toISOString());
+  next();
+});
+
+// when login is successful, retrieve user info
+router.get('/login/success', loginSuccess);
+
+// when login failed, send failed msg
+router.get('/login/failed', loginFailed);
+
+// when user logs out, redirect to client
+router.get('/logout', logout);
+
+// call authenticate for google strategy
+router.get('/google', authenticate);
+
+// redirect after auth completes successfully
+router.get('/google/redirect', redirect);

Diff for: server/src/models/user.ts

@@ -0,0 +1,18 @@
+import { NextFunction, Request, Response, Router } from 'express';
+
+import {
+  retrieveSessions,
+  getSessionSummary,
+  saveSessions,
+} from '../controllers/sessionController';
+export const router = Router();
+
+router.use((req: Request, res: Response, next: NextFunction) => {
+  next();
+});
+
+router.get('/', retrieveSessions);
+
+router.post('/save', saveSessions);
+
+router.get('/summary', getSessionSummary);

Diff for: server/passport-setup.js renamed to server/src/passport-setup.ts

@@ -1,10 +1,10 @@
 require('dotenv').config();
-const express = require('express');
-const passport = require('passport');
-const authRoutes = require('./routes/auth-routes');
-const sessionRoutes = require('./routes/session-routes');
-const mongoose = require('mongoose');
-const cors = require('cors');
+import express from 'express';
+import mongoose from 'mongoose';
+import passport from 'passport';
+import { router as authRoutes } from './routes/auth-routes';
+import { router as sessionRoutes } from './routes/session-routes';
+import cors from 'cors';
 const offline = process.env.OFFLINE === 'true' ? true : false;
 require('./passport-setup');
 
@@ -33,7 +33,6 @@ if (!offline) {
   console.log('offline mode: will not connect to mongodb');
 }
 
-// Create a new Express application.
 var app = express();
 
 app.set('port', process.env.PORT || 8080);

Diff for: server/src/routes/auth-routes.ts

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "es6",
+    "noImplicitAny": true,
+    "moduleResolution": "node",
+    "sourceMap": true,
+    "outDir": "dist",
+    "baseUrl": ".",
+    "paths": {
+      "*": ["node_modules/*", "src/types/*"]
+    }
+  },
+  "ts-node": {
+    "files": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules"]
+}