Merge pull request #4090 from quarto-dev/bug/link-resolve-create

Confluence: 2-Pass update for link resolution in Confluence

Author: Allen Manning

src/publish/confluence/confluence-helper.ts

@@ -260,7 +260,8 @@ export const buildContentUpdate = (
   parent?: string,
   status: ContentStatusEnum = ContentStatusEnum.current,
   type: string = PAGE_TYPE,
-  version: ContentVersion | null = null
+  version: ContentVersion | null = null,
+  ancestors: ContentAncestor[] | null = null
 ): ContentUpdate => {
   return {
     contentChangeType: ContentChangeType.update,
@@ -269,7 +270,7 @@ export const buildContentUpdate = (
     title,
     type,
     status,
-    ancestors: parent ? [{ id: parent }] : null,
+    ancestors: parent ? [{ id: parent }] : ancestors,
     body,
     fileName,
   };
@@ -474,11 +475,20 @@ export const buildSpaceChanges = (
   return spaceChanges;
 };
 
+export const replaceExtension = (
+  fileName: string,
+  oldExtension: string,
+  newExtension: string
+) => {
+  return fileName.replace(oldExtension, newExtension);
+};
+
 export const getTitle = (
   fileName: string,
   metadataByInput: Record<string, InputMetadata>
 ): string => {
-  const qmdFileName = fileName.replace(".xml", ".qmd");
+  const qmdFileName = replaceExtension(fileName, ".xml", ".qmd");
+
   const metadataTitle = metadataByInput[qmdFileName]?.title;
 
   const titleFromFilename = capitalizeWord(fileName.split(".")[0] ?? fileName);
@@ -540,12 +550,17 @@ export const updateLinks = (
   spaceChanges: ConfluenceSpaceChange[],
   server: string,
   parent: ConfluenceParent
-): ConfluenceSpaceChange[] => {
+): {
+  pass1Changes: ConfluenceSpaceChange[];
+  pass2Changes: ConfluenceSpaceChange[];
+} => {
   const root = `${server}`;
   const url = `${ensureTrailingSlash(server)}wiki/spaces/${
     parent.space
   }/pages/`;
 
+  let collectedPass2Changes: ConfluenceSpaceChange[] = [];
+
   const changeMapper = (
     changeToProcess: ConfluenceSpaceChange
   ): ConfluenceSpaceChange => {
@@ -597,7 +612,9 @@ export const updateLinks = (
 
         updated = updated.replace(linkFullFileName, pagePath);
       } else {
-        console.warn(`Link not found for ${siteFilePath}`);
+        if (!collectedPass2Changes.includes(changeToProcess)) {
+          collectedPass2Changes = [...collectedPass2Changes, changeToProcess];
+        }
       }
 
       return updated;
@@ -621,7 +638,66 @@ export const updateLinks = (
   const updatedChanges: ConfluenceSpaceChange[] =
     spaceChanges.map(changeMapper);
 
-  return updatedChanges;
+  return { pass1Changes: updatedChanges, pass2Changes: collectedPass2Changes };
+};
+
+export const convertForSecondPass = (
+  fileMetadataTable: Record<string, SitePage>,
+  spaceChanges: ConfluenceSpaceChange[],
+  server: string,
+  parent: ConfluenceParent
+): ConfluenceSpaceChange[] => {
+  const toUpdatesReducer = (
+    accumulator: ConfluenceSpaceChange[],
+    change: ConfluenceSpaceChange
+  ) => {
+    if (isContentUpdate(change)) {
+      accumulator = [...accumulator, change];
+    }
+
+    if (isContentCreate(change)) {
+      console.log(
+        "basename(change?.fileName?)",
+        basename(change?.fileName ?? "")
+      );
+      const qmdFileName = replaceExtension(
+        change.fileName ?? "",
+        ".xml",
+        ".qmd"
+      );
+      const updateId = fileMetadataTable[qmdFileName]?.id;
+
+      if (updateId) {
+        const convertedUpdate = buildContentUpdate(
+          updateId,
+          change.title,
+          change.body,
+          change.fileName ?? "",
+          "",
+          ContentStatusEnum.current,
+          PAGE_TYPE,
+          null,
+          change.ancestors
+        );
+        accumulator = [...accumulator, convertedUpdate];
+      } else {
+        console.warn("update ID not found for", change.fileName);
+      }
+    }
+
+    return accumulator;
+  };
+
+  const changesAsUpdates = spaceChanges.reduce(toUpdatesReducer, []);
+
+  const updateLinkResults = updateLinks(
+    fileMetadataTable,
+    changesAsUpdates,
+    server,
+    parent
+  );
+
+  return updateLinkResults.pass1Changes;
 };
 
 export const updateImagePaths = (body: ContentBody): ContentBody => {

src/publish/confluence/confluence.ts

@@ -51,6 +51,7 @@ import {
   buildPublishRecordForContent,
   buildSpaceChanges,
   confluenceParentFromString,
+  convertForSecondPass,
   doWithSpinner,
   filterFilesForUpdate,
   findAttachments,
@@ -349,7 +350,8 @@ async function publish(
     id: string,
     body: ContentBody,
     titleToUpdate: string = title,
-    fileName: string = ""
+    fileName: string = "",
+    uploadFileAttachments: boolean = true
   ): Promise<Content> => {
     const previousPage = await client.getContent(id);
 
@@ -380,7 +382,7 @@ async function publish(
 
     const updatedContent: Content = await client.updateContent(toUpdate);
 
-    if (toUpdate.id) {
+    if (toUpdate.id && uploadFileAttachments) {
       const existingAttachments: AttachmentSummary[] =
         await client.getAttachments(toUpdate.id);
 
@@ -571,7 +573,7 @@ async function publish(
       parent: parentId,
     };
 
-    const existingSite: SitePage[] = await fetchExistingSite(parentId);
+    let existingSite: SitePage[] = await fetchExistingSite(parentId);
 
     const publishFiles: PublishFiles = await renderSite(render);
     const metadataByInput: Record<string, InputMetadata> =
@@ -620,7 +622,7 @@ async function publish(
 
     trace("fileMetadata", fileMetadata);
 
-    const metadataByFilename = buildFileToMetaTable(existingSite);
+    let metadataByFilename = buildFileToMetaTable(existingSite);
 
     trace("metadataByFilename", metadataByFilename);
 
@@ -631,18 +633,23 @@ async function publish(
       existingSite
     );
 
-    changeList = updateLinks(
+    const { pass1Changes, pass2Changes } = updateLinks(
       metadataByFilename,
       changeList,
       server,
       siteParent
     );
 
-    trace("changelist", changeList);
+    changeList = pass1Changes;
+
+    trace("changelist Pass 1", changeList);
 
     let pathsToId: Record<string, string> = {}; // build from existing site
 
-    const doChange = async (change: ConfluenceSpaceChange) => {
+    const doChange = async (
+      change: ConfluenceSpaceChange,
+      uploadFileAttachments: boolean = true
+    ) => {
       if (isContentCreate(change)) {
         let ancestorId =
           (change?.ancestors && change?.ancestors[0]?.id) ?? null;
@@ -684,7 +691,8 @@ async function publish(
           update.id ?? "",
           update.body,
           update.title ?? "",
-          update.fileName ?? ""
+          update.fileName ?? "",
+          uploadFileAttachments
         );
       } else if (isContentDelete(change)) {
         if (DELETE_DISABLED) {
@@ -704,8 +712,27 @@ async function publish(
       await doChange(currentChange);
     }
 
-    const parentPage: Content = await client.getContent(parentId);
+    if (pass2Changes.length) {
+      //PASS #2 to update links to newly created pages
+
+      trace("changelist Pass 2", pass2Changes);
+
+      existingSite = await fetchExistingSite(parentId);
+      metadataByFilename = buildFileToMetaTable(existingSite);
+
+      const linkUpdateChanges: ConfluenceSpaceChange[] = convertForSecondPass(
+        metadataByFilename,
+        pass2Changes,
+        server,
+        parent
+      );
 
+      for (let currentChange of linkUpdateChanges) {
+        await doChange(currentChange, false);
+      }
+    }
+
+    const parentPage: Content = await client.getContent(parentId);
     return buildPublishRecordForContent(server, parentPage);
   };