hapi-campaigns/index.js

campaign tracking

const parseCookie = require('./lib/parseCookie');
const prepareCookie = require('./lib/prepareCookie');

const defaults = {
  cookieName: 'campaigns64',
  cookie: {
    isSecure: false,
    isSameSite: false,
    isHttpOnly: true,
    clearInvalid: true,
    ignoreErrors: true
  },
  ttl: 30 * 86400000 // 30 days
};

const register = function(server, options) {
  const settings = Object.assign({}, defaults, options);
  server.event('campaign');
  const parseCampaign = (request) => {
    let name = false;
    let type = '';
    if (request.query.campaign.indexOf('_') === -1) {
      name = request.query.campaign;
    } else {
      [type, name] = request.query.campaign.split('_');
    }
    return name ? { name, type } : false;
  };

  const parseUTM = (request) => {
    const name = request.query.utm_campaign;
    const type = request.query.utm_medium ? `${request.query.utm_source}_${request.query.utm_medium}` : request.query.utm_source;
    return { name, type };
  };

  const setCampaigns = (request, h) => {
    // if state was not set up then this probably means we are being redirected
    // from http -> https and don't need to respond yet:
    if (!request.state) {
      return;
    }

    let res;
    if (request.query.campaign) {
      res = parseCampaign(request);
    }
    if (request.query.utm_campaign && request.query.utm_source) {
      res = parseUTM(request);
    }

    const now = Date.now();
    const cutoff = now - settings.ttl;
    const currentCookie = request.state[settings.cookieName] || '';
    const campaigns = parseCookie(currentCookie).filter(c => c.timestamp >= cutoff);

    // if there was no campaign query don't set anything:
    if (!res) {
      // if there was a campaigns cookie go ahead and call the event:
      if (campaigns && campaigns.length) {
        server.events.emit('campaign', { request, campaign: campaigns });
      }

      return;
    }

    const name = res.name;
    const type = res.type;
    const existing = campaigns.findIndex(c => (c.name === name && c.type === type));
    if (existing !== -1) {
      campaigns[existing].timestamp = now;
    } else {
      campaigns.push({ name, type, timestamp: now });
    }
    h.state(settings.cookieName, prepareCookie(campaigns), {
      ttl: settings.ttl,
      path: '/',
      isSecure: settings.cookie.isSecure,
      isSameSite: settings.cookie.isSameSite,
      isHttpOnly: settings.cookie.isHttpOnly,
      clearInvalid: settings.cookie.clearInvalid,
      ignoreErrors: settings.cookie.ignoreErrors,
      encoding: 'base64'
    });
    server.events.emit('campaign', { request, campaign: { name, type, timestamp: now } });
  };

  const getCampaigns = function() {
    const now = Date.now();
    const cutoff = now - settings.ttl;
    const currentCookie = this.state[settings.cookieName] || '';
    return parseCookie(currentCookie).filter(c => c.timestamp >= cutoff);
  };

  server.ext('onPreResponse', (request, h) => {
    setCampaigns(request, h);

    return h.continue;
  });

  server.decorate('request', 'getCampaigns', getCampaigns);
  server.decorate('request', 'setCampaigns', setCampaigns);
};

exports.plugin = {
  once: true,
  pkg: require('./package.json'),
  register
};