get-template.js

const path = require('path');
const { mkdir, readFile, writeFile } = require('fs/promises');

const xlsx = require('xlsx');
const { SERVER_DATA_DIR, EMPTY_TEMPLATE_NAME, PERIOD_TEMPLATES_DIR } = require('../environment');

const { getReportingPeriod, updateReportingPeriod } = require('../db/reporting-periods');
const { requiredArgument } = require('../lib/preconditions');

// cache treasury templates in memory after first load
const treasuryTemplates = new Map();

// WARNING: changes to this function must be made with care, because:
//  1. there may be existing data on disk with filenames set according to this function,
//     which could become inaccessible
//  2. this function is duplicated in GOST's import_arpa_reporter_dump.js script
function periodTemplatePath(reportingPeriod) {
    return path.join(
        PERIOD_TEMPLATES_DIR,
        `${reportingPeriod.id}.template`,
    );
}

async function savePeriodTemplate(periodId, fileName, buffer) {
    requiredArgument(periodId, 'must specify periodId in savePeriodTemplate');
    requiredArgument(fileName, 'must specify fileName in savePeriodTemplate');
    requiredArgument(buffer, 'must specify buffer in savePeriodTemplate');

    const reportingPeriod = await getReportingPeriod(periodId);

    await mkdir(PERIOD_TEMPLATES_DIR, { recursive: true });
    await writeFile(
        periodTemplatePath(reportingPeriod),
        buffer,
        { flag: 'w' },
    );

    reportingPeriod.template_filename = fileName;
    await updateReportingPeriod(reportingPeriod);
}

async function loadTemplate(templateName) {
    const templatePath = path.join(
        SERVER_DATA_DIR,
        'treasury',
        `${templateName}.xlsx`,
    );

    const workbook = xlsx.readFile(templatePath);
    if (workbook.SheetNames.length !== 1) {
        throw Error(`template ${templateName} contains multiple sheets`);
    }

    const worksheet = workbook.Sheets[workbook.SheetNames[0]];
    return xlsx.utils.sheet_to_json(worksheet, { header: 1, blankrows: false });
}

async function getTemplate(templateName) {
    if (treasuryTemplates.has(templateName)) {
        return treasuryTemplates.get(templateName);
    }
    const template = await loadTemplate(templateName);
    treasuryTemplates.set(templateName, template);
    return template;
}

async function templateForPeriod(periodId) {
    requiredArgument(periodId, 'must specify periodId in templateForPeriod');

    const reportingPeriod = await getReportingPeriod(periodId);

    if (reportingPeriod.template_filename) {
        const filename = reportingPeriod.template_filename;
        const data = await readFile(periodTemplatePath(reportingPeriod));
        return { filename, data };
    }
    const filename = EMPTY_TEMPLATE_NAME;
    const data = await readFile(path.join(SERVER_DATA_DIR, filename));
    return { filename, data };
}

module.exports = {
    getTemplate,
    templateForPeriod,
    periodTemplatePath,
    savePeriodTemplate,
};

// NOTE: This file was copied from src/server/services/get-template.js (git @ ada8bfdc98) in the arpa-reporter repo on 2022-09-23T20:05:47.735Z