update artifactory store to use getKey

[mcalhoun]

what

• Refactored the getKey method in ArtifactoryStore to use a shared key generation function
• Simplified key path construction by separating prefix handling from the main path generation

why

• Reduces code duplication by leveraging a common key generation function
• Improves maintainability by separating concerns between prefix handling and path construction
• Makes the code more consistent with other store implementations

references

• Related to key generation standardization across storage implementations

Summary by CodeRabbit

• Refactor
  • Streamlined internal key creation logic to enhance maintainability and clarity.
  • Ensured that public functionalities remain consistent with no visible changes to the end-user.

[mcalhoun]

• update artifactory store to use getKey #1017 👈 (View in Graphite)
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes refactor the key-generation logic in the ArtifactoryStore by modifying the getKey method. Instead of directly manipulating strings within the method, the new implementation builds a prefix from repoName and prefix and then calls a separate helper function to generate the key. Error handling remains consistent, and no exported entities’ signatures are altered.

Changes

File	Change Summary
pkg/store/artifactory_store.go	Refactored the getKey method to construct a prefix and delegate key generation to a new helper function, simplifying the string manipulation logic.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant A as ArtifactoryStore
    participant H as getKey Helper
    C->>A: Request key generation (stack, component, key, separator)
    A->>A: Construct prefix using repoName and prefix
    A->>H: Call helper getKey(prefix, stack, component, key, separator)
    H-->>A: Return generated key
    A-->>C: Return key

Loading

Possibly related PRs

• update aws param store store to use getKey #1009: Involves similar modifications to the getKey method, with adjustments to key generation logic and error handling in SSMStore.

Suggested labels

minor

Suggested reviewers

• osterman

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2a38feb and 78b413f.

📒 Files selected for processing (1)

• pkg/store/artifactory_store.go (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Acceptance Tests (windows-latest, windows)
• GitHub Check: Summary

🔇 Additional comments (1)

pkg/store/artifactory_store.go (1)

114-116: Verify the helper function and consider improving separator handling.

The code looks cleaner with the new approach, but there are a few considerations:

1. The code calls a getKey helper function that isn't visible in this file.
2. The separator "/" is hardcoded in two places.

Let's verify the existence and implementation of the getKey helper function:

Consider extracting the separator into a constant or configuration to maintain consistency and make it easier to change if needed:

+const pathSeparator = "/"
+
 func (s *ArtifactoryStore) getKey(stack string, component string, key string) (string, error) {
   if s.stackDelimiter == nil {
     return "", fmt.Errorf("stack delimiter is not set")
   }

   prefixParts := []string{s.repoName, s.prefix}
-  prefix := strings.Join(prefixParts, "/")
-  return getKey(prefix, *s.stackDelimiter, stack, component, key, "/")
+  prefix := strings.Join(prefixParts, pathSeparator)
+  return getKey(prefix, *s.stackDelimiter, stack, component, key, pathSeparator)

✅ Verification successful

Helper function exists and separator handling is confirmed.

• The getKey helper function is implemented in pkg/store/store.go (lines 18-30) and is correctly utilized in pkg/store/artifactory_store.go.
• The hardcoded separator "/" is used consistently, though extracting it into a constant might improve maintainability.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for the getKey helper function implementation
ast-grep --pattern 'func getKey($_, $_, $_, $_, $_, $_) $_'

Length of output: 834

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary or @auto-summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @auto-title anywhere in the PR title to generate the title automatically.

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.

[github-actions]

These changes were released in v1.159.0.