Skip to content
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.

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

chore(merge-back): 1.103.1 #4631

Merged
merged 4 commits into from
Aug 30, 2024
Merged

chore(merge-back): 1.103.1 #4631

merged 4 commits into from
Aug 30, 2024

Conversation

aws-cdk-automation
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation commented Aug 30, 2024

See CHANGELOG

iliapolo and others added 3 commits August 30, 2024 10:54
…served (#4625)

In #4611, we added the `_jsii_proxy_class__` attributes to the `@jsii.interface` implementations. This was required in order to comply with `typeguard` protocol checking. We didn't implement it correctly, accidentally overriding user defined proxy classes.

## Note

I have been wrecking my brain trying to understand if this bug has any runtime implications, and I couldn't find any.

#### How so?

At runtime, from what I could gather, the `__jsii_proxy_class__` attribute is only used when we try to instantiate a subclass of an abstract class:

https://github.com/aws/jsii/blob/dc77d6c7016bcb7531f6e374243410f969ea1fbf/packages/%40jsii/python-runtime/src/jsii/_reference_map.py#L65-L70

However, for abstract classes, we assign an explicit value to `__jsii_proxy_class__`:

https://github.com/aws/jsii/blob/dc77d6c7016bcb7531f6e374243410f969ea1fbf/packages/jsii-pacmak/lib/targets/python.ts#L1496-L1501

Luckily, this happens **AFTER** the `@jsii.implements` decorator has finished, thus overriding the mistake in the decorator.
Presumably, this would still be a problem for user defined abstract classes (since they don't have this assignment). However, reference resolving for user defined classes is done via native reference lookup:

https://github.com/aws/jsii/blob/dc77d6c7016bcb7531f6e374243410f969ea1fbf/packages/%40jsii/python-runtime/src/jsii/_reference_map.py#L48-L54

This is also why I couldn't come up with a real life test case, and had to resort to an artificial one. 

---

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

[Apache 2.0 license]: https://www.apache.org/licenses/LICENSE-2.0
See [CHANGELOG](https://github.com/aws/jsii/blob/patch/v1.103.1/CHANGELOG.md)

(Re-roll of #4628 which I messed up)

---

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

[Apache 2.0 license]: https://www.apache.org/licenses/LICENSE-2.0
@aws-cdk-automation aws-cdk-automation added auto-approve pr/no-squash This PR should be merged instead of squash-merging it labels Aug 30, 2024
Copy link
Contributor

mergify bot commented Aug 30, 2024

Thank you for contributing! ❤️ I will now look into making sure the PR is up-to-date, then proceed to try and merge it!

@mergify mergify bot added the pr/ready-to-merge This PR is ready to be merged. label Aug 30, 2024
Copy link
Contributor

mergify bot commented Aug 30, 2024

Merging (no-squash)...

Copy link
Contributor

mergify bot commented Aug 30, 2024

Merging (no-squash)...

@mergify mergify bot merged commit 49a17c4 into main Aug 30, 2024
37 checks passed
@mergify mergify bot deleted the merge-back/1.103.1 branch August 30, 2024 15:15
@mergify mergify bot removed the pr/ready-to-merge This PR is ready to be merged. label Aug 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-approve pr/no-squash This PR should be merged instead of squash-merging it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants