@getxflow/cli 0.34.1 → 1.0.0

package/dist/commands/functions.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.functionsList = functionsList;
-exports.failureHint = failureHint;
 exports.functionsInvoke = functionsInvoke;
 const api_1 = require("../api");
 const args_1 = require("../args");
@@ -9,45 +8,25 @@ const errors_1 = require("../errors");
 const json_arg_1 = require("../json-arg");
 const session_1 = require("../session");
 const ui_1 = require("../ui");
-/** Who can call the function: anyone, an outside service holding a key, or the app alone. */
-function accessLabel(fn) {
-    const keys = fn.external_keys ? `external (${fn.external_keys} key${fn.external_keys > 1 ? 's' : ''})` : '';
-    if (fn.is_public)
-        return keys ? `public, ${keys}` : 'public';
-    return keys || 'in-app only';
-}
-const FUNCTIONS_DIR = 'functions';
 async function functionsList(args) {
     const { projectId, client } = await (0, session_1.projectTarget)(args);
-    const data = await (0, api_1.apiJson)(client, `/api/v1/projects/${projectId}/functions`);
-    if (data.functions.length === 0 && !data.shared?.length) {
-        (0, ui_1.note)(`No functions. Put the code in ${FUNCTIONS_DIR}/<name>/index.ts and run xflow deploy`);
+    const { functions } = await (0, api_1.apiJson)(client, `/api/v1/projects/${projectId}/functions`);
+    if (functions.length === 0) {
+        (0, ui_1.note)('No functions. Put the code in functions/<name>/index.ts at the project root and run xflow deploy functions');
         return;
     }
-    if (data.functions.length > 0) {
-        (0, ui_1.table)(data.functions.map((fn) => [
-            fn.name,
-            fn.status === 'deployed' ? 'deployed' : fn.status === 'failed' ? 'failed' : fn.status,
-            accessLabel(fn),
-            fn.last_deployed_at ? (0, ui_1.formatAge)(fn.last_deployed_at) : '-',
-            // The address is not a secret (the app bundle carries it): a page or a
-            // webhook needs it, and asking the user to copy it out of the UI was a detour.
-            fn.invoke_url ?? '',
-            fn.error_message ?? '',
-        ]));
-    }
-    // Not rows of the table above: these are not this project's to deploy, rename or
-    // delete, and invoke and logs do not reach them from here either. Under the table
-    // with the id they need, so calling one is the same command plus --project.
-    if (data.shared?.length) {
-        if (data.functions.length > 0)
-            (0, ui_1.note)();
-        (0, ui_1.note)((0, ui_1.dim)('  Also callable from this project by name, code in another project of the organization:'));
-        const width = Math.max(...data.shared.map((fn) => fn.name.length));
-        for (const fn of data.shared) {
-            (0, ui_1.note)((0, ui_1.dim)(`    ${fn.name.padEnd(width)}  --project ${fn.project_id}`));
-        }
-    }
+    (0, ui_1.table)(functions.map((fn) => [
+        fn.name,
+        fn.status,
+        fn.callers.length > 0 ? fn.callers.join(', ') : 'no callers',
+        fn.open ? 'open' : '',
+        fn.external_keys ? `${fn.external_keys} key${fn.external_keys > 1 ? 's' : ''}` : '',
+        fn.last_called_at ? `called ${(0, ui_1.formatAge)(fn.last_called_at)}` : 'never called',
+        fn.last_error_at ? `failed ${(0, ui_1.formatAge)(fn.last_error_at)}` : '',
+    ]));
+    (0, ui_1.note)((0, ui_1.dim)('  callers: the app folders and page names allowed to call it (functions in the root xflow.json)'));
+    (0, ui_1.note)((0, ui_1.dim)('  open: a caller is public, so anyone on the internet can call it; no callers: a workflow'));
+    (0, ui_1.note)((0, ui_1.dim)(`  Webhooks and other functions call ${functions[0].url.replace(/\/[^/]+$/, '/<name>')} with a key`));
 }
 function prettyBody(text) {
     try {
@@ -57,94 +36,23 @@ function prettyBody(text) {
         return text;
     }
 }
-/**
- * Refusals the wrapper writes itself, before the handler runs. Nothing about them
- * reaches the logs, and the answer already names the cause.
- *
- * Matched by value and not by the presence of the field, because a handler is free to
- * put a reason of its own into the body it returns, and that one did run.
- *
- * Keep in sync with lib/yandex-functions/call-outcome.ts, which the MCP tool calls:
- * this package ships without dependencies and cannot reach into the platform. One test
- * holds the two halves together.
- */
-const WRAPPER_REASONS = ['no_pass', 'invalid', 'expired', 'no_access', 'unavailable', 'role', 'access'];
-/** What to look at next, when the function did not answer with a success. */
-function failureHint(name, status, body) {
-    let reason;
-    try {
-        reason = JSON.parse(body).reason;
-    }
-    catch {
-        reason = undefined;
-    }
-    const logs = `The stack and console output: xflow functions logs ${name}`;
-    if (typeof reason !== 'string' || !WRAPPER_REASONS.includes(reason))
-        return logs;
-    if (reason !== 'role' || status < 500)
-        return undefined;
-    // Two different answers wear this one: a threshold the platform cannot read, refused
-    // before the handler and so absent from the logs, and a handler that answered 5xx with
-    // a reason of that name itself, which is logged. Emptiness there tells them apart.
-    return `${logs}. Nothing there means the declared minRole is the problem: fix functions/${name}/index.ts`;
-}
-/** Call a function the same way the application does. */
+/** Call a function as the person who owns the key, through the platform. */
 async function functionsInvoke(args) {
     const { projectId, client } = await (0, session_1.projectTarget)(args);
     const name = args.words[1];
     if (!name)
         throw new errors_1.CliError('A function name is required', 'What is deployed: xflow functions list');
-    // The body is judged before anything goes over the network: a broken one is the
-    // user's own line, and it costs nothing to say so at once.
+    // Judged before anything goes over the network: a broken body is the user's own line.
     const data = (0, json_arg_1.jsonArg)(args, 'data');
     const method = ((0, args_1.flagString)(args, 'method') ?? (data ? 'POST' : 'GET')).toUpperCase();
-    const sendsBody = method !== 'GET' && method !== 'HEAD';
-    const card = await (0, api_1.apiJson)(client, `/api/v1/projects/${projectId}`);
-    const fn = card.functions.find((item) => item.name === name);
-    if (!fn || !fn.invoke_url) {
-        throw new errors_1.CliError(`Function ${name} is not deployed`, card.functions.length > 0
-            ? `Deployed: ${card.functions.map((item) => item.name).join(', ')}`
-            : 'Functions ship with the build: xflow deploy');
-    }
-    // A pass for the person who owns the key: the project token alone is not an
-    // identity, and a project built with the current template refuses without one.
-    // A read-only key cannot get a pass, so the call still goes out without it.
-    let pass = '';
-    try {
-        const issued = await (0, api_1.apiJson)(client, `/api/v1/projects/${projectId}/pass`, { method: 'POST' });
-        pass = issued.pass;
-    }
-    catch {
-        (0, ui_1.note)((0, ui_1.dim)('  Could not get a visitor pass: calling with the project token only'));
-    }
-    // The cap the deployed version actually carries, not the plan's current one:
-    // they diverge until the next build. Null means deployed before the platform
-    // recorded caps, that is with 90.
-    const capS = fn.execution_timeout_s ?? 90;
-    const started = Date.now();
-    let response;
-    try {
-        response = await fetch(fn.invoke_url, {
-            method,
-            headers: {
-                'Content-Type': 'application/json',
-                'X-Project-Token': card.project_token ?? '',
-                ...(pass ? { 'X-Project-Pass': pass } : {}),
-            },
-            body: sendsBody ? (data ?? '{}') : undefined,
-            // Wait past the function's own cap to see its timeout, not ours.
-            signal: AbortSignal.timeout((capS + 10) * 1000),
-        });
-    }
-    catch (e) {
-        throw new errors_1.CliError(`The function did not answer: ${e instanceof Error ? e.message : String(e)}`, 'Check that it is deployed: xflow functions list');
-    }
-    const elapsed = Date.now() - started;
-    const text = await response.text();
-    (0, ui_1.note)((0, ui_1.dim)(`${response.status} ${response.statusText} in ${elapsed} ms`));
-    if (text)
-        (0, ui_1.out)((0, args_1.flagBool)(args, 'json') ? text : prettyBody(text));
-    if (!response.ok) {
-        throw new errors_1.CliError(`The function answered ${response.status}`, failureHint(name, response.status, text));
-    }
+    const answer = await (0, api_1.apiForward)(client, `/api/v1/projects/${projectId}/functions/${encodeURIComponent(name)}/invoke`, {
+        method: 'POST',
+        body: { method, ...(data !== undefined && method !== 'GET' && method !== 'HEAD' ? { body: data } : {}) },
+        timeoutMs: 15 * 60_000,
+    });
+    (0, ui_1.note)((0, ui_1.dim)(`${answer.status} in ${answer.elapsedMs} ms`));
+    if (answer.body)
+        (0, ui_1.out)((0, args_1.flagBool)(args, 'json') ? answer.body : prettyBody(answer.body));
+    if (answer.status >= 400)
+        throw new errors_1.CliError(`The function answered ${answer.status}`, answer.hint);
 }

package/dist/commands/logs.js

@@ -4,6 +4,7 @@ exports.logs = logs;
 exports.functionsLogs = functionsLogs;
 const api_1 = require("../api");
 const args_1 = require("../args");
+const config_1 = require("../config");
 const session_1 = require("../session");
 const ui_1 = require("../ui");
 const DEFAULT_LIMIT = 10;
@@ -13,18 +14,10 @@ function stamp(iso) {
     const pad = (value) => String(value).padStart(2, '0');
     return `${pad(date.getDate())}.${pad(date.getMonth() + 1)} ${pad(date.getHours())}:${pad(date.getMinutes())}:${pad(date.getSeconds())}`;
 }
-async function fetchLogs(source, name, args) {
-    const { projectId, client } = await (0, session_1.projectTarget)(args);
-    const query = new URLSearchParams({ source, limit: String((0, args_1.flagNumber)(args, 'limit') ?? DEFAULT_LIMIT) });
-    if (name)
-        query.set('name', name);
-    const data = await (0, api_1.apiJson)(client, `/api/v1/projects/${projectId}/logs?${query.toString()}`);
-    return data.logs;
-}
 /** Newest at the bottom. */
-function render(rows) {
+function render(rows, appLabel) {
     for (const row of [...rows].reverse()) {
-        const label = row.source === 'function' ? (row.function ?? 'function') : 'browser';
+        const label = row.source === 'function' ? (row.function ?? 'function') : appLabel(row.app_id ?? '');
         (0, ui_1.out)(`${(0, ui_1.dim)(stamp(row.timestamp))}  ${(0, ui_1.bold)(label)}  ${row.message}`);
         if (row.stack) {
             const lines = row.stack.split('\n');
@@ -36,22 +29,33 @@ function render(rows) {
         (0, ui_1.out)('');
     }
 }
+/** Browser errors: of this app in its folder or with --app, of every app in the project root. */
 async function logs(args) {
-    const rows = await fetchLogs('client', undefined, args);
+    const target = await (0, session_1.streamTarget)(args, undefined, false);
+    const limit = String((0, args_1.flagNumber)(args, 'limit') ?? DEFAULT_LIMIT);
+    const path = target.kind === 'app'
+        ? `/api/v1/apps/${target.appId}/logs?limit=${limit}`
+        : `/api/v1/projects/${target.projectId}/logs?source=client&limit=${limit}`;
+    const { logs: rows } = await (0, api_1.apiJson)(target.client, path);
     if (rows.length === 0) {
         (0, ui_1.note)('No browser errors');
-        (0, ui_1.note)((0, ui_1.dim)('  This collects crashes of the released application, not of a local npm run dev'));
+        (0, ui_1.note)((0, ui_1.dim)('  This collects crashes of the published app, not of a local xflow dev'));
         return;
     }
-    render(rows);
+    const folders = new Map(target.kind === 'project' && target.root ? (0, config_1.localApps)(target.root).map((app) => [app.appId, `apps/${app.folder}`]) : []);
+    render(rows, (id) => folders.get(id) ?? 'browser');
 }
 async function functionsLogs(args) {
     const name = args.words[1];
-    const rows = await fetchLogs('function', name, args);
+    const { projectId, client } = await (0, session_1.projectTarget)(args);
+    const query = new URLSearchParams({ source: 'function', limit: String((0, args_1.flagNumber)(args, 'limit') ?? DEFAULT_LIMIT) });
+    if (name)
+        query.set('name', name);
+    const { logs: rows } = await (0, api_1.apiJson)(client, `/api/v1/projects/${projectId}/logs?${query.toString()}`);
     if (rows.length === 0) {
         (0, ui_1.note)(name ? `Function ${name} has not crashed` : 'No function has crashed');
         (0, ui_1.note)((0, ui_1.dim)('  Only failed calls land here: successful ones write nothing'));
         return;
     }
-    render(rows);
+    render(rows, () => 'browser');
 }

package/dist/commands/pages.js

@@ -98,6 +98,7 @@ async function pagesCreate(args) {
     (0, ui_1.ok)(`Page "${result.page.title}" is live: ${result.file_count} file(s), ${(0, ui_1.formatBytes)(result.size_bytes)}`);
     (0, ui_1.out)(result.page.url);
     (0, ui_1.note)((0, ui_1.dim)(`  Anyone with the address sees it within seconds. The next version: xflow pages deploy ${result.page.slug} <path>`));
+    (0, ui_1.note)((0, ui_1.dim)(`  A backend for it: name "${result.page.slug}" in functions.<name>.callers of a project, xflow deploy functions, then fetch /_fn/<name>`));
 }
 function contentTypeOf(upload) {
     return upload.kind === 'zip' ? 'application/zip' : 'text/html';