Dynamic checklist POC

.github/PULL_REQUEST_TEMPLATE.md

@@ -18,8 +18,8 @@ $ https://github.com/Expensify/App/issues/<issueID(comment)>
 
 Do NOT only link the issue number like this: $ #<issueID>
 --->
-$ 
-PROPOSAL: 
+$
+PROPOSAL:
 
 
 ### Tests
@@ -94,17 +94,6 @@ This is a checklist for PR authors. Please make sure to complete all tasks and c
 - [ ] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
 - [ ] I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
 - [ ] I verified that if a function's arguments changed that all usages have also been updated correctly
-- [ ] If a new component is created I verified that:
-    - [ ] A similar component doesn't exist in the codebase
-    - [ ] All props are defined accurately and each prop has a `/** comment above it */`
-    - [ ] The file is named correctly
-    - [ ] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
-    - [ ] The only data being stored in the state is data necessary for rendering and nothing else
-    - [ ] If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
-    - [ ] For Class Components, any internal methods passed to components event handlers are bound to `this` properly so there are no scoping issues (i.e. for `onClick={this.submit}` the method `this.submit` should be bound to `this` in the constructor)
-    - [ ] Any internal methods bound to `this` are necessary to be bound (i.e. avoid `this.submit = this.submit.bind(this);` if `this.submit` is never passed to a component event handler like `onClick`)
-    - [ ] All JSX used for rendering exists in the render method
-    - [ ] The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
 - [ ] If any new file was added I verified that:
     - [ ] The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
 - [ ] If a new CSS style is added I verified that:
@@ -116,7 +105,6 @@ This is a checklist for PR authors. Please make sure to complete all tasks and c
 - [ ] If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
 - [ ] If a new page is added, I verified it's using the `ScrollView` component to make it scrollable when more elements are added to the page.
 - [ ] If the `main` branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the `Test` steps.
-- [ ] I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.
 
 ### Screenshots/Videos
 <details>

.github/actions/javascript/authorChecklist/authorChecklist.js

@@ -1,12 +1,56 @@
 const core = require('@actions/core');
 const github = require('@actions/github');
 const https = require('https');
-const GitHubUtils = require('../../../libs/GithubUtils');
+const _ = require('lodash');
+const GithubUtils = require('../../../libs/GithubUtils');
+const CONST = require('../../../libs/CONST');
+const newComponentCategory = require('./newComponentCategory');
 
 const pathToAuthorChecklist = 'https://raw.githubusercontent.com/Expensify/App/main/.github/PULL_REQUEST_TEMPLATE.md';
-const authorChecklistStartsWith = '### PR Author Checklist';
-const reviewerChecklistStartsWith = '<summary><h4>PR Reviewer Checklist</h4>';
-const issue = github.context.payload.issue ? github.context.payload.issue.number : github.context.payload.pull_request.number;
+const checklistStartsWith = '### PR Author Checklist';
+const checklistEndsWith = "\r\n### Screenshots/Videos";
+
+const prNumber = github.context.payload.pull_request.number;
+
+const CHECKLIST_CATEGORIES = {
+    NEW_COMPONENT: newComponentCategory,
+};
+
+/**
+ * Look at the contents of the pull request, and determine which checklist categories apply.
+ *
+ * @returns {Promise<Array<String>>}
+ */
+async function getChecklistCategoriesForPullRequest() {
+    const categories = [];
+    const changedFiles = await GithubUtils.paginate(GithubUtils.octokit.pulls.listFiles, {
+        owner: CONST.GITHUB_OWNER,
+        repo: CONST.APP_REPO,
+        pull_number: prNumber,
+        per_page: 100,
+    });
+
+    for (const category of _.values(CHECKLIST_CATEGORIES)) {
+        const {detectFunction, items} = category;
+        const categoryDetected = await detectFunction(changedFiles);
+        if (categoryDetected) {
+            categories.push(items);
+        }
+    }
+    return categories;
+}
+
+/**
+ * Takes string in markdown, and divides it's content by two contant markers.
+ *
+ * @param {String} body
+ * @returns {[String, String, String]}
+ */
+function partitionWithChecklist(body) {
+    const [contentBeforeChecklist, contentAfterStartOfChecklist] = body.split(checklistStartsWith);
+    const [checklistContent, contentAfterChecklist] = contentAfterStartOfChecklist.split(checklistEndsWith);
+    return [contentBeforeChecklist, checklistContent, contentAfterChecklist];
+}
 
 /**
  * @returns {Promise}
@@ -20,12 +64,10 @@ function getNumberOfItemsFromAuthorChecklist() {
                     fileContents += chunk;
                 });
                 res.on('end', () => {
-                    // Currently, both the author and reviewer checklists are in the PR template file, so we need to do a little bit of parsing the PR description to get just the author
-                    // checklist.
-                    const contentAfterStartOfAuthorChecklist = fileContents.split(authorChecklistStartsWith).pop();
-                    const contentBeforeStartOfReviewerChecklist = contentAfterStartOfAuthorChecklist.split(reviewerChecklistStartsWith).shift();
+                    // eslint-disable-next-line no-unused-vars
+                    const [_start, checklist] = partitionWithChecklist(fileContents);
 
-                    const numberOfChecklistItems = (contentBeforeStartOfReviewerChecklist.match(/\[ \]/g) || []).length;
+                    const numberOfChecklistItems = (checklist.match(/\[ \]/g) || []).length;
                     resolve(numberOfChecklistItems);
                 });
             })
@@ -35,33 +77,107 @@ function getNumberOfItemsFromAuthorChecklist() {
 
 /**
  * @param {Number} numberOfChecklistItems
+ * @param {String} pullRequestBody
  */
