Merge branch 'ian/support-console-date'

Author: ianmacartney

.gitignore

@@ -16,3 +16,4 @@ node_modules
 frontend/package.json
 # npm pack output
 *.tgz
+*.tsbuildinfo

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 0.2.7 alpha
+
+- Support for console logging & timing in workflows
+- Support for Date.now() in workflows
+- Batches the call to start steps
+- Adds the workflow name to the workpool execution for observability
+- Logs any error that shows up in the workflow body
+- Will call onComplete for Workflows with startAsync that fail
+  on their first invocation.
+- Increases the max journal size from 1MB to 8MB
+- Adds the WorkflowId type to step.workflowId
+
 ## 0.2.6
 
 - Allow calling components directly from steps

CONTRIBUTING.md

@@ -3,48 +3,37 @@
 ## Running locally
 
 ```sh
-npm i
-cd example
-npm i
-npx convex dev
+npm run setup
+npm run dev
 ```
 
 ## Testing
 
 ```sh
-rm -rf dist/ && npm run build
+npm run clean
 npm run typecheck
-npm run test
-cd example
 npm run lint
-cd ..
+npm run test
 ```
 
 ## Deploying
 
 ### Building a one-off package
 
 ```sh
-rm -rf dist/ && npm run build
+npm run clean
+npm run build
 npm pack
 ```
 
 ### Deploying a new version
 
 ```sh
-# this will change the version and commit it (if you run it in the root directory)
-npm version patch
-npm publish --dry-run
-# sanity check files being included
-npm publish
-git push --tags
+npm run release
 ```
 
 #### Alpha release
 
-The same as above, but it requires extra flags so the release is only installed with `@alpha`:
-
 ```sh
-npm version prerelease --preid alpha
-npm publish --tag alpha
+npm run alpha
 ```

README.md

@@ -22,7 +22,7 @@ Welcome to the world of Convex workflows.
 - Output from previous steps is available to pass to subsequent steps.
 - Run queries, mutations, and actions.
 - Specify retry behavior on a per-step basis, along with a default policy.
-- Specify how many workflows can run in parallel to manage load.
+- Specify how many workflow steps can run in parallel to manage load.
 - Cancel long-running workflows.
 - Clean up workflows after they're done.
 
@@ -447,10 +447,8 @@ Here are a few limitations to keep in mind:
   mutation apply and limit the number and size of steps you can perform to 16MiB
   (including the workflow state overhead). See more about mutation limits here:
   https://docs.convex.dev/production/state/limits#transactions
-- `console.log()` isn't currently captured, so you may see duplicate log lines
-  within your Convex dashboard if you log within the workflow definition.
 - We currently do not collect backtraces from within function calls from workflows.
-- If you need to use side effects like `fetch`, `Math.random()`, or `Date.now()`,
+- If you need to use side effects like `fetch` or use randomness,
   you'll need to do that in a step, not in the workflow definition.
 - If the implementation of the workflow meaningfully changes (steps added,
   removed, or reordered) then it will fail with a determinism violation.

convex.json

@@ -0,0 +1,3 @@
+{
+  "functions": "example/convex"
+}

example/.gitignore

@@ -91,31 +91,32 @@ export declare const components: {
           };
         }
       >;
-      startStep: FunctionReference<
+      startSteps: FunctionReference<
         "mutation",
         "internal",
         {
           generationNumber: number;
-          name: string;
-          retry?:
-            | boolean
-            | { base: number; initialBackoffMs: number; maxAttempts: number };
-          schedulerOptions?: { runAt?: number } | { runAfter?: number };
-          step: {
-            args: any;
-            argsSize: number;
-            completedAt?: number;
-            functionType: "query" | "mutation" | "action";
-            handle: string;
-            inProgress: boolean;
-            name: string;
-            runResult?:
-              | { kind: "success"; returnValue: any }
-              | { error: string; kind: "failed" }
-              | { kind: "canceled" };
-            startedAt: number;
-            workId?: string;
-          };
+          steps: Array<{
+            retry?:
+              | boolean
+              | { base: number; initialBackoffMs: number; maxAttempts: number };
+            schedulerOptions?: { runAt?: number } | { runAfter?: number };
+            step: {
+              args: any;
+              argsSize: number;
+              completedAt?: number;
+              functionType: "query" | "mutation" | "action";
+              handle: string;
+              inProgress: boolean;
+              name: string;
+              runResult?:
+                | { kind: "success"; returnValue: any }
+                | { error: string; kind: "failed" }
+                | { kind: "canceled" };
+              startedAt: number;
+              workId?: string;
+            };
+          }>;
           workflowId: string;
           workpoolOptions?: {
             defaultRetryBehavior?: {
@@ -128,7 +129,7 @@ export declare const components: {
             retryActionsByDefault?: boolean;
           };
         },
-        {
+        Array<{
           _creationTime: number;
           _id: string;
           step: {
@@ -148,7 +149,7 @@ export declare const components: {
           };
           stepNumber: number;
           workflowId: string;
-        }
+        }>
       >;
     };
     workflow: {

example/convex/_generated/api.d.ts

@@ -28,13 +28,16 @@ export const exampleWorkflow = workflow.define({
     windSpeed: number;
     windGust: number;
   }> => {
+    console.time("overall");
+    console.time("geocoding");
     // Run in parallel!
     const [{ latitude, longitude, name }, weather2] = await Promise.all([
       step.runAction(internal.example.getGeocoding, args, { runAfter: 100 }),
       step.runAction(internal.example.getGeocoding, args, { retry: true }),
     ]);
     console.log("Is geocoding is consistent?", latitude === weather2.latitude);
-
+    console.timeLog("geocoding", name);
+    console.time("weather");
     const weather = await step.runAction(internal.example.getWeather, {
       latitude,
       longitude,
@@ -45,6 +48,12 @@ export const exampleWorkflow = workflow.define({
     console.log(
       `Weather in ${name}: ${farenheit.toFixed(1)}°F (${temperature}°C), ${windSpeed} km/h, ${windGust} km/h`,
     );
+    console.timeLog("weather", temperature);
+    await step.runMutation(internal.example.updateFlow, {
+      workflowId: step.workflowId,
+      out: { name, celsius, farenheit, windSpeed, windGust },
+    });
+    console.timeEnd("overall");
     return { name, celsius, farenheit, windSpeed, windGust };
   },
   workpoolOptions: {
@@ -109,7 +118,8 @@ export const flowCompleted = internalMutation({
     await ctx.db.patch(flow._id, {
       out: args.result,
     });
-    await workflow.cleanup(ctx, args.workflowId);
+    // To delete the workflow data after it completes:
+    // await workflow.cleanup(ctx, args.workflowId);
   },
 });
 

example/convex/example.ts

@@ -5,10 +5,10 @@ import schema from "./schema";
 export const modules = import.meta.glob("./**/*.*s");
 
 // Sorry about everything
-import componentSchema from "../node_modules/@convex-dev/workflow/src/component/schema";
+import componentSchema from "../../node_modules/@convex-dev/workflow/src/component/schema";
 export { componentSchema };
 export const componentModules = import.meta.glob(
-  "../node_modules/@convex-dev/workflow/src/component/**/*.ts",
+  "../../node_modules/@convex-dev/workflow/src/component/**/*.ts",
 );
 
 export function initConvexTest() {