Merge pull request #342 from KTH/issues/KUI-1776-user-friendly-error-handling

fix(KUI-1776): end-user-frindly-error-messages

Author: Flippeen

i18n/messages.en.js

@@ -132,5 +132,8 @@ module.exports = {
     round_type: 'Type of round',
     round_time_slots: 'Planned timeslots',
     round_application_link: 'Application link'
-  }
+  },
+  syllabusErrorMessages: {
+    syllabus_fetching_error: ({ code, semester, time_stamp }) => `Could not create syllabus for ${code}-${semester}. Time: ${time_stamp}. Please try again later and contact IT support with this error message if the problem persists.`,
+  },
 }

i18n/messages.se.js

@@ -1,5 +1,5 @@
 module.exports = {
-  shortNames: [ 'sv', 'se' ],
+  shortNames: ['sv', 'se'],
   longNameSe: 'Svenska',
   longNameEn: 'Swedish',
   messages: {
@@ -131,6 +131,8 @@ module.exports = {
     round_application_link: 'Anmälningslänk',
     round_type: 'Typ av kurstillfälle',
     round_time_slots: 'Planerade moduler'
-  }
-
+  },
+  syllabusErrorMessages: {
+    syllabus_fetching_error: ({ code, semester, time_stamp }) => `Kunde inte skapa kursplan för ${code}-${semester}. Tidpunkt: ${time_stamp}. Försök igen om ett tag och kontakta IT-support med detta felmeddelande om problemet kvarstår.`,
+  },
 }

server/controllers/pdfCtrl.js

@@ -2,6 +2,7 @@
 
 const log = require('@kth/log')
 
+const i18n = require('../../i18n')
 const { getLadokSyllabus } = require('../ladokApi')
 const { createPdf } = require('../libs/pdfRenderer.js')
 
@@ -21,7 +22,7 @@ async function _getSyllabus(req, res, next) {
   try {
     const syllabus = await getLadokSyllabus(courseCode, semester, language)
 
-    if (syllabus == null) {
+    if (!syllabus) {
       log.debug(`Could not get a syllabus for ${courseCode}, ${semester}, ${language}.`)
       res.sendStatus(404)
       return
@@ -43,7 +44,11 @@ async function _getSyllabus(req, res, next) {
     )
   } catch (err) {
     log.error('getSyllabus: Failed request for PDF, error:', { err })
-    next(err)
+    const languageIndex = language === 'en' ? 0 : 1
+    const status = err.response?.status || 500
+    const message = i18n.messages[languageIndex].syllabusErrorMessages.syllabus_fetching_error({ code: courseCode, semester, time_stamp: new Date().toISOString() })
+    const error = new Error(`${status}: ${message}`)
+    next(error)
   }
 }
 

server/ladokApi.js

@@ -1,15 +1,15 @@
 'use strict'
 
+const i18n = require('../i18n')
+
 const { createApiClient } = require('@kth/om-kursen-ladok-client')
 const { server: serverConfig } = require('./configuration')
 
 const client = createApiClient(serverConfig.ladokMellanlagerApi)
 
 async function getLadokSyllabus(courseCode, semester, lang) {
   try {
-    const course = await client.getCourseSyllabus(courseCode, semester, lang)
-
-    return course
+    return client.getCourseSyllabus(courseCode, semester, lang)
   } catch (error) {
     throw new Error(error.message)
   }