-function checkIssueForCompletedChecklist(numberOfChecklistItems) {
-    GitHubUtils.getPullRequestBody(issue).then((pullRequestBody) => {
-        const contentAfterStartOfAuthorChecklist = pullRequestBody.split(authorChecklistStartsWith).pop();
-        const contentOfAuthorChecklist = contentAfterStartOfAuthorChecklist.split(reviewerChecklistStartsWith).shift();
+function checkPRForCompletedChecklist(numberOfChecklistItems, pullRequestBody) {
+    // eslint-disable-next-line no-unused-vars
+    const [_start, checklist] = partitionWithChecklist(pullRequestBody);
 
-        const numberOfFinishedChecklistItems = (contentOfAuthorChecklist.match(/- \[x\]/gi) || []).length;
-        const numberOfUnfinishedChecklistItems = (contentOfAuthorChecklist.match(/- \[ \]/g) || []).length;
+    const numberOfFinishedChecklistItems = (checklist.match(/- \[x\]/gi) || []).length;
+    const numberOfUnfinishedChecklistItems = (checklist.match(/- \[ \]/g) || []).length;
 
-        const maxCompletedItems = numberOfChecklistItems + 2;
-        const minCompletedItems = numberOfChecklistItems - 2;
+    const minCompletedItems = numberOfChecklistItems - 2;
 
-        console.log(`You completed ${numberOfFinishedChecklistItems} out of ${numberOfChecklistItems} checklist items with ${numberOfUnfinishedChecklistItems} unfinished items`);
+    console.log(`You completed ${numberOfFinishedChecklistItems} out of ${numberOfChecklistItems} checklist items with ${numberOfUnfinishedChecklistItems} unfinished items`);
 
-        if (numberOfFinishedChecklistItems >= minCompletedItems && numberOfFinishedChecklistItems <= maxCompletedItems && numberOfUnfinishedChecklistItems === 0) {
-            console.log('PR Author checklist is complete 🎉');
-            return;
-        }
+    if (numberOfFinishedChecklistItems >= minCompletedItems && numberOfUnfinishedChecklistItems === 0) {
+        console.log('PR Author checklist is complete 🎉');
+        return;
+    }
 
-        console.log(`Make sure you are using the most up to date checklist found here: ${pathToAuthorChecklist}`);
-        core.setFailed("PR Author Checklist is not completely filled out. Please check every box to verify you've thought about the item.");
-    });
+    console.log(`Make sure you are using the most up to date checklist found here: ${pathToAuthorChecklist}`);
+    core.setFailed("PR Author Checklist is not completely filled out. Please check every box to verify you've thought about the item.");
 }
 
-getNumberOfItemsFromAuthorChecklist()
-    .then(checkIssueForCompletedChecklist)
-    .catch((err) => {
+async function generateDynamicChecksAndCheckForCompletion() {
+    // Generate dynamic checks
+    const checks = new Set();
+    const categories = await getChecklistCategoriesForPullRequest();
+    for (const checksForCategory of categories) {
+        for (const check of checksForCategory) {
+            checks.add(check);
+        }
+    }
+
+    const body = github.context.payload.pull_request.body;
+
+    // eslint-disable-next-line prefer-const
+    let [contentBeforeChecklist, checklist, contentAfterChecklist] = partitionWithChecklist(body);
+
+    let isPassing = true;
+    let checklistChanged = false;
+    for (const check of checks) {
+        // Check if it's already in the PR body, capturing the whether or not it's already checked
+        const regex = new RegExp(`- \\[([ x])] ${_.escapeRegExp(check)}`);
+        const match = regex.exec(checklist);
+        if (!match) {
+            // Add it to the PR body
+            isPassing = false;
+            checklist += `- [ ] ${check}\r\n`;
+            checklistChanged = true;
+        } else {
+            const isChecked = match[1] === 'x';
+            if (!isChecked) {
+                isPassing = false;
+            }
+        }
+    }
+    const allChecks = _.flatten(_.map(_.values(CHECKLIST_CATEGORIES), 'items'));
+    for (const check of allChecks) {
+        if (!checks.has(check)) {
+            // Check if some dynamic check has been added with previous commit, but the check is not relevant anymore
+            const regex = new RegExp(`- \\[([ x])] ${_.escapeRegExp(check)}\r\n`);
+            const match = regex.exec(checklist);
+            if (match) {
+                // Remove it from the PR body
+                checklist = checklist.replace(match[0], '');
+                checklistChanged = true;
+            }
+        }
+    }
+
+    // Put the PR body back together, need to add the markers back in
+    const newBody = contentBeforeChecklist + checklistStartsWith + checklist + checklistEndsWith + contentAfterChecklist;
+
+    // Update the PR body
+    if (checklistChanged) {
+        await GithubUtils.octokit.pulls.update({
+            owner: CONST.GITHUB_OWNER,
+            repo: CONST.APP_REPO,
+            pull_number: prNumber,
+            body: newBody,
+        });
+        console.log('Updated PR checklist');
+    }
+
+    if (!isPassing) {
+        const err = new Error("New checks were added into checklist. Please check every box to verify you've thought about the item.");
         console.error(err);
         core.setFailed(err);
-    });
+    }
+
+    // check for completion
+    try {
+        const numberofItems = await getNumberOfItemsFromAuthorChecklist();
+        checkPRForCompletedChecklist(numberofItems, newBody);
+    } catch (err) {
+        console.error(err);
+        core.setFailed(err);
+    }
+}
+
+if (require.main === module) {
+    generateDynamicChecksAndCheckForCompletion();
+}
+
+module.exports = generateDynamicChecksAndCheckForCompletion;