Add deb repository and remote pages - #347
warisshaikh1 wants to merge 1 commit into
Conversation
Adds a "Pulp deb" menu section with Repositories and Remotes, mirroring the structure of Pulp file: list, detail and edit for each, plus the versions and distributions tabs on a repository. Deliberately scoped to repositories and remotes. Publications are left out because deb has two publication endpoints rather than a field -- publications/deb/apt generates fresh metadata and needs a signing service, publications/deb/verbatim republishes upstream's Release byte for byte -- so a publications tab needs a design decision rather than just wiring. Content browsing is left out for the same reason: deb has a dozen content endpoints where rpm has one. RemoteForm gains the APT fields, which have no equivalent in the other plugins: distributions (suites), components, architectures, gpgkey, and the sync_sources/sync_udebs/sync_installer switches. `distributions` is added to requiredFields for deb only -- pulp_deb answers a remote without it with "This field is required.", unlike every other plugin where url alone is enough. gpgkey reuses the FileUpload treatment the certificate fields already use, since it is an armoured key file. The remaining changes are registry entries: plugin2api, the plugin unions on LazyRepositories/LazyDistributions/RepositoryForm, and the deb-only fields on the shared RemoteType. All are additive; ansible, container and file behaviour is unchanged. Refs pulp#277
There was a problem hiding this comment.
Thanks for this - solid work overall, and I've left comments on the specific issues, tagged using MoSCoW. A couple of things I'd suggest:
-
Commit size: This is a large PR, 1,942 lines across 32 files submitted as a single commit. That makes it much harder for reviewers to follow, especially when trying to understand how the implementation came together. Smaller, sequential PRs would be preferred going forward.
-
Cypress Testing: As this is new UI functionality within PulpUI, could you please add corresponding test cases to
cypress/e2e/smoke.js. -
AI-assisted contributions: No issue either way, but if any AI tooling was used, please make sure the appropriate attributions is included, in line with Pulp's AI policy.
Ref:
https://github.com/pulp/.github/blob/cf562eff2ec6fe0f49bdfd693c3627453eef5203/profile/README.md
| { name, pulp_href, pulpId }, | ||
| { addAlert, setState, listQuery }, | ||
| ) { | ||
| // TODO: handle more pages |
There was a problem hiding this comment.
MUST: Bare // TODO isn't enough here - if the repository being deleted has more than 100 distributions, the excess are silently orphaned. I'm aware this same pattern exists in both ansible and file repository actions, but I don't want to carry it over into deb as well.
Please either link this TODO to a tracked Github issue, or implement pagination using the offset value returned by the API.
| @@ -0,0 +1,149 @@ | |||
| import { msg, t } from '@lingui/core/macro'; | |||
There was a problem hiding this comment.
MUST (mirror default): Good to see this flagged on the PR already - I'd agree it's worth resolving to match what pulp_deb defaults to, since that's the safer, non-destruction option. Aware ansible and file hardcode true too, but I'll raise a separate issue to track.
SHOULD (SyncModal duplication): Also flagged by you already - agreed this is worth doing, but I'd suggest pulling SyncModal out into a shared component as a precursor PR rather than here, since it's identical to file and ansible.
| listUrl: formatPath(Paths.deb.remote.list), | ||
| query: ({ name }) => | ||
| DebRemoteAPI.list({ name }) | ||
| .then(({ data: { results } }) => results[0]) |
There was a problem hiding this comment.
MUST: results[0] assumes an array with no local .catch - if the response shape is ever wrong, it throws past page-with-tabs.tsx catch handler, and the page would hang silently. Also, the comment here is a little misleading, worth rewording so it's clear we're synthesizing a not-found rejection, not describing actual API behaviour.
| : plugin === 'file' | ||
| ? FileRemoteAPI.list({ ...(name ? { name__icontains: name } : {}) }) | ||
| : Promise.reject(plugin) | ||
| : plugin === 'deb' |
There was a problem hiding this comment.
SHOULD: Nested ternary here is easy to misread and easy to break silently if a fourth plugin is added. Suggest breaking it out into a helper function with a switch statement instead.
| addAlert, | ||
| query, | ||
| hasPermission, | ||
| hasObjectPermission: (_p: string): boolean => true, |
There was a problem hiding this comment.
SHOULD: hasObjectPermission here always returns true, unlike the ansible implementation which conducts a real check against item.my_permissions. It's most likely harmless today, but it's a potential landmine for whoever wires up a permission-gated action later and copies in this stub.
| @@ -0,0 +1,71 @@ | |||
| import { PulpAPI } from './pulp'; | |||
|
|
|||
| export class DebRemoteType { | |||
There was a problem hiding this comment.
WOULD: This class only holds property definitions - no constructor or methods, never instantiated. Per TypeScript's own docs, this fits an interface better.
| @@ -0,0 +1,42 @@ | |||
| import { PulpAPI } from './pulp'; | |||
|
|
|||
| export class DebRepositoryType { | |||
There was a problem hiding this comment.
WOULD: This class only holds property definitions - no constructor or methods, never instantiated. Per TypeScript's own docs, this fits an interface better.
| remote[field] = null; | ||
| } | ||
|
|
||
| // API returns headers:null bull doesn't accept it .. and we don't edit headers |
There was a problem hiding this comment.
COULD: Typo - bull should be but.
| const DebRepositoryDetail = PageWithTabs< | ||
| DebRepositoryType & { remote?: DebRemoteType } | ||
| >({ | ||
| breadcrumbs: ({ name, tab, params: { repositoryVersion } }) => |
There was a problem hiding this comment.
WOULD: The three tab === 'repositoru-versions' tenaries repeat the same guard to build what's really one decision - harder to read than it needs to be. Suggest collapsing into a single guarded branch instead.
Addresses part of #277 (deb in the side menu).
Draft on purpose — I asked three scoping questions in #277 and haven't heard back yet. This is here so there's something concrete to react to rather than to pre-empt the answers. Happy to cut it down, extend it, or restructure it entirely.
What this adds
A
Pulp debmenu section gated onhasPlugin('deb'), with Repositories and Remotes, mirroringPulp file:remotes/deb/aptrepositories/deb/aptWhat it deliberately leaves out
publications/deb/aptgenerates fresh metadata and needs a signing service to be consumable, whilepublications/deb/verbatimrepublishes upstream'sRelease/InReleasebyte for byte so an ordinaryubuntu-archive-keyringverifies it. A publications tab has to either show both or ask which to create, which is a design decision rather than wiring, so it seemed better to agree it first.content/deb/packagesis the useful one, but there are a dozen deb content endpoints where rpm has one. Easy follow-up once the shape here is agreed.The one place deb genuinely differs from file
RemoteFormneeded the APT fields, which have no equivalent elsewhere:distributions(suites),components,architectures,gpgkey, and thesync_sources/sync_udebs/sync_installerswitches.distributionsis required, for deb only. Every other plugin's remote needs just a URL; pulp_deb rejects one without suites:So
requiredFieldsbecomes conditional.gpgkeyreuses theFileUploadtreatmentca_certandclient_certalready get, since it's an armoured key file rather than a one-line value.Everything else is registry entries —
plugin2api, the plugin unions onLazyRepositories/LazyDistributions/RepositoryForm, and deb-only optional fields on the sharedRemoteType. All additive; ansible, container and file behaviour is unchanged (theRemoteFormdiff is worth a look on that point specifically).Testing
Verified against a live pulpcore 3.116.0 / pulp_deb 3.10.0 mirroring Ubuntu noble, with the dev server proxied at it (
API_PROXY):ordering/name__icontains/pulp_label_select/remotefilters,…/versions/,…/versions/?number=N, anddistributions/deb/apt/?repository=<href>DebRemoteEditsends → 201; thesmartUpdatePUT with all APT fields → 202, and the fields read back verbatimpluginRepositoryBasePath('deb', …)resolves the base_path the Repository URL field showsnpm run lint:js,lint:ts,lint:ls, thethis-without-classcheck andnpm run buildare all clean (build warnings unchanged at 18, all pre-existing bundle-size ones). NoCHANGES.mdentry, since that's generated from PR titles at release.Two things I'd flag for review
SyncModal.ansible-repository-sync.tsxandfile-repository-sync.tsxalready carry identical copies and I've followed suit rather than refactoring inside a feature PR. Happy to extract all three into a shared component, here or separately, if you'd prefer.mirrordefaults totruein the sync modal, matching the other plugins, though pulp_deb's own API default isfalse. I kept UI consistency, but say the word and I'll flip it — mirroring is the destructive direction.@bmbouter @himdel @dkliban @ipanova