Allow simplified composite driver config

[NickCao]

Summary by CodeRabbit

• Refactor

  • Simplified driver configuration structures by removing unnecessary nesting, resulting in a cleaner and more direct setup.
  • Enhanced configuration handling with a new composite format for driver instances, enabling more straightforward instantiation.

• Tests

  • Updated test configurations with clearer property naming and added options to maintain backward compatibility.

[coderabbitai]

Walkthrough

This pull request restructures configuration definitions across multiple components. The YAML API reference is simplified by removing unnecessary children wrappers for both the proxy and foo entities. In parallel, the exporter configuration is enhanced by introducing a new composite driver instance class and updating the instantiation flow. Additionally, test configurations are updated with renamed and additional properties to support a flatter hierarchy. These changes affect documentation, configuration processing, and testing.

Changes

File(s)	Change Summary
docs/…/proxy.yaml	Removed nested children wrappers for proxy and foo entities; restructured definitions to directly reference "foo.bar.power", resulting in a flatter YAML hierarchy.
packages/jumpstarter/…/exporter.py	Added ExporterConfigV1Alpha1DriverInstanceCompositeSimplified class; updated the instantiate method to handle the new composite type; modified the type of the export attribute and adjusted related attributes.
packages/jumpstarter/…/exporter_test.py	Renamed property nested to nested-simplified; added new properties nested-legacy and nested-reserved-name to simplify and extend the configuration structure.

Sequence Diagram(s)

sequenceDiagram
    participant S as Service (serve/serve_unix_async)
    participant E as ExporterConfigV1Alpha1
    participant I as instantiate Method
    participant C as Composite Handler

    S->>E: Call serve/serve_unix_async
    E->>I: Invoke instantiate on export instance
    alt Export instance is CompositeSimplified
        I->>C: Build Composite using the root dictionary
    else Other instance types
        I->>I: Proceed with standard instantiation
    end
    C-->>E: Return composite driver instance
    E-->>S: Return the instantiated driver

Loading

Possibly related PRs

• Init Proxy driver #307: Introduced modifications to the YAML configuration for proxy entities, aligning with the current structural simplifications.
• Provide a simplified "ref" access to proxy drivers #309: Addressed similar restructuring of the proxy configuration by removing the children layer and leveraging direct ref definitions.

Suggested reviewers

• bennyz
• mangelajo

Poem

In a burrow of code where changes abound,
I hop through YAML fields, smooth and sound.
The layers are flattened, the config is bright,
New composites assembled like stars in the night.
A bunny’s delight in each ref and key,
Hop on through updates with joy and glee!
(_/)(•ω•`) Let's celebrate this code spree!

Tip

CodeRabbit's docstrings feature is now available as part of our Pro Plan! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 115351d and 45dd44a.

📒 Files selected for processing (3)

• docs/source/api-reference/drivers/proxy.yaml (1 hunks)
• packages/jumpstarter/jumpstarter/config/exporter.py (6 hunks)
• packages/jumpstarter/jumpstarter/config/exporter_test.py (3 hunks)

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

• GitHub Check: pytest-matrix (3.13)
• GitHub Check: pytest-matrix (3.12)
• GitHub Check: e2e
• GitHub Check: pytest-matrix (3.11)
• GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter-devspace .devfile/Containerfile.client)
• GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter-dev .devfile/Containerfile)
• GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter Dockerfile)

🔇 Additional comments (13)

docs/source/api-reference/drivers/proxy.yaml (1)

1-6: Configuration structure successfully simplified.

The YAML configuration has been effectively flattened by removing nested "children" wrappers. This makes the configuration more concise and readable while maintaining the hierarchical relationship between components.

packages/jumpstarter/jumpstarter/config/exporter_test.py (5)

28-35: Direct TCP instance assignment looks good.

The test now directly assigns the TCP instance as a property of nested without using a children wrapper, which aligns with the simplified configuration approach.

---

96-100: New nested-simplified structure implemented correctly.

This new property introduces the simplified configuration format with a direct custom driver instance, allowing for a cleaner hierarchy.

---

101-106: Maintaining backward compatibility with legacy format.

The nested-legacy structure retains the previous format using the children wrapper while updating the configuration value, ensuring backward compatibility.

---

107-111: Added support for reserved names with the ref approach.

The new nested-reserved-name property demonstrates how to handle reserved property names using the ref approach.

---

147-172: Test assertions updated to match new configuration formats.

The assertions correctly validate all three configuration patterns: simplified, legacy, and reserved name handling.

packages/jumpstarter/jumpstarter/config/exporter.py (7)

24-25: Removed default factory from children attribute.

Making children a required field in ExporterConfigV1Alpha1DriverInstanceComposite clarifies that this attribute must be explicitly defined when using the legacy format.

---

28-29: Well-designed simplified composite class.

The new ExporterConfigV1Alpha1DriverInstanceCompositeSimplified class provides a cleaner way to define hierarchical driver instances without needing the children wrapper.

---

41-41: Union type correctly updated.

Adding the new composite simplified class to the union type ensures that it's properly recognized during validation and instantiation.

---

59-64: Composite instantiation handler implemented properly.

The new case in the instantiate method correctly handles ExporterConfigV1Alpha1DriverInstanceCompositeSimplified instances, creating a Composite object with the appropriate children.

---

94-96: Export attribute structure improved.

Changing export from a dictionary to a single instance of ExporterConfigV1Alpha1DriverInstance with an appropriate default factory simplifies the API while maintaining functionality.

---

154-154: Updated serve_unix_async to use the new export structure.

The method now directly calls instantiate on the export attribute, aligning with the new design.

---

178-178: Updated serve method to use the new export structure.

The method now correctly provides export.instantiate as the device factory, consistent with the updated type.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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.
• @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 to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

[netlify]

✅ Deploy Preview for jumpstarter-docs ready!

Name	Link
🔨 Latest commit	45dd44a
🔍 Latest deploy log	https://app.netlify.com/sites/jumpstarter-docs/deploys/67bf3a83ecbd3100088fdf6b
😎 Deploy Preview	https://deploy-preview-312--jumpstarter-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[mangelajo]

I really like the idea, my only worry, is what will we do if we want to add newer fields later (i.e. incompatibility with fields set by customers in config)

Thinking of that we could want to brainstorm for any additional fields in advance.

[NickCao]

Pending further discussion on what else keywords to reserve, and how to handle name collisions.