chore(cleanup)!: Remove redundant callback types, move storage.ts to … #2445

ddelgrosso1 · 2024-04-24T18:23:05Z

…calling gaxios

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

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 #<issue_number_goes_here> 🦕

ddelgrosso1 · 2024-04-24T18:23:17Z

Gigantic WIP / PoC

danielduhh

IIUC the bulk of this PR is refactoring all the common options to "Storage-Transport" and wiring everything back together? If thats right, it would be helpful to add context in the StorageTransport docs.

Also, if this is the case, maybe create a seperate PR that introduces the concept of "storage-transport", and then the PRs after that can incrementally refactor specific files that need to be refactored (e.g. ACL, Bucket, HMAC, etc.)

danielduhh · 2024-06-17T18:19:50Z

conformance-test/conformanceCommon.ts

-            [hmacKey] = await storage.createHmacKey(
-              `${TESTS_PREFIX}@email.com`
-            );
+            hmacKey = await storage.createHmacKey(`${TESTS_PREFIX}@email.com`);


Im guessing we can remove this once #2461 is complete?

This is a conformance test, it already runs against test bench. The change here is that it no longer returns an array, only a single element.

danielduhh · 2024-06-17T18:20:12Z

conformance-test/conformanceCommon.ts


-            storage.interceptors.push({
+            //TODO: Interceptors


Maybe add a bug here with more info on the TODO?

This can actually be fixed now. When I started this was dependent on adding interceptors to gaxios.

Fixed this.

danielduhh · 2024-06-17T19:05:50Z

conformance-test/libraryMethods.ts

@@ -795,7 +795,7 @@ export async function notificationGetMetadata(options: ConformanceTestOptions) {

 export async function createBucket(options: ConformanceTestOptions) {
  const bucket = options.storage!.bucket('test-creating-bucket');
-  const [exists] = await bucket.exists();
+  const exists = await bucket.exists();


Whats the change here? previously we were returning an array, and now its an object?
It would be helpful to start a README doc with a list of "breaking" changes so that we make sure we cover everything

Or update PR description with a checklist of # of changes that need to happen

We were returning arrays for no reason all over the place. I'm trying to bring responses much more in line with the standard JSON API responses.

The number of breaking changes is going to be too big for comments / PR commit messsages. I have created an issue in buganizer to create a migration guide.

Throwing out some random ideas here... It seems like migrating for returning an array vs object is the big breaking change here. Is there anyway to have some kind of flag for customers who want to keep the current behavior? We can eventually deprecate the flag but it would give customers some more time to keep the current behavior while we modernize the library

danielduhh · 2024-06-17T19:08:13Z

src/storage-transport.ts

+  (err: GaxiosError<T> | null, data?: T): void;
+}
+
+interface TransportParameters extends Omit<GoogleAuthOptions, 'authClient'> {


where's Omit coming from?

https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys

v cool. TIL

danielduhh · 2024-06-17T19:08:35Z

src/storage-transport.ts

+}
+
+interface TransportParameters extends Omit<GoogleAuthOptions, 'authClient'> {
+  apiEndpoint: string;


are these options all copied from somewhere? What's the source and how do we know nothing is missing?

Yes, this is extending GoogleAuthOptions but omitting authClient.

danielduhh · 2024-06-17T19:10:20Z

src/file.ts


-      const keyIndex = this.interceptors.indexOf(
+      // TODO: INTERCEPTORS


same request about adding a bug or notes

danielduhh · 2024-06-17T19:12:06Z

src/file.ts

          this.bucket.name
        }/${encodeURIComponent(this.name)}`,
-        headers,
+        //headers,


why comment this out?

danielduhh · 2024-06-17T19:15:58Z

src/nodejs-common/service.ts

@@ -13,33 +13,13 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
-import {


Is this file even necessary anymore?

Probably not. I was going to sweep up all the garbage once I got things back to a working state.

sg, can you add it to some tracking list of TODOs

danielduhh · 2024-06-17T19:17:48Z

src/storage.ts

@@ -779,6 +755,10 @@ export class Storage extends Service {

    this.retryOptions = config.retryOptions;

+    this.storageTransport = new StorageTransport({...config, ...options});
+    //this.interceptors = [];
+    this.universeDomain = options.universeDomain || DEFAULT_UNIVERSE;


wheres this change coming from?

What change are you referring to? It probably shows all three lines as new because I commented out the interceptors and added StorageTransport. I didn't touch universedomain.

danielduhh · 2024-06-17T19:18:35Z

src/transfer-manager.ts

@@ -654,7 +655,7 @@ export class TransferManager {
        : fileOrName;

    const fileInfo = await file.get();
-    const size = parseInt(fileInfo[0].metadata.size!.toString());
+    const size = parseInt(fileInfo.metadata.size!.toString());


Similar question here about expecting an array vs a single object

ddelgrosso1 · 2024-06-17T19:40:51Z

IIUC the bulk of this PR is refactoring all the common options to "Storage-Transport" and wiring everything back together? If thats right, it would be helpful to add context in the StorageTransport docs.

Also, if this is the case, maybe create a seperate PR that introduces the concept of "storage-transport", and then the PRs after that can incrementally refactor specific files that need to be refactored (e.g. ACL, Bucket, HMAC, etc.)

Sort of. StorageTransport is replacing the mixture of transport level options and functionality that was spread across several files (Service, ServiceObject, util).

I think we are a bit too far past just introducing Storage Transport. I think at this point our best path forward is to merge this into the feature branch and then do as you suggest and work on each file / section individually.

…calling gaxios

…port

product-auto-label bot added size: l Pull request size is large. api: storage Issues related to the googleapis/nodejs-storage API. labels Apr 24, 2024

ddelgrosso1 force-pushed the gaxios branch from 62604ae to f86880e Compare May 16, 2024 20:14

product-auto-label bot added size: xl Pull request size is extra large. and removed size: l Pull request size is large. labels May 16, 2024

ddelgrosso1 changed the base branch from main to gaxios-feature May 22, 2024 21:33

ddelgrosso1 marked this pull request as ready for review May 22, 2024 21:35

ddelgrosso1 requested review from a team as code owners May 22, 2024 21:35

danielduhh reviewed Jun 17, 2024

View reviewed changes

ddelgrosso1 added 9 commits June 17, 2024 19:42

chore(cleanup)!: Remove redundant callback types, move storage.ts to …

bc0401b

…calling gaxios

remove service class and associated tests

49ac24e

modify service-object and associated sub classes to use storage trans…

5e7544c

…port

update storage.ts documentation, use storage transport in channel.ts

0061d94

fix channel unit tests

3d0b9e4

use storageTransport in acl.ts and fix unit tests

cb5d452

add header to storage transport

55dc813

convert isPublic to use gaxios

8557206

use storage transport in bucket.ts

b256785

ddelgrosso1 force-pushed the gaxios branch from ad06afa to b256785 Compare June 17, 2024 19:43

add request inerceptor back to conformanceCommon

f1d9292

ddelgrosso1 closed this Jul 9, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(cleanup)!: Remove redundant callback types, move storage.ts to … #2445

chore(cleanup)!: Remove redundant callback types, move storage.ts to … #2445

ddelgrosso1 commented Apr 24, 2024

ddelgrosso1 commented Apr 24, 2024

danielduhh left a comment

danielduhh Jun 17, 2024

ddelgrosso1 Jun 17, 2024

danielduhh Jun 17, 2024

ddelgrosso1 Jun 17, 2024

ddelgrosso1 Jun 18, 2024

danielduhh Jun 17, 2024

danielduhh Jun 17, 2024

ddelgrosso1 Jun 17, 2024

ddelgrosso1 Jun 17, 2024

danielduhh Jun 18, 2024

danielduhh Jun 17, 2024

ddelgrosso1 Jun 17, 2024

danielduhh Jun 18, 2024

danielduhh Jun 17, 2024

ddelgrosso1 Jun 17, 2024

danielduhh Jun 17, 2024

danielduhh Jun 17, 2024

danielduhh Jun 17, 2024

ddelgrosso1 Jun 17, 2024

danielduhh Jun 18, 2024

danielduhh Jun 17, 2024

ddelgrosso1 Jun 17, 2024

danielduhh Jun 17, 2024

ddelgrosso1 commented Jun 17, 2024


		const keyIndex = this.interceptors.indexOf(
		// TODO: INTERCEPTORS

chore(cleanup)!: Remove redundant callback types, move storage.ts to … #2445

chore(cleanup)!: Remove redundant callback types, move storage.ts to … #2445

Conversation

ddelgrosso1 commented Apr 24, 2024

ddelgrosso1 commented Apr 24, 2024

danielduhh 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

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

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

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

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

ddelgrosso1 commented Jun 17, 2024