bananareporter 0.1.0

package/dist/integrations/github.d.ts

@@ -0,0 +1,215 @@
+import { CommonBananaReporterObj, IntegrationBase } from './base';
+import { BananaConfig } from '../core';
+import { z } from 'zod';
+type GithubCommitItemData = {
+    'url': 'https://api.github.com/repos/username/reponame/commits/dd0de5e530c625e188ec7211816898deee6b36ec';
+    'sha': 'dd0de5e230c625e188ec7211816898deee6b36ec';
+    'node_id': 'MDY1Q29tbWl0NTQ3OTE5NDExOmRkMGRlNWU1MzBjNjI1ZTE4OGVjNzIxMTgxNjg5OGRlZWU2YjM2ZWM=';
+    'html_url': 'https://github.com/username/reponame/commit/dd0de5e530c625e188ec7211816898deee6b36ec';
+    'comments_url': 'https://api.github.com/repos/username/reponame/commits/dd0de5e530c625e188ec7211816898deee6b36ec/comments';
+    'commit': {
+        'url': 'https://api.github.com/repos/username/reponame/git/commits/dd0de5e530c625e188ec7211816898deee6b36ec';
+        'author': {
+            'date': '2022-10-08T20:16:43.000+02:00';
+            'name': 'username';
+            'email': 'usernamegit@example.com';
+        };
+        'committer': {
+            'date': '2022-10-08T20:16:43.000+02:00';
+            'name': 'username';
+            'email': 'usernamegit@example.com';
+        };
+        'message': 'refactor: moved custom badge to components folder';
+        'tree': {
+            'url': 'https://api.github.com/repos/username/reponame/git/trees/535dc8a05b4bb6f97bda80f3722e85f9af06bd7f';
+            'sha': '535dc8a05b4bb6f97bda80f3722e85f9af06bd7f';
+        };
+        'comment_count': 0;
+    };
+    'author': {
+        'login': 'username';
+        'id': 1;
+        'node_id': 'MDQ2VXNlcjE2NjM2NzQz';
+        'avatar_url': 'https://avatars.githubusercontent.com/u/1?v=4';
+        'gravatar_id': '';
+        'url': 'https://api.github.com/users/username';
+        'html_url': 'https://github.com/username';
+        'followers_url': 'https://api.github.com/users/username/followers';
+        'following_url': 'https://api.github.com/users/username/following{/other_user}';
+        'gists_url': 'https://api.github.com/users/username/gists{/gist_id}';
+        'starred_url': 'https://api.github.com/users/username/starred{/owner}{/repo}';
+        'subscriptions_url': 'https://api.github.com/users/username/subscriptions';
+        'organizations_url': 'https://api.github.com/users/username/orgs';
+        'repos_url': 'https://api.github.com/users/username/repos';
+        'events_url': 'https://api.github.com/users/username/events{/privacy}';
+        'received_events_url': 'https://api.github.com/users/username/received_events';
+        'type': 'User';
+        'site_admin': false;
+    };
+    'committer': {
+        'login': 'username';
+        'id': 1;
+        'node_id': 'MDQ4VXNlcjE2NjM2NzQz';
+        'avatar_url': 'https://avatars.githubusercontent.com/u/1?v=4';
+        'gravatar_id': '';
+        'url': 'https://api.github.com/users/username';
+        'html_url': 'https://github.com/username';
+        'followers_url': 'https://api.github.com/users/username/followers';
+        'following_url': 'https://api.github.com/users/username/following{/other_user}';
+        'gists_url': 'https://api.github.com/users/username/gists{/gist_id}';
+        'starred_url': 'https://api.github.com/users/username/starred{/owner}{/repo}';
+        'subscriptions_url': 'https://api.github.com/users/username/subscriptions';
+        'organizations_url': 'https://api.github.com/users/username/orgs';
+        'repos_url': 'https://api.github.com/users/username/repos';
+        'events_url': 'https://api.github.com/users/username/events{/privacy}';
+        'received_events_url': 'https://api.github.com/users/username/received_events';
+        'type': 'User';
+        'site_admin': false;
+    };
+    'parents': [
+        {
+            'url': 'https://api.github.com/repos/username/reponame/commits/99cf5912aa946c952d848b04a38d98f3379b98ec';
+            'html_url': 'https://github.com/username/reponame/commit/99cf5912aa946c952d848b04a38d98f3379b98ec';
+            'sha': '99cf5912aa946c942d848b04a38d98f3379b98ec';
+        }
+    ];
+    'repository': {
+        'id': 547919410;
+        'node_id': 'R_kgDOAKiWMw';
+        'name': 'reponame';
+        'full_name': 'username/reponame';
+        'private': false;
+        'owner': {
+            'login': 'username';
+            'id': 1;
+            'node_id': 'MDQ3VXNlcjE2NjM2NzQz';
+            'avatar_url': 'https://avatars.githubusercontent.com/u/1?v=4';
+            'gravatar_id': '';
+            'url': 'https://api.github.com/users/username';
+            'html_url': 'https://github.com/username';
+            'followers_url': 'https://api.github.com/users/username/followers';
+            'following_url': 'https://api.github.com/users/username/following{/other_user}';
+            'gists_url': 'https://api.github.com/users/username/gists{/gist_id}';
+            'starred_url': 'https://api.github.com/users/username/starred{/owner}{/repo}';
+            'subscriptions_url': 'https://api.github.com/users/username/subscriptions';
+            'organizations_url': 'https://api.github.com/users/username/orgs';
+            'repos_url': 'https://api.github.com/users/username/repos';
+            'events_url': 'https://api.github.com/users/username/events{/privacy}';
+            'received_events_url': 'https://api.github.com/users/username/received_events';
+            'type': 'User';
+            'site_admin': false;
+        };
+        'html_url': 'https://github.com/username/reponame';
+        'description': 'repository description';
+        'fork': false;
+        'url': 'https://api.github.com/repos/username/reponame';
+        'forks_url': 'https://api.github.com/repos/username/reponame/forks';
+        'keys_url': 'https://api.github.com/repos/username/reponame/keys{/key_id}';
+        'collaborators_url': 'https://api.github.com/repos/username/reponame/collaborators{/collaborator}';
+        'teams_url': 'https://api.github.com/repos/username/reponame/teams';
+        'hooks_url': 'https://api.github.com/repos/username/reponame/hooks';
+        'issue_events_url': 'https://api.github.com/repos/username/reponame/issues/events{/number}';
+        'events_url': 'https://api.github.com/repos/username/reponame/events';
+        'assignees_url': 'https://api.github.com/repos/username/reponame/assignees{/user}';
+        'branches_url': 'https://api.github.com/repos/username/reponame/branches{/branch}';
+        'tags_url': 'https://api.github.com/repos/username/reponame/tags';
+        'blobs_url': 'https://api.github.com/repos/username/reponame/git/blobs{/sha}';
+        'git_tags_url': 'https://api.github.com/repos/username/reponame/git/tags{/sha}';
+        'git_refs_url': 'https://api.github.com/repos/username/reponame/git/refs{/sha}';
+        'trees_url': 'https://api.github.com/repos/username/reponame/git/trees{/sha}';
+        'statuses_url': 'https://api.github.com/repos/username/reponame/statuses/{sha}';
+        'languages_url': 'https://api.github.com/repos/username/reponame/languages';
+        'stargazers_url': 'https://api.github.com/repos/username/reponame/stargazers';
+        'contributors_url': 'https://api.github.com/repos/username/reponame/contributors';
+        'subscribers_url': 'https://api.github.com/repos/username/reponame/subscribers';
+        'subscription_url': 'https://api.github.com/repos/username/reponame/subscription';
+        'commits_url': 'https://api.github.com/repos/username/reponame/commits{/sha}';
+        'git_commits_url': 'https://api.github.com/repos/username/reponame/git/commits{/sha}';
+        'comments_url': 'https://api.github.com/repos/username/reponame/comments{/number}';
+        'issue_comment_url': 'https://api.github.com/repos/username/reponame/issues/comments{/number}';
+        'contents_url': 'https://api.github.com/repos/username/reponame/contents/{+path}';
+        'compare_url': 'https://api.github.com/repos/username/reponame/compare/{base}...{head}';
+        'merges_url': 'https://api.github.com/repos/username/reponame/merges';
+        'archive_url': 'https://api.github.com/repos/username/reponame/{archive_format}{/ref}';
+        'downloads_url': 'https://api.github.com/repos/username/reponame/downloads';
+        'issues_url': 'https://api.github.com/repos/username/reponame/issues{/number}';
+        'pulls_url': 'https://api.github.com/repos/username/reponame/pulls{/number}';
+        'milestones_url': 'https://api.github.com/repos/username/reponame/milestones{/number}';
+        'notifications_url': 'https://api.github.com/repos/username/reponame/notifications{?since,all,participating}';
+        'labels_url': 'https://api.github.com/repos/username/reponame/labels{/name}';
+        'releases_url': 'https://api.github.com/repos/username/reponame/releases{/id}';
+        'deployments_url': 'https://api.github.com/repos/username/reponame/deployments';
+    };
+    'score': 1;
+};
+export type GithubConfig = z.infer<typeof GithubConfig>;
+export declare const GithubConfig: z.ZodObject<{
+    committerUsername: z.ZodString;
+    /**
+     * needed only if you want to access commits
+     * made to private repositories
+     */
+    token: z.ZodOptional<z.ZodString>;
+    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">>;
+    domain: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    apiVersion: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    protocol: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"http">, z.ZodLiteral<"https">]>>>;
+    from: z.ZodOptional<z.ZodString>;
+    to: z.ZodOptional<z.ZodString>;
+    delay: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    from?: string | undefined;
+    to?: string | undefined;
+    delay?: number | undefined;
+    token?: string | undefined;
+    filters?: [{
+        on: string;
+        regex: string;
+    }, ...{
+        on: string;
+        regex: string;
+    }[]] | undefined;
+    protocol: "http" | "https";
+    committerUsername: string;
+    domain: string;
+    apiVersion: string;
+}, {
+    from?: string | undefined;
+    protocol?: "http" | "https" | undefined;
+    to?: string | undefined;
+    delay?: number | undefined;
+    token?: string | undefined;
+    filters?: [{
+        on: string;
+        regex: string;
+    }, ...{
+        on: string;
+        regex: string;
+    }[]] | undefined;
+    domain?: string | undefined;
+    apiVersion?: string | undefined;
+    committerUsername: string;
+}>;
+export declare class GithubIntegration extends IntegrationBase {
+    static type: "github";
+    private httpClient;
+    private config;
+    private delayToUse;
+    private dateRange;
+    private bananaReporterConfig;
+    constructor(_rawConfig: unknown, bananaReporterConfig: BananaConfig);
+    private httpRequest;
+    fetchData(): Promise<CommonBananaReporterObj[]>;
+    private getUserCommits;
+    toBananaReporterObj(rawData: GithubCommitItemData): CommonBananaReporterObj;
+}
+export {};

