Ghost/ghost/session-service
Daniel Lockyer 81f566b44a Added codecov.io coverage uploader to CI
refs linear.app/tryghost/issue/CORE-74/improve-the-test-situation

- this commit adds the codecov GitHub Action into CI so we can upload
  coverage reports
- the coverage files need to be in XML for them to work with
  codecov, so this commit also adds cobertura (XML) as a reporter
2021-10-20 11:56:20 +02:00
..
lib Added a CSRF bypass to enable OAuth 2021-05-14 17:38:33 +02:00
test Added a CSRF bypass to enable OAuth 2021-05-14 17:38:33 +02:00
types Added a CSRF bypass to enable OAuth 2021-05-14 17:38:33 +02:00
.eslintignore
.eslintrc.js
index.js
LICENSE 2021 2021-01-25 16:20:43 +00:00
package.json Added codecov.io coverage uploader to CI 2021-10-20 11:56:20 +02:00
README.md Stopped type declaration files from being generated 2021-07-14 11:51:14 +01:00
tsconfig.json Stopped type declaration files from being generated 2021-07-14 11:51:14 +01:00

Session Service

Install

npm install @tryghost/session-service --save

or

yarn add @tryghost/session-service

Usage

const SessionService = require('@tryghost/session-service');

const sessionService = SessionService({
    async getSession(req, res) {
        return new Promise((resolve, reject) => {
            require('express-session')(config)(req, res, (err) => {
                if (err) {
                    reject(err);
                }
                resolve(req.session);
            })
        })
    },
    async findUserById({id}) {
        return UserModel.findUserById(id);
    },
    getOriginOfRequest(req) {
        return req.headers.origin;
    }
});

app.use(async (req, res, next) => {
    try {
        const user = await sessionService.getUserForSession(req, res);
        req.user = user;
        next();
    } catch (err) {
        next(err);
    }
});

app.post('/login', async (req, res) => {
    try {
        const user = await UserModel.verify(req.body);
        await sessionService.createSessionForUser(req, res, user);
        res.redirect('/home');
    } catch (err) {
        return next(err);
    }
});

app.post('/logout', async (req, res) => {
   try {
        await sessionService.destroyCurrentSession(req, res);
        res.redirect('/login');
    } catch (err) {
        return next(err);
    }
});

Develop

This is a mono repository, managed with lerna.

Follow the instructions for the top-level repo.

  1. git clone this repo & cd into it as usual
  2. Run yarn to install top-level dependencies.

Test

  • yarn lint run just eslint
  • yarn test run lint and tests and type check

Copyright & License

Copyright (c) 2013-2021 Ghost Foundation - Released under the MIT license.