add the priority labels

legomushroom · web-flow · commit 095a48fe7fcc · 2020-10-31T20:31:08.000Z
diff --git a/TODO.md b/TODO.md
@@ -1,11 +1,14 @@
 
-- Add support for issues from external repos
-- Add the developer stats and badges/achievements
+
+- show original planned percent for complete
 - Pass the config JSON file refrence thru the yml file
+- Cache repo issues
 - docs!
+- Add the developer stats and badges/achievements
 - Add the PR parsing logic on teh card/issue and render it for the "In review" items
 
-- project pulse - graph on how many items fixed on particular day ?
+- project pulse - graph on how many items fixed on particular week ?
+- burn-down chart - graph on how many items fixed on particular day ?
 - stats on when moved from one column to another ?
 
 - Badges:
diff --git a/schemas/IConfig.json b/schemas/IConfig.json
@@ -89,7 +89,14 @@
           "type": "integer"
         },
         "trackLabels": {
-          "description": "Issue labels that will be rendered as sections\non the aggregated issue.",
+          "description": "Issue labels that will be rendered as sections\non the aggregated issue. With descending priority.\n\nExample: [\"port-forwarding\", \"workbench\", \"performance\", \"serverless\"]\n\nThe issues with both \"port-forwarding\" and \"performance\" labels, will\nshow up only in the` Port-forwarding` section since it has the higher\nprecedence over the \"performance\" label.",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "priorityLabels": {
+          "description": "List of mutually exclusive[1] priority labels with descending priority[2].\nExample: [\"p0\", \"p1\", \"p2\", \"p3\"]\n- [1]: No `p0` and `p1` can be assigned at the same time.\n- [2]: Label in [N-th] array position has higher precendence then\n        any item in the rest of the list. `p1` has higher priority\n        than `p3` in the example above.\n\nThese labels will be rendered as a label on the list items\nto signify the priority of the item.",
           "type": "array",
           "items": {
             "type": "string"
diff --git a/src/interfaces/IProject.ts b/src/interfaces/IProject.ts
@@ -8,10 +8,29 @@ export interface IProject {
 
   /**
    * Issue labels that will be rendered as sections
-   * on the aggregated issue.
+   * on the aggregated issue. With descending priority.
+   *
+   * Example: ["port-forwarding", "workbench", "performance", "serverless"]
+   *
+   * The issues with both "port-forwarding" and "performance" labels, will
+   * show up only in the` Port-forwarding` section since it has the higher
+   * precedence over the "performance" label.
    */
   trackLabels?: string[];
 
+  /**
+   * List of mutually exclusive[1] priority labels with descending priority[2].
+   * Example: ["p0", "p1", "p2", "p3"]
+   * - [1]: No `p0` and `p1` can be assigned at the same time.
+   * - [2]: Label in [N-th] array position has higher precendence then
+   *        any item in the rest of the list. `p1` has higher priority
+   *        than `p3` in the example above.
+   *
+   * These labels will be rendered as a label on the list items
+   * to signify the priority of the item.
+   */
+  priorityLabels?: string[];
+
   /**
    * If to render issues as check list using the [x] markers.
    *
diff --git a/src/interfaces/TArraySortResult.ts b/src/interfaces/TArraySortResult.ts
@@ -0,0 +1,5 @@
+export enum TArraySortResult {
+  FirstEarlier = -1,
+  SecondEarlier = 0,
+  Equal = 0
+}
diff --git a/src/octokit/ProjectsOctoKit.ts b/src/octokit/ProjectsOctoKit.ts
@@ -1,7 +1,7 @@
 import { OctoKitBase } from './OctoKitBase';
 import { parseIssueApiUrl, parseIssueUrl } from '../utils/parseIssueUrl';
 import { parseFileUrl } from '../utils/parseFileUrl';
-import { notEmpty } from '../utils/notEmpty';
+import { notEmpty } from '../utils/functional/notEmpty';
 
 import { IRepoSourceConfig } from '../interfaces/IRepoSourceConfig';
 import { TColumnCard } from '../interfaces/TColumnCard';
diff --git a/src/utils/emojiIcon.ts b/src/utils/emojiIcon.ts
@@ -0,0 +1,10 @@
+import { ident } from '../views/ident';
+
+export const emojiIcon = (icon: string, title?: string) => {
+  const iconString = `${icon}${ident(1)}`;
+  if (!title) {
+    return iconString;
+  }
+
+  return `<i title="${title}">${iconString}</i>`;
+};
diff --git a/src/utils/functional/capitalize.ts b/src/utils/functional/capitalize.ts
diff --git a/src/utils/functional/notEmpty.ts b/src/utils/functional/notEmpty.ts
diff --git a/src/utils/functional/pluck.ts b/src/utils/functional/pluck.ts
diff --git a/src/utils/functional/toLowerCase.ts b/src/utils/functional/toLowerCase.ts
@@ -0,0 +1,4 @@
+
+export const toLowerCase = (str: string) => {
+  return str.toLowerCase();
+};
diff --git a/src/utils/getProjectStats.ts b/src/utils/getProjectStats.ts
@@ -6,8 +6,8 @@ import { TRepoIssue } from '../interfaces/TRepoIssue';
 import { getWorkDays } from '../views/renderDaysLeft';
 import { arrayUnique } from './arrayUnique';
 import { flattenArray } from './flatternArray';
-import { notEmpty } from './notEmpty';
-import { pluck } from './pluck';
+import { notEmpty } from './functional/notEmpty';
+import { pluck } from './functional/pluck';
 import { ICardWithIssue } from '../interfaces/ICardWithIssue';
 import { IProjectWithConfig } from '../interfaces/IProjectWithConfig';
 
diff --git a/src/utils/isBugCard.ts b/src/utils/isBugCard.ts
@@ -0,0 +1,15 @@
+import { pluck } from './functional/pluck';
+import { toLowerCase } from './functional/toLowerCase';
+
+import { ICardWithIssue } from '../interfaces/ICardWithIssue';
+
+export const isBugCard = (card: ICardWithIssue): boolean => {
+  const { issue } = card;
+  if (!issue) {
+    return false;
+  }
+
+  const { labels } = issue;
+  const isBug = labels.map(pluck('name')).map(toLowerCase).includes('bug');
+  return isBug;
+};
diff --git a/src/utils/isDoneColumn.ts b/src/utils/isDoneColumn.ts
@@ -0,0 +1,14 @@
+import { TColumnTypes } from '../interfaces/TColumnTypes';
+
+export const isDoneColumn = (column: TColumnTypes) => {
+  switch (column) {
+    case TColumnTypes.WaitingToDeploy:
+    case TColumnTypes.Done: {
+      return true;
+    }
+
+    default: {
+      return false;
+    }
+  }
+};
diff --git a/src/utils/measure.ts b/src/utils/measure.ts
@@ -5,7 +5,8 @@ export type TMeasureCallbackSync<T> = (...args: any[]) => T;
 export type TMeasureCallback<T> = TMeasureCallbackSync<T> | TMeasureCallbackAsync<T>;
 
 export const measure = async <T>(blockName: string, callback: TMeasureCallback<T>) => {
-  const label = `${blockName}__${shortId()}`
+  // const labelSuffix = `__${shortId().substr(0, 4).toLowerCase()}`;
+  const label = `${blockName}`
 
   console.log(`> ${label}`);
 
diff --git a/src/utils/sortCards/getCardPriority.ts b/src/utils/sortCards/getCardPriority.ts
@@ -0,0 +1,38 @@
+import { ICardWithIssue } from '../../interfaces/ICardWithIssue';
+import { IProjectWithConfig } from '../../interfaces/IProjectWithConfig';
+
+/**
+ * Find out card priority by the `priorityLabels` setting,
+ * larger the number, more priority the card has.
+ */
+export const getCardPriority = (
+  cardWithIssue: ICardWithIssue,
+  { projectConfig }: IProjectWithConfig,
+  // if actual priority not set, use this value (0 is the least priority)
+  notDefinedValue: number = 0,
+) => {
+  const { issue } = cardWithIssue;
+
+  if (!issue || typeof projectConfig === 'number') {
+    return notDefinedValue;
+  }
+
+  const { priorityLabels } = projectConfig;
+  if (!priorityLabels) {
+    return notDefinedValue;
+  }
+
+  const cardPrioritylabel = priorityLabels.find((priorityLabel: string) => {
+    const foundLabel = issue.labels.find((issueLabel) => {
+      return issueLabel.name === priorityLabel;
+    });
+
+    return !!foundLabel;
+  });
+
+  if (!cardPrioritylabel) {
+    return notDefinedValue;
+  }
+
+  return Number.MAX_SAFE_INTEGER - priorityLabels.indexOf(cardPrioritylabel);
+};
diff --git a/src/utils/sortCards/getSortResultByIssuePresence.ts b/src/utils/sortCards/getSortResultByIssuePresence.ts
@@ -0,0 +1,24 @@
+import { ICardWithIssue } from '../../interfaces/ICardWithIssue';
+import { TArraySortResult } from '../../interfaces/TArraySortResult';
+
+export const getSortResultByIssuePresence = (
+  cardWithIssue1: ICardWithIssue,
+  cardWithIssue2: ICardWithIssue
+): TArraySortResult | null => {
+  const { issue: issue1 } = cardWithIssue1;
+  const { issue: issue2 } = cardWithIssue2;
+
+  if (!issue1 && !issue2) {
+    return null;
+  }
+
+  if (!issue1) {
+    return TArraySortResult.SecondEarlier;
+  }
+
+  if (!issue2) {
+    return TArraySortResult.FirstEarlier;
+  }
+
+  return null;
+};
diff --git a/src/utils/sortCards/sortCardsByAssigneesInPlace.ts b/src/utils/sortCards/sortCardsByAssigneesInPlace.ts
@@ -0,0 +1,39 @@
+import { ICardWithIssue } from '../../interfaces/ICardWithIssue';
+import { TArraySortResult } from '../../interfaces/TArraySortResult';
+
+export const sortByAssigneesPredicate = (
+  cardWithIssue1: ICardWithIssue,
+  cardWithIssue2: ICardWithIssue,
+): TArraySortResult | undefined => {
+  const { issue: issue1 } = cardWithIssue1;
+  const { issue: issue2 } = cardWithIssue2;
+
+  if (!issue1 && !issue2) {
+    return;
+  }
+
+  if (!issue1 || !issue1.assignees.length) {
+    return TArraySortResult.SecondEarlier;
+  }
+
+  if (!issue2 || !issue2.assignees.length) {
+    return TArraySortResult.FirstEarlier;
+  }
+
+  if (issue1.assignees[0].login < issue2.assignees[0].login) {
+    return TArraySortResult.FirstEarlier;
+  }
+  if (issue1.assignees[0].login > issue2.assignees[0].login) {
+    return TArraySortResult.SecondEarlier;
+  }
+
+  return TArraySortResult.Equal;
+}
+
+export const sortCardsByAssigneesInPlace = (cardsWithIssue: ICardWithIssue[]) => {
+  const result = cardsWithIssue.sort((card1: ICardWithIssue, card2: ICardWithIssue) => {
+    return sortByAssigneesPredicate(card1, card2) ?? TArraySortResult.Equal;
+  });
+
+  return result;
+};
diff --git a/src/utils/sortCards/sortCardsByLabelPriorityInPlace.ts b/src/utils/sortCards/sortCardsByLabelPriorityInPlace.ts
@@ -0,0 +1,66 @@
+import { ICardWithIssue } from '../../interfaces/ICardWithIssue';
+import { IProjectWithConfig } from '../../interfaces/IProjectWithConfig';
+import { getCardPriority } from './getCardPriority';
+import { TArraySortResult } from '../../interfaces/TArraySortResult';
+import { getSortResultByIssuePresence } from './getSortResultByIssuePresence';
+
+type TSortPredicate = (ardWithIssue1: ICardWithIssue, cardWithIssue2: ICardWithIssue) => TArraySortResult | undefined;
+
+// const sortCardsByPriorityLabelsPredicateFactory = (
+//   projectWithConfig: IProjectWithConfig,
+//   predicate?: TSortPredicate,
+// ) => {
+//   return
+// };
+
+export const sortCardsByLabelPriorityInPlace = (
+  cardsWithIssue: ICardWithIssue[],
+  projectWithConfig: IProjectWithConfig,
+  predicate?: TSortPredicate,
+) => {
+  const result = cardsWithIssue.sort((cardWithIssue1: ICardWithIssue, cardWithIssue2: ICardWithIssue) => {
+    const baseSort = getSortResultByIssuePresence(cardWithIssue1, cardWithIssue2);
+    if (baseSort !== null) {
+      return baseSort;
+    }
+
+    // const { issue: issue1 } = cardWithIssue1;
+    // const { issue: issue2 } = cardWithIssue1;
+
+    // if (issue1 && issue2) {
+    //   if (issue1.number === )
+    // }
+
+
+
+    // const defaultPriority = (predicate)
+    //   ? null
+    //   : undefined;
+
+    const cardPriority1 = getCardPriority(cardWithIssue1, projectWithConfig);
+    const cardPriority2 = getCardPriority(cardWithIssue2, projectWithConfig);
+    // if (cardPriority1 === null && cardPriority2 === null && predicate) {
+    //   return predicate(cardWithIssue1, cardWithIssue2) ?? TArraySortResult.Equal;
+    // }
+
+    // if (cardPriority1 === null) {
+    //   return TArraySortResult.SecondEarlier;
+    // }
+
+    // if (cardPriority2 === null) {
+    //   return TArraySortResult.FirstEarlier;
+    // }
+
+    if (cardPriority1 > cardPriority2) {
+      return TArraySortResult.FirstEarlier;
+    }
+
+    if (cardPriority1 < cardPriority2) {
+      return TArraySortResult.SecondEarlier;
+    }
+
+    return TArraySortResult.Equal;
+  });
+
+  return result;
+};
diff --git a/src/utils/sortCards/sortCardsInPlace.ts b/src/utils/sortCards/sortCardsInPlace.ts
@@ -0,0 +1,20 @@
+import { ICardWithIssue } from '../../interfaces/ICardWithIssue';
+import { IProjectWithConfig } from '../../interfaces/IProjectWithConfig';
+import { sortCardsByLabelPriorityInPlace } from './sortCardsByLabelPriorityInPlace';
+import { sortByAssigneesPredicate } from './sortCardsByAssigneesInPlace';
+
+/**
+ * The Default way of sorting the cards. !IN PLACE!
+ */
+export const sortCardsInPlace = (
+    cards: ICardWithIssue[],
+    projectWithConfig: IProjectWithConfig,
+) => {
+    sortCardsByLabelPriorityInPlace(
+        cards,
+        projectWithConfig,
+        // sortByAssigneesPredicate,
+    );
+
+    return cards;
+};
diff --git a/src/views/renderCard.ts b/src/views/renderCard.ts
diff --git a/src/views/renderIssue.ts b/src/views/renderIssue.ts
diff --git a/src/views/renderIssuesBlock.ts b/src/views/renderIssuesBlock.ts
diff --git a/testConfig2.json b/testConfig2.json

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
++
 +export const toLowerCase = (str: string) => {
 +  return str.toLowerCase();
 +};