switch to comment-rendering

Author: legomushroom

.env-template

@@ -1,2 +1,3 @@
-REPO_GITHUB_PAT="<github PAT>"
+REPO_GITHUB_READ_PAT="<github PAT>"
+REPO_GITHUB_WRITE_PAT="<github PAT>"
 CONFIG_PATH="./testConfig2.json"

README.md

@@ -2,6 +2,8 @@
   <a href="https://github.com/actions/typescript-action/actions"><img alt="typescript-action status" src="https://github.com/actions/typescript-action/workflows/build-test/badge.svg"></a>
 </p>
 
+*`releases/v2` branch implements the board rendering in a issue comment*
+
 # Create a JavaScript Action using TypeScript
 
 Use this template to bootstrap the creation of a TypeScript action.:rocket:

schemas/IConfig.json

@@ -45,7 +45,6 @@
   },
   "additionalProperties": false,
   "required": [
-    "boardIssue",
     "repos"
   ],
   "definitions": {
@@ -116,6 +115,10 @@
         "newCardsCutoffDays": {
           "description": "How many days should elapse since the beginning of\nthe sprint for a card to be treated as `new`.",
           "type": "number"
+        },
+        "boardComment": {
+          "description": "The issue that is used as aggregated board.",
+          "type": "string"
         }
       },
       "additionalProperties": false,

src/interfaces/IConfig.ts

@@ -4,7 +4,7 @@ export interface IConfig {
   /**
    * The issue that is used as aggregated board.
    */
-  boardIssue: string;
+  boardIssue?: string;
 
   /**
    * List of the repositories/projects to track.

src/interfaces/IParsedComment.ts

@@ -0,0 +1,5 @@
+import { IParsedIssue } from './IParsedIssue';
+
+export interface IParsedComment extends IParsedIssue {
+  commentId: number;
+}

src/interfaces/IParsedIssue.ts

@@ -1,5 +1,4 @@
 import { IParsedRepo } from './IParsedRepo';
-
 export interface IParsedIssue extends IParsedRepo {
   issueNumber: number;
 }

src/interfaces/IProject.ts

@@ -49,4 +49,9 @@ export interface IProject {
    * the sprint for a card to be treated as `new`.
    */
   newCardsCutoffDays?: number;
+
+  /**
+   * The issue that is used as aggregated board.
+   */
+  boardComment?: string;
 }

src/main.ts

@@ -9,34 +9,35 @@ import { renderProject } from './views/renderProject';
 import { getProjectData } from './utils/getProjectData';
 import { env } from './utils/env';
 import { getConfigs, validateConfig } from './config';
-import { renderOverview } from './views/renderOverview';
+// import { renderOverview } from './views/renderOverview';
 
 import { IConfig } from './interfaces/IConfig';
 
-const TOKEN_NAME = 'REPO_GITHUB_PAT';
+const TOKEN_READ_NAME = 'REPO_GITHUB_READ_PAT';
+const TOKEN_WRITE_NAME = 'REPO_GITHUB_READ_PAT';
 const CONFIG_PATH = 'CONFIG_PATH';
 
-const overwriteBoardIssue = async (
-  issueContents: string,
-  config: IConfig,
-  projectKit: ProjectsOctoKit,
-) => {
-  const { status } = await projectKit.updateBoardIssue(
-    config.boardIssue,
-    issueContents,
-  );
+// const overwriteBoardIssue = async (
+//   issueContents: string,
+//   config: IConfig,
+//   projectKit: ProjectsOctoKit,
+// ) => {
+//   const { status } = await projectKit.updateBoardIssue(
+//     config.boardIssue,
+//     issueContents,
+//   );
 
-  if (status !== 200) {
-    throw new Error(`Failed to update the issue ${config.boardIssue}`);
-  }
+//   if (status !== 200) {
+//     throw new Error(`Failed to update the issue ${config.boardIssue}`);
+//   }
 
-  console.log(`Successfully updated the board issue ${config.boardIssue}`);
-};
+//   console.log(`Successfully updated the board issue ${config.boardIssue}`);
+// };
 
