Docs Updates #70
Docs Updates #70
Conversation
|
All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the ℹ️ Googlers: Go here for more info. |
|
@googlebot I consent. |
…rm/functions-framework-nodejs into comolongo-ReadMeUpdate
| @@ -0,0 +1,77 @@ | |||
| ## Local Testing of Cloud Events | |||
|
|
|||
| The setup for cloud functions that accept events is very similar to the instructions in the quickstart, with the following adjustments: | |||
|
|
||
| The setup for cloud functions that accept events is very similar to the instructions in the quickstart, with the following adjustments: | ||
|
|
||
| In your `package.json`, add a signature type (in bold) to your start command: |
There was a problem hiding this comment.
Nit: remove? (Maybe italicize signature type instead?)
There was a problem hiding this comment.
Bolded sig type instead as it is important.
|
|
||
| Upon running ```sh npm start ```, you'll see the function is still being served at `http://localhost:8080/`. However, it is no longer accessible via GET requests from the browser. Instead, send a POST request where the request body conforms to the API defined by [push subscriptions](https://cloud.google.com/pubsub/docs/push). | ||
|
|
||
| ### Submitting POST Request to Simulate Pub/Sub messages |
|
|
||
| ### Using the Pub/Sub emulator | ||
|
|
||
| Another way to test your cloud function Pub/Sub endpoint is to use the [Pub/Sub Emulator](https://cloud.google.com/pubsub/docs/emulator). This allows you to use the Pub/Sub notification from another service to trigger your cloud function. |
There was a problem hiding this comment.
Capitalization nit: cloud function -> Cloud Function?
| 1. Start the Pub/Sub Emulator | ||
| 2. Use the Pub/Sub client library to create a subscription and set the `pushEndpoint` to `http://localhost:8080`. | ||
|
|
||
| After setup, all notifications to the subscription topic will be pushed to your cloud function. |
There was a problem hiding this comment.
Nit: would locally hosted function be better than Cloud Function here?
| @@ -0,0 +1,77 @@ | |||
| ## Local Testing of Cloud Events | |||
|
|
|||
| The setup for cloud functions that accept events is very similar to the instructions in the quickstart, with the following adjustments: | |||
|
|
||
| The setup for cloud functions that accept events is very similar to the instructions in the quickstart, with the following adjustments: | ||
|
|
||
| In your `package.json`, add a signature type (in bold) to your start command: |
There was a problem hiding this comment.
Bolded sig type instead as it is important.
|
|
||
| Upon running ```sh npm start ```, you'll see the function is still being served at `http://localhost:8080/`. However, it is no longer accessible via GET requests from the browser. Instead, send a POST request where the request body conforms to the API defined by [push subscriptions](https://cloud.google.com/pubsub/docs/push). | ||
|
|
||
| ### Submitting POST Request to Simulate Pub/Sub messages |
|
|
||
| ### Using the Pub/Sub emulator | ||
|
|
||
| Another way to test your cloud function Pub/Sub endpoint is to use the [Pub/Sub Emulator](https://cloud.google.com/pubsub/docs/emulator). This allows you to use the Pub/Sub notification from another service to trigger your cloud function. |
| 1. Start the Pub/Sub Emulator | ||
| 2. Use the Pub/Sub client library to create a subscription and set the `pushEndpoint` to `http://localhost:8080`. | ||
|
|
||
| After setup, all notifications to the subscription topic will be pushed to your cloud function. |
|
A Googler has manually verified that the CLAs look good. (Googler, please make sure the reason for overriding the CLA status is clearly documented in these comments.) ℹ️ Googlers: Go here for more info. |
|
Merging as I have signed the CLA and I am squashing. |
eventsanddockerdocs