refine code to improve readability

Author: daihere1993

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

@@ -317,7 +317,7 @@ export async function createPublisher(
       return new GitHubPublisher(context, publishConfig as GithubOptions, version, options)
 
     case "gitlab":
-      return new GitlabPublisher(context, publishConfig as GitlabOptions, version, options)
+      return new GitlabPublisher(context, publishConfig as GitlabOptions, version)
 
     case "keygen":
       return new KeygenPublisher(context, publishConfig as KeygenOptions, version)

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

@@ -143,6 +143,53 @@ export function githubUrl(options: GithubOptions, defaultHost = "github.com") {
   return `${options.protocol || "https"}://${options.host || defaultHost}`
 }
 
+/**
+ * [GitLab](https://docs.gitlab.com/ee/user/project/releases/) options.
+ *
+ * GitLab [personal access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html) is required for private repositories. You can generate one by going to your GitLab profile settings.
+ * Define `GITLAB_TOKEN` or `GL_TOKEN` environment variable.
+ */
+export interface GitlabOptions extends PublishConfiguration {
+  /**
+   * The provider. Must be `gitlab`.
+   */
+  readonly provider: "gitlab"
+
+  /**
+   * The GitLab project ID or path (e.g., "12345678" or "namespace/project").
+   */
+  readonly projectId?: string | number | null
+
+  /**
+   * The GitLab host (including the port if need).
+   * @default gitlab.com
+   */
+  readonly host?: string | null
+
+  /**
+   * The access token to support auto-update from private GitLab repositories. Never specify it in the configuration files.
+   */
+  readonly token?: string | null
+
+  /**
+   * Whether to use `v`-prefixed tag name.
+   * @default true
+   */
+  readonly vPrefixedTagName?: boolean
+
+  /**
+   * The channel.
+   * @default latest
+   */
+  readonly channel?: string | null
+
+  /**
+   * Upload target method. Can be "project_upload" for GitLab project uploads or "generic_package" for GitLab generic packages.
+   * @default "project_upload"
+   */
+  readonly uploadTarget?: "project_upload" | "generic_package" | null
+}
+
 /**
  * Generic (any HTTP(S) server) options.
  * In all publish options [File Macros](./file-patterns.md#file-macros) are supported.
@@ -276,53 +323,6 @@ export interface SnapStoreOptions extends PublishConfiguration {
   readonly channels?: string | Array<string> | null
 }
 
-/**
- * [GitLab](https://docs.gitlab.com/ee/user/project/releases/) options.
- *
- * GitLab [personal access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html) is required for private repositories. You can generate one by going to your GitLab profile settings.
- * Define `GITLAB_TOKEN` or `GL_TOKEN` environment variable.
- */
-export interface GitlabOptions extends PublishConfiguration {
-  /**
-   * The provider. Must be `gitlab`.
-   */
-  readonly provider: "gitlab"
-
-  /**
-   * The GitLab project ID or path (e.g., "12345678" or "namespace/project").
-   */
-  readonly projectId?: string | number | null
-
-  /**
-   * The GitLab host (including the port if need).
-   * @default gitlab.com
-   */
-  readonly host?: string | null
-
-  /**
-   * The access token to support auto-update from private GitLab repositories. Never specify it in the configuration files.
-   */
-  readonly token?: string | null
-
-  /**
-   * Whether to use `v`-prefixed tag name.
-   * @default true
-   */
-  readonly vPrefixedTagName?: boolean
-
-  /**
-   * The channel.
-   * @default latest
-   */
-  readonly channel?: string | null
-
-  /**
-   * Upload target method. Can be "project_upload" for GitLab project uploads or "generic_package" for GitLab generic packages.
-   * @default "project_upload"
-   */
-  readonly uploadTarget?: "project_upload" | "generic_package" | null
-}
-
 export interface BaseS3Options extends PublishConfiguration {
   /**
    * The update channel.

packages/electron-publish/src/gitlabPublisher.ts

@@ -9,8 +9,9 @@ import * as mime from "mime"
 import * as FormData from "form-data"
 import { URL } from "url"
 import { HttpPublisher } from "./httpPublisher"
-import { PublishContext, PublishOptions } from "./index"
-import { getCiTag } from "./publisher"
+import { PublishContext } from "./index"
+
+type RequestProcessor = (request: ClientRequest, reject: (error: Error) => void) => void
 
 export class GitlabPublisher extends HttpPublisher {
   private readonly tag: string
@@ -28,8 +29,7 @@ export class GitlabPublisher extends HttpPublisher {
   constructor(
     context: PublishContext,
     private readonly info: GitlabOptions,
-    private readonly version: string,
-    private readonly options: PublishOptions = {}
+    private readonly version: string
   ) {
     super(context, true)
 
@@ -67,32 +67,13 @@ export class GitlabPublisher extends HttpPublisher {
     }
 
     try {
-      // Get all releases first, then filter by tag (similar to GitHub publisher pattern)
-      const url = new URL(`${this.baseApiPath}/projects/${encodeURIComponent(this.projectId)}/releases`)
-      const releases = await this.gitlabRequest<GitlabReleaseInfo[]>(url, this.token)
-      for (const release of releases) {
-        if (release.tag_name === this.tag) {
-          return release
-        }
+      const existingRelease = await this.getExistingRelease()
+      if (existingRelease) {
+        return existingRelease
       }
 
       // Create new release if it doesn't exist
-      if (this.options.publish === "always" || getCiTag() != null) {
-        log.info(
-          {
-            reason: "release doesn't exist",
-            ...logFields,
-          },
-          `creating GitLab release`
-        )
-        return this.createRelease()
-      }
-
-      this.releaseLogFields = {
-        reason: 'release doesn\'t exist and not created because "publish" is not "always" and build is not on tag',
-        ...logFields,
-      }
-      return null
+      return this.createRelease()
     } catch (error: any) {
       const errorInfo = this.categorizeGitlabError(error)
       log.error(
@@ -108,9 +89,22 @@ export class GitlabPublisher extends HttpPublisher {
     }
   }
 
+  private async getExistingRelease(): Promise<GitlabReleaseInfo | null> {
+    const url = this.buildProjectUrl("/releases")
+    const releases = await this.gitlabRequest<GitlabReleaseInfo[]>(url, this.token)
+
+    for (const release of releases) {
+      if (release.tag_name === this.tag) {
+        return release
+      }
+    }
+
+    return null
+  }
+
   private async getDefaultBranch(): Promise<string> {
     try {
-      const url = new URL(`${this.baseApiPath}/projects/${encodeURIComponent(this.projectId)}`)
+      const url = this.buildProjectUrl()
       const project = await this.gitlabRequest<{ default_branch: string }>(url, this.token)
       return project.default_branch || "main"
     } catch (error: any) {
@@ -139,17 +133,11 @@ export class GitlabPublisher extends HttpPublisher {
       "creating GitLab release"
     )
 
-    const url = new URL(`${this.baseApiPath}/projects/${encodeURIComponent(this.projectId)}/releases`)
+    const url = this.buildProjectUrl("/releases")
     return this.gitlabRequest<GitlabReleaseInfo>(url, this.token, releaseData, "POST")
   }
 
-  protected async doUpload(
-    fileName: string,
-    arch: Arch,
-    dataLength: number,
-    requestProcessor: (request: ClientRequest, reject: (error: Error) => void) => void,
-    _file: string
-  ): Promise<any> {
+  protected async doUpload(fileName: string, arch: Arch, dataLength: number, requestProcessor: RequestProcessor, filePath: string): Promise<any> {
     const release = await this._release.value
     if (release == null) {
       log.warn({ file: fileName, ...this.releaseLogFields }, "skipped publishing")
@@ -165,32 +153,16 @@ export class GitlabPublisher extends HttpPublisher {
 
     try {
       log.debug(logFields, "starting GitLab upload")
-      // Default to project_upload method
-      const uploadTarget = this.info.uploadTarget || "project_upload"
-
-      let uploadResult
-      let assetUrl: string
-      if (uploadTarget === "generic_package") {
-        uploadResult = await this.uploadToGenericPackages(fileName, dataLength, requestProcessor, _file)
-        // For generic packages, construct the download URL
-        const projectId = encodeURIComponent(this.projectId)
-        assetUrl = `${this.baseApiPath}/projects/${projectId}/packages/generic/releases/${this.version}/${fileName}`
-      } else {
-        // Default to project_upload
-        uploadResult = await this.uploadToProjectUpload(fileName, _file)
-        // For project uploads, construct full URL from relative path
-        assetUrl = `https://${this.host}${uploadResult.url}`
-      }
-
+      const assetPath = await this.uploadFileAndReturnAssetPath(fileName, dataLength, requestProcessor, filePath)
       // Add the uploaded file as a release asset link
-      if (assetUrl) {
-        await this.addReleaseAssetLink(fileName, assetUrl)
-        log.info({ ...logFields, assetUrl }, "GitLab upload completed successfully")
+      if (assetPath) {
+        await this.addReleaseAssetLink(fileName, assetPath)
+        log.info({ ...logFields, assetPath }, "GitLab upload completed successfully")
       } else {
         log.warn({ ...logFields }, "No asset URL found for file")
       }
 
-      return uploadResult
+      return assetPath
     } catch (e: any) {
       const errorInfo = this.categorizeGitlabError(e)
       log.error(
@@ -206,6 +178,26 @@ export class GitlabPublisher extends HttpPublisher {
     }
   }
 
+  private async uploadFileAndReturnAssetPath(fileName: string, dataLength: number, requestProcessor: RequestProcessor, filePath: string) {
+    // Default to project_upload method
+    const uploadTarget = this.info.uploadTarget || "project_upload"
+
+    let assetPath: string
+    if (uploadTarget === "generic_package") {
+      await this.uploadToGenericPackages(fileName, dataLength, requestProcessor)
+      // For generic packages, construct the download URL
+      const projectId = encodeURIComponent(this.projectId)
+      assetPath = `${this.baseApiPath}/projects/${projectId}/packages/generic/releases/${this.version}/${fileName}`
+    } else {
+      // Default to project_upload
+      const uploadResult = await this.uploadToProjectUpload(fileName, filePath)
+      // For project uploads, construct full URL from relative path
+      assetPath = `https://${this.host}${uploadResult.url}`
+    }
+
+    return assetPath
+  }
+
   private async addReleaseAssetLink(fileName: string, assetUrl: string): Promise<void> {
     try {
       const linkData = {
@@ -214,7 +206,7 @@ export class GitlabPublisher extends HttpPublisher {
         link_type: "other",
       }
 
-      const url = new URL(`${this.baseApiPath}/projects/${encodeURIComponent(this.projectId)}/releases/${this.tag}/assets/links`)
+      const url = this.buildProjectUrl(`/releases/${this.tag}/assets/links`)
       await this.gitlabRequest(url, this.token, linkData, "POST")
 
       log.debug({ fileName, assetUrl }, "Successfully linked asset to GitLab release")
@@ -224,25 +216,25 @@ export class GitlabPublisher extends HttpPublisher {
     }
   }
 
-  private async uploadToProjectUpload(fileName: string, _filePath: string): Promise<any> {
+  private async uploadToProjectUpload(fileName: string, filePath: string): Promise<any> {
     const uploadUrl = `${this.baseApiPath}/projects/${encodeURIComponent(this.projectId)}/uploads`
     const parsedUrl = new URL(uploadUrl)
 
     // Check file size to determine upload method
-    const stats = await stat(_filePath)
+    const stats = await stat(filePath)
     const fileSize = stats.size
     const STREAMING_THRESHOLD = 50 * 1024 * 1024 // 50MB
 
     const form = new FormData()
     if (fileSize > STREAMING_THRESHOLD) {
       // Use streaming for large files
       log.debug({ fileName, fileSize }, "using streaming upload for large file")
-      const fileStream = createReadStream(_filePath)
+      const fileStream = createReadStream(filePath)
       form.append("file", fileStream, fileName)
     } else {
       // Use buffer for small files
       log.debug({ fileName, fileSize }, "using buffer upload for small file")
-      const fileContent = await readFile(_filePath)
+      const fileContent = await readFile(filePath)
       form.append("file", fileContent, fileName)
     }
 
@@ -267,12 +259,7 @@ export class GitlabPublisher extends HttpPublisher {
     return JSON.parse(response)
   }
 
-  private async uploadToGenericPackages(
-    fileName: string,
-    dataLength: number,
-    requestProcessor: (request: ClientRequest, reject: (error: Error) => void) => void,
-    _filePath: string
-  ): Promise<any> {
+  private async uploadToGenericPackages(fileName: string, dataLength: number, requestProcessor: RequestProcessor): Promise<any> {
     const uploadUrl = `${this.baseApiPath}/projects/${encodeURIComponent(this.projectId)}/packages/generic/releases/${this.version}/${fileName}`
     const parsedUrl = new URL(uploadUrl)
 
@@ -294,6 +281,10 @@ export class GitlabPublisher extends HttpPublisher {
     )
   }
 
+  private buildProjectUrl(path: string = ""): URL {
+    return new URL(`${this.baseApiPath}/projects/${encodeURIComponent(this.projectId)}${path}`)
+  }
+
   private resolveProjectId(): string {
     if (this.info.projectId) {
       return String(this.info.projectId)

packages/electron-updater/src/providers/GitLabProvider.ts

@@ -186,7 +186,7 @@ export class GitLabProvider extends Provider<GitlabUpdateInfo> {
     return null
   }
 
-  private async getReleaseInfoByVersion(version: string): Promise<GitlabReleaseInfo | null> {
+  private async fetchReleaseInfoByVersion(version: string): Promise<GitlabReleaseInfo | null> {
     const cancellationToken = new CancellationToken()
 
     // Try v-prefixed version first, then fallback to plain version
@@ -230,7 +230,7 @@ export class GitLabProvider extends Provider<GitlabUpdateInfo> {
     }
 
     // Fetch version info if not cached or version doesn't match
-    const versionInfo = await this.getReleaseInfoByVersion(version)
+    const versionInfo = await this.fetchReleaseInfoByVersion(version)
     if (versionInfo && versionInfo.assets) {
       return this.convertAssetsToMap(versionInfo.assets)
     }
@@ -262,8 +262,8 @@ export class GitLabProvider extends Provider<GitlabUpdateInfo> {
   }
 
   async getBlockMapFiles(baseUrl: URL, oldVersion: string, newVersion: string, oldBlockMapFileBaseUrl: string | null = null): Promise<URL[]> {
-    // If is `project_upload`, find blockmap files in GitLab assets
-    // As each asset has a unique path that includes an identified hash code,
+    // If is `project_upload`, find blockmap files from corresponding gitLab assets
+    // Because each asset has an unique path that includes an identified hash code,
     // e.g. https://gitlab.com/-/project/71361100/uploads/051f27a925eaf679f2ad688105362acc/latest.yml
     if (this.options.uploadTarget === "project_upload") {
       // Get the base filename from the URL to find corresponding blockmap files