custom-badges.js

Filename	Percent	Threshold	Total	Covered	Uncovered
plugins/custom-badges.js	96.67%	80%	210	203	7

//@ts-check
import { clone, find, first, get, includes, isEmpty, keys,
  unset, upperFirst } from 'lodash-es';
import * as utils from '../src/utils.js';
import axios from 'axios';

/**
 * @typedef {import('@gitbeaker/rest').ProjectBadgeSchema} ProjectBadgeSchema
 */

const service = 'custom-badges';

/**
 * @param  {Plugins.CustomBadgeConfig} badge
 * @param  {'image_url'|'link_url'} name
 * @param  {any} placeholders
 */
async function checkLink(badge, name, placeholders) {
  if (includes(badge.no_check, name)) {
    return;
  }
  return axios.get(utils.format(badge[name] || '', placeholders, false));
}

/**
 * @param  {GitConfig.Env} env
 * @param  {GitConfig.$ProjectSchema} project
 * @param  {any} placeholders
 * @param  {GitConfig.$BadgeSchema[]} projectBadges
 * @param  {{ [key:string]: Plugins.CustomBadgeConfig}} badges
 * @return {Promise<void>}
 */
async function checkBadges(env, project, placeholders, projectBadges, badges) {
  if (isEmpty(badges)) {
    return;
  }

  var name = /** @type {string} */ (first(keys(badges)));
  const msg = `${upperFirst(service)} ${name}`;
  var badge = badges[name];
  unset(badges, name);

  var current = find(projectBadges, { image_url: badge.image_url });

  env.spin.start(`Checking for badge ${name}: ${project.name}`);
  await Promise.all([
    checkLink(badge, 'image_url', placeholders),
    checkLink(badge, 'link_url', placeholders)
  ])
  .then(
    async () => {
      if (current && (current.link_url === badge.link_url)) {
        env.spin.debug(`${msg} already displayed: ${project.name}`);
      }
      else if (env.opts.dryRun) {
        env.spin.warn(`${msg} update required: ${project.name}`);
      }
      else if (current) {
        await env.gitlab.ProjectBadges.edit(project.id, current.id,
          { imageUrl: badge.image_url, linkUrl: badge.link_url });
        env.spin.succeed(`${msg} updated: ${project.name}`);
      }
      else {
        await env.gitlab.ProjectBadges.add(project.id, badge.link_url, badge.image_url);
        env.spin.succeed(`${msg} added: ${project.name}`);
      }
    },
    async (err) => {
      if (current) {
        if (env.opts.dryRun) {
          env.spin.warn(`${msg} removal required: ${project.name}`);
        }
        else {
          await env.gitlab.ProjectBadges.remove(project.id, current.id);
          env.spin.succeed(`${msg} removed: ${project.name}`);
        }
      }
      else {
        env.spin.debug(`${msg} not needed: ${project.name} (${err})`);
      }
    });
  return checkBadges(env, project, placeholders, projectBadges, badges);
}

/**
 * @param  {GitConfig.Env} env
 * @param  {GitConfig.$ProjectSchema} project
 * @param  {GitConfig.Settings} settings
 */
async function update(env, project, settings) {
  if (utils.isIgnored(env, project, settings, upperFirst(service))) {
    return;
  }

  var placeholders = {
    project_path: project.path_with_namespace,
    project_id: project.id,
    commit_sha: project.default_branch,
    default_branch: project.default_branch
  };
  env.spin.start(`Fetching pipeline-badge config: ${project.name}`);
  const badges = /** @type {ProjectBadgeSchema[]} */ (await env.gitlab.ProjectBadges.all(project.id));
  return checkBadges(env, project, placeholders, badges, clone(get(settings, 'config.badges')) || []);
}

export default update;

[{"file":"plugins/custom-badges.js","line":17,"character":38,"text":"placeholders","kind":1},{"file":"plugins/custom-badges.js","line":32,"character":41,"text":"placeholders","kind":1},{"file":"plugins/custom-badges.js","line":46,"character":34,"text":"placeholders","kind":1},{"file":"plugins/custom-badges.js","line":47,"character":33,"text":"placeholders","kind":1},{"file":"plugins/custom-badges.js","line":67,"character":11,"text":"err","kind":1},{"file":"plugins/custom-badges.js","line":78,"character":62,"text":"err","kind":1},{"file":"plugins/custom-badges.js","line":81,"character":35,"text":"placeholders","kind":1}]

TypeScript coverage report