feat: add GitHubPullRequestWorkflow

.changeset/smooth-dolls-add.md

@@ -0,0 +1,11 @@
+---
+'@jpmorganchase/mosaic-cli': patch
+'@jpmorganchase/mosaic-schemas': patch
+'@jpmorganchase/mosaic-site': patch
+'@jpmorganchase/mosaic-types': patch
+'@jpmorganchase/mosaic-workflows': patch
+---
+
+Feat: add GithubPullRequestWorkflow
+
+This workflow requires a [fine-grained github personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) so that the github rest API can be used to create Pull Requests.

package.json

@@ -9,7 +9,7 @@
     "packages/*"
   ],
   "engines": {
-    "node": ">=16.10.0 || >=18.0.0"
+    "node": ">=18.0.0 || >=20.0.0"
   },
   "bin": {
     "mosaic": "yarn workspace @jpmorganchase/mosaic-cli"

packages/cli/package.json

@@ -15,7 +15,7 @@
     }
   },
   "engines": {
-    "node": ">=16.10.0 || >=18.0.0"
+    "node": ">=18.0.0 || >=20.0.0"
   },
   "bin": {
     "mosaic": "./dist/index.mjs"

packages/cli/src/plugins/mosaicWorkflowsPlugin.ts

@@ -48,7 +48,8 @@ async function mosaicWorkflows(fastify: FastifyInstance, _options) {
             );
           }
 
-          const channel = md5(`${user.sid.toLowerCase()} - ${name.toLowerCase()}`);
+          const userId = user.id || user.sid;
+          const channel = md5(`${userId.toLowerCase()} - ${name.toLowerCase()}`);
 
           const sendWorkflowProgressMessage: SendSourceWorkflowMessage = (info, status) =>
             connection.socket.send(JSON.stringify({ status, message: info, channel }));
@@ -68,7 +69,7 @@ async function mosaicWorkflows(fastify: FastifyInstance, _options) {
           }
         } catch (e) {
           console.error(e);
-          connection.socket.send(JSON.stringify({ status: 'ERROR', message: 'e.message' }));
+          connection.socket.send(JSON.stringify({ status: 'ERROR', message: e.message }));
         }
       }
     });

packages/content-editor-plugin/src/components/PersistEditDialog/index.tsx

@@ -72,7 +72,7 @@ export const PersistDialog = ({ meta, persistUrl }: PersistDialogProps) => {
   };
 
   const handleCompleteMessage = message => {
-    setPrHref(message.message?.links?.self[0]?.href);
+    setPrHref(message.message?.links?.self[0]?.href || message);
     setIsRaising(false);
   };
 

packages/core/package.json

