migrate to cards

Author: legomushroom

TODO.md

@@ -37,4 +37,6 @@
 🛢️ 🧹 🛀 🧲 🔋 🧭 🔦 ⚙️ ⚡ 🤖 🔧 💳 🔌 🔎 📷 🔬 🕵️ 🔭 👽
 🧑‍🚀 🛰️ 📡 🥛 🎂 🧀 🍕 🧰 👷 🚧 🎥 🎬 💩 🎉 📚 ⛄ 🧸 👋 🏆
 ⚽ 🥅 🤓 🧐 🍭 🍭 🎪 🗡️ 🐉 🧝 🃏 🎲 🧩 🙈 🖊️ 🏛️ 🗝️ 🗺️ 🙉
--->
+-->
+
+- Web Experience team ["legomushroom", "plisy", "GideonCheruiyot", "VincentDondain", "wachaudh", "klvnraju"]

package.json

@@ -30,11 +30,13 @@
   "dependencies": {
     "@actions/core": "^1.2.6",
     "@actions/github": "^4.0.0",
-    "dotenv": "^8.2.0"
+    "dotenv": "^8.2.0",
+    "shortid": "^2.2.16"
   },
   "devDependencies": {
     "@types/jest": "^26.0.10",
     "@types/node": "^14.10.0",
+    "@types/shortid": "^0.0.29",
     "@typescript-eslint/parser": "^3.10.1",
     "@vercel/ncc": "^0.23.0",
     "eslint": "^7.8.1",

schemas/IConfig.json

@@ -98,6 +98,13 @@
         "isCheckListItems": {
           "description": "If to render issues as check list using the [x] markers.\n\ndefault: false",
           "type": "boolean"
+        },
+        "developers": {
+          "description": "Team developers list, if not set, inferred from\nthe assigned GitHub issues.",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
         }
       },
       "additionalProperties": false,

src/interfaces/ICardWithIssue.ts

@@ -0,0 +1,9 @@
+import { TColumnCard } from './TColumnCard';
+import { TColumnTypes } from './TColumnTypes';
+import { TRepoIssue } from './TRepoIssue';
+
+export interface ICardWithIssue {
+    column: TColumnTypes;
+    issue?: TRepoIssue;
+    card: TColumnCard;
+}

src/interfaces/IProject.ts

@@ -18,4 +18,10 @@ export interface IProject {
    * default: false
    */
   isCheckListItems?: boolean;
+
+  /**
+   * Team developers list, if not set, inferred from
+   * the assigned GitHub issues.
+   */
+  developers?: string[];
 }

src/interfaces/IProjectData.ts

@@ -1,18 +1,20 @@
-import { IWrappedIssue } from './IWrappedIssue';
+import { ICardWithIssue } from './ICardWithIssue';
+import { IProjectWithConfig } from './IProjectWithConfig';
 
 export interface IProjectData {
-  inWorkIssues: IWrappedIssue[];
-  doneOrDeployIssues: IWrappedIssue[];
-  allPlannedIssues: IWrappedIssue[];
-  issuesToSolve: IWrappedIssue[];
+  project: IProjectWithConfig;
+  inWorkIssues: ICardWithIssue[];
+  doneOrDeployIssues: ICardWithIssue[];
+  allPlannedIssues: ICardWithIssue[];
+  issuesToSolve: ICardWithIssue[];
   // raw:
-  backlogIssues: IWrappedIssue[];
-  committedIssues: IWrappedIssue[];
-  progressIssues: IWrappedIssue[];
-  inReviewIssues: IWrappedIssue[];
-  blockedIssues: IWrappedIssue[];
-  waitingToDeployIssues: IWrappedIssue[];
-  doneIssues: IWrappedIssue[];
+  backlogIssues: ICardWithIssue[];
+  committedIssues: ICardWithIssue[];
+  progressIssues: ICardWithIssue[];
+  inReviewIssues: ICardWithIssue[];
+  blockedIssues: ICardWithIssue[];
+  waitingToDeployIssues: ICardWithIssue[];
+  doneIssues: ICardWithIssue[];
 }
 
 

src/interfaces/IProjectStats.ts

@@ -14,7 +14,7 @@ export interface IProjectStats {
   issuesDeveloperDayRatio?: number;
   issuesDeveloperDayLeftRatio?: number;
 
-  devWithMostAssignedIssues: IDeveloperWithIssuesCount;
+  // devWithMostAssignedIssues: IDeveloperWithIssuesCount;
 
   developers: string[];
 }

src/interfaces/IProjectWithConfig.ts

@@ -1,7 +1,6 @@
 import { TProject } from './TProject';
 import { TProjectConfig } from './TProjetConfig';
 
