add schema validation and checklist rendering

Author: legomushroom

package.json

@@ -43,6 +43,7 @@
     "jest": "^24.9.0",
     "jest-circus": "^26.4.2",
     "js-yaml": "^3.14.0",
+    "jsonschema": "^1.3.0",
     "prettier": "2.1.1",
     "ts-jest": "^24.3.0",
     "typescript": "^4.0.2",

schemas/IConfig.json

@@ -33,8 +33,21 @@
     "footerFileUrl": {
       "description": "File that will be added as the issue footer.\nExample: \"https://raw.githubusercontent.com/legomushroom/codespaces-board/main/sprints/sprint%2012/footer.md\"",
       "type": "string"
+    },
+    "isReplaceProjectMarkers": {
+      "description": "If replace the <!-- codespaces-board:project_{id}:start -->\nmarkers instead of replacing entire issue body.\n\ndefault: false.",
+      "type": "boolean"
+    },
+    "$schema": {
+      "description": "Used by `vscode` in JSON files.",
+      "type": "string"
     }
   },
+  "additionalProperties": false,
+  "required": [
+    "boardIssue",
+    "repos"
+  ],
   "definitions": {
     "IRepoSourceConfig": {
       "type": "object",
@@ -61,7 +74,12 @@
             ]
           }
         }
-      }
+      },
+      "additionalProperties": false,
+      "required": [
+        "owner",
+        "repo"
+      ]
     },
     "IProject": {
       "type": "object",
@@ -76,8 +94,16 @@
           "items": {
             "type": "string"
           }
+        },
+        "isCheckListItems": {
+          "description": "If to render issues as check list using the [x] markers.\n\ndefault: false",
+          "type": "boolean"
         }
-      }
+      },
+      "additionalProperties": false,
+      "required": [
+        "id"
+      ]
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#"

scripts/generate-json-schema.js

@@ -12,7 +12,11 @@ if (!fs.existsSync(OUTPUT_SCHEMA_FOLDER_PATH)){
 }
 
 // schema generator settings
