fix: make extensions that don't use project templates backwards-compatible #4060
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
There was recently an addition of
pub project_templates: Option<HashMap<String, ExtensionProjectTemplate>>
to the structExtensionManifest
.This is somewhat problematic on its own because
ExtensionManifest
has#[serde(deny_unknown_fields)]
. So any extension that has this field in its manifest won’t be compatible with any version of DFX that was released prior to this field being added.This lack of backwards-compatibility might be desirable for extensions that declare project templates (since old versions of DFX wouldn't support the extension's whole feature set). But extensions that don't declare project templates should probably be backwards compatible.
So let's tell serde to be tolerant to the field being omitted using
#[serde(default)]
, and skip serializing it if an extension manifest doesn't declare project templates. This will ensure that projects who generate their manifests programmatically (like the NNS and SNS extensions) don't accidentally lose backwards compatibility.Checklist: