Add an RBS signature for sigv4 #3152

kazuyainoue0124 · 2024-12-04T13:44:53Z

I received some advice suggesting, "Why not start with aws-sigv4?" in this PR: #3150.

Following that advice, I have added type definition files to aws-sigv4.

mullermp · 2024-12-04T15:25:52Z

Thank you, we will review this. I think you will also need: a changelog entry, add sig/ to gemspec files, and ensure rbs test passes (see tasks/rbs.rake).

mullermp · 2024-12-04T15:26:10Z

@ksss may also be interested in reviewing if you'd like.

alextwoods

Thanks for the contribution, this is looking good!

gems/aws-sigv4/sig/error.rbs

gems/aws-sigv4/sig/request.rbs

gems/aws-sigv4/sig/signer.rbs

ksss

Private API types should be removed.
The intent and syntax are different.
Hash arguments should be supported as well as keyword arguments.
What about RBS testing?

ksss · 2024-12-05T01:10:09Z

gems/aws-sigv4/sig/credentials.rbs

@@ -0,0 +1,30 @@
+module Aws
+  module Sigv4
+    class Credentials


Looks like a private API.

aws-sdk-ruby/gems/aws-sigv4/lib/aws-sigv4/credentials.rb

Lines 5 to 8 in 8c6f65f

# Users that wish to configure static credentials can use the

# `:access_key_id` and `:secret_access_key` constructor options.

# @api private

class Credentials

Sorry, I deleted it.
a72b3bc

ksss · 2024-12-05T01:10:27Z

gems/aws-sigv4/sig/credentials.rbs

+      def set?: () -> bool
+    end
+
+    class StaticCredentialsProvider


ditto.

aws-sdk-ruby/gems/aws-sigv4/lib/aws-sigv4/credentials.rb

Lines 43 to 46 in 8c6f65f

# Users that wish to configure static credentials can use the

# `:access_key_id` and `:secret_access_key` constructor options.

# @api private

class StaticCredentialsProvider

Sorry, I deleted it.
a72b3bc

gems/aws-sigv4/sig/request.rbs

ksss · 2024-12-05T01:25:00Z

gems/aws-sigv4/sig/request.rbs

@@ -0,0 +1,24 @@
+module AWS


Suggested change

module AWS

module Aws

Fixed!
a522cc1

ksss · 2024-12-05T01:33:06Z

gems/aws-sigv4/sig/signer.rbs

+      def sign_event: (
+        prior_signature: String,
+        payload: String,
+        encoder: Object


Use untyped when you do not know what the type is or when you want to put off a decision.

Thank you, I fixed it.
2a780e6

ksss · 2024-12-05T01:41:01Z

gems/aws-sigv4/sig/signer.rbs

+        signing_algorithm?: Symbol,
+        omit_session_token?: bool,
+        normalize_path?: bool,
+      ) -> void


I think you are writing the overload to match the YARD notation, but there is a tradeoff with maintenance costs.
Either way, we can't make a strict type determination when dealing with hash arguments.

I've tried combining all the overloads of the initialize method into a single definition. Would you mind sharing your thoughts on this approach?
2a780e6

Hash arguments should be supported.

Let me confirm: Do you mean I should revise it as follows?

def initialize: ( options: { service: String, region: String, access_key_id?: String, secret_access_key?: String, session_token?: String, credentials?: untyped, credentials_provider?: untyped, unsigned_headers?: Array[String], uri_escape_path?: bool, apply_checksum_header?: bool, signing_algorithm?: :sigv4 | :sigv4a | :'sigv4-s3express', omit_session_token?: bool, normalize_path?: bool, } ) -> void

No. "Hash arguments" is same as #3152 (comment)

How are you testing the behavior?
I don't think it will pass in steep with the proposed signature.

Sorry about that, I've updated the code.
3c34687

…ndError

kazuyainoue0124 · 2024-12-06T14:00:58Z

I replaced URI::HTTP | URI::HTTPS with untyped because using URI::HTTP | URI::HTTPS caused an RBS::NoTypeFoundError.

mullermp · 2024-12-09T18:28:10Z

Let me know when this is ready for re-review and I can allocate some time.

ksss · 2024-12-10T00:30:16Z

gems/aws-sigv4/sig/signer.rbs

+      def initialize: (
+        service: String,
+        region: String,
+        access_key_id?: String,


Same as #3152 (comment)

foo?: String is not optional keyword syntax.
It support to call method like m(foo?: 'bar'). This is a very rare case.

Sorry about that, I've updated the code.

kazuyainoue0124 · 2024-12-12T03:09:31Z

I've made changes based on your feedback. Please review the updated code at your convenience.

ksss

We should modify tasks/rbs.rake to run the RBS test.

ksss · 2024-12-12T13:15:09Z

gems/aws-sigv4/sig/signer.rbs

+        signing_algorithm?: Symbol,
+        omit_session_token?: bool,
+        normalize_path?: bool,
+      ) -> void


Hash arguments should be supported.

