Skip to content

[TA] Make actions errors more resilient#22070

Merged
maririos merged 1 commit intoAzure:feature/textanalyticsv31from
maririos:errorPArsing
Jun 23, 2021
Merged

[TA] Make actions errors more resilient#22070
maririos merged 1 commit intoAzure:feature/textanalyticsv31from
maririos:errorPArsing

Conversation

@maririos
Copy link
Member

In recent conversation with the service team, and after a casual error I got, I noticed how the .NET SDK was making an assumption that the service will always return errors with targets and that it will always be related to the tasks.

Although we don't have a concrete case yet, I added some code to make our SDK more resilient in case this ever happens.
The major problem is that our exceptions were custom and hiding the error code and message the service was sending, and this is important information we should share with the user.

By coincidence, it addressed: #16686 as it validates the method works. FYI @mohamedshabanofficial


Assert.IsTrue(keyPhrasesActionsResults.HasError);
Assert.Throws<InvalidOperationException>(() => entitiesActionsResults.DocumentsResults.GetType());
Assert.Throws<InvalidOperationException>(() => keyPhrasesActionsResults.DocumentsResults.GetType());
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oops. Fixing this tests :P

}

[Test]
public void AnalyzeOperationWithGenericError()
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mocking a test just to be able to test what will happen and guarantee that .NET won't break without telling the customer why

@check-enforcer
Copy link

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them. In order to bootstrap pipelines for a new service, please perform following steps:

For data-plane/track 2 SDKs Issue the following command as a pull request comment:

/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run net - [service] - ci

For track 1 management-plane SDKs

Please open a separate PR and to your service SDK path in this file. Once that PR has been merged, you can re-run the pipeline to trigger the verification.

Copy link
Contributor

@kinelski kinelski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@maririos maririos merged this pull request into Azure:feature/textanalyticsv31 Jun 23, 2021
maririos added a commit that referenced this pull request Jun 23, 2021
maririos added a commit that referenced this pull request Jun 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants