@hubspot/cms-lib/personalAccessKey.js

const open = require('open');
const moment = require('moment');
const {
  promptUser,
  PERSONAL_ACCESS_KEY_FLOW,
  PERSONAL_ACCESS_KEY,
} = require('@hubspot/cms-cli/lib/prompts');

const { HubSpotAuthError } = require('@hubspot/api-auth-lib/Errors');
const {
  getEnv,
  getPortalId,
  getPortalConfig,
  updatePortalConfig,
  updateDefaultPortal,
} = require('./lib/config');
const {
  DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME,
  PERSONAL_ACCESS_KEY_AUTH_METHOD,
} = require('./lib/constants');
const { logger } = require('./logger');
const { fetchAccessToken } = require('./api/localDevAuth');

const refreshRequests = new Map();

function getRefreshKey(personalAccessKey, expiration) {
  return `${personalAccessKey}-${expiration || 'fresh'}`;
}

async function getAccessToken(personalAccessKey, env = 'PROD') {
  let response;
  try {
    response = await fetchAccessToken(personalAccessKey, env);
  } catch (e) {
    if (e.response) {
      const errorOutput = `Error while retrieving new access token: ${e.response.body.message}.`;
      if (e.response.statusCode === 401) {
        throw new HubSpotAuthError(
          `${errorOutput} \nYour personal CMS access key is invalid. Please run "hs auth personalaccesskey" to reauthenticate. See https://designers.hubspot.com/docs/personal-access-keys for more information.`
        );
      } else {
        throw new HubSpotAuthError(errorOutput);
      }
    } else {
      throw e;
    }
  }
  return {
    portalId: response.hubId,
    accessToken: response.oauthAccessToken,
    expiresAt: moment(response.expiresAtMillis),
    scopeGroups: response.scopeGroups,
    encodedOauthRefreshToken: response.encodedOauthRefreshToken,
  };
}

async function refreshAccessToken(personalAccessKey, env = 'PROD') {
  const { accessToken, expiresAt, portalId } = await getAccessToken(
    personalAccessKey,
    env
  );
  const config = getPortalConfig(portalId);

  updatePortalConfig({
    ...config,
    portalId,
    tokenInfo: {
      accessToken,
      expiresAt: expiresAt.toISOString(),
    },
  });

  return accessToken;
}

async function getNewAccessToken(personalAccessKey, expiresAt, env) {
  const key = getRefreshKey(personalAccessKey, expiresAt);
  if (refreshRequests.has(key)) {
    return refreshRequests.get(key);
  }
  let accessToken;
  try {
    const refreshAccessPromise = refreshAccessToken(personalAccessKey, env);
    if (key) {
      refreshRequests.set(key, refreshAccessPromise);
    }
    accessToken = await refreshAccessPromise;
  } catch (e) {
    if (key) {
      refreshRequests.delete(key);
    }
    throw e;
  }
  return accessToken;
}

async function accessTokenForPersonalAccessKey(portalId) {
  const { auth, personalAccessKey, env } = getPortalConfig(portalId);
  const authTokenInfo = auth && auth.tokenInfo;
  const authDataExists = authTokenInfo && auth.tokenInfo.accessToken;

  if (
    !authDataExists ||
    moment()
      .add(30, 'minutes')
      .isAfter(moment(authTokenInfo.expiresAt))
  ) {
    return getNewAccessToken(
      personalAccessKey,
      authTokenInfo && authTokenInfo.expiresAt,
      env
    );
  }

  return auth.tokenInfo.accessToken;
}

/**
 * Prompts user for portal name, then opens their browser to the shortlink to personal-access-key
 */
const personalAccessKeyPrompt = async () => {
  const { name } = await promptUser(PERSONAL_ACCESS_KEY_FLOW);
  const portalId = getPortalId(name);
  const env = getEnv(name);
  if (portalId) {
    open(
      `https://app.hubspot${
        env === 'QA' ? 'qa' : ''
      }.com/personal-access-key/${portalId}`
    );
  } else {
    open(
      `https://app.hubspot${env === 'QA' ? 'qa' : ''}.com/l/personal-access-key`
    );
  }
  const { personalAccessKey } = await promptUser(PERSONAL_ACCESS_KEY);

  return {
    personalAccessKey,
    name,
  };
};

/**
 * Adds a portal to the config using authType: personalAccessKey
 *
 * @param {object} configData Data containing personalAccessKey and name properties
 * @param {string} configData.personalAccessKey Personal access key string to place in config
 * @param {string} configData.name Unique name to identify this config entry
 * @param {boolean} makeDefault option to make the portal being added to the config the default portal
 */
const updateConfigWithPersonalAccessKey = async (configData, makeDefault) => {
  const { personalAccessKey, name } = configData;

  const { portalId, accessToken, expiresAt } = await getAccessToken(
    personalAccessKey,
    getEnv(name)
  );

  updatePortalConfig({
    portalId,
    personalAccessKey,
    name,
    authType: PERSONAL_ACCESS_KEY_AUTH_METHOD.value,
    tokenInfo: { accessToken, expiresAt },
  });

  if (makeDefault) {
    updateDefaultPortal(name);
  }

  logger.log(
    `Success: ${DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME} created with ${PERSONAL_ACCESS_KEY_AUTH_METHOD.name}.`
  );
};

module.exports = {
  accessTokenForPersonalAccessKey,
  personalAccessKeyPrompt,
  updateConfigWithPersonalAccessKey,
};