/
PublishManager.ts
582 lines (500 loc) · 20.9 KB
/
PublishManager.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
import BluebirdPromise from "bluebird-lst"
import { Arch, asArray, AsyncTaskManager, InvalidConfigurationError, isEmptyOrSpaces, isPullRequest, log, safeStringifyJson, serializeToYaml } from "builder-util"
import {
CancellationToken,
GenericServerOptions,
getS3LikeProviderBaseUrl,
GithubOptions,
githubUrl,
KeygenOptions,
SnapStoreOptions,
PublishConfiguration,
PublishProvider,
BitbucketOptions,
} from "builder-util-runtime"
import _debug from "debug"
import { getCiTag, PublishContext, Publisher, PublishOptions, UploadTask } from "electron-publish"
import { GitHubPublisher } from "electron-publish/out/gitHubPublisher"
import { MultiProgress } from "electron-publish/out/multiProgress"
import S3Publisher from "./s3/s3Publisher"
import SpacesPublisher from "./s3/spacesPublisher"
import { writeFile } from "fs/promises"
import * as isCi from "is-ci"
import * as path from "path"
import { WriteStream as TtyWriteStream } from "tty"
import * as url from "url"
import { AppInfo, ArtifactCreated, Configuration, Platform, PlatformSpecificBuildOptions, Target } from "../index"
import { Packager } from "../packager"
import { PlatformPackager } from "../platformPackager"
import { expandMacro } from "../util/macroExpander"
import { WinPackager } from "../winPackager"
import { SnapStorePublisher } from "./SnapStorePublisher"
import { createUpdateInfoTasks, UpdateInfoFileTask, writeUpdateInfoFiles } from "./updateInfoBuilder"
import { KeygenPublisher } from "./KeygenPublisher"
import { BitbucketPublisher } from "./BitbucketPublisher"
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)" +
"\nIf you have SSH keys, sensitive env vars or AWS credentials stored in your project settings and untrusted forks can make pull requests against your repo, then this option isn't for you."
const debug = _debug("electron-builder:publish")
function checkOptions(publishPolicy: any) {
if (publishPolicy != null && publishPolicy !== "onTag" && publishPolicy !== "onTagOrDraft" && publishPolicy !== "always" && publishPolicy !== "never") {
if (typeof publishPolicy === "string") {
throw new InvalidConfigurationError(
`Expected one of "onTag", "onTagOrDraft", "always", "never", but got ${JSON.stringify(
publishPolicy
)}.\nPlease note that publish configuration should be specified under "config"`
)
}
}
}
export class PublishManager implements PublishContext {
private readonly nameToPublisher = new Map<string, Publisher | null>()
private readonly taskManager: AsyncTaskManager
readonly isPublish: boolean = false
readonly progress = (process.stdout as TtyWriteStream).isTTY ? new MultiProgress() : null
private readonly updateFileWriteTask: Array<UpdateInfoFileTask> = []
constructor(private readonly packager: Packager, private readonly publishOptions: PublishOptions, readonly cancellationToken: CancellationToken = packager.cancellationToken) {
checkOptions(publishOptions.publish)
this.taskManager = new AsyncTaskManager(cancellationToken)
const forcePublishForPr = process.env.PUBLISH_FOR_PULL_REQUEST === "true"
if (!isPullRequest() || forcePublishForPr) {
if (publishOptions.publish === undefined) {
if (process.env.npm_lifecycle_event === "release") {
publishOptions.publish = "always"
} else {
const tag = getCiTag()
if (tag != null) {
log.info({ reason: "tag is defined", tag }, "artifacts will be published")
publishOptions.publish = "onTag"
} else if (isCi) {
log.info({ reason: "CI detected" }, "artifacts will be published if draft release exists")
publishOptions.publish = "onTagOrDraft"
}
}
}
const publishPolicy = publishOptions.publish
this.isPublish = publishPolicy != null && publishOptions.publish !== "never" && (publishPolicy !== "onTag" || getCiTag() != null)
if (this.isPublish && forcePublishForPr) {
log.warn(publishForPrWarning)
}
} else if (publishOptions.publish !== "never") {
log.info(
{
reason: "current build is a part of pull request",
solution: `set env PUBLISH_FOR_PULL_REQUEST to true to force code signing\n${publishForPrWarning}`,
},
"publishing will be skipped"
)
}
packager.addAfterPackHandler(async event => {
const packager = event.packager
if (event.electronPlatformName === "darwin") {
if (!event.targets.some(it => it.name === "dmg" || it.name === "zip")) {
return
}
} else if (packager.platform === Platform.WINDOWS) {
if (!event.targets.some(it => isSuitableWindowsTarget(it))) {
return
}
} else {
// AppImage writes data to AppImage stage dir, not to linux-unpacked
return
}
const publishConfig = await getAppUpdatePublishConfiguration(packager, event.arch, this.isPublish)
if (publishConfig != null) {
await writeFile(path.join(packager.getResourcesDir(event.appOutDir), "app-update.yml"), serializeToYaml(publishConfig))
}
})
packager.artifactCreated(event => {
const publishConfiguration = event.publishConfig
if (publishConfiguration == null) {
this.taskManager.addTask(this.artifactCreatedWithoutExplicitPublishConfig(event))
} else if (this.isPublish) {
if (debug.enabled) {
debug(`artifactCreated (isPublish: ${this.isPublish}): ${safeStringifyJson(event, new Set(["packager"]))},\n publishConfig: ${safeStringifyJson(publishConfiguration)}`)
}
this.scheduleUpload(publishConfiguration, event, this.getAppInfo(event.packager))
}
})
}
private getAppInfo(platformPackager: PlatformPackager<any> | null) {
return platformPackager == null ? this.packager.appInfo : platformPackager.appInfo
}
async getGlobalPublishConfigurations(): Promise<Array<PublishConfiguration> | null> {
const publishers = this.packager.config.publish
return await resolvePublishConfigurations(publishers, null, this.packager, null, true)
}
/** @internal */
scheduleUpload(publishConfig: PublishConfiguration, event: UploadTask, appInfo: AppInfo): void {
if (publishConfig.provider === "generic") {
return
}
const publisher = this.getOrCreatePublisher(publishConfig, appInfo)
if (publisher == null) {
log.debug(
{
file: event.file,
reason: "publisher is null",
publishConfig: safeStringifyJson(publishConfig),
},
"not published"
)
return
}
const providerName = publisher.providerName
if (this.publishOptions.publish === "onTagOrDraft" && getCiTag() == null && providerName !== "bitbucket" && providerName !== "github") {
log.info({ file: event.file, reason: "current build is not for a git tag", publishPolicy: "onTagOrDraft" }, `not published to ${providerName}`)
return
}
if (publishConfig.timeout) {
event.timeout = publishConfig.timeout
}
this.taskManager.addTask(publisher.upload(event))
}
private async artifactCreatedWithoutExplicitPublishConfig(event: ArtifactCreated) {
const platformPackager = event.packager
const target = event.target
const publishConfigs = await getPublishConfigs(platformPackager, target == null ? null : target.options, event.arch, this.isPublish)
if (debug.enabled) {
debug(`artifactCreated (isPublish: ${this.isPublish}): ${safeStringifyJson(event, new Set(["packager"]))},\n publishConfigs: ${safeStringifyJson(publishConfigs)}`)
}
const eventFile = event.file
if (publishConfigs == null) {
if (this.isPublish) {
log.debug({ file: eventFile, reason: "no publish configs" }, "not published")
}
return
}
if (this.isPublish) {
for (const publishConfig of publishConfigs) {
if (this.cancellationToken.cancelled) {
log.debug({ file: event.file, reason: "cancelled" }, "not published")
break
}
this.scheduleUpload(publishConfig, event, this.getAppInfo(platformPackager))
}
}
if (
event.isWriteUpdateInfo &&
target != null &&
eventFile != null &&
!this.cancellationToken.cancelled &&
(platformPackager.platform !== Platform.WINDOWS || isSuitableWindowsTarget(target))
) {
this.taskManager.addTask(createUpdateInfoTasks(event, publishConfigs).then(it => this.updateFileWriteTask.push(...it)))
}
}
private getOrCreatePublisher(publishConfig: PublishConfiguration, appInfo: AppInfo): Publisher | null {
// to not include token into cache key
const providerCacheKey = safeStringifyJson(publishConfig)
let publisher = this.nameToPublisher.get(providerCacheKey)
if (publisher == null) {
publisher = createPublisher(this, appInfo.version, publishConfig, this.publishOptions, this.packager)
this.nameToPublisher.set(providerCacheKey, publisher)
log.info({ publisher: publisher!.toString() }, "publishing")
}
return publisher
}
// noinspection JSUnusedGlobalSymbols
cancelTasks() {
this.taskManager.cancelTasks()
this.nameToPublisher.clear()
}
async awaitTasks(): Promise<void> {
await this.taskManager.awaitTasks()
const updateInfoFileTasks = this.updateFileWriteTask
if (this.cancellationToken.cancelled || updateInfoFileTasks.length === 0) {
return
}
await writeUpdateInfoFiles(updateInfoFileTasks, this.packager)
await this.taskManager.awaitTasks()
}
}
export async function getAppUpdatePublishConfiguration(packager: PlatformPackager<any>, arch: Arch, errorIfCannot: boolean) {
const publishConfigs = await getPublishConfigsForUpdateInfo(packager, await getPublishConfigs(packager, null, arch, errorIfCannot), arch)
if (publishConfigs == null || publishConfigs.length === 0) {
return null
}
const publishConfig = {
...publishConfigs[0],
updaterCacheDirName: packager.appInfo.updaterCacheDirName,
}
if (packager.platform === Platform.WINDOWS && publishConfig.publisherName == null) {
const winPackager = packager as WinPackager
const publisherName = winPackager.isForceCodeSigningVerification ? await winPackager.computedPublisherName.value : undefined
if (publisherName != null) {
publishConfig.publisherName = publisherName
}
}
return publishConfig
}
export async function getPublishConfigsForUpdateInfo(
packager: PlatformPackager<any>,
publishConfigs: Array<PublishConfiguration> | null,
arch: Arch | null
): Promise<Array<PublishConfiguration> | null> {
if (publishConfigs === null) {
return null
}
if (publishConfigs.length === 0) {
log.debug(null, "getPublishConfigsForUpdateInfo: no publishConfigs, detect using repository info")
// https://github.com/electron-userland/electron-builder/issues/925#issuecomment-261732378
// default publish config is github, file should be generated regardless of publish state (user can test installer locally or manage the release process manually)
const repositoryInfo = await packager.info.repositoryInfo
debug(`getPublishConfigsForUpdateInfo: ${safeStringifyJson(repositoryInfo)}`)
if (repositoryInfo != null && repositoryInfo.type === "github") {
const resolvedPublishConfig = await getResolvedPublishConfig(packager, packager.info, { provider: repositoryInfo.type }, arch, false)
if (resolvedPublishConfig != null) {
debug(`getPublishConfigsForUpdateInfo: resolve to publish config ${safeStringifyJson(resolvedPublishConfig)}`)
return [resolvedPublishConfig]
}
}
}
return publishConfigs
}
export function createPublisher(context: PublishContext, version: string, publishConfig: PublishConfiguration, options: PublishOptions, packager: Packager): Publisher | null {
if (debug.enabled) {
debug(`Create publisher: ${safeStringifyJson(publishConfig)}`)
}
const provider = publishConfig.provider
switch (provider) {
case "github":
return new GitHubPublisher(context, publishConfig as GithubOptions, version, options)
case "keygen":
return new KeygenPublisher(context, publishConfig as KeygenOptions, version)
case "snapStore":
return new SnapStorePublisher(context, publishConfig as SnapStoreOptions)
case "generic":
return null
default: {
const clazz = requireProviderClass(provider, packager)
return clazz == null ? null : new clazz(context, publishConfig)
}
}
}
function requireProviderClass(provider: string, packager: Packager): any | null {
switch (provider) {
case "github":
return GitHubPublisher
case "generic":
return null
case "keygen":
return KeygenPublisher
case "s3":
return S3Publisher
case "snapStore":
return SnapStorePublisher
case "spaces":
return SpacesPublisher
case "bitbucket":
return BitbucketPublisher
default: {
const name = `electron-publisher-${provider}`
let module: any = null
try {
module = require(path.join(packager.buildResourcesDir, name + ".js"))
} catch (ignored) {
console.log(ignored)
}
if (module == null) {
module = require(name)
}
return module.default || module
}
}
}
export function computeDownloadUrl(publishConfiguration: PublishConfiguration, fileName: string | null, packager: PlatformPackager<any>) {
if (publishConfiguration.provider === "generic") {
const baseUrlString = (publishConfiguration as GenericServerOptions).url
if (fileName == null) {
return baseUrlString
}
const baseUrl = url.parse(baseUrlString)
return url.format({ ...(baseUrl as url.UrlObject), pathname: path.posix.resolve(baseUrl.pathname || "/", encodeURI(fileName)) })
}
let baseUrl
if (publishConfiguration.provider === "github") {
const gh = publishConfiguration as GithubOptions
baseUrl = `${githubUrl(gh)}/${gh.owner}/${gh.repo}/releases/download/${gh.vPrefixedTagName === false ? "" : "v"}${packager.appInfo.version}`
} else {
baseUrl = getS3LikeProviderBaseUrl(publishConfiguration)
}
if (fileName == null) {
return baseUrl
}
return `${baseUrl}/${encodeURI(fileName)}`
}
export async function getPublishConfigs(
platformPackager: PlatformPackager<any>,
targetSpecificOptions: PlatformSpecificBuildOptions | null | undefined,
arch: Arch | null,
errorIfCannot: boolean
): Promise<Array<PublishConfiguration> | null> {
let publishers
// check build.nsis (target)
if (targetSpecificOptions != null) {
publishers = targetSpecificOptions.publish
// if explicitly set to null - do not publish
if (publishers === null) {
return null
}
}
// check build.win (platform)
if (publishers == null) {
publishers = platformPackager.platformSpecificBuildOptions.publish
if (publishers === null) {
return null
}
}
if (publishers == null) {
publishers = platformPackager.config.publish
if (publishers === null) {
return null
}
}
return await resolvePublishConfigurations(publishers, platformPackager, platformPackager.info, arch, errorIfCannot)
}
async function resolvePublishConfigurations(
publishers: any,
platformPackager: PlatformPackager<any> | null,
packager: Packager,
arch: Arch | null,
errorIfCannot: boolean
): Promise<Array<PublishConfiguration> | null> {
if (publishers == null) {
let serviceName: PublishProvider | null = null
if (!isEmptyOrSpaces(process.env.GH_TOKEN) || !isEmptyOrSpaces(process.env.GITHUB_TOKEN)) {
serviceName = "github"
} else if (!isEmptyOrSpaces(process.env.KEYGEN_TOKEN)) {
serviceName = "keygen"
} else if (!isEmptyOrSpaces(process.env.BITBUCKET_TOKEN)) {
serviceName = "bitbucket"
} else if (!isEmptyOrSpaces(process.env.BT_TOKEN)) {
throw new Error(
"Bintray has been sunset and is no longer supported by electron-builder. Ref: https://jfrog.com/blog/into-the-sunset-bintray-jcenter-gocenter-and-chartcenter/"
)
}
if (serviceName != null) {
log.debug(null, `detect ${serviceName} as publish provider`)
return [(await getResolvedPublishConfig(platformPackager, packager, { provider: serviceName }, arch, errorIfCannot))!]
}
}
if (publishers == null) {
return []
}
debug(`Explicit publish provider: ${safeStringifyJson(publishers)}`)
return await (BluebirdPromise.map(asArray(publishers), it =>
getResolvedPublishConfig(platformPackager, packager, typeof it === "string" ? { provider: it } : it, arch, errorIfCannot)
) as Promise<Array<PublishConfiguration>>)
}
function isSuitableWindowsTarget(target: Target) {
if (target.name === "appx" && target.options != null && (target.options as any).electronUpdaterAware) {
return true
}
return target.name === "nsis" || target.name.startsWith("nsis-")
}
function expandPublishConfig(options: any, platformPackager: PlatformPackager<any> | null, packager: Packager, arch: Arch | null): void {
for (const name of Object.keys(options)) {
const value = options[name]
if (typeof value === "string") {
const archValue = arch == null ? null : Arch[arch]
const expanded = platformPackager == null ? expandMacro(value, archValue, packager.appInfo) : platformPackager.expandMacro(value, archValue)
if (expanded !== value) {
options[name] = expanded
}
}
}
}
function isDetectUpdateChannel(platformSpecificConfiguration: PlatformSpecificBuildOptions | null, configuration: Configuration) {
const value = platformSpecificConfiguration == null ? null : platformSpecificConfiguration.detectUpdateChannel
return value == null ? configuration.detectUpdateChannel !== false : value
}
async function getResolvedPublishConfig(
platformPackager: PlatformPackager<any> | null,
packager: Packager,
options: PublishConfiguration,
arch: Arch | null,
errorIfCannot: boolean
): Promise<PublishConfiguration | GithubOptions | BitbucketOptions | null> {
options = { ...options }
expandPublishConfig(options, platformPackager, packager, arch)
let channelFromAppVersion: string | null = null
if (
(options as GenericServerOptions).channel == null &&
isDetectUpdateChannel(platformPackager == null ? null : platformPackager.platformSpecificBuildOptions, packager.config)
) {
channelFromAppVersion = packager.appInfo.channel
}
const provider = options.provider
if (provider === "generic") {
const o = options as GenericServerOptions
if (o.url == null) {
throw new InvalidConfigurationError(`Please specify "url" for "generic" update server`)
}
if (channelFromAppVersion != null) {
;(o as any).channel = channelFromAppVersion
}
return options
}
const providerClass = requireProviderClass(options.provider, packager)
if (providerClass != null && providerClass.checkAndResolveOptions != null) {
await providerClass.checkAndResolveOptions(options, channelFromAppVersion, errorIfCannot)
return options
}
if (provider === "keygen") {
return {
...options,
platform: platformPackager?.platform.name,
} as KeygenOptions
}
const isGithub = provider === "github"
if (!isGithub && provider !== "bitbucket") {
return options
}
let owner = isGithub ? (options as GithubOptions).owner : (options as BitbucketOptions).owner
let project = isGithub ? (options as GithubOptions).repo : (options as BitbucketOptions).slug
if (isGithub && owner == null && project != null) {
const index = project.indexOf("/")
if (index > 0) {
const repo = project
project = repo.substring(0, index)
owner = repo.substring(index + 1)
}
}
async function getInfo() {
const info = await packager.repositoryInfo
if (info != null) {
return info
}
const message = `Cannot detect repository by .git/config. Please specify "repository" in the package.json (https://docs.npmjs.com/files/package.json#repository).\nPlease see https://electron.build/configuration/publish`
if (errorIfCannot) {
throw new Error(message)
} else {
log.warn(message)
return null
}
}
if (!owner || !project) {
log.debug({ reason: "owner or project is not specified explicitly", provider, owner, project }, "calling getInfo")
const info = await getInfo()
if (info == null) {
return null
}
if (!owner) {
owner = info.user
}
if (!project) {
project = info.project
}
}
if (isGithub) {
if ((options as GithubOptions).token != null && !(options as GithubOptions).private) {
log.warn('"token" specified in the github publish options. It should be used only for [setFeedURL](module:electron-updater/out/AppUpdater.AppUpdater+setFeedURL).')
}
//tslint:disable-next-line:no-object-literal-type-assertion
return { owner, repo: project, ...options } as GithubOptions
} else {
//tslint:disable-next-line:no-object-literal-type-assertion
return { owner, slug: project, ...options } as BitbucketOptions
}
}