v2.13.0: Added exclude option to filter reviewers

Author: manuelmhtr

CHANGELOG.md

@@ -1,6 +1,13 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [2.13.0] - 2024-02-10
+### Added
+- `exclude` option to exclude specific users from the stats.
+
+### Fixed
+- Reduces the block size in the Slack messages to prevent hitting the characters limit.
+
 ## [2.12.0] - 2024-02-06
 ### Changed
 - [#85](https://github.com/flowwer-dev/pull-request-stats/pull/85) Use Node v20 (by [antonindrawan](https://github.com/antonindrawan))

README.md

@@ -39,6 +39,8 @@ Just add this action to one of your [workflow files](https://docs.github.com/en/
         uses: flowwer-dev/pull-request-stats@master
 ```
 
+If you are getting an empty table or an error, check the [troubleshooting section](#troubleshooting).
+
 ### Action inputs
 
 The possible inputs for this action are:
@@ -47,18 +49,19 @@ The possible inputs for this action are:
 | --------- | ----------- | ------- |
 | `token` | A [Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) with `repo` permissions. Required to calculate stats for an organization or multiple repos. | `GITHUB_TOKEN` |
 | `repositories` | A comma-separated list of GitHub repositories to calculate the stats, e.g. `username/repo1,username/repo2`. When specifying other repo(s), **it is mandatory to pass a Personal Access Token** in the `token` parameter.| Current repository |
-| `organization` | If you prefer, you may specify your organization's name to calculate the stats across all of its repos. When specifying an organization, **it is mandatory to pass a Personal Access Token** in the `token` parameter. | `null`|
+| `organization` | If you prefer, you may specify your organization's name to calculate the stats across all of its repos. When specifying an organization, **it is mandatory to pass a Personal Access Token** in the `token` parameter. | `null` |
 | `period` | The period used to calculate the stats, expressed in days. | `30` |
-| `limit` | The maximum number of rows to display in the table. A value of `0` means unlimited. |`0`|
+| `limit` | The maximum number of rows to display in the table. A value of `0` means unlimited. | `0` |
 | `charts` | Whether to add a chart to the start. Possible values: `true` or `false`. | `false` |
 | `disableLinks` | If `true`, removes the links to the detailed charts. Possible values: `true` or `false`. | `false` |
 | `sortBy` | The column used to sort the data. Possible values: `REVIEWS`, `TIME`, `COMMENTS`. | `REVIEWS` |
 | `publishAs` | Where to publish the results. Possible values: as a `COMMENT`, on the pull request `DESCRIPTION`, or publish `NONE`. | `COMMENT` |
+| `exclude` | A comma-separated list of usernames (case-insensitive) to be excluded from the results (e.g. `username1,username2`), or a regular expression enclosed between slashes (eg. `/^bot/i` will exclude all usernames that begin with "bot"). | `null` |
 | `telemetry` | Indicates if the action is allowed to send monitoring data to the developer. This data is [minimal](/src/services/telemetry/sendStart.js) and helps me improve this action. **This option is a premium feature reserved for [sponsors](#premium-features-).** |`true`|
-| `slackWebhook` | **🔥 New.** A Slack webhook URL to post resulting stats. **This option is a premium feature reserved for [sponsors](#premium-features-).** See [full documentation here](/docs/slack.md).  |`null`|
-| `slackChannel` | The Slack channel where stats will be posted. Include the `#` character (eg. `#mychannel`). Required when a `slackWebhook` is configured. |`null`|
-| `teamsWebhook` | **🔥 New.** A Microsoft Teams webhook URL to post resulting stats. **This option is a premium feature reserved for [sponsors](#premium-features-).** See [full documentation here](/docs/teams.md).  |`null`|
-| `webhook` | **🔥 New.** A webhook URL to send the resulting stats as JSON (integrate with Zapier, IFTTT...). See [full documentation here](/docs/webhook.md). |`null`|
+| `slackWebhook` | **🔥 New.** A Slack webhook URL to post resulting stats. **This option is a premium feature reserved for [sponsors](#premium-features-).** See [full documentation here](/docs/slack.md).  | `null` |
+| `slackChannel` | The Slack channel where stats will be posted. Include the `#` character (eg. `#mychannel`). Required when a `slackWebhook` is configured. | `null` |
+| `teamsWebhook` | **🔥 New.** A Microsoft Teams webhook URL to post resulting stats. **This option is a premium feature reserved for [sponsors](#premium-features-).** See [full documentation here](/docs/teams.md).  | `null` |
+| `webhook` | **🔥 New.** A webhook URL to send the resulting stats as JSON (integrate with Zapier, IFTTT...). See [full documentation here](/docs/webhook.md). | `null` |
 
 
 ### Action outputs
@@ -179,6 +182,19 @@ Check the guide for the tool you want to integrate:
   1. Make sure the repositories have pull request reviews during the configured `period`.
   2. When specifying `repositories` or `organization` parameters, a [Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) is required in the `token` parameter.
   3. If providing a Personal Access Token, ensure it has the `repo` permission for the projects you want.
+  4. If you are not providing a Personal Access Token (thus, the action is using the default `GITHUB_TOKEN`), make sure the job has the `contents: read` and `pull-requests: write` [permissions](https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs#defining-access-for-the-github_token-scopes) While these permissions are typically provided by default, certain organizations may customize or overwrite them.
+
+  ```yml
+  jobs:
+    stats:
+      runs-on: ubuntu-latest
+      permissions:
+        contents: read
+        pull-requests: write
+      steps:
+        - name: Run pull request stats
+          uses: flowwer-dev/pull-request-stats@master
+  ```
 </details>
 
 <details>

action.yml

@@ -35,6 +35,9 @@ inputs:
     description: 'Where to publish the results. Possible values: "COMMENT", "DESCRIPTION" or "NONE"'
     required: false
     default: 'COMMENT'
+  exclude:
+    description: 'A list or regular expression to exclude users from the stats'
+    required: false
   disableLinks:
     description: 'Prevents from adding any external links in the stats'
     required: false

dist/index.js

@@ -41192,11 +41192,14 @@ module.exports = parseParams
 /***/ 1855:
 /***/ ((module) => {
 
-const getSlackCharsLimit = () => 39000;
-const getTeamsBytesLimit = () => 27000;
+const getSlackLimits = () => ({
+  chars: 30_000,
+  blocks: 50,
+});
+const getTeamsBytesLimit = () => 27_000;
 
 module.exports = {
-  getSlackCharsLimit,
+  getSlackLimits,
   getTeamsBytesLimit,
 };
 
@@ -41288,7 +41291,7 @@ const run = async (params) => {
   });
   core.info(`Found ${pulls.length} pull requests to analyze`);
 
-  const reviewersRaw = getReviewers(pulls);
+  const reviewersRaw = getReviewers(pulls, { excludeStr: params.excludeStr });
   core.info(`Analyzed stats for ${reviewersRaw.length} pull request reviewers`);
 
   const reviewers = setUpReviewers({
@@ -42062,6 +42065,18 @@ module.exports = (reviews) => {
 };
 
 
+/***/ }),
+
+/***/ 3966:
+/***/ ((module) => {
+
+module.exports = (exclude, username) => {
+  if (exclude.test) return !exclude.test(username);
+  if (exclude.includes) return !exclude.includes(username);
+  return true;
+};
+
+
 /***/ }),
 
 /***/ 9633:
@@ -42100,12 +42115,43 @@ module.exports = (pulls) => {
 /***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
 
 const calculateReviewsStats = __nccwpck_require__(3753);
+const filterReviewer = __nccwpck_require__(3966);
+const parseExclude = __nccwpck_require__(7960);
 const groupReviews = __nccwpck_require__(9633);
 
-module.exports = (pulls) => groupReviews(pulls).map(({ author, reviews }) => {
-  const stats = calculateReviewsStats(reviews);
-  return { author, reviews, stats };
-});
+module.exports = (pulls, { excludeStr } = {}) => {
+  const exclude = parseExclude(excludeStr);
+  return groupReviews(pulls)
+    .filter(({ author }) => filterReviewer(exclude, author.login))
+    .map(({ author, reviews }) => {
+      const stats = calculateReviewsStats(reviews);
+      return { author, reviews, stats };
+    });
+};
+
+
+/***/ }),
+
+/***/ 7960:
+/***/ ((module) => {
+
+const REGEXP_PATTERN = /^\/.+\/[a-z]*$/;
+
+// Github usernames can only contain alphanumeric characters and dashes (-)
+const sanitize = (str = '') => (str || '').replace(/[^-a-zA-Z0-9]/g, '').toLowerCase();
+
+const isRegExp = (str) => REGEXP_PATTERN.test(str);
+
+const parseRegExp = (str) => {
+  const [pattern, flags] = str.split('/').slice(1);
+  return new RegExp(pattern, flags);
+};
+
+module.exports = (excludeStr) => {
+  if (!sanitize(excludeStr)) return [];
+  if (isRegExp(excludeStr)) return parseRegExp(excludeStr);
+  return excludeStr.split(',').map(sanitize);
+};
 
 
 /***/ }),
@@ -43086,13 +43132,10 @@ module.exports = {
 /***/ ((module) => {
 
 class BaseSplitter {
-  constructor({ message, limit = null }) {
-    this.limit = limit || this.constructor.defaultLimit();
+  constructor({ message, limit = null, maxBlocksLength = null }) {
     this.message = message;
-  }
-
-  static defaultLimit() {
-    return Infinity;
+    this.limit = limit || Infinity;
+    this.maxBlocksLength = maxBlocksLength || Infinity;
   }
 
   get blockSize() {
@@ -43118,10 +43161,13 @@ class BaseSplitter {
     const blocksCount = this.constructor.getBlocksCount(message);
     const currentSize = this.constructor.calculateSize(message);
     const diff = currentSize - this.limit;
-    if (diff < 0 || blocksCount === 1) return 0;
+    const onLimit = diff <= 0 && blocksCount <= this.maxBlocksLength;
+    if (onLimit || blocksCount === 1) return 0;
 
     const blocksSpace = Math.ceil(diff / this.blockSize);
-    const blocksToSplit = Math.max(1, Math.min(blocksCount - 1, blocksSpace));
+    const upperBound = Math.min(blocksCount - 1, blocksSpace);
+    const exceedingBlocks = Math.max(0, blocksCount - this.maxBlocksLength);
+    const blocksToSplit = Math.max(1, upperBound, exceedingBlocks);
     const [firsts] = this.constructor.splitBlocks(message, blocksToSplit);
     return this.calculateBlocksToSplit(firsts) || blocksToSplit;
   }
@@ -43165,13 +43211,18 @@ module.exports = {
 /***/ 2843:
 /***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
 
-const { getSlackCharsLimit } = __nccwpck_require__(1855);
+const { getSlackLimits } = __nccwpck_require__(1855);
 const { median } = __nccwpck_require__(9988);
 const BaseSplitter = __nccwpck_require__(7027);
 
 class SlackSplitter extends BaseSplitter {
-  static defaultLimit() {
-    return getSlackCharsLimit();
+  constructor(args = {}) {
+    const limits = getSlackLimits();
+    super({
+      ...args,
+      limit: limits.chars,
+      maxBlocksLength: limits.blocks,
+    });
   }
 
   static splitBlocks(message, count) {
@@ -43212,8 +43263,11 @@ const { median } = __nccwpck_require__(9988);
 const BaseSplitter = __nccwpck_require__(7027);
 
 class TeamsSplitter extends BaseSplitter {
-  static defaultLimit() {
-    return getTeamsBytesLimit();
+  constructor(args = {}) {
+    super({
+      ...args,
+      limit: getTeamsBytesLimit(),
+    });
   }
 
   static splitBlocks(body, count) {
@@ -47978,7 +48032,7 @@ module.exports = JSON.parse('{"name":"mixpanel","description":"A simple server-s
 /***/ ((module) => {
 
 "use strict";
-module.exports = JSON.parse('{"name":"pull-request-stats","version":"2.12.0","description":"Github action to print relevant stats about Pull Request reviewers","main":"dist/index.js","type":"commonjs","scripts":{"build":"eslint src && ncc build src/index.js -o dist -a","test":"jest","lint":"eslint ./"},"keywords":[],"author":"Manuel de la Torre","license":"MIT","jest":{"testEnvironment":"node","testMatch":["**/?(*.)+(spec|test).[jt]s?(x)"]},"dependencies":{"@actions/core":"^1.10.1","@actions/github":"^6.0.0","axios":"^1.6.7","humanize-duration":"^3.31.0","i18n-js":"^3.9.2","jsurl":"^0.1.5","lodash.get":"^4.4.2","markdown-table":"^2.0.0","mixpanel":"^0.18.0"},"devDependencies":{"@vercel/ncc":"^0.38.1","eslint":"^8.56.0","eslint-config-airbnb-base":"^15.0.0","eslint-plugin-import":"^2.29.1","eslint-plugin-jest":"^27.6.3","jest":"^29.7.0"},"funding":"https://github.com/sponsors/manuelmhtr","packageManager":"yarn@4.1.0"}');
+module.exports = JSON.parse('{"name":"pull-request-stats","version":"2.13.0","description":"Github action to print relevant stats about Pull Request reviewers","main":"dist/index.js","type":"commonjs","scripts":{"build":"eslint src && ncc build src/index.js -o dist -a","test":"jest","lint":"eslint ./"},"keywords":[],"author":"Manuel de la Torre","license":"MIT","jest":{"testEnvironment":"node","testMatch":["**/?(*.)+(spec|test).[jt]s?(x)"]},"dependencies":{"@actions/core":"^1.10.1","@actions/github":"^6.0.0","axios":"^1.6.7","humanize-duration":"^3.31.0","i18n-js":"^3.9.2","jsurl":"^0.1.5","lodash.get":"^4.4.2","markdown-table":"^2.0.0","mixpanel":"^0.18.0"},"devDependencies":{"@vercel/ncc":"^0.38.1","eslint":"^8.56.0","eslint-config-airbnb-base":"^15.0.0","eslint-plugin-import":"^2.29.1","eslint-plugin-jest":"^27.6.3","jest":"^29.7.0"},"funding":"https://github.com/sponsors/manuelmhtr","packageManager":"yarn@4.1.0"}');
 
 /***/ }),
 
@@ -48086,6 +48140,7 @@ const getParams = () => {
     disableLinks: core.getBooleanInput('disableLinks') || core.getBooleanInput('disable-links'),
     pullRequestId: getPrId(),
     limit: parseInt(core.getInput('limit'), 10),
+    excludeStr: core.getInput('exclude'),
     telemetry: core.getBooleanInput('telemetry'),
     webhook: core.getInput('webhook'),
     slack: {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pull-request-stats",
-  "version": "2.12.0",
+  "version": "2.13.0",
   "description": "Github action to print relevant stats about Pull Request reviewers",
   "main": "dist/index.js",
   "type": "commonjs",

src/config/index.js

@@ -1,7 +1,10 @@
-const getSlackCharsLimit = () => 39000;
-const getTeamsBytesLimit = () => 27000;
+const getSlackLimits = () => ({
+  chars: 30_000,
+  blocks: 50,
+});
+const getTeamsBytesLimit = () => 27_000;
 
 module.exports = {
-  getSlackCharsLimit,
+  getSlackLimits,
   getTeamsBytesLimit,
 };

src/execute.js

@@ -50,7 +50,7 @@ const run = async (params) => {
   });
   core.info(`Found ${pulls.length} pull requests to analyze`);
 
-  const reviewersRaw = getReviewers(pulls);
+  const reviewersRaw = getReviewers(pulls, { excludeStr: params.excludeStr });
   core.info(`Analyzed stats for ${reviewersRaw.length} pull request reviewers`);
 
   const reviewers = setUpReviewers({

src/index.js

@@ -37,6 +37,7 @@ const getParams = () => {
     disableLinks: core.getBooleanInput('disableLinks') || core.getBooleanInput('disable-links'),
     pullRequestId: getPrId(),
     limit: parseInt(core.getInput('limit'), 10),
+    excludeStr: core.getInput('exclude'),
     telemetry: core.getBooleanInput('telemetry'),
     webhook: core.getInput('webhook'),
     slack: {

src/interactors/getReviewers/__tests__/filterReviewer.test.js

@@ -0,0 +1,30 @@
+const filterReviewer = require('../filterReviewer');
+
+describe('Interactors | getReviewers | .filterReviewer', () => {
+  const reviewers = [
+    'manuelmhtr',
+    'jartmez',
+    'bot1',
+    'bot2',
+  ];
+
+  it('filters out reviewers by a list of usernames', () => {
+    const exclude = ['manuelmhtr', 'jartmez'];
+    const results = reviewers.filter((reviewer) => filterReviewer(exclude, reviewer));
+    expect(results.length).toEqual(2);
+    expect(results).toEqual([
+      'bot1',
+      'bot2',
+    ]);
+  });
+
+  it('filters out reviewers by a regular expression', () => {
+    const exclude = /bot/;
+    const results = reviewers.filter((reviewer) => filterReviewer(exclude, reviewer));
+    expect(results.length).toEqual(2);
+    expect(results).toEqual([
+      'manuelmhtr',
+      'jartmez',
+    ]);
+  });
+});

src/interactors/getReviewers/__tests__/index.test.js

@@ -1,13 +1,13 @@
 const input = require('./mocks/pullRequests');
 const getReviewers = require('../index');
 
+const getAuthors = (reviewers) => reviewers.map((r) => r.author.login);
+
 describe('Interactors | getReviewers', () => {
   it('groups reviews by author and calculate its stats', () => {
     const result = getReviewers(input);
     expect(result.length).toEqual(2);
-
-    const authors = result.map((r) => r.author.login);
-    expect(authors).toContain('manuelmhtr', 'jartmez');
+    expect(getAuthors(result)).toContain('manuelmhtr', 'jartmez');
 
     result.forEach((reviewer) => {
       expect(reviewer).toHaveProperty('author');
@@ -21,4 +21,10 @@ describe('Interactors | getReviewers', () => {
       expect(reviewer.stats).toHaveProperty('timeToReview');
     });
   });
+
+  it('excludes reviewers when the option is passed', () => {
+    const result = getReviewers(input, { excludeStr: 'manuelmhtr' });
+    expect(result.length).toEqual(1);
+    expect(getAuthors(result)).not.toContain('manuelmhtr');
+  });
 });