@cloudbase/toolbox 0.7.15 → 0.7.16-beta.0

package/lib/auth/index.d.ts

@@ -27,6 +27,8 @@ export interface WebAuthOptions {
      */
     throwError?: boolean;
     getAuthUrl?: (rawUrl: string) => string;
+    noBrowser?: boolean;
+    callbackTimeout?: number;
 }
 export interface LoginByApiSecretOptions {
     /**

package/lib/auth/index.js

@@ -80,7 +80,7 @@ class AuthSupervisor {
      */
     loginByWebAuth(options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { getAuthUrl, throwError } = options;
+            const { getAuthUrl, throwError, noBrowser, callbackTimeout } = options;
             if (this.cacheCredential && this.needCache && !this.isCacheExpire()) {
                 return this.cacheCredential;
             }
@@ -90,7 +90,9 @@ class AuthSupervisor {
                 return credential;
             // 兼容临时秘钥
             credential = yield (0, web_auth_1.getAuthTokenFromWeb)({
-                getAuthUrl
+                getAuthUrl,
+                noBrowser,
+                callbackTimeout
             });
             try {
                 yield (0, common_1.checkAuth)(credential, this.requestConfig);

package/lib/auth/web-auth.d.ts

@@ -1,4 +1,6 @@
 import { Credential } from '../types';
 export declare function getAuthTokenFromWeb(options?: {
     getAuthUrl?: (rawUrl: string) => string;
+    noBrowser?: boolean;
+    callbackTimeout?: number;
 }): Promise<Credential>;

package/lib/auth/web-auth.js

@@ -14,27 +14,38 @@ const common_1 = require("./common");
 const coding_1 = require("../coding");
 const web_1 = require("../web");
 const system_1 = require("../system");
-const CliAuthBaseUrl = 'https://tcb.cloud.tencent.com/dev#/cli-auth';
+const CliAuthBaseUrl = 'https://tcb.cloud.tencent.com/dev';
 // 打开云开发控制台，获取授权
 function getAuthTokenFromWeb(options = {}) {
     return __awaiter(this, void 0, void 0, function* () {
-        const { getAuthUrl } = options;
+        const { getAuthUrl, noBrowser, callbackTimeout } = options;
         const mac = yield (0, system_1.getMacAddress)();
         const os = (0, system_1.getOSInfo)();
         const macHash = (0, coding_1.md5Encoding)(mac);
         const query = yield (0, web_1.getDataFromWeb)((port) => {
+            const callbackUrl = `http://127.0.0.1:${port}`;
+            const encodedQuery = `port=${encodeURIComponent(String(port))}`
+                + `&hash=${encodeURIComponent(macHash)}`
+                + `&mac=${encodeURIComponent(mac)}`
+                + `&os=${encodeURIComponent(os)}`
+                + '&from=cli';
+            const encodedCallbackUrl = encodeURIComponent(callbackUrl);
             // 授权链接
-            let cliAuthUrl = `${CliAuthBaseUrl}?port=${port}&hash=${macHash}&mac=${mac}&os=${os}&from=cli`;
+            const rawAuthUrl = `${CliAuthBaseUrl}?authCallbackUrl=${encodedCallbackUrl}#/cli-auth?${encodedQuery}`;
+            let cliAuthUrl = rawAuthUrl;
             if (getAuthUrl) {
                 try {
-                    cliAuthUrl = getAuthUrl(`${CliAuthBaseUrl}?port=${port}&hash=${macHash}&mac=${mac}&os=${os}&from=cli`);
+                    cliAuthUrl = getAuthUrl(rawAuthUrl);
                 }
                 catch (error) {
                     // 忽略错误
                 }
             }
             return cliAuthUrl;
-        }, 'login');
+        }, 'login', {
+            noBrowser,
+            callbackTimeout
+        });
         const credential = (0, common_1.resolveCredential)(query);
         return credential;
     });

package/lib/system/port.js

@@ -15,12 +15,32 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPort = void 0;
 const portfinder_1 = __importDefault(require("portfinder"));
 // 默认端口
-const DEFAULT_PORT = 9012;
+const LOCAL_DEFAULT_PORT = 9012;
+const REMOTE_DEFAULT_PORT = 19012;
+function isRemoteEnvironment() {
+    return Boolean(process.env.SSH_CONNECTION
+        || process.env.SSH_CLIENT
+        || process.env.SSH_TTY
+        || process.env.VSCODE_IPC_HOOK_CLI
+        || process.env.VSCODE_AGENT_FOLDER
+        || process.env.REMOTE_CONTAINERS
+        || process.env.CODESPACES
+        || process.env.GITPOD_WORKSPACE_ID);
+}
+function getStartPort() {
+    const customStartPort = Number(process.env.TCB_WEB_LOGIN_START_PORT);
+    if (Number.isInteger(customStartPort) && customStartPort > 0 && customStartPort < 65535) {
+        return customStartPort;
+    }
+    return isRemoteEnvironment() ? REMOTE_DEFAULT_PORT : LOCAL_DEFAULT_PORT;
+}
 // 获取本地可用端口
 function getPort() {
     return __awaiter(this, void 0, void 0, function* () {
+        const startPort = getStartPort();
         const port = yield portfinder_1.default.getPortPromise({
-            port: DEFAULT_PORT
+            port: startPort,
+            stopPort: 65535
         });
         return port;
     });

package/lib/web/web.d.ts

@@ -3,4 +3,8 @@ export interface IQuery {
 }
 export type GetUrlFn = (port: number) => string;
 export type CheckFn = (query: IQuery) => Promise<void>;
-export declare function getDataFromWeb<T extends IQuery>(getUrl: GetUrlFn, type: 'login' | 'getData'): Promise<T>;
+export interface GetDataFromWebOptions {
+    noBrowser?: boolean;
+    callbackTimeout?: number;
+}
+export declare function getDataFromWeb<T extends IQuery>(getUrl: GetUrlFn, type: 'login' | 'getData', options?: GetDataFromWebOptions): Promise<T>;

package/lib/web/web.js

@@ -19,6 +19,7 @@ const http_1 = __importDefault(require("http"));
 const system_1 = require("../system");
 const error_1 = require("../error");
 const html_1 = require("../html");
+const child_process_1 = require("child_process");
 // 创建本地 Web 服务器，接受 Web 控制台传入的信息
 function createLocalServer() {
     return __awaiter(this, void 0, void 0, function* () {
@@ -52,23 +53,81 @@ function respondWithFile(options) {
         resolve();
     });
 }
+function isTruthyFlag(value) {
+    if (!value) {
+        return false;
+    }
+    return ['1', 'true', 'yes', 'on'].includes(String(value).trim().toLowerCase());
+}
+function isVSCodeEnvironment() {
+    return !!(process.env.VSCODE_PID || process.env.VSCODE_CWD || process.env.TERM_PROGRAM === 'vscode');
+}
+function openUrlByVSCode(url) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return new Promise((resolve, reject) => {
+            (0, child_process_1.execFile)('code', ['--open-url', url], (error) => {
+                if (error) {
+                    reject(error);
+                    return;
+                }
+                resolve();
+            });
+        });
+    });
+}
 // 从 Web 页面中获取数据
-function getDataFromWeb(getUrl, type) {
+function getDataFromWeb(getUrl, type, options = {}) {
+    var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {
         const { server, port } = yield createLocalServer();
-        const url = getUrl(port);
-        // 对 url 转码, 避免 wsl 无法正常打开地址
-        // https://www.npmjs.com/package/open#url
-        // https://github.com/sindresorhus/open/blob/master/index.js#L48
-        try {
-            yield (0, open_1.default)(url, { url: true });
+        const noBrowser = (_a = options.noBrowser) !== null && _a !== void 0 ? _a : isTruthyFlag(process.env.TCB_NO_BROWSER);
+        const callbackTimeout = (_b = options.callbackTimeout) !== null && _b !== void 0 ? _b : 180000;
+        if (!Number.isFinite(callbackTimeout) || callbackTimeout <= 0) {
+            throw new error_1.CloudBaseError('callbackTimeout must be a positive number');
         }
-        catch (e) {
-            throw new error_1.CloudBaseError('打开浏览器失败，请尝试使用其他登录方式');
+        const url = getUrl(port);
+        console.log('若链接未自动打开，请手动复制此链接至浏览器，或尝试使用其他登录方式:');
+        console.log(`\n${url}`);
+        if (!noBrowser) {
+            // 对 url 转码, 避免 wsl 无法正常打开地址
+            // https://www.npmjs.com/package/open#url
+            // https://github.com/sindresorhus/open/blob/master/index.js#L48
+            try {
+                yield (0, open_1.default)(url, { url: true });
+            }
+            catch (e) {
+                const code = (e === null || e === void 0 ? void 0 : e.code) || 'UNKNOWN';
+                console.warn(`自动打开浏览器失败(${code})。`);
+                if (isVSCodeEnvironment()) {
+                    try {
+                        yield openUrlByVSCode(url);
+                    }
+                    catch (vscodeError) {
+                        // ignore error
+                    }
+                }
+            }
         }
         return new Promise((resolve, reject) => {
+            let finished = false;
+            const timer = setTimeout(() => {
+                if (finished) {
+                    return;
+                }
+                finished = true;
+                server.close();
+                reject(new error_1.CloudBaseError(`等待浏览器授权回调超时(${Math.floor(callbackTimeout / 1000)}s)!`));
+            }, callbackTimeout);
+            const finish = (fn) => {
+                if (finished) {
+                    return;
+                }
+                finished = true;
+                clearTimeout(timer);
+                fn();
+            };
             server.on('request', (req, res) => {
-                const { url } = req;
+                const url = req.url || '/';
                 const { query } = query_string_1.default.parseUrl(url);
                 // 响应 HTML 文件
                 if (query === null || query === void 0 ? void 0 : query.html) {
@@ -78,11 +137,15 @@ function getDataFromWeb(getUrl, type) {
                         statusCode: 200,
                         filename: `${type}Success`
                     }).then(() => {
-                        server.close();
-                        resolve(query);
+                        finish(() => {
+                            server.close();
+                            resolve(query);
+                        });
                     }).catch((e) => {
-                        server.close();
-                        reject(e);
+                        finish(() => {
+                            server.close();
+                            reject(e);
+                        });
                     });
                 }
                 // CORS 响应普通文本
@@ -98,7 +161,9 @@ function getDataFromWeb(getUrl, type) {
                 if (req.method !== 'OPTIONS') {
                     server.close();
                 }
-                resolve(query);
+                finish(() => {
+                    resolve(query);
+                });
             });
         });
     });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cloudbase/toolbox",
-    "version": "0.7.15",
+    "version": "0.7.16-beta.0",
     "description": "The toolbox for cloudbase",
     "main": "lib/index.js",
     "scripts": {
@@ -63,7 +63,7 @@
     },
     "husky": {
         "hooks": {
-            "pre-commit": "npm run build && git add ."
+            "pre-commit": "npm run build"
         }
     },
     "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"