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

Changing trait instance label names on resource definitions should be a breaking change #22

Open
mrjerryjohns opened this issue Sep 26, 2019 · 1 comment

Comments

@mrjerryjohns
Copy link
Collaborator

Currently, altering the trait instance label name on a resource definition is flagged as a warning by the compiler:

E.g Changing the LabelSettingsTrait instance 'device_label' to 'device_label_moved':

WARNING:root:RemovedObjectValidator has validation warnings:
  Previous schema item weave.resource.service.DescriptionServiceResource.device_label is missing from current schema. Schema items cannot be removed without breaking backward compatibility.

On the service layer, this change is actually deemed a breaking change since the labels are used to index into their data storage layer.

Consequently, the WDL compiler should be modified to flag this appropriately.

@gerickson
Copy link
Contributor

Before we move forward with this, was that indexing choice an ecosystem-specific implementation choice and, as such, should this be a -Werror=device-label-moved option that ecosystems can specific to the extent they made such a choice?

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

No branches or pull requests

2 participants