bananareporter 0.1.0

package/dist/integrations/gitlab.js

@@ -0,0 +1,246 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GitlabIntegration = exports.GitlabConfig = void 0;
+const base_1 = require("./base");
+// import {Axios} from 'axios'
+const common_1 = require("../util/common");
+const zod_1 = require("zod");
+const axios_1 = require("axios");
+const dayjs = require("dayjs");
+const logger_1 = require("../util/logger");
+exports.GitlabConfig = zod_1.z.object({
+    committerUsername: zod_1.z.string().min(1),
+    userId: zod_1.z.number().optional(),
+    token: zod_1.z.string().min(1),
+    filters: zod_1.z.array(zod_1.z.object({
+        on: zod_1.z.string().min(1),
+        regex: zod_1.z.string().min(1),
+    })).nonempty().optional(),
+    domain: zod_1.z.string().optional().default('gitlab.com'),
+    apiVersion: zod_1.z.string().startsWith('v').optional().default('v4'),
+    protocol: zod_1.z.union([zod_1.z.literal('http'), zod_1.z.literal('https')]).optional().default('https'),
+    apiBasePath: zod_1.z.string().optional().default('api'),
+    // TODO should be extended from a base integration
+    from: common_1.zIsoString.optional(),
+    to: common_1.zIsoString.optional(),
+    delay: zod_1.z.number().min(0).optional(),
+});
+class GitlabIntegration extends base_1.IntegrationBase {
+    constructor(_rawConfig, bananaReporterConfig) {
+        var _a, _b, _c;
+        super(_rawConfig, bananaReporterConfig);
+        this.projectIdToDetails = {};
+        logger_1.logger.debug('gitlab integration');
+        this.config = exports.GitlabConfig.parse(_rawConfig);
+        logger_1.logger.debug('gitlab integration config', this.config);
+        this.bananaReporterConfig = bananaReporterConfig;
+        this.delayToUse = (_a = this.config.delay) !== null && _a !== void 0 ? _a : this.bananaReporterConfig.delay;
+        logger_1.logger.debug(`gitlab integration delayToUse ${this.delayToUse}`);
+        this.dateRange = {
+            from: (_b = this.config.from) !== null && _b !== void 0 ? _b : this.bananaReporterConfig.from,
+            to: (_c = this.config.to) !== null && _c !== void 0 ? _c : this.bananaReporterConfig.to,
+        };
+        logger_1.logger.debug('gitlab integration dateRange', this.dateRange);
+        const baseURL = `${this.config.protocol}://${this.config.domain}/${this.config.apiBasePath}/${this.config.apiVersion}`;
+        logger_1.logger.debug(`gitlab integration baseURL ${baseURL}`);
+        this.httpClient = axios_1.default.create({
+            baseURL,
+            headers: {
+                Authorization: `Bearer ${this.config.token}`,
+            },
+            timeout: 35000,
+        });
+    }
+    setup(options) {
+        for (const p of options.projectDetails) {
+            if (!(p.id in this.projectIdToDetails)) {
+                this.projectIdToDetails[p.id] = p;
+            }
+        }
+    }
+    async httpRequest(path, config) {
+        logger_1.logger.debug(`gitlab integration http request ${path}`, config);
+        const res = await this.httpClient(path, {
+            ...config,
+        });
+        return res.data;
+    }
+    /**
+     * events API needs the user id, retrieve it
+     * from the username provided
+     * @returns GitLab user id
+     */
+    async getUserId() {
+        if (typeof this.config.userId !== 'undefined') {
+            return this.config.userId;
+        }
+        const username = this.config.committerUsername;
+        const data = await this.httpRequest(`/users?username=${username}`);
+        if (data.length === 0) {
+            throw new Error(`unable to find the GitLab username ${username}`);
+        }
+        return data[0].id;
+    }
+    async fetchData() {
+        const userId = await this.getUserId();
+        logger_1.logger.debug(`gitlab integration userId ${userId}`);
+        let page = 1;
+        let eventList = [];
+        const projectIds = new Set();
+        while (page > 0) {
+            logger_1.logger.debug(`gitlab integration working on ${page}`);
+            /* eslint-disable no-await-in-loop */
+            const events = await this.getUserEvents(userId, {
+                from: this.dateRange.from,
+                to: this.dateRange.to,
+                page,
+            });
+            // no more data, break loop
+            if (events.length === 0) {
+                logger_1.logger.debug('gitlab integration no more events to process');
+                break;
+            }
+            for (const e of events) {
+                projectIds.add(e.project_id);
+            }
+            // eslint-disable-next-line unicorn/prefer-spread
+            eventList = eventList.concat(events);
+            logger_1.logger.debug(`gitlab integration eventList ${eventList.length} (added ${events.length} events)`);
+            page += 1;
+            await (0, common_1.delay)(this.delayToUse);
+        }
+        // get all project details
+        const projectDetails = await this.getProjects(userId, projectIds);
+        logger_1.logger.debug('gitlab integration projectDetails', projectDetails);
+        for (const p of projectDetails) {
+            this.projectIdToDetails[p.id] = p;
+        }
+        this.setup({
+            projectDetails,
+        });
+        // format data to common obj
+        let filteredData = eventList
+            .filter(e => e.action_name.startsWith('pushed'));
+        const projectsToRemove = new Set();
+        for (const filter of this.config.filters || []) {
+            const targetKey = filter.on;
+            if (targetKey.startsWith('$project.')) {
+                // custom logic for project matching
+                for (const projectId of Object.keys(this.projectIdToDetails)) {
+                    const project = this.projectIdToDetails[Number(projectId)];
+                    const targetProjectKey = targetKey.split('.').pop();
+                    if (!(targetProjectKey in project)) {
+                        const errorMsg = `while filtering the project ${project.name} (id ${project.id}) unable to find the key ${targetProjectKey} in the project's object (available keys: ${Object.keys(project).join(',')})`;
+                        logger_1.logger.error(errorMsg);
+                        throw new Error(errorMsg);
+                    }
+                    const regex = new RegExp(filter.regex);
+                    if (!regex.test(project[targetProjectKey])) {
+                        // false, remove
+                        projectsToRemove.add(Number(projectId));
+                    }
+                }
+            }
+            filteredData = filteredData.filter(e => {
+                const targetKey = filter.on;
+                // custom project is filtered later on
+                if (targetKey.startsWith('$project.')) {
+                    return true;
+                }
+                const regex = new RegExp(filter.regex);
+                if (!(targetKey in e)) {
+                    const errorMsg = `while filtering event id ${e.id} unable to find the key ${targetKey} in the event's object (available keys: ${Object.keys(e).join(',')})`;
+                    logger_1.logger.error(errorMsg);
+                    throw new Error(errorMsg);
+                }
+                return regex.test(e[targetKey]);
+            });
+        }
+        if (projectsToRemove.size > 0) {
+            filteredData = filteredData.filter(e => {
+                return !projectsToRemove.has(e.project_id);
+            });
+        }
+        const formattedData = filteredData.map(e => this.toBananaReporterObj(e));
+        return formattedData;
+    }
+    /**
+     * GitLab doesn't return project information in the events call,
+     * need to fetch all projects to enrich the events data
+     * @param userId identifier of gitlab user
+     * @param projectIds set of project ids found in events call
+     * @returns list of projects found
+     */
+    async getProjects(userId, projectIds) {
+        // get all user projects, if some projects are missing
+        // try to get the project via a direct GET call
+        const remainingProjectIdsToFetch = projectIds;
+        const projects = await this.httpRequest(`/users/${userId}/projects`);
+        for (const p of projects) {
+            remainingProjectIdsToFetch.delete(p.id);
+        }
+        const projectsLoaded = projects;
+        if (remainingProjectIdsToFetch.size > 0) {
+            // delay before starting to fetch other data
+            await (0, common_1.delay)(this.delayToUse);
+            // eslint-disable-next-line unicorn/prefer-spread
+            for (const projectId of Array.from(remainingProjectIdsToFetch)) {
+                try {
+                    const project = await this.httpRequest(`/projects/${projectId}`);
+                    if (project) {
+                        remainingProjectIdsToFetch.delete(projectId);
+                        projectsLoaded.push(project);
+                    }
+                }
+                catch (error) {
+                    logger_1.logger.debug(`gitlab integration unable to fetch details for project ID ${projectId}`, error);
+                }
+                await (0, common_1.delay)(this.delayToUse);
+            }
+        }
+        if (remainingProjectIdsToFetch.size > 0) {
+            logger_1.logger.warn(`unable to retrieve details for the following project ids: ${[...remainingProjectIdsToFetch].join(',')} make sure you have still access to these projects, the report won't include the project names`);
+        }
+        return projectsLoaded;
+    }
+    async getUserEvents(userId, options) {
+        var _a;
+        const fromDate = dayjs(options.from);
+        const toDate = dayjs(options.to);
+        // recalculate from - to according on GitLab API behaviour
+        const from = fromDate.subtract(1, 'day').format('YYYY-MM-DD');
+        const to = toDate.add(1, 'day').format('YYYY-MM-DD');
+        logger_1.logger.debug(`gitlab integration getUserEvents from ${from} to ${to}`);
+        const page = (_a = options.page) !== null && _a !== void 0 ? _a : 1;
+        const url = `/users/${userId}/events`;
+        const events = await this.httpRequest(url, {
+            params: {
+                after: from,
+                before: to,
+                sort: 'asc',
+                // eslint-disable-next-line camelcase
+                per_page: 100,
+                action: 'pushed',
+                page,
+            },
+        });
+        return events;
+    }
+    toBananaReporterObj(rawData) {
+        const projectId = rawData.project_id;
+        const projectDetails = this.projectIdToDetails[projectId];
+        const projectName = projectDetails === null || projectDetails === void 0 ? void 0 : projectDetails.path;
+        const description = `${rawData.push_data.commit_title} branch:${rawData.push_data.ref} git:${rawData.push_data.commit_to.slice(0, 7)}`;
+        return {
+            date: rawData.created_at,
+            username: rawData.author_username,
+            description,
+            projectId: String(projectId),
+            projectName,
+            type: GitlabIntegration.type,
+            __raw: this.bananaReporterConfig.includeRawObject ? rawData : undefined,
+        };
+    }
+}
+exports.GitlabIntegration = GitlabIntegration;
+GitlabIntegration.type = base_1.SourceType.Enum.gitlab;

