@iki-inc/test-registry 1.0.10 → 1.0.18

package/scripts/closeIssues/index.ts

@@ -0,0 +1,23 @@
+import CloseIssuesOperation from "./modules/closeIssuesOperation";
+
+const operation = new CloseIssuesOperation()
+
+if (!operation.isMergeRequest) {
+  console.log('⚠️ Not a merge request. Skip closing issues.')
+  process.exit(0)
+}
+
+operation.execute()
+  .then((result) => {
+    const error = result.find(r => r.status === 'error')
+    if (error) {
+      console.error('😭 Failed to close issues.')
+      process.exit(1)
+    }
+
+    console.log('👏 Issues closed successfully.')
+  })
+  .catch((error) => {
+    console.error('💥 Fatal error', error)
+    process.exit(1)
+  })

package/scripts/closeIssues/modules/closeIssuesOperation.ts

@@ -0,0 +1,167 @@
+import type { Camelize, ExpandedMergeRequestSchema } from '@gitbeaker/rest'
+import GitLabApi from '../../modules/gitlabApi'
+
+type TargetIssue = {
+  keyword: string
+  id: number
+}
+
+type OperationResultError = {id: string; status: 'error'; message: string}
+type OperationResult = {id: string; status: 'closed' | 'skipped'} | OperationResultError
+
+export default class CloseIssuesOperation extends GitLabApi {
+  // マージリクエストのID
+  readonly #mergeRequestIid = NaN
+
+
+  constructor() {
+    super()
+    this.#mergeRequestIid = this.getMergeRequestIidFromCommitMessage(process.env.CI_COMMIT_MESSAGE ?? '')
+  }
+
+  /** マージリクエストが存在するか */
+  get isMergeRequest(): boolean {
+    return !isNaN(this.#mergeRequestIid)
+  }
+
+  /**
+   * マージリクエストに紐づくイシューをクローズする
+   */
+  public async execute() {
+    const mr = await this.api.MergeRequests.show(this.projectId, this.#mergeRequestIid)
+
+    const issues = this.#getIssues(mr)
+    const result = await this.#closeIssues(issues)
+
+    this.#printSummary(issues, result)
+
+    return result
+  }
+
+  /**
+   * マージリクエストの説明文からクローズ対象のイシューIDリストを取得する
+   * @param mr
+   * @private
+   */
+  #getIssues(mr: ExpandedMergeRequestSchema | Camelize<ExpandedMergeRequestSchema>) {
+    const issues = Array.from([...mr.description?.matchAll(this.closeIssuesRegex) ?? '']
+      .map((match) => {
+        if (typeof match === 'string') {
+          return {
+            keyword: 'fixes',
+            id: NaN
+          }
+        }
+
+        return {
+          keyword: match.groups?.keyword ?? 'fixes',
+          id: Number(match.groups?.number)
+        }
+      })
+      .filter(({ id }) => !isNaN(id))
+      .reduce((map, issue) => {
+        // イシューIDの重複排除
+        map.set(issue.id, issue)
+        return map
+      }, new Map<number, TargetIssue>())
+      .values())
+
+    return issues
+  }
+
+  async #closeIssues(issues: TargetIssue[]) {
+    if (Array.from(issues).length === 0) return []
+
+    const result: OperationResult[] = []
+
+    for (const issue of issues) {
+      try {
+        const targetIssue = await this.api.Issues.show(issue.id, {
+          projectId: this.projectId
+        })
+
+        if (targetIssue.state === 'closed') {
+          result.push({
+            id: `#${issue.id}`,
+            status: 'skipped'
+          })
+          continue
+        }
+
+        if (targetIssue.state === 'opened') {
+          await this.api.Issues.edit(this.projectId, issue.id, {
+            stateEvent: 'close',
+          })
+
+          result.push({
+            id: `#${issue.id}`,
+            status: 'closed'
+          })
+        }
+      } catch (error) {
+        result.push({
+          id: `#${issue.id}`,
+          status: 'error',
+          message: (error as Error).message
+        })
+      }
+    }
+
+    return result
+  }
+
+  /**
+   * 処理結果のログ出力
+   * @param issues
+   * @param result
+   * @private
+   */
+  #printSummary(issues: TargetIssue[], result: OperationResult[]) {
+    console.log('📊 Summary')
+
+    console.log(`\nMerge Request IID: !${this.#mergeRequestIid}`)
+
+    // ターゲットリスト
+    const targetIssues = Array.from(issues, (issue) => `#${issue.id}`)
+    const targetLength = targetIssues.length
+
+    console.log(`\nTarget issues: ${targetLength}件`)
+    if (targetIssues.length > 0) {
+      console.log(`${targetIssues.join(', ')}`)
+    } else {
+      // 0件なら終了
+      return
+    }
+
+    console.log('\n')
+
+    const closed = result.filter(({ status }) => status === 'closed')
+    this.#printResultData('✅ Closed issues:', closed)
+
+    const skipped = result.filter(({ status }) => status === 'skipped')
+    this.#printResultData('⏭️ Skipped issues:', skipped)
+
+    const errors = result.filter(({ status }) => status === 'error')
+    this.#printResultData('❌ Error issues:', errors, true)
+  }
+
+  /**
+   * 処理結果の詳細ログ
+   * @param label
+   * @param result
+   * @param isError
+   * @private
+   */
+  #printResultData(label: string, result: OperationResult[], isError = false) {
+    console.log(`${label} ${result.length}件`)
+
+    for (const res of result) {
+      console.log(`  - ${res.id}`)
+
+      if (isError) {
+        console.log(`    Error: ${(res as OperationResultError).message}`)
+      }
+    }
+  }
+
+}

