esa-cli 0.0.2-beta.0 → 0.0.2-beta.10

package/dist/utils/download.js

@@ -0,0 +1,182 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import fetch from 'node-fetch';
+import * as fs from 'fs/promises';
+import * as path from 'path';
+import os from 'os';
+import AdmZip from 'adm-zip';
+import { exec } from 'child_process';
+import { promisify } from 'util';
+import t from '../i18n/index.js';
+import logger from '../libs/logger.js';
+import chalk from 'chalk';
+const execAsync = promisify(exec);
+function getBinDir() {
+    const home = os.homedir();
+    return path.join(home || '', '.deno', 'bin');
+}
+/**
+ * 下载文件
+ * @param url 远程文件URL
+ * @param dest 本地保存路径
+ */
+export function downloadFile(url, dest) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield fetch(url);
+        if (!response.ok) {
+            throw new Error(`Error downloading file: ${response.status} ${response.statusText}`);
+        }
+        const fileStream = yield fs.open(dest, 'w');
+        return new Promise((resolve, reject) => {
+            var _a, _b;
+            (_a = response.body) === null || _a === void 0 ? void 0 : _a.pipe(fileStream.createWriteStream());
+            (_b = response.body) === null || _b === void 0 ? void 0 : _b.on('error', (err) => {
+                fileStream.close();
+                reject(err);
+            });
+            fileStream.createWriteStream().on('finish', () => {
+                fileStream.close();
+                resolve();
+            });
+        });
+    });
+}
+/**
+ * 解压Zip文件 adm 是同步的
+ * @param zipPath Zip文件路径
+ * @param extractPath 解压目标目录
+ */
+export function unzipFile(zipPath, extractPath) {
+    const zip = new AdmZip(zipPath);
+    zip.extractAllTo(extractPath, true);
+    logger.info(`UnzipFile success: from ${zipPath} to ${extractPath}`);
+}
+/**
+ * 获取用户的 PATH 环境变量（win下专用）
+ * @returns 用户 PATH
+ */
+function getUserPath() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { stdout } = yield execAsync('reg query "HKCU\\Environment" /v Path');
+        const match = stdout.match(/Path\s+REG_EXPAND_SZ\s+(.*)/i);
+        if (match && match[1]) {
+            return match[1].trim();
+        }
+        return '';
+    });
+}
+/**
+ * 检查 BinDir 是否在用户的 PATH 中（win下专用）
+ * @param binDir BinDir 路径
+ * @returns 是否包含
+ */
+function isBinDirInPath(binDir) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const userPath = yield getUserPath();
+        return userPath
+            .split(';')
+            .map((p) => p.toLowerCase())
+            .includes(binDir.toLowerCase());
+    });
+}
+/**
+ * 将 BinDir 添加到用户的 PATH 环境变量（win下专用）
+ * @param binDir BinDir 路径
+ */
+function addBinDirToPath(binDir) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // 使用 setx 添加到 PATH
+        // setx 对 PATH 的长度有2047字符的限制
+        const command = `setx Path "%Path%;${binDir}"`;
+        try {
+            yield execAsync(command);
+            logger.info(`Path add success: ${binDir}`);
+        }
+        catch (error) {
+            throw new Error(`Add BinDir to Path failed: ${error}`);
+        }
+    });
+}
+export function downloadRuntimeAndUnzipForWindows() {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const BinDir = getBinDir();
+            const DenoZip = path.join(BinDir, 'deno.zip');
+            const Target = 'x86_64-pc-windows-msvc';
+            const DownloadUrl = `http://esa-runtime.myalicdn.com/runtime/deno-${Target}.zip`;
+            logger.ora.start('Downloading...');
+            try {
+                yield fs.mkdir(BinDir, { recursive: true });
+            }
+            catch (error) {
+                const err = error;
+                logger.ora.fail();
+                logger.error(`mkdir error ${BinDir}: ${err.message}`);
+                process.exit(1);
+            }
+            try {
+                yield downloadFile(DownloadUrl, DenoZip);
+            }
+            catch (error) {
+                const err = error;
+                logger.ora.fail();
+                logger.error(`${t('deno_download_failed').d('Download failed')}: ${err.message}`);
+                process.exit(1);
+            }
+            logger.info(`Unzip file to: ${BinDir}`);
+            try {
+                logger.ora.text = 'Unzip...';
+                unzipFile(DenoZip, BinDir);
+            }
+            catch (error) {
+                const err = error;
+                logger.ora.fail();
+                logger.error(`${t('deno_unzip_failed').d('Unzip failed')}: ${err.message}`);
+                process.exit(1);
+            }
+            try {
+                logger.ora.text = 'Deleting temp file...';
+                yield fs.unlink(DenoZip);
+                logger.ora.succeed('Download success');
+                logger.info(`Delete temp file: ${DenoZip}`);
+            }
+            catch (error) {
+                logger.warn(`Delete temp file ${DenoZip} failed: ${error}`);
+            }
+            try {
+                logger.ora.text = 'Adding Bin dir to PATH...';
+                const inPath = yield isBinDirInPath(BinDir);
+                if (!inPath) {
+                    logger.info(`${BinDir} not in PATH`);
+                    yield addBinDirToPath(BinDir);
+                }
+                else {
+                    logger.info(`${BinDir} in PATH already`);
+                }
+            }
+            catch (error) {
+                const err = error;
+                logger.ora.fail();
+                logger.error(`${t('deno_add_path_failed').d('Add BinDir to Path failed')}: ${err.message}`);
+                process.exit(1);
+            }
+            logger.success(t('deno_install_success').d('Runtime install success!'));
+            logger.block();
+            const dev = chalk.green('esa dev');
+            logger.log(t('deno_install_success_tips', { dev }).d(`Please run ${dev} again`));
+        }
+        catch (error) {
+            const err = error;
+            logger.ora.fail();
+            logger.error(`Download Error: ${err.message}`);
+            process.exit(1);
+        }
+    });
+}

