Writing and Responding to Pub/Sub Messages

Region ID

The REGION_ID is an abbreviated code that Google assigns based on the region you select when you create your app. The code does not correspond to a country or province, even though some region IDs may appear similar to commonly used country and province codes. For apps created after February 2020, REGION_ID.r is included in App Engine URLs. For existing apps created before this date, the region ID is optional in the URL.

Learn more about region IDs.

OK

Python |Java |Node.js |Go |Ruby |PHP |.NET

Pub/Sub provides reliable, many-to-many, asynchronous messaging between applications. Publisher applications can send messages to a topic, and other applications can subscribe to that topic to receive the messages.

This document describes how to use the Cloud Client Library to send and receive Pub/Sub messages in a .NET app.

Prerequisites

• Follow the instructions in "Hello, World!" for .NET on App Engine to set up your environment and project, and to understand how App Engine .NET apps are structured.
• Write down and save your project ID, because you will need it to run the sample application described in this document.
• Follow the steps to create a service account and service account key to use with your application.

• Enable the Google Cloud Pub/Sub API.

  Enable the API

Cloning the sample app

Copy the sample apps to your local machine, and navigate to the pubsub directory:

git clone https://github.com/GoogleCloudPlatform/dotnet-docs-samples
cd dotnet-docs-samples/appengine/flexible/pubsub

Creating a topic and subscription

Create a topic and subscription, which includes specifying the endpoint to which the Pub/Sub server should send requests:

gcloud pubsub topics create YOUR_TOPIC
gcloud pubsub subscriptions create YOUR_SUBSCRIPTION `
    --topic YOUR_TOPIC `
    --push-endpoint `
    https://YOUR_PROJECT_ID.REGION_ID.r.appspot.com/pubsub/push?token=YOUR_SECRET_TOKEN `
    --ack-deadline 10

Setting environment variables

Edit the appsettings.json file to set your project ID:

appengine/flexible/Pubsub/appsettings.json

View on GitHub

{
  "Pubsub": {
    "ProjectId": "your-project-id",
    "VerificationToken": "your-secret-token",
    "TopicId": "your-topic",
    "SubscriptionId": "your-subscription",
    "AuthSubscriptionId": "your-auth-subscription",
    "ServiceAccountEmail": "your-service-account-email"
  },
  
  "Logging": {
    "IncludeScopes": false,
    "LogLevel": {
      "Default": "Debug",
      "System": "Information",
      "Microsoft": "Information"
    }
  }
}

Code review

The sample app uses the Cloud Client Library.

Note: This tutorial is using an instance level global variable, s_receivedMessages, to store messages received from Pub/Sub. In production, that should be converted to an external storage solution such as Firestore.

appengine/flexible/Pubsub/Controllers/HomeController.cs

View on GitHub

[HttpGet]
[HttpPost]
public IActionResult Index(MessageForm messageForm)
{
    var model = new MessageList();
    if (!_options.HasGoodProjectId())
    {
        model.MissingProjectId = true;
        return View(model);
    }
    if (!string.IsNullOrEmpty(messageForm.Message))
    {
        // Publish the message.
        var pubsubMessage = new PubsubMessage()
        {
            Data = ByteString.CopyFromUtf8(messageForm.Message)
        };
        pubsubMessage.Attributes["token"] = _options.VerificationToken;
        _publisher.PublishAsync(pubsubMessage);
        model.PublishedMessage = messageForm.Message;
    }
    // Render the current list of messages.
    model.Messages = s_receivedMessages.ToArray();
    model.AuthMessages = s_authenticatedMessages.ToArray();
    return View(model);
}

Running the sample locally

When running locally, you can use the Google Cloud CLI to provide authentication to use Google Cloud APIs. Assuming you set up your environment as described in Prerequisites, you have already run the gcloud init command, which provides this authentication.

To run the sample app locally:

Visual Studio

1. Open dotnet-docs-samples\appengine\flexible\AppEngineFlex.sln with Visual Studio.

2. In Solution Explorer, right-click Pubsub, and choose Debug > Start new instance.

Command line

1. Run the following commands from the dotnet-docs-samples\appengine\flexible\Pubsub directory:

   dotnet restore
   dotnet run
   

2. In your web browser, enter the following address:

   http://localhost:5000/
   

Simulating push notifications

The application can send messages locally, but it is not able to receive push messages locally. You can, however, simulate a push message by making an HTTP request to the local push notification endpoint. The sample includes the file sample_message.json.

To send an HTTP POST request:

Get-Content -Raw .\sample_message.json | Invoke-WebRequest -Uri
http://localhost:5000/Push?token=your-secret-token -Method POST -ContentType
'text/json' -OutFile out.txt

After the request completes, you can refresh localhost:5000 and see the message in the list of received messages.

Running on App Engine

To deploy the demo app to App Engine by using the gcloud command-line tool, you run the following command from the directory where your app.yaml file is located:

Visual Studio

To deploy the Hello World app:

1. Open dotnet-docs-samples\appengine\flexible\AppEngineFlex.sln with Visual Studio.
2. In Solution Explorer, right-click Pubsub, and choose Publish to Google Cloud...
3. Click App Engine Flex.
4. Click Publish.

Command line

Run the following commands from the dotnet-docs-samples\appengine\flexible\Pubsub directory:

dotnet restore
dotnet publish
cd bin\Debug\netcoreapp2.1\publish
gcloud app deploy

You can now access the application at https://PROJECT_ID.REGION_ID.r.appspot.com. You can use the form to submit messages, but there's no guarantee of which instance of your application will receive the notification. You can send multiple messages and refresh the page to see the received message.