[EPIC] Publication based plugins should use either `distribution.repository` or `distribution.publication` but not both
Ticket moved to GitHub: "pulp/pulpcore/1993":https://github.com/pulp/pulpcore/issues/1993
Currently, when auto-publish creates a publication, for distributions to go live with that the code needs to make a data change on the distribution. Here is an example in pulp_rpm. This requires the sync+publish code to lock on every distribution referencing the repository being sync'd. So instead of a lock like
["repository foo"]you get
["repository foo", "some distribution" "another distribution", "maybe a third distribution"].
Using both fields doesn't capture the user's intent. If a user wants to have a distribution always publish the latest publication setting the
distribution.repositorycaptures that nicely. If a user wants to have a distribution distribute a specific version of a publication (even if newer ones get created) setting
distribution.publicationcaptures that nicely. What we've got though is both fields being used together which captures conflicting requirements, they want the latest publication for a repository, but they also want this specific publication? If the
distribution.publicationis poiting to the latest publication then we're using two pieces of data when we only need one.
Why did we do it this way?¶
I suspect because it was convenient since the content app already knows how to serve distribution.publication so by setting that data the publication will serve correctly.
What to do instead?¶
- For plugins that use publications, have their
Distributionserializers validate to not allow both
publicationat the same time.
- Provide a migration to fix the data in cases where both are used.
- Update the content app to find the latest publication when
MyDistribution.repositoryis set and
MyDistribution.publicationis unset. This would happen here. This is roughly how the content app auto distributes non-publication plugins, see the implementation here.
Updated by dalley over 2 years ago
I would additionally suggest adding a database constraint (in core) so that plugin writers can't violate this invariant or mess up the validation.
Something equivalent to
~Q(repository_isnull=False, repository_version__isnull=False) & ~Q(repository_isnull=False, publication__isnull=False)
Updated by bmbouter over 2 years ago
- Subject changed from Publication based plugins should use either `distribution.repository` or `distribution.publication` but not both to [EPIC] Publication based plugins should use either `distribution.repository` or `distribution.publication` but not both