feat(snap): publishing to Snapcraft

Close #3187

mkdocs.yml

@@ -16,6 +16,9 @@ edit_uri: ""
 dev_addr: 0.0.0.0:8000
 strict: true
 
+extra_javascript:
+  - extra.js
+
 markdown_extensions:
   - admonition
   - smarty

packages/app-builder-lib/src/index.ts

@@ -34,6 +34,7 @@ export { PublishManager } from "./publish/PublishManager"
 export { PlatformPackager } from "./platformPackager"
 export { Framework, PrepareApplicationStageDirectoryOptions } from "./Framework"
 export { buildForge, ForgeOptions } from "./forge-maker"
+export { SnapStoreOptions } from "./publish/SnapStorePublisher"
 
 const expectedOptions = new Set(["publish", "targets", "mac", "win", "linux", "projectDir", "platformPackagerFactory", "config", "effectiveOptionComputed", "prepackaged"])
 

packages/app-builder-lib/src/packagerApi.ts

@@ -32,7 +32,7 @@ export interface ArtifactCreated extends UploadTask {
 
   readonly safeArtifactName?: string | null
 
-  readonly publishConfig?: PublishConfiguration
+  readonly publishConfig?: PublishConfiguration | null
 
   readonly isWriteUpdateInfo?: boolean
 }

packages/electron-publish/src/BintrayPublisher.ts → packages/app-builder-lib/src/publish/BintrayPublisher.ts

@@ -4,7 +4,7 @@ import { BintrayClient, Version } from "builder-util-runtime/out/bintray"
 import { httpExecutor } from "builder-util/out/nodeHttpExecutor"
 import { ClientRequest, RequestOptions } from "http"
 import { Lazy } from "lazy-val"