-const getRegex = (projectId?: number) => {
-  const regex = /<!--\s*codespaces-board:start\s*-->([\W\w]*)<!--\s*codespaces-board:end\s*-->/gim;
-  return regex;
-};
+// const getRegex = (projectId?: number) => {
+//   const regex = /<!--\s*codespaces-board:start\s*-->([\W\w]*)<!--\s*codespaces-board:end\s*-->/gim;
+//   return regex;
+// };
 
 const wrapIssueText = (text: string, projectId?: number) => {
   return [
@@ -48,26 +49,98 @@ const wrapIssueText = (text: string, projectId?: number) => {
   ].join('\n');
 };
 
-const updateBoardIssue = async (
+// const updateBoardIssue = async (
+//   issueContents: string,
+//   config: IConfig,
+//   projectKit: ProjectsOctoKit,
+// ) => {
+//   if (!config.isReplaceProjectMarkers) {
+//     return await overwriteBoardIssue(issueContents, config, projectKit);
+//   }
+
+//   const issue = await projectKit.getBoardIssue(config.boardIssue);
+
+//   const { body } = issue;
+//   const newBody = body.replace(getRegex(), wrapIssueText(issueContents));
+
+//   await overwriteBoardIssue(newBody, config, projectKit);
+// };
+
+// const processConfigRecord = async (
+//   config: IConfig,
+//   projectKit: ProjectsOctoKit,
+// ) => {
+//   console.log('Processing config: \n', JSON.stringify(config, null, 2));
+
+//   const validationErrors = validateConfig(config);
+//   if (validationErrors.length) {
+//     console.error(
+//       `\n\nNot valid config for the issue ${config.boardIssue}, skipping.. \n`,
+//       validationErrors,
+//       '\n\n',
+//     );
+//     return;
+//   }
+
+//   console.log(`- Config schema validation passed.`);
+
+//   const repoProjects = await projectKit.getAllProjects(config.repos);
+
+//   const projectsWithData = [];
+//   for (let { repo, projects } of repoProjects) {
+//     for (let project of projects) {
+//         console.log(`- Getting Project data for ${project.project.name}.`);
+//         projectsWithData.push({
+//           project,
+//           data: await getProjectData(projectKit, config, project),
+//         });
+//     }
+
+//     const result = projectsWithData.map(({ project, data }) => {
+//       return renderProject(data, project, config);
+//     });
+
+//     const issueBody = result.join('\n') + '\n';
+//     let header;
+//     if (config.headerFileUrl) {
+//       header = await projectKit.getBoardHeaderText(config.headerFileUrl);
+//     }
+
+//     let footer;
+//     if (config.footerFileUrl) {
+//       footer = await projectKit.getBoardHeaderText(config.footerFileUrl);
+//     }
+
+//     const issueContents = [
+//       header,
+//       // render all projects overview
+//       // renderOverview(config, projectsWithData),
+//       issueBody,
+//       footer,
+//     ].join('\n');
+
+//     await updateBoardIssue(issueContents, config, projectKit);
+//   }
+// };
+
+const updateBoardComment = async (
+  commentUrl: string,
   issueContents: string,
-  config: IConfig,
   projectKit: ProjectsOctoKit,
 ) => {
-  if (!config.isReplaceProjectMarkers) {
-    return await overwriteBoardIssue(issueContents, config, projectKit);
-  }
+  // if (!config.isReplaceProjectMarkers) {
+  //   return await overwriteBoardIssue(issueContents, config, projectKit);
+  // }
 
-  const issue = await projectKit.getBoardIssue(config.boardIssue);
+  console.log(`>> updating the comment ${commentUrl} with contents length: ${issueContents.length}`);
 
-  const { body } = issue;
-  const newBody = body.replace(getRegex(), wrapIssueText(issueContents));
-
-  await overwriteBoardIssue(newBody, config, projectKit);
+  return await projectKit.updateBoardComment(commentUrl, issueContents);
 };
 
-const processConfigRecord = async (
+const processConfigRecordComment = async (
   config: IConfig,
-  projectKit: ProjectsOctoKit,
+  readProjectKit: ProjectsOctoKit,
+  writeProjectKit: ProjectsOctoKit,
 ) => {
   console.log('Processing config: \n', JSON.stringify(config, null, 2));
 
@@ -81,59 +154,57 @@ const processConfigRecord = async (
     return;
   }
 
-  console.log(`- Config schema validation passed.`);
+  console.log('\n- Config schema validation passed.\n');
 
-  const repoProjects = await projectKit.getAllProjects(config.repos);
+  const repoProjects = await readProjectKit.getAllProjects(config.repos);
 
   const projectsWithData = [];
   for (let { repo, projects } of repoProjects) {
     for (let project of projects) {
         console.log(`- Getting Project data for ${project.project.name}.`);
         projectsWithData.push({
           project,
-          data: await getProjectData(projectKit, config, project),
+          data: await getProjectData(readProjectKit, config, project),
         });
     }
 
-    const result = projectsWithData.map(({ project, data }) => {
-      return renderProject(data, project, config);
-    });
+    for (let { project, data } of projectsWithData) {
+      const comment = renderProject(data, project, config);
+      const { projectConfig } = project;
+      if (typeof projectConfig === 'number') {
+        continue;
+      }
 
-    const issueBody = result.join('\n') + '\n';
-    let header;
-    if (config.headerFileUrl) {
-      header = await projectKit.getBoardHeaderText(config.headerFileUrl);
-    }
+      const { boardComment } = projectConfig;
+      if (!boardComment) {
+        continue;
+      }
 
-    let footer;
-    if (config.footerFileUrl) {
-      footer = await projectKit.getBoardHeaderText(config.footerFileUrl);
+      await updateBoardComment(boardComment, comment, writeProjectKit);
     }
-
-    const issueContents = [
-      header,
-      // render all projects overview
-      // renderOverview(config, projectsWithData),
-      issueBody,
-      footer,
-    ].join('\n');
-
-    await updateBoardIssue(issueContents, config, projectKit);
   }
 };
 
 async function run(): Promise<void> {
   try {
-    const token = env(TOKEN_NAME) ?? core.getInput('token');
+    const token = core.getInput('token');
+    const readToken = env(TOKEN_READ_NAME) ?? core.getInput('readToken') ?? token;
+    const writeToken = env(TOKEN_READ_NAME) ?? core.getInput('writeToken') ?? token;
+
+    if (!readToken) {
+      throw new AuthorizationError('No read token found.');
+    }
 
-    if (!token) {
-      throw new AuthorizationError('No token found.');
+    if (!writeToken) {
+      throw new AuthorizationError('No write token found.');
     }
 
-    const projectKit = new ProjectsOctoKit(token);
+    const readProjectKit = new ProjectsOctoKit(readToken);
+    const writeProjectKit = new ProjectsOctoKit(writeToken);
+
     const configsFilePath = env(CONFIG_PATH) ?? core.getInput('config');
     for (let config of getConfigs(configsFilePath)) {
-      await processConfigRecord(config, projectKit);
+      await processConfigRecordComment(config, readProjectKit, writeProjectKit);
     }
   } catch (error) {
     console.error(error);

src/octokit/ProjectsOctoKit.ts

@@ -1,5 +1,5 @@
 import { OctoKitBase } from './OctoKitBase';
-import { parseIssueApiUrl, parseIssueUrl } from '../utils/parseIssueUrl';
+import { parseCommentUrl, parseIssueApiUrl, parseIssueUrl } from '../utils/parseIssueUrl';
 import { parseFileUrl } from '../utils/parseFileUrl';
 import { notEmpty } from '../utils/functional/notEmpty';
 
@@ -299,7 +299,6 @@ export class ProjectsOctoKit extends OctoKitBase {
     }
 
     const { owner, repo, issueNumber } = issue;
-
     return await this.kit.issues.update({
       owner,
       repo,
@@ -330,6 +329,29 @@ export class ProjectsOctoKit extends OctoKitBase {
     return data;
   };
 
+  public updateBoardComment = async (
+    commentUrl: string,
+    body: string,
+  ) => {
+    const comment = parseCommentUrl(commentUrl);
+    if (!comment) {
+      throw new Error(`cannot parse the comment ${commentUrl}`);
+    }
+
+    const { owner, repo, issueNumber, commentId } = comment;
+    const { status } = await this.kit.issues.updateComment({
+      owner,
+      repo,
+      issue_number: issueNumber,
+      comment_id: commentId,
+      body,
+    });
+
+    if (status !== 200) {
+      throw new Error(`Failed to update the comment ${commentUrl}`);
+    }
+  };
+
   public getBoardHeaderText = async (fileUrl: string): Promise<string> => {
     const fileRef = parseFileUrl(fileUrl);
 

src/utils/parseIssueUrl.ts

@@ -1,3 +1,4 @@
+import { IParsedComment } from '../interfaces/IParsedComment';
 import { IParsedIssue } from '../interfaces/IParsedIssue';
 
 export const parseIssueUrl = (issueUrl: string): IParsedIssue | null => {
@@ -17,6 +18,24 @@ export const parseIssueUrl = (issueUrl: string): IParsedIssue | null => {
   };
 };
 
+export const parseCommentUrl = (issueUrl: string): IParsedComment | null => {
+  const uri = new URL(issueUrl);
+  const { pathname, hash } = uri;
+
+  if (uri.hostname !== 'github.com') {
+    return null;
+  }
+
+  const split = pathname.split('/');
+
+  return {
+    owner: split[1],
+    repo: split[2],
+    issueNumber: parseInt(split[4], 10),
+    commentId: parseInt(hash.split('#issuecomment-')[1], 10),
+  };
+};
+
 
 export const parseIssueApiUrl = (issueUrl: string): IParsedIssue => {
   const uri = new URL(issueUrl);