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

First PoC of Harbor Satellite #21

Closed
wants to merge 9 commits into from
Closed

First PoC of Harbor Satellite #21

wants to merge 9 commits into from

Conversation

OneFlyingBanana
Copy link
Collaborator

@OneFlyingBanana OneFlyingBanana commented May 21, 2024

Features :

  • Check user input for local filepath or URL
  • Retrieve list of images via URL or local file and store them in-memory
  • Check for changes in remote URL or local file and update in-memory store accordingly
  • Launch local Zot registry
  • Replicate images using in-memory store list to local registry

Main missing features/elements :

  • Delete images from local repository if removed from in-memory store
  • Handle multiple registries/repositories
  • Unit + integration tests
  • Optimization and refactoring
  • ...

Included 2 possible implementations :
- using sync.Map optimised for high concurrency read/writes
- using base map with RWMutex lock/unlock better performing for low-concurrency read/writes
Removed concurrency handling
Added hash map comparison of local + fetched images
Added cli to ask user to choose between remote fetcher and file fetcher
Added barebones files of remote fetcher and file fetcher with test image lists
Modified image list comparison to work via hash map comparison
Setup of skeleton files for file fetcher and http fetcher
Updated user feedback to be more concise
Moved List call in-memory-store to not proc when hashes are equal
Reworked main's user interface to automatically recognise and validate URL or filepath
Reworked http-fetcher to accept  full URLs
Added images.json test file
http-fetcher :
Now using correct Harbor v2 API
Local image list is based on tag list retrieved via API
file-fetcher :
Created JSON struct with name, digest and repository URL
This data, with optional tag name, can be used to make docker pull commands using only url + digest
Features :
- Check user input for local filepath or URL
- Retrieve list of images via URL or local file and store them in-memory
- Check for changes in remote URL or local file and update in-memory store accordingly
- Launch local Zot registry
- Replicate images using in-memory store list to local registry

Main missing features/elements :
- Delete images from local repository if removed from in-memory store
- Unit + integration tests
- Optimization and refactoring
Copy link

coderabbitai bot commented May 21, 2024

Important

Review Skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@milinddethe15
Copy link

Hi @OneFlyingBanana, Can I work on supporting structured logging using log or logrus?
or adding unit tests for some function?

fmt.Println("Source:", source)

if source != "" {
CopyImage(source)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not ignore the error returned.

func getPullSource(image string) string {
input := os.Getenv("USER_INPUT")
if os.Getenv("SCHEME") == "https://" {
url := os.Getenv("HOST") + "/" + os.Getenv("REGISTRY") + "/" + image
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would avoid getting environment variables here and rather do it at startup and pass then as a parameter. Makes it easier to unit test and debug in the future.

req.Header.Set("Authorization", "Basic "+auth)

// Send the request
httpClient := &http.Client{}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Create an http client for the struct rather than creating one for every function call.


// Check if the received image exists in the store
for storeDigest, storeImage := range s.images {
if storeImage == image {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer to inverse the check and call continue instead. This is just to avoid the amount of statement nesting that is done. Improves readability.

return &registryInfo, nil
}

func CopyImage(imageName string) error {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does CopyImage need to be exported outside the package.

@Vad1mo Vad1mo closed this Jun 14, 2024
@Vad1mo
Copy link
Contributor

Vad1mo commented Jun 14, 2024

close in favor of the changed code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants