GPAP Cloud JS

Helper utilities for server-side JS, particularly in the cloud.

Examples

Reading environment variables:

// throws if YOUR_ENVIRONMENT_VAR isn't set:
const myVar = env.get('YOUR_ENVIRONMENT_VAR')

Logging

Log via a Winston transport:

logger.error('Failed to do ___ while processing request', { err, req });

If you're running on GCP, this will log via Stackdriver. If you're running locally with NODE_ENV=development, it will pretty-print on your console. If you're running tests (NODE_ENV=test), logs go to a local test file (./tests.log or the value of env.LOG_FILE).

Note that passing the request (req) as above allows grouping log entries in Stackdriver.

Or maybe you want to log requests via Morgan:

// app.js:
const { requestLogMiddleware } = require('@gp-australia-pacific/gpap-cloud-js');

// Setup request logging
app.use(requestLogMiddleware);

Checking your runtime environment

const { isRunningOnGCloud } = require('@gp-australia-pacific/gpap-cloud-js');

// Determines whether we are running on GCloud:
if (isRunningOnGCloud()) {
  logger.debug('we are on the Google Cloud');
}

Development Info

This project was bootstrapped with TSDX.

Local Development

Below is a list of commands you will probably find useful.

npm start or yarn start

Runs the project in development/watch mode. Your project will be rebuilt upon changes. TSDX has a special logger for you convenience. Error messages are pretty printed and formatted for compatibility VS Code's Problems tab.

Your library will be rebuilt if you make edits.

npm run build or yarn build

Bundles the package to the dist folder. The package is optimized and bundled with Rollup into multiple formats (CommonJS, UMD, and ES Module).

npm test or yarn test

Runs the test watcher (Jest) in an interactive mode. By default, runs tests related to files changed since the last commit.