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

Add MddGetPackageGraphRevisionId() + M.W.AM.DynamicDependency.PackageDependency.PackageGraphRevisionId API Spec #2898

Merged
merged 2 commits into from
Oct 4, 2022

Conversation

DrusTheAxe
Copy link
Member

@DrusTheAxe DrusTheAxe commented Aug 23, 2022

Add MddGetPackageGraphRevisionId() (Flat-C API) and PackageGraphRevisionId property (WinRT API), for alignment with Windows 11 API / terminology.

GenerationId is soft-deprecated (predecessor equivalent to PackageGraphRevisionId still supported but will go away in a future release).

Also corrected spec missing updates:

  • Corrected missing changes per previous API Review and implementation
  • Added missing contracts (added in WinAppSDK 1.1)

https://task.ms/41077950

…s (added in WinAppSDK 1.1). Added PackageGraphRevisionId, for alignment with Windows API (GenerationId is soft-deprecated; will go away in a future release)
@DrusTheAxe DrusTheAxe added this to the 1.2 milestone Aug 23, 2022
@DrusTheAxe DrusTheAxe self-assigned this Aug 23, 2022
@ghost ghost added the needs-triage label Aug 23, 2022
@DrusTheAxe DrusTheAxe changed the title Updated spec (missing changes per previous API Review). Added contact… Add MddGetPackageGraphRevisionId() + M.W.AM.DynamicDependency.PackageDependency.PackageGraphRevisionId Aug 23, 2022
@DrusTheAxe DrusTheAxe added area-DynamicDependencies api-design Updates to Project Reunion API surfaces feature and removed needs-triage labels Aug 23, 2022
@DrusTheAxe
Copy link
Member Author

We're doing an "email review" of this - please leave your comments in the PR by 5pm Seattle time, 2022-08-26. @DrusTheAxe will address feedback in future updates.

Copy link
Contributor

@EHO-makai EHO-makai left a comment

Choose a reason for hiding this comment

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

Is it on purpose that we change generation => revision id but make no mention of the "soft deprecation?"

@DrusTheAxe
Copy link
Member Author

Is it on purpose that we change generation => revision id but make no mention of the "soft deprecation?"

Are you referring to a specific line?

@EHO-makai
Copy link
Contributor

No, it seems like most of the edits just change generation => revision. But no mention is made of what you're supposed to do if you had previously used generation. I'm not asking for a change here necessarily, just wondering if silently doing a "replace" here is what you intended / OK.

@DrusTheAxe
Copy link
Member Author

DrusTheAxe commented Aug 24, 2022

No, it seems like most of the edits just change generation => revision. But no mention is made of what you're supposed to do if you had previously used generation.

2 words for the same thing.

Was originally called GenerationId in Windows (internal) and then WinAppSDK DynDep API Review. Windows had no public API to get that value so we fixed that with a new public API (GetPackageGraphRevisionId) per API Review, which recommended using the term 'revision id' instead of 'generation id'.

This merely updates WinAppSDK to support consist lingo with Windows. Compat's retained for now; breaking changes deferred to vFuture when that's viable e.g. 2.0

I'm not asking for a change here necessarily, just wondering if silently doing a "replace" here is what you intended / OK.

Yes. Given it's the same thing, the GetGeneration doc-comments point you to GetRevision, and it's open source so anyone who looks can see it's the same thing1 I didn't see a need to belabor the point. I expect the release notes and docs will mention this.

1 The implementation is literally 1-liners UINT32 MddGetGenerationId() { return MddGetPackageGraphRevisionId(); })

@DrusTheAxe DrusTheAxe changed the title Add MddGetPackageGraphRevisionId() + M.W.AM.DynamicDependency.PackageDependency.PackageGraphRevisionId Add MddGetPackageGraphRevisionId() + M.W.AM.DynamicDependency.PackageDependency.PackageGraphRevisionId API Spec Aug 26, 2022
@DrusTheAxe
Copy link
Member Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@DrusTheAxe DrusTheAxe modified the milestones: 1.2, 2.0, Future (backlog) Sep 2, 2022
@DrusTheAxe DrusTheAxe merged commit 69f08e7 into main Oct 4, 2022
@DrusTheAxe DrusTheAxe deleted the user/drustheaxe/dyndep-revisionid-spec branch October 4, 2022 16:32
@bpulliam bpulliam removed the feature label May 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api-design Updates to Project Reunion API surfaces area-DynamicDependencies feature proposal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants