* refactor(routes): remove unused sitemap route * style(comments): enforce consistent comment style * style(exports): enforce consistent export style * chore: Add jsDoc for contentful service * chore: Add jsDoc for contentful service \n \n closes #23 * refactor(app): move query parameter comment to right position and mention comment route middleware * test(npm): add temporary test script * refactor(middlewares): split up bootstrap middleware - fixes #23759 * refactor(cookies): use constances to give context the maxAge cookie setting * refactor(variables): use more descriptive names for variables * space became spaceId when it was just the id not the full space instance * all (access) token variable name variants became [api-type]Token * all clients are now called deliveryClient or previewClient * cpa and cda only remain when they are used as actual API id * env variables names adjusted * perf(helpers): only run marked when content is not empty * refactor(comments): fix typos * refactor(comments): add hint why error is logged to console in settings * chore: Add comments to routes and services * refactor(requires): order and group requires * fix(settings): add validation for wrong preview token * chore: Add comments to routes * chore: fix typo * chore: console.error -> throw * chore: move cookie name to a constant * chore: Fix app.js comment * typo: removing t * chore: typos * chore: removed unnecessary comment line sign * chore: newline for readabillity * chore: remove dangling `t` * chore: remove `t`, add `l` * chore: typos * Fleshed out title * build(npm): remove unused dependencies * build(npm): upgrade to latest stable contentful sdk * chore: Addressing David feedbak * fix(credentials): update to match the new space * chore: Addressing code review comments * chore: Addressing code review comments * chore: res -> response, req-> request * chore: include exactly what we need * chore: Address JPs comments * chore: Address JPs comments * chore: Address Fredericks comments * chore: Address Fredericks comments * fixup! chore: Address Fredericks comments * fixup! fixup! chore: Address Fredericks comments * fixup! fixup! fixup! chore: Address Fredericks comments * fixup! fixup! fixup! fixup! chore: Address Fredericks comments * fixup! fixup! fixup! fixup! fixup! chore: Address Fredericks comments * fixup! fixup! fixup! fixup! fixup! fixup! chore: Address Fredericks comments
142 lines
4.7 KiB
JavaScript
142 lines
4.7 KiB
JavaScript
/*
|
|
* The purpose of this module is to render the category page when the route is requested
|
|
*/
|
|
|
|
const {
|
|
getCourses,
|
|
getCourse,
|
|
getCategories,
|
|
getCoursesByCategory
|
|
} = require('./../services/contentful')
|
|
|
|
const attachEntryState = require('../lib/entry-state')
|
|
const { updateCookie } = require('../lib/cookies')
|
|
|
|
/**
|
|
* Renders courses list when `/courses` route is requested
|
|
*
|
|
* @param request - Object - Express request object
|
|
* @param response - Object - Express response object
|
|
* @param next - Function - express callback
|
|
*
|
|
* @returns {undefined}
|
|
*/
|
|
module.exports.getCourses = async (request, response, next) => {
|
|
// Get all the entries of content type course
|
|
let courses = []
|
|
let categories = []
|
|
courses = await getCourses(response.locals.currentLocale.code, response.locals.currentApi.id)
|
|
|
|
// Attach entry state flags when using preview API
|
|
if (response.locals.settings.editorialFeatures && response.locals.currentApi.id === 'cpa') {
|
|
courses = await Promise.all(courses.map(attachEntryState))
|
|
}
|
|
|
|
categories = await getCategories(response.locals.currentLocale.code, response.locals.currentApi.id)
|
|
response.render('courses', { title: `All Courses (${courses.length})`, categories, courses })
|
|
}
|
|
|
|
/**
|
|
* Renders a course when `/courses/:slug` route is requested
|
|
*
|
|
* @param request - Object - Express request object
|
|
* @param response - Object - Express response object
|
|
* @param next - Function - express callback
|
|
*
|
|
* @returns {undefined}
|
|
*/
|
|
module.exports.getCourse = async (request, response, next) => {
|
|
let course = await getCourse(request.params.slug, response.locals.currentLocale.code, response.locals.currentApi.id)
|
|
|
|
// Get lessons
|
|
const lessons = course.fields.lessons
|
|
let {lesson, lessonIndex} = getNextLesson(lessons, request.params.lslug)
|
|
|
|
// Manage state of viewed lessons
|
|
const cookie = request.cookies.visitedLessons
|
|
let visitedLessons = cookie || []
|
|
visitedLessons.push(course.sys.id)
|
|
visitedLessons = [...new Set(visitedLessons)]
|
|
updateCookie(response, 'visitedLessons', visitedLessons)
|
|
|
|
// Attach entry state flags when using preview API
|
|
if (response.locals.settings.editorialFeatures && response.locals.currentApi.id === 'cpa') {
|
|
course = await attachEntryState(course)
|
|
}
|
|
|
|
response.render('course', {title: course.fields.title, course, lesson, lessons, lessonIndex, visitedLessons})
|
|
}
|
|
|
|
/**
|
|
* Renders a courses list by a category when `/courses/category/:category` route is requested
|
|
*
|
|
* @param request - Object - Express request object
|
|
* @param response - Object - Express response object
|
|
* @param next - Function - Express callback
|
|
*
|
|
* @returns {undefined}
|
|
*/
|
|
module.exports.getCoursesByCategory = async (request, response, next) => {
|
|
// We get all the entries with the content type `course` filtered by a category
|
|
let courses = []
|
|
let categories = []
|
|
let activeCategory = ''
|
|
try {
|
|
categories = await getCategories()
|
|
activeCategory = categories.find((category) => category.fields.slug === request.params.category)
|
|
courses = await getCoursesByCategory(activeCategory.sys.id, response.locals.currentLocale.code, response.locals.currentApi.id)
|
|
} catch (e) {
|
|
console.log('Error ', e)
|
|
}
|
|
response.render('courses', { title: `${activeCategory.fields.title} (${courses.length})`, categories, courses })
|
|
}
|
|
|
|
/**
|
|
* Renders a lesson details when `/courses/:courseSlug/lessons/:lessonSlug` route is requested
|
|
*
|
|
* @param request - Object - Express request object
|
|
* @param response - Object - Express response object
|
|
* @param next - Function - express callback
|
|
*
|
|
* @returns {undefined}
|
|
*/
|
|
module.exports.getLesson = async (request, response, next) => {
|
|
let course = await getCourse(request.params.cslug, response.locals.currentLocale.code, response.locals.currentApi.id)
|
|
|
|
const lessons = course.fields.lessons
|
|
let {lesson, nextLesson} = getNextLesson(lessons, request.params.lslug)
|
|
|
|
// Save visited lessons
|
|
const cookie = request.cookies.visitedLessons
|
|
let visitedLessons = cookie || []
|
|
visitedLessons.push(lesson.sys.id)
|
|
visitedLessons = [...new Set(visitedLessons)]
|
|
updateCookie(response, 'visitedLessons', visitedLessons)
|
|
|
|
// Attach entry state flags when using preview API
|
|
if (response.locals.settings.editorialFeatures && response.locals.currentApi.id === 'cpa') {
|
|
lesson = await attachEntryState(lesson)
|
|
}
|
|
|
|
response.render('course', {
|
|
title: `${course.fields.title} | ${lesson.fields.title}`,
|
|
course,
|
|
lesson,
|
|
lessons,
|
|
nextLesson,
|
|
visitedLessons
|
|
})
|
|
}
|
|
|
|
function getNextLesson (lessons, lslug) {
|
|
const lessonIndex = lessons.findIndex((lesson) => lesson.fields.slug === lslug)
|
|
let lesson = lessons[lessonIndex]
|
|
const nextLesson = lessons[lessonIndex + 1] || null
|
|
|
|
return {
|
|
lessonIndex,
|
|
lesson,
|
|
nextLesson
|
|
}
|
|
}
|