ci-fetch.js

Filename	Percent	Threshold	Total	Covered	Uncovered
src/ci-fetch.js	88.48%	80%	269	238	31

//@ts-check
import { assign, clone, get, has, isString, map, mapValues, omitBy, set,
  startsWith, unset } from 'lodash-es';
import axios from 'axios';
import yaml from 'js-yaml';

var globalCache = {};

/* parse additional gitlab types: !reference ["..."] */
class Reference {
  /**
   * @param {string[]} ref
   */
  constructor(ref) {
    this.ref = ref;
  }

  get [Symbol.toStringTag]() {return  'Reference'; }
}

const ReferenceType = new yaml.Type('!reference', {
  kind: 'sequence',
  construct(data) { return new Reference(data); },
  instanceOf: Reference
});
const schema = yaml.DEFAULT_SCHEMA.extend(ReferenceType);

/**
 * @param {any} config
 * @param {string} name
 */
function ciResolve(config, name) {
  var job = get(config, name);
  if (has(job, 'extends') && has(config, job.extends)) {
    job = assign({}, ciResolve(config, job.extends), job);
    unset(job, 'extends');
    config[name] = job;
  }
  return job;
}

/**
 * @param {GitConfig.Env} env
 * @param {GitConfig.$ProjectSchema} project
 * @param {string} url
 * @param {{ [key:string]: any }} cache
 * @details local or remote includes
 */
async function ciFetchSingle(env, project, url, cache) {
  var ret;
  if (has(cache, [ url ])) {
    return cache[url];
  }
  else if (startsWith(url, 'http')) {
    ret = yaml.load((await axios.get(url)).data, { schema });
  }
  else {
    // type issue in gitbeaker typescript
    /** @type {string} */
    ret = yaml.load(/** @type {any} */ (await env.gitlab.RepositoryFiles.showRaw(
      project.id, url, get(project, 'default_branch'))), { schema });
  }

  const includes = await Promise.all(
    map(get(ret, 'include'), (inc) => ciFetch(env, project, inc, cache)));

  /** @type {any} */
  ret = assign({}, ...includes, ret);
  unset(ret, 'include'); /* now resolved */
  set(cache, [ url ], ret);
  return ret;
}

/**
 * @param {GitConfig.Env} env
 * @param {GitConfig.$ProjectSchema} project
 * @param {{ file: string|string[], project?: string, ref?: string }} inc
 * @param {{ [key:string]: any }} cache
 */
async function ciFetchProjects(env, project, inc, cache) {
  const file = inc.file;
  const path = /** @type {string|number} */ (inc.project);
  const ref = inc.ref ?? 'HEAD';

  const remoteProject = /** @type {GitConfig.$ProjectSchema} */
    (await env.gitlab.Projects.show(path));

  const files = await Promise.all(map(isString(file) ? [ file ] : file, async (file) => {
    const uri = `project://${remoteProject.id}:${file}@${ref}`;
    if (has(cache, [ uri ])) {
      return cache[uri];
    }
    const raw = /** @type {any} */ (await env.gitlab.RepositoryFiles.showRaw(
      remoteProject.id, file, ref));
    var ret = yaml.load(raw, { schema });
    const includes = await Promise.all(map(get(ret, 'include'),
      (inc) => ciFetch(env, remoteProject, inc, cache)));
    ret = assign({}, ...includes, ret);
    unset(ret, 'include'); /* now resolved */
    set(cache, [ uri ], ret);
    return ret;
  }));
  return assign({}, ...files);
}

/**
 * @param {GitConfig.Env} env
 * @param {GitConfig.$ProjectSchema} project
 * @param {string} url
 * @param {{ [key:string]: any }} cache
 * @return {Promise<{ [key:string]: any }>}
 */