package/dist/integrations/todotxt.d.ts

@@ -0,0 +1,51 @@
+import { CommonBananaReporterObj, IntegrationBase } from './base';
+import { BananaConfig } from '../core';
+import { z } from 'zod';
+import { Task } from '@lggruspe/todo-txt-parser';
+export type TodoTxtConfig = z.infer<typeof TodoTxtConfig>;
+export declare const TodoTxtConfig: z.ZodObject<{
+    file: z.ZodEffects<z.ZodDefault<z.ZodString>, string, string | undefined>;
+    filters: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        on: z.ZodString;
+        regex: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        on: string;
+        regex: string;
+    }, {
+        on: string;
+        regex: string;
+    }>, "atleastone">>;
+    from: z.ZodOptional<z.ZodString>;
+    to: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    from?: string | undefined;
+    to?: string | undefined;
+    filters?: [{
+        on: string;
+        regex: string;
+    }, ...{
+        on: string;
+        regex: string;
+    }[]] | undefined;
+    file: string;
+}, {
+    file?: string | undefined;
+    from?: string | undefined;
+    to?: string | undefined;
+    filters?: [{
+        on: string;
+        regex: string;
+    }, ...{
+        on: string;
+        regex: string;
+    }[]] | undefined;
+}>;
+export declare class TodoTxtIntegration extends IntegrationBase {
+    static type: "todo.txt";
+    private config;
+    private dateRange;
+    private bananaReporterConfig;
+    constructor(_rawConfig: unknown, bananaReporterConfig: BananaConfig);
+    fetchData(): Promise<CommonBananaReporterObj[]>;
+    toBananaReporterObj(rawData: Task): CommonBananaReporterObj;
+}