@@ -15,7 +15,7 @@
     }
   },
   "engines": {
-    "node": ">=16.10.0 || >=18.0.0"
+    "node": ">=18.0.0 || >=20.0.0"
   },
   "files": [
     "dist"

packages/fromHttpRequest/package.json

@@ -16,7 +16,7 @@
     }
   },
   "engines": {
-    "node": ">=16.10.0 || >=18.0.0"
+    "node": ">=18.0.0 || >=20.0.0"
   },
   "files": [
     "dist"

packages/plugins/package.json

@@ -19,7 +19,7 @@
     }
   },
   "engines": {
-    "node": ">=16.10.0 || >=18.0.0"
+    "node": ">=18.0.0 || >=20.0.0"
   },
   "files": [
     "dist"

packages/schemas/package.json

@@ -16,7 +16,7 @@
     }
   },
   "engines": {
-    "node": ">=16.10.0 || >=18.0.0"
+    "node": ">=18.0.0 || >=20.0.0"
   },
   "repository": {
     "type": "git",

packages/schemas/src/SourceWorkflowSchema.ts

@@ -8,7 +8,7 @@ export const sourceWorkflowSchema = z.object({
   /**
    * Workflow config options
    */
-  options: z.unknown(),
+  options: z.record(z.string(), z.unknown()),
   /**
    * action to run when workflow is triggered
    */

packages/serialisers/package.json

@@ -31,7 +31,7 @@
     }
   },
   "engines": {
-    "node": ">=16.10.0 || >=18.0.0"
+    "node": ">=18.0.0 || >=20.0.0"
   },
   "files": [
     "dist"

packages/site-middleware/src/loaders/__tests__/loadLocalFile.test.ts

@@ -26,7 +26,7 @@ describe('GIVEN loadLocalFile', () => {
   test('THEN it throws and error when the local file does not exist', async () => {
     // assert
     await expect(loadLocalFile('some/non-existent/mynamespace/mydir')).rejects.toThrow(
-      /ENOENT: no such file or directory, stat 'some\/non-existent\/mynamespace\/mydir'/
+      "ENOENT: no such file or directory, stat 'some/non-existent/mynamespace/mydir'"
     );
   });
   test('THEN it loads the index file if a directory is requested', async () => {

packages/source-figma/package.json

@@ -16,7 +16,7 @@
     }
   },
   "engines": {
-    "node": ">= 16.0.0"
+    "node": ">=18.0.0 || >=20.0.0"
   },
   "files": [
     "dist"

packages/source-git-repo/package.json

@@ -16,7 +16,7 @@
     }
   },
   "engines": {
-    "node": ">=16.10.0 || >=18.0.0"
+    "node": ">=18.0.0 || >=20.0.0"
   },
   "files": [
     "dist"

packages/source-http/package.json

@@ -16,7 +16,7 @@
     }
   },
   "engines": {
-    "node": ">=16.10.0 || >=18.0.0"
+    "node": ">=18.0.0 || >=20.0.0"
   },
   "files": [
     "dist"

packages/source-local-folder/package.json

@@ -16,7 +16,7 @@
     }
   },
   "engines": {
-    "node": ">=16.10.0 || >=18.0.0"
+    "node": ">=18.0.0 || >=20.0.0"
   },
   "files": [
     "dist"

packages/source-readme/package.json

@@ -15,7 +15,7 @@
     }
   },
   "engines": {
-    "node": ">= 16.0.0"
+    "node": ">=18.0.0 || >=20.0.0"
   },
   "files": [
     "dist"

packages/source-storybook/package.json

@@ -16,7 +16,7 @@
     }
   },
   "engines": {
-    "node": ">= 16.0.0"
+    "node": ">=18.0.0 || >=20.0.0"
   },
   "files": [
     "dist"

packages/types/package.json

@@ -12,7 +12,7 @@
     }
   },
   "engines": {
-    "node": ">=16.10.0 || >=18.0.0"
+    "node": ">=18.0.0 || >=20.0.0"
   },
   "repository": {
     "type": "git",

packages/types/src/SourceWorkflow.ts

@@ -5,7 +5,7 @@ export type SourceWorkflowAction<TSourceOptions, TOptions> = (
   ...args: any[]
 ) => Promise<unknown>;
 
-export type SourceWorkflow<TSourceOptions = unknown, TOptions = unknown> = {
+export type SourceWorkflow<TSourceOptions = unknown, TOptions = Record<string, unknown>> = {
   name: string;
   options?: TOptions;
   action: SourceWorkflowAction<TSourceOptions, TOptions>;

packages/workflows/package.json

@@ -15,7 +15,7 @@
     }
   },
   "engines": {
-    "node": ">=16.10.0 || >=18.0.0"
+    "node": ">=18.0.0 || >=20.0.0"
   },
   "files": [
     "dist"
@@ -37,6 +37,8 @@
     "@jpmorganchase/mosaic-serialisers": "^0.1.0-beta.85",
     "@jpmorganchase/mosaic-source-git-repo": "^0.1.0-beta.85",
     "@jpmorganchase/mosaic-types": "^0.1.0-beta.85",
+    "@octokit/core": "^6.1.2",
+    "undici" : "^6.19.5",
     "uuid": "^7.0.3"
   }
 }

packages/workflows/src/GitHubPullRequestWorkflow.ts