mullermp · 2024-12-17T16:41:39Z

Is this ready for re-review from our side?

mullermp

Looks good and definitely an improvement!

mullermp · 2024-12-17T16:44:31Z

gems/aws-sigv4/sig/signer.rbs

+        ?credentials: untyped,
+        ?credentials_provider: untyped,


I think there are classes in this gem you could use for these, or possibly use some interface for "responds to"

I noticed that aws-sigv4/credentials.rb is marked @api private, so I removed its RBS definitions. Do you think it’s better to restore them or just define an interface (requiring #credentials returning access keys, etc.) directly in signer.rbs? I’m unsure which approach is more suitable, given the private status. Any thoughts?

Yes, this is true. I think sigv4/credentials.rb serves as an intermediary. Technically these would be Aws::Credentials from aws-sdk-core. We can leave these untyped for now, and if you're interested in adding rbs for credentials in aws-sdk-core, we can fill these in. I'm not sure how rbs works with across packages, since aws-sigv4 does not depend on aws-sdk-core.

So you’re suggesting that if we create RBS files corresponding to gems/aws-sdk-core/lib/aws-sdk-core/credentials.rb and gems/aws-sdk-core/lib/aws-sdk-core/credential_provider.rb, we could then make use of those type definitions, right? For now, I'll keep it untyped, but afterward I'm thinking of adding RBS definitions for aws-sdk-core credentials. How does that sound?

While in most use cases, Aws::Credentials from aws-sdk-core would be used, this library is intended as a stand alone and doesn't depend on aws-sdk-core - I think from a typing perspective maybe we should define a credentials interface (ie: any object that responds to access_key_id, secret_access_key and session_token) since thats actually what is required. And probably an interface for credentials provider as well.

kazuyainoue0124 added 2 commits December 4, 2024 22:35

Add type definitions to sigv4

b4c8bdc

Add CHANGELOG

8074651

alextwoods reviewed Dec 4, 2024

View reviewed changes

ksss reviewed Dec 5, 2024

View reviewed changes

kazuyainoue0124 added 5 commits December 6, 2024 14:48

Fix errors.rbs

5c6600f

Fix request.rbs

a522cc1

Remove credentials.rbs

a72b3bc

Fix signer.rbs

2a780e6

Replace URI::HTTP | URI::HTTPS with untyped to fix RBS::NoTypeFou…

c63dff6

…ndError

ksss reviewed Dec 10, 2024

View reviewed changes

kazuyainoue0124 added 2 commits December 12, 2024 11:53

Fix RBS syntax for optional keyword arguments

fd5fb78

Add missing correction for optional keyword argument syntax in RBS

fd6d200

ksss reviewed Dec 12, 2024

View reviewed changes

mullermp approved these changes Dec 17, 2024

View reviewed changes

Support hash arguments

3c34687

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add an RBS signature for sigv4 #3152

Add an RBS signature for sigv4 #3152

kazuyainoue0124 commented Dec 4, 2024

mullermp commented Dec 4, 2024

mullermp commented Dec 4, 2024

alextwoods left a comment

ksss left a comment

ksss Dec 5, 2024

kazuyainoue0124 Dec 6, 2024

ksss Dec 5, 2024

kazuyainoue0124 Dec 6, 2024

ksss Dec 5, 2024

kazuyainoue0124 Dec 6, 2024

ksss Dec 5, 2024

kazuyainoue0124 Dec 6, 2024

ksss Dec 5, 2024

kazuyainoue0124 Dec 6, 2024

ksss Dec 12, 2024

kazuyainoue0124 Dec 19, 2024

ksss Dec 20, 2024

kazuyainoue0124 Dec 24, 2024

kazuyainoue0124 commented Dec 6, 2024

mullermp commented Dec 9, 2024

ksss Dec 10, 2024

kazuyainoue0124 Dec 12, 2024

kazuyainoue0124 commented Dec 12, 2024

ksss left a comment

ksss Dec 12, 2024

mullermp commented Dec 17, 2024 •

edited

Loading

mullermp left a comment

mullermp Dec 17, 2024

kazuyainoue0124 Dec 24, 2024

mullermp Dec 24, 2024

kazuyainoue0124 Dec 24, 2024

alextwoods Dec 24, 2024

	# Users that wish to configure static credentials can use the
	# `:access_key_id` and `:secret_access_key` constructor options.
	# @api private
	class Credentials

Add an RBS signature for sigv4 #3152

Are you sure you want to change the base?

Add an RBS signature for sigv4 #3152

Conversation

kazuyainoue0124 commented Dec 4, 2024

mullermp commented Dec 4, 2024

mullermp commented Dec 4, 2024

alextwoods left a comment

Choose a reason for hiding this comment

ksss 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

kazuyainoue0124 commented Dec 6, 2024

mullermp commented Dec 9, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kazuyainoue0124 commented Dec 12, 2024

ksss left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mullermp commented Dec 17, 2024 • edited Loading

mullermp 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

mullermp commented Dec 17, 2024 •

edited

Loading