package/dist/utils/fileUtils/base.js

@@ -11,7 +11,7 @@ export const getRoot = (root) => {
     if (typeof root === 'undefined') {
         root = process.cwd();
     }
-    if (root === '/') {
+    if (path.parse(root).root === root) {
         return process.cwd();
     }
     const file = path.join(root, cliConfigFile);

package/dist/utils/fileUtils/index.js

@@ -188,7 +188,7 @@ export const getApiConfig = () => {
     };
     return config;
 };
-export const templateHubPath = path.join(getDirName(import.meta.url), '../../node_modules/esa-template/src');
+export const templateHubPath = path.join(getDirName(import.meta.url), '../../../node_modules/esa-template/src');
 export const getTemplatesConfig = () => {
     const manifestPath = path.join(templateHubPath, 'manifest.json');
     const config = JSON.parse(fs.readFileSync(manifestPath, 'utf-8'));

package/dist/utils/installDeno.js

@@ -9,16 +9,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { exec, execSync } from 'child_process';
 import os from 'os';
-import { getDirName } from './fileUtils/base.js';
-import logger from '../libs/logger.js';
 import path from 'path';
+import logger from '../libs/logger.js';
+import { getDirName } from './fileUtils/base.js';
+import { downloadRuntimeAndUnzipForWindows } from './download.js';
 import t from '../i18n/index.js';
 export function preCheckDeno() {
     return __awaiter(this, void 0, void 0, function* () {
         const command = yield checkDenoInstalled();
         if (!command) {
-            logger.error(t('install_runtime_explain').d('Under the beta phase, we are temporarily using Deno as the local development runtime. It needs to be installed first.'));
-            installDeno();
+            logger.error(t('install_runtime_explain').d('Our runtime does not yet support this OS. We are temporarily using Deno as the local development runtime, which needs to be installed first.'));
+            yield installDeno();
             return false;
         }
         return command;
@@ -45,7 +46,6 @@ export function checkDenoInstalled() {
             resolve(res);
         })
             .catch((err) => {
-            console.log(err);
             resolve(false);
         });
     });
@@ -57,8 +57,8 @@ export function installDeno() {
         const p = path.join(__dirname, './install');
         switch (os.platform()) {
             case 'win32':
-                installCommand = `powershell.exe -Command "Get-Content '${p}/install.ps1' | iex"`;
-                break;
+                yield downloadRuntimeAndUnzipForWindows();
+                return true;
             case 'darwin':
             case 'linux':
                 installCommand = `sh ${p}/install.sh`;

package/package.json

@@ -1,15 +1,18 @@
 {
   "name": "esa-cli",
-  "version": "0.0.2-beta.0",
+  "version": "0.0.2-beta.10",
   "description": "A CLI for operating Alibaba Cloud ESA EdgeRoutine (Edge Functions).",
   "main": "bin/enter.cjs",
   "type": "module",
-  "files": [
-    "dist/"
-  ],
   "bin": {
     "esa": "bin/enter.cjs"
   },
+  "files": [
+    "bin",
+    "dist/",
+    "zh_CN.md",
+    "README.md"
+  ],
   "scripts": {
     "build": "rm -rf ./dist && rm -rf ./build && node ./genLocale.cjs && tsc && node ./copy.cjs",
     "watch": "tsc --watch",
@@ -34,6 +37,7 @@
     "@testing-library/dom": "^10.4.0",
     "@testing-library/jest-dom": "^6.5.0",
     "@testing-library/react": "^16.0.1",
+    "@types/adm-zip": "^0.5.7",
     "@types/babel__generator": "^7.6.8",
     "@types/babel__traverse": "^7.20.6",
     "@types/cli-table": "^0.3.4",
@@ -71,7 +75,7 @@
     "@iarna/toml": "^2.2.5",
     "@types/inquirer": "^9.0.7",
     "@vitest/coverage-istanbul": "^2.0.4",
-    "axios": "^1.7.7",
+    "adm-zip": "^0.5.16",
     "chalk": "^5.3.0",
     "chokidar": "^3.5.3",
     "cli-table3": "^0.6.5",

package/dist/README.md

@@ -1,173 +0,0 @@
-# ESA CLI
-
-A CLI for operating Alibaba Cloud ESA EdgeRoutine (Edge Functions). It supports quick creation of edge functions, local debugging, version publishing and deployment, and trigger management.
-
-English | [简体中文](./zh_CN.md)
-
-#### Reference
-
-- [Edge Security Acceleration (ESA)](https://www.aliyun.com/product/esa)
-- [What is EdgeRoutine?](https://help.aliyun.com/document_detail/2710021.html)》
-
-> **Note**: **In version 0.0.2 and above, the local development mode of the ESA CLI has been replaced with the same runtime as the ESA edge functions, ensuring that its actual behavior now matches the live environment. We invite you to experience it.**
-
-ESA CLI is in public beta. If you encounter any issues or have any suggestions while using it, please feel free to submit an issue or a pull request.We are actively working to improve this tool and welcome any feedback. Thank you for your understanding and support!
-
-## Installation
-
-Install and run the CLI using npm:
-
-```bash
-$ npm install esa-cli -g    # Install globally
-$ esa -v                    # Check the version
-```
-
-## Usage
-
-### 1. Initialize Routine Project
-
-```bash
-& esa init
-```
-
-The initialization command has a complete process guide. Follow the prompts to enter the project name and choose a template.
-
-### 2. Start a local server for developing your routine
-
-Local dev is the core feature of the CLI, offering a more convenient debugging experience compared to the Alibaba Cloud ESA console.
-
-```bash
-& cd <Project Name>
-& esa dev [options]
-```
-
-#### Write Code
-
-In an EdgeRoutine project, the entry file is `src/index.js`, and the basic structure is as follows:
-
-```javascript
-const html = `<!DOCTYPE html>
-<body>
-  <h1>Hello World!</h1>
-</body>`;
-
-async function handleRequest(request) {
-  return new Response(html, {
-    headers: {
-      'content-type': 'text/html;charset=UTF-8'
-    }
-  });
-}
-
-export default {
-  async fetch(event) {
-    return event.respondWith(handleRequest(event));
-  }
-};
-```
-
-For more EdgeRoutine APIs and syntax, please refer to the [API Reference](https://help.aliyun.com/document_detail/2710024.html)
-
-#### Local Debugging
-
-After executing `esa dev`, the entry file will be automatically packaged and a local debugging service will be started. The interface looks like this:
-
-![dev png](https://github.com/aliyun/alibabacloud-esa-cli/blob/master/docs/dev.png)
-
-- Press `b` to open the debugging page in the browser.
-- Press `c` to clear the panel.
-- Press `x` to exit debugging.
-- You can use `esa dev --port <port>` to temporarily specify the port or use `esa config -l` to set the port by project configuration.
-
-### 3. Log in to Alibaba Cloud Account
-
-You need to log in to your Alibaba Cloud account to perform remote management operations.
-
-First, visit the [Alibaba Cloud RAM Console](https://ram.console.aliyun.com/manage/ak) to get your AccessKey ID and AccessKey Secret, then execute `esa login` and follow the prompts to enter them.
-
-```bash
-& esa login
-& esa logout
-```
-
-### 4. Create a Version
-
-After local debugging is complete, you need to create a code version for deployment.
-
-```bash
-& esa commit      # Create a Version
-```
-
-### 5. Deploy to Environment & Manage Versions and Deployments
-
-After the code version is created, it needs to be deployed to edge nodes.
-
-Use the `esa deployments [script]` command to manage versions and deployments.
-
-```bash
-& esa deploy              # Deploy versions to the target environment
-& esa deployments list    # View deployments
-& esa deployments delete <versionId>  # Delete a version
-```
-
-_Note: Deployed versions cannot be deleted._
-
-### 6. Manage Triggers
-
-Once deployed to the nodes, you can configure triggers to access your edge functions. There are two types of triggers:
-
-- Domain: After you associate the routine with a domain name, you can use the domain name to access the routine.
-- Route: After you add a route for requested URLs, the routine is called from the edge to respond to the request.
-
-```bash
-& esa domain list
-& esa domain add <domainName>
-& esa domain delete <domainName>
-
-& esa route list
-& esa route add [route] [site]
-& esa route delete <route>
-```
-
-### 7. Manage Functions
-
-You can view and delete Routine functions through the CLI.
-
-```bash
-& esa routine list
-& esa routine delete <routineName>
-```
-
-## Commands
-
-see [Commands](./docs/Commands_en.md)
-
-## Config files
-
-### Global config file
-
-```toml
-endpoint = "" # ESA API Endpoint
-lang = "zh_CN" # language
-
-[auth]
-accessKeyId = "" # AccessKey ID
-accessKeySecret = "" # AccessKey Secret
-```
-
-### Project config file
-
-```toml
-name = "Hello World" # Project name
-description = "Hello World" # Project description
-entry = "src/index.js" # Entry file
-codeVersions = [ ] # Code version
-
-[dev]
-port = 18080 # Debug port
-localUpstream = '' # When debugging locally, the upstream source site will replace the current origin when returning to the source
-```
-
-## LICENSE
-
-[The MIT License](./LICENSE)

package/dist/package.json

@@ -1,104 +0,0 @@
-{
-  "name": "esa-cli",
-  "version": "0.0.2-beta.0",
-  "description": "A CLI for operating Alibaba Cloud ESA EdgeRoutine (Edge Functions).",
-  "main": "bin/enter.cjs",
-  "type": "module",
-  "files": [
-    "dist/"
-  ],
-  "bin": {
-    "esa": "bin/enter.cjs"
-  },
-  "scripts": {
-    "build": "rm -rf ./dist && rm -rf ./build && node ./genLocale.cjs && tsc && node ./copy.cjs",
-    "watch": "tsc --watch",
-    "eslint": "eslint src/ --ext .js,.jsx,.ts,.tsx",
-    "lint-staged": "lint-staged",
-    "prepare": "npm run build",
-    "test": "FORCE_COLOR=0 npx vitest ",
-    "coverage": "vitest --coverage"
-  },
-  "keywords": [
-    "cli",
-    "edge",
-    "esa",
-    "edgeRoutine",
-    "alibaba",
-    "ali"
-  ],
-  "author": "Kinice, Shengyuan Ma",
-  "license": "MIT",
-  "devDependencies": {
-    "@babel/plugin-syntax-import-attributes": "^7.24.7",
-    "@testing-library/dom": "^10.4.0",
-    "@testing-library/jest-dom": "^6.5.0",
-    "@testing-library/react": "^16.0.1",
-    "@types/babel__generator": "^7.6.8",
-    "@types/babel__traverse": "^7.20.6",
-    "@types/cli-table": "^0.3.4",
-    "@types/cross-spawn": "^6.0.6",
-    "@types/fs-extra": "^11.0.4",
-    "@types/jest": "^29.5.12",
-    "@types/lodash": "^4.14.202",
-    "@types/node": "^20.8.10",
-    "@types/node-fetch": "^2.6.9",
-    "@types/portscanner": "^2.1.4",
-    "@types/react": "^18.2.47",
-    "@types/yargs": "^17.0.32",
-    "@typescript-eslint/parser": "^6.9.1",
-    "eslint": "^8.52.0",
-    "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-react": "^7.33.2",
-    "eslint-plugin-react-hooks": "^4.6.0",
-    "husky": "^8.0.3",
-    "jsdom": "^25.0.1",
-    "lint-staged": "^15.0.2",
-    "prettier": "^3.0.3",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "rimraf": "^6.0.1",
-    "tsc-files": "^1.1.4",
-    "typescript": "^5.2.2",
-    "vitest": "^2.0.4"
-  },
-  "dependencies": {
-    "@alicloud/esa20240910": "2.8.1",
-    "@alicloud/openapi-client": "^0.4.7",
-    "@babel/generator": "^7.26.3",
-    "@babel/parser": "^7.24.4",
-    "@babel/traverse": "^7.24.1",
-    "@iarna/toml": "^2.2.5",
-    "@types/inquirer": "^9.0.7",
-    "@vitest/coverage-istanbul": "^2.0.4",
-    "axios": "^1.7.7",
-    "chalk": "^5.3.0",
-    "chokidar": "^3.5.3",
-    "cli-table3": "^0.6.5",
-    "cross-spawn": "^7.0.3",
-    "esa-template": "^0.0.3",
-    "esbuild": "^0.21.1",
-    "esbuild-plugin-less": "^1.3.8",
-    "form-data": "^4.0.0",
-    "fs-extra": "^11.2.0",
-    "http-proxy-agent": "^7.0.2",
-    "ink": "^5.0.1",
-    "ink-select-input": "^6.0.0",
-    "ink-text-input": "^6.0.0",
-    "inquirer": "^9.2.15",
-    "js-base64": "^3.7.7",
-    "moment": "^2.30.1",
-    "node-fetch": "^3.3.2",
-    "open": "^9.1.0",
-    "ora": "^7.0.1",
-    "os-locale": "^6.0.2",
-    "portscanner": "^2.2.0",
-    "winston": "^3.11.0",
-    "winston-daily-rotate-file": "^5.0.0",
-    "yargs": "^17.7.2"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+ssh://git@github.com/aliyun/alibabacloud-esa-cli.git"
-  }
-}