@@ -0,0 +1,161 @@
+import { Octokit } from '@octokit/core';
+import path from 'node:path';
+import fs from 'node:fs';
+import { v4 as uuidv4 } from 'uuid';
+import { Repo, GitRepoSourceOptions } from '@jpmorganchase/mosaic-source-git-repo';
+import { mdx } from '@jpmorganchase/mosaic-serialisers';
+import type { SendSourceWorkflowMessage, SourceWorkflow } from '@jpmorganchase/mosaic-types';
+import { ProxyAgent, fetch as undiciFetch } from 'undici';
+
+function getErrorMessage(error: unknown) {
+  if (error instanceof Error) return error.message;
+  return String(error);
+}
+
+interface GitHubPullRequestWorkflowData {
+  user: { id: string; name: string; email: string };
+  markdown: string;
+}
+
+interface GitHubPullRequestWorkflowOptions {
+  apiEndpoint: string;
+  commitMessage: (filePath: string) => string;
+  titlePrefix: string;
+  proxyEndpoint?: string;
+}
+
+export async function createPullRequest(
+  sendWorkflowProgressMessage: SendSourceWorkflowMessage,
+  sourceOptions: GitRepoSourceOptions,
+  { apiEndpoint, commitMessage, titlePrefix, proxyEndpoint }: GitHubPullRequestWorkflowOptions,
+  filePath: string,
+  { user, markdown }: GitHubPullRequestWorkflowData
+) {
+  const {
+    credentials,
+    remote,
+    branch: sourceBranch,
+    repo: repoUrl,
+    subfolder,
+    prefixDir
+  } = sourceOptions;
+
+  if (!repoUrl || !markdown) {
+    return false;
+  }
+
+  let repoInstance: Repo | null = new Repo(credentials, remote, sourceBranch, repoUrl);
+  await repoInstance.init();
+  const userId = user.id.toLowerCase();
+
+  sendWorkflowProgressMessage('GitHub clone complete', 'IN_PROGRESS');
+
+  const branchName = `${userId}-${uuidv4()}`;
+  await repoInstance.createWorktree(userId, branchName);
+  sendWorkflowProgressMessage('Created git worktree', 'IN_PROGRESS');
+
+  /**
+   * strip out the namespace from the file path.
+   * We are interested in the file on disk not in the VFS
+   */
+  const pathOnDisk = path.posix.join(
+    repoInstance.dir,
+    subfolder,
+    filePath.replace(new RegExp(`${prefixDir}/`), '')
+  );
+
+  const rawPage = await fs.promises.readFile(pathOnDisk);
+  const { content, ...metadata } = await mdx.deserialise(pathOnDisk, rawPage);
+  const updatedPage = { ...metadata, content: markdown };
+  sendWorkflowProgressMessage('Updated page content', 'IN_PROGRESS');
+  await fs.promises.writeFile(pathOnDisk, await mdx.serialise(pathOnDisk, updatedPage));
+  sendWorkflowProgressMessage('Saved page', 'IN_PROGRESS');
+
+  /** create a new fetcher with proxy agent configured if required. */
+  const fetcher: typeof undiciFetch = proxyEndpoint
+    ? (url, opts) => {
+        return undiciFetch(url, {
+          ...opts,
+          dispatcher: new ProxyAgent({
+            uri: proxyEndpoint,
+            keepAliveTimeout: 10,
+            keepAliveMaxTimeout: 10
+          })
+        });
+      }
+    : undiciFetch;
+
+  const token = credentials.split(':')[1];
+
+  // get a new client
+  const githubClient = new Octokit({
+    auth: token,
+    request: {
+      fetch: fetcher,
+      timeout: 5000
+    }
+  });
+
+  sendWorkflowProgressMessage('Creating Pull Request', 'IN_PROGRESS');
+
+  let prResult = null;
+
+  try {
+    await repoInstance.configureGitUser(user.name, user.email);
+    await repoInstance.addChanges();
+    await repoInstance.commitChanges(user.name, user.email, commitMessage(filePath));
+    await repoInstance.pushBranch(branchName);
+
+    const result = await githubClient.request(`POST ${apiEndpoint}`, {
+      owner: repoInstance.projectName,
+      repo: repoInstance.repoName,
+      title: `${titlePrefix} - Content update - ${filePath}`,
+      body: commitMessage(filePath),
+      head: branchName,
+      base: sourceBranch,
+      headers: {
+        'X-GitHub-Api-Version': '2022-11-28'
+      }
+    });
+
+    /**
+     * https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#create-a-pull-request
+     * Status 201 = created
+     */
+    if (result.status === 201) {
+      prResult = result.data.url;
+    } else {
+      throw new Error(`${result.data.status} - ${result.data.message}`);
+    }
+  } catch (e: unknown) {
+    console.group('[Mosaic] Pull Request Error');
+    console.log('fullPath', filePath);
+    console.log('Head', branchName);
+    console.log('Base', sourceBranch);
+    console.error(e);
+    console.groupEnd();
+
+    prResult = {
+      error: `Error creating Pull Request: ${getErrorMessage(e)} `,
+      source: `${repoInstance.name}`
+    };
+  } finally {
+    await repoInstance.removeWorktree(userId);
+    repoInstance = null;
+  }
+
+  sendWorkflowProgressMessage(prResult, 'COMPLETE');
+  return prResult;
+}
+
+const workflow: SourceWorkflow = {
+  name: 'save',
+  options: {
+    titlePrefix: 'Mosaic Docs',
+    apiEndpoint: 'https://api.github.com/repos/{owner}/{repo}/pulls',
+    commitMessage: (filePath: string) => `docs: updated content ${filePath} (UIE-7026)`
+  },
+  action: createPullRequest
+};
+
+export default workflow;