Exclude abstract components from list

[samtholiya]

issue: https://linear.app/cloudposse/issue/DEV-2808/atmos-tui-should-not-include-abstract-components

what

We want to exclude abstract components from the UI list
Considering we have the following yaml:

# yaml-language-server: $schema=https://atmos.tools/schemas/atmos/atmos-manifest/1.0/atmos-manifest.json

components:
  terraform:
    station:
      metadata:
        component: weather
      vars:
        location: Los Angeles
        lang: en
        format: ''
        options: '0'
        units: m
    station_disabled:
      metadata:
        component: weather
        enabled: false
      vars:
        location: Los Angeles
        lang: en
        format: ''
        options: '0'
        units: m
    station_abstract:
      metadata:
        component: weather
        type: abstract
      vars:
        location: Los Angeles
        lang: en
        format: ''
        options: '0'
        units: m

Currently we would get the following options in the atmos TUI

After this pr we would get only station as shown

why

Since abstract components are not real components and disabled components are supposed to be not usable.

references

https://sweetops.slack.com/archives/C031919U8A0/p1733161390410539

Summary by CodeRabbit

• New Features
  • Introduced a new filtering function for components, allowing for the exclusion of abstract components from the results.
• Bug Fixes
  • Improved the method of retrieving component keys to ensure only relevant components are returned.

[coderabbitai]

📝 Walkthrough

📝 Walkthrough

Walkthrough

The pull request introduces a new function, FilterAbstractComponents, in the internal/exec/describe_component.go file, which filters out abstract components from a given map. This function is then utilized in the ExecuteAtmosCmd function of the internal/exec/atmos.go file to refine the selection of components returned. The changes focus on enhancing the way components are processed, specifically ensuring that abstract components are excluded from the results.

Changes

File Path	Change Summary
internal/exec/atmos.go	Modified ExecuteAtmosCmd to use FilterAbstractComponents instead of lo.Keys for component retrieval.
internal/exec/describe_component.go	Added new function FilterAbstractComponents to filter out abstract components from a map. Added import for github.com/samber/lo.

Assessment against linked issues

Objective	Addressed	Explanation
UI should not include abstract components (DEV-2808)	✅
UI should not include disabled components (DEV-2808)	❌	No changes related to handling disabled components were made.

Suggested labels

minor

---

📜 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 631ef5b and aeb6aab.

📒 Files selected for processing (2)

• internal/exec/atmos.go (1 hunks)
• internal/exec/describe_component.go (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• internal/exec/atmos.go
• internal/exec/describe_component.go

---

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. (Experiment)
• @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.

[coderabbitai]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)

internal/exec/describe_component.go (1)

88-89: Add function documentation to clarify the expected input structure.

The function would benefit from detailed documentation explaining the expected structure of the componentsMap parameter, including an example of the metadata format that defines abstract components.

-// FilterAbstractComponents This function removes abstract components and returns the list of components
+// FilterAbstractComponents filters out components marked as "abstract" in their metadata.
+// The componentsMap is expected to have the following structure:
+// {
+//   "component-name": {
+//     "metadata": {
+//       "type": "abstract|concrete"
+//     }
+//   }
+// }
+// Returns a slice of component names, excluding those marked as abstract.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 22c9b28 and 631ef5b.

📒 Files selected for processing (2)

• internal/exec/atmos.go (1 hunks)
• internal/exec/describe_component.go (2 hunks)

🔇 Additional comments (1)

internal/exec/atmos.go (1)

54-54: LGTM! The change correctly implements abstract component filtering.

The replacement of lo.Keys(v4) with FilterAbstractComponents(v4) successfully implements the PR objective of excluding abstract components from the UI list.

Let's verify if the lo package is still needed in this file:

✅ Verification successful

The lo package is still actively used in the file - import should be retained

The verification shows that the lo package is used in three other locations within the same file:

• lo.MapEntries() for stack components mapping
• lo.Uniq() and lo.Flatten() with lo.Values() for component set operations
• lo.ForEach() for component iteration

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if lo package is used elsewhere in the file
rg --type go "lo\." internal/exec/atmos.go

Length of output: 257

[aknysh]

thanks @samtholiya

[github-actions]

These changes were released in v1.125.0.