Add schedule example

closes #75

buf.yaml

@@ -3,6 +3,7 @@ modules:
   - path: examples/example/proto
   - path: examples/helloworld/proto
   - path: examples/mutex/proto
+  - path: examples/schedule/proto
   - path: examples/searchattributes/proto
   - path: examples/updatabletimer/proto
   - path: examples/xns/proto

docs/docs/examples/schedule.mdx

@@ -0,0 +1,32 @@
+import CodeBlock from '@theme/CodeBlock';
+import Proto from '!!raw-loader!../../../examples/schedule/proto/example/schedule/v1/schedule.proto';
+import Implementation from '!!raw-loader!../../../examples/schedule/main.go';
+
+
+# Schedule
+
+A simple example showcasing usage of proto workflwos with Temporal [schedules](https://temporal.io/blog/temporal-schedules-reliable-scalable-and-more-flexible-than-cron-jobs).
+
+<CodeBlock language="protobuf" title="example.proto">{Proto}</CodeBlock>
+
+<CodeBlock language="go" title="main.go">{Implementation}</CodeBlock>
+
+
+## Run this example
+
+1. Clone the examples
+    ```sh
+    git clone https://github.com/cludden/protoc-gen-go-temporal && cd protoc-gen-go-temporal
+    ```
+2. Start temporal
+    ```shell
+    temporal server start-dev
+    ```
+3. In a different terminal, run the worker
+    ```shell
+    go run ./examples/schedule/... worker
+    ```
+4. In a different terminal, create a schedule
+    ```shell
+    go run ./examples/schedule/... create-schedule
+    ```

docs/sidebars.ts

@@ -163,6 +163,11 @@ const sidebars: SidebarsConfig = {
       id: 'examples/mutex',
       label: 'Mutex'
     },
+    {
+      type: 'doc',
+      id: 'examples/schedule',
+      label: 'Schedule'
+    },
     {
       type: 'doc',
       id: 'examples/searchattributes',

examples/schedule/main.go

@@ -0,0 +1,100 @@
+package main
+
+import (
+	"fmt"
+	"log"
+	"os"
+	"time"
+
+	schedulev1 "github.com/cludden/protoc-gen-go-temporal/gen/example/schedule/v1"
+	"github.com/urfave/cli/v2"
+	"go.temporal.io/sdk/client"
+	"go.temporal.io/sdk/worker"
+	"go.temporal.io/sdk/workflow"
+	"google.golang.org/protobuf/types/known/timestamppb"
+)
+
+type (
+	Workflows struct{}
+
+	ScheduleWorkflow struct {
+		*schedulev1.ScheduleWorkflowInput
+	}
+)
+
+func main() {
+	app, err := schedulev1.NewExampleCli(
+		schedulev1.NewExampleCliOptions().
+			WithClient(withClient).
+			WithWorker(func(cmd *cli.Context, c client.Client) (worker.Worker, error) {
+				w := worker.New(c, schedulev1.ExampleTaskQueue, worker.Options{})
+				schedulev1.RegisterExampleWorkflows(w, &Workflows{})
+				return w, nil
+			}),
+	)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	app.Commands = append(app.Commands, &cli.Command{
+		Name: "create-schedule",
+		Flags: []cli.Flag{
+			&cli.StringFlag{
+				Name:  "id",
+				Usage: "schedule id",
+				Value: "schedule_id",
+			},
+		},
+		Action: func(cmd *cli.Context) error {
+			c, err := withClient(cmd)
+			if err != nil {
+				return err
+			}
+			defer c.Close()
+
+			h, err := c.ScheduleClient().Create(cmd.Context, client.ScheduleOptions{
+				ID: cmd.String("id"),
+				Spec: client.ScheduleSpec{
+					Intervals: []client.ScheduleIntervalSpec{{
+						Every: time.Minute,
+					}},
+				},
+				Action: &client.ScheduleWorkflowAction{
+					ID:        fmt.Sprintf("%s/", schedulev1.ScheduleWorkflowName),
+					Workflow:  schedulev1.ScheduleWorkflowName,
+					TaskQueue: schedulev1.ExampleTaskQueue,
+					Args: []any{
+						&schedulev1.ScheduleInput{},
+					},
+				},
+			})
+			if err != nil {
+				return err
+			}
+			fmt.Printf("schedule created: %s\n", h.GetID())
+			return nil
+		},
+	})
+
+	if err := app.Run(os.Args); err != nil {
+		log.Fatal(err)
+	}
+}
+
+func (w *Workflows) Schedule(ctx workflow.Context, input *schedulev1.ScheduleWorkflowInput) (schedulev1.ScheduleWorkflow, error) {
+	return &ScheduleWorkflow{input}, nil
+}
+
+func (w *ScheduleWorkflow) Execute(ctx workflow.Context) (*schedulev1.ScheduleOutput, error) {
+	return &schedulev1.ScheduleOutput{
+		StartedAt: timestamppb.New(workflow.Now(ctx)),
+	}, nil
+}
+
+func withClient(cmd *cli.Context) (client.Client, error) {
+	c, err := client.DialContext(cmd.Context, client.Options{})
+	if err != nil {
+		return nil, err
+	}
+	return c, nil
+}

examples/schedule/proto/example/schedule/v1/schedule.proto

@@ -0,0 +1,22 @@
+syntax = "proto3";
+
+package example.schedule.v1;
+
+import "google/protobuf/timestamp.proto";
+import "temporal/v1/temporal.proto";
+
+service Example {
+  option (temporal.v1.service).task_queue = "schedule-v1";
+
+  rpc Schedule(ScheduleInput) returns (ScheduleOutput) {
+    option (temporal.v1.workflow) = {
+      name: "example.schedule.v1.Schedule"
+    };
+  }
+}
+
+message ScheduleInput {}
+
+message ScheduleOutput {
+  google.protobuf.Timestamp started_at = 1;
+}