refactor: Configuration.resolve as a regular constructor

[christerswahn]

Configuration.resolve was a factory constructor, preventing its invocation from subclass constructors. This makes it a regular constructor.

Summary by CodeRabbit

• Refactor
  • Improved and centralized argument parsing and error handling for configuration options, resulting in more consistent error messages and streamlined option resolution. No changes to the user interface or visible features.

[coderabbitai]

📝 Walkthrough

Walkthrough

The update refactors the argument parsing logic in the Configuration class by introducing a new private method _prepareArgResults to handle argument parsing and error handling. The resolve constructor is converted from a factory to a generative constructor, and its logic is streamlined by integrating parsing and error handling directly.

Changes

File	Change Summary
lib/src/config/configuration.dart	Refactored argument parsing into a private method; changed resolve from factory to generative constructor; unified error handling and simplified logic.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant Configuration
    participant ArgParser

    Caller->>Configuration: new Configuration.resolve(options, args, ...)
    alt argResults not provided and args provided
        Configuration->>Configuration: _prepareArgResults(args)
        Configuration->>ArgParser: parse(args)
        ArgParser-->>Configuration: ArgResults or FormatException
        alt FormatException
            Configuration->>Caller: throw error
        end
    end
    Configuration->>Configuration: resolve options
    alt errors found
        Configuration->>Caller: throw error
    else
        Configuration-->>Caller: Configuration instance
    end

Loading

---

📜 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 f517a79 and 8036cc8.

📒 Files selected for processing (1)

• lib/src/config/configuration.dart (2 hunks)

🧰 Additional context used

🧠 Learnings (2)

📓 Common learnings

Learnt from: christerswahn
PR: serverpod/cli_tools#47
File: lib/src/config/options.dart:552-567
Timestamp: 2025-06-12T14:55:38.006Z
Learning: The codebase relies on a recent version of `package:args` where `ArgParser.addFlag` accepts the `hideNegatedUsage` parameter.

lib/src/config/configuration.dart (1)

Learnt from: christerswahn
PR: serverpod/cli_tools#47
File: lib/src/config/options.dart:552-567
Timestamp: 2025-06-12T14:55:38.006Z
Learning: The codebase relies on a recent version of `package:args` where `ArgParser.addFlag` accepts the `hideNegatedUsage` parameter.

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

• GitHub Check: Dart Test (3.3)

🔇 Additional comments (3)

lib/src/config/configuration.dart (3)

92-96: Good refactoring to extract the parsing logic.

The extraction of argument parsing logic into _prepareArgResults improves code reuse and maintainability.

---

142-155: Well-structured parsing method with proper error handling.

The _prepareArgResults method effectively centralizes argument parsing and error handling. Setting all options to error state on parsing failure ensures consistent behavior.

---

112-140: Critical: Remove the invalid return statement in the generative constructor.

The conversion from factory to generative constructor achieves the PR objective of allowing subclass invocation. However, line 127 contains a return statement which is invalid in a generative constructor in Dart.

Apply this diff to fix the issue:

  Configuration.resolve({
    required final Iterable<O> options,
    ArgResults? argResults,
    final Iterable<String>? args,
    final Map<String, String>? env,
    final ConfigurationBroker? configBroker,
    final Map<O, Object?>? presetValues,
    final bool ignoreUnexpectedPositionalArgs = false,
  })  : _options = List<O>.from(options),
        _config = <O, OptionResolution>{},
        _errors = <String>[] {
    if (argResults == null && args != null) {
      argResults = _prepareArgResults(args);
      if (argResults == null) {
        throwExceptionOnErrors();
-        return;
      }
    }

    _resolveWithArgResults(
      args: argResults,
      env: env,
      configBroker: configBroker,
      presetValues: presetValues,
      ignoreUnexpectedPositionalArgs: ignoreUnexpectedPositionalArgs,
    );

    throwExceptionOnErrors();
  }

⛔ Skipped due to learnings

Learnt from: christerswahn
PR: serverpod/cli_tools#47
File: lib/src/config/options.dart:552-567
Timestamp: 2025-06-12T14:55:38.006Z
Learning: For this project, avoid review comments that simply repeat compile-time errors the Dart analyzer already reports; focus on issues not caught by the analyzer.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

[exaby73]

LGTM. This change does introduce a bit of duplicated code, but I think it's fine as it's reads better than to further extract to be pedantically DRY