fix: adding log warning in case afterSign exists but no signing occ…

…urred (#7388)
electron-userland · Jan 24, 2023 · 1cb8f50 · 1cb8f50
1 parent aeffe08
commit 1cb8f50
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 8 deletions.
diff --git a/.changeset/neat-peas-complain.md b/.changeset/neat-peas-complain.md
@@ -0,0 +1,5 @@
+---
+"app-builder-lib": major
+---
+
+fix(BREAKING): Execute `afterSign` hook only when signing is completed, otherwise skip
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -100,7 +100,7 @@ jobs:
       matrix:
         testFiles:
           - installerTest,appxTest,msiTest,portableTest,assistedInstallerTest,protonTest
-          - oneClickInstallerTest,winCodeSignTest,winPackagerTest,webInstallerTest
+          - BuildTest,oneClickInstallerTest,winCodeSignTest,winPackagerTest,webInstallerTest
     steps:
       - name: Checkout code repository
         uses: actions/checkout@v3

diff --git a/packages/app-builder-lib/src/platformPackager.ts b/packages/app-builder-lib/src/platformPackager.ts
@@ -330,10 +330,12 @@ export abstract class PlatformPackager<DC extends PlatformSpecificBuildOptions>
       electronPlatformName: platformName,
     }
     const didSign = await this.signApp(packContext, isAsar)
-    if (didSign) {
-      const afterSign = resolveFunction(this.config.afterSign, "afterSign")
-      if (afterSign != null) {
+    const afterSign = resolveFunction(this.config.afterSign, "afterSign")
+    if (afterSign != null) {
+      if (didSign) {
         await Promise.resolve(afterSign(packContext))
+      } else {
+        log.warn(null, `skipping "afterSign" hook as no signing occurred, perhaps you intended "afterPack"?`)
       }
     }
   }
@@ -428,7 +430,7 @@ export abstract class PlatformPackager<DC extends PlatformSpecificBuildOptions>
 
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   protected signApp(packContext: AfterPackContext, isAsar: boolean): Promise<any> {
-    return Promise.resolve(true)
+    return Promise.resolve(false)
   }
 
   getIconPath(): Promise<string | null> {

diff --git a/test/snapshots/BuildTest.js.snap b/test/snapshots/BuildTest.js.snap
@@ -10,7 +10,7 @@ Object {
 exports[`afterSign 1`] = `
 Object {
   "linux": Array [],
-  "mac": Array [],
+  "win": Array [],
 }
 `;
 

diff --git a/test/src/BuildTest.ts b/test/src/BuildTest.ts
@@ -241,12 +241,12 @@ test.ifLinuxOrDevMac("afterPack", () => {
   )
 })
 
-test.ifLinuxOrDevMac("afterSign", () => {
+test.ifWindows("afterSign", () => {
   let called = 0
   return assertPack(
     "test-app-one",
     {
-      targets: createTargets([Platform.LINUX, Platform.MAC], DIR_TARGET),
+      targets: createTargets([Platform.LINUX, Platform.WINDOWS], DIR_TARGET),
       config: {
         afterSign: () => {
           called++