@quantum-hub/qhubctl 1.19.1 → 2.0.0

package/dist/commands/compress.js

@@ -2,18 +2,36 @@ import { Command } from 'commander';
 import fs from 'fs-extra';
 import path from 'node:path';
 import { zipProjectFolder } from '../lib/up/zip.js';
-import { spinner, stdout } from '../lib/output.js';
+import { enforceRequiredFiles } from '../lib/up/required-files.js';
+import { error, spinner, stdout } from '../lib/output.js';
 const EXAMPLES = `
 Examples:
-  $ qhubctl compress`;
+  $ qhubctl compress
+
+The '.qhubignore' file uses gitignore syntax. To ship only 'src' and the
+Dockerfile, re-include the directory AND its contents:
+
+  *
+  !src
+  !src/**
+  !Dockerfile
+
+These paths are always excluded: .git, node_modules, .venv, __pycache__, service.zip`;
 export const compressCommand = new Command('compress')
-    .description("Compresses the current project and creates a ZIP file. Use the '.dockerignore' file to exclude files and directories from the ZIP file.")
+    .description("Compresses the current project and creates a ZIP file. Use a '.qhubignore' file (gitignore syntax) to exclude files and directories from the ZIP file.")
     .addHelpText('after', EXAMPLES)
     .action(async () => {
     const spin = spinner('Compressing project');
     const targetDirectory = process.cwd();
     const targetFilename = 'service.zip';
     const targetFilePath = path.join(targetDirectory, '/', targetFilename);
+    try {
+        await enforceRequiredFiles(targetDirectory);
+    }
+    catch (err) {
+        spin.fail('Compression aborted');
+        error(err.message);
+    }
     if (fs.existsSync(targetFilePath)) {
         fs.unlinkSync(targetFilePath);
     }

package/dist/commands/openapi.js

@@ -68,7 +68,7 @@ function isProjectSupported(opts) {
         return false;
     }
     const hasExplicitEntrypoint = !!(opts.entrypoint || opts.package || opts.method);
-    const supportedRuntimes = [Runtime.PYTHON_TEMPLATE, Runtime.PYTHON, Runtime.DOCKER];
+    const supportedRuntimes = [Runtime.PYTHON_TEMPLATE, Runtime.DOCKER];
     if (hasExplicitEntrypoint) {
         const isSupported = supportedRuntimes.includes(serviceConfig.runtime);
         if (!isSupported) {
@@ -76,7 +76,7 @@ function isProjectSupported(opts) {
             warn('');
             warn('Supported configurations:');
             warn('  \u2022 PYTHON_TEMPLATE: Automatic (requires src/program.py)');
-            warn('  \u2022 PYTHON/DOCKER: With explicit entrypoint flags');
+            warn('  \u2022 DOCKER: With explicit entrypoint flags');
             warn('');
             warn('Examples:');
             warn('  qhubctl openapi --entrypoint=myapp.main:handler');
@@ -176,7 +176,7 @@ Examples:
 export const openapiCommand = new Command('openapi')
     .description('Generates the OpenAPI description for your project based on the parameter and return types of your run() method. ' +
     'The output of this command will be used when creating or updating your service. ' +
-    'Supports PYTHON_TEMPLATE (with src/program.py), PYTHON and DOCKER runtimes (with explicit entrypoint). ' +
+    'Supports PYTHON_TEMPLATE (with src/program.py) and DOCKER runtime (with explicit entrypoint). ' +
     'Requires uv and a valid uv project in the workspace. The "qhub-commons" dependency is installed/upgraded automatically as a dependency.')
     .option('-f, --force', 'Overwrite the output file if it already exists', false)
     .option('--file <value>', 'The file to write the OpenAPI description to')
@@ -204,7 +204,7 @@ export const openapiCommand = new Command('openapi')
     if (!shouldGenerateFile) {
         warn(`Cannot generate OpenAPI description from your code. Supported configurations:\n` +
             '  \u2022 PYTHON_TEMPLATE runtime with "./src/program.py" file\n' +
-            '  \u2022 DOCKER, PYTHON, or PYTHON_TEMPLATE runtimes with explicit entrypoint (--entrypoint, or (--package, --method))');
+            '  \u2022 DOCKER or PYTHON_TEMPLATE runtimes with explicit entrypoint (--entrypoint, or (--package, --method))');
         return;
     }
     // Ensure qhub-commons is installed (or upgraded) in the project venv

package/dist/commands/up.js

@@ -7,6 +7,7 @@ import { HubPlatform } from '@quantum-hub/qhub-api/platform';
 import { streamToBlob } from '../lib/stream-to-blob.js';
 import { getDescriptionText } from '../lib/up/get-description.js';
 import { zipProjectFolder } from '../lib/up/zip.js';
+import { enforceRequiredFiles } from '../lib/up/required-files.js';
 import { handleError } from '../lib/error.js';
 import { error, spinner, stdout, warn } from '../lib/output.js';
 import { requireAuth } from '../model/command.js';
@@ -129,6 +130,12 @@ export const upCommand = new Command('up')
         if (!createNewService)
             process.exit(0);
     }
+    try {
+        await enforceRequiredFiles(process.cwd());
+    }
+    catch (err) {
+        error(err.message);
+    }
     const serviceFiles = {
         openapi: await getOpenapi(),
         descriptionText: await getDescriptionText(process.cwd()),

package/dist/lib/up/ignore.js

@@ -3,13 +3,15 @@ import fs from 'node:fs';
 import path from 'node:path';
 import { promisify } from 'node:util';
 const readFile = promisify(fs.readFile);
+// Always excluded from the upload archive. Added before user patterns so a
+// user can re-include any of them with a negation (e.g. `!node_modules`).
+const DEFAULT_IGNORES = ['.git', 'node_modules', '.venv', '__pycache__', 'service.zip'];
 export async function createIgnoreFileChecker(filePath = process.cwd()) {
-    const ignoreFilePath = path.join(filePath, '.dockerignore');
-    if (!fs.existsSync(ignoreFilePath)) {
-        return () => false;
+    const ig = ignore().add(DEFAULT_IGNORES);
+    const ignoreFilePath = path.join(filePath, '.qhubignore');
+    if (fs.existsSync(ignoreFilePath)) {
+        const ignoreFileContents = await readFile(ignoreFilePath, 'utf8');
+        ig.add(ignoreFileContents.split('\n'));
     }
-    const ignoreFileContents = await readFile(ignoreFilePath, 'utf8');
-    const ig = ignore().add(ignoreFileContents.split('\n'));
-    ig.add('service.zip');
     return (fullPath) => ig.ignores(fullPath);
 }

package/dist/lib/up/required-files.d.ts

@@ -0,0 +1,8 @@
+export interface RequiredFilesResult {
+    skipped: boolean;
+    runtimeMissing: boolean;
+    missing: string[];
+    excluded: string[];
+}
+export declare function evaluateRequiredFiles(workingDirectory: string): Promise<RequiredFilesResult>;
+export declare function enforceRequiredFiles(workingDirectory: string): Promise<void>;

package/dist/lib/up/required-files.js

@@ -0,0 +1,48 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { Runtime } from '../../model/managed-service-config.js';
+import { readServiceConfig } from '../../service/service-config-service.js';
+import { createIgnoreFileChecker } from './ignore.js';
+import { warn } from '../output.js';
+const REQUIRED_FILES = {
+    [Runtime.DOCKER]: ['Dockerfile'],
+    [Runtime.PYTHON_TEMPLATE]: ['requirements.txt', 'src/program.py'],
+};
+export async function evaluateRequiredFiles(workingDirectory) {
+    const result = { skipped: false, runtimeMissing: false, missing: [], excluded: [] };
+    if (!fs.existsSync(path.join(workingDirectory, 'qhub.json'))) {
+        result.skipped = true;
+        return result;
+    }
+    const { runtime } = readServiceConfig(workingDirectory);
+    if (!runtime) {
+        result.runtimeMissing = true;
+        return result;
+    }
+    const required = REQUIRED_FILES[runtime] ?? [];
+    const isIgnored = await createIgnoreFileChecker(workingDirectory);
+    for (const file of required) {
+        const onDisk = fs.existsSync(path.join(workingDirectory, file));
+        if (onDisk && isIgnored(file)) {
+            result.excluded.push(file);
+        }
+        else if (!onDisk) {
+            result.missing.push(file);
+        }
+    }
+    return result;
+}
+export async function enforceRequiredFiles(workingDirectory) {
+    const { runtimeMissing, missing, excluded } = await evaluateRequiredFiles(workingDirectory);
+    if (runtimeMissing) {
+        warn('No "runtime" set in qhub.json; skipping required-file validation.');
+        return;
+    }
+    if (missing.length > 0) {
+        warn(`Required file(s) missing for the configured runtime: ${missing.join(', ')}`);
+    }
+    if (excluded.length > 0) {
+        throw new Error(`Required file(s) are present but excluded by .qhubignore: ${excluded.join(', ')}. ` +
+            `Re-include them with a negation (e.g. "!Dockerfile").`);
+    }
+}

package/dist/model/managed-service-config.d.ts

@@ -8,7 +8,6 @@ export default interface ManagedServiceConfig {
 }
 export declare enum Runtime {
     DOCKER = "DOCKER",
-    PYTHON = "PYTHON",
     PYTHON_TEMPLATE = "PYTHON_TEMPLATE"
 }
 export interface ResourceConfiguration {

package/dist/model/managed-service-config.js

@@ -1,7 +1,6 @@
 export var Runtime;
 (function (Runtime) {
     Runtime["DOCKER"] = "DOCKER";
-    Runtime["PYTHON"] = "PYTHON";
     Runtime["PYTHON_TEMPLATE"] = "PYTHON_TEMPLATE";
 })(Runtime || (Runtime = {}));
 export var GpuType;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quantum-hub/qhubctl",
-  "version": "1.19.1",
+  "version": "2.0.0",
   "description": "Kipu Quantum Hub CLI",
   "author": "Kipu Quantum GmbH",
   "contributors": [