-import { HttpPublisher, PublishContext, PublishOptions } from "./publisher"
+import { HttpPublisher, PublishContext, PublishOptions } from "electron-publish"
 
 export class BintrayPublisher extends HttpPublisher {
   private readonly _versionPromise = new Lazy(() => this.init())

packages/app-builder-lib/src/publish/PublishManager.ts

@@ -3,11 +3,11 @@ import { Arch, asArray, AsyncTaskManager, InvalidConfigurationError, isEmptyOrSp
 import { BintrayOptions, CancellationToken, GenericServerOptions, getS3LikeProviderBaseUrl, GithubOptions, githubUrl, PublishConfiguration, PublishProvider } from "builder-util-runtime"
 import _debug from "debug"
 import { getCiTag, PublishContext, Publisher, PublishOptions, UploadTask } from "electron-publish"
-import { BintrayPublisher } from "electron-publish/out/BintrayPublisher"
+import { BintrayPublisher } from "./BintrayPublisher"
 import { GitHubPublisher } from "electron-publish/out/gitHubPublisher"
 import { MultiProgress } from "electron-publish/out/multiProgress"
-import S3Publisher from "electron-publish/out/s3/s3Publisher"
-import SpacesPublisher from "electron-publish/out/s3/spacesPublisher"
+import S3Publisher from "./s3/s3Publisher"
+import SpacesPublisher from "./s3/spacesPublisher"
 import { writeFile } from "fs-extra"
 import isCi from "is-ci"
 import * as path from "path"
@@ -18,6 +18,7 @@ import { Packager } from "../packager"
 import { PlatformPackager } from "../platformPackager"
 import { expandMacro } from "../util/macroExpander"
 import { WinPackager } from "../winPackager"
+import { SnapStoreOptions, SnapStorePublisher } from "./SnapStorePublisher"
 import { createUpdateInfoTasks, UpdateInfoFileTask, writeUpdateInfoFiles } from "./updateInfoBuilder"
 
 const publishForPrWarning = "There are serious security concerns with PUBLISH_FOR_PULL_REQUEST=true (see the  CircleCI documentation (https://circleci.com/docs/1.0/fork-pr-builds/) for details)" +
@@ -277,6 +278,9 @@ export function createPublisher(context: PublishContext, version: string, publis
     case "generic":
       return null
 
+    case "snapStore":
+      return new SnapStorePublisher(context, publishConfig as SnapStoreOptions)
+
     default:
       const clazz = requireProviderClass(provider, packager)
       return clazz == null ? null : new clazz(context, publishConfig)

packages/app-builder-lib/src/publish/SnapStorePublisher.ts

@@ -0,0 +1,49 @@
+import { Publisher, UploadTask, PublishContext } from "electron-publish"
+import { executeAppBuilder } from "builder-util"
+import * as path from "path"
+import { PublishConfiguration } from "builder-util-runtime"
+
+export class SnapStorePublisher extends Publisher {
+  readonly providerName = "snapStore"
+
+  constructor(context: PublishContext, private options: SnapStoreOptions) {
+    super(context)
+  }
+
+  upload(task: UploadTask): Promise<any> {
+    this.createProgressBar(path.basename(task.file), -1)
+
+    const args = ["publish-snap", "-f", task.file]
+
+    let channels = this.options.channels
+    if (channels == null) {
+      channels = ["edge"]
+    }
+    else {
+      if (typeof channels === "string") {
+        channels = channels.split(",")
+      }
+    }
+
+    for (const channel of channels) {
+      args.push("-c", channel)
+    }
+
+    return executeAppBuilder(args)
+  }
+
+  toString(): string {
+    return "Snap Store"
+  }
+}
+
+/**
+ * [Snap Store](https://snapcraft.io/) options.
+ */
+export interface SnapStoreOptions extends PublishConfiguration {
+  /**
+   * The list of channels the snap would be released.
+   * @default ["edge"]
+   */
+  readonly channels?: string | Array<string> | null
+}

packages/electron-publish/src/s3/BaseS3Publisher.ts → packages/app-builder-lib/src/publish/s3/BaseS3Publisher.ts

@@ -1,6 +1,6 @@
 import { log, executeAppBuilder } from "builder-util"
 import { BaseS3Options } from "builder-util-runtime"
-import { PublishContext, Publisher, UploadTask } from "../publisher"
+import { PublishContext, Publisher, UploadTask } from "electron-publish"
 import { ensureDir, symlink } from "fs-extra"
 import * as path from "path"
 

packages/electron-publish/src/s3/s3Publisher.ts → packages/app-builder-lib/src/publish/s3/s3Publisher.ts

@@ -1,6 +1,6 @@
 import { executeAppBuilder, InvalidConfigurationError, log } from "builder-util"
 import { S3Options } from "builder-util-runtime"
-import { PublishContext } from "../publisher"
+import { PublishContext } from "electron-publish"
 import { BaseS3Publisher } from "./BaseS3Publisher"
 
 export default class S3Publisher extends BaseS3Publisher {

packages/electron-publish/src/s3/spacesPublisher.ts → packages/app-builder-lib/src/publish/s3/spacesPublisher.ts

@@ -1,6 +1,6 @@
 import { InvalidConfigurationError, isEmptyOrSpaces } from "builder-util"
 import { SpacesOptions } from "builder-util-runtime"
-import { PublishContext } from "../publisher"
+import { PublishContext } from "electron-publish"
 import { BaseS3Publisher } from "./BaseS3Publisher"
 
 export default class SpacesPublisher extends BaseS3Publisher {

packages/app-builder-lib/src/targets/snap.ts

@@ -203,7 +203,14 @@ export default class SnapTarget extends Target {
     }
     await executeAppBuilder(args)
 
-    await packager.dispatchArtifactCreated(artifactPath, this, arch, packager.computeSafeArtifactName(artifactName, "snap", arch, false))
+    await packager.info.callArtifactBuildCompleted({
+      file: artifactPath,
+      safeArtifactName: packager.computeSafeArtifactName(artifactName, "snap", arch, false),
+      target: this,
+      arch,
+      packager,
+      publishConfig: options.publish == null ? {provider: "snapStore"} : null,
+    })
   }
 
   private isElectronVersionGreaterOrEqualThen(version: string) {

packages/builder-util-runtime/src/CancellationToken.ts

@@ -116,6 +116,6 @@ export class CancellationToken extends EventEmitter {
 
 export class CancellationError extends Error {
   constructor() {
-    super("Cancelled")
+    super("cancelled")
   }
 }

packages/builder-util-runtime/src/ProgressCallbackTransform.ts

@@ -22,7 +22,7 @@ export class ProgressCallbackTransform extends Transform {
 
   _transform(chunk: any, encoding: string, callback: any) {
     if (this.cancellationToken.cancelled) {
-      callback(new Error("Cancelled"), null)
+      callback(new Error("cancelled"), null)
       return
     }
 
@@ -48,7 +48,7 @@ export class ProgressCallbackTransform extends Transform {
 
   _flush(callback: any): void {
     if (this.cancellationToken.cancelled) {
-      callback(new Error("Cancelled"))
+      callback(new Error("cancelled"))
       return
     }
 

packages/builder-util-runtime/src/publishOptions.ts

@@ -1,4 +1,4 @@
-export type PublishProvider = "github" | "bintray" | "s3" | "spaces" | "generic" | "custom"
+export type PublishProvider = "github" | "bintray" | "s3" | "spaces" | "generic" | "custom" | "snapStore"
 
 // typescript-json-schema generates only PublishConfiguration if it is specified in the list, so, it is not added here
 export type AllPublishOptions = string | GithubOptions | S3Options | SpacesOptions | GenericServerOptions | BintrayOptions | CustomPublishOptions

packages/electron-publish/src/publisher.ts

@@ -68,7 +68,7 @@ export abstract class Publisher {
 }
 
 export abstract class HttpPublisher extends Publisher {
-  constructor(protected readonly context: PublishContext, private readonly useSafeArtifactName = false) {
+  protected constructor(protected readonly context: PublishContext, private readonly useSafeArtifactName = false) {
     super(context)
   }
 

packages/electron-updater/src/AppUpdater.ts

@@ -612,7 +612,7 @@ export abstract class AppUpdater extends EventEmitter {
       await removeFileIfAny()
 
       if (e instanceof CancellationError) {
-        log.info("Cancelled")
+        log.info("cancelled")
         this.emit("update-cancelled", updateInfo)
       }
       throw e

scripts/jsdoc/helpers.js

@@ -289,7 +289,7 @@ function identifierToLink(id, root) {
       id !== "module:https.RequestOptions" &&
       !id.endsWith(".__type")
     ) {
-      for (const name of ["GithubOptions", "GenericServerOptions", "BintrayOptions", "S3Options", "SpacesOptions", "PublishConfiguration"]) {
+      for (const name of ["GithubOptions", "GenericServerOptions", "BintrayOptions", "S3Options", "SpacesOptions", "PublishConfiguration", "SnapStoreOptions"]) {
         if (id.endsWith(`.${name}`)) {
           return `[${name}](/configuration/publish#${name.toLowerCase()})`
         }

scripts/jsdoc2md.js

@@ -215,10 +215,8 @@ async function render2(files, jsdoc2MdOptions) {
     }),
 
     new Page("generated/s3-options.md", "S3Options"),
-
-    new Page("generated/spaces-options.md", null, {
-      "SpacesOptions": "",
-    }),
+    new Page("generated/snap-store-options.md", null, {"SnapStoreOptions": ""}),
+    new Page("generated/spaces-options.md", null, {"SpacesOptions": ""}),
 
     new Page("generated/appimage-options.md", "AppImageOptions"),
     new Page("generated/DebOptions.md", "DebOptions"),

scripts/snap-template.sh

@@ -8,9 +8,11 @@ rm -rf ~/squashfs-root/app ~/squashfs-root/snap ~/squashfs-root/meta ~/squashfs-
 rm -rf ~/squashfs-root/etc ~/squashfs-root/var
 
 #rm -f /home/develar/snap-template-electron-4.0.tar.7z && cd ~/squashfs-root && tar cf - . | zstd -22 --ultra --long  -o ~/snap-template-electron-4.0.tar.zstd
-rm -f /home/develar/snap-template-electron-4.0.tar.7z && cd ~/squashfs-root && tar cf - . | 7za a -mx=9 -mfb=64 -si ~/snap-template-electron-4.0.tar.7z
+rm -f /home/develar/snap-template-electron-4.0.tar.7z && cd ~/squashfs-root && tar cf - . | 7za a -mx=9 -mfb=64 -si ~/snap-template-electron-4.0-2.tar.7z
+
+zip -yX9 -r ~/snap-template-electron-4.0-2.zip .
 
 #rm -f /home/develar/snap-template-electron-4.0.tar.7z && cd ~/squashfs-root && tar cf - . | 7za a -mx=9 -mfb=64 -si ~/snap-template-electron-4.0-1-arm.tar.7z
 
 mv ~/snap-template-electron-4.0.tar.7z /media/psf/ramdisk/snap-template-electron-4.0.tar.7z
-shasum -a 512 /Volumes/ramdisk/snap-template-electron-4.0.tar.7z | xxd -r -p | base64
+shasum -a 512 /Volumes/ramdisk/snap-template-electron-4.0-2.tar.7z | xxd -r -p | base64

test/src/ArtifactPublisherTest.ts

@@ -2,7 +2,7 @@ import { Arch, copyFile, TmpDir } from "builder-util"
 import { CancellationToken, HttpError, S3Options, SpacesOptions } from "builder-util-runtime"
 import { createPublisher } from "app-builder-lib/out/publish/PublishManager"
 import { PublishContext } from "electron-publish"
-import { BintrayPublisher } from "electron-publish/out/BintrayPublisher"
+import { BintrayPublisher } from "app-builder-lib/out/publish/BintrayPublisher"
 import { GitHubPublisher } from "electron-publish/out/gitHubPublisher"
 import isCi from "is-ci"
 import { join } from "path"