mirror of
https://github.com/CherryHQ/cherry-studio.git
synced 2025-12-29 05:51:26 +08:00
d12515ccb9
* feat: enhance multi-language support in release notes processing * fix review comments * format code
387 lines
13 KiB
TypeScript
387 lines
13 KiB
TypeScript
import { loggerService } from '@logger'
|
||
import { isWin } from '@main/constant'
|
||
import { getIpCountry } from '@main/utils/ipService'
|
||
import { locales } from '@main/utils/locales'
|
||
import { generateUserAgent } from '@main/utils/systemInfo'
|
||
import { FeedUrl, UpgradeChannel } from '@shared/config/constant'
|
||
import { IpcChannel } from '@shared/IpcChannel'
|
||
import { CancellationToken, UpdateInfo } from 'builder-util-runtime'
|
||
import { app, BrowserWindow, dialog, net } from 'electron'
|
||
import { AppUpdater as _AppUpdater, autoUpdater, Logger, NsisUpdater, UpdateCheckResult } from 'electron-updater'
|
||
import path from 'path'
|
||
import semver from 'semver'
|
||
|
||
import icon from '../../../build/icon.png?asset'
|
||
import { configManager } from './ConfigManager'
|
||
import { windowService } from './WindowService'
|
||
|
||
const logger = loggerService.withContext('AppUpdater')
|
||
|
||
// Language markers constants for multi-language release notes
|
||
const LANG_MARKERS = {
|
||
EN_START: '<!--LANG:en-->',
|
||
ZH_CN_START: '<!--LANG:zh-CN-->',
|
||
END: '<!--LANG:END-->'
|
||
} as const
|
||
|
||
export default class AppUpdater {
|
||
autoUpdater: _AppUpdater = autoUpdater
|
||
private releaseInfo: UpdateInfo | undefined
|
||
private cancellationToken: CancellationToken = new CancellationToken()
|
||
private updateCheckResult: UpdateCheckResult | null = null
|
||
|
||
constructor() {
|
||
autoUpdater.logger = logger as Logger
|
||
autoUpdater.forceDevUpdateConfig = !app.isPackaged
|
||
autoUpdater.autoDownload = configManager.getAutoUpdate()
|
||
autoUpdater.autoInstallOnAppQuit = configManager.getAutoUpdate()
|
||
autoUpdater.requestHeaders = {
|
||
...autoUpdater.requestHeaders,
|
||
'User-Agent': generateUserAgent(),
|
||
'X-Client-Id': configManager.getClientId()
|
||
}
|
||
|
||
autoUpdater.on('error', (error) => {
|
||
logger.error('update error', error as Error)
|
||
windowService.getMainWindow()?.webContents.send(IpcChannel.UpdateError, error)
|
||
})
|
||
|
||
autoUpdater.on('update-available', (releaseInfo: UpdateInfo) => {
|
||
logger.info('update available', releaseInfo)
|
||
const processedReleaseInfo = this.processReleaseInfo(releaseInfo)
|
||
windowService.getMainWindow()?.webContents.send(IpcChannel.UpdateAvailable, processedReleaseInfo)
|
||
})
|
||
|
||
// 检测到不需要更新时
|
||
autoUpdater.on('update-not-available', () => {
|
||
windowService.getMainWindow()?.webContents.send(IpcChannel.UpdateNotAvailable)
|
||
})
|
||
|
||
// 更新下载进度
|
||
autoUpdater.on('download-progress', (progress) => {
|
||
windowService.getMainWindow()?.webContents.send(IpcChannel.DownloadProgress, progress)
|
||
})
|
||
|
||
// 当需要更新的内容下载完成后
|
||
autoUpdater.on('update-downloaded', (releaseInfo: UpdateInfo) => {
|
||
const processedReleaseInfo = this.processReleaseInfo(releaseInfo)
|
||
windowService.getMainWindow()?.webContents.send(IpcChannel.UpdateDownloaded, processedReleaseInfo)
|
||
this.releaseInfo = processedReleaseInfo
|
||
logger.info('update downloaded', processedReleaseInfo)
|
||
})
|
||
|
||
if (isWin) {
|
||
;(autoUpdater as NsisUpdater).installDirectory = path.dirname(app.getPath('exe'))
|
||
}
|
||
|
||
this.autoUpdater = autoUpdater
|
||
}
|
||
|
||
private async _getReleaseVersionFromGithub(channel: UpgradeChannel) {
|
||
const headers = {
|
||
Accept: 'application/vnd.github+json',
|
||
'X-GitHub-Api-Version': '2022-11-28',
|
||
'Accept-Language': 'en-US,en;q=0.9'
|
||
}
|
||
try {
|
||
logger.info(`get release version from github: ${channel}`)
|
||
const responses = await net.fetch('https://api.github.com/repos/CherryHQ/cherry-studio/releases?per_page=8', {
|
||
headers
|
||
})
|
||
const data = (await responses.json()) as GithubReleaseInfo[]
|
||
let mightHaveLatest = false
|
||
const release: GithubReleaseInfo | undefined = data.find((item: GithubReleaseInfo) => {
|
||
if (!item.draft && !item.prerelease) {
|
||
mightHaveLatest = true
|
||
}
|
||
|
||
return item.prerelease && item.tag_name.includes(`-${channel}.`)
|
||
})
|
||
|
||
if (!release) {
|
||
return null
|
||
}
|
||
|
||
// if the release version is the same as the current version, return null
|
||
if (release.tag_name === app.getVersion()) {
|
||
return null
|
||
}
|
||
|
||
if (mightHaveLatest) {
|
||
logger.info(`might have latest release, get latest release`)
|
||
const latestReleaseResponse = await net.fetch(
|
||
'https://api.github.com/repos/CherryHQ/cherry-studio/releases/latest',
|
||
{
|
||
headers
|
||
}
|
||
)
|
||
const latestRelease = (await latestReleaseResponse.json()) as GithubReleaseInfo
|
||
if (semver.gt(latestRelease.tag_name, release.tag_name)) {
|
||
logger.info(
|
||
`latest release version is ${latestRelease.tag_name}, prerelease version is ${release.tag_name}, return null`
|
||
)
|
||
return null
|
||
}
|
||
}
|
||
|
||
logger.info(`release url is ${release.tag_name}, set channel to ${channel}`)
|
||
return `https://github.com/CherryHQ/cherry-studio/releases/download/${release.tag_name}`
|
||
} catch (error) {
|
||
logger.error('Failed to get latest not draft version from github:', error as Error)
|
||
return null
|
||
}
|
||
}
|
||
|
||
public setAutoUpdate(isActive: boolean) {
|
||
autoUpdater.autoDownload = isActive
|
||
autoUpdater.autoInstallOnAppQuit = isActive
|
||
}
|
||
|
||
private _getChannelByVersion(version: string) {
|
||
if (version.includes(`-${UpgradeChannel.BETA}.`)) {
|
||
return UpgradeChannel.BETA
|
||
}
|
||
if (version.includes(`-${UpgradeChannel.RC}.`)) {
|
||
return UpgradeChannel.RC
|
||
}
|
||
return UpgradeChannel.LATEST
|
||
}
|
||
|
||
private _getTestChannel() {
|
||
const currentChannel = this._getChannelByVersion(app.getVersion())
|
||
const savedChannel = configManager.getTestChannel()
|
||
|
||
if (currentChannel === UpgradeChannel.LATEST) {
|
||
return savedChannel || UpgradeChannel.RC
|
||
}
|
||
|
||
if (savedChannel === currentChannel) {
|
||
return savedChannel
|
||
}
|
||
|
||
// if the upgrade channel is not equal to the current channel, use the latest channel
|
||
return UpgradeChannel.LATEST
|
||
}
|
||
|
||
private _setChannel(channel: UpgradeChannel, feedUrl: string) {
|
||
this.autoUpdater.channel = channel
|
||
this.autoUpdater.setFeedURL(feedUrl)
|
||
|
||
// disable downgrade after change the channel
|
||
this.autoUpdater.allowDowngrade = false
|
||
// github and gitcode don't support multiple range download
|
||
this.autoUpdater.disableDifferentialDownload = true
|
||
}
|
||
|
||
private async _setFeedUrl() {
|
||
const testPlan = configManager.getTestPlan()
|
||
if (testPlan) {
|
||
const channel = this._getTestChannel()
|
||
|
||
if (channel === UpgradeChannel.LATEST) {
|
||
this._setChannel(UpgradeChannel.LATEST, FeedUrl.GITHUB_LATEST)
|
||
return
|
||
}
|
||
|
||
const releaseUrl = await this._getReleaseVersionFromGithub(channel)
|
||
if (releaseUrl) {
|
||
logger.info(`release url is ${releaseUrl}, set channel to ${channel}`)
|
||
this._setChannel(channel, releaseUrl)
|
||
return
|
||
}
|
||
|
||
// if no prerelease url, use github latest to get release
|
||
this._setChannel(UpgradeChannel.LATEST, FeedUrl.GITHUB_LATEST)
|
||
return
|
||
}
|
||
|
||
this._setChannel(UpgradeChannel.LATEST, FeedUrl.PRODUCTION)
|
||
const ipCountry = await getIpCountry()
|
||
logger.info(`ipCountry is ${ipCountry}, set channel to ${UpgradeChannel.LATEST}`)
|
||
if (ipCountry.toLowerCase() !== 'cn') {
|
||
this._setChannel(UpgradeChannel.LATEST, FeedUrl.GITHUB_LATEST)
|
||
}
|
||
}
|
||
|
||
public cancelDownload() {
|
||
this.cancellationToken.cancel()
|
||
this.cancellationToken = new CancellationToken()
|
||
if (this.autoUpdater.autoDownload) {
|
||
this.updateCheckResult?.cancellationToken?.cancel()
|
||
}
|
||
}
|
||
|
||
public async checkForUpdates() {
|
||
if (isWin && 'PORTABLE_EXECUTABLE_DIR' in process.env) {
|
||
return {
|
||
currentVersion: app.getVersion(),
|
||
updateInfo: null
|
||
}
|
||
}
|
||
|
||
try {
|
||
await this._setFeedUrl()
|
||
|
||
this.updateCheckResult = await this.autoUpdater.checkForUpdates()
|
||
logger.info(
|
||
`update check result: ${this.updateCheckResult?.isUpdateAvailable}, channel: ${this.autoUpdater.channel}, currentVersion: ${this.autoUpdater.currentVersion}`
|
||
)
|
||
|
||
if (this.updateCheckResult?.isUpdateAvailable && !this.autoUpdater.autoDownload) {
|
||
// 如果 autoDownload 为 false，则需要再调用下面的函数触发下
|
||
// do not use await, because it will block the return of this function
|
||
logger.info('downloadUpdate manual by check for updates', this.cancellationToken)
|
||
this.autoUpdater.downloadUpdate(this.cancellationToken)
|
||
}
|
||
|
||
return {
|
||
currentVersion: this.autoUpdater.currentVersion,
|
||
updateInfo: this.updateCheckResult?.isUpdateAvailable ? this.updateCheckResult?.updateInfo : null
|
||
}
|
||
} catch (error) {
|
||
logger.error('Failed to check for update:', error as Error)
|
||
return {
|
||
currentVersion: app.getVersion(),
|
||
updateInfo: null
|
||
}
|
||
}
|
||
}
|
||
|
||
public async showUpdateDialog(mainWindow: BrowserWindow) {
|
||
if (!this.releaseInfo) {
|
||
return
|
||
}
|
||
const locale = locales[configManager.getLanguage()]
|
||
const { update: updateLocale } = locale.translation
|
||
|
||
let detail = this.formatReleaseNotes(this.releaseInfo.releaseNotes)
|
||
if (detail === '') {
|
||
detail = updateLocale.noReleaseNotes
|
||
}
|
||
|
||
dialog
|
||
.showMessageBox({
|
||
type: 'info',
|
||
title: updateLocale.title,
|
||
icon,
|
||
message: updateLocale.message.replace('{{version}}', this.releaseInfo.version),
|
||
detail,
|
||
buttons: [updateLocale.later, updateLocale.install],
|
||
defaultId: 1,
|
||
cancelId: 0
|
||
})
|
||
.then(({ response }) => {
|
||
if (response === 1) {
|
||
app.isQuitting = true
|
||
setImmediate(() => autoUpdater.quitAndInstall())
|
||
} else {
|
||
mainWindow.webContents.send(IpcChannel.UpdateDownloadedCancelled)
|
||
}
|
||
})
|
||
}
|
||
|
||
/**
|
||
* Check if release notes contain multi-language markers
|
||
*/
|
||
private hasMultiLanguageMarkers(releaseNotes: string): boolean {
|
||
return releaseNotes.includes(LANG_MARKERS.EN_START)
|
||
}
|
||
|
||
/**
|
||
* Parse multi-language release notes and return the appropriate language version
|
||
* @param releaseNotes - Release notes string with language markers
|
||
* @returns Parsed release notes for the user's language
|
||
*
|
||
* Expected format:
|
||
* <!--LANG:en-->English content<!--LANG:zh-CN-->Chinese content<!--LANG:END-->
|
||
*/
|
||
private parseMultiLangReleaseNotes(releaseNotes: string): string {
|
||
try {
|
||
const language = configManager.getLanguage()
|
||
const isChineseUser = language === 'zh-CN' || language === 'zh-TW'
|
||
|
||
// Create regex patterns using constants
|
||
const enPattern = new RegExp(
|
||
`${LANG_MARKERS.EN_START.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')}([\\s\\S]*?)${LANG_MARKERS.ZH_CN_START.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')}`
|
||
)
|
||
const zhPattern = new RegExp(
|
||
`${LANG_MARKERS.ZH_CN_START.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')}([\\s\\S]*?)${LANG_MARKERS.END.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')}`
|
||
)
|
||
|
||
// Extract language sections
|
||
const enMatch = releaseNotes.match(enPattern)
|
||
const zhMatch = releaseNotes.match(zhPattern)
|
||
|
||
// Return appropriate language version with proper fallback
|
||
if (isChineseUser && zhMatch) {
|
||
return zhMatch[1].trim()
|
||
} else if (enMatch) {
|
||
return enMatch[1].trim()
|
||
} else {
|
||
// Clean fallback: remove all language markers
|
||
logger.warn('Failed to extract language-specific release notes, using cleaned fallback')
|
||
return releaseNotes
|
||
.replace(new RegExp(`${LANG_MARKERS.EN_START}|${LANG_MARKERS.ZH_CN_START}|${LANG_MARKERS.END}`, 'g'), '')
|
||
.trim()
|
||
}
|
||
} catch (error) {
|
||
logger.error('Failed to parse multi-language release notes', error as Error)
|
||
// Return original notes as safe fallback
|
||
return releaseNotes
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Process release info to handle multi-language release notes
|
||
* @param releaseInfo - Original release info from updater
|
||
* @returns Processed release info with localized release notes
|
||
*/
|
||
private processReleaseInfo(releaseInfo: UpdateInfo): UpdateInfo {
|
||
const processedInfo = { ...releaseInfo }
|
||
|
||
// Handle multi-language release notes in string format
|
||
if (releaseInfo.releaseNotes && typeof releaseInfo.releaseNotes === 'string') {
|
||
// Check if it contains multi-language markers
|
||
if (this.hasMultiLanguageMarkers(releaseInfo.releaseNotes)) {
|
||
processedInfo.releaseNotes = this.parseMultiLangReleaseNotes(releaseInfo.releaseNotes)
|
||
}
|
||
}
|
||
|
||
return processedInfo
|
||
}
|
||
|
||
/**
|
||
* Format release notes for display
|
||
* @param releaseNotes - Release notes in various formats
|
||
* @returns Formatted string for display
|
||
*/
|
||
private formatReleaseNotes(releaseNotes: string | ReleaseNoteInfo[] | null | undefined): string {
|
||
if (!releaseNotes) {
|
||
return ''
|
||
}
|
||
|
||
if (typeof releaseNotes === 'string') {
|
||
// Check if it contains multi-language markers
|
||
if (this.hasMultiLanguageMarkers(releaseNotes)) {
|
||
return this.parseMultiLangReleaseNotes(releaseNotes)
|
||
}
|
||
return releaseNotes
|
||
}
|
||
|
||
if (Array.isArray(releaseNotes)) {
|
||
return releaseNotes.map((note) => note.note).join('\n')
|
||
}
|
||
|
||
return ''
|
||
}
|
||
}
|
||
interface GithubReleaseInfo {
|
||
draft: boolean
|
||
prerelease: boolean
|
||
tag_name: string
|
||
}
|
||
interface ReleaseNoteInfo {
|
||
readonly version: string
|
||
readonly note: string | null
|
||
}
|