package/dist/integrations/todotxt.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TodoTxtIntegration = exports.TodoTxtConfig = void 0;
+const base_1 = require("./base");
+// import {Axios} from 'axios'
+const common_1 = require("../util/common");
+const zod_1 = require("zod");
+const dayjs = require("dayjs");
+const logger_1 = require("../util/logger");
+const objectPath = require("object-path");
+const node_fs_1 = require("node:fs");
+const todo_txt_parser_1 = require("@lggruspe/todo-txt-parser");
+const path = require("path");
+exports.TodoTxtConfig = zod_1.z.object({
+    // TODO support wildcard
+    file: zod_1.z.string().min(1).default('./todo.txt').refine(s => {
+        return path.resolve(s);
+    }),
+    filters: zod_1.z.array(zod_1.z.object({
+        on: zod_1.z.string().min(1),
+        regex: zod_1.z.string().min(1),
+    })).nonempty().optional(),
+    from: common_1.zIsoString.optional(),
+    to: common_1.zIsoString.optional(),
+});
+class TodoTxtIntegration extends base_1.IntegrationBase {
+    constructor(_rawConfig, bananaReporterConfig) {
+        var _a, _b;
+        super(_rawConfig, bananaReporterConfig);
+        logger_1.logger.debug('todo.txt integration');
+        this.config = exports.TodoTxtConfig.parse(_rawConfig);
+        logger_1.logger.debug('todo.txt integration config', this.config);
+        this.bananaReporterConfig = bananaReporterConfig;
+        this.dateRange = {
+            from: (_a = this.config.from) !== null && _a !== void 0 ? _a : this.bananaReporterConfig.from,
+            to: (_b = this.config.to) !== null && _b !== void 0 ? _b : this.bananaReporterConfig.to,
+        };
+        logger_1.logger.debug('todo.txt integration dateRange', this.dateRange);
+        if (!(0, node_fs_1.existsSync)(this.config.file)) {
+            const errorMsg = `Unable to find file ${this.config.file}`;
+            logger_1.logger.error(errorMsg);
+            throw new Error(errorMsg);
+        }
+        logger_1.logger.debug(`todo.txt file ${this.config.file} exists`);
+    }
+    async fetchData() {
+        // parse
+        const rawTodoTxt = (0, node_fs_1.readFileSync)(this.config.file).toString();
+        const parsedTodoTxtFile = (0, todo_txt_parser_1.parse)(rawTodoTxt);
+        const fromDate = dayjs(this.dateRange.from).subtract(1, 'minute');
+        const toDate = dayjs(this.dateRange.to).add(1, 'minute');
+        let filteredTasks = parsedTodoTxtFile.filter(t => {
+            const rawTaskDate = t.completion || t.creation;
+            // unknown task date, don't include it
+            if (typeof rawTaskDate === 'undefined') {
+                return false;
+            }
+            const taskDateObj = dayjs(rawTaskDate);
+            return (taskDateObj.isAfter(fromDate) &&
+                taskDateObj.isBefore(toDate));
+        });
+        // format data to common obj
+        for (const filter of this.config.filters || []) {
+            const targetKey = filter.on;
+            filteredTasks = filteredTasks.filter(t => {
+                const regex = new RegExp(filter.regex);
+                const value = objectPath.get(t, targetKey);
+                if (typeof value === 'undefined') {
+                    const errorMsg = `while filtering "${t.description}" unable to find the key ${targetKey} in the task's object (available keys: ${Object.keys(t).join(',')})`;
+                    logger_1.logger.error(errorMsg);
+                    throw new Error(errorMsg);
+                }
+                return regex.test(value);
+            });
+        }
+        const formattedData = filteredTasks.map(e => this.toBananaReporterObj(e));
+        return formattedData;
+    }
+    toBananaReporterObj(rawData) {
+        var _a;
+        const projectName = (_a = rawData.projects) === null || _a === void 0 ? void 0 : _a.map(p => p.replace('+', '')).join(',');
+        const description = `${rawData.description}`;
+        return {
+            date: rawData.completion || rawData.creation || '',
+            description,
+            projectName,
+            type: TodoTxtIntegration.type,
+            __raw: this.bananaReporterConfig.includeRawObject ? rawData : undefined,
+        };
+    }
+}
+exports.TodoTxtIntegration = TodoTxtIntegration;
+TodoTxtIntegration.type = base_1.SourceType.Enum['todo.txt'];

