@soos-io/soos-scm-audit 0.1.3 → 0.2.0-pre.1

package/bin/constants.d.ts

@@ -0,0 +1,8 @@
+export declare const SOOS_SCM_AUDIT_CONSTANTS: {
+    Parameters: {
+        DefaultDaysAgo: number;
+    };
+    Files: {
+        ContributorAuditResults: string;
+    };
+};

package/bin/constants.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SOOS_SCM_AUDIT_CONSTANTS = void 0;
+exports.SOOS_SCM_AUDIT_CONSTANTS = {
+    Parameters: {
+        DefaultDaysAgo: 90,
+    },
+    Files: {
+        ContributorAuditResults: "soos_contributor_audit",
+    },
+};

package/bin/enums.d.ts

@@ -0,0 +1,8 @@
+export declare enum ScmResultsFormat {
+    JSON = "JSON",
+    TXT = "TXT"
+}
+export declare enum ScmType {
+    GitHub = "GitHub",
+    BitbucketCloud = "BitbucketCloud"
+}

package/bin/enums.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScmType = exports.ScmResultsFormat = void 0;
+var ScmResultsFormat;
+(function (ScmResultsFormat) {
+    ScmResultsFormat["JSON"] = "JSON";
+    ScmResultsFormat["TXT"] = "TXT";
+})(ScmResultsFormat || (exports.ScmResultsFormat = ScmResultsFormat = {}));
+var ScmType;
+(function (ScmType) {
+    ScmType["GitHub"] = "GitHub";
+    ScmType["BitbucketCloud"] = "BitbucketCloud";
+})(ScmType || (exports.ScmType = ScmType = {}));

package/bin/index.js

@@ -6,8 +6,9 @@ const package_json_1 = require("../package.json");
 const api_client_1 = require("@soos-io/api-client");
 const process_1 = require("process");
 const utilities_1 = require("@soos-io/api-client/dist/utilities");
