refactor!: don't return Stream from createLoadJob #647

zamnuts · 2020-03-17T08:07:48Z

Breaking change to fix #640:

createLoadJob now only returns a promise (or handles the callback), and provides the completed job response. in some signatures this used to return a Writable stream
added createLoadJobStream to explicitly return the Writable without any async operations, unless the writable is specifically desired by the consumer, createLoadJob is recommended.

fix!(table): createLoadJobStream sync returns a stream, createLoadJob always returns a job #640

Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
Ensure the tests and linter pass
Code coverage does not decrease (if any source code was changed)
Appropriate docs were updated (if necessary)

Fixes #640 🦕

… always returns a job #640

… for promises #640

codecov · 2020-03-23T08:41:37Z

Codecov Report

Merging #647 into master will increase coverage by 0.11%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #647      +/-   ##
==========================================
+ Coverage   94.99%   95.11%   +0.11%     
==========================================
  Files           7        7              
  Lines        6218     6227       +9     
  Branches      392      382      -10     
==========================================
+ Hits         5907     5923      +16     
+ Misses        311      304       -7

Impacted Files	Coverage Δ
src/table.ts	`100.00% <100.00%> (ø)`
src/bigquery.ts	`100.00% <0.00%> (+0.37%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 712b029...30f0641. Read the comment docs.

… given promisifyAll

…actor

src/table.ts

bcoe · 2020-03-30T17:00:58Z

lets land in the next major, this looks great to me though.

8e26fb5 commit 8e26fb5 Author: Andrew Zammit <zammit.andrew@gmail.com> Date: Mon Mar 30 21:58:06 2020 -0700 refactor!: don't return Stream from createLoadJob (#647) * fix!(table): createLoadJobStream sync returns a stream, createLoadJob always returns a job #640 * chore(table): remove createLoadJobStream, createLoadJob test refactor for promises #640 * chore(table): remove never encountered callback noop in createLoadJob given promisifyAll * test(biqquery): add tests to increase codecov as a result of #647 refactor Co-authored-by: Benjamin E. Coe <bencoe@google.com> Co-authored-by: Steffany Brown <30247553+steffnay@users.noreply.github.com>

* Change triggered by none of the following: This git repo (https://github.com/googleapis/nodejs-bigquery.git) Git repo https://github.com/googleapis/synthtool.git * feat!: drop Node 8 from engines field (#662) 712b029 commit 712b029 Author: Steffany Brown <30247553+steffnay@users.noreply.github.com> Date: Mon Mar 30 12:59:52 2020 -0700 feat!: drop Node 8 from engines field (#662) Drops Node 8 from the engines field. * refactor!: don't return Stream from createLoadJob (#647) 8e26fb5 commit 8e26fb5 Author: Andrew Zammit <zammit.andrew@gmail.com> Date: Mon Mar 30 21:58:06 2020 -0700 refactor!: don't return Stream from createLoadJob (#647) * fix!(table): createLoadJobStream sync returns a stream, createLoadJob always returns a job #640 * chore(table): remove createLoadJobStream, createLoadJob test refactor for promises #640 * chore(table): remove never encountered callback noop in createLoadJob given promisifyAll * test(biqquery): add tests to increase codecov as a result of #647 refactor Co-authored-by: Benjamin E. Coe <bencoe@google.com> Co-authored-by: Steffany Brown <30247553+steffnay@users.noreply.github.com> * chore: update dependency @google-cloud/common to v3 (#661) c61407e commit c61407e Author: WhiteSource Renovate <bot@renovateapp.com> Date: Tue Mar 31 19:27:51 2020 +0200 chore: update dependency @google-cloud/common to v3 (#661) * fix(deps): update dependency @google-cloud/paginator to v3 (#658) a09c493 commit a09c493 Author: WhiteSource Renovate <bot@renovateapp.com> Date: Tue Mar 31 19:38:07 2020 +0200 fix(deps): update dependency @google-cloud/paginator to v3 (#658) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@google-cloud/paginator](https://togithub.com/googleapis/nodejs-paginator) | dependencies | major | [`^2.0.0` -> `^3.0.0`](https://renovatebot.com/diffs/npm/@google-cloud%2fpaginator/2.0.3/3.0.0) | --- ### Release Notes <details> <summary>googleapis/nodejs-paginator</summary> ### [`v3.0.0`](https://togithub.com/googleapis/nodejs-paginator/blob/master/CHANGELOG.md#300-httpswwwgithubcomgoogleapisnodejs-paginatorcomparev203v300-2020-03-25) [Compare Source](https://togithub.com/googleapis/nodejs-paginator/compare/v2.0.3...v3.0.0) ##### ⚠ BREAKING CHANGES - **dep:** upgrade gts 2.0.0 ([#194](https://togithub.com/googleapis/nodejs-paginator/issues/194)) - **deps:** deprecated node 8 to 10; upgrade typescript ##### Miscellaneous Chores - **dep:** upgrade gts 2.0.0 ([#194](https://www.github.com/googleapis/nodejs-paginator/issues/194)) ([4eaf9be](https://www.github.com/googleapis/nodejs-paginator/commit/4eaf9bed1fcfd0f10e877ff15c1d0e968e3356c8)) - **deps:** deprecated node 8 to 10; upgrade typescript ([f6434ab](https://www.github.com/googleapis/nodejs-paginator/commit/f6434ab9cacb6ab804c070f19c38b6072ca326b5)) ##### [2.0.3](https://www.github.com/googleapis/nodejs-paginator/compare/v2.0.2...v2.0.3) (2019-12-05) ##### Bug Fixes - **deps:** pin TypeScript below 3.7.0 ([e06e1b0](https://www.github.com/googleapis/nodejs-paginator/commit/e06e1b0a2e2bb1cf56fc806c1703b8b5e468b954)) ##### [2.0.2](https://www.github.com/googleapis/nodejs-paginator/compare/v2.0.1...v2.0.2) (2019-11-13) ##### Bug Fixes - **docs:** add jsdoc-region-tag plugin ([#155](https://www.github.com/googleapis/nodejs-paginator/issues/155)) ([b983799](https://www.github.com/googleapis/nodejs-paginator/commit/b98379905848fd179c6268aff3e1cfaf2bf76663)) ##### [2.0.1](https://www.github.com/googleapis/nodejs-paginator/compare/v2.0.0...v2.0.1) (2019-08-25) ##### Bug Fixes - **deps:** use the latest extend ([#141](https://www.github.com/googleapis/nodejs-paginator/issues/141)) ([61b383e](https://www.github.com/googleapis/nodejs-paginator/commit/61b383e)) </details> --- ### Renovate configuration 📅 **Schedule**: "after 9am and before 3pm" (UTC). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻️ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [WhiteSource Renovate](https://renovate.whitesourcesoftware.com). View repository job log [here](https://app.renovatebot.com/dashboard#googleapis/nodejs-bigquery). * fix(deps): update dependency @google-cloud/promisify to v2 (#657) 5d8112c commit 5d8112c Author: WhiteSource Renovate <bot@renovateapp.com> Date: Tue Mar 31 19:48:07 2020 +0200 fix(deps): update dependency @google-cloud/promisify to v2 (#657) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@google-cloud/promisify](https://togithub.com/googleapis/nodejs-promisify) | dependencies | major | [`^1.0.0` -> `^2.0.0`](https://renovatebot.com/diffs/npm/@google-cloud%2fpromisify/1.0.4/2.0.0) | --- ### Release Notes <details> <summary>googleapis/nodejs-promisify</summary> ### [`v2.0.0`](https://togithub.com/googleapis/nodejs-promisify/blob/master/CHANGELOG.md#200-httpswwwgithubcomgoogleapisnodejs-promisifycomparev104v200-2020-03-23) [Compare Source](https://togithub.com/googleapis/nodejs-promisify/compare/v1.0.4...v2.0.0) ##### ⚠ BREAKING CHANGES - update to latest version of gts/typescript ([#183](https://togithub.com/googleapis/nodejs-promisify/issues/183)) - drop Node 8 from engines field ([#184](https://togithub.com/googleapis/nodejs-promisify/issues/184)) ##### Features - drop Node 8 from engines field ([#184](https://www.github.com/googleapis/nodejs-promisify/issues/184)) ([7e6d3c5](https://www.github.com/googleapis/nodejs-promisify/commit/7e6d3c54066d89530ed25c7f9722efd252f43fb8)) ##### Build System - update to latest version of gts/typescript ([#183](https://www.github.com/googleapis/nodejs-promisify/issues/183)) ([9c3ed12](https://www.github.com/googleapis/nodejs-promisify/commit/9c3ed12c12f4bb1e17af7440c6371c4cefddcd59)) ##### [1.0.4](https://www.github.com/googleapis/nodejs-promisify/compare/v1.0.3...v1.0.4) (2019-12-05) ##### Bug Fixes - **deps:** pin TypeScript below 3.7.0 ([e48750e](https://www.github.com/googleapis/nodejs-promisify/commit/e48750ef96aa20eb3a2b73fe2f062d04430468a7)) ##### [1.0.3](https://www.github.com/googleapis/nodejs-promisify/compare/v1.0.2...v1.0.3) (2019-11-13) ##### Bug Fixes - **docs:** add jsdoc-region-tag plugin ([#146](https://www.github.com/googleapis/nodejs-promisify/issues/146)) ([ff0ee74](https://www.github.com/googleapis/nodejs-promisify/commit/ff0ee7408f50e8f7147b8ccf7e10337aa5920076)) ##### [1.0.2](https://www.github.com/googleapis/nodejs-promisify/compare/v1.0.1...v1.0.2) (2019-06-26) ##### Bug Fixes - **docs:** link to reference docs section on googleapis.dev ([#128](https://www.github.com/googleapis/nodejs-promisify/issues/128)) ([5a8bd90](https://www.github.com/googleapis/nodejs-promisify/commit/5a8bd90)) ##### [1.0.1](https://www.github.com/googleapis/nodejs-promisify/compare/v1.0.0...v1.0.1) (2019-06-14) ##### Bug Fixes - **docs:** move to new client docs URL ([#124](https://www.github.com/googleapis/nodejs-promisify/issues/124)) ([34d18cd](https://www.github.com/googleapis/nodejs-promisify/commit/34d18cd)) </details> --- ### Renovate configuration 📅 **Schedule**: "after 9am and before 3pm" (UTC). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻️ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [WhiteSource Renovate](https://renovate.whitesourcesoftware.com). View repository job log [here](https://app.renovatebot.com/dashboard#googleapis/nodejs-bigquery). * fix(deps): update dependency google-auth-library to v6 (#660) 3ea642e commit 3ea642e Author: WhiteSource Renovate <bot@renovateapp.com> Date: Tue Mar 31 19:58:07 2020 +0200 fix(deps): update dependency google-auth-library to v6 (#660) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [google-auth-library](https://togithub.com/googleapis/google-auth-library-nodejs) | dependencies | major | [`^5.8.0` -> `^6.0.0`](https://renovatebot.com/diffs/npm/google-auth-library/5.10.1/6.0.0) | --- ### Release Notes <details> <summary>googleapis/google-auth-library-nodejs</summary> ### [`v6.0.0`](https://togithub.com/googleapis/google-auth-library-nodejs/blob/master/CHANGELOG.md#600-httpswwwgithubcomgoogleapisgoogle-auth-library-nodejscomparev5101v600-2020-03-26) [Compare Source](https://togithub.com/googleapis/google-auth-library-nodejs/compare/v5.10.1...v6.0.0) ##### ⚠ BREAKING CHANGES - typescript@3.7.x introduced some breaking changes in generated code. - require node 10 in engines field ([#926](https://togithub.com/googleapis/google-auth-library-nodejs/issues/926)) - remove deprecated methods ([#906](https://togithub.com/googleapis/google-auth-library-nodejs/issues/906)) ##### Features - require node 10 in engines field ([#926](https://www.github.com/googleapis/google-auth-library-nodejs/issues/926)) ([d89c59a](https://www.github.com/googleapis/google-auth-library-nodejs/commit/d89c59a316e9ca5b8c351128ee3e2d91e9729d5c)) ##### Bug Fixes - do not warn for SDK creds ([#905](https://www.github.com/googleapis/google-auth-library-nodejs/issues/905)) ([9536840](https://www.github.com/googleapis/google-auth-library-nodejs/commit/9536840f88e77f747bbbc2c1b5b4289018fc23c9)) - use iamcredentials API to sign blobs ([#908](https://www.github.com/googleapis/google-auth-library-nodejs/issues/908)) ([7b8e4c5](https://www.github.com/googleapis/google-auth-library-nodejs/commit/7b8e4c52e31bb3d448c3ff8c05002188900eaa04)) - **deps:** update dependency gaxios to v3 ([#917](https://www.github.com/googleapis/google-auth-library-nodejs/issues/917)) ([1f4bf61](https://www.github.com/googleapis/google-auth-library-nodejs/commit/1f4bf6128a0dcf22cfe1ec492b2192f513836cb2)) - **deps:** update dependency gcp-metadata to v4 ([#918](https://www.github.com/googleapis/google-auth-library-nodejs/issues/918)) ([d337131](https://www.github.com/googleapis/google-auth-library-nodejs/commit/d337131d009cc1f8182f7a1f8a9034433ee3fbf7)) - **types:** add additional fields to TokenInfo ([#907](https://www.github.com/googleapis/google-auth-library-nodejs/issues/907)) ([5b48eb8](https://www.github.com/googleapis/google-auth-library-nodejs/commit/5b48eb86c108c47d317a0eb96b47c0cae86f98cb)) ##### Build System - update to latest gts and TypeScript ([#927](https://www.github.com/googleapis/google-auth-library-nodejs/issues/927)) ([e11e18c](https://www.github.com/googleapis/google-auth-library-nodejs/commit/e11e18cb33eb60a666980d061c54bb8891cdd242)) ##### Miscellaneous Chores - remove deprecated methods ([#906](https://www.github.com/googleapis/google-auth-library-nodejs/issues/906)) ([f453fb7](https://www.github.com/googleapis/google-auth-library-nodejs/commit/f453fb7d8355e6dc74800b18d6f43c4e91d4acc9)) ##### [5.10.1](https://www.github.com/googleapis/google-auth-library-nodejs/compare/v5.10.0...v5.10.1) (2020-02-25) ##### Bug Fixes - if GCF environment detected, increase library timeout ([#899](https://www.github.com/googleapis/google-auth-library-nodejs/issues/899)) ([2577ff2](https://www.github.com/googleapis/google-auth-library-nodejs/commit/2577ff28bf22dfc58bd09e7365471c16f359f109)) </details> --- ### Renovate configuration 📅 **Schedule**: "after 9am and before 3pm" (UTC). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻️ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [WhiteSource Renovate](https://renovate.whitesourcesoftware.com). View repository job log [here](https://app.renovatebot.com/dashboard#googleapis/nodejs-bigquery). * build: set AUTOSYNTH_MULTIPLE_COMMITS=true for context aware commits (#665) 3f78914 commit 3f78914 Author: Benjamin E. Coe <bencoe@google.com> Date: Tue Mar 31 18:35:04 2020 -0700 build: set AUTOSYNTH_MULTIPLE_COMMITS=true for context aware commits (#665) * docs: document the release schedule we follow (#454) googleapis/synthtool@6a17abc commit 6a17abc7652e2fe563e1288c6e8c23fc260dda97 Author: Benjamin E. Coe <bencoe@google.com> Date: Mon Mar 23 19:22:34 2020 -0700 docs: document the release schedule we follow (#454) * fix: do not run node 8 CI (#456) googleapis/synthtool@1b4cc80 commit 1b4cc80a7aaf164f6241937dd87f3bd1f4149e0c Author: Alexander Fenster <fenster@google.com> Date: Wed Mar 25 08:01:31 2020 -0700 fix: do not run node 8 CI (#456) * fix: update template files for Node.js libraries (#463) googleapis/synthtool@9982024 commit 99820243d348191bc9c634f2b48ddf65096285ed Author: Alexander Fenster <fenster@google.com> Date: Tue Mar 31 11:56:27 2020 -0700 fix: update template files for Node.js libraries (#463)

fix!(table): createLoadJobStream sync returns a stream, createLoadJob…

9a9e97d

… always returns a job #640

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Mar 17, 2020

zamnuts added 2 commits March 23, 2020 01:08

Merge branch 'master' into feature/table-streams-no-promise

3c055b4

chore(table): remove createLoadJobStream, createLoadJob test refactor…

28e3ef0

… for promises #640

chore(table): remove never encountered callback noop in createLoadJob…

2895a91

… given promisifyAll

zamnuts marked this pull request as ready for review March 23, 2020 09:11

test(biqquery): add tests to increase codecov as a result of #647 ref…

2d75a7b

…actor

zamnuts mentioned this pull request Mar 23, 2020

fix(table): add retries for insert partial failures #589

Merged

3 tasks

zamnuts changed the title ~~table: createLoadJobStream = stream only, createLoadJob = promise/cb only~~ table: never return Stream from createLoadJob Mar 23, 2020

zamnuts changed the title ~~table: never return Stream from createLoadJob~~ table: don't return Stream from createLoadJob Mar 23, 2020

stephenplusplus reviewed Mar 23, 2020

View reviewed changes

src/table.ts Show resolved Hide resolved

bcoe changed the title ~~table: don't return Stream from createLoadJob~~ refactor!: don't return Stream from createLoadJob Mar 23, 2020

stephenplusplus reviewed Mar 24, 2020

View reviewed changes

src/table.ts Show resolved Hide resolved

stephenplusplus approved these changes Mar 29, 2020

View reviewed changes

Merge branch 'master' into feature/table-streams-no-promise

61abf71

bcoe added the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Mar 30, 2020

Merge branch 'master' into feature/table-streams-no-promise

30f0641

zamnuts removed the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Mar 31, 2020

zamnuts merged commit 8e26fb5 into master Mar 31, 2020

release-please bot mentioned this pull request Mar 31, 2020

chore: release 5.0.0 #663

Closed

stephenplusplus deleted the feature/table-streams-no-promise branch March 31, 2020 13:21

release-please bot mentioned this pull request Jun 9, 2020

chore: release 5.0.0 #718

Merged

release-please bot mentioned this pull request May 18, 2022

chore(main): release 6.0.0 #1117

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor!: don't return Stream from createLoadJob #647

refactor!: don't return Stream from createLoadJob #647

zamnuts commented Mar 17, 2020 •

edited

codecov bot commented Mar 23, 2020 •

edited

bcoe commented Mar 30, 2020

refactor!: don't return Stream from createLoadJob #647

refactor!: don't return Stream from createLoadJob #647

Conversation

zamnuts commented Mar 17, 2020 • edited

codecov bot commented Mar 23, 2020 • edited

Codecov Report

bcoe commented Mar 30, 2020

zamnuts commented Mar 17, 2020 •

edited

codecov bot commented Mar 23, 2020 •

edited