-const settings = {};
+const settings = {
+  required: true,
+  strictNullChecks: true,
+  noExtraProps: true,
+};
 
 // ts compiler options
 const compilerOptions = {

src/config.ts

@@ -1,7 +1,27 @@
+import { Schema, Validator } from 'jsonschema';
+import * as path from 'path';
+
+import { PROJECT_ROOT } from './constants';
+
 import { IConfig } from './interfaces/IConfig';
 
 export const getConfigs = (configFilePath: string): IConfig[] => {
-    const configs = require(configFilePath);
+  const configs = require(path.join(PROJECT_ROOT, configFilePath));
+
+  return configs;
+};
+
+export const getConfigSchema = (): Schema => {
+  const schema = require(path.join(PROJECT_ROOT, `./schemas/IConfig.json`));
+
+  return schema;
+};
+
+export const validateConfig = (config: unknown) => {
+  const validator = new Validator();
+
+  const validationResult = validator.validate(config, getConfigSchema());
+  const { errors } = validationResult;
 
-    return configs;
+  return errors;
 };

src/constants.ts

@@ -1 +1,3 @@
-export const PROJECT_ROOT = '../';
+import * as path from 'path';
+
+export const PROJECT_ROOT = path.join(__dirname, '../');

src/interfaces/IConfig.ts

@@ -47,4 +47,17 @@ export interface IConfig {
    * Example: "https://raw.githubusercontent.com/legomushroom/codespaces-board/main/sprints/sprint%2012/footer.md"
    */
   footerFileUrl?: string;
+
+  /**
+   * If replace the <!-- codespaces-board:project_{id}:start -->
+   * markers instead of replacing entire issue body.
+   *
+   * default: false.
+   */
+  isReplaceProjectMarkers?: boolean;
+
+  /**
+   * Used by `vscode` in JSON files.
+   */
+  ['$schema']?: string,
 }

src/interfaces/IIssueState.ts

@@ -0,0 +1,4 @@
+export enum IIssueState {
+    Open = 'open',
+    Closed = 'closed',
+}

src/interfaces/IProject.ts

@@ -5,9 +5,17 @@ export interface IProject {
    * @TJS-type integer
    */
   id: number;
+
   /**
    * Issue labels that will be rendered as sections
    * on the aggregated issue.
    */
   trackLabels?: string[];
+
+  /**
+   * If to render issues as check list using the [x] markers.
+   *
+   * default: false
+   */
+  isCheckListItems?: boolean;
 }

src/interfaces/IProjectWithConfig.ts

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

src/interfaces/IProjectWithTrackedLabels.ts

@@ -1,4 +1,4 @@
-import { IProject } from './IProject';
+import { TProjectConfig } from './TProjetConfig';
 
 export interface IRepoSourceConfig {
   /**
@@ -14,5 +14,5 @@ export interface IRepoSourceConfig {
   /**
    * Project to track, if not set assuming all projects on the repo.
    */
-  projects?: (IProject | number)[];
+  projects?: TProjectConfig[];
 }

src/interfaces/IRepoSourceConfig.ts

@@ -0,0 +1,3 @@
+import { IProject } from './IProject';
+
+export type TProjectConfig = IProject | number;

src/interfaces/TProjetConfig.ts

@@ -1,5 +1,5 @@
 import * as core from '@actions/core';
-import { env } from './utils/env';
+import { Validator } from 'jsonschema';
 
 // add .env file support for dev purposes
 require('dotenv').config();
@@ -9,14 +9,79 @@ import { ProjectsOctoKit } from './octokit/ProjectsOctoKit';
 import { renderProject } from './views/renderProject';
 import { renderOverview } from './views/renderOverview';
 import { getProjectData } from './utils/getProjectData';
-import { getConfigs } from './config';
+import { env } from './utils/env';
+import { getConfigs, validateConfig } from './config';
+
 import { IConfig } from './interfaces/IConfig';
 
 const TOKEN_NAME = 'REPO_GITHUB_PAT';
 const CONFIG_PATH = 'CONFIG_PATH';
 
+
+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}`,
+    );
+  }
+
+  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 wrapIssueText = (text: string, projectId?: number) => {
+  return [
+    `<!-- codespaces-board:start -->`,
+    `<!-- ⚠️ AUTO GENERATED GITHUB ACTION, DON'T EDIT BY HAND ⚠️ -->`,
+    `<!-- updated on: ${new Date().toISOString()} -->`,
+    text,
+    `<!-- codespaces-board:end -->`,
+  ].join('\n');
+}
+
+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,
+    issueContents,
+  );
+
+  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 for issue ${config.boardIssue}`);
+  console.log('Processing config: \n', config);
+
+  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);
 
@@ -47,29 +112,14 @@ const processConfigRecord = async (config: IConfig, projectKit: ProjectsOctoKit)
       footer = await projectKit.getBoardHeaderText(config.footerFileUrl);
     }
 
-    const projectsData = projectsWithData.map((x) => {
-      return x.data;
-    });
-
     const issueContents = [
       header,
       renderOverview(config, projectsWithData),
       issueBody,
       footer
     ].join('\n');
 
-    const { status } = await projectKit.updateBoardIssue(
-      config.boardIssue,
-      issueContents,
-    );
-
-    if (status !== 200) {
-      throw new Error(
-        `Failed to update the issue ${config.boardIssue}`,
-      );
-    }
-
-    console.log(`Successfully updated the board issue ${config.boardIssue}`);
+    await updateBoardIssue(issueContents, config, projectKit);
   }
 }
 

src/main.ts

@@ -12,7 +12,7 @@ import { TRepoIssue } from '../interfaces/TRepoIssue';
 import { TColumnTypes } from '../interfaces/TColumnTypes';
 import { IWrappedIssue } from '../interfaces/IWrappedIssue';
 import { IProject } from '../interfaces/IProject';
-import { IProjectWithTrackedLabels } from '../interfaces/IProjectWithTrackedLabels';
+import { IProjectWithConfig } from '../interfaces/IProjectWithConfig';
 
 type TColumnsMap = Record<TColumnTypes, TProjectColumn | undefined>;
 
@@ -56,7 +56,7 @@ const getProjectId = (project: IProject | number) => {
 export class ProjectsOctoKit extends OctoKitBase {
   public getRepoProjects = async (
     repo: IRepoSourceConfig,
-  ): Promise<IProjectWithTrackedLabels[]> => {
+  ): Promise<IProjectWithConfig[]> => {
     const { data: projectsResponse } = await this.kit.projects.listForRepo({
       accept: 'application/vnd.github.inertia-preview+json',
       owner: repo.owner,
@@ -65,7 +65,7 @@ export class ProjectsOctoKit extends OctoKitBase {
     });
 
     const fetchedProjects = projectsResponse.map((project):
-      | IProjectWithTrackedLabels
+      | IProjectWithConfig
       | undefined => {
       const { projects } = repo;
 
@@ -81,13 +81,9 @@ export class ProjectsOctoKit extends OctoKitBase {
         return;
       }
 
-      const labels = (typeof proj === 'number')
-        ? []
-        : proj.trackLabels ?? [];
-
       return {
         project,
-        labels,
+        projectConfig: proj,
       };
     })
     .filter(notEmpty);
@@ -97,7 +93,7 @@ export class ProjectsOctoKit extends OctoKitBase {
 
   public getAllProjects = async (
     repos: IRepoSourceConfig[],
-  ): Promise<{ repo: IRepoSourceConfig; projects: IProjectWithTrackedLabels[] }[]> => {
+  ): Promise<{ repo: IRepoSourceConfig; projects: IProjectWithConfig[] }[]> => {
     const result = [];
 
     for (let repo of repos) {
@@ -111,7 +107,7 @@ export class ProjectsOctoKit extends OctoKitBase {
     return result;
   };
 
-  public getColumns = async (projectWithLabels: IProjectWithTrackedLabels): Promise<TColumnsMap> => {
+  public getColumns = async (projectWithLabels: IProjectWithConfig): Promise<TColumnsMap> => {
     const { project } = projectWithLabels;
 
     const { data: columns } = await this.kit.projects.listColumns({
@@ -218,6 +214,26 @@ export class ProjectsOctoKit extends OctoKitBase {
     });
   };
 
+  public getBoardIssue = async (issueUrl: string, body: string) => {
+    const { owner, repo, issueNumber } = parseIssueUrl(issueUrl);
+
+    const { status, data } = await this.kit.issues.get({
+      owner,
+      repo,
+      issue_number: issueNumber,
+      body,
+    });
+
+    if (status !== 200) {
+      throw new Error(
+        `Failed to get the issue ${issueUrl}`,
+      );
+    }
+
+    return data;
+  };
+
+
   public getBoardHeaderText = async (fileUrl: string): Promise<string> => {
     const fileRef = parseFileUrl(fileUrl);