igir/dist/src/modules/candidates/candidateValidator.js

🕹 A zero-setup ROM collection manager that sorts, filters, extracts or archives, patches, and reports on collections of any size on any OS.

import { ProgressBarSymbol } from '../../console/progressBar.js';
import ArrayPoly from '../../polyfill/arrayPoly.js';
import Module from '../module.js';
/**
 * Validate candidates for write-ability after all generation and filtering has happened.
 */
export default class CandidateValidator extends Module {
    options;
    constructor(options, progressBar) {
        super(progressBar, CandidateValidator.name);
        this.options = options;
    }
    /**
     * Validate the {@link WriteCandidate}s.
     */
    validate(dat, candidates) {
        if (!this.options.shouldWrite()) {
            // No need to validate, we're not writing
            return [];
        }
        if (candidates.length === 0) {
            this.progressBar.logTrace(`${dat.getName()}: no candidates to validate`);
            return [];
        }
        this.progressBar.logTrace(`${dat.getName()}: validating candidates`);
        this.progressBar.setSymbol(ProgressBarSymbol.CANDIDATE_VALIDATING);
        this.progressBar.resetProgress(candidates.length);
        const conflictedOutputPaths = this.validateUniqueOutputPaths(dat, candidates);
        if (conflictedOutputPaths.length > 0) {
            return conflictedOutputPaths;
        }
        this.progressBar.logTrace(`${dat.getName()}: done validating candidates`);
        return [];
    }
    validateUniqueOutputPaths(dat, candidates) {
        const outputPathsToCandidates = candidates.reduce((map, candidate) => {
            candidate.getRomsWithFiles().forEach((romWithFiles) => {
                const key = romWithFiles.getOutputFile().getFilePath();
                if (map.has(key)) {
                    map.get(key)?.push(candidate);
                }
                else {
                    map.set(key, [candidate]);
                }
            });
            return map;
        }, new Map());
        return [...outputPathsToCandidates.entries()]
            .filter(([outputPath, candidates]) => {
            const uniqueCandidates = candidates
                .filter(ArrayPoly.filterUniqueMapped((candidate) => candidate.getGame()))
                .sort();
            if (uniqueCandidates.length < 2) {
                return false;
            }
            let message = `${dat.getName()}: multiple games writing to the same output path: ${outputPath}`;
            uniqueCandidates.forEach((candidate) => {
                message += `\n  ${candidate.getName()}`;
            });
            this.progressBar.logError(message);
            return true;
        })
            .flatMap(([, candidates]) => candidates)
            .reduce(ArrayPoly.reduceUnique(), []);
    }
}