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

Mechnism to version the preconfiguredEntries in the manifest #8331

Closed
4 of 9 tasks
mgrosperrin opened this issue Jul 22, 2022 · 6 comments
Closed
4 of 9 tasks

Mechnism to version the preconfiguredEntries in the manifest #8331

mgrosperrin opened this issue Jul 22, 2022 · 6 comments
Labels
area:spfx Category: SharePoint Framework (not extensions related) status:tracked Currently tracked with Microsoft’s internal issue tracking system. DO NOT ADD/REMOVE (MSFT managed)
Milestone

Comments

@mgrosperrin
Copy link

Target SharePoint environment

SharePoint Online

What SharePoint development model, framework, SDK or API is this about?

💥 SharePoint Framework

Developer environment

No response

What browser(s) / client(s) have you tested

  • 💥 Internet Explorer
  • 💥 Microsoft Edge
  • 💥 Google Chrome
  • 💥 FireFox
  • 💥 Safari
  • mobile (iOS/iPadOS)
  • mobile (Android)
  • not applicable
  • other (enter in the "Additional environment details" area below)

Additional environment details

  • browser version: all
  • SPFx version: 1.14 & above
  • Node.js version: 12.x & above

Describe the bug / error

When a WebPart is added to a page, SharePoint use the preconfiguredEntries property of the manifest of the WebPart to initalize the properties of the WebPart. The method onAfterDeserialize is called with this data, and the dataVersion argument of the method is the one define in the dataVersion property of the WebPart.
In some cases (mainly for ISVs), we cannot deploy at the same time evolution of the code and the manifest (included in the SharePoint package) (some of our clients take day (if not weeks or months) to deploy the manifest while our code is updated immediatly on our CDN.
As discussed with @AJIXuMuK in #8199 (comment), it would be great to add a dedicated property in the manifest to indicate the version of the preconfiguredEntries.

Steps to reproduce

Expected behavior

There is a way to specify the version of the initial properties of a WebPart

@mgrosperrin mgrosperrin added the type:bug-suspected Suspected bug (not working as designed/expected). See “type:bug-confirmed” for confirmed bugs. label Jul 22, 2022
@ghost
Copy link

ghost commented Jul 22, 2022

Thank you for reporting this issue. We will be triaging your incoming issue as soon as possible.

@ghost ghost added the Needs: Triage 🔍 Awaiting categorization and initial review. label Jul 22, 2022
@AJIXuMuK AJIXuMuK added type:uservoice-request Enhancements & feature requests should be posted: http://aka.ms/sp-dev-uservoice area:spfx Category: SharePoint Framework (not extensions related) status:tracked Currently tracked with Microsoft’s internal issue tracking system. DO NOT ADD/REMOVE (MSFT managed) and removed type:bug-suspected Suspected bug (not working as designed/expected). See “type:bug-confirmed” for confirmed bugs. Needs: Triage 🔍 Awaiting categorization and initial review. labels Jul 22, 2022
@ghost
Copy link

ghost commented Jul 22, 2022

Thank you for your submission. As explained in our wiki (Issue List: What doesn't belong in the issue list), all new feature requests and change requests to existing features should be posted to the SP Dev UserVoice site. You can learn more about this in our wiki: type:uservoice-request

@ghost ghost closed this as completed Jul 22, 2022
@AJIXuMuK AJIXuMuK removed the type:uservoice-request Enhancements & feature requests should be posted: http://aka.ms/sp-dev-uservoice label Jul 22, 2022
@AJIXuMuK AJIXuMuK reopened this Jul 22, 2022
@AJIXuMuK AJIXuMuK added this to the 1.16.0 milestone Sep 15, 2022
@AJIXuMuK
Copy link
Collaborator

@mgrosperrin - dataVersion has been added to the manifest in SPFx v1.16.0-beta.2

@mgrosperrin
Copy link
Author

Hi @AJIXuMuK,
I saw this with pleasure in the release note 😄 .
Is there any PR in the docs to explain this "new" property?

@AJIXuMuK
Copy link
Collaborator

@mgrosperrin - not as of now.
But the behavior is pretty straightforward.
If a new instance of the web part is added to the page we will check the value from the manifest

@ghost
Copy link

ghost commented Nov 7, 2022

Issues that have been closed & had no follow-up activity for at least 7 days are automatically locked. Please refer to our wiki for more details, including how to remediate this action if you feel this was done prematurely or in error: Issue List: Our approach to locked issues

@ghost ghost locked as resolved and limited conversation to collaborators Nov 7, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area:spfx Category: SharePoint Framework (not extensions related) status:tracked Currently tracked with Microsoft’s internal issue tracking system. DO NOT ADD/REMOVE (MSFT managed)
Projects
None yet
Development

No branches or pull requests

2 participants