export async function ciFetch(env, project, url, cache) {
  /** @type {any[]} */
  if (!isString(url)) {
    if (has(url, 'remote')) {
      return ciFetchSingle(env, project, get(url, 'remote'), cache);
    }
    else if (has(url, 'local')) {
      return ciFetchSingle(env, project, get(url, 'local'), cache);
    }
    else if (has(url, 'project')) {
      return ciFetchProjects(env, project, url, cache);
    }
    else {
      env.spin.warn(`unsupported include in gitlab-ci file: ${project.name}`);
      return {};
    }
  }
  else {
    return ciFetchSingle(env, project, url, cache);
  }
}

/**
 * @param {GitConfig.Env} env
 * @param {GitConfig.$ProjectSchema} project
 */
async function loadGitlabCi(env, project) {
  var localCache = clone(globalCache);
  return ciFetch(env, project, '.gitlab-ci.yml', localCache)
  .then((config) => mapValues(config, (v, name) => ciResolve(config, name)))
  .then((ret) => {
    globalCache = omitBy(localCache,
      (v, k) => !startsWith(k, 'http') && !startsWith(k, 'project'));
    return ret;
  });
}

export default loadGitlabCi;

[{"file":"src/ci-fetch.js","line":14,"character":9,"text":"ref","kind":1},{"file":"src/ci-fetch.js","line":22,"character":12,"text":"data","kind":1},{"file":"src/ci-fetch.js","line":31,"character":19,"text":"config","kind":1},{"file":"src/ci-fetch.js","line":32,"character":6,"text":"job","kind":1},{"file":"src/ci-fetch.js","line":32,"character":16,"text":"config","kind":1},{"file":"src/ci-fetch.js","line":33,"character":10,"text":"job","kind":1},{"file":"src/ci-fetch.js","line":33,"character":33,"text":"config","kind":1},{"file":"src/ci-fetch.js","line":33,"character":41,"text":"job","kind":1},{"file":"src/ci-fetch.js","line":33,"character":45,"text":"extends","kind":1},{"file":"src/ci-fetch.js","line":34,"character":4,"text":"job","kind":1},{"file":"src/ci-fetch.js","line":34,"character":31,"text":"config","kind":1},{"file":"src/ci-fetch.js","line":34,"character":39,"text":"job","kind":1},{"file":"src/ci-fetch.js","line":34,"character":43,"text":"extends","kind":1},{"file":"src/ci-fetch.js","line":34,"character":53,"text":"job","kind":1},{"file":"src/ci-fetch.js","line":35,"character":10,"text":"job","kind":1},{"file":"src/ci-fetch.js","line":36,"character":4,"text":"config","kind":1},{"file":"src/ci-fetch.js","line":36,"character":19,"text":"job","kind":1},{"file":"src/ci-fetch.js","line":38,"character":9,"text":"job","kind":1},{"file":"src/ci-fetch.js","line":49,"character":6,"text":"ret","kind":1},{"file":"src/ci-fetch.js","line":54,"character":4,"text":"ret","kind":1},{"file":"src/ci-fetch.js","line":54,"character":43,"text":"data","kind":1},{"file":"src/ci-fetch.js","line":59,"character":4,"text":"ret","kind":1},{"file":"src/ci-fetch.js","line":64,"character":30,"text":"inc","kind":1},{"file":"src/ci-fetch.js","line":67,"character":2,"text":"ret","kind":1},{"file":"src/ci-fetch.js","line":68,"character":8,"text":"ret","kind":1},{"file":"src/ci-fetch.js","line":69,"character":22,"text":"ret","kind":1},{"file":"src/ci-fetch.js","line":70,"character":9,"text":"ret","kind":1},{"file":"src/ci-fetch.js","line":92,"character":10,"text":"raw","kind":1},{"file":"src/ci-fetch.js","line":96,"character":7,"text":"inc","kind":1},{"file":"src/ci-fetch.js","line":141,"character":39,"text":"v","kind":1},{"file":"src/ci-fetch.js","line":144,"character":7,"text":"v","kind":1}]

TypeScript coverage report