@pd4castr/cli 0.0.11 → 0.0.12

package/README.md

@@ -1,6 +1,6 @@
 # pd4castr CLI
 
-CLI tool for creating, testing, and publishing pd4castr models.
+CLI tool for creating, testing, and publishing [pd4castr](https://pdview.com.au/services/pd4castr/) models.
 
 Install via:
 
@@ -8,41 +8,34 @@ Install via:
 npm install -g @pd4castr/cli
 ```
 
-## Contributing
+Read the [full documentation here](https://github.com/pipelabs/pd4castr-model-examples/)
 
-### Quick Start
+## Quick Usage
 
-```bash
-# set this repository up for linking during develpment
-yarn link
+Authenticate with the pd4castr API
 
-# run the project in watch mode
-yarn dev
+```sh
+pd4castr login
+```
 
-# from a model project, link the module
-# ex. https://github.com/pipelabs/pd4castr-model-examples/tree/main/examples/python-demo
-yarn link @pd4castr/cli
+Run model input data fetchers and generate test input data
 
-# from that project, execute a command
-yarn pd4castr <command>
+```sh
+pd4castr fetch
 ```
 
-### Scripts
+Run your model locally and verify it reads inputs & uploads output as expected
 
-- `yarn build` - Build the project
-- `yarn dev` - Watch mode for development
-- `yarn cli <command>` - Run CLI commands against local build
-- `yarn test` - Run tests once
-- `yarn test:watch` - Run tests in watch mode
-- `yarn lint` - Check for linting issues
-- `yarn format` - Format code with Prettier
-- `yarn type-check` - TypeScript type checking
+```sh
+pd4castr test
+```
 
-### Testing
+Publish your model to the pd4castr platform
 
-As this project requires a lot of disk I/O and network reqeuests, we opt for 2 mocking solutions that keep us as close to the metal as possible:
+```sh
+pd4castr publish
+```
 
-- network requests are mocked uses [msw](https://mswjs.io/) - request handlers live in the [mocks/handlers](./src/mocks/handlers/) folder
-- disk I/O (`fs`) is mocked using [`memfs`](https://github.com/streamich/memfs) which is handled by Vitest in our [`__mocks__/`](./src/__mocks__) folder
+## Contributing
 
-Both of these mocks are initialised globally via our [setup script](./vitest.setup.ts).
+For development docs, check [CONTRIBUTING.MD](./CONTRIBUTING.md)

package/dist/index.js

@@ -626,7 +626,7 @@ async function startWebServer(app, port) {
 
 // src/commands/publish/handle-create-model-flow.ts
 import * as inquirer2 from "@inquirer/prompts";
-import chalk2 from "chalk";
+import chalk3 from "chalk";
 
 // src/api/create-model.ts
 async function createModel(config, authCtx) {
@@ -667,10 +667,14 @@ async function updateProjectConfig(updateFn) {
 import { execa } from "execa";
 async function buildDockerImage(dockerImage, ctx) {
   try {
-    await execa("docker", ["build", "-t", dockerImage, "."], {
-      cwd: ctx.projectRoot,
-      stdio: "pipe"
-    });
+    await execa(
+      "docker",
+      ["build", "--platform=linux/amd64", "-t", dockerImage, "."],
+      {
+        cwd: ctx.projectRoot,
+        stdio: "pipe"
+      }
+    );
   } catch (error) {
     throw new Error("Failed to build docker image", { cause: error });
   }
@@ -771,19 +775,27 @@ function logEmptyLine() {
   console.log("");
 }
 
-// src/commands/publish/utils/get-model-summary-lines.ts
+// src/commands/publish/constants.ts
 import chalk from "chalk";
+var MODEL_RUN_TRIGGER_MESSAGE = `${chalk.whiteBright.bold("NOTE!")} If you do not see your model output in the pd4castr UI:
+
+\u2022 If you are using static inputs - check you have uploaded your input data to your input bucket
+\u2022 If you are using inputs with data fetchers - wait a few minutes and check again
+`;
+
+// src/commands/publish/utils/get-model-summary-lines.ts
+import chalk2 from "chalk";
 function getModelSummaryLines(ctx) {
   return [
-    `	${chalk.bold("Model name:")} ${ctx.config.name}`,
-    `	${chalk.bold("Revision:")} ${ctx.config.$$revision}`,
-    `	${chalk.bold("Forecast variable:")} ${ctx.config.forecastVariable}`,
-    `	${chalk.bold("Time horizon:")} ${ctx.config.timeHorizon}`,
-    `	${chalk.bold("Inputs:")}`,
+    `	${chalk2.bold("Model name:")} ${ctx.config.name}`,
+    `	${chalk2.bold("Revision:")} ${ctx.config.$$revision}`,
+    `	${chalk2.bold("Forecast variable:")} ${ctx.config.forecastVariable}`,
+    `	${chalk2.bold("Time horizon:")} ${ctx.config.timeHorizon}`,
+    `	${chalk2.bold("Inputs:")}`,
     ...ctx.config.inputs.map(
       (input2) => `	\u2022 ${input2.key} - ${getInputType(input2)}`
     ),
-    `	${chalk.bold("Outputs:")}`,
+    `	${chalk2.bold("Outputs:")}`,
     ...ctx.config.outputs.map((output) => `	\u2022 ${output.name} - ${output.type}`),
     ""
   ];
@@ -973,7 +985,7 @@ async function runModelIOTests(dockerImage, options, app, ctx) {
 
 // src/commands/publish/handle-create-model-flow.ts
 async function handleCreateModelFlow(options, app, spinner, ctx, authCtx) {
-  spinner.info(`You are publishing a ${chalk2.bold("new")} model:
+  spinner.info(`You are publishing a ${chalk3.bold("new")} model:
 `);
   getModelSummaryLines(ctx).map((line) => console.log(line));
   const confirm4 = await inquirer2.confirm({
@@ -1009,29 +1021,34 @@ async function handleCreateModelFlow(options, app, spinner, ctx, authCtx) {
   await pushDockerImage(dockerImage, model.dockerImage);
   spinner.succeed("Model image pushed to reogistry successfully");
   spinner.start("Triggering model run...");
-  try {
-    await triggerModelRun(model.id, authCtx);
-    spinner.succeed("Model run triggered successfully");
-  } catch {
-    spinner.warn(`Failed to trigger model run
-     If you use static inputs, make sure you have uploaded it to your input bucket
-     If you use inputs with data fetchers, your model will run when they have fetched new data`);
+  let modelRunTriggered = false;
+  if (!options.skipTrigger) {
+    try {
+      await triggerModelRun(model.id, authCtx);
+      spinner.succeed("Model run triggered successfully");
+      modelRunTriggered = true;
+    } catch {
+      spinner.info("Model run did not trigger");
+    }
   }
   spinner.stopAndPersist({
     symbol: "\u{1F680} ",
     prefixText: "\n",
     suffixText: "\n",
-    text: chalk2.bold(`${model.name} r${model.revision} published successfully`)
+    text: chalk3.bold(`${model.name} r${model.revision} published successfully`)
   });
+  if (!modelRunTriggered && !options.skipTrigger) {
+    console.log(MODEL_RUN_TRIGGER_MESSAGE);
+  }
 }
 
 // src/commands/publish/handle-update-existing-model-flow.ts
 import * as inquirer5 from "@inquirer/prompts";
-import chalk5 from "chalk";
+import chalk6 from "chalk";
 
 // src/commands/publish/handle-model-revision-create-flow.ts
 import * as inquirer3 from "@inquirer/prompts";
-import chalk3 from "chalk";
+import chalk4 from "chalk";
 
 // src/commands/publish/utils/validate-local-model-state.ts
 import invariant2 from "tiny-invariant";
@@ -1060,7 +1077,7 @@ async function validateLocalModelState(ctx, authCtx) {
 }
 
 // src/commands/publish/handle-model-revision-create-flow.ts
-var WARNING_LABEL = chalk3.yellowBright.bold("WARNING!");
+var WARNING_LABEL = chalk4.yellowBright.bold("WARNING!");
 var CONFIRMATION_MESSAGE = `${WARNING_LABEL} Creating a new revision will preserve existing revisions.
 Previous revisions will still be available in the pd4castr UI.
 `;
@@ -1102,27 +1119,32 @@ async function handleModelRevisionCreateFlow(options, app, spinner, ctx, authCtx
   await pushDockerImage(dockerImage, model.dockerImage);
   spinner.succeed("New model revision image pushed to registry successfully");
   spinner.start("Triggering model run...");
-  try {
-    await triggerModelRun(model.id, authCtx);
-    spinner.succeed("Model run triggered successfully");
-  } catch {
-    spinner.warn(`Failed to trigger model run
-     If you use static inputs, make sure you have uploaded it to your input bucket
-     If you use inputs with data fetchers, your model will run when they have fetched new data`);
+  let modelRunTriggered = false;
+  if (!options.skipTrigger) {
+    try {
+      await triggerModelRun(model.id, authCtx);
+      spinner.succeed("Model run triggered successfully");
+      modelRunTriggered = true;
+    } catch {
+      spinner.info("Model run did not trigger");
+    }
   }
   spinner.stopAndPersist({
     symbol: "\u{1F680} ",
     prefixText: "\n",
     suffixText: "\n",
-    text: chalk3.bold(
+    text: chalk4.bold(
       `New model revision (r${model.revision}) published successfully`
     )
   });
+  if (!modelRunTriggered && !options.skipTrigger) {
+    console.log(MODEL_RUN_TRIGGER_MESSAGE);
+  }
 }
 
 // src/commands/publish/handle-model-revision-update-flow.ts
 import * as inquirer4 from "@inquirer/prompts";
-import chalk4 from "chalk";
+import chalk5 from "chalk";
 
 // src/api/update-model.ts
 async function updateModel(config, authCtx) {
@@ -1132,7 +1154,7 @@ async function updateModel(config, authCtx) {
 }
 
 // src/commands/publish/handle-model-revision-update-flow.ts
-var WARNING_LABEL2 = chalk4.yellowBright.bold("WARNING!");
+var WARNING_LABEL2 = chalk5.yellowBright.bold("WARNING!");
 var CONFIRMATION_MESSAGE2 = `${WARNING_LABEL2} Updating a model revision recreates the associated inputs and outputs.
 Historical data is preserved, but it will no longer be displayed in the pd4castr UI.
 `;
@@ -1174,25 +1196,30 @@ async function handleModelRevisionUpdateFlow(options, app, spinner, ctx, authCtx
   await pushDockerImage(dockerImage, model.dockerImage);
   spinner.succeed("Updated model image pushed to registry successfully");
   spinner.start("Triggering model run...");
-  try {
-    await triggerModelRun(model.id, authCtx);
-    spinner.succeed("Model run triggered successfully");
-  } catch {
-    spinner.warn(`Failed to trigger model run
-     If you use static inputs, make sure you have uploaded it to your input bucket
-     If you use inputs with data fetchers, your model will run when they have fetched new data`);
+  let modelRunTriggered = false;
+  if (!options.skipTrigger) {
+    try {
+      await triggerModelRun(model.id, authCtx);
+      spinner.succeed("Model run triggered successfully");
+      modelRunTriggered = true;
+    } catch {
+      spinner.info("Model run did not trigger");
+    }
   }
   spinner.stopAndPersist({
     symbol: "\u{1F680} ",
     prefixText: "\n",
     suffixText: "\n",
-    text: chalk4.bold(`${model.name} (r${model.revision}) updated successfully`)
+    text: chalk5.bold(`${model.name} (r${model.revision}) updated successfully`)
   });
+  if (!modelRunTriggered && !options.skipTrigger) {
+    console.log(MODEL_RUN_TRIGGER_MESSAGE);
+  }
 }
 
 // src/commands/publish/handle-update-existing-model-flow.ts
 async function handleUpdateExistingModelFlow(options, app, spinner, ctx, authCtx) {
-  spinner.info(`You are publishing an ${chalk5.bold("existing")} model:
+  spinner.info(`You are publishing an ${chalk6.bold("existing")} model:
 `);
   getModelSummaryLines(ctx).map((line) => console.log(line));
   const revision = ctx.config.$$revision ?? 0;
@@ -1266,7 +1293,7 @@ function registerPublishCommand(program2) {
     "-p, --port <port>",
     "The port to run the IO testing webserver on",
     TEST_WEBSERVER_PORT.toString()
-  ).option("-s, --skip-checks", "Skip the model I/O checks", false).action(handleAction5);
+  ).option("--sc, --skip-checks", "Skip the model I/O checks", false).option("--st, --skip-trigger", "Skip the model trigger", false).action(handleAction5);
 }
 
 // src/commands/test/handle-action.ts
@@ -1367,7 +1394,7 @@ import { Command } from "commander";
 // package.json
 var package_default = {
   name: "@pd4castr/cli",
-  version: "0.0.11",
+  version: "0.0.12",
   description: "CLI tool for creating, testing, and publishing pd4castr models",
   main: "dist/index.js",
   type: "module",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pd4castr/cli",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "description": "CLI tool for creating, testing, and publishing pd4castr models",
   "main": "dist/index.js",
   "type": "module",