runExample.ts

/*  This is an example of how to invoke mariner using the new GraphQL code.
    It mostly exists to be able to test and debug while working on the library code

    To use it, you will need to add a variable to your environment:
        export MARINER_GITHUB_TOKEN="<token here>"
    Optionally, you can have environment variables for INPUT_FILE_PATH and OUTPUT_FILE_PATH,
        but they have defaults that will work with the standard development environment.
    Then, run `npm run build`
    Finally, run `node dist/examples/runExample.js`

    You'll know it's run correctly if you have a new file
        examples/output.json with some GitHub issues in it.
*/

import fs from 'fs';
import * as mariner from '../src/mariner/index'; // This is used during development
// import mariner from 'oss-mariner'    // This is how the npm package would normally be used
import * as path from 'path';

const config = mariner.readConfigFile('examples/config.json');

const htmlPath = 'examples/output.html';

function getFromEnvOrThrow(configField: string): string {
    const value = process.env[configField];
    if (!value) {
        throw new Error(`${configField} is required`);
    }

    return value as string;
}

const token = getFromEnvOrThrow('MARINER_GITHUB_TOKEN');

/*  This demonstrates instructing mariner to use a custom logger.
    It is optional, and if you don't call setLogger,
    output will simply be sent to console.log()
    */
class FancyLogger implements mariner.Logger {
    public info(message: string): void {
        console.log('***INFO: ' + message);
    }
    public error(message: string): void {
        console.log('***ERROR: ' + message);
    }
}

const logger = new FancyLogger();
mariner.setLogger(logger);

logger.info(`Input:  ${path.resolve(config.inputFilePath)}`);
logger.info(`Output: ${path.resolve(config.outputFilePath)}`);
logger.info(`Fetching issues from the last ${config.daysAgoCreated} days`);

const contents = fs.readFileSync(config.inputFilePath, {
    encoding: 'utf8',
});

const countsByLibrary = JSON.parse(contents) as Record<string, number>;
const repositoryIdentifiers = Object.keys(countsByLibrary);
const prefix = 'https://api.github.com/repos/';
const repositories = repositoryIdentifiers.map((identifier) => {
    if (identifier.startsWith(prefix)) {
        return identifier.substring(prefix.length);
    } else {
        return identifier;
    }
});

const finder = new mariner.IssueFinder(config);
const contributorsFinder = new mariner.ContributorsFinder(token);

function convertToRecord(issues: Map<string, mariner.Issue[]>): Record<string, mariner.Issue[]> {
    const record: Record<string, mariner.Issue[]> = {};
    issues.forEach((issuesForRepo: mariner.Issue[], repo: string) => {
        record[repo] = issuesForRepo;
    });

    return record;
}

function outputToJson(record: Record<string, mariner.Issue[]>): void {
    const noReplacer = undefined;
    const indent = 2;
    const jsonResults = JSON.stringify(record, noReplacer, indent);
    fs.writeFileSync(config.outputFilePath, jsonResults);
}

contributorsFinder
    .findContributors(repositories)
    .then((contributors) => {
        const random = Math.random().toString(36);
        const outputPath = `examples/contributorsOutput-${random}.json`; // hardcoded for now
        const contributorsByRepo: Record<string, mariner.Contributor[]> = {};
        contributors.forEach((allContributors: mariner.Contributor[], repo: string) => {
            contributorsByRepo[repo] = allContributors;
        });
        fs.appendFileSync(outputPath, JSON.stringify(contributorsByRepo, undefined, 2));

        logger.info(`Saved contributor results to: ${outputPath}`);
    })
    .catch((err) => {
        logger.error(err.message);
        console.log(err);
    });

finder
    .findIssues(token, repositories)
    .then((issues) => {
        let issueCount = 0;
        issues.forEach((issuesForRepo) => {
            issueCount += issuesForRepo.length;
        });

        logger.info(`Found ${issueCount} issues in ${issues.size} projects\n`);
        outputToJson(convertToRecord(issues));
        logger.info(`Saved issue results to: ${config.outputFilePath}`);

        const html = mariner.generateHtml(issues, 90);
        fs.writeFileSync(htmlPath, html);
        logger.info(`Saved HTML to: ${htmlPath}`);
    })
    .catch((err) => {
        logger.error(err.message);
        console.log(err);
    });