This sample application shows how to use Google Cloud Tasks on Google App Engine Node.js standard environment and flexible environment.

App Engine queues push tasks to an App Engine HTTP target. This directory contains both the App Engine app to deploy, as well as the snippets to run locally to push tasks to it, which could also be called on App Engine.

createTask.js is a simple command-line program to create tasks to be pushed to the App Engine app.

server.js is the main App Engine app. This app serves as an endpoint to receive App Engine task attempts.

app.standard.yaml configures the app for App Engine Node.js standard environment.

app.flexible.yaml configures the app for App Engine Node.js flexible environment.

• Setup
• Running locally
• Deploying to App Engine
• Running the tests

Before you can run or deploy the sample, you need to do the following:

1. Refer to the [appengine/README.md][readme] file for instructions on running and deploying.

2. Enable the Cloud Tasks API in the Google Cloud Console.

3. Install dependencies:

   With npm:

   npm install
   

   or with yarn:

   yarn install
   

To create a queue using the Cloud SDK, use the following gcloud command:

gcloud beta tasks queues create-app-engine-queue my-appengine-queue

Note: A newly created queue will route to the default App Engine service and version unless configured to do otherwise. Read the online help for the create-app-engine-queue or the update-app-engine-queue commands to learn about routing overrides for App Engine queues.

Deploy the App Engine app with gcloud:

gcloud app deploy app.standard.yaml

Verify the index page is serving:

gcloud app browse

The App Engine app serves as a target for the push requests. It has an endpoint /log_payload that reads the payload (i.e., the request body) of the HTTP POST request and logs it. The log output can be viewed with:

gcloud app logs read

Deploy the App Engine app with gcloud:

gcloud app deploy app.flexible.yaml

Verify the index page is serving:

gcloud app browse

The App Engine app serves as a target for the push requests. It has an endpoint /log_payload that reads the payload (i.e., the request body) of the HTTP POST request and logs it. The log output can be viewed with:

gcloud app logs read

Set environment variables:

First, your project ID:

export PROJECT_ID=my-project-id

Then the queue ID, as specified at queue creation time. Queue IDs already created can be listed with gcloud beta tasks queues list.

export QUEUE_ID=my-appengine-queue

And finally the location ID, which can be discovered with gcloud beta tasks queues describe $QUEUE_ID, with the location embedded in the "name" value (for instance, if the name is "projects/my-project/locations/us-central1/queues/my-appengine-queue", then the location is "us-central1").

export LOCATION_ID=us-central1

Create a task, targeted at the log_payload endpoint, with a payload specified:

node createTask.js --project=$PROJECT_ID --queue=$QUEUE_ID --location=$LOCATION_ID --payload=hello

Now view that the payload was received and verify the payload:

gcloud app logs read

Create a task that will be scheduled for a time in the future using the --in_seconds flag:

node createTask.js --project=$PROJECT_ID --queue=$QUEUE_ID --location=$LOCATION_ID --payload=hello --in_seconds=30

To get usage information: node createTask.js --help

Which prints:

Options:
  --version        Show version number                                                                         [boolean]
  --location, -l   Location of the queue to add the task to.                                         [string] [required]
  --queue, -q      ID (short name) of the queue to add the task to.                                  [string] [required]
  --project, -p    Project of the queue to add the task to.                                          [string] [required]
  --payload, -d    (Optional) Payload to attach to the push queue.                                              [string]
  --inSeconds, -s  (Optional) The number of seconds from now to schedule task attempt.                          [number]
  --help           Show help                                                                                   [boolean]

Examples:
  node createTask.js --project my-project-id

For more information, see https://cloud.google.com/cloud-tasks