[ServiceBus] add delay between infinite retry cycles #20316

jeremymeng · 2022-02-10T19:46:30Z

Errors that are not retryable will be re-thrown out of the normal retry() call.
However, we don't have any delay before restarting the retry cycle.

This PR adds a delay before continuing the infinite retry cycles.

Packages impacted by this PR

@azure/service-bus

Issues associated with this PR

#19883

Describe the problem that is addressed by this PR

Errors that are not retryable will be re-thrown out of the normal retry() call.
However, we don't have any delay before restarting the retry cycle.

What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen?

Are there test cases added in this PR? _

To be added

Checklists

Added a changelog (if necessary)

Errors that are not retryable will be re-thrown out of the normal retry() call. However, we don't have any delay before restarting the retry cycle. This PR adds a delay before continuing the infinite retry cycles.

jeremymeng · 2022-02-10T19:48:50Z

sdk/servicebus/service-bus/src/receivers/receiverCommon.ts

@@ -293,6 +318,22 @@ export async function retryForever<T>(
  retryFn: typeof retry = retry
 ): Promise<T> {
  let numRetryCycles = 0;
+  const config = args.retryConfig;


I duplicated the code from core-amqp's retry as they are used internally and not really worth to expose to reuse.

HarshaNalluru · 2022-02-10T21:04:03Z

sdk/servicebus/service-bus/src/receivers/receiverCommon.ts

+        delayInMs,
+        config.operationType
+      );
+      await delay<void>(delayInMs, config.abortSignal, "Retry cycle has been cancelled by the user.");


HarshaNalluru

Looks good.

HarshaNalluru · 2022-02-10T21:07:14Z

Can we check the resource usage before and after the changes just for sanity?

Perhaps the perf test under sdk/servicebus/service-bus/test/perf-js-libs/service-bus-v7/receive.ts can be used for testing while this #18859 is still being worked upon.

jeremymeng · 2022-02-10T21:21:30Z

Can we check the resource usage before and after the changes just for sanity?

Does the test cover the retry case?

HarshaNalluru · 2022-02-10T21:23:54Z

No, it doesn't. Might have to tweak the test.

Edit: or maybe the sdk/servicebus/service-bus/samples-dev/receiveMessagesStreaming.ts sample is better in this case to test.

also fixed the issue where we don't use `maxRetryDelayInMs` in Fixed retry mode.

jeremymeng · 2022-02-10T21:49:20Z

sdk/core/core-amqp/src/retry.ts

@@ -153,7 +153,7 @@ function calculateDelay(
    return Math.min(incrementDelta, maxRetryDelayInMs);
  }

-  return retryDelayInMs;
+  return Math.min(retryDelayInMs, maxRetryDelayInMs);


I found that we didn't limit the delay in Fixed mode. I think we should respect in Fixed mode too.

This got me thinking. Should we allow specifying a delay larger than the default max, if maxRetryDelayInMs is not specified?

I got it now. It doesn't make sense for fixed mode because the delay is not changing. Will remove

jeremymeng · 2022-02-10T21:50:13Z

sdk/servicebus/service-bus/test/internal/unit/receiverCommon.spec.ts

