Skip to content

feat: Add retry logic to file#download via file#createReadStream #1681

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

feat: Add retry logic to file#download via file#createReadStream #1681

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a52c6b8
refactor: use unified idempotency-based retry method
d-goog Oct 26, 2021
00ea997
feat: Utilize `maxRetries` in `createReadStream`
d-goog Oct 26, 2021
c26f8fc
Merge branch 'main' of https://github.com/googleapis/nodejs-storage i…
d-goog Oct 27, 2021
79d8309
test: Add tests for retries in `createReadStream`
d-goog Oct 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions src/file.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1331,13 +1331,17 @@ class File extends ServiceObject<File> {
headers.Range = `bytes=${tailRequest ? end : `${start}-${end}`}`;
}

const reqOpts = {
const reqOpts: DecorateRequestOptions = {
forever: false,
uri: '',
headers,
qs: query,
};

if (this.storage.retryOptions.autoRetry) {
reqOpts.maxRetries = this.storage.retryOptions.maxRetries;
}

const hashes: {crc32c?: string; md5?: string} = {};

this.requestStream(reqOpts)
Expand Down Expand Up @@ -1609,12 +1613,9 @@ class File extends ServiceObject<File> {

const retryOptions = this.storage.retryOptions;
if (
(options?.preconditionOpts?.ifGenerationMatch === undefined &&
this.instancePreconditionOpts?.ifGenerationMatch === undefined &&
this.storage.retryOptions.idempotencyStrategy ===
IdempotencyStrategy.RetryConditional) ||
this.storage.retryOptions.idempotencyStrategy ===
IdempotencyStrategy.RetryNever
!this.shouldRetryBasedOnPreconditionAndIdempotencyStrat(
options?.preconditionOpts
)
) {
retryOptions.autoRetry = false;
}
Expand Down
29 changes: 29 additions & 0 deletions test/file.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1033,6 +1033,7 @@ describe('File', () => {
'Accept-Encoding': 'gzip',
'Cache-Control': 'no-store',
},
maxRetries: 3,
qs: {
alt: 'media',
},
Expand Down Expand Up @@ -1736,6 +1737,34 @@ describe('File', () => {
file.createReadStream({end: endOffset}).resume();
});
});

describe('retry', () => {
it('should retry by default', done => {
const nonDefaultMaxRetries = file.storage.retryOptions.maxRetries + 1;

file.storage.retryOptions.maxRetries = nonDefaultMaxRetries;

file.requestStream = (opts: DecorateRequestOptions) => {
assert.strictEqual(opts.maxRetries, nonDefaultMaxRetries);
setImmediate(() => done());
return duplexify();
};

file.createReadStream().resume();
});

it('should not retry if `storage.retryOptions.autoRetry` is `false`', done => {
file.storage.retryOptions.autoRetry = false;

file.requestStream = (opts: DecorateRequestOptions) => {
assert.strictEqual(opts.maxRetries, undefined);
setImmediate(() => done());
return duplexify();
};

file.createReadStream().resume();
});
});
});

describe('createResumableUpload', () => {
Expand Down