From 398b25a76b2737aecb51f6857733c1f764186331 Mon Sep 17 00:00:00 2001
From: wuhuizuo <wuhuizuo@126.com>
Date: Tue, 24 Dec 2024 03:12:39 +0000
Subject: [PATCH] feat(packages/scripts): add get-delivery-target-images.ts

Use it to get the target images for delivery, we
can use it to check if the deliveries are ready.

Usage:
```bash
./packages/scripts/get-delivery-target-images.ts \
    --config <url-or-filepath-of-delivery-yaml> \
    --version <vX.Y.Z> \
    --registry <the-source-registry-where-the-images-copied-from> \
    --save_to <path-to-save-the-result-yaml>
```

Signed-off-by: wuhuizuo <wuhuizuo@126.com>
---
 .../scripts/get-delivery-target-images.ts     | 155 ++++++++++++++++++
 1 file changed, 155 insertions(+)
 create mode 100755 packages/scripts/get-delivery-target-images.ts

diff --git a/packages/scripts/get-delivery-target-images.ts b/packages/scripts/get-delivery-target-images.ts
new file mode 100755
index 00000000..7cd9a36e
--- /dev/null
+++ b/packages/scripts/get-delivery-target-images.ts
@@ -0,0 +1,155 @@
+#!/usr/bin/env -S deno run --allow-read --allow-write --allow-net
+import * as yaml from "jsr:@std/yaml@1.0.5";
+import { parseArgs } from "jsr:@std/cli@1.0.9";
+import { retryAsync } from "https://deno.land/x/retry@v2.0.0/mod.ts";
+import {
+  parse,
+  parseRange,
+  satisfies,
+} from "jsr:@std/semver@^1.0.3";
+
+interface Rule {
+  description?: string;
+  tags_regex: string[];
+  dest_repositories: string[];
+  constant_tags?: string[];
+  tag_regex_replace?: string;
+}
+
+interface Config {
+  [sourceRepo: string]: Rule[];
+}
+
+function srcImages(
+  version: string,
+  registry: string,
+) {
+  const images = [
+    "pingcap/tidb/images/br",
+    "pingcap/tidb/images/dumpling",
+    "pingcap/tidb/images/tidb-lightning",
+    "pingcap/tidb/images/tidb-server",
+    "pingcap/monitoring/image",
+    "pingcap/ng-monitoring/image",
+    "pingcap/tidb-dashboard/image",
+    "pingcap/tiflash/image",
+    "pingcap/tiflow/images/cdc",
+    "pingcap/tiflow/images/dm",
+    "pingcap/tiflow/images/tiflow",
+    "tikv/pd/image",
+    "tikv/tikv/image",
+  ];
+
+  // "tidb-binlog" repo stops to release since 8.4.0, but the history release branches is still there and keep releasing patches.
+  const binlogAliveRange = parseRange("<8.4.0-0");
+  if (satisfies(parse(version), binlogAliveRange)) {
+    images.push("pingcap/tidb-binlog/image");
+  }
+
+  // "ticdc" repo will release from from 9.0.0, it's a new repo for new CDC component.
+  const ticdcStartedRange = parseRange(">=9.0.0-0");
+  if (!satisfies(parse(version), ticdcStartedRange)) {
+    images.push("pingcap/ticdc/image");
+  }
+
+  const enterpriseImages = [
+    "pingcap/tidb/images/br",
+    "pingcap/tidb/images/dumpling",
+    "pingcap/tidb/images/tidb-lightning",
+    "pingcap/tidb/images/tidb-server",
+    "pingcap/tiflash/image",
+    "tikv/pd/image",
+    "tikv/tikv/image",
+  ];
+
+  const ret: string[] = [];
+  for (const img of images) {
+    ret.push(`${registry}/${img}:${version}`);
+  }
+  for (const img of enterpriseImages) {
+    ret.push(`${registry}/${img}:${version}-enterprise`);
+  }
+
+  return ret;
+}
+
+function getDeliveryTargetImages(imageUrlWithTag: string, config: Config) {
+  const [imageUrl, tag] = imageUrlWithTag.split(":");
+  const ret: string[] = [];
+
+  // Retrieve rules for the source repository from the YAML config
+  (config[imageUrl] || [])
+    .filter((r) => r.tags_regex.some((regex) => new RegExp(regex).test(tag)))
+    .forEach((rule) => {
+      const {
+        dest_repositories,
+        constant_tags = [],
+        tag_regex_replace = "",
+        tags_regex = [],
+      } = rule;
+
+      for (const destRepo of dest_repositories) {
+        ret.push(`${destRepo}:${tag}`);
+        for (const constTag of constant_tags) {
+          ret.push(`${destRepo}:${constTag}`);
+        }
+        if (tag_regex_replace != "") {
+          const converted = tag.replace(
+            new RegExp(tags_regex[0]),
+            tag_regex_replace,
+          );
+          ret.push(`${destRepo}:${converted}`);
+        }
+      }
+    });
+
+  return ret;
+}
+
+async function main(
+  version: string,
+  registry: string,
+  configFileOrUrl: string,
+  outFile: string,
+) {
+  // Read delivery config
+  let yamlContent: string;
+  // if yamlFile is a url format, fetch it.
+  if (configFileOrUrl.startsWith("http")) {
+    const url = new URL(configFileOrUrl);
+    const response = await retryAsync(
+      async () => await fetch(url),
+      { delay: 1000, maxTry: 5 },
+    );
+    const text = await response.text();
+    yamlContent = text;
+  } else {
+    yamlContent = await Deno.readTextFile(configFileOrUrl);
+  }
+
+  const config = yaml.parse(yamlContent) as { image_copy_rules: Config };
+  const dstImages = srcImages(version, registry).map((srcImage) =>
+    getDeliveryTargetImages(srcImage, config.image_copy_rules)
+  ).flat();
+
+  // Save results.
+  const contentStr = yaml.stringify(dstImages);
+  await Deno.writeTextFile(outFile, contentStr, {
+    create: true,
+    append: false,
+  });
+  console.info("✅ target image urls are saved in ", outFile);
+}
+
+// Parse command-line arguments
+const {
+  version,
+  registry = "hub.pingcap.net",
+  config = "./packages/delivery.yaml",
+  save_to = "./delivery-target-images.yaml",
+} = parseArgs(Deno.args);
+
+// Example usage
+// ./get-delivery-target-images.ts --config=../delivery.yaml --version=v8.5.0
+await main(version, registry, config, save_to);
+Deno.exit(0);