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(types): correct ManifestBundleRef #7957

Merged
merged 1 commit into from
Jun 21, 2023
Merged

chore(types): correct ManifestBundleRef #7957

merged 1 commit into from
Jun 21, 2023

Conversation

turadg
Copy link
Member

@turadg turadg commented Jun 20, 2023

Description

Document some type info found while debugging with @Chris-Hibbert

Security Considerations

Scaling Considerations

Documentation Considerations

Testing Considerations

@turadg turadg requested review from warner and dckc June 20, 2023 17:28
Copy link
Member

@dckc dckc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FWIW: re chore: I often use docs for types.

* @typedef BundleHandle
* @property {string} [bundleName]
* @typedef {{ bundleName: string } | { bundleID: string} } ManifestBundleRef
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a thought on product interface boundaries...

One consumer (metamask) pointed out that even though the types have no runtime impact, they can represent breaking changes in the sense that ci jobs fail and effort is needed to address them. This type is exported, so renaming it is a breaking change, from that angle. (I suppose changing its definition could be too)

I don't think that should hold up this PR, but I hope we decide soon on a pretty clear set of product interfaces.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to raise. I queued it for our discussion about breaking changes.

@turadg turadg added this pull request to the merge queue Jun 21, 2023
Merged via the queue into master with commit 3a87a12 Jun 21, 2023
60 checks passed
@turadg turadg deleted the ta/bundle-types branch June 21, 2023 20:54
mhofman pushed a commit that referenced this pull request Aug 7, 2023
chore(types): correct ManifestBundleRef
mhofman pushed a commit that referenced this pull request Jan 13, 2024
chore(types): correct ManifestBundleRef
mhofman pushed a commit that referenced this pull request Jan 15, 2024
chore(types): correct ManifestBundleRef
mhofman pushed a commit that referenced this pull request Jan 19, 2024
chore(types): correct ManifestBundleRef
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants