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

Introduce light-weight registry core module #5709

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

Yoshani
Copy link
Contributor

@Yoshani Yoshani commented May 17, 2024

Proposed changes in this pull request

This PR introduces a light weight registry module, stripping off all the complex and unnecessary features and retaining only the core capabilities from registry core. The following features are removed:

  1. Versioning capability.
  • The old registry module had the versioning capability which, if on, will create the resource as a new version of the object being modified.
  1. Authorization for a given resource path for a given action.
  • Each operation performed on the registry core was checked to ensure that the current user is authorized to perform that action (due to the folder structure).
  1. Paged collections.
  • Since there is no set limit on the number of children a collection could have, the collections had paging capability to retrieve only a set of children.
  1. Registry-specific operations.
  • Registry-specific operations such as copy, move, restore, dump, import.

When should this PR be merged

Upon review and approval

Related issues

Checklist (for reviewing)

General

  • Is this PR explained thoroughly? All code changes must be accounted for in the PR description.
  • Is the PR labeled correctly?

Functionality

  • Are all requirements met? Compare implemented functionality with the requirements specification.
  • Does the UI work as expected? There should be no Javascript errors in the console; all resources should load. There should be no unexpected errors. Deliberately try to break the feature to find out if there are corner cases that are not handled.

Code

  • Do you fully understand the introduced changes to the code? If not ask for clarification, it might uncover ways to solve a problem in a more elegant and efficient way.
  • Does the PR introduce any inefficient database requests? Use the debug server to check for duplicate requests.
  • Are all necessary strings marked for translation? All strings that are exposed to users via the UI must be marked for translation.

Tests

  • Are there sufficient test cases? Ensure that all components are tested individually; models, forms, and serializers should be tested in isolation even if a test for a view covers these components.
  • If this is a bug fix, are tests for the issue in place? There must be a test case for the bug to ensure the issue won’t regress. Make sure that the tests break without the new code to fix the issue.
  • If this is a new feature or a significant change to an existing feature? has the manual testing spreadsheet been updated with instructions for manual testing?

Security

  • Confirm this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets.
  • Are all UI and API inputs run through forms or serializers?
  • Are all external inputs validated and sanitized appropriately?
  • Does all branching logic have a default case?
  • Does this solution handle outliers and edge cases gracefully?
  • Are all external communications secured and restricted to SSL?

Documentation

  • Are changes to the UI documented in the platform docs? If this PR introduces new platform site functionality or changes existing ones, the changes should be documented.
  • Are changes to the API documented in the API docs? If this PR introduces new API functionality or changes existing ones, the changes must be documented.
  • Are reusable components documented? If this PR introduces components that are relevant to other developers (for instance a mixin for a view or a generic form) they should be documented in the Wiki.

@Yoshani Yoshani force-pushed the light-registry branch 5 times, most recently from 8d67886 to d53af6d Compare May 17, 2024 10:34
@Yoshani Yoshani marked this pull request as draft May 20, 2024 06:38
@Yoshani Yoshani force-pushed the light-registry branch 3 times, most recently from 2c447db to 3f3a4cd Compare May 21, 2024 05:01
@Yoshani Yoshani force-pushed the light-registry branch 2 times, most recently from 089f2ef to 24bffa6 Compare May 21, 2024 07:11
@Yoshani Yoshani changed the title Add light-weight registry Introduce light-weight registry May 21, 2024
@Yoshani Yoshani changed the title Introduce light-weight registry Introduce light-weight registry core module May 21, 2024
@Yoshani Yoshani force-pushed the light-registry branch 4 times, most recently from 81135ad to d869229 Compare May 27, 2024 05:57
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

Successfully merging this pull request may close these issues.

None yet

1 participant