@@ -278,6 +278,9 @@ describe("shared receiver code", () => {
            },
            connectionId: "id",
            operationType: RetryOperationType.connection,
+            retryOptions: {
+              maxRetryDelayInMs: 2000,


The default of 30s delay is too high so I reduced it.

check-enforcer · 2022-02-10T22:01:31Z

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, you can 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 js - [service] - ci

deyaaeldeen · 2022-02-10T22:20:33Z

sdk/servicebus/service-bus/src/receivers/receiverCommon.ts

@@ -279,6 +282,28 @@ export interface RetryForeverArgs<T> {
  logPrefix: string;
 }

+/**
+ * Calculates delay between retries, in milliseconds.
+ * @internal


nit: no need to tag it as internal if it is not exported.

deyaaeldeen

The change makes sense.

deyaaeldeen · 2022-02-10T22:26:50Z

sdk/servicebus/service-bus/test/internal/unit/receiverCommon.spec.ts

+      const fakeRetry = async <T>(): Promise<T> => {
+        ++numRetryCalls;
+
+        if (numRetryCalls < 4) {


nit: could the constant 3 be factored into a variable everywhere so there is no magic numbers?

sdk/servicebus/service-bus/CHANGELOG.md

Co-authored-by: Ramya Rao <[email protected]>

deyaaeldeen · 2022-02-11T19:22:52Z

sdk/servicebus/service-bus/test/internal/unit/receiverCommon.spec.ts

+      assert.deepEqual(errorMessages, [
+        "Attempt 1: Force another call of retry<>",
+        "Attempt 2: Force another call of retry<>",
+        "Attempt 3: Force another call of retry<>",
+      ]);


nit:

Suggested change

assert.deepEqual(errorMessages, [

"Attempt 1: Force another call of retry<>",

"Attempt 2: Force another call of retry<>",

"Attempt 3: Force another call of retry<>",

]);

assert.deepEqual(errorMessages, Array(errorCount).fill("Attempt 1: Force another call of retry<>"));

or not because the message has indices in it, please discard this

right. the counter increments

…connecting-attemp

as the setting only applies to Exponential retry mode.

[ServiceBus] add delay between infinite retry cycles

786dec4

Errors that are not retryable will be re-thrown out of the normal retry() call. However, we don't have any delay before restarting the retry cycle. This PR adds a delay before continuing the infinite retry cycles.

ghost added the Service Bus label Feb 10, 2022

jeremymeng requested review from ramya-rao-a, HarshaNalluru, deyaaeldeen and richardpark-msft February 10, 2022 19:46

jeremymeng commented Feb 10, 2022

View reviewed changes

HarshaNalluru reviewed Feb 10, 2022

View reviewed changes

HarshaNalluru approved these changes Feb 10, 2022

View reviewed changes

Add a test and update changelog

a044202

also fixed the issue where we don't use `maxRetryDelayInMs` in Fixed retry mode.

jeremymeng commented Feb 10, 2022

View reviewed changes

jeremymeng marked this pull request as ready for review February 10, 2022 21:51

deyaaeldeen reviewed Feb 10, 2022

View reviewed changes

deyaaeldeen approved these changes Feb 10, 2022

View reviewed changes

Address CR feedback

57d6df2

ramya-rao-a reviewed Feb 11, 2022

View reviewed changes

sdk/servicebus/service-bus/CHANGELOG.md Outdated Show resolved Hide resolved

Update sdk/servicebus/service-bus/CHANGELOG.md

55e4c0d

Co-authored-by: Ramya Rao <[email protected]>

deyaaeldeen approved these changes Feb 11, 2022

View reviewed changes

jeremymeng added 3 commits February 11, 2022 11:40

Merge remote-tracking branch 'upstream/main' into sb/delay-between-re…

73f4689

…connecting-attemp

Merge remote-tracking branch 'upstream/main' into sb/delay-between-re…

b1b2cab

…connecting-attemp

Revert max delay limit in Fixed retry mode

e48a827

as the setting only applies to Exponential retry mode.

jeremymeng merged commit d5e4636 into Azure:main Feb 12, 2022

jeremymeng deleted the sb/delay-between-reconnecting-attemp branch February 12, 2022 02:11

jeremymeng mentioned this pull request Feb 15, 2022

[ServiceBus] Live tests pipeline timed out #20388

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ServiceBus] add delay between infinite retry cycles #20316

[ServiceBus] add delay between infinite retry cycles #20316

jeremymeng commented Feb 10, 2022

jeremymeng Feb 10, 2022

HarshaNalluru Feb 10, 2022

HarshaNalluru left a comment

HarshaNalluru commented Feb 10, 2022

jeremymeng commented Feb 10, 2022

HarshaNalluru commented Feb 10, 2022 •

edited

Loading

jeremymeng Feb 10, 2022

jeremymeng Feb 10, 2022

jeremymeng Feb 12, 2022

jeremymeng Feb 10, 2022

check-enforcer bot commented Feb 10, 2022

deyaaeldeen Feb 10, 2022

deyaaeldeen left a comment

deyaaeldeen Feb 10, 2022

deyaaeldeen Feb 11, 2022

deyaaeldeen Feb 11, 2022

jeremymeng Feb 12, 2022

[ServiceBus] add delay between infinite retry cycles #20316

[ServiceBus] add delay between infinite retry cycles #20316

Conversation

jeremymeng commented Feb 10, 2022

Packages impacted by this PR

Issues associated with this PR

Describe the problem that is addressed by this PR

What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen?

Are there test cases added in this PR? _

Checklists

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HarshaNalluru left a comment

Choose a reason for hiding this comment

HarshaNalluru commented Feb 10, 2022

jeremymeng commented Feb 10, 2022

HarshaNalluru commented Feb 10, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

check-enforcer bot commented Feb 10, 2022

What is Check Enforcer?

Why am I getting this message?

What should I do now?

What if I am onboarding a new service?

Choose a reason for hiding this comment

deyaaeldeen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HarshaNalluru commented Feb 10, 2022 •

edited

Loading