@onesi/genesis-cli 0.2.5 → 0.2.6

package/README.md

@@ -3,7 +3,7 @@
 `genesis`, the OneOS command line. It works against the Genesis API at `https://os.one.ml/api`.
 
 ```sh
-npx -y @onesi/genesis-cli@0.2.5 --help
+npx -y @onesi/genesis-cli@0.2.6 --help
 ```
 
 ## First run

package/dist/hives-node-transport.d.ts

@@ -1,6 +1,8 @@
 import { type GenesisOptions } from '@onesi/genesis';
 export declare function closeHivesNodeTransport(): Promise<void>;
 export declare function hivesOperationBudget(id: string): number;
+/** Live log streams must start within 45 s (15 s heartbeat + 15 s window + margin). The 330 s budget runs from the start of the request, so the body gets at least 285 s. */
+export declare function hivesHeaderBudget(id: string): number | undefined;
 /** Hives leaf transport. Caller fetch overrides stay authoritative; only native
  * global fetch gets our Agent. Every operation retains an overall body deadline. */
 export declare function createHivesNodeTransport(opts: GenesisOptions, callerSignal?: AbortSignal): typeof fetch;

package/dist/hives-node-transport.js

@@ -24,6 +24,10 @@ export function hivesOperationBudget(id) {
         return 100_000;
     return 20_000;
 }
+/** Live log streams must start within 45 s (15 s heartbeat + 15 s window + margin). The 330 s budget runs from the start of the request, so the body gets at least 285 s. */
+export function hivesHeaderBudget(id) {
+    return id === 'hives_stream_logs' || id === 'hives_stream_deployment_logs' ? 45_000 : undefined;
+}
 const escape = (value) => value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
 const templatePattern = (value) => new RegExp('^' + value.split(/(\{[^}]+\})/).map((part) => part.startsWith('{') ? '[^/]+' : escape(part)).join('') + '$');
 /** Hives leaf transport. Caller fetch overrides stay authoritative; only native
@@ -78,6 +82,12 @@ export function createHivesNodeTransport(opts, callerSignal) {
             controller.abort();
         }, hivesOperationBudget(route.id));
         timer.unref();
+        const headerBudget = hivesHeaderBudget(route.id);
+        const headerTimer = headerBudget === undefined ? undefined : setTimeout(() => {
+            message = 'Hives stream did not start within 45 s. Retry the stream.';
+            controller.abort();
+        }, headerBudget);
+        headerTimer?.unref();
         let abortReject = () => { };
         let reader;
         let bodyController;
@@ -92,6 +102,7 @@ export function createHivesNodeTransport(opts, callerSignal) {
         void abortPromise.catch(() => { });
         const cleanup = () => {
             clearTimeout(timer);
+            clearTimeout(headerTimer);
             for (const signal of signals)
                 signal.removeEventListener('abort', canceled);
             controller.signal.removeEventListener('abort', aborted);
@@ -112,6 +123,7 @@ export function createHivesNodeTransport(opts, callerSignal) {
             void pending.then((response) => { if (controller.signal.aborted)
                 void response.body?.cancel().catch(() => { }); }, () => { });
             const response = await Promise.race([pending, abortPromise]);
+            clearTimeout(headerTimer);
             if (controller.signal.aborted)
                 throw safeError();
             if (!response.body) {

package/dist/hives-project.d.ts

@@ -1,8 +1,25 @@
 import type { Command } from 'commander';
-import { type Genesis } from '@onesi/genesis';
+import { type Genesis, type OperationId, type OperationMeta } from '@onesi/genesis';
+/**
+ * `genesis hives <words>` commands whose last argument is <project_id>, and the Hives operation each one sends.
+ * Only these can let project_id default, and only when that operation reads or creates (see hivesProjectMayDefault).
+ * A command that is not listed keeps an explicit project id. `test/hives-project-guard.test.ts` checks that every
+ * command with a trailing project_id is listed and that each one sends exactly this operation.
+ */
+export declare const HIVES_PROJECT_COMMANDS: Record<string, OperationId>;
+/** DELETE, or a POST that ends a lifecycle: an omitted project id never defaults. */
+export declare const isHivesDestructiveOperation: (id: string, op: Pick<OperationMeta, "method">) => boolean;
+/**
+ * Whether an omitted project id may default for this operation: reads (GET, and POST log search) and creates
+ * (POST hives_create_…). Deletes, lifecycle endings and writes that overwrite (PUT, PATCH, publish and other POSTs)
+ * take an explicit project id.
+ */
+export declare function hivesProjectMayDefault(id: string, op: Pick<OperationMeta, 'method'>): boolean;
+/** The command's words under `genesis hives`, for example "remote sessions list". */
+export declare const hivesCommandPath: (command: Command, hives: Command) => string;
 /**
  * Every `genesis hives` command with a <project_id>: the help says "Hives project id (prj_…)"; a Genesis pr_… id of
- * the selected context resolves to its Hives binding, and where project_id is the last argument of a command that
- * does not delete or end anything it may be omitted. The binding is read once per invocation, before the action.
+ * the selected context resolves to its Hives binding, and where project_id is the last argument of a listed command
+ * whose operation reads or creates it may be omitted. The binding is read once per invocation, before the action.
  */
 export declare function registerHivesProjectDefault(hives: Command, client: () => Promise<Genesis>): void;

package/dist/hives-project.js

@@ -1,18 +1,92 @@
-import { HIVES_PROJECT_ID_DEFAULT, HIVES_PROJECT_ID_DESCRIPTION, isGenesisProjectId } from '@onesi/genesis';
-/** Commands that delete or end something keep an explicit project id: an omitted one never defaults. */
-const EXPLICIT = /^(?:delete|remove|purge|uninstall|destroy|stop|cancel|rollback|detach)/;
+import { HIVES_PROJECT_ID_DEFAULT, HIVES_PROJECT_ID_DESCRIPTION, isGenesisProjectId, operationTable } from '@onesi/genesis';
+import { HIVES_COVERAGE_COMMANDS } from './hives-coverage.js';
+/**
+ * `genesis hives <words>` commands whose last argument is <project_id>, and the Hives operation each one sends.
+ * Only these can let project_id default, and only when that operation reads or creates (see hivesProjectMayDefault).
+ * A command that is not listed keeps an explicit project id. `test/hives-project-guard.test.ts` checks that every
+ * command with a trailing project_id is listed and that each one sends exactly this operation.
+ */
+export const HIVES_PROJECT_COMMANDS = {
+    'settings get': 'hives_get_project_settings',
+    'settings update': 'hives_update_project_settings',
+    'crons list': 'hives_list_crons',
+    'crons create': 'hives_create_cron',
+    'metrics project': 'hives_get_project_metrics',
+    'metrics requests': 'hives_get_request_metrics',
+    'metrics latency': 'hives_get_latency_metrics',
+    'metrics errors': 'hives_get_error_metrics',
+    'metrics resources': 'hives_get_resource_usage',
+    'metrics dashboard': 'hives_get_dashboard_metrics',
+    'metrics realtime': 'hives_get_realtime_metrics',
+    'marketplace list': 'hives_marketplace_list_packages',
+    'marketplace categories': 'hives_marketplace_categories',
+    'marketplace featured': 'hives_marketplace_featured',
+    'marketplace publish': 'hives_marketplace_publish',
+    'marketplace installed': 'hives_marketplace_installed',
+    'cells list': 'hives_list_buckets',
+    'cells create': 'hives_create_bucket',
+    'queues list': 'hives_list_native_queue',
+    'queues create': 'hives_create_native_queue',
+    'topics list': 'hives_list_native_topic',
+    'topics create': 'hives_create_native_topic',
+    'volumes list': 'hives_list_volumes',
+    'volumes create': 'hives_create_volume',
+    'runtimes project': 'hives_list_project_runtimes',
+    'logs query': 'hives_query_logs',
+    'logs stream': 'hives_stream_logs',
+    'domains list': 'hives_list_domains',
+    'remote sessions list': 'hives_list_remote_sessions',
+    'deployments list': 'hives_list_deployments',
+    'functions list': 'hives_list_functions',
+    'environment list': 'hives_list_project_environment',
+    'environment upsert': 'hives_update_project_environment',
+    'secrets list': 'hives_list_secrets',
+    'secrets bulk': 'hives_bulk_upsert_secrets',
+    'projects get': 'hives_get_project',
+    'projects delete': 'hives_delete_project',
+    'projects activity': 'hives_get_project_activity',
+    ...Object.fromEntries(Object.entries(HIVES_COVERAGE_COMMANDS).filter(([, id]) => {
+        const op = operationTable[id];
+        return op.pathParams.at(-1) === 'project_id';
+    })),
+};
+/** POST operations that end, undo or tear down something. */
+const LIFECYCLE_END = /(?:^|_)(?:stop|cancel|rollback|revoke|release|teardown|unlink|unsubscribe|close|reset|purge|uninstall|detach|unmount)(?:_|$)/;
+/** DELETE, or a POST that ends a lifecycle: an omitted project id never defaults. */
+export const isHivesDestructiveOperation = (id, op) => op.method === 'DELETE' || (op.method === 'POST' && LIFECYCLE_END.test(id));
+/**
+ * Whether an omitted project id may default for this operation: reads (GET, and POST log search) and creates
+ * (POST hives_create_…). Deletes, lifecycle endings and writes that overwrite (PUT, PATCH, publish and other POSTs)
+ * take an explicit project id.
+ */
+export function hivesProjectMayDefault(id, op) {
+    if (isHivesDestructiveOperation(id, op))
+        return false;
+    if (op.method === 'GET' || op.method === 'HEAD')
+        return true;
+    return op.method === 'POST' && /^hives_(?:create|search)_/.test(id);
+}
 const projectArgument = (command) => command.registeredArguments.findIndex((a) => a.name() === 'project_id');
+/** The command's words under `genesis hives`, for example "remote sessions list". */
+export const hivesCommandPath = (command, hives) => {
+    const words = [];
+    for (let c = command; c && c !== hives; c = c.parent)
+        words.unshift(c.name());
+    return words.join(' ');
+};
 /**
  * Every `genesis hives` command with a <project_id>: the help says "Hives project id (prj_…)"; a Genesis pr_… id of
- * the selected context resolves to its Hives binding, and where project_id is the last argument of a command that
- * does not delete or end anything it may be omitted. The binding is read once per invocation, before the action.
+ * the selected context resolves to its Hives binding, and where project_id is the last argument of a listed command
+ * whose operation reads or creates it may be omitted. The binding is read once per invocation, before the action.
  */
 export function registerHivesProjectDefault(hives, client) {
     const visit = (command) => {
         const at = projectArgument(command);
         if (at >= 0 && command.parent?.name() !== 'context') {
             const argument = command.registeredArguments[at];
-            const optional = at === command.registeredArguments.length - 1 && !argument.variadic && !EXPLICIT.test(command.name());
+            const id = HIVES_PROJECT_COMMANDS[hivesCommandPath(command, hives)];
+            const op = id ? operationTable[id] : undefined;
+            const optional = at === command.registeredArguments.length - 1 && !argument.variadic && !!op && hivesProjectMayDefault(id, op);
             argument.description = optional ? `${HIVES_PROJECT_ID_DESCRIPTION}; ${HIVES_PROJECT_ID_DEFAULT}` : HIVES_PROJECT_ID_DESCRIPTION;
             if (optional)
                 argument.required = false;

package/dist/index.js

@@ -41,7 +41,7 @@ export function buildProgram(deps = {}) {
     const auth = { ...authConfig(env, f), sleep: deps.sleep };
     const program = new Command('genesis')
         .description('One CLI for every Genesis service.')
-        .version('0.2.5')
+        .version('0.2.6')
         .option('--json', 'machine-readable JSON output')
         .option('--api-key <key>', 'use this API key (default: GENESIS_API_KEY, then your `genesis login`)')
         .option('--base-url <url>', 'gateway URL (default: GENESIS_BASE_URL or https://os.one.ml/api)')
@@ -57,7 +57,7 @@ export function buildProgram(deps = {}) {
         const opts = {
             apiKey: o.apiKey ?? env.GENESIS_API_KEY, token: env.GENESIS_TOKEN,
             baseUrl: o.baseUrl ?? env.GENESIS_BASE_URL, routing: o.direct || env.GENESIS_ROUTING === 'direct' ? 'direct' : 'gateway',
-            fetch: f, userAgent: 'genesis-cli/0.2.5',
+            fetch: f, userAgent: 'genesis-cli/0.2.6',
             credentials: store ? savedLoginProvider(auth, store) : undefined,
         };
         return new Genesis(hivesTransport ? { ...opts, fetch: createHivesNodeTransport(opts, deps.signal) } : opts);
@@ -278,7 +278,7 @@ export function buildProgram(deps = {}) {
         if (!key)
             throw new Error('Give the enrollment key with --key-file, --key-stdin or GENESIS_ENROLLMENT_KEY; it is never accepted as an argument.');
         const body = await readFunctionJson(o.bodyFile, 16 * 1024);
-        const result = await new Genesis({ baseUrl: g().baseUrl ?? env.GENESIS_BASE_URL, fetch: f, userAgent: 'genesis-cli/0.2.5' }).iam.agents.enroll(key, body);
+        const result = await new Genesis({ baseUrl: g().baseUrl ?? env.GENESIS_BASE_URL, fetch: f, userAgent: 'genesis-cli/0.2.6' }).iam.agents.enroll(key, body);
         emit(result, () => JSON.stringify(result, null, 2));
     });
     // ---- auth ------------------------------------------------------------
@@ -813,7 +813,7 @@ export function buildProgram(deps = {}) {
         const url = `${base.href.replace(/\/+$/, '')}/v1/status`;
         let response;
         try {
-            response = await f(url, { method: 'GET', headers: { accept: 'application/json', 'user-agent': 'genesis-cli/0.2.5' }, signal: AbortSignal.timeout(15_000) });
+            response = await f(url, { method: 'GET', headers: { accept: 'application/json', 'user-agent': 'genesis-cli/0.2.6' }, signal: AbortSignal.timeout(15_000) });
         }
         catch (e) {
             throw new Error(`Gateway unreachable at ${safe(url)}: ${safe(e.message)}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onesi/genesis-cli",
-  "version": "0.2.5",
+  "version": "0.2.6",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/l1felabs/genesis-api.git",
@@ -33,7 +33,7 @@
   "dependencies": {
     "commander": "^14.0.0",
     "undici": "6.29.0",
-    "@onesi/genesis": "0.2.5"
+    "@onesi/genesis": "0.2.6"
   },
   "optionalDependencies": {
     "@napi-rs/keyring": "^1.2.0"