Method checkIds

grunt/helpers/data/Language.js:181–237

@returns {Language}

()

  /** @returns {Language} */
  checkIds() {
    const items = this.getAllFileItems().map(({ item }) => item);
    // Index and group
    const idIndex = _.keyBy(items, '_id');
    const idGroups = _.groupBy(items, '_id');
    const parentIdGroups = _.groupBy(items, '_parentId');
    // Setup error collection arrays
    let orphanedIds = {};
    let emptyIds = {};
    let duplicateIds = {};
    let missingIds = {};
    items.forEach((o) => {
      const isCourseType = (o._type === 'course');
      const isComponentType = (o._type === 'component');
      if (idGroups[o._id].length > 1) {
        duplicateIds[o._id] = true; // Id has more than one item
      }
      if (!isComponentType && !parentIdGroups[o._id]) {
        emptyIds[o._id] = true; // Course has no children
      }
      if (!isCourseType && (!o._parentId || !idIndex[o._parentId])) {
        orphanedIds[o._id] = o._type; // Item has no defined parent id or the parent id doesn't exist
      }
      if (!isCourseType && o._parentId && !idIndex[o._parentId]) {
        missingIds[o._parentId] = o._type; // Referenced parent item does not exist
      }
    });
    const orphanedIdsArray = Object.keys(orphanedIds);
    const missingIdsArray = Object.keys(missingIds);
    emptyIds = Object.keys(emptyIds);
    duplicateIds = Object.keys(duplicateIds);
    // Output for each type of error
    const hasErrored = orphanedIdsArray.length || emptyIds.length || duplicateIds.length || missingIdsArray.length;
    if (orphanedIdsArray.length) {
      const orphanedIdString = orphanedIdsArray.map((id) => `${id} (${orphanedIds[id]})`);
      this.log(chalk.yellow(`Orphaned _ids: ${orphanedIdString.join(', ')}`));
    }
    if (missingIdsArray.length) {
      const missingIdString = missingIdsArray.map((id) => `${id} (${missingIds[id]})`);
      this.log(chalk.yellow(`Missing _ids: ${missingIdString.join(', ')}`));
    }
    if (emptyIds.length) {
      this.log(chalk.yellow(`Empty _ids: ${emptyIds}`));
    }
    if (duplicateIds.length) {
      this.log(chalk.yellow(`Duplicate _ids: ${duplicateIds}`));
    }
    // If any error has occured, stop processing.
    if (hasErrored) {
      const err = new Error('Oops, looks like you have some json errors.');
      err.number = 10011;
      throw err;
    }
    this.log(`No issues found in course/${this.name}, your JSON is a-ok!`);

    return this;
  }