package/dist/util/common.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="node" />
+import { z } from 'zod';
+export declare const zIsoString: z.ZodString;
+export declare function delay(ms: number): Promise<NodeJS.Timeout>;

package/dist/util/common.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.delay = exports.zIsoString = void 0;
+const zod_1 = require("zod");
+const ISO_DATE_REGEX = /\d{4}-[01]\d-[0-3]\d/;
+// from https://github.com/colinhacks/zod/issues/482#issuecomment-1369800957
+exports.zIsoString = zod_1.z
+    .string()
+    .regex(ISO_DATE_REGEX, 'date must be a valid ISO8601 date');
+function delay(ms) {
+    // eslint-disable-next-line no-promise-executor-return
+    return new Promise(resolve => setTimeout(resolve, ms));
+}
+exports.delay = delay;

package/dist/util/logger.d.ts

@@ -0,0 +1,2 @@
+import winston = require('winston');
+export declare const logger: winston.Logger;

package/dist/util/logger.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+const winston = require("winston");
+exports.logger = winston.createLogger({
+    level: process.env.BANANAREPORTER_LOG_LEVEL || 'info',
+    format: winston.format.json(),
+    transports: [
+        new winston.transports.Console({
+            format: winston.format.combine(winston.format.colorize(), winston.format.simple()),
+        }),
+    ],
+});

package/oclif.manifest.json

