search

aws / language-servers

AWS related Language Servers
Apache License 2.0
17 stars 15 forks source link

Fix CodeWhisperer IAM "optout" header #285

Closed andredcoliveira closed 1 month ago

andredcoliveira commented 1 month ago

Problem

The CodeWhisperer IAM Server was creating its client using the options type from the CodeWhisperer Token Client. This led to a bug wherein the IAM Server was using onRequestSetup, which is not a recognized option for its client. Instead, the proper way to modify HTTP requests in its client is to use setupRequestListeners.

This discrepancy is due to the fact that the Service Client's options passed via the factory method for the Token Client have been modified. I think this is unnecessary and might be what led to this bug, which is why I did not modify the IAM Client module to match the Token Client. I would suggest modifying the Token Client instead to use the official aws-sdk types/options if possible, without changing them—I don't have a strong opinion here, but I err on the side of this being beyond the scope of this PR.

Solution

Use the correct options type when creating the client and set up the http request header using valid options/methods.

Testing

As far as I can tell, adding a test is not trivial because this repository currently has no testing setup that includes the service clients. See https://github.com/andredcoliveira/language-servers/blob/6ba221873b824d611c731230dab91cc3caeda318/server/aws-lsp-codewhisperer/src/language-server/codeWhispererServer.test.ts#L470-L473.

Tested by verifying CodeWhisperer requests made using the Browser Developer Tools:

Before

Header is missing:

header_before_missing

After

Header is showing:

header_after_showing

License

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

andredcoliveira commented 1 month ago

I hope including https://github.com/aws/language-servers/pull/285/commits/6ba221873b824d611c731230dab91cc3caeda318 in this PR is not a blocker, the output file being tracked was annoying me a bit when using git :)