Project

Profile

Help

Task #2968

Rename DeferredArtifact and remove DownloadCatalog.

Added by jortel@redhat.com about 2 years ago. Updated 6 months ago.

Status:
MODIFIED
Priority:
Normal
Assignee:
Category:
-
Sprint/Milestone:
Start date:
Due date:
% Done:

100%

Platform Release:
Blocks Release:
Backwards Incompatible:
No
Groomed:
No
Sprint Candidate:
No
Tags:
QA Contact:
Complexity:
Smash Test:
Verified:
No
Verification Required:
No
Sprint:
Sprint 24

Description

I think the name can be improved. The record is always created (even when downloading is not deferred) and represents an artifact in a remote or external repository. It's used by the streamer for downloading and Publishers for information when a published Artifact does not exist. So, having deferred in the name seems inappropriate.

Perhaps something like: RemoteArtifact or going back to something like ArtifactCatalog. Suggestions?

Also, this model takes the place of the DownloadCatalog and it should be deleted.

This affects the plugin API.

Associated revisions

Revision bba14bf2 View on GitHub
Added by daviddavis about 2 years ago

Rename DeferredArtifact and remove DownloadCatalog

fixes #2968
https://pulp.plan.io/issues/2968

Revision bba14bf2 View on GitHub
Added by daviddavis about 2 years ago

Rename DeferredArtifact and remove DownloadCatalog

fixes #2968
https://pulp.plan.io/issues/2968

Revision bba14bf2 View on GitHub
Added by daviddavis about 2 years ago

Rename DeferredArtifact and remove DownloadCatalog

fixes #2968
https://pulp.plan.io/issues/2968

History

#1 Updated by mhrivnak about 2 years ago

+1 to the uniqueness constraint that's obviously missing.

For the name aspect, I suggest adding to the description that the name will be changed only if a better one can be agreed upon. I wouldn't want to hold up the rest of these improvements if we have trouble settling on a name.

One thing I'm not crazy about with regard to DeferredArtifact is that "defer" implies that retrieval has been delayed but will eventually happen. I think for most on-demand use cases, a lot of the content will never be retrieved, and that's an valued part of the feature.

It's often a good idea to focus on the nature of the data itself, not necessarily how or why it gets used. RemoteArtifact captures that it's a reference to a file outside of Pulp. ExternalArtifact might also work. ForeignArtifact says less about where the artifact is, but just focuses on the fact that it's not here. AvailableArtifact would heavily imply that the artifact is not locally stored, but that the record contains info on how to get it. ArtifactDownload emphasizes that this record is really about downloading, and the download info happens to be for an Artifact. OnDemandArtifact would match other language we use and I think is clear.

Any of that resonating well? Or sparking other ideas?

#2 Updated by jortel@redhat.com about 2 years ago

  • Subject changed from DeferredArtifact improvments. to Rename DeferredArtifact and remove DownloadCatalog.
  • Description updated (diff)

#3 Updated by jortel@redhat.com about 2 years ago

mhrivnak wrote:

+1 to the uniqueness constraint that's obviously missing.

For the name aspect, I suggest adding to the description that the name will be changed only if a better one can be agreed upon. I wouldn't want to hold up the rest of these improvements if we have trouble settling on a name.

Agreed. Let's deal with adding the unique constraint in a separate issue/pr.

#4 Updated by ttereshc about 2 years ago

  • Sprint/Milestone set to 43
  • Triaged changed from No to Yes

We still need to agree on the name.

#5 Updated by jortel@redhat.com about 2 years ago

  • Tracker changed from Issue to Task
  • % Done set to 0

#6 Updated by daviddavis about 2 years ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to daviddavis

#7 Updated by daviddavis about 2 years ago

The two names I am partial to are RemoteArtifact and ArtifactDownload. Since there's already been support raised for the former, I'm tempted to use it unless anyone opposes.

#8 Updated by daviddavis about 2 years ago

  • Status changed from ASSIGNED to POST

#9 Updated by daviddavis about 2 years ago

  • Status changed from POST to MODIFIED
  • % Done changed from 0 to 100

#10 Updated by bmbouter almost 2 years ago

  • Tags deleted (Pulp 3 Plugin Writer Alpha)

Cleaning up Redmine tags

#11 Updated by bmbouter over 1 year ago

  • Sprint set to Sprint 24

#12 Updated by bmbouter over 1 year ago

  • Sprint/Milestone deleted (43)

#13 Updated by daviddavis 6 months ago

  • Sprint/Milestone set to 3.0

#14 Updated by bmbouter 6 months ago

  • Tags deleted (Pulp 3)

Please register to edit this issue

Also available in: Atom PDF