@jira-deploy/core 1.0.15 → 1.0.17

package/tools/branch-prs.js

@@ -0,0 +1,164 @@
+import {
+  MODULE_TO_REPO_MAP,
+  REPO_MAPS,
+  SYSTEM_TO_CI_REPO_MAP,
+} from '../constants/index.js';
+import { error, ok } from './helpers.js';
+
+const SUPPORTED_TICKET_TYPES = ['library', 'grayrelease', 'ci'];
+
+export function getBranchPRToolDefinitions() {
+  return [
+    {
+      name: 'validate_branch_no_open_pr',
+      description:
+        '檢查開 Library、GrayRelease 或 CI 單前，對應 Bitbucket branch 是否有尚未 merge 的 OPEN pull request。Library/GrayRelease 使用輸入 branch；CI 固定檢查 master。CD 與 Deployment 不需要使用。',
+      inputSchema: {
+        type: 'object',
+        required: ['ticketType', 'systemCode'],
+        properties: {
+          ticketType: {
+            type: 'string',
+            enum: SUPPORTED_TICKET_TYPES,
+            description: '要檢查的開單類型：library / grayrelease / ci。',
+          },
+          systemCode: {
+            type: 'string',
+            description: '系統代碼，例如 IBK、CWA。CI 會用 systemCode 找 Golden Image repo。',
+          },
+          module: {
+            type: 'string',
+            description: 'Library 或 GrayRelease 模組名稱，例如 ssr、cwa。CI 不需要。',
+          },
+          branch: {
+            type: 'string',
+            description: 'Library / GrayRelease 要檢查的 Git branch。CI 會忽略此值並固定檢查 master。',
+          },
+        },
+      },
+    },
+  ];
+}
+
+export async function handleValidateBranchNoOpenPR(args, { jira }) {
+  try {
+    const result = await validateBranchNoOpenPR(args, { jira });
+    return ok(result);
+  } catch (err) {
+    return error(`validate_branch_no_open_pr 失敗: ${err.message}`);
+  }
+}
+
+export async function assertNoOpenPRBeforeCreate(args, { jira }) {
+  const result = await validateBranchNoOpenPR(args, { jira });
+  if (result.blocked) {
+    throw new Error(formatOpenPRBlockMessage(result));
+  }
+  return result;
+}
+
+export async function validateBranchNoOpenPR(args, { jira }) {
+  const target = resolveBranchPRCheckTarget(args);
+  const pullRequests = await jira.getBitbucketPullRequests(target.project, target.repo, {
+    branch: target.branch,
+    state: 'OPEN',
+    limit: 100,
+  });
+  const openPullRequests = normalizePullRequests(pullRequests, target.branch);
+
+  return {
+    ok: openPullRequests.length === 0,
+    blocked: openPullRequests.length > 0,
+    reason: openPullRequests.length > 0 ? 'branch_has_open_pull_requests' : null,
+    ticketType: target.ticketType,
+    systemCode: target.systemCode,
+    module: target.module,
+    repo: target.repo,
+    project: target.project,
+    branch: target.branch,
+    openPullRequests,
+    message: openPullRequests.length > 0
+      ? `${target.branch} 仍有尚未 merge 的 PR，請先完成 merge 後再開單。`
+      : `${target.branch} 沒有尚未 merge 的 OPEN PR，可繼續開單。`,
+  };
+}
+
+export function resolveBranchPRCheckTarget(args) {
+  const ticketType = String(args.ticketType ?? '').trim().toLowerCase();
+  const systemCode = String(args.systemCode ?? '').trim().toUpperCase();
+  const module = String(args.module ?? '').trim().toLowerCase();
+  const branch = ticketType === 'ci'
+    ? 'master'
+    : String(args.branch ?? args.gitBranch ?? '').trim();
+
+  if (!SUPPORTED_TICKET_TYPES.includes(ticketType)) {
+    throw new Error(`不支援的 PR 檢查類型：${args.ticketType}，僅支援 ${SUPPORTED_TICKET_TYPES.join(' / ')}`);
+  }
+  if (!systemCode) {
+    throw new Error('缺少 systemCode');
+  }
+  if (ticketType !== 'ci' && !module) {
+    throw new Error(`${ticketType} PR 檢查缺少 module`);
+  }
+  if (!branch) {
+    throw new Error(`${ticketType} PR 檢查缺少 branch`);
+  }
+
+  const repo = ticketType === 'ci'
+    ? SYSTEM_TO_CI_REPO_MAP[systemCode]
+    : MODULE_TO_REPO_MAP[module];
+  if (!repo) {
+    throw new Error(ticketType === 'ci'
+      ? `找不到系統 "${systemCode}" 的 CI repo 對應，請確認 SYSTEM_TO_CI_REPO_MAP`
+      : `找不到模組 "${module}" 的 repo 對應，請確認 MODULE_TO_REPO_MAP`);
+  }
+
+  const repoMeta = REPO_MAPS[repo];
+  if (!repoMeta?.project) {
+    throw new Error(`找不到 repo "${repo}" 的 Bitbucket 設定`);
+  }
+
+  return {
+    ticketType,
+    systemCode,
+    module: module || null,
+    repo,
+    project: repoMeta.project,
+    branch,
+  };
+}
+
+function normalizePullRequests(pullRequests, branch) {
+  return (pullRequests ?? [])
+    .filter((pr) => isOpenPullRequestFromBranch(pr, branch))
+    .map((pr) => ({
+      id: pr.id,
+      title: pr.title ?? '',
+      state: pr.state ?? '',
+      fromRef: pr.fromRef?.displayId ?? normalizeRefId(pr.fromRef?.id),
+      toRef: pr.toRef?.displayId ?? normalizeRefId(pr.toRef?.id),
+      author: pr.author?.user?.displayName ?? pr.author?.user?.name ?? '',
+      url: pr.links?.self?.[0]?.href ?? pr.link?.url ?? '',
+    }));
+}
+
+function isOpenPullRequestFromBranch(pr, branch) {
+  if (String(pr.state ?? '').toUpperCase() !== 'OPEN') {
+    return false;
+  }
+  const expectedRef = `refs/heads/${branch}`;
+  return pr.fromRef?.displayId === branch
+    || pr.fromRef?.id === expectedRef
+    || normalizeRefId(pr.fromRef?.id) === branch;
+}
+
+function normalizeRefId(refId) {
+  return String(refId ?? '').replace(/^refs\/heads\//, '');
+}
+
+function formatOpenPRBlockMessage(result) {
+  const prLines = result.openPullRequests
+    .map((pr) => `#${pr.id} ${pr.title}${pr.url ? ` ${pr.url}` : ''}`)
+    .join('; ');
+  return `${result.branch} 仍有尚未 merge 的 PR，請先完成 merge 後再開單。${prLines ? ` (${prLines})` : ''}`;
+}

package/tools/build.js

@@ -0,0 +1,117 @@
+/**
+ * Build 相關共用 tools
+ *   - wait_build_result
+ */
+import { SHARED_FIELD_IDS } from '../constants/index.js';
+import {
+  error,
+  getPollIntervalMs,
+  getPollTimeoutMs,
+  isFailingResult,
+  isPassingResult,
+  ok,
+} from './helpers.js';
+
+function progress(ctx, event) {
+  if (typeof ctx.progress === 'function') {
+    ctx.progress(event);
+  }
+}
+
+// ── Schema definitions ───────────────────────────────────────────
+export function getBuildToolDefinitions() {
+  return [
+    {
+      name: 'wait_build_result',
+      description:
+        '輪詢等待 Jira issue 的共用 Build 結果欄位變成 pass 或 fail。支援 CI、Library、GrayRelease；通常接在 build_ci、build_library 或 build_grayrelease 成功觸發 Jenkins build 後使用。',
+      inputSchema: {
+        type: 'object',
+        required: ['issueKey'],
+        properties: {
+          issueKey: {
+            type: 'string',
+            description: '要等待 build 結果的 issue key，例如 CI、Library 或 GrayRelease 單 CID-822',
+          },
+          resultFieldId: {
+            type: 'string',
+            description: '(選填) Build 結果欄位 ID，預設 customfield_13432',
+            default: SHARED_FIELD_IDS.buildResult,
+          },
+          pollIntervalMs: {
+            type: 'number',
+            description: '輪詢間隔毫秒，預設讀 POLL_INTERVAL_MS',
+          },
+          timeoutMs: {
+            type: 'number',
+            description: '最長等待毫秒，預設讀 POLL_TIMEOUT_MS',
+          },
+        },
+      },
+    },
+  ];
+}
+
+// ── Handlers ─────────────────────────────────────────────────────
+export async function handleWaitBuildResult(args, ctx) {
+  const { issueKey } = args;
+  const { jira } = ctx;
+  const fieldId = args.resultFieldId ?? SHARED_FIELD_IDS.buildResult;
+  const intervalMs = args.pollIntervalMs ?? getPollIntervalMs();
+  const timeoutMs = args.timeoutMs ?? getPollTimeoutMs();
+  const startedAt = Date.now();
+  const deadline = Date.now() + timeoutMs;
+  let attempts = 0;
+  let lastValue;
+  let currentStatus;
+
+  try {
+    while (true) {
+      attempts++;
+      const issue = await jira.getIssue(issueKey);
+      currentStatus = issue.fields.status?.name;
+      const fields = await jira.getIssueFields(issueKey, [fieldId]);
+      const raw = fields[fieldId];
+      lastValue = raw?.value ?? raw;
+
+      progress(ctx, {
+        phase: 'polling',
+        title: '等待 Build 結果',
+        detail: `${fieldId}: ${lastValue ?? 'empty'}`,
+        issueKey,
+        currentStatus,
+        attempts,
+        elapsedMs: Date.now() - startedAt,
+        timeoutMs,
+        nextPollMs: intervalMs,
+      });
+
+      if (isPassingResult(lastValue)) {
+        return ok({
+          issueKey,
+          fieldId,
+          result: lastValue,
+          buildResult: lastValue,
+          currentStatus,
+          attempts,
+        });
+      }
+
+      if (isFailingResult(lastValue)) {
+        return error(`Build 失敗，${fieldId}: ${lastValue}`);
+      }
+
+      if (Date.now() >= deadline) {
+        return error(`Build 結果等待逾時，${fieldId}: ${lastValue ?? 'empty'}`);
+      }
+
+      await sleep(intervalMs);
+    }
+  } catch (err) {
+    return error(`wait_build_result 失敗: ${err.message}`);
+  }
+}
+
+function sleep(ms) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}