apigee / apigee/apigeetool-node

Deploy of shared flows failing but not resulting in error

Open
#151 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
91
Forks
91
PR merge metrics
No merged PRs in 30d

Description

I've been using the tool to automate the deploy of API layer, but sometimes the deploy of shared flows fail and the javascript command does not result on errors nor trigger exceptions.

It may be due to some network issue or something on apigee side that partially deploys the shared flow, so I'm not able to reproduce it. But from time to time I keep facing this issue. The problem is that the tool does not recognize the error received from apigee and thus it does not trigger an exception or error when it happens.

For example, this is the expected result while deploying the sharedflow with success:

[{"name":"shared-flow-name","environment":"dev","revision":48,"state":"deployed","basePath":"N/A","uris":[]}]

However, sometimes I got:

[{"name":"shared-flow-name","environment":"dev","revision":47,"state":"error","basePath":"N/A","partialResults":[{"pod":{"name":"rde1dmp010-1","region":"eu-central-1"},"status":"deployed","type":["message-processor"],"uUID":"1be899cb-3228-4239-baeb-713ac2b5fad4"},{"pod":{"name":"rea1dmp010-1","region":"us-east-1"},"status":"deployed","type":["message-processor"],"uUID":"d7ffaa10-16da-4bc3-a2e8-5512f37bc33d"},{"pod":{"name":"rea1dmp010-1","region":"us-east-1"},"status":"deployed","type":["message-processor"],"uUID":"aa47e8f2-6f1b-416a-866f-f05b561e4c66"},{"pod":{"name":"rea1dmp010-1","region":"us-east-1"},"status":"deployed","type":["message-processor"],"uUID":"ab6ec230-8336-44e4-83c2-51dfdbca177d"},{"pod":{"name":"rea1dmp010-1","region":"us-east-1"},"status":"deployed","type":["message-processor"],"uUID":"6b01b7f9-42ee-4073-ae81-912bfcf43ed5"}]}]

That's how I'm using the tool, and apigeetool sdk does not trigger the exception, it proceeds to the then:

apigeeSdk.deploySharedflow(opts)
          .then(function (result) {
            log('%s: %s - Sharedflow was deployed successfully: %s', sharedFlowName, opts.name, JSON.stringify(result))
          }, function (err) {
            handleError(err) // not reached when the error mentioned happens...
          })

Of course, I can verify the content of the result and check the state field of the deployment (which indeed I'm doing right now). But, I'd like to confirm if it is expected behavior, and apigeetool is not supposed to throw the exception when the deploy is done partially with errors. Otherwise, it may be nice to fail the sharedflow deploy when it happens.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the apigeeSdk.deploySharedflow entry point and inspect how the returned deployment result is handled. Use the reported response with state:error and partialResults as the failure case; done when a partially failed deployment is consistently surfaced as an error or the expected behavior is documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
api, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.