Remove temporary attachments after upload

Fix build after axios upgrade

Author: mihaeu

CHANGELOG.md

@@ -13,7 +13,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 -   Added capability of running Cosmere as a script library.
 -   Added support for custom renderers.
--   Added `cleanupLocalAttachmentFiles` option.
+
+### Changed
+
+-   Local copies of attachment are no longer stored, because caching is done by comparing filename and size instead
 
 ## [0.16.0] - 2022-07-12
 

README.md

@@ -46,7 +46,6 @@ which produces:
     "baseUrl": "<your base url including /rest/api>",
     "user": "<your username>",
     "pass": "<your password>",
-    "cleanupLocalAttachmentFiles": false,
     "personalAccessToken": "<your personal access token (can be set instead of username/password)>",
     "cachePath": "build",
     "prefix": "This document is automatically generated. Please don't edit it directly!",
@@ -60,8 +59,6 @@ which produces:
 }
 ```
 
-If `cleanupLocalAttachmentFiles` is set to true, we disable caching attachment files locally.
-
 ### Continuous Integration
 
 In most scenarios it is not recommended storing your credentials in the configuration file, because you will probably add it to your VCS. Instead, it is recommended to provide the following environment variables in your build pipeline (GitLab CI, GitHub Actions, Jenkins, ...):
@@ -138,7 +135,6 @@ const config = {
     prefix: "This document is automatically generated. Please don't edit it directly!",
     insecure: false,
     force: false,
-    cleanupLocalAttachmentFiles: true,
     fileRoot: "/usr/bin/myawesomefolder",
     pages: [
         {
@@ -153,8 +149,6 @@ const config = {
 await cosmere(config);
 ```
 
-If `cleanupLocalAttachmentFiles` is set to true, we disable caching attachment files locally.
-
 ## Troubleshooting
 
 ### Custom certificates on Confluence instance

src/FileConfigLoader.ts

@@ -110,7 +110,6 @@ export class FileConfigLoader {
             pages: fileConfig.pages,
             configPath: fileConfig.configPath,
             authorizationToken: authorizationToken,
-            cleanupLocalAttachmentFiles: fileConfig.cleanupLocalAttachmentFiles,
         };
     }
 }

src/ObjectConfigLoader.ts

@@ -64,7 +64,6 @@ export class ObjectConfigLoader {
             configPath: config.fileRoot || process.cwd(),
             customRenderer: config.customRenderer,
             authorizationToken: authorizationToken,
-            cleanupLocalAttachmentFiles: config.cleanupLocalAttachmentFiles,
         };
     }
 }

src/UpdatePage.ts

@@ -123,20 +123,7 @@ async function deleteOutOfDateAttachments(
     }
 }
 