package/scripts/modules/gitlabApi.ts

@@ -0,0 +1,49 @@
+import { Gitlab } from '@gitbeaker/rest'
+
+export default class GitLabApi {
+  protected readonly api: InstanceType<typeof Gitlab>
+  protected readonly projectId: number
+
+  constructor() {
+    this.api = new Gitlab({
+      host: `https://${process.env.CI_SERVER_HOST ?? 'gitlab.com'}`,
+      token: process.env.CI_API_TOKEN,
+    })
+
+    this.projectId = Number(process.env.CI_PROJECT_ID)
+  }
+
+  /** MRからクローズ対象のイシューIDを抽出するための正規表現 */
+  protected get closeIssuesRegex() {
+    return /(?<keyword>fix(?:es)?|closes?|resolves?)\s*#(?<number>\d+)/gi
+  }
+
+  /**
+   * コミットメッセージからマージリクエストのIIDを抽出する
+   * @param commitMessage
+   * @protected
+   */
+  protected getMergeRequestIidFromCommitMessage(commitMessage: string): number {
+    // 検索したいコミットメッセージの正規表現パターン
+    const searchRegExpPattern = [
+      // パターン1："See merge request project/repo!123"
+      /See merge request [^\s!]+!(?<iid>\d+)/i,
+      // パターン2："See merge request !123"
+      /See merge request !(?<iid>\d+)/i,
+      // パターン3："Closes !123" または "Merge !123"
+      /(?:closes?|merges?|see)\s+!(?<iid>\d+)/i,
+      // パターン4："https://gitlab.com/project/repo/-/merge_requests/123"
+      /https?:\/\/[^\s\/]+\/[^\s\/]+\/[^\s\/]+\/-\/merge_requests\/(?<iid>\d+)/i,
+    ]
+
+    for (const pattern of searchRegExpPattern) {
+      const match = commitMessage.match(pattern)
+      if (match && match.groups?.iid) {
+        return Number(match.groups.iid)
+      }
+    }
+
+    // マッチしなかった場合
+    return NaN
+  }
+}

package/scripts/modules/utils.ts

@@ -0,0 +1,5 @@
+/**
+ * 型ガード関数でstring型かどうかをチェック
+ * @param value
+ */
+export const isString = (value: unknown): value is string => typeof value === 'string'

package/scripts/releaseNote/index.ts

@@ -0,0 +1,19 @@
+import releaseNoteGenerator from './modules/releaseNoteGenerator'
+
+const generator = new releaseNoteGenerator()
+
+if (!generator.isReleaseTag) {
+  console.log('⚠️ Not a release tag. Skip generating release notes.')
+  process.exit(0)
+}
+
+generator.execute()
+  .then((body: string) => {
+    console.log(body)
+    console.log('👏 Release notes generated successfully.')
+  })
+  .catch((error) => {
+    console.error('💥 Fatal error', error)
+    process.exit(1)
+  })
+

package/scripts/releaseNote/modules/releaseNoteGenerator.ts

