Add schedules sample (temporalio#221)

msjaber · Jan 13, 2023 · 8a7c796 · 8a7c796
1 parent 33b1658
commit 8a7c796
Show file tree

Hide file tree

Showing 87 changed files with 561 additions and 279 deletions.
diff --git a/.scripts/copy-shared-files.mjs b/.scripts/copy-shared-files.mjs
@@ -33,6 +33,7 @@ const ESLINTRC_EXCLUDE = [
 const ESLINTIGNORE_EXCLUDE = ['production', 'hello-world-js', 'protobufs', 'activities-examples', 'nestjs-counter'];
 
 const POST_CREATE_EXCLUDE = [
+  'schedules',
   'timer-examples',
   'query-subscriptions',
   'nextjs-ecommerce-oneclick',
@@ -45,6 +46,7 @@ const POST_CREATE_EXCLUDE = [
   'activities-cancellation-heartbeating',
   'nestjs-counter',
   'replay-history',
+  'search-attributes',
 ];
 
 const FILES = [

diff --git a/.scripts/list-of-samples.json b/.scripts/list-of-samples.json
@@ -28,6 +28,7 @@
     "query-subscriptions",
     "replay-history",
     "saga",
+    "schedules",
     "search-attributes",
     "signals-queries",
     "sinks",

diff --git a/.shared/.post-create b/.shared/.post-create
@@ -1,15 +1,13 @@
-To begin development, install Docker:
+To begin development, install the Temporal CLI:
 
-  Mac: {cyan brew cask install docker; open} /Applications/Docker.app
-  Other: https://www.docker.com/products/docker-desktop
+  Mac: {cyan brew install temporal}
+  Other: Download and extract the latest release from https://github.com/temporalio/cli/releases/latest
 
 Start Temporal Server:
 
-  {cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
-  {cyan cd} temporal-server/
-  {cyan docker-compose up}
+  {cyan temporal server start-dev}
 
-Use Node version 14+:
+Use Node version 16+:
 
   Mac: {cyan brew install node@16}
   Other: https://nodejs.org/en/download/

diff --git a/README.md b/README.md
@@ -44,7 +44,7 @@ cd temporal
 docker-compose up -d
 ```
 
-Use Node version 14+:
+Use Node version 16+:
 
 - Install Node 16:
   - Mac: `brew install node@16`
@@ -115,7 +115,8 @@ and you'll be given the list of sample options.
   - [**Mutex**](https://github.com/temporalio/samples-typescript/tree/main/mutex): Workflows send Signals to each other in this example of `lockWorkflow` acting as a mutex.
   - [**State**](https://github.com/temporalio/samples-typescript/tree/main/state): The Workflow maintains state in a `Map<string, number>`, and the state can be updated and read via a Signal and a Query.
   - **Async activity completion**: Example of an [**Expense reporting**](https://github.com/temporalio/samples-typescript/tree/main/expense) Workflow that communicates with a server API. Shows how to kick off a Workflow and manually complete it at an arbitrarily later date.
-- [**Cron Workflows**](https://github.com/temporalio/samples-typescript/tree/main/cron-workflows): Schedule a cron job.
+- [**Schedules**](https://github.com/temporalio/samples-typescript/tree/main/schedules): Schedule Workflows.
+- [**Cron Workflows**](https://github.com/temporalio/samples-typescript/tree/main/cron-workflows): Schedule a cron job. _DEPRECATED: use [Schedules](https://github.com/temporalio/samples-typescript/tree/main/schedules) instead._
 - [**Child Workflows**](https://github.com/temporalio/samples-typescript/tree/main/child-workflows): Start and control Child Workflows.
 - [**Infinite Workflows**](https://github.com/temporalio/samples-typescript/tree/main/continue-as-new): Use the `continueAsNew` API for indefinitely long running Workflows.
 - [**Search Attributes**](https://github.com/temporalio/samples-typescript/tree/main/search-attributes): Create, set, upsert, and read Search Attributes.

diff --git a/activities-cancellation-heartbeating/.post-create b/activities-cancellation-heartbeating/.post-create
@@ -1,15 +1,13 @@
-To begin development, install Docker:
+To begin development, install the Temporal CLI:
 
-  Mac: {cyan brew cask install docker; open} /Applications/Docker.app
-  Other: https://www.docker.com/products/docker-desktop
+  Mac: {cyan brew install temporal}
+  Other: Download and extract the latest release from https://github.com/temporalio/cli/releases/latest
 
 Start Temporal Server:
 
-  {cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
-  {cyan cd} temporal-server/
-  {cyan docker-compose up}
+  {cyan temporal server start-dev}
 
-Use Node version 14+:
+Use Node version 16+:
 
   Mac: {cyan brew install node@16}
   Other: https://nodejs.org/en/download/

diff --git a/activities-cancellation-heartbeating/README.md b/activities-cancellation-heartbeating/README.md
@@ -24,7 +24,7 @@ Running [`src/client.ts`](./src/client.ts) does this:
 
 ### Running this sample
 
-1. Make sure Temporal Server is running locally (see the [Dev guide](https://docs.temporal.io/application-development/foundations#run-a-development-cluster)).
+1. `temporal server start-dev` to start [Temporal Server](https://github.com/temporalio/cli/#installation).
 2. `npm install` to install dependencies.
 3. `npm run start` to start the Worker.
 4. In another shell, `npm run workflow` to run the Workflow.

diff --git a/activities-dependency-injection/.post-create b/activities-dependency-injection/.post-create
@@ -1,15 +1,13 @@
-To begin development, install Docker:
+To begin development, install the Temporal CLI:
 
-  Mac: {cyan brew cask install docker; open} /Applications/Docker.app
-  Other: https://www.docker.com/products/docker-desktop
+  Mac: {cyan brew install temporal}
+  Other: Download and extract the latest release from https://github.com/temporalio/cli/releases/latest
 
 Start Temporal Server:
 
-  {cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
-  {cyan cd} temporal-server/
-  {cyan docker-compose up}
+  {cyan temporal server start-dev}
 
-Use Node version 14+:
+Use Node version 16+:
 
   Mac: {cyan brew install node@16}
   Other: https://nodejs.org/en/download/

diff --git a/activities-dependency-injection/README.md b/activities-dependency-injection/README.md
@@ -6,7 +6,7 @@ This sample shows how to [share dependencies](https://docs.temporal.io/applicati
 
 ### Running this sample
 
-1. Make sure Temporal Server is running locally (see the [quick install guide](https://docs.temporal.io/application-development/foundations#run-a-development-cluster)).
+1. `temporal server start-dev` to start [Temporal Server](https://github.com/temporalio/cli/#installation).
 2. `npm install` to install dependencies.
 3. `npm run start.watch` to start the Worker.
 4. In another shell, `npm run workflow` to run the Workflow.

diff --git a/activities-examples/.post-create b/activities-examples/.post-create
@@ -1,15 +1,13 @@
-To begin development, install Docker:
+To begin development, install the Temporal CLI:
 
-  Mac: {cyan brew cask install docker; open} /Applications/Docker.app
-  Other: https://www.docker.com/products/docker-desktop
+  Mac: {cyan brew install temporal}
+  Other: Download and extract the latest release from https://github.com/temporalio/cli/releases/latest
 
 Start Temporal Server:
 
-  {cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
-  {cyan cd} temporal-server/
-  {cyan docker-compose up}
+  {cyan temporal server start-dev}
 
-Use Node version 14+:
+Use Node version 16+:
 
   Mac: {cyan brew install node@16}
   Other: https://nodejs.org/en/download/

diff --git a/activities-examples/README.md b/activities-examples/README.md
@@ -17,7 +17,7 @@ More Activity samples are [listed here](https://github.com/temporalio/samples-ty
 
 ### Running this sample
 
-1. Make sure Temporal Server is running locally (see the [quick install guide](https://docs.temporal.io/application-development/foundations#run-a-development-cluster)).
+1. `temporal server start-dev` to start [Temporal Server](https://github.com/temporalio/cli/#installation).
 2. `npm install` to install dependencies.
 3. `npm run start.watch` to start the Worker.
 4. In another shell, `npm run workflow` to run the Workflow.

diff --git a/activities-sticky-queues/.post-create b/activities-sticky-queues/.post-create
@@ -1,15 +1,13 @@
-To begin development, install Docker:
+To begin development, install the Temporal CLI:
 
-  Mac: {cyan brew cask install docker; open} /Applications/Docker.app
-  Other: https://www.docker.com/products/docker-desktop
+  Mac: {cyan brew install temporal}
+  Other: Download and extract the latest release from https://github.com/temporalio/cli/releases/latest
 
 Start Temporal Server:
 
-  {cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
-  {cyan cd} temporal-server/
-  {cyan docker-compose up}
+  {cyan temporal server start-dev}
 
-Use Node version 14+:
+Use Node version 16+:
 
   Mac: {cyan brew install node@16}
   Other: https://nodejs.org/en/download/

diff --git a/activities-sticky-queues/README.md b/activities-sticky-queues/README.md
@@ -14,7 +14,7 @@ Activities have been artificially slowed with `activity.Context().sleep(3000)` t
 
 ### Running this sample
 
-1. Make sure Temporal Server is running locally (see the [quick install guide](https://docs.temporal.io/application-development/foundations#run-a-development-cluster)).
+1. `temporal server start-dev` to start [Temporal Server](https://github.com/temporalio/cli/#installation).
 1. `npm install` to install dependencies.
 1. `npm run start.watch` to start the Worker.
 1. In another shell, `npm run workflow` to run the Workflow.

diff --git a/child-workflows/.post-create b/child-workflows/.post-create
@@ -1,15 +1,13 @@
-To begin development, install Docker:
+To begin development, install the Temporal CLI:
 
-  Mac: {cyan brew cask install docker; open} /Applications/Docker.app
-  Other: https://www.docker.com/products/docker-desktop
+  Mac: {cyan brew install temporal}
+  Other: Download and extract the latest release from https://github.com/temporalio/cli/releases/latest
 
 Start Temporal Server:
 
-  {cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
-  {cyan cd} temporal-server/
-  {cyan docker-compose up}
+  {cyan temporal server start-dev}
 
-Use Node version 14+:
+Use Node version 16+:
 
   Mac: {cyan brew install node@16}
   Other: https://nodejs.org/en/download/

diff --git a/child-workflows/README.md b/child-workflows/README.md
@@ -6,7 +6,7 @@ This sample shows how to use [Child Workflows](https://docs.temporal.io/applicat
 
 ### Running this sample
 
-1. Make sure Temporal Server is running locally (see the [quick install guide](https://docs.temporal.io/application-development/foundations#run-a-development-cluster)).
+1. `temporal server start-dev` to start [Temporal Server](https://github.com/temporalio/cli/#installation).
 2. `npm install` to install dependencies.
 3. `npm run start.watch` to start the Worker.
 4. In another shell, `npm run workflow` to run the Workflow.

diff --git a/continue-as-new/.post-create b/continue-as-new/.post-create
@@ -1,15 +1,13 @@
-To begin development, install Docker:
+To begin development, install the Temporal CLI:
 
-  Mac: {cyan brew cask install docker; open} /Applications/Docker.app
-  Other: https://www.docker.com/products/docker-desktop
+  Mac: {cyan brew install temporal}
+  Other: Download and extract the latest release from https://github.com/temporalio/cli/releases/latest
 
 Start Temporal Server:
 
-  {cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
-  {cyan cd} temporal-server/
-  {cyan docker-compose up}
+  {cyan temporal server start-dev}
 
-Use Node version 14+:
+Use Node version 16+:
 
   Mac: {cyan brew install node@16}
   Other: https://nodejs.org/en/download/

diff --git a/continue-as-new/README.md b/continue-as-new/README.md
@@ -4,7 +4,7 @@ This sample demonstrates the [continueAsNew API](https://docs.temporal.io/applic
 
 ### Running this sample
 
-1. Make sure Temporal Server is running locally (see the [quick install guide](https://docs.temporal.io/application-development/foundations#run-a-development-cluster)).
+1. `temporal server start-dev` to start [Temporal Server](https://github.com/temporalio/cli/#installation).
 2. `npm install` to install dependencies.
 3. `npm run start.watch` to start the Worker.
 4. In another shell, `npm run workflow` to run the Workflow.

diff --git a/cron-workflows/.post-create b/cron-workflows/.post-create
@@ -1,15 +1,13 @@
-To begin development, install Docker:
+To begin development, install the Temporal CLI:
 
-  Mac: {cyan brew cask install docker; open} /Applications/Docker.app
-  Other: https://www.docker.com/products/docker-desktop
+  Mac: {cyan brew install temporal}
+  Other: Download and extract the latest release from https://github.com/temporalio/cli/releases/latest
 
 Start Temporal Server:
 
-  {cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
-  {cyan cd} temporal-server/
-  {cyan docker-compose up}
+  {cyan temporal server start-dev}
 
-Use Node version 14+:
+Use Node version 16+:
 
   Mac: {cyan brew install node@16}
   Other: https://nodejs.org/en/download/

diff --git a/cron-workflows/README.md b/cron-workflows/README.md
@@ -1,6 +1,8 @@
 # Cron Workflows
 
-This example demonstrates a working Cron workflow. Note the limitations and caveats listed in the [docs](https://docs.temporal.io/workflows/#temporal-cron-job).
+_DEPRECATED: use [Schedules](https://github.com/temporalio/samples-typescript/tree/main/schedules) instead._
+
+This example demonstrates a working Cron workflow. Note the limitations and caveats listed in the [docs](https://docs.temporal.io/content/what-is-a-temporal-cron-job/).
 
 Differences from the hello world demo:
 
@@ -17,7 +19,7 @@ Note that when we're changing code and restarting Workers, unless we cancel all
 
 ### Running this sample
 
-1. Make sure Temporal Server is running locally (see the [quick install guide](https://docs.temporal.io/application-development/foundations#run-a-development-cluster)).
+1. `temporal server start-dev` to start [Temporal Server](https://github.com/temporalio/cli/#installation).
 2. `npm install` to install dependencies.
 3. `npm run start.watch` to start the Worker.
 4. In another shell, `npm run workflow` to run the Workflow.

diff --git a/dsl-interpreter/.post-create b/dsl-interpreter/.post-create
@@ -1,15 +1,13 @@
-To begin development, install Docker:
+To begin development, install the Temporal CLI:
 
-  Mac: {cyan brew cask install docker; open} /Applications/Docker.app
-  Other: https://www.docker.com/products/docker-desktop
+  Mac: {cyan brew install temporal}
+  Other: Download and extract the latest release from https://github.com/temporalio/cli/releases/latest
 
 Start Temporal Server:
 
-  {cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
-  {cyan cd} temporal-server/
-  {cyan docker-compose up}
+  {cyan temporal server start-dev}
 
-Use Node version 14+:
+Use Node version 16+:
 
   Mac: {cyan brew install node@16}
   Other: https://nodejs.org/en/download/

diff --git a/dsl-interpreter/README.md b/dsl-interpreter/README.md
@@ -9,7 +9,7 @@ See also:
 
 ### Running this sample
 
-1. Make sure Temporal Server is running locally (see the [quick install guide](https://docs.temporal.io/application-development/foundations#run-a-development-cluster)).
+1. `temporal server start-dev` to start [Temporal Server](https://github.com/temporalio/cli/#installation).
 1. `npm install` to install dependencies.
 1. `npm run start.watch` to start the Worker.
 1. In another terminal, `npm run workflow1` or `npm run workflow2` to run the Workflows accordingly

diff --git a/ejson/.post-create b/ejson/.post-create
@@ -1,15 +1,13 @@
-To begin development, install Docker:
+To begin development, install the Temporal CLI:
 
-  Mac: {cyan brew cask install docker; open} /Applications/Docker.app
-  Other: https://www.docker.com/products/docker-desktop
+  Mac: {cyan brew install temporal}
+  Other: Download and extract the latest release from https://github.com/temporalio/cli/releases/latest
 
 Start Temporal Server:
 
-  {cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
-  {cyan cd} temporal-server/
-  {cyan docker-compose up}
+  {cyan temporal server start-dev}
 
-Use Node version 14+:
+Use Node version 16+:
 
   Mac: {cyan brew install node@16}
   Other: https://nodejs.org/en/download/

diff --git a/ejson/README.md b/ejson/README.md
@@ -38,7 +38,7 @@ export const payloadConverter = new CompositePayloadConverter(
 
 ### Running this sample
 
-1. Make sure Temporal Server is running locally (see the [quick install guide](https://docs.temporal.io/application-development/foundations#run-a-development-cluster)).
+1. `temporal server start-dev` to start [Temporal Server](https://github.com/temporalio/cli/#installation).
 1. `npm install` to install dependencies.
 1. `npm run start.watch` to start the Worker.
 1. In another shell, `npm run workflow` to run the Workflow Client.

diff --git a/encryption/.post-create b/encryption/.post-create
@@ -1,15 +1,13 @@
-To begin development, install Docker:
+To begin development, install the Temporal CLI:
 
-  Mac: {cyan brew cask install docker; open} /Applications/Docker.app
-  Other: https://www.docker.com/products/docker-desktop
+  Mac: {cyan brew install temporal}
+  Other: Download and extract the latest release from https://github.com/temporalio/cli/releases/latest
 
 Start Temporal Server:
 
-  {cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
-  {cyan cd} temporal-server/
-  {cyan docker-compose up}
+  {cyan temporal server start-dev}
 
-Use Node version 14+:
+Use Node version 16+:
 
   Mac: {cyan brew install node@16}
   Other: https://nodejs.org/en/download/

diff --git a/encryption/README.md b/encryption/README.md
@@ -23,7 +23,7 @@ The Payload Converter is supplied to the [client.ts](./src/client.ts) and [worke
 
 ## Running this sample
 
-1. Make sure Temporal Server is running locally (see the [quick install guide](https://docs.temporal.io/application-development/foundations#run-a-development-cluster)).
+1. `temporal server start-dev` to start [Temporal Server](https://github.com/temporalio/cli/#installation).
 1. `npm install` to install dependencies.
 1. `npm run start.watch` to start the Worker.
 1. In another shell, `npm run workflow` to run the Workflow Client.

diff --git a/expense/.post-create b/expense/.post-create
@@ -1,15 +1,13 @@
-To begin development, install Docker:
+To begin development, install the Temporal CLI:
 
-  Mac: {cyan brew cask install docker; open} /Applications/Docker.app
-  Other: https://www.docker.com/products/docker-desktop
+  Mac: {cyan brew install temporal}
+  Other: Download and extract the latest release from https://github.com/temporalio/cli/releases/latest
 
 Start Temporal Server:
 
-  {cyan git clone} https://github.com/temporalio/docker-compose.git temporal-server
-  {cyan cd} temporal-server/
-  {cyan docker-compose up}
+  {cyan temporal server start-dev}
 
-Use Node version 14+:
+Use Node version 16+:
 
   Mac: {cyan brew install node@16}
   Other: https://nodejs.org/en/download/