feat(deployment): publish patterned name if it conforms to GitHub rules

electron-userland · Aug 18, 2017 · e4430c5 · e4430c5
1 parent 83b1cd7
commit e4430c5
Show file tree

Hide file tree

Showing 14 changed files with 40 additions and 34 deletions.
diff --git a/packages/electron-builder-http/src/updateInfo.ts b/packages/electron-builder-http/src/updateInfo.ts
@@ -7,7 +7,7 @@ export interface VersionInfo {
 
 export interface UpdateInfo extends VersionInfo {
   readonly path: string
-  readonly githubArtifactName?: string | null
+  githubArtifactName?: string | null
 
   /**
    * The release name.

diff --git a/packages/electron-builder/src/macPackager.ts b/packages/electron-builder/src/macPackager.ts
@@ -199,9 +199,10 @@ export default class MacPackager extends PlatformPackager<MacOptions> {
         throw new Error(`Cannot find valid "${certType}" identity to sign MAS installer, please see https://github.com/electron-userland/electron-builder/wiki/Code-Signing`)
       }
 
-      const pkg = path.join(outDir!, this.expandArtifactNamePattern(masOptions, "pkg"))
-      await this.doFlat(appPath, pkg, masInstallerIdentity, keychainName)
-      this.dispatchArtifactCreated(pkg, null, Arch.x64, this.computeSafeArtifactName("pkg"))
+      const artifactName = this.expandArtifactNamePattern(masOptions, "pkg")
+      const artifactPath = path.join(outDir!, artifactName)
+      await this.doFlat(appPath, artifactPath, masInstallerIdentity, keychainName)
+      this.dispatchArtifactCreated(artifactPath, null, Arch.x64, this.computeSafeArtifactName(artifactName, "pkg"))
     }
   }
 

diff --git a/packages/electron-builder/src/packagerApi.ts b/packages/electron-builder/src/packagerApi.ts
@@ -33,7 +33,7 @@ export interface ArtifactCreated {
   readonly file?: string
   readonly data?: Buffer
 
-  readonly safeArtifactName?: string
+  readonly safeArtifactName?: string | null
 
   readonly publishConfig?: PublishConfiguration
 

diff --git a/packages/electron-builder/src/platformPackager.ts b/packages/electron-builder/src/platformPackager.ts
@@ -89,7 +89,7 @@ export abstract class PlatformPackager<DC extends PlatformSpecificBuildOptions>
     return this.packagerOptions.prepackaged || path.join(outDir, `${this.platform.buildConfigurationKey}${getArchSuffix(arch)}${this.platform === Platform.MAC ? "" : "-unpacked"}`)
   }
 
-  dispatchArtifactCreated(file: string, target: Target | null, arch: Arch | null, safeArtifactName?: string) {
+  dispatchArtifactCreated(file: string, target: Target | null, arch: Arch | null, safeArtifactName?: string | null) {
     this.info.dispatchArtifactCreated({
       file, safeArtifactName, target, arch,
       packager: this,
@@ -350,7 +350,12 @@ export abstract class PlatformPackager<DC extends PlatformSpecificBuildOptions>
     await this.checkFileInPackage(resourcesDir, "package.json", "Application", isAsar)
   }
 
-  computeSafeArtifactName(ext: string, arch?: Arch | null, skipArchIfX64 = true) {
+  computeSafeArtifactName(suggestedName: string | null, ext: string, arch?: Arch | null, skipArchIfX64 = true): string | null {
+    // GitHub only allows the listed characters in file names.
+    if (suggestedName != null && /^[0-9A-Za-z._-]+$/.test(suggestedName)) {
+      return null
+    }
+
     // tslint:disable:no-invalid-template-strings
     return this.computeArtifactName("${name}-${version}-${arch}.${ext}", ext, skipArchIfX64 && arch === Arch.x64 ? null : arch)
   }
@@ -542,4 +547,4 @@ export abstract class PlatformPackager<DC extends PlatformSpecificBuildOptions>
 // remove leading dot
 export function normalizeExt(ext: string) {
   return ext.startsWith(".") ? ext.substring(1) : ext
-}
+}
diff --git a/packages/electron-builder/src/publish/PublishManager.ts b/packages/electron-builder/src/publish/PublishManager.ts
@@ -160,7 +160,7 @@ export class PublishManager implements PublishContext {
 
   private getOrCreatePublisher(publishConfig: PublishConfiguration, platformPackager: PlatformPackager<any>, target: Target | null): Publisher | null {
     let providerCacheKey = `${publishConfig.provider}-${platformPackager.platform.name}`
-    if (target) {
+    if (target != null) {
       providerCacheKey += `-${target.name}`
     }
 
@@ -281,9 +281,13 @@ async function writeUpdateInfo(event: ArtifactCreated, _publishConfigs: Array<Pu
     const info: UpdateInfo = {
       version,
       releaseDate: new Date().toISOString(),
-      githubArtifactName: event.safeArtifactName,
       path: path.basename(event.file!),
-      sha512: await sha512.value, ...releaseInfo as UpdateInfo}
+      sha512: await sha512.value, ...releaseInfo as UpdateInfo,
+    }
+
+    if (event.safeArtifactName != null) {
+      info.githubArtifactName = event.safeArtifactName
+    }
 
     if (packager.platform === Platform.WINDOWS) {
       // backward compatibility

diff --git a/packages/electron-builder/src/targets/appImage.ts b/packages/electron-builder/src/targets/appImage.ts
@@ -36,7 +36,8 @@ export default class AppImageTarget extends Target {
 
     // https://github.com/electron-userland/electron-builder/issues/775
     // https://github.com/electron-userland/electron-builder/issues/1726
-    const resultFile = path.join(this.outDir, this.options.artifactName == null ? packager.computeSafeArtifactName("AppImage", arch, false) : packager.expandArtifactNamePattern(this.options, "AppImage", arch))
+    const artifactName = this.options.artifactName == null ? packager.computeSafeArtifactName(null, "AppImage", arch, false)!! : packager.expandArtifactNamePattern(this.options, "AppImage", arch)
+    const resultFile = path.join(this.outDir, artifactName)
     await unlinkIfExists(resultFile)
 
     const appImagePath = await appImagePathPromise
@@ -99,6 +100,6 @@ export default class AppImageTarget extends Target {
 
     await chmod(resultFile, "0755")
 
-    packager.dispatchArtifactCreated(resultFile, this, arch, packager.computeSafeArtifactName("AppImage", arch, false))
+    packager.dispatchArtifactCreated(resultFile, this, arch, packager.computeSafeArtifactName(artifactName, "AppImage", arch, false))
   }
-}
+}
diff --git a/packages/electron-builder/src/targets/appx.ts b/packages/electron-builder/src/targets/appx.ts
@@ -83,8 +83,9 @@ export default class AppXTarget extends Target {
     taskManager.addTask(copyDir(appOutDir, path.join(preAppx, "app")))
     await taskManager.awaitTasks()
 
-    const destination = path.join(this.outDir, packager.expandArtifactNamePattern(this.options, "appx", arch))
-    const makeAppXArgs = ["pack", "/o", "/d", preAppx, "/p", destination]
+    const artifactName = packager.expandArtifactNamePattern(this.options, "appx", arch)
+    const artifactPath = path.join(this.outDir, artifactName)
+    const makeAppXArgs = ["pack", "/o", "/d", preAppx, "/p", artifactPath]
 
     // we do not use process.arch to build path to tools, because even if you are on x64, ia32 appx tool must be used if you build appx for ia32
     if (isScaledAssetsProvided(userAssets)) {
@@ -99,13 +100,13 @@ export default class AppXTarget extends Target {
     use(this.options.makeappxArgs, (it: Array<string>) => makeAppXArgs.push(...it))
     // wine supports only ia32 binary in any case makeappx crashed on wine
     await spawn(path.join(vendorPath, "windows-10", Arch[arch], "makeappx.exe"), makeAppXArgs, undefined, {isDebugEnabled: debug.enabled})
-    await packager.sign(destination)
+    await packager.sign(artifactPath)
 
     packager.info.dispatchArtifactCreated({
-      file: destination,
+      file: artifactPath,
       packager,
       arch,
-      safeArtifactName: packager.computeSafeArtifactName("appx"),
+      safeArtifactName: packager.computeSafeArtifactName(artifactName, "appx"),
       target: this,
       isWriteUpdateInfo: this.options.electronUpdaterAware,
     })

diff --git a/packages/electron-builder/src/targets/dmg.ts b/packages/electron-builder/src/targets/dmg.ts
@@ -163,7 +163,8 @@ export class DmgTarget extends Target {
       return
     }
 
-    const artifactPath = path.join(this.outDir, packager.expandArtifactNamePattern(packager.config.dmg, "dmg"))
+    const artifactName = packager.expandArtifactNamePattern(packager.config.dmg, "dmg")
+    const artifactPath = path.join(this.outDir, artifactName)
 
     // dmg file must not exist otherwise hdiutil failed (https://github.com/electron-userland/electron-builder/issues/1308#issuecomment-282847594), so, -ov must be specified
     //noinspection SpellCheckingInspection
@@ -176,7 +177,7 @@ export class DmgTarget extends Target {
 
     await addLicenseToDmg(packager, artifactPath)
 
-    this.packager.dispatchArtifactCreated(artifactPath, this, arch, packager.computeSafeArtifactName("dmg"))
+    this.packager.dispatchArtifactCreated(artifactPath, this, arch, packager.computeSafeArtifactName(artifactName, "dmg"))
   }
 
   computeVolumeName(custom?: string | null): string {

diff --git a/packages/electron-builder/src/targets/pkg.ts b/packages/electron-builder/src/targets/pkg.ts
@@ -47,17 +47,18 @@ export class PkgTarget extends Target {
       throw new Error(`Cannot find valid "${certType}" to sign standalone installer, please see https://github.com/electron-userland/electron-builder/wiki/Code-Signing`)
     }
 
-    const outFile = path.join(appOutDir, packager.expandArtifactNamePattern(options, "pkg"))
+    const artifactName = packager.expandArtifactNamePattern(options, "pkg")
+    const artifactPath = path.join(appOutDir, artifactName)
     const args = prepareProductBuildArgs(identity, keychainName)
     args.push("--distribution", distInfoFile)
-    args.push(outFile)
+    args.push(artifactPath)
     use(options.productbuild, it => args.push(...it as any))
     await exec("productbuild", args, {
       cwd: appOutDir,
     })
     await BluebirdPromise.all([unlink(innerPackageFile), unlink(distInfoFile)])
 
-    packager.dispatchArtifactCreated(outFile, this, arch, packager.computeSafeArtifactName("pkg", arch))
+    packager.dispatchArtifactCreated(artifactPath, this, arch, packager.computeSafeArtifactName(artifactName, "pkg", arch))
   }
 
   private async customizeDistributionConfiguration(distInfoFile: string, appPath: string) {

diff --git a/packages/electron-publish/src/publisher.ts b/packages/electron-publish/src/publisher.ts
@@ -32,7 +32,7 @@ export abstract class Publisher {
 
   abstract get providerName(): string
 
-  abstract upload(file: string, arch: Arch, safeArtifactName?: string): Promise<any>
+  abstract upload(file: string, arch: Arch, safeArtifactName?: string | null): Promise<any>
 
   protected createProgressBar(fileName: string, fileStat: Stats): ProgressBar | null {
     if (this.context.progress == null) {

diff --git a/test/out/__snapshots__/ExtraBuildTest.js.snap b/test/out/__snapshots__/ExtraBuildTest.js.snap
@@ -6,7 +6,6 @@ Object {
     Object {
       "arch": "x64",
       "file": "TestApp-1.1.0-x86_64.AppImage",
-      "safeArtifactName": "TestApp-1.1.0-x86_64.AppImage",
     },
   ],
 }
@@ -97,7 +96,7 @@ Object {
 `;
 
 exports[`scheme validation 1`] = `
-"Config is invalid:
+"Configuration is invalid:
 {
   \\"foo\\": \\"Unknown option\\",
   \\"mac\\": [
@@ -136,7 +135,6 @@ Object {
     Object {
       "arch": "x64",
       "file": "TestApp-1.1.0-x86_64.AppImage",
-      "safeArtifactName": "TestApp-1.1.0-x86_64.AppImage",
     },
     Object {
       "arch": "ia32",

diff --git a/test/out/linux/__snapshots__/linuxPackagerTest.js.snap b/test/out/linux/__snapshots__/linuxPackagerTest.js.snap
@@ -31,7 +31,6 @@ Object {
     Object {
       "arch": "x64",
       "file": "TestApp-1.1.0-x86_64.AppImage",
-      "safeArtifactName": "TestApp-1.1.0-x86_64.AppImage",
     },
   ],
 }
@@ -43,7 +42,6 @@ Object {
     Object {
       "arch": "x64",
       "file": "TestApp-1.1.0-x86_64.AppImage",
-      "safeArtifactName": "TestApp-1.1.0-x86_64.AppImage",
     },
   ],
 }

diff --git a/test/out/mac/__snapshots__/dmgTest.js.snap b/test/out/mac/__snapshots__/dmgTest.js.snap
@@ -81,7 +81,6 @@ Object {
     Object {
       "arch": "x64",
       "file": "NoApplicationsLink-1.1.0.dmg",
-      "safeArtifactName": "TestApp-1.1.0.dmg",
     },
     Object {
       "arch": "x64",
@@ -98,7 +97,6 @@ Object {
     Object {
       "arch": "x64",
       "file": "NoBackground-1.1.0.dmg",
-      "safeArtifactName": "TestApp-1.1.0.dmg",
     },
   ],
 }
@@ -112,7 +110,6 @@ Object {
     Object {
       "arch": "x64",
       "file": "NoBuildDirectory-1.1.0.dmg",
-      "safeArtifactName": "TestApp-1.1.0.dmg",
     },
   ],
 }

diff --git a/test/out/mac/__snapshots__/macPackagerTest.js.snap b/test/out/mac/__snapshots__/macPackagerTest.js.snap
@@ -97,7 +97,6 @@ Object {
     Object {
       "arch": "x64",
       "file": "TestApp-1.1.0-mac.dmg",
-      "safeArtifactName": "TestApp-1.1.0.dmg",
     },
     Object {
       "file": "latest-mac.json",