fix(nuxt-module): clean up the dump bundle file after the build (#1924)

* fix(nuxt-module): clean up the dump bundle file after the build

* fix(helpers): correct types

* chore: add missing test for nuxt-module

* chore: fix name of the test

* chore: types

Co-authored-by: Patryk Tomczyk <13100280+patzick@users.noreply.github.com>

Author: mkucmus

api/helpers.api.md

@@ -29,10 +29,19 @@ export function getCmsEntityByType(page?: CmsPageResponse | null): Product | Cat
 export function getCmsLayoutConfiguration(content: CmsBlock | CmsSection): LayoutConfiguration;
 
 // @public
-export function getCmsLink(content?: CmsSlot): String;
+export function getCmsLink(content?: Omit<CmsSlot, "data"> & {
+    data?: {
+        url?: string;
+    };
+}): String;
 
 // @public
-export function getCmsLinkTarget(content?: CmsSlot): String;
+export function getCmsLinkTarget(content?: Omit<CmsSlot, "data"> & {
+    data?: {
+        url?: string;
+        newTab?: boolean;
+    };
+}): String;
 
 // @public (undocumented)
 export function getCmsTechnicalPath(page: CmsPageResponse): string | undefined;

docs/landing/resources/api/helpers.getcmslink.md

@@ -9,14 +9,18 @@ Gets the link of a cms slot
 <b>Signature:</b>
 
 ```typescript
-export declare function getCmsLink(content?: CmsSlot): String;
+export declare function getCmsLink(content?: Omit<CmsSlot, "data"> & {
+    data?: {
+        url?: string;
+    };
+}): String;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  content | CmsSlot |  |
+|  content | Omit&lt;CmsSlot, "data"&gt; &amp; { data?: { url?: string; }; } |  |
 
 <b>Returns:</b>
 

docs/landing/resources/api/helpers.getcmslinktarget.md

@@ -9,14 +9,19 @@ Return the target attribute for the cms link
 <b>Signature:</b>
 
 ```typescript
-export declare function getCmsLinkTarget(content?: CmsSlot): String;
+export declare function getCmsLinkTarget(content?: Omit<CmsSlot, "data"> & {
+    data?: {
+        url?: string;
+        newTab?: boolean;
+    };
+}): String;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  content | CmsSlot |  |
+|  content | Omit&lt;CmsSlot, "data"&gt; &amp; { data?: { url?: string; newTab?: boolean; }; } |  |
 
 <b>Returns:</b>
 

packages/cli/src/extensions/plugins-extensions.ts

@@ -5,6 +5,12 @@ import { join } from "path";
 module.exports = (toolbox: GluegunToolbox) => {
   toolbox.plugins = {};
 
+  type DumpBundlesResponse = {
+    success: boolean;
+    buildArtifact: { [key: string]: string };
+    bundleConfig: any;
+  };
+
   let runningRefreshPlugins: boolean = false;
   toolbox.plugins.invokeRefreshPlugins = async (devMode: boolean = false) => {
     if (runningRefreshPlugins) {
@@ -38,7 +44,7 @@ module.exports = (toolbox: GluegunToolbox) => {
   }: {
     shopwareEndpoint: string;
     authToken: string;
-  }) => {
+  }): Promise<DumpBundlesResponse> => {
     const pluginsConfigRsponse = await axios.post(
       `${toolbox.normalizeBaseUrl(
         shopwareEndpoint
@@ -50,7 +56,7 @@ module.exports = (toolbox: GluegunToolbox) => {
         },
       }
     );
-    return pluginsConfigRsponse.data.buildArtifact;
+    return pluginsConfigRsponse.data;
   };
 
   toolbox.fetchPluginsConfig = async ({ config }: { config: string }) => {
@@ -310,12 +316,11 @@ module.exports = (toolbox: GluegunToolbox) => {
         return;
       }
 
-      const buildArtifact = await toolbox.fetchPluginsBuildArtifact({
-        ...toolbox.inputParameters,
-        authToken,
-      });
-
-      const pluginsConfig = await toolbox.fetchPluginsConfig(buildArtifact);
+      const { buildArtifact, bundleConfig }: DumpBundlesResponse =
+        await toolbox.fetchPluginsBuildArtifact({
+          ...toolbox.inputParameters,
+          authToken,
+        });
 
       await toolbox.filesystem.removeAsync(`.shopware-pwa/pwa-bundles.json`);
       await toolbox.filesystem.removeAsync(`.shopware-pwa/pwa-bundles-assets`);
@@ -324,7 +329,7 @@ module.exports = (toolbox: GluegunToolbox) => {
       );
       await toolbox.filesystem.writeAsync(
         ".shopware-pwa/pwa-bundles.json",
-        pluginsConfig
+        bundleConfig
       );
 
       await toolbox.loadPluginsAssetFile(buildArtifact);

packages/helpers/src/cms/getCmsLink.ts

@@ -5,6 +5,8 @@ import { CmsSlot } from "@shopware-pwa/commons";
  *
  * @public
  */
-export function getCmsLink(content?: CmsSlot): String {
+export function getCmsLink(
+  content?: Omit<CmsSlot, "data"> & { data?: { url?: string } }
+): String {
   return content?.data?.url || "";
 }

packages/helpers/src/cms/getCmsLinkTarget.ts

@@ -5,7 +5,11 @@ import { CmsSlot } from "@shopware-pwa/commons";
  *
  * @public
  */
-export function getCmsLinkTarget(content?: CmsSlot): String {
+export function getCmsLinkTarget(
+  content?: Omit<CmsSlot, "data"> & {
+    data?: { url?: string; newTab?: boolean };
+  }
+): String {
   const inNewTab = content?.data?.newTab;
 
   return inNewTab ? "_blank" : "_self";

packages/nuxt-module/__tests__/module.spec.ts

@@ -442,6 +442,58 @@ describe("nuxt-module - ShopwarePWAModule runModule", () => {
     );
   });
 
+  it("should remove a temporary json file after the build is done", async () => {
+    moduleObject.options.dev = false;
+    const afterBuildMethods: any[] = [];
+    mockedFse.existsSync.mockReturnValue(true);
+    moduleObject.nuxt.hook.mockImplementation(
+      (hookName: string, method: Function) => {
+        hookName === "build:done" && afterBuildMethods.push(method);
+      }
+    );
+    await runModule(moduleObject, {});
+    expect(moduleObject.nuxt.hook).toBeCalledWith(
+      "build:done",
+      expect.any(Function)
+    );
+
+    expect(afterBuildMethods.length).toEqual(1);
+    await afterBuildMethods[0](moduleObject);
+    const pathToDelete = path.join(
+      moduleObject.options.rootDir,
+      ".shopware-pwa",
+      "pwa-bundles.json"
+    );
+    expect(mockedFse.existsSync).toBeCalledWith(pathToDelete);
+    expect(mockedFse.removeSync).toBeCalledWith(pathToDelete);
+  });
+
+  it("should catch the error while a temporary json cannot be deleted", async () => {
+    moduleObject.options.dev = false;
+    const afterBuildMethods: any[] = [];
+    mockedFse.existsSync.mockReturnValue(true);
+    mockedFse.removeSync.mockImplementationOnce(() => {
+      throw new Error("test");
+    });
+
+    moduleObject.nuxt.hook.mockImplementation(
+      (hookName: string, method: Function) => {
+        hookName === "build:done" && afterBuildMethods.push(method);
+      }
+    );
+    await runModule(moduleObject, {});
+    expect(moduleObject.nuxt.hook).toBeCalledWith(
+      "build:done",
+      expect.any(Function)
+    );
+
+    await afterBuildMethods[0](moduleObject);
+    expect(consoleErrorSpy).toHaveBeenLastCalledWith(
+      "error while trying to remove a dump file: ",
+      expect.any(Error)
+    );
+  });
+
   it("should add plugins registered in theme - js|ts files only including extracted mode", async () => {
     mockedFiles.getAllFiles.mockReturnValueOnce([
       "/file/path/plugins/notifications.js",

packages/nuxt-module/src/module.ts

@@ -299,6 +299,20 @@ export async function runModule(
       const sourceDir = path.join(TARGET_SOURCE, "static");
       const destinationDir = path.join(builder.options.rootDir, "static");
       await fse.copy(sourceDir, destinationDir);
+
+      const temporaryShopwarePwaDumpFile = path.join(
+        moduleObject.options.rootDir,
+        ".shopware-pwa",
+        "pwa-bundles.json"
+      );
+
+      if (fse.existsSync(temporaryShopwarePwaDumpFile)) {
+        try {
+          fse.removeSync(temporaryShopwarePwaDumpFile);
+        } catch (error) {
+          console.error("error while trying to remove a dump file: ", error);
+        }
+      }
       console.info(
         "Moved static files to root directory static folder. Make sure your static files are placed inside `src/static` directory."
       );