@@ -0,0 +1,231 @@
+import GitLabApi from '../../modules/gitlabApi'
+import type { ExpandedMergeRequestSchema, SimpleLabelSchema } from '@gitbeaker/rest'
+import { writeFile } from 'node:fs/promises'
+import { isString } from '../../modules/utils'
+
+interface ScopedMergeRequest {
+  scope: string
+  title: string
+  webUrl: string
+  iid: number
+}
+
+// 最古のコミットを指す定数
+const OLDEST_COMMIT_REF = 'HEAD~9999'
+
+export default class ReleaseNoteGenerator extends GitLabApi {
+  readonly #currentTag: string;
+
+  constructor() {
+    super()
+
+    this.#currentTag = process.env.CI_COMMIT_TAG ?? ''
+  }
+
+  /** リリースタグが存在している */
+  get isReleaseTag() {
+    return this.#currentTag !== ''
+  }
+
+  /** リリースノート作成！ */
+  public async execute() {
+    const previousTag = await this.#getPreviousTag()
+    console.log({ previousTag, currentTag: this.#currentTag })
+
+    const mergeRequest = await this.#getMergeRequestsBetweenTags(previousTag, this.#currentTag)
+    const scopedMergeRequests = this.#categorizeMergeRequestsByScope(mergeRequest)
+
+    const releaseNoteBody = this.#generateReleaseNoteBody(scopedMergeRequests)
+
+    // flag: 'a' だと末尾に追記する。先頭に追記したい場合は既存のドキュメントを読み込んで結合する必要がある
+    await writeFile('release_notes.md', releaseNoteBody, { encoding: 'utf8', flag: 'w' })
+
+    return releaseNoteBody
+  }
+
+  /**
+   * 前のリリースタグを取得
+   * @private
+   */
+  async #getPreviousTag(): Promise<string> {
+    const tags = await this.api.Tags.all(this.projectId, {
+      orderBy: 'updated',
+      sort: 'desc',
+      perPage: 100
+    })
+
+    const currentTagIndex = tags.findIndex((tag) => tag.name === this.#currentTag)
+
+    if (currentTagIndex === -1) {
+      throw new Error(`Current tag ${this.#currentTag} not found`)
+    }
+
+    if (currentTagIndex === tags.length - 1) {
+      // 最初のタグの場合は、リポジトリの最初のコミットから
+      return OLDEST_COMMIT_REF
+    }
+
+    return tags[currentTagIndex + 1].name
+  }
+
+  /**
+   * 指定された2つのタグ間のマージリクエストを取得
+   * @param fromTag
+   * @param toTag
+   */
+  async #getMergeRequestsBetweenTags(fromTag: string, toTag: string): Promise<ExpandedMergeRequestSchema[]> {
+    const fromTagInfo = await this.#getTagInfo(fromTag)
+
+    const createdAt = fromTagInfo?.commit.created_at
+    const since = createdAt && isString(createdAt) ? createdAt : undefined
+
+    const commits = await this.api.Commits.all(this.projectId, {
+      refName: toTag,
+      since
+    })
+
+    // マージコミットからコミットリクエストを特定
+    const mergeRequestIids = new Set<number>()
+
+    // デフォルトブランチへのマージコミットを判定する正規表現
+    const defaultBranchMergeRegExp = new RegExp(`^Merge branch.*into\\s+'?${process.env.CI_DEFAULT_BRANCH}'?`, 'i')
+
+    for (const commit of commits) {
+      // デフォルトブランチへのマージコミットは対象外
+      if (commit.title.match(defaultBranchMergeRegExp)) continue
+
+      const iid = this.getMergeRequestIidFromCommitMessage(commit.message)
+      if (!isNaN(iid)) {
+        mergeRequestIids.add(iid)
+      }
+    }
+
+    const promises = Array.from(mergeRequestIids).map((iid) => this.api.MergeRequests.show(this.projectId, iid))
+    const results = await Promise.allSettled(promises)
+
+    return results
+      .filter((result): result is PromiseFulfilledResult<ExpandedMergeRequestSchema> => {
+        if (result.status === 'rejected') {
+          // マージリクエストIIDを取得するために、元の配列のインデックスを使用
+          const iid = Array.from(mergeRequestIids)[results.indexOf(result)]
+          console.warn(`⚠️ Could not fetch MR !${iid}:`, result.reason?.message || result.reason)
+          return false
+        }
+
+        return true
+      })
+      .map((result) => result.value)
+  }
+
+  /**
+   * タグの情報を取得
+   * @param tag
+   * @private
+   */
+  async #getTagInfo(tag: string) {
+    if (tag === OLDEST_COMMIT_REF) return undefined
+
+    return await this.api.Tags.show(this.projectId, tag)
+  }
+
+  /**
+   * マージリクエストをスコープごとに分類
+   * @param mergeRequests
+   * @private
+   */
+  #categorizeMergeRequestsByScope(mergeRequests: ExpandedMergeRequestSchema[]): Map<string, ScopedMergeRequest[]> {
+    const scopedMrs = new Map<string, ScopedMergeRequest[]>()
+
+    for (const mr of mergeRequests) {
+      const scope = this.#extractScopesFromLabels(this.#getLabelNames(mr.labels ?? []))
+      if (scope == null) continue
+
+      const scopedMr: ScopedMergeRequest = {
+        scope,
+        title: mr.title,
+        webUrl: mr.web_url,
+        iid: mr.iid
+      }
+
+      if (!scopedMrs.has(scope)) {
+        scopedMrs.set(scope, [])
+      }
+      scopedMrs.get(scope)!.push(scopedMr)
+    }
+
+    return scopedMrs
+  }
+
+  /**
+   * ラベル名を配列で取得
+   * @param labels
+   * @private
+   */
+  #getLabelNames(labels: string[] | SimpleLabelSchema[]): string[] {
+    if (labels.length === 0) return []
+
+    // GitLab APIのレスポンスは一貫しているので方が混在することはないため最初の型をチェックしてstring[]になるようにする
+    return typeof labels.at(0) === 'string'
+      ? labels as string[]
+      : (labels as SimpleLabelSchema[]).map(label => label.name)
+  }
+
+  /**
+   * ラベルからリリースノート用のラベルを抽出
+   * リリース用のラベルはスコープドなので必ず一つだけしか存在しない
+   * @param labels
+   * @private
+   */
+  #extractScopesFromLabels(labels: string[]): string | null {
+    const scopes = labels
+      .filter((label) => label.startsWith('log::'))
+      .map((label) => label.replace('log::', ''))
+
+    return scopes.at(0) ?? null
+  }
+
+  /**
+   * リリースノートの本文を生成
+   * @param scopedMRs
+   * @private
+   */
+  #generateReleaseNoteBody(scopedMRs: Map<string, ScopedMergeRequest[]>): string {
+    const header = `# ${this.#currentTag}`
+
+    if (scopedMRs.size === 0) {
+      return [
+        header,
+        '',
+        'No changes.'
+      ].join('\n')
+    }
+
+    const sortedScopes = Array.from(scopedMRs.keys()).sort()
+
+    const scopeSections: string[] = []
+
+    for (const scope of sortedScopes) {
+      const mrs = scopedMRs.get(scope)!
+      const sectionHeader = `## ${scope.charAt(0).toUpperCase() + scope.slice(1)}`
+
+      const mrList: string[] = []
+      for (const mr of mrs) {
+        mrList.push(`- ${mr.title} ([!${mr.iid}](${mr.webUrl}))`)
+      }
+
+      scopeSections.push([
+        '',
+        sectionHeader,
+        ...mrList,
+      ]
+        .join('\n'))
+    }
+
+    return [
+      header,
+      ...scopeSections,
+      '',
+      ''
+    ].join('\n')
+  }
+}

package/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "files": [],
+  "references": [{ "path": "./tsconfig.node.json" }]
+}

package/tsconfig.node.json

@@ -0,0 +1,29 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "lib": ["ES2022"],
+    "module": "ES2022",
+    "skipLibCheck": true,
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": false,
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "moduleDetection": "force",
+    "noEmit": true,
+    "types": ["node"],
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedSideEffectImports": true,
+    "verbatimModuleSyntax": true,
+    "stripInternal": true,
+    "erasableSyntaxOnly": true
+  },
+  "include": ["types/**/*", "scripts/**/*"],
+  "exclude": ["node_modules"]
+}

package/types/env.d.ts

@@ -0,0 +1,10 @@
+interface ProcessEnv {
+  CI_API_TOKEN: string;
+  CI_SERVER_HOST: string;
+  CI_PROJECT_ID: string;
+  CI_COMMIT_MESSAGE?: string;
+
+  // リリースノート
+  CI_COMMIT_TAG?: string;
+  CI_DEFAULT_BRANCH: string
+}

package/types/reset.d.ts

@@ -0,0 +1 @@
+import '@total-typescript/ts-reset'