-function deleteLocalAttachmentFiles(attachments: Picture[]) {
-    for (const attachment of attachments.filter((attachment) => fs.existsSync(attachment.remoteFileName))) {
-        fs.unlinkSync(attachment.remoteFileName);
-    }
-    signale.success("Local cleanup successful");
-}
-
-async function updateAttachments(
-    mdWikiData: string,
-    pageData: Page,
-    cachePath: string,
-    confluenceAPI: ConfluenceAPI,
-    shouldCleanupLocalFiles: boolean,
-) {
+async function updateAttachments(mdWikiData: string, pageData: Page, cachePath: string, confluenceAPI: ConfluenceAPI) {
     const remoteAttachments = (await confluenceAPI.getAttachments(pageData.pageId)).results;
     let attachments = extractAttachmentsFromPage(pageData, mdWikiData).map((attachment) =>
         mapLocalToRemoteAttachments(attachment, remoteAttachments),
@@ -147,15 +134,17 @@ async function updateAttachments(
 
     await deleteOutOfDateAttachments(attachments, remoteAttachments, confluenceAPI);
     for (const attachment of attachments.filter((attachment) => !attachment.remoteAttachmentId)) {
-        fs.copyFileSync(attachment.originalAbsolutePath, attachment.remoteFileName);
+        const temporaryAttachmentPath = path.join(cachePath, attachment.remoteFileName);
+        fs.copyFileSync(attachment.originalAbsolutePath, temporaryAttachmentPath);
 
         signale.await(`Uploading attachment "${attachment.remoteFileName}" for "${pageData.title}" ...`);
-        await confluenceAPI.uploadAttachment(attachment.remoteFileName, pageData.pageId);
+        try {
+            await confluenceAPI.uploadAttachment(attachment.remoteFileName, pageData.pageId);
+        } finally {
+            fs.unlinkSync(temporaryAttachmentPath);
+        }
     }
 
-    if (shouldCleanupLocalFiles) {
-        deleteLocalAttachmentFiles(attachments);
-    }
     mdWikiData = mdWikiData.replace(/<ri:attachment ri:filename=".+?"/g, (s: string) => s.replace(/(\.\.|\/)/g, "_"));
     return mdWikiData;
 }
@@ -218,13 +207,7 @@ export async function updatePage(confluenceAPI: ConfluenceAPI, pageData: Page, c
         return;
     }
 
-    mdWikiData = await updateAttachments(
-        mdWikiData,
-        pageData,
-        cachePath,
-        confluenceAPI,
-        config.cleanupLocalAttachmentFiles,
-    );
+    mdWikiData = await updateAttachments(mdWikiData, pageData, cachePath, confluenceAPI);
     signale.await(`Fetch current page for "${pageData.title}" ...`);
     const confluencePage = (await confluenceAPI.currentPage(pageData.pageId)).data;
     if (!force && !isRemoteUpdateRequired(mdWikiData, confluencePage)) {

src/cli/MainCommand.ts

@@ -1,7 +1,7 @@
 import { Config } from "../types/Config";
-import { FileConfigLoader } from "../FileConfigLoader";
 import { ConfluenceAPI } from "../api/ConfluenceAPI";
 import { updatePage } from "../UpdatePage";
+import { FileConfigLoader } from "../FileConfigLoader";
 
 export default async function (configPath: string | null, force: boolean = false, insecure: boolean = false) {
     const config: Config = await FileConfigLoader.load(configPath);

src/types/BaseConfig.ts

@@ -4,6 +4,5 @@ export type BaseConfig = {
     baseUrl: string;
     cachePath: string;
     prefix: string;
-    cleanupLocalAttachmentFiles: boolean;
     pages: Page[];
 };

tests/ConfluenceRenderer.test.ts

@@ -11,7 +11,6 @@ describe("ConfluenceRenderer", () => {
         pages: [currentPage, { pageId: "456", title: "", file: "/tmp/other.md" }],
         configPath: "",
         authorizationToken: "",
-        cleanupLocalAttachmentFiles: false,
     };
 
     beforeEach(() => {

tests/FileConfigLoader.test.ts

@@ -1,4 +1,5 @@
 import { FileConfigLoader } from "../src/FileConfigLoader";
+import { BaseConfig } from "../src/types/BaseConfig";
 
 describe("FileConfigLoader", () => {
     it("should create bearer token from personal access token", async () => {
@@ -19,7 +20,7 @@ describe("FileConfigLoader", () => {
         });
     });
 
-    const irrelevantConfigFields = {
+    const irrelevantConfigFields: BaseConfig = {
         baseUrl: "https://confluence.custom.host/rest/api",
         cachePath: "cache/",
         pages: [
@@ -29,6 +30,5 @@ describe("FileConfigLoader", () => {
             },
         ],
         prefix: "This document is automatically generated. Please don't edit it directly!",
-        cleanupLocalAttachmentFiles: false,
     };
 });

tests/ObjectConfigLoader.test.ts

@@ -1,7 +1,9 @@
 import { ObjectConfigLoader } from "../src/ObjectConfigLoader";
+import { ObjectConfig } from "../src/types/ObjectConfig";
+import { BaseConfig } from "../src/types/BaseConfig";
 
 describe("ObjectConfigLoader", () => {
-    const objectConfigurationWithPersonalAccessToken = {
+    const objectConfigurationWithPersonalAccessToken: ObjectConfig = {
         baseUrl: "https://confluence.custom.host/rest/api",
         personalAccessToken: "unbearable",
         prefix: "This document is automatically generated. Please don't edit it directly!",
@@ -15,10 +17,9 @@ describe("ObjectConfigLoader", () => {
         ],
         insecure: false,
         force: false,
-        cleanupLocalAttachmentFiles: false,
     };
 
-    const objectConfigurationWithUserPass = {
+    const objectConfigurationWithUserPass: ObjectConfig = {
         baseUrl: "https://confluence.custom.host/rest/api",
         user: "user",
         pass: "pass",
@@ -33,7 +34,6 @@ describe("ObjectConfigLoader", () => {
         ],
         insecure: false,
         force: false,
-        cleanupLocalAttachmentFiles: false,
     };
 
     it("should create bearer token from personal access token", async () => {
@@ -52,7 +52,7 @@ describe("ObjectConfigLoader", () => {
         });
     });
 
-    const irrelevantConfigFields = {
+    const irrelevantConfigFields: BaseConfig & Pick<ObjectConfig, "customRenderer"> = {
         baseUrl: "https://confluence.custom.host/rest/api",
         cachePath: "cache/",
         pages: [
@@ -63,6 +63,5 @@ describe("ObjectConfigLoader", () => {
         ],
         prefix: "This document is automatically generated. Please don't edit it directly!",
         customRenderer: undefined,
-        cleanupLocalAttachmentFiles: false,
     };
 });

tests/UpdatePage.test.ts

@@ -13,12 +13,11 @@ describe("UpdatePage", () => {
         };
         const config: Config = {
             baseUrl: "string",
-            cachePath: "string",
+            cachePath: "build",
             prefix: "string",
             pages: [],
             configPath: "...",
             authorizationToken: "Bearer unbearable",
-            cleanupLocalAttachmentFiles: false,
         };
         const confluenceApi = new ConfluenceAPI("", "Bearer unbearable", false);
         confluenceApi.getAttachments = jest.fn().mockResolvedValueOnce({
@@ -50,13 +49,12 @@ describe("UpdatePage", () => {
         const customRendererFunction = jest.fn();
         const config: Config = {
             baseUrl: "string",
-            cachePath: "string",
+            cachePath: "build",
             prefix: "string",
             pages: [],
             configPath: "...",
             authorizationToken: "Bearer unbearable",
             customRenderer: customRendererFunction,
-            cleanupLocalAttachmentFiles: false,
         };
         const confluenceApi = new ConfluenceAPI("", "Bearer unbearable", false);
         confluenceApi.getAttachments = jest.fn().mockResolvedValueOnce({

tests/cli/MainCommand.test.ts

@@ -1,3 +1,5 @@
+import { Config } from "../../src/types/Config";
+
 jest.mock("../../src/UpdatePage");
 jest.mock("../../src/FileConfigLoader");
 jest.mock("../../src/api/ConfluenceAPI");
@@ -26,11 +28,10 @@ describe("MainCommand", () => {
                 file: generateRandomString(),
             });
         }
-        const config = {
+        const config: Config = {
             baseUrl: "baseUrl",
             cachePath: ".cache",
             prefix: "prefix",
-            cleanupLocalAttachmentFiles: false,
             pages: randomPages,
             configPath: "path",
             authorizationToken: "token",

tests/resources/test-config-with-personal-access-token-auth.json

@@ -3,7 +3,6 @@
     "personalAccessToken": "unbearable",
     "prefix": "This document is automatically generated. Please don't edit it directly!",
     "cachePath": "cache/",
-    "cleanupLocalAttachmentFiles": false,
     "pages": [
         {
             "pageId": "123456789",

tests/resources/test-config-with-user-pass-auth.json

@@ -4,7 +4,6 @@
     "pass": "pass",
     "prefix": "This document is automatically generated. Please don't edit it directly!",
     "cachePath": "cache/",
-    "cleanupLocalAttachmentFiles": false,
     "pages": [
         {
             "pageId": "123456789",

tsconfig.json

@@ -2,8 +2,8 @@
     "compilerOptions": {
         /* Basic Options */
         // "incremental": true,                   /* Enable incremental compilation */
-        "target": "es6" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */,
-        //    "module": "amd",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+        "target": "ES2019" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */,
+        "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
         "lib": ["esnext"] /* Specify library files to be included in the compilation. */,
         // "allowJs": true,                       /* Allow javascript files to be compiled. */
         // "checkJs": true,                       /* Report errors in .js files. */
@@ -39,7 +39,7 @@
         // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
 
         /* Module Resolution Options */
-        // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+        "moduleResolution": "node" /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */,
         // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
         // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
         // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */