Made changes to base user model and documented necessary parts of code

krushiraj · krushiraj · commit 3363429e5f3f · 2019-11-26T11:46:42.000+05:30
diff --git a/.env.example b/.env.example
@@ -1,11 +1,17 @@
+# Env modes
+PRODUCTION=
+TEST=
+
 # Database credentials
 DB_USER=root
 DB_PASSWORD=null
 DB_HOST=localhost
 DB_PORT=5432
 DB_NAME=coderplex-org
+
 # JWT secret
-JWT_SECRET=jwt-secret
+JWT_SECRET=
+
 # Github OAuth
 GITHUB_CLIENT_ID=
 GITHUB_CLIENT_SECRET=
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,2 @@
+.vscode/*
+bin/*
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -1,3 +1,3 @@
 module.exports = {
-    "extends": "standard"
+  extends: "standard"
 };
diff --git a/package.json b/package.json
@@ -10,7 +10,7 @@
     "makemigrations": "sequelize migration:create",
     "migrate": "sequelize db:migrate",
     "build": "mkdir dist && babel src -s -d dist",
-    "lint": "eslint"
+    "lint": "eslint --fix --ext js src"
   },
   "dependencies": {
     "apollo-server": "^2.0.0",
@@ -21,6 +21,7 @@
     "dataloader": "^1.4.0",
     "dotenv": "^6.0.0",
     "express": "^4.17.1",
+    "express-session": "^1.17.0",
     "graphql": "^14.5.8",
     "graphql-relay": "^0.6.0",
     "graphql-resolvers": "^0.3.3",
diff --git a/src/index.js b/src/index.js
@@ -19,6 +19,7 @@ app.use(cors())
 
 app.use(morgan('dev'))
 
+// This adds handlers for routes related to auth
 addAuthRoutes(app)
 
 const getLoggedInUser = async req => {
@@ -80,39 +81,21 @@ server.applyMiddleware({ app, path: '/graphql' })
 const httpServer = http.createServer(app)
 server.installSubscriptionHandlers(httpServer)
 
-const isTest = !!process.env.TEST_DATABASE
-const isProduction = !!process.env.DATABASE_URL
+const isDevelopment = !process.env.PRODUCTION
+const isTest = !!process.env.TEST
 const port = process.env.PORT || 8000
 
-sequelize.sync({ force: isTest || isProduction }).then(async () => {
-  if (isTest || isProduction) {
-    createUsersWithMessages(new Date())
+sequelize.sync({ force: isDevelopment || isTest }).then(async () => {
+  if (isTest) {
+    createTestData()
   }
 
   httpServer.listen({ port }, () => {
     console.log(`Apollo Server on http://localhost:${port}/graphql`)
+    console.log({ isDevelopment, isTest })
   })
 })
 
-const createUsersWithMessages = async date => {
-  models.User.create(
-    {
-      email: 'hello@robin.com',
-      password: 'rwieruch',
-      firstName: 'rev',
-      lastName: 'rich',
-    }
-  ).then(async _user => {
-    const user = (await models.User.findByLogin('hello@robin.com'))
-    models.SocialProfile.create(
-    {
-      facebook: 'facebook.com/krushiraj',
-      twitter: 'twitter.com/krushiraj123',
-      userId: user.id
-    },
-    {
-      include: [models.User]
-    }
-    )
-  }).catch(console.error)
+const createTestData = async () => {
+  // Use this function in future to seed the test data
 }
diff --git a/src/loaders/index.js b/src/loaders/index.js
@@ -1,3 +1,3 @@
-import * as user from './user';
+import * as user from './user'
 
-export default { user };
+export default { user }
diff --git a/src/loaders/user.js b/src/loaders/user.js
@@ -2,10 +2,10 @@ export const batchUsers = async (keys, models) => {
   const users = await models.User.findAll({
     where: {
       id: {
-        $in: keys,
-      },
-    },
-  });
+        $in: keys
+      }
+    }
+  })
 
-  return keys.map(key => users.find(user => user.id === key));
-};
+  return keys.map(key => users.find(user => user.id === key))
+}
diff --git a/src/models/event-profile.js b/src/models/event-profile.js
@@ -4,7 +4,7 @@ const EventProfile = (sequelize, DataTypes) => {
   const EventProfile = sequelize.define(
     'event_profile',
     {
-      id: id(DataTypes)
+      id: id(DataTypes.UUID)
     }
   )
 
diff --git a/src/models/index.js b/src/models/index.js
@@ -1,23 +1,23 @@
 import Sequelize from 'sequelize'
 import { development } from '../config/config'
-//import all models here
+// import all models here
 import user from './user'
 import socialProfile from './social-profile'
 import eventProfile from './event-profile'
 
 let sequelize
 if (process.env.DATABASE_URL) {
   sequelize = new Sequelize(process.env.DATABASE_URL, {
-    dialect: 'postgres',
+    dialect: 'postgres'
   })
 } else {
   sequelize = new Sequelize(
     development.database,
     development.username,
     development.password,
     {
-      dialect: 'postgres',
-    },
+      dialect: 'postgres'
+    }
   )
 }
 
diff --git a/src/models/social-profile.js b/src/models/social-profile.js
@@ -1,8 +1,8 @@
 import { id } from './utils'
 
 const socialProfile = (sequelize, DataTypes) => {
-  const SocialProfile = sequelize.define("social_profile", {
-    id: id(DataTypes),
+  const SocialProfile = sequelize.define('social_profile', {
+    id: id(DataTypes.UUID),
     facebook: {
       type: DataTypes.STRING,
       allowNull: true
@@ -22,4 +22,4 @@ const socialProfile = (sequelize, DataTypes) => {
   return SocialProfile
 }
 
-export default socialProfile
+export default socialProfile
diff --git a/src/models/user.js b/src/models/user.js
@@ -1,19 +1,11 @@
-import bcrypt from 'bcrypt'
 import { id } from './utils'
 
 const user = (sequelize, DataTypes) => {
   const User = sequelize.define(
     'user',
     {
-      id: id(DataTypes),
-      firstName: {
-        type: DataTypes.STRING,
-        allowNull: false,
-        validate: {
-          notEmpty: true
-        }
-      },
-      lastName: {
+      id: id(DataTypes.UUID),
+      name: {
         type: DataTypes.STRING,
         allowNull: false,
         validate: {
@@ -25,17 +17,9 @@ const user = (sequelize, DataTypes) => {
         unique: true,
         allowNull: false,
         validate: {
-          notEmpty: true,
           isEmail: true
         }
       },
-      password: {
-        type: DataTypes.STRING,
-        allowNull: false,
-        validate: {
-          notEmpty: true
-        }
-      },
       contactNo: {
         type: DataTypes.STRING,
         allowNull: true,
@@ -50,30 +34,7 @@ const user = (sequelize, DataTypes) => {
           'https://i0.wp.com/www.winhelponline.com/blog/wp-content/uploads/2017/12/user.png?fit=256%2C256&quality=100&ssl=1'
       }
     }
-  );
-
-  User.findByLogin = async login => {
-    let user = await User.findOne({
-      where: { email: login }
-    })
-
-    return user
-  }
-
-  User.beforeCreate(async user => {
-    user.password = await user.generatePasswordHash(user.password)
-  })
-
-  User.prototype.generatePasswordHash = async password => {
-    const saltRounds = 10
-    const hash = await bcrypt.hash(password, saltRounds)
-    return hash
-  }
-
-  User.prototype.validatePassword = async (password) => {
-    const comparision = await bcrypt.compare(password, this.password)
-    return comparision
-  }
+  )
 
   return User
 }
diff --git a/src/models/utils.js b/src/models/utils.js
@@ -1,12 +1,12 @@
 import uuid from 'uuid/v4'
 
-const id = (DataTypes) => {
+const id = (UUID) => {
   return {
-    type: DataTypes.UUID,
+    type: UUID,
     allowNull: false,
     primaryKey: true,
     defaultValue: () => uuid()
   }
 }
 
-export { id }
+export { id }
diff --git a/src/schema/index.js b/src/schema/index.js
@@ -1,11 +1,14 @@
 import { gql } from 'apollo-server-express'
 
+// TODO: move all feature specific schemas to subdirectory
+// Ex: All events related schemas should be under ./event
+//     All jobs related schemas under ./jobs
+
 // Common schemas
 // Schema for UserProfile
 import userSchema from './user'
 
 // Events related schemas
-import eventProfileSchema from './event-profile'
 import eventDetails from './event-details'
 import eventGroupMemberRoleChoice from './event-group-member-role-choice'
 import eventGroupMemberRoles from './event-group-member-roles'
@@ -25,8 +28,7 @@ import subEvent from './sub-event'
 
 // Profile extensions. These are used to extend the base User schema
 import eventProfile from './event-profile'
-import socialProfile from "./social-profile";
-
+import socialProfile from './social-profile'
 
 const linkSchema = gql`
   scalar DateTime
@@ -47,7 +49,7 @@ const linkSchema = gql`
 
 export default [
   linkSchema, userSchema,
-  eventProfileSchema, eventDetails,
+  eventProfile, eventDetails,
   eventGroupMemberRoleChoice, eventGroupMemberRoles,
   eventGroup, eventLocationDetails,
   eventParticipationStatus, eventParticipation,
diff --git a/src/schema/user.js b/src/schema/user.js
@@ -1,28 +1,31 @@
 import { gql } from 'apollo-server-express'
 
+/*
+User - Base user model used in profiles feature
+
+Extends each new profile for each feature.
+
+- Make necessary changes in the models whenever new fields are added.
+- Add new queries under Query and update the query with function in resolvers.
+- Whenever a new extension added please add it as field under User,
+  also add resolvers to each of it.
+- Add necessary mutations if needed and handle the mutations in resolvers.
+*/
+
 export default gql`
   extend type Query {
-    allUsers: [User!]
+    allUsers: [User]!
     userById(id: ID!): User
     userByEmail(email: String!): User
     currentUser: User
   }
 
   extend type Mutation {
-    signUp(
-      username: String!
-      email: String!
-      password: String!
-    ): Token!
-
-    signIn(login: String!, password: String!): Token!
-
     updateUser(
-      email: String!,
-      contact_no: String!,
-      first_name: String!,
-      last_name: String!,
-      profile_pic: URL!
+      email: String,
+      contact_no: String,
+      name: String,
+      profile_pic: URL
     ): User!
 
     deleteUser(id: ID!): Boolean!
@@ -35,8 +38,7 @@ export default gql`
   type User {
     id: ID!
 
-    firstName: String!
-    lastName: String!
+    name: String!
     email: String!
     contactNo: String
     profilePic: URL!
@@ -45,3 +47,4 @@ export default gql`
     eventProfile: EventProfile
   }
 `
+// Extend with new profiles for each feature above
diff --git a/src/subscription/index.js b/src/subscription/index.js
@@ -1,9 +1,9 @@
-import { PubSub } from 'apollo-server';
+import { PubSub } from 'apollo-server'
 
-import * as MESSAGE_EVENTS from './message';
+import * as MESSAGE_EVENTS from './message'
 
 export const EVENTS = {
-  MESSAGE: MESSAGE_EVENTS,
-};
+  MESSAGE: MESSAGE_EVENTS
+}
 
-export default new PubSub();
+export default new PubSub()
diff --git a/src/subscription/message.js b/src/subscription/message.js
@@ -1 +1 @@
-export const CREATED = 'CREATED';
+export const CREATED = 'CREATED'
diff --git a/src/tests/api.js b/src/tests/api.js
diff --git a/src/tests/user.spec.js b/src/tests/user.spec.js
diff --git a/src/utils/constants.js b/src/utils/constants.js
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ const EventProfile = (sequelize, DataTypes) => {`
`4`	`4`	`const EventProfile = sequelize.define(`
`5`	`5`	`'event_profile',`
`6`	`6`	`{`
`7`		`- id: id(DataTypes)`
	`7`	`+ id: id(DataTypes.UUID)`
`8`	`8`	`}`
`9`	`9`	`)`
`10`	`10`