Merge pull request #556 from UniversityOfHelsinkiCS/trunk

better logging

Author: qzuw

backend/server/controllers/admin.js

@@ -13,17 +13,17 @@ module.exports = {
       const nonActive = await helper.getInactive(req, res)
       const areActive = await helper.getActive(req, res)
       res.render('index', { 
-        title: 'Import courses to Labtool from Kurki', 
-        message1: 'Current and upcoming courses', 
+        title: 'Import courses to Labtool from Kurki',
+        message1: 'Current and upcoming courses',
         submessage1: 'Current and upcoming courses from Kurki which are not yet in Labtool database. Click Import to import course to Labtool.',
         elseMessage1: 'There are no courses in Kurki to import',
         values1: nonActive,
         message2: 'Already imported courses',
-        elseMessage2: 'There are no courses in Labtool.', 
+        elseMessage2: 'There are no courses in Labtool.',
         values2: areActive
       })
     } catch (e) {
-      logger.error(e)
+      logger.error('admin page error', { error: e.message })
 
       res.send('errored in controllers/admin/list')
     }

backend/server/controllers/assistants.js

@@ -72,7 +72,7 @@ module.exports = {
       })
       res.status(200).send(studentInstance)
     } catch (e) {
-      logger.error(e)
+      logger.error('create assistant error', { error: e.message })
     }
   },
 
@@ -83,7 +83,7 @@ module.exports = {
       status: undefined,
       data: undefined
     }
-    let studentInstanceId = undefined
+    let studentInstanceId
 
     try {
       studentInstanceId = req.params.id
@@ -138,7 +138,7 @@ module.exports = {
       })
       res.status(200).send(studentsForThisTeacherInstance)
     } catch (e) {
-      logger.error(e)
+      logger.error('find students by teacher instance error', { error: e.message })
       res.status(400).send(e)
     }
   }

backend/server/controllers/checklists.js

@@ -90,7 +90,7 @@ module.exports = {
         data: req.body
       })
     } catch (e) {
-      logger.error(e)
+      logger.error('checklist creation error', { error: e.message })
       res.status(500).send('Unexpected error')
     }
   },
@@ -122,7 +122,7 @@ module.exports = {
         })
       }
     } catch (e) {
-      logger.error(e)
+      logger.error('get checklist error', { error: e.message })
       res.status(500).send(e)
     }
   }

backend/server/controllers/codeReviews.js

@@ -77,7 +77,7 @@ module.exports = {
         data: req.body
       })
     } catch (e) {
-      logger.error('CodeReview bulk insert failed.\n', e)
+      logger.error('CodeReview bulk insert failed.', { error: e.message })
       res.status(500).send('Unexpected error.')
     }
   },

backend/server/controllers/login.js

@@ -22,7 +22,7 @@ module.exports = {
     try {
       const result = request(options, (err, resp, body) => {
         if (err) {
-          logger.error('\nlogin: ', err, 'n')
+          logger.error('login result error', { error: err.message })
         }
         if (result.response && result.response.body && result.response.body.username && result.response.body.error !== 'wrong credentials') {
           let first
@@ -70,7 +70,7 @@ module.exports = {
         }
       })
     } catch (error) {
-      logger.error(error)
+      logger.error('login error', { error: error.message })
       res.status(500).send({
         error: 'Unexpected error'
       })

backend/server/controllers/tags.js

@@ -52,7 +52,7 @@ module.exports = {
               return
             })
             .catch(error => {
-              logger.error(error)
+              logger.error('tag create/update error', { error: error.message })
               res.status(400).send('color did not update')
               return
             })
@@ -99,16 +99,15 @@ module.exports = {
 
     try {
       return Tag.findAll()
-        .then(tag => {
+        .then((tag) => {
           return res.status(200).send(tag)
         })
-        .catch(error => {
+        .catch((error) => {
           res.status(400).send('et ny saa niitä tageja')
-          logger.error(error)
+          logger.error('tag getall error', { error: error.message })
         })
     } catch (e) {
       res.status(400).send('nymmeni jokin pieleen')
-      return
     }
   },
 
@@ -120,7 +119,7 @@ module.exports = {
           where: {
             userId: req.decoded.id
           }
-        }).then(found => {
+        }).then((found) => {
           if (!found) {
             res.status(400).send('you have to be a teacher to do this')
             return
@@ -129,7 +128,7 @@ module.exports = {
             where: {
               id: req.body.studentId
             }
-          }).then(student => {
+          }).then((student) => {
             if (!student) {
               res.status(404).send('did not found student with that id')
               return
@@ -138,16 +137,16 @@ module.exports = {
               where: {
                 id: req.body.tagId
               }
-            }).then(found => {
-              if (!found) {
+            }).then((foundTag) => {
+              if (!foundTag) {
                 res.status(404).send('did not find a tag with that id')
               }
               StudentTag.findOrCreate({
                 where: {
                   tagId: req.body.tagId,
                   studentInstanceId: req.body.studentId
                 }
-              }).then(studentTag => {
+              }).then((studentTag) => {
                 if (!studentTag) {
                   return res.status(400).send('tagging did not succeed')
                 }
@@ -194,7 +193,7 @@ module.exports = {
                       attributes: ['id', 'name', 'color']
                     }
                   ]
-                }).then(student => {
+                }).then((student) => {
                   return res.status(200).send(student)
                 })
               })

backend/server/controllers/users.js

@@ -30,7 +30,7 @@ module.exports = {
     } else {
       User.update({ email: req.body.email }, { where: { id: req.decoded.id } }).then(
         User.findById(req.decoded.id)
-          .then(user => {
+          .then((user) => {
             const returnedUser = {
               email: req.body.email,
               firsts: user.firsts,
@@ -40,9 +40,9 @@ module.exports = {
             }
             res.status(201).send(returnedUser)
           })
-          .catch(error => {
+          .catch((error) => {
             res.status(400).send(error)
-            logger.error(error)
+            logger.error('user update error', { error: error.message })
           })
       )
     }
@@ -77,7 +77,7 @@ module.exports = {
         })
         res.status(200).send(users)
       } catch (exception) {
-        logger.error(exception)
+        logger.error('user list error', { error: exception.message })
         res.status(400).send('Unable to send user list')
       }
     }

backend/server/controllers/weeks.js

@@ -68,7 +68,7 @@ module.exports = {
         res.status(400).send('token verific ation failed')
       }
     } catch (error) {
-      logger.error('\nweeks, ', error, '\n')
+      logger.error('create weeks error', { error: error.message })
     }
   },
   /**
@@ -82,8 +82,8 @@ module.exports = {
 
     return Week.all()
       .then(ui => res.status(200).send(ui))
-      .catch(error => {
-        logger.error(error)
+      .catch((error) => {
+        logger.error('list weeks error', { error: error.message })
         res.status(400).send(error)
       })
   },
@@ -97,16 +97,16 @@ module.exports = {
     helper.controller_before_auth_check_action(req, res)
 
     return Week.findById(req.params.id, {})
-      .then(week => {
+      .then((week) => {
         if (!week) {
           return res.status(404).send({
             message: 'Teacher Instance not Found'
           })
         }
         return res.status(200).send(week)
       })
-      .catch(error => {
-        logger.error(error)
+      .catch((error) => {
+        logger.error('retrieve weeks error', {error: error.message})
         res.status(400).send(error)
       })
   }

backend/server/helpers/application_helper.js

@@ -240,7 +240,7 @@ async function createCourse(body) {
     }
     return result
   } catch (error) {
-    logger.error(error)
+    logger.error('createCourse error', { error: error.message })
   }
 }
 
@@ -263,7 +263,7 @@ async function getCurrent(req, res) {
       })
     return result
   } catch (error) {
-    logger.error(error)
+    logger.error('getCurrent error', { error: error.message })
   }
 }
 
@@ -286,6 +286,6 @@ async function getNewer(req, res) {
       })
     return result
   } catch (error) {
-    logger.error(error)
+    logger.error('getNewer error', { error: error.message })
   }
 }

backend/server/helpers/course_instance_helper.js

@@ -39,16 +39,16 @@ function checkWebOodi(req, res, user, resolve) {
     try {
       json = JSON.parse(body)
     } catch (e) {
-      logger.error(e)
+      logger.error('checkweboodi error', { error: e.message })
       resolve('notfound')
       return
     }
     if (json.students.find(student => student === user.studentNumber)) {
       resolve('found')
       return
     } else {
-      logger.info(json)
-      logger.info('course registration not found for studentNumber', user.studentNumber)
+//      logger.info(json)
+//      logger.info('course registration not found for studentNumber', user.studentNumber)
       resolve('notfound')
       return
     }
@@ -76,7 +76,7 @@ function findByUserStudentInstance(req, res) {
       .query(`SELECT * FROM "CourseInstances" JOIN "StudentInstances" ON "CourseInstances"."id" = "StudentInstances"."courseInstanceId" WHERE "StudentInstances"."userId" = ${req.decoded.id}`)
       .then(instance => res.status(200).send(instance[0]))
       .catch((error) => {
-        logger.error(error)
+        logger.error('findByUserStudentInstance error', { error: error.message })
         res.status(400).send(error)
       })
   } else {