-
 export interface IProjectWithConfig {
   project: TProject;
   projectConfig: TProjectConfig;

src/octokit/ProjectsOctoKit.ts

@@ -5,7 +5,6 @@ import { notEmpty } from '../utils/notEmpty';
 
 import { IRepoSourceConfig } from '../interfaces/IRepoSourceConfig';
 import { TColumnCard } from '../interfaces/TColumnCard';
-// import { TProject } from '../interfaces/TProject';
 import { TRepoIssue } from '../interfaces/TRepoIssue';
 import { TColumnTypes } from '../interfaces/TColumnTypes';
 import { IWrappedIssue } from '../interfaces/IWrappedIssue';
@@ -15,9 +14,7 @@ import { IParsedIssue } from '../interfaces/IParsedIssue';
 import { TProjectColumn } from '../interfaces/TProjectColumn';
 import { flattenArray } from '../utils/flatternArray';
 import { IParsedRepo } from '../interfaces/IParsedRepo';
-// import { IParsedIssue } from '../interfaces/IParsedIssue';
-// import { serializeIssuePath } from '../utils/serializeIssuePath';
-// import { serializeIssuePath } from '../utils/serializeIssuePath';
+import { ICardWithIssue } from '../interfaces/ICardWithIssue';
 
 interface IColumnWithCards {
   column: TProjectColumn;
@@ -27,8 +24,6 @@ interface IColumnWithCards {
 type TColumnsMap = Record<TColumnTypes, TProjectColumn | undefined>;
 type TColumnsWithCardsMap = Record<TColumnTypes, IColumnWithCards | undefined>
 
-type TRepoIssuesMap = Record<string, TRepoIssue[]>
-
 const findColumn = (
   columns: TProjectColumn[],
   columnName: TColumnTypes,
@@ -40,31 +35,6 @@ const findColumn = (
   return result;
 };
 
-const wrapIssue = (column: TColumnTypes) => {
-  return (issue: TRepoIssue) => {
-    return {
-      column,
-      issue,
-    };
-  };
-};
-
-// const findColumnThrows = (
-//   projectName: string,
-//   columns: TProjectColumn[],
-//   columnName: TColumnTypes,
-// ) => {
-//   const result = findColumn(columns, columnName);
-
-//   if (!result) {
-//     throw new Error(
-//       `No column "${columnName}" found in project "projectName".`,
-//     );
-//   }
-
-//   return result;
-// };
-
 const getProjectId = (project: IProject | number) => {
   return typeof project === 'number' ? project : project.id;
 };
@@ -171,7 +141,7 @@ export class ProjectsOctoKit extends OctoKitBase {
         column,
         cards: await this.getColumnCards(column),
       };
-    });
+    }).filter(notEmpty);
 
     const columnCardsWithEmpty = await Promise.all(cardPromises);
     const columnCards = columnCardsWithEmpty.filter(notEmpty);
@@ -212,6 +182,10 @@ export class ProjectsOctoKit extends OctoKitBase {
     return flattenArray(await Promise.all(resultPromises));
   };
 
+  private isCardIssue = (card: TColumnCard, issue: TRepoIssue): boolean => {
+    return (card.content_url === issue.url) || (card.note === issue.html_url);
+  };
+
   private getCardIssueFromNote = (card: TColumnCard): IParsedIssue | null => {
     try {
       const issue = parseIssueUrl(card.note);
@@ -265,29 +239,31 @@ export class ProjectsOctoKit extends OctoKitBase {
     return Object.values(repos);
   };
 
-  public filterIssuesForColumnCards = async (
+  public mergeCardsWithIssuesForColumn = (
     issues: TRepoIssue[],
-    columns: TColumnsMap,
+    columns: TColumnsWithCardsMap,
     columnType: TColumnTypes,
-  ): Promise<IWrappedIssue[]> => {
+  ): ICardWithIssue[] => {
     // get the column
     const column = columns[columnType];
-    // no column - no issues
+    // no column - no issue
     if (!column) {
       return [];
     }
 
-    const cards = await this.getColumnCards(column);
-
-    const cardIssues = issues
-      .filter((issue) => {
-        const cardIssue = cards.find((card) => {
-          return card.content_url === issue.url;
+    const { cards } = column;
+    const cardIssues: ICardWithIssue[] = cards
+      .map((card) => {
+        const cardIssue = issues.find((issue) => {
+          return this.isCardIssue(card, issue);
         });
 
-        return !!cardIssue;
-      })
-      .map(wrapIssue(columnType));
+        return {
+          card,
+          issue: cardIssue,
+          column: columnType,
+        }
+      });
 
     return cardIssues;
   };