-const ContributorAuditService_1 = tslib_1.__importDefault(require("@soos-io/api-client/dist/services/ContributorAuditService/ContributorAuditService"));
-const ContributorAuditArgumentParser_1 = tslib_1.__importDefault(require("@soos-io/api-client/dist/services/ContributorAuditArgumentParser"));
+const ContributorAuditArgumentParser_1 = tslib_1.__importDefault(require("./services/ContributorAuditArgumentParser"));
+const ContributorAuditService_1 = tslib_1.__importDefault(require("./services/ContributorAuditService/ContributorAuditService"));
+const enums_1 = require("./enums");
 class SOOSSCMAudit {
     args;
     constructor(args) {
@@ -21,7 +22,7 @@ class SOOSSCMAudit {
     async runAudit() {
         const contributingDeveloperService = ContributorAuditService_1.default.create(this.args.apiKey, this.args.apiURL, this.args.scmType);
         let auditParams;
-        if (this.args.scmType === api_client_1.ScmType.GitHub) {
+        if (this.args.scmType === enums_1.ScmType.GitHub) {
             const githubArgs = this.args;
             auditParams = {
                 days: this.args.days,
@@ -30,7 +31,7 @@ class SOOSSCMAudit {
                 secret: this.args.secret,
             };
         }
-        else if (this.args.scmType === api_client_1.ScmType.BitbucketCloud) {
+        else if (this.args.scmType === enums_1.ScmType.BitbucketCloud) {
             const bitbucketCloudArgs = this.args;
             auditParams = {
                 days: this.args.days,

package/bin/services/ContributorAuditArgumentParser.d.ts

@@ -0,0 +1,17 @@
+import { ArgumentParserBase, ICommonArguments } from "@soos-io/api-client";
+import { ScmResultsFormat, ScmType } from "../enums";
+import { Command, OptionValues } from "commander";
+interface IContributorAuditArguments extends ICommonArguments {
+    days: number;
+    secret: string;
+    saveResults: ScmResultsFormat;
+    scmType: ScmType;
+}
+declare class ContributorAuditArgumentParser extends ArgumentParserBase {
+    constructor(argumentParser: Command);
+    static create(): ContributorAuditArgumentParser;
+    addBaseContributorArguments(): void;
+    parseArguments<T extends OptionValues>(): T;
+}
+export default ContributorAuditArgumentParser;
+export { IContributorAuditArguments };

package/bin/services/ContributorAuditArgumentParser.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const GitHubContributorAuditProvider_1 = tslib_1.__importDefault(require("./ContributorAuditService/providers/GitHub/GitHubContributorAuditProvider"));
+const BitbucketCloudContributorAuditProvider_1 = tslib_1.__importDefault(require("./ContributorAuditService/providers/BitbucketCloud/BitbucketCloudContributorAuditProvider"));
+const api_client_1 = require("@soos-io/api-client");
+const enums_1 = require("../enums");
+const commander_1 = require("commander");
+const constants_1 = require("../constants");
+class ContributorAuditArgumentParser extends api_client_1.ArgumentParserBase {
+    constructor(argumentParser) {
+        super(argumentParser);
+    }
+    static create() {
+        const parser = commander_1.program.description("SOOS SCM Audit");
+        return new ContributorAuditArgumentParser(parser);
+    }
+    addBaseContributorArguments() {
+        this.argumentParser.option("--days", "Number of days to look back for commits.", (value) => {
+            const parsedValue = parseInt(value, 10);
+            if (isNaN(parsedValue) || parsedValue <= 0) {
+                throw new Error(`Invalid value for days: ${value}`);
+            }
+            return parsedValue;
+        }, constants_1.SOOS_SCM_AUDIT_CONSTANTS.Parameters.DefaultDaysAgo);
+        this.addEnumArgument("--saveResults", enums_1.ScmResultsFormat, "Save results to file, options available: JSON, TXT.", enums_1.ScmResultsFormat.TXT);
+        this.addEnumArgument("--scmType", enums_1.ScmType, "Scm Type to use for the audit. Options: GitHub, Bitbucket.", enums_1.ScmType.GitHub);
+    }
+    parseArguments() {
+        this.addCommonArguments();
+        this.addBaseContributorArguments();
+        this.argumentParser.parse();
+        const preProviderArgs = this.argumentParser.opts();
+        switch (preProviderArgs.scmType) {
+            case enums_1.ScmType.GitHub:
+                GitHubContributorAuditProvider_1.default.addProviderArgs(this.argumentParser);
+                break;
+            case enums_1.ScmType.BitbucketCloud:
+                BitbucketCloudContributorAuditProvider_1.default.addProviderArgs(this.argumentParser);
+                break;
+            default:
+                throw new Error("Unsupported scmType");
+        }
+        this.argumentParser.parse();
+        const args = this.argumentParser.opts();
+        return args;
+    }
+}
+exports.default = ContributorAuditArgumentParser;

package/bin/services/ContributorAuditService/ContributorAuditService.d.ts

@@ -0,0 +1,18 @@
+import { ScmResultsFormat, ScmType } from "../../enums";
+import SOOSHooksApiClient, { IContributorAuditModel } from "@soos-io/api-client/dist/api/SOOSHooksApiClient";
+export interface IContributorAuditProvider {
+    audit(implementationParams: Record<string, string | number>): Promise<IContributorAuditModel>;
+}
+declare class ContributorAuditService {
+    private auditProvider;
+    hooksApiClient: SOOSHooksApiClient;
+    constructor(auditProvider: IContributorAuditProvider, hooksApiClient: SOOSHooksApiClient);
+    static create(apiKey: string, apiURL: string, scmType: ScmType): ContributorAuditService;
+    audit(implementationParams: Record<string, string | number>): Promise<IContributorAuditModel>;
+    uploadContributorAudits(clientHash: string, contributorAudit: IContributorAuditModel): Promise<void>;
+    saveResults(results: IContributorAuditModel, format: ScmResultsFormat): Promise<void>;
+    private saveResultsAsJSON;
+    private saveResultsAsTXT;
+    private validateCommonParams;
+}
+export default ContributorAuditService;

package/bin/services/ContributorAuditService/ContributorAuditService.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const fs_1 = tslib_1.__importDefault(require("fs"));
+const Path = tslib_1.__importStar(require("path"));
+const utilities_1 = require("./utilities");
+const GitHubContributorAuditProvider_1 = tslib_1.__importDefault(require("./providers/GitHub/GitHubContributorAuditProvider"));
+const BitbucketCloudContributorAuditProvider_1 = tslib_1.__importDefault(require("./providers/BitbucketCloud/BitbucketCloudContributorAuditProvider"));
+const enums_1 = require("../../enums");
+const SOOSHooksApiClient_1 = tslib_1.__importDefault(require("@soos-io/api-client/dist/api/SOOSHooksApiClient"));
+const constants_1 = require("../../constants");
+const api_client_1 = require("@soos-io/api-client");
+class ContributorAuditService {
+    auditProvider;
+    hooksApiClient;
+    constructor(auditProvider, hooksApiClient) {
+        this.auditProvider = auditProvider;
+        this.hooksApiClient = hooksApiClient;
+    }
+    static create(apiKey, apiURL, scmType) {
+        let auditProvider;
+        switch (scmType) {
+            case enums_1.ScmType.GitHub: {
+                auditProvider = new GitHubContributorAuditProvider_1.default();
+                break;
+            }
+            case enums_1.ScmType.BitbucketCloud: {
+                auditProvider = new BitbucketCloudContributorAuditProvider_1.default();
+                break;
+            }
+            default: {
+                throw new Error(`Unsupported SCM type: ${scmType}`);
+            }
+        }
+        const hooksApiClient = new SOOSHooksApiClient_1.default(apiKey, apiURL.replace("api.", "api-hooks."));
+        return new ContributorAuditService(auditProvider, hooksApiClient);
+    }
+    async audit(implementationParams) {
+        this.validateCommonParams(implementationParams);
+        const contributors = await this.auditProvider.audit(implementationParams);
+        api_client_1.soosLogger.debug(`Contributing Developers found: ${JSON.stringify(contributors, null, 2)}`);
+        return contributors;
+    }
+    async uploadContributorAudits(clientHash, contributorAudit) {
+        api_client_1.soosLogger.info(`Uploading Contributor Audit to SOOS.`);
+        await this.hooksApiClient.postContributorAudits(clientHash, contributorAudit);
+        api_client_1.soosLogger.info(`Results uploaded successfully.`);
+    }
+    async saveResults(results, format) {
+        api_client_1.soosLogger.info(`Saving results.`);
+        switch (format) {
+            case enums_1.ScmResultsFormat.JSON: {
+                await this.saveResultsAsJSON(results);
+                break;
+            }
+            case enums_1.ScmResultsFormat.TXT: {
+                await this.saveResultsAsTXT(results);
+                break;
+            }
+            default: {
+                throw new Error(`Unsupported format: ${format}`);
+            }
+        }
+    }
+    async saveResultsAsJSON(results) {
+        fs_1.default.writeFileSync(Path.join(process.cwd(), `${constants_1.SOOS_SCM_AUDIT_CONSTANTS.Files.ContributorAuditResults}.json`), JSON.stringify(results, null, 2));
+        api_client_1.soosLogger.info(`Results saved successfully ${Path.join(process.cwd(), `${constants_1.SOOS_SCM_AUDIT_CONSTANTS.Files.ContributorAuditResults}.json`)}`);
+    }
+    async saveResultsAsTXT(results) {
+        const uniqueContributors = new Set();
+        results.contributors
+            .sort((a, b) => a.username.localeCompare(b.username))
+            .forEach((contributor) => {
+            uniqueContributors.add(contributor.username);
+        });
+        fs_1.default.writeFileSync(Path.join(process.cwd(), `${constants_1.SOOS_SCM_AUDIT_CONSTANTS.Files.ContributorAuditResults}.txt`), Array.from(uniqueContributors).join("\n"));
+        api_client_1.soosLogger.info(`Results saved successfully ${Path.join(process.cwd(), `${constants_1.SOOS_SCM_AUDIT_CONSTANTS.Files.ContributorAuditResults}.txt`)}`);
+    }
+    validateCommonParams(implementationParams) {
+        if (!implementationParams["days"]) {
+            throw new Error("Days is required");
+        }
+        if (utilities_1.ParamUtilities.getAsNumber(implementationParams, "days") < 0) {
+            throw new Error("Days must be greater than 0");
+        }
+    }
+}
+exports.default = ContributorAuditService;

package/bin/services/ContributorAuditService/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./providers";
+export * from "./ContributorAuditService";

package/bin/services/ContributorAuditService/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./providers"), exports);
+tslib_1.__exportStar(require("./ContributorAuditService"), exports);

package/bin/services/ContributorAuditService/providers/BitbucketCloud/BitbucketCloudApiClient.d.ts

@@ -0,0 +1,53 @@
+import { IContributorAuditRepositories } from "@soos-io/api-client/dist/api/SOOSHooksApiClient";
+export interface BitbucketRepositoryApiResponse {
+    values: BitbucketCloudRepository[];
+    next?: string;
+}
+export interface BitbucketCloudRepository {
+    uuid: string;
+    full_name: string;
+    name: string;
+    is_private: boolean;
+    updated_on: string;
+    workspace: BitbucketCloudWorkspace;
+}
+export interface BitbucketCloudWorkspace {
+    type: string;
+    uuid: string;
+    name: string;
+    slug: string;
+}
+export interface BitbucketCloudCommitsApiResponse {
+    values: BitbucketCloudCommit[];
+    next?: string;
+}
+export interface BitbucketCloudCommit {
+    author: BitbucketCloudAuthor;
+    date: string;
+}
+export interface BitbucketCloudAuthor {
+    raw: string;
+    name: string;
+    emailAddress: string;
+    displayName: string;
+    user: BitbucketCloudUser;
+}
+interface BitbucketCloudUser {
+    display_name: string;
+    type: string;
+    nickname: string;
+}
+declare class BitbucketCloudApiClient {
+    private readonly client;
+    private readonly workspace;
+    private readonly days;
+    private readonly dateToFilter;
+    constructor(days: number, username: string, password: string, workspace: string, baseUri?: string);
+    private static createHttpClient;
+    getBitbucketCloudRepositories(): Promise<BitbucketCloudRepository[]>;
+    getBitbucketCloudRepositoryContributors(repository: BitbucketCloudRepository): Promise<IContributorAuditRepositories[]>;
+    private setupInterceptor;
+    private static handleRepositoryPagination;
+    private handleCommitPagination;
+}
+export default BitbucketCloudApiClient;

package/bin/services/ContributorAuditService/providers/BitbucketCloud/BitbucketCloudApiClient.js

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const axios_1 = tslib_1.__importDefault(require("axios"));
+const constants_1 = require("./constants");
+const utilities_1 = require("../../utilities");
+const utilities_2 = require("@soos-io/api-client/dist/utilities");
+const api_client_1 = require("@soos-io/api-client");
+class BitbucketCloudApiClient {
+    client;
+    workspace;
+    days;
+    dateToFilter;
+    constructor(days, username, password, workspace, baseUri = constants_1.SOOS_BITBUCKET_CLOUD_CONTRIBUTOR_AUDIT_CONSTANTS.Urls.API.Base) {
+        this.workspace = workspace;
+        this.days = days;
+        this.dateToFilter = utilities_2.DateUtilities.getDate(this.days).toISOString();
+        this.client = BitbucketCloudApiClient.createHttpClient({
+            baseUri,
+            username: username,
+            password: password,
+            apiClientName: "BitbucketCloud API",
+            dateToFilter: this.dateToFilter,
+        });
+    }
+    static createHttpClient({ baseUri, username, password }) {
+        const client = axios_1.default.create({
+            baseURL: baseUri,
+            auth: {
+                username: username,
+                password: password,
+            },
+        });
+        return client;
+    }
+    async getBitbucketCloudRepositories() {
+        this.client.interceptors.response.use((response) => {
+            if (response.data.next) {
+                return BitbucketCloudApiClient.handleRepositoryPagination(response, this.client, this.dateToFilter);
+            }
+            return response;
+        });
+        const response = await this.client.get(`repositories/${this.workspace}`);
+        const repoResponse = response.data;
+        const repos = repoResponse.values.filter((repo) => utilities_2.DateUtilities.isWithinDateRange(new Date(repo.updated_on), new Date(this.dateToFilter)));
+        return repos;
+    }
+    async getBitbucketCloudRepositoryContributors(repository) {
+        await this.setupInterceptor(this.client, "BitbucketCloud API", this.dateToFilter, this.handleCommitPagination);
+        const response = await this.client.get(`repositories/${this.workspace}/${repository.name}/commits`);
+        response.data.values = response.data.values.filter((commit) => utilities_2.DateUtilities.isWithinDateRange(new Date(commit.date), new Date(this.dateToFilter)));
+        const commits = response.data;
+        const contributors = commits.values.reduce((acc, commit) => {
+            const username = commit.author.user ? commit.author.user.display_name : "Unknown Author";
+            const commitDate = commit.date;
+            const repo = {
+                id: repository.uuid,
+                name: repository.name,
+                lastCommit: commitDate,
+                isPrivate: repository.is_private,
+            };
+            return utilities_1.DataMappingUtilities.updateContributors(acc, repo, username, commitDate);
+        }, []);
+        return contributors;
+    }
+    async setupInterceptor(client, apiClientName, dateToFilter, paginationFunction) {
+        client.interceptors.response.clear();
+        client.interceptors.response.use(async (response) => {
+            api_client_1.soosLogger.debug(apiClientName, `Response Body: ${JSON.stringify(response.data)}`);
+            if (response.data.next) {
+                return await paginationFunction(response, client, dateToFilter);
+            }
+            return response;
+        }, async (error) => {
+            const { config, response } = error;
+            const maxRetries = 3;
+            config.retryCount = config.retryCount || 0;
+            if (response?.status === 429 && config.retryCount < maxRetries) {
+                api_client_1.soosLogger.debug(apiClientName, `Rate limit exceeded on the BitbucketCloud API. Waiting ${constants_1.SOOS_BITBUCKET_CLOUD_CONTRIBUTOR_AUDIT_CONSTANTS.RetrySeconds} seconds before retrying. Retry count: ${config.retryCount}`);
+                config.retryCount += 1;
+                await (0, utilities_2.sleep)(constants_1.SOOS_BITBUCKET_CLOUD_CONTRIBUTOR_AUDIT_CONSTANTS.RetrySeconds * 1000);
+                return client(config);
+            }
+            if (response?.status) {
+                api_client_1.soosLogger.debug(apiClientName, `Response Status: ${response.status}`);
+            }
+            return Promise.reject(error);
+        });
+    }
+    static async handleRepositoryPagination(response, client, dateToFilter) {
+        const data = response.data;
+        let nextUrl = data.next;
+        let isWithinDateRange = data.values.every((repo) => utilities_2.DateUtilities.isWithinDateRange(new Date(repo.updated_on), new Date(dateToFilter)));
+        while (nextUrl && isWithinDateRange) {
+            api_client_1.soosLogger.debug("Fetching next page", nextUrl);
+            const nextPageResponse = await client.get(nextUrl);
+            data.values = data.values.concat(nextPageResponse.data.values);
+            nextUrl = nextPageResponse.data.next ?? undefined;
+            isWithinDateRange = nextPageResponse.data.values.every((repo) => utilities_2.DateUtilities.isWithinDateRange(new Date(repo.updated_on), new Date(dateToFilter)));
+        }
+        return { ...response, data };
+    }
+    async handleCommitPagination(response, client, dateToFilter) {
+        const data = response.data;
+        let nextUrl = data.next;
+        let lastCommitDate = new Date(data.values[data.values.length - 1].date);
+        let isWithinDateRange = utilities_2.DateUtilities.isWithinDateRange(lastCommitDate, new Date(dateToFilter));
+        while (nextUrl && isWithinDateRange) {
+            api_client_1.soosLogger.debug("Fetching next page", nextUrl);
+            const nextPageResponse = await client.get(nextUrl);
+            data.values = data.values.concat(nextPageResponse.data.values);
+            api_client_1.soosLogger.debug(`Checking if commits are within date range min date ${new Date(dateToFilter)}`);
+            lastCommitDate = new Date(nextPageResponse.data.values[nextPageResponse.data.values.length - 1].date);
+            isWithinDateRange = utilities_2.DateUtilities.isWithinDateRange(lastCommitDate, new Date(dateToFilter));
+            nextUrl = nextPageResponse.data.next ?? undefined;
+        }
+        return { ...response, data };
+    }
+}
+exports.default = BitbucketCloudApiClient;

package/bin/services/ContributorAuditService/providers/BitbucketCloud/BitbucketCloudContributorAuditProvider.d.ts

@@ -0,0 +1,15 @@
+import { IContributorAuditProvider } from "../../ContributorAuditService";
+import { IContributorAuditArguments } from "../../../ContributorAuditArgumentParser";
+import { IContributorAuditModel } from "@soos-io/api-client/dist/api/SOOSHooksApiClient";
+import { Command } from "commander";
+interface IBitBucketContributorAuditArguments extends IContributorAuditArguments {
+    username: string;
+    workspace: string;
+}
+declare class BitbucketCloudContributorAuditProvider implements IContributorAuditProvider {
+    audit(implementationParams: Record<string, string | number>): Promise<IContributorAuditModel>;
+    static addProviderArgs(argumentParser: Command): void;
+    private getBitbucketCloudRepositoryContributors;
+}
+export default BitbucketCloudContributorAuditProvider;
+export { IBitBucketContributorAuditArguments };

package/bin/services/ContributorAuditService/providers/BitbucketCloud/BitbucketCloudContributorAuditProvider.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const utilities_1 = require("../../utilities");
+const BitbucketCloudApiClient_1 = tslib_1.__importDefault(require("./BitbucketCloudApiClient"));
+const constants_1 = require("./constants");
+const api_client_1 = require("@soos-io/api-client");
+class BitbucketCloudContributorAuditProvider {
+    async audit(implementationParams) {
+        const bitbucketPAT = utilities_1.ParamUtilities.getAsString(implementationParams, "secret");
+        const workspace = utilities_1.ParamUtilities.getAsString(implementationParams, "workspace");
+        const days = utilities_1.ParamUtilities.getAsNumber(implementationParams, "days");
+        const username = utilities_1.ParamUtilities.getAsString(implementationParams, "username");
+        const bitbucketApiClient = new BitbucketCloudApiClient_1.default(days, username, bitbucketPAT, workspace);
+        const repositories = await bitbucketApiClient.getBitbucketCloudRepositories();
+        api_client_1.soosLogger.debug("Fetching commits for each repository");
+        const contributors = await this.getBitbucketCloudRepositoryContributors(bitbucketApiClient, repositories, constants_1.SOOS_BITBUCKET_CLOUD_CONTRIBUTOR_AUDIT_CONSTANTS.RequestBatchSize);
+        const scriptVersion = utilities_1.ParamUtilities.getAsString(implementationParams, "scriptVersion");
+        const finalContributors = {
+            metadata: {
+                scriptVersion: scriptVersion,
+                days: days,
+            },
+            organizationName: workspace,
+            contributors: contributors,
+        };
+        return finalContributors;
+    }
+    static addProviderArgs(argumentParser) {
+        argumentParser.requiredOption("--workspace", "Organization name to use for the audit.");
+        argumentParser.requiredOption("--secret", "Secret to use for api calls, it should be an app password.");
+        argumentParser.requiredOption("--username", "Username for audit.");
+    }
+    async getBitbucketCloudRepositoryContributors(bitbucketApiClient, repositories, batchSize) {
+        const contributorsArray = [];
+        for (let i = 0; i < repositories.length; i += batchSize) {
+            const batch = repositories.slice(i, i + batchSize);
+            const results = await Promise.all(batch.map((repo) => bitbucketApiClient.getBitbucketCloudRepositoryContributors(repo)));
+            contributorsArray.push(...results);
+        }
+        return utilities_1.DataMappingUtilities.mergeContributors(contributorsArray);
+    }
+}
+exports.default = BitbucketCloudContributorAuditProvider;

package/bin/services/ContributorAuditService/providers/BitbucketCloud/constants.d.ts

@@ -0,0 +1,12 @@
+export declare const SOOS_BITBUCKET_CLOUD_CONTRIBUTOR_AUDIT_CONSTANTS: {
+    Urls: {
+        API: {
+            Base: string;
+        };
+        Docs: {
+            AppPassword: string;
+        };
+    };
+    RequestBatchSize: number;
+    RetrySeconds: number;
+};

package/bin/services/ContributorAuditService/providers/BitbucketCloud/constants.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SOOS_BITBUCKET_CLOUD_CONTRIBUTOR_AUDIT_CONSTANTS = void 0;
+exports.SOOS_BITBUCKET_CLOUD_CONTRIBUTOR_AUDIT_CONSTANTS = {
+    Urls: {
+        API: {
+            Base: "https://api.bitbucket.org/2.0/",
+        },
+        Docs: {
+            AppPassword: "https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/",
+        },
+    },
+    RequestBatchSize: 10,
+    RetrySeconds: 60,
+};

package/bin/services/ContributorAuditService/providers/BitbucketCloud/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./BitbucketCloudApiClient";
+export * from "./BitbucketCloudContributorAuditProvider";

package/bin/services/ContributorAuditService/providers/BitbucketCloud/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./BitbucketCloudApiClient"), exports);
+tslib_1.__exportStar(require("./BitbucketCloudContributorAuditProvider"), exports);

package/bin/services/ContributorAuditService/providers/GitHub/GitHubApiClient.d.ts

@@ -0,0 +1,36 @@
+import { IContributorAuditRepositories } from "@soos-io/api-client/dist/api/SOOSHooksApiClient";
+export interface GitHubOrganization {
+    login: string;
+}
+export interface GitHubRepository {
+    id: number;
+    name: string;
+    full_name: string;
+    private: boolean;
+    owner: GitHubOrganization;
+    pushed_at: string;
+}
+export interface GitHubCommits {
+    commit: {
+        author: GitHubAuthor;
+    };
+}
+export interface GitHubAuthor {
+    name: string;
+    email: string;
+    date: string;
+}
+declare class GitHubApiClient {
+    private readonly client;
+    private readonly organizationName;
+    private readonly days;
+    private readonly dateToFilter;
+    constructor(days: number, gitHubPAT: string, organizationName: string, baseUri?: string);
+    private static createHttpClient;
+    private static handleNextPage;
+    private static getNextPageUrl;
+    getGitHubOrganizations(): Promise<GitHubOrganization[]>;
+    getGitHubOrganizationRepositories(organization: GitHubOrganization): Promise<GitHubRepository[]>;
+    getGitHubRepositoryContributors(repository: GitHubRepository): Promise<IContributorAuditRepositories[]>;
+}
+export default GitHubApiClient;

package/bin/services/ContributorAuditService/providers/GitHub/GitHubApiClient.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const axios_1 = tslib_1.__importDefault(require("axios"));
+const constants_1 = require("./constants");
+const utilities_1 = require("../../utilities");
+const utilities_2 = require("@soos-io/api-client/dist/utilities");
+const api_client_1 = require("@soos-io/api-client");
+class GitHubApiClient {
+    client;
+    organizationName;
+    days;
+    dateToFilter;
+    constructor(days, gitHubPAT, organizationName, baseUri = constants_1.SOOS_GITHUB_CONTRIBUTOR_AUDIT_CONSTANTS.Urls.API.Base) {
+        this.client = GitHubApiClient.createHttpClient({
+            baseUri,
+            gitHubPAT: gitHubPAT,
+            apiClientName: "GitHub API",
+        });
+        this.organizationName = organizationName;
+        this.days = days;
+        this.dateToFilter = utilities_2.DateUtilities.getDate(this.days).toISOString();
+    }
+    static createHttpClient({ baseUri, gitHubPAT: gitHubPAT, apiClientName, }) {
+        const client = axios_1.default.create({
+            baseURL: baseUri,
+            headers: {
+                accept: "application/vnd.github+json",
+                Authorization: `Bearer ${gitHubPAT}`,
+            },
+        });
+        client.interceptors.request.use((request) => {
+            if (request.data) {
+                api_client_1.soosLogger.debug(apiClientName, `Request URL: ${request.method?.toLocaleUpperCase()} ${request.url}`);
+                if (request.params) {
+                    api_client_1.soosLogger.debug(apiClientName, `Request Params: ${JSON.stringify(request.params)}`);
+                }
+                api_client_1.soosLogger.debug(apiClientName, `Request Body: ${JSON.stringify(request.data)}`);
+            }
+            return request;
+        }, (rejectedRequest) => {
+            return Promise.reject(rejectedRequest);
+        });
+        client.interceptors.response.use(async (response) => {
+            api_client_1.soosLogger.debug(apiClientName, `Response Body: ${JSON.stringify(response.data)}`);
+            if (response.config.url?.includes("per_page")) {
+                return await GitHubApiClient.handleNextPage(response, client);
+            }
+            return response;
+        }, async (error) => {
+            const { config, response } = error;
+            const maxRetries = 3;
+            config.retryCount = config.retryCount || 0;
+            if ((response?.status === 429 || response?.status === 403) &&
+                config.retryCount < maxRetries) {
+                const rateLimitReset = response?.headers["x-ratelimit-reset"];
+                if (rateLimitReset) {
+                    api_client_1.soosLogger.debug(`Trying to parse rate limit reset: ${rateLimitReset}`);
+                    const rateLimitDate = utilities_2.DateUtilities.getDateFromUnixUTC(rateLimitReset);
+                    const timeToWait = Math.floor((rateLimitDate.getTime() - Date.now()) / 1000);
+                    api_client_1.soosLogger.debug(apiClientName, `Rate limit exceeded on the GitHub API. Waiting ${timeToWait} seconds before retrying. Retry count: ${config.retryCount}`);
+                    config.retryCount += 1;
+                    await (0, utilities_2.sleep)(timeToWait * 1000);
+                }
+                return client(config);
+            }
+            if (response?.status) {
+                api_client_1.soosLogger.debug(apiClientName, `Response Status: ${response.status}`);
+            }
+            if (response?.data?.message) {
+                api_client_1.soosLogger.debug(apiClientName, `Response Message: ${response.data.message}`);
+            }
+            return Promise.reject(error);
+        });
+        return client;
+    }
+    static async handleNextPage(response, client) {
+        let data = response.data;
+        const nextUrl = GitHubApiClient.getNextPageUrl(response);
+        if (nextUrl) {
+            api_client_1.soosLogger.debug("Fetching next page", nextUrl);
+            const nextPageResponse = await client.get(nextUrl);
+            data = data.concat(nextPageResponse.data);
+        }
+        return { ...response, data };
+    }
+    static getNextPageUrl(response) {
+        const linkHeader = response.headers["link"];
+        const nextLink = linkHeader?.split(",").find((s) => s.includes('rel="next"'));
+        return nextLink
+            ? new URL(nextLink.split(";")[0].trim().slice(1, -1), response.config.baseURL).toString()
+            : null;
+    }
+    async getGitHubOrganizations() {
+        const response = await this.client.get(`user/orgs?per_page=100`);
+        const orgs = response.data.filter((org) => org.login.toLowerCase() === this.organizationName.toLowerCase());
+        if (orgs.length === 0) {
+            throw new Error(`Organization ${this.organizationName} not found`);
+        }
+        return orgs;
+    }
+    async getGitHubOrganizationRepositories(organization) {
+        const response = await this.client.get(`orgs/${organization.login}/repos?per_page=50`);
+        const repos = response.data.filter((repo) => utilities_2.DateUtilities.isWithinDateRange(new Date(repo.pushed_at), new Date(this.dateToFilter)));
+        return repos;
+    }
+    async getGitHubRepositoryContributors(repository) {
+        const response = await this.client.get(`repos/${repository.owner.login}/${repository.name}/commits?per_page=100&since=${this.dateToFilter}`);
+        const commits = await response.data;
+        const contributors = commits.reduce((acc, commit) => {
+            const username = commit.commit.author.name;
+            const commitDate = commit.commit.author.date;
+            const repo = {
+                id: repository.id.toString(),
+                name: repository.name,
+                lastCommit: commitDate,
+                isPrivate: repository.private,
+            };
+            return utilities_1.DataMappingUtilities.updateContributors(acc, repo, username, commitDate);
+        }, []);
+        return contributors;
+    }
+}
+exports.default = GitHubApiClient;

package/bin/services/ContributorAuditService/providers/GitHub/GitHubContributorAuditProvider.d.ts

@@ -0,0 +1,14 @@
+import { IContributorAuditProvider } from "../../ContributorAuditService";
+import { IContributorAuditArguments } from "../../../ContributorAuditArgumentParser";
+import { IContributorAuditModel } from "@soos-io/api-client/dist/api/SOOSHooksApiClient";
+import { Command } from "commander";
+interface IGitHubContributorAuditArguments extends IContributorAuditArguments {
+    organizationName: string;
+}
+declare class GitHubContributorAuditProvider implements IContributorAuditProvider {
+    audit(implementationParams: Record<string, string | number>): Promise<IContributorAuditModel>;
+    static addProviderArgs(argumentParser: Command): void;
+    private getGitHubRepositoryContributors;
+}
+export default GitHubContributorAuditProvider;
+export { IGitHubContributorAuditArguments };

package/bin/services/ContributorAuditService/providers/GitHub/GitHubContributorAuditProvider.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const utilities_1 = require("../../utilities");
+const GitHubApiClient_1 = tslib_1.__importDefault(require("./GitHubApiClient"));
+const constants_1 = require("./constants");
+const api_client_1 = require("@soos-io/api-client");
+class GitHubContributorAuditProvider {
+    async audit(implementationParams) {
+        const gitHubPAT = utilities_1.ParamUtilities.getAsString(implementationParams, "secret");
+        const organizationName = utilities_1.ParamUtilities.getAsString(implementationParams, "organizationName");
+        const days = utilities_1.ParamUtilities.getAsNumber(implementationParams, "days");
+        const gitHubApiClient = new GitHubApiClient_1.default(days, gitHubPAT, organizationName);
+        const organizations = await gitHubApiClient.getGitHubOrganizations();
+        api_client_1.soosLogger.debug("Fetching GitHub repositories");
+        const repositories = await Promise.all(organizations.map((org) => gitHubApiClient.getGitHubOrganizationRepositories(org)));
+        api_client_1.soosLogger.debug("Fetching commits for each repository");
+        const contributors = await this.getGitHubRepositoryContributors(gitHubApiClient, repositories.flatMap((repoArray) => {
+            return repoArray;
+        }), constants_1.SOOS_GITHUB_CONTRIBUTOR_AUDIT_CONSTANTS.RequestBatchSize);
+        const scriptVersion = utilities_1.ParamUtilities.getAsString(implementationParams, "scriptVersion");
+        const finalContributors = {
+            metadata: {
+                scriptVersion: scriptVersion,
+                days: days,
+            },
+            organizationName: organizationName,
+            contributors: contributors,
+        };
+        return finalContributors;
+    }
+    static addProviderArgs(argumentParser) {
+        argumentParser.requiredOption("--organizationName", "Organization name to use for the audit.");
+        argumentParser.requiredOption("--secret", "Secret to use for api calls, it should be a GPAT.");
+    }
+    async getGitHubRepositoryContributors(gitHubApiClient, repositories, batchSize) {
+        const contributorsArray = [];
+        for (let i = 0; i < repositories.length; i += batchSize) {
+            const batch = repositories.slice(i, i + batchSize);
+            const results = await Promise.all(batch.map((repo) => gitHubApiClient.getGitHubRepositoryContributors(repo)));
+            contributorsArray.push(...results);
+        }
+        return utilities_1.DataMappingUtilities.mergeContributors(contributorsArray);
+    }
+}
+exports.default = GitHubContributorAuditProvider;

package/bin/services/ContributorAuditService/providers/GitHub/constants.d.ts

@@ -0,0 +1,11 @@
+export declare const SOOS_GITHUB_CONTRIBUTOR_AUDIT_CONSTANTS: {
+    Urls: {
+        API: {
+            Base: string;
+        };
+        Docs: {
+            PAT: string;
+        };
+    };
+    RequestBatchSize: number;
+};

package/bin/services/ContributorAuditService/providers/GitHub/constants.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SOOS_GITHUB_CONTRIBUTOR_AUDIT_CONSTANTS = void 0;
+exports.SOOS_GITHUB_CONTRIBUTOR_AUDIT_CONSTANTS = {
+    Urls: {
+        API: {
+            Base: "https://api.github.com/",
+        },
+        Docs: {
+            PAT: "https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens",
+        },
+    },
+    RequestBatchSize: 10,
+};

package/bin/services/ContributorAuditService/providers/GitHub/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./GitHubApiClient";
+export * from "./GitHubContributorAuditProvider";

package/bin/services/ContributorAuditService/providers/GitHub/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./GitHubApiClient"), exports);
+tslib_1.__exportStar(require("./GitHubContributorAuditProvider"), exports);

package/bin/services/ContributorAuditService/providers/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./GitHub";
+export * from "./BitbucketCloud";

package/bin/services/ContributorAuditService/providers/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./GitHub"), exports);
+tslib_1.__exportStar(require("./BitbucketCloud"), exports);

package/bin/services/ContributorAuditService/utilities.d.ts

@@ -0,0 +1,10 @@
+import { IContributorAuditRepositories, IContributorAuditRepository } from "@soos-io/api-client/dist/api/SOOSHooksApiClient";
+declare const ParamUtilities: {
+    getAsString(params: Record<string, string | number>, key: string): string;
+    getAsNumber(params: Record<string, string | number>, key: string): number;
+};
+declare const DataMappingUtilities: {
+    updateContributors(acc: IContributorAuditRepositories[], repo: IContributorAuditRepository, username: string, commitDate: string): IContributorAuditRepositories[];
+    mergeContributors(contributorsArray: IContributorAuditRepositories[][]): IContributorAuditRepositories[];
+};
+export { ParamUtilities, DataMappingUtilities };

package/bin/services/ContributorAuditService/utilities.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataMappingUtilities = exports.ParamUtilities = void 0;
+const ParamUtilities = {
+    getAsString(params, key) {
+        const value = params[key];
+        if (typeof value !== "string") {
+            throw new Error(`Expected string for parameter '${key}', got ${typeof value}`);
+        }
+        return value;
+    },
+    getAsNumber(params, key) {
+        const value = params[key];
+        if (typeof value !== "number") {
+            throw new Error(`Expected number for parameter '${key}', got ${typeof value}`);
+        }
+        return value;
+    },
+};
+exports.ParamUtilities = ParamUtilities;
+const DataMappingUtilities = {
+    updateContributors(acc, repo, username, commitDate) {
+        const existingContributor = acc.find((contributor) => contributor.username === username);
+        if (!existingContributor) {
+            acc.push({ username, repositories: [repo] });
+        }
+        else {
+            const existingRepository = existingContributor.repositories.find((r) => r.id === repo.id);
+            if (!existingRepository) {
+                existingContributor.repositories.push(repo);
+            }
+            else if (new Date(existingRepository.lastCommit) < new Date(commitDate)) {
+                existingRepository.lastCommit = commitDate;
+            }
+        }
+        return acc;
+    },
+    mergeContributors(contributorsArray) {
+        const flattenedContributors = contributorsArray.flat();
+        const mergedContributors = new Map();
+        flattenedContributors.forEach((contributor) => {
+            const existingContributor = mergedContributors.get(contributor.username);
+            if (existingContributor) {
+                contributor.repositories.forEach((repository) => {
+                    if (!existingContributor.repositories.find((r) => r.id === repository.id)) {
+                        existingContributor.repositories.push(repository);
+                    }
+                });
+            }
+            else {
+                mergedContributors.set(contributor.username, contributor);
+            }
+        });
+        return Array.from(mergedContributors.values());
+    },
+};
+exports.DataMappingUtilities = DataMappingUtilities;

package/bin/services/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./ContributorAuditService";
+export * from "./ContributorAuditArgumentParser";

package/bin/services/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./ContributorAuditService"), exports);
+tslib_1.__exportStar(require("./ContributorAuditArgumentParser"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soos-io/soos-scm-audit",
-  "version": "0.1.3",
+  "version": "0.2.0-pre.1",
   "description": "SOOS SCM Audit CLI",
   "main": "bin/index.js",
   "scripts": {
@@ -31,13 +31,12 @@
   },
   "homepage": "https://github.com/soos-io/soos-scm-audit#readme",
   "dependencies": {
-    "@soos-io/api-client": "1.2.2",
-    "argparse": "^2.0.1",
+    "@soos-io/api-client": "1.3.0-pre.2",
+    "commander": "^13.1.0",
     "tslib": "^2.6.2"
   },
   "devDependencies": {
     "@eslint/js": "^9.21.0",
-    "@types/argparse": "^2.0.16",
     "@types/node": "^20.11.30",
     "eslint": "^9.21.0",
     "globals": "^16.0.0",