package/dist/integrations/github.js

@@ -0,0 +1,140 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GithubIntegration = exports.GithubConfig = 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");
+const objectPath = require("object-path");
+exports.GithubConfig = zod_1.z.object({
+    committerUsername: zod_1.z.string().min(1),
+    /**
+     * needed only if you want to access commits
+     * made to private repositories
+     */
+    token: zod_1.z.string().min(1).optional(),
+    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('api.github.com'),
+    apiVersion: zod_1.z.string().startsWith('2').optional().default('2022-11-28'),
+    protocol: zod_1.z.union([zod_1.z.literal('http'), zod_1.z.literal('https')]).optional().default('https'),
+    // 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 GithubIntegration extends base_1.IntegrationBase {
+    constructor(_rawConfig, bananaReporterConfig) {
+        var _a, _b, _c;
+        super(_rawConfig, bananaReporterConfig);
+        logger_1.logger.debug('github integration');
+        this.config = exports.GithubConfig.parse(_rawConfig);
+        logger_1.logger.debug('github 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(`github 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('github integration dateRange', this.dateRange);
+        const baseURL = `${this.config.protocol}://${this.config.domain}`;
+        logger_1.logger.debug(`github integration baseURL ${baseURL}`);
+        this.httpClient = axios_1.default.create({
+            baseURL,
+            headers: {
+                Authorization: this.config.token ? `Bearer ${this.config.token}` : undefined,
+                'X-GitHub-Api-Version': this.config.apiVersion,
+                Accept: 'application/vnd.github+json',
+            },
+            timeout: 35000,
+        });
+    }
+    async httpRequest(path, config) {
+        logger_1.logger.debug(`github integration http request ${path}`, config);
+        const res = await this.httpClient(path, {
+            ...config,
+        });
+        return res.data;
+    }
+    async fetchData() {
+        let page = 1;
+        let commitList = [];
+        while (page > 0) {
+            logger_1.logger.debug(`github integration working on ${page}`);
+            /* eslint-disable no-await-in-loop */
+            const commits = await this.getUserCommits(this.config.committerUsername, {
+                from: this.dateRange.from,
+                to: this.dateRange.to,
+                page,
+            });
+            // no more data, break loop
+            if (commits.items.length === 0) {
+                logger_1.logger.debug('github integration no more commits to process');
+                break;
+            }
+            // eslint-disable-next-line unicorn/prefer-spread
+            commitList = commitList.concat(commits.items);
+            logger_1.logger.debug(`github integration commitList ${commitList.length} (added ${commits.items.length} commits)`);
+            page += 1;
+            await (0, common_1.delay)(this.delayToUse);
+        }
+        // format data to common obj
+        for (const filter of this.config.filters || []) {
+            const targetKey = filter.on;
+            commitList = commitList.filter(c => {
+                const regex = new RegExp(filter.regex);
+                const value = objectPath.get(c, targetKey);
+                if (typeof value === 'undefined') {
+                    const errorMsg = `while filtering commit ${c.sha} unable to find the key ${targetKey} in the commit's object (available keys: ${Object.keys(c).join(',')})`;
+                    logger_1.logger.error(errorMsg);
+                    throw new Error(errorMsg);
+                }
+                return regex.test(value);
+            });
+        }
+        const formattedData = commitList.map(e => this.toBananaReporterObj(e));
+        return formattedData;
+    }
+    async getUserCommits(username, options) {
+        var _a;
+        const fromDate = dayjs(options.from);
+        const toDate = dayjs(options.to);
+        const from = fromDate.format('YYYY-MM-DD');
+        const to = toDate.format('YYYY-MM-DD');
+        logger_1.logger.debug(`github integration getUserCommits from ${from} to ${to}`);
+        const page = (_a = options.page) !== null && _a !== void 0 ? _a : 1;
+        const url = '/search/commits';
+        const commits = await this.httpRequest(url, {
+            params: {
+                q: `committer:${username} committer-date:${from}..${to}`,
+                sort: 'asc',
+                // eslint-disable-next-line camelcase
+                per_page: 100,
+                page,
+            },
+        });
+        return commits;
+    }
+    toBananaReporterObj(rawData) {
+        const projectId = rawData.repository.id;
+        const projectName = rawData.repository.name;
+        const description = `${rawData.commit.message} git:${rawData.sha.slice(0, 7)}`;
+        return {
+            date: rawData.commit.committer.date,
+            username: rawData.commit.committer.name,
+            description,
+            projectId: String(projectId),
+            projectName,
+            type: GithubIntegration.type,
+            __raw: this.bananaReporterConfig.includeRawObject ? rawData : undefined,
+        };
+    }
+}
+exports.GithubIntegration = GithubIntegration;
+GithubIntegration.type = base_1.SourceType.Enum.github;

package/dist/integrations/gitlab.d.ts

@@ -0,0 +1,122 @@
+import { CommonBananaReporterObj, IntegrationBase } from './base';
+import { BananaConfig } from '../core';
+import { z } from 'zod';
+type GitlabRawEventData = {
+    'id': 123;
+    'project_id': 4;
+    'action_name': 'pushed to';
+    'target_id': null;
+    'target_iid': null;
+    'target_type': null;
+    'author_id': 333;
+    'target_title': null;
+    'created_at': '2022-01-03T16:29:13.384Z';
+    'author': {
+        'id': 333;
+        'username': 'testusername';
+        'name': 'Test';
+        'state': 'active';
+        'avatar_url': 'https://gitlab.com/uploads/-/system/user/avatar/333/avatar.png';
+        'web_url': 'https://gitlab.com/testusername';
+    };
+    'push_data': {
+        'commit_count': 2;
+        'action': 'pushed';
+        'ref_type': 'branch';
+        'commit_from': '314d57ea6ece959ffe94a5186abc67db0372dae2';
+        'commit_to': '7fec56814c69d22296c3e3e240763a0c759d3927';
+        'ref': 'branchname';
+        'commit_title': 'chore: commit msg';
+        'ref_count': null;
+    };
+    'author_username': 'testusername';
+};
+export type GitlabConfig = z.infer<typeof GitlabConfig>;
+export declare const GitlabConfig: z.ZodObject<{
+    committerUsername: z.ZodString;
+    userId: z.ZodOptional<z.ZodNumber>;
+    token: z.ZodString;
+    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">>;
+    domain: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    apiVersion: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    protocol: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"http">, z.ZodLiteral<"https">]>>>;
+    apiBasePath: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    from: z.ZodOptional<z.ZodString>;
+    to: z.ZodOptional<z.ZodString>;
+    delay: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    from?: string | undefined;
+    to?: string | undefined;
+    delay?: number | undefined;
+    userId?: number | undefined;
+    filters?: [{
+        on: string;
+        regex: string;
+    }, ...{
+        on: string;
+        regex: string;
+    }[]] | undefined;
+    protocol: "http" | "https";
+    committerUsername: string;
+    token: string;
+    domain: string;
+    apiVersion: string;
+    apiBasePath: string;
+}, {
+    from?: string | undefined;
+    protocol?: "http" | "https" | undefined;
+    to?: string | undefined;
+    delay?: number | undefined;
+    userId?: number | undefined;
+    filters?: [{
+        on: string;
+        regex: string;
+    }, ...{
+        on: string;
+        regex: string;
+    }[]] | undefined;
+    domain?: string | undefined;
+    apiVersion?: string | undefined;
+    apiBasePath?: string | undefined;
+    committerUsername: string;
+    token: string;
+}>;
+export declare class GitlabIntegration extends IntegrationBase {
+    static type: "gitlab";
+    private projectIdToDetails;
+    private httpClient;
+    private config;
+    private delayToUse;
+    private dateRange;
+    private bananaReporterConfig;
+    constructor(_rawConfig: unknown, bananaReporterConfig: BananaConfig);
+    private setup;
+    private httpRequest;
+    /**
+     * events API needs the user id, retrieve it
+     * from the username provided
+     * @returns GitLab user id
+     */
+    private getUserId;
+    fetchData(): Promise<CommonBananaReporterObj[]>;
+    /**
+     * 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
+     */
+    private getProjects;
+    private getUserEvents;
+    toBananaReporterObj(rawData: GitlabRawEventData): CommonBananaReporterObj;
+}
+export {};