feat: add cloud workflows quickstart by grant · Pull Request #2120 · GoogleCloudPlatform/nodejs-docs-samples

grant · 2020-12-30T22:47:41Z

Inits canonical Cloud Workflows API quickstart sample.

Adds a README for new folder, workflows/quickstart
This sample...
- Executes the Cloud Workflows quickstart (myfirstworkflow) using the Workflows client library
- Awaits the results with exponential backoff
- Includes test
  - GOOGLE_CLOUD_PROJECT=my-project npm test

Example test result:

  Cloud Workflows Quickstart Tests
Created execution: projects/392236462496/locations/us-central1/workflows/myFirstWorkflow/executions/685a01f4-3cae-4dcb-b0b4-c2965f95fc1a
Poll every second for result...
- Waiting for results...
Execution finished with state: SUCCEEDED
["Wednesday","Wednesday Night Wars","Wednesday 13","Wednesday Addams","Wednesday Campanella","Wednesdayite","Wednesday Martin","Wednesday Campanella discography","Wednesday Night Hockey (American TV program)","Wednesday Morning, 3 A.M."]
    ✓ should execute the quickstart (2196ms)


  1 passing (2s)

CC: @KrisBraun

Signed-off-by: Grant Timmerman <timmerman+devrel@google.com>

snippet-bot · 2020-12-30T22:47:45Z

Here is the summary of changes.

You added 2 region tags.

workflows/quickstart/index.js:31, tag workflows_api_quickstart
workflows/quickstart/test/quickstart.test.js:63, tag workflows_myfirstworkflow

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

Refresh this comment

grant · 2020-12-31T01:26:53Z

CI failures are unrelated.

Signed-off-by: Grant Timmerman <timmerman+devrel@google.com>

grant · 2021-01-08T16:44:28Z

Thanks for the review @grayside. I've addressed your comments. PTAL again.

Signed-off-by: Grant Timmerman <timmerman+devrel@google.com>

grant · 2021-01-08T19:19:17Z

run/system-package failure is unrelated.

averikitsch · 2021-01-08T19:29:14Z

+  // Execute workflow
+  try {
+    const createExecutionRes = await client.createExecution({
+      parent: client.workflowPath(projectId, location, workflow),


nit: save parent as a variable

There's no reason to add a new variable/const, as the expression is not reused.

Right, but it may be more readable split apart. Preference is up to you.

Suggested change

parent: client.workflowPath(projectId, location, workflow),

const parent = client.workflowPath(projectId, location, workflow);

const createExecutionRes = await client.createExecution({parent});

Yes, it could be argued either way. Less variables on the stack / in autocompletion results one way.

Since this is a quickstart the emphasis is not on readability to the same degree as a snippet, however the (often forgotten) rubric guideline is to avoid nesting complex initialization logic inside objects.

Signed-off-by: Grant Timmerman <timmerman+devrel@google.com>

grant

Thanks, replied to comments with updated code.

grant · 2021-01-08T19:34:34Z

+  // Execute workflow
+  try {
+    const createExecutionRes = await client.createExecution({
+      parent: client.workflowPath(projectId, location, workflow),


There's no reason to add a new variable/const, as the expression is not reused.

grant · 2021-01-08T21:59:55Z

Can an admin merge this PR?

@ace-n looks like there's a flaky Functions test.

ace-n · 2021-01-08T22:30:15Z

I'll try re-running the tests for now, and merge if they continue to be flaky.

grant added 2 commits December 30, 2020 16:25

feat: add cloud workflows quickstart

e875ffc

Signed-off-by: Grant Timmerman <timmerman+devrel@google.com>

docs: add detailed comments and use exponential backoff

dd9f454

Signed-off-by: Grant Timmerman <timmerman+devrel@google.com>

grant requested review from averikitsch and grayside December 30, 2020 22:47

grant self-assigned this Dec 30, 2020

grant requested a review from fhinkel as a code owner December 30, 2020 22:47

product-auto-label Bot added the samples Issues that are directly related to samples. label Dec 30, 2020

google-cla Bot added the cla: yes This human has signed the Contributor License Agreement. label Dec 30, 2020

grayside reviewed Jan 7, 2021

View reviewed changes

Comment thread workflows/quickstart/test/quickstart.test.js Resolved

Comment thread workflows/quickstart/test/quickstart.test.js Resolved

refactor: workflows/quickstart add try block and remove chai

46aa63f

Signed-off-by: Grant Timmerman <timmerman+devrel@google.com>

grant force-pushed the grant_workflows_quickstart branch from 35010c4 to 46aa63f Compare January 8, 2021 16:43

grant requested a review from grayside January 8, 2021 16:44

fix: add workflow before running test

b04c79f

Signed-off-by: Grant Timmerman <timmerman+devrel@google.com>

grant mentioned this pull request Jan 8, 2021

run/System Package sample is failing tests #1506

Closed

averikitsch reviewed Jan 8, 2021

View reviewed changes

refactor: move sleep function into region tag

3f35c07

Signed-off-by: Grant Timmerman <timmerman+devrel@google.com>

grant commented Jan 8, 2021

View reviewed changes

grant requested a review from averikitsch January 8, 2021 19:37

grayside approved these changes Jan 8, 2021

View reviewed changes

averikitsch approved these changes Jan 8, 2021

View reviewed changes

Merge branch 'master' into grant_workflows_quickstart

72e10c6

grant added the automerge Merge the pull request once unit tests and other checks pass. label Jan 8, 2021

ace-n added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 8, 2021

kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 8, 2021

gcf-merge-on-green Bot merged commit ebad45a into master Jan 8, 2021

gcf-merge-on-green Bot removed the automerge Merge the pull request once unit tests and other checks pass. label Jan 8, 2021

ace-n deleted the grant_workflows_quickstart branch January 8, 2021 22:44

	parent: client.workflowPath(projectId, location, workflow),
	const parent = client.workflowPath(projectId, location, workflow);
	const createExecutionRes = await client.createExecution({parent});

Conversation

grant commented Dec 30, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

snippet-bot Bot commented Dec 30, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

grant commented Dec 31, 2020

Uh oh!

Uh oh!

Uh oh!

grant commented Jan 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

grant commented Jan 8, 2021

Uh oh!

averikitsch Jan 8, 2021

Choose a reason for hiding this comment

Uh oh!

grant Jan 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

averikitsch Jan 8, 2021

Choose a reason for hiding this comment

Uh oh!

grant Jan 8, 2021

Choose a reason for hiding this comment

Uh oh!

grayside Jan 8, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

grant left a comment

Choose a reason for hiding this comment

Uh oh!

grant Jan 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

grant commented Jan 8, 2021

Uh oh!

ace-n commented Jan 8, 2021

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

grant commented Dec 30, 2020 •

edited

Loading

snippet-bot Bot commented Dec 30, 2020 •

edited

Loading

grant commented Jan 8, 2021 •

edited

Loading

grant Jan 8, 2021 •

edited

Loading

grant Jan 8, 2021 •

edited

Loading