@@ -0,0 +1,92 @@
+{
+  "version": "0.1.0",
+  "commands": {
+    "run": {
+      "id": "run",
+      "description": "Run report",
+      "strict": true,
+      "pluginName": "bananareporter",
+      "pluginAlias": "bananareporter",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "$ banana-reporter run --from 2023-01-01 --to 2023-01-31\nreport with 138 entries saved to ./bananareporter.json\n"
+      ],
+      "flags": {
+        "config": {
+          "name": "config",
+          "type": "option",
+          "char": "c",
+          "description": "config file location, by default ~/.config/bananareporter/config.yaml",
+          "required": false,
+          "multiple": false
+        },
+        "from": {
+          "name": "from",
+          "type": "option",
+          "description": "from date (ISO8601)",
+          "required": false,
+          "helpValue": "2023-03-01",
+          "multiple": false
+        },
+        "to": {
+          "name": "to",
+          "type": "option",
+          "description": "to date (ISO8601)",
+          "required": false,
+          "helpValue": "2023-03-31",
+          "multiple": false,
+          "dependsOn": [
+            "from"
+          ]
+        },
+        "out": {
+          "name": "out",
+          "type": "option",
+          "char": "o",
+          "description": "file path to save the output",
+          "required": true,
+          "multiple": false,
+          "default": "./bananareporter.json",
+          "aliases": [
+            "output"
+          ]
+        },
+        "format": {
+          "name": "format",
+          "type": "option",
+          "description": "output file format",
+          "required": true,
+          "multiple": false,
+          "options": [
+            "json",
+            "jsonl",
+            "csv"
+          ],
+          "default": "json"
+        },
+        "delay": {
+          "name": "delay",
+          "type": "option",
+          "description": "global delay in millisecons between http requests",
+          "multiple": false,
+          "default": 300
+        },
+        "include-raw-object": {
+          "name": "include-raw-object",
+          "type": "boolean",
+          "description": "include raw object in json/jsonl reporter output",
+          "allowNo": false
+        },
+        "disable-welcome-emoji": {
+          "name": "disable-welcome-emoji",
+          "type": "boolean",
+          "description": "disable banana welcome emoji",
+          "hidden": true,
+          "allowNo": false
+        }
+      },
+      "args": {}
+    }
+  }
+}

package/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "bananareporter",
+  "version": "0.1.0",
+  "description": "Easily generate a report from multiple sources",
+  "author": "nya1",
+  "bin": {
+    "bananareporter": "./bin/run"
+  },
+  "homepage": "https://github.com/nya1/bananareporter",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "repository": "nya1/bananareporter",
+  "files": [
+    "/bin",
+    "/dist",
+    "/npm-shrinkwrap.json",
+    "/oclif.manifest.json"
+  ],
+  "dependencies": {
+    "@lggruspe/todo-txt-parser": "^1.1.1",
+    "@oclif/core": "^2",
+    "@oclif/plugin-help": "^5",
+    "axios": "^1.3.4",
+    "dayjs": "^1.11.7",
+    "js-yaml": "^4.1.0",
+    "lodash": "^4.17.21",
+    "object-path": "^0.11.8",
+    "papaparse": "^5.4.0",
+    "winston": "^3.8.2",
+    "zod": "^3.21.0"
+  },
+  "devDependencies": {
+    "@oclif/test": "^2.3.8",
+    "@types/chai": "^4",
+    "@types/js-yaml": "^4.0.5",
+    "@types/mocha": "^9.1.1",
+    "@types/node": "^18.14.6",
+    "@types/node-fetch": "^2.6.2",
+    "@types/object-path": "^0.11.1",
+    "@types/papaparse": "^5.3.7",
+    "chai": "^4",
+    "eslint": "^7.32.0",
+    "eslint-config-oclif": "^4",
+    "eslint-config-oclif-typescript": "^1.0.3",
+    "mocha": "^9",
+    "oclif": "^3",
+    "shx": "^0.3.4",
+    "ts-node": "^10.9.1",
+    "tslib": "^2.5.0",
+    "typescript": "^4.9.5"
+  },
+  "oclif": {
+    "bin": "bananareporter",
+    "dirname": "bananareporter",
+    "default": "run",
+    "commands": "./dist/commands",
+    "plugins": [
+      "@oclif/plugin-help"
+    ],
+    "topicSeparator": " ",
+    "topics": {
+      "run": {
+        "description": "Run reporter"
+      }
+    }
+  },
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "lint": "eslint . --ext .ts --config .eslintrc",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "yarn lint",
+    "prepack": "yarn build && oclif manifest && oclif readme",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif readme && git add README.md"
+  },
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "bugs": "https://github.com/nya1/bananareporter/issues",
+  "keywords": [
+    "report",
+    "banana",
+    "reporter",
+    "export",
+    "oclif"
+  ],
+  "types": "dist/index.d.ts"
+}