devotis💐 Bouquet
A bouquet of little functions, wrappers and libraries that I use across projects and clients
Install
yarn add @devotis/bouquet (or npm)
Usage
mssql
Functions to connect to and query SQL Server using node-mssql as a dependency.
const {
connect,
query,
close,
all,
one,
tag,
cp, // the connection pool for raw usage with for example:
mssql, // const request = new mssql.Request(cp);
} = require('@devotis/bouquet').mssql;pg
Functions to execute queries as a role and local settings from the Express request object.
With postgraphile as middleware
const express = require('express');
const {
connect,
setupPostgraphile,
errorHandling,
startServer,
getRedisStore,
} = require('@devotis/bouquet').express;
const server = express();
const poolPg = connect();
const isSecureCookie = process.env.NODE_ENV === 'production';
const ONE_MONTH = 31 * 24 * 60 * 60 * 1000;
server.use(
session({
name: 'session',
store: getRedisStore(),
secret: process.env.SESSION_SECRET,
resave: false,
saveUninitialized: true,
proxy: isSecureCookie, // needed when behind a reverse proxy for secure cookies
cookie: {
path: '/',
httpOnly: true,
secure: isSecureCookie,
maxAge: ONE_MONTH,
},
})
);
// ...
setupPostgraphile(server, {
pool: poolPg,
schemaName: 'app',
mountPath: '/api/postgraphile',
reqParts: ['headers', 'user', 'query', 'session', 'method', 'fullUrl'],
getRole: (req) => `app_${req.user ? req.user.roleName : 'anonymous'}`,
defaultSettings: {
application_name: 'bouquet',
timezone: 'Europe/Amsterdam',
},
});
// ...
setupErrorHandling(server);
setupStartServer(server);Without postgraphile
You can query as a role with local settings without postgraphile as well.
const express = require('express');
const { sql, queryWithContext } = require('@devotis/bouquet').pg;
// ...
const routeHandler = async (req, res, next) => {
const result = await queryWithContext(
req,
(reqParts = [
'headers',
'user',
'query',
'session',
'method',
'fullUrl',
]),
(req) => `app_${req.user ? req.user.roleName : 'anonymous'}`,
{
application_name: 'bouquet',
timezone: 'Europe/Amsterdam',
},
sql`
select t.*
from app.my_table t
where t.id = ${req.params.id}
and t.creator_id = current_setting('request.user.id', true)
`
);
res.json(result);
};express
Functions and middleware to be used with Express.
const {
getRemoteAddress,
ensureAuthenticated,
ensureCsrfProtected,
ensureNocache,
ensureTraceProtected,
setupStartServer,
setupErrorHandling,
} = require('@devotis/bouquet').express;logger
All same as the logfmt based heroku-logger, but allows logging an error object along with context-specific error message (issues) and the express req object
const logger = require('@devotis/bouquet').logger;
const error = new Error('x');
logger.error(error);
logger.error(error, { some, additional, info });
logger.error(error, req); // req is the express req object.
logger.error('Custom error message', error);
logger.error('Custom error message', error, { some, additional, info });
logger.error('Custom error message', error, req);
// Also log a few bits of info on the req object
logger.info('Some message', req);
// Log a lot of information on the req object
logger.debug('Some message', req);mailjet
const { connect, send } = require('@devotis/bouquet').mailjet;
connect();
await sendJetEmail({
to: 'someone@example.com',,
// bcc,
data: { some data },
TemplateID: <Mailjet Template ID number>,
});