GitAuto: [FEATURE] Add Auto-Registration and Dependency Resolution to DI Container in Pancake

[gitauto-ai]

Resolves #237

What is the feature

This feature introduces auto-registration and automatic dependency resolution to the Dependency Injection (DI) Container in the Pancake project. When enabled, the DI Container will automatically register services that are not explicitly registered and resolve all their dependencies, including constructor dependencies, recursively.

Why we need the feature

• Simplify Service Management: Manually registering every service can be tedious and error-prone, especially in large projects with numerous services and dependencies.
• Enhance Developer Productivity: Auto-registration reduces boilerplate code, allowing developers to focus on business logic rather than configuration.
• Improve Flexibility: The DI Container adapts to changes in the codebase without requiring additional registration code.
• Facilitate Dependency Handling: Automatic resolution of dependencies ensures that complex dependency graphs are managed seamlessly.

How to implement and why

Implementation Steps:

1. Modify the DIContainer Class:

   • Add a Property for Auto-Registration Flag:
     • Introduce a private property $autoRegisterEnabled to control the auto-registration feature.
     • Initialize it in the constructor with a default value of true, making the feature enabled by default.
   • Update the resolve Method:
     • Check if the service exists in $services. If not found and auto-registration is enabled, proceed to auto-register.
     • Invoke a new private method autoRegister($name) to handle the registration and resolution.
   • Implement the autoRegister Method:
     • Use PHP's Reflection API to inspect the class and its constructor.
     • Check if the class exists; if not, throw an exception.
     • Retrieve constructor parameters and resolve each dependency recursively by calling resolve on the parameter's class name.
     • Instantiate the class with resolved dependencies using newInstanceArgs.
   • Add Methods to Control Auto-Registration:
     • Provide setAutoRegisterEnabled(bool $enabled) to allow enabling or disabling the feature at runtime.
     • This adds flexibility for developers to opt-in or opt-out as needed.

2. Handle Dependency Resolution:

   • Ensure that when resolving dependencies, the container can handle nested dependencies by recursively resolving constructor arguments.
   • If a dependency cannot be resolved (e.g., missing type hint or class does not exist), throw an exception with a clear message for easier debugging.

3. Update Registration Methods:

   • Maintain existing methods like registerSingleton and registerTransient to ensure they work seamlessly with the new auto-registration feature.
   • Explicitly registered services should take precedence over auto-registered ones.

4. Write Unit Tests:

   • Auto-Registration Tests:
     • Verify that services not explicitly registered can be auto-registered and resolved.
   • Dependency Resolution Tests:
     • Test services with multiple layers of dependencies to ensure recursive resolution works correctly.
   • Auto-Registration Disabled Tests:
     • Confirm that when auto-registration is disabled, resolving an unregistered service throws an exception.
   • Exception Handling Tests:
     • Ensure meaningful exceptions are thrown when services cannot be resolved.

5. Write Integration Tests:

   • Create real-world scenarios where services depend on each other.
   • Validate that the DI Container correctly auto-registers and resolves all services and their dependencies in an application context.

6. Update Documentation:

   • Provide clear examples showcasing how to use the DI Container with auto-registration enabled and disabled.
   • Explain the mechanisms of auto-registration and dependency resolution.
   • Highlight any potential caveats or considerations.

Why Implement This Way:

• Maintain Backward Compatibility: By enabling auto-registration by default but allowing it to be disabled, existing codebases remain unaffected unless they choose to utilize the new feature.
• Improve Developer Experience: Automating the tedious parts of service registration promotes a smoother development workflow.
• Enhance Reliability: With thorough unit and integration tests, we ensure the new feature is robust and reliable.

About backward compatibility

• Non-Intrusive Addition: The feature is added in a way that does not break existing functionality. All existing methods and behaviors remain unchanged unless auto-registration is used.
• Enabled by Default, Configurable: Auto-registration is enabled by default for convenience but can be turned off for projects that require explicit service registration.
• Explicit Registration Priority: Services explicitly registered in the container take precedence over auto-registered services, preventing unexpected behavior.
• No Changes Required for Existing Code: Developers are not required to modify existing code to accommodate this feature unless they wish to leverage auto-registration.

By carefully implementing the feature with these considerations, we ensure that current users of the Pancake DI Container can adopt the new functionality without disruption.

Test these changes locally

git checkout -b gitauto/issue-237-89757ae2-5736-4b2e-9a82-20e0e588b009
git pull origin gitauto/issue-237-89757ae2-5736-4b2e-9a82-20e0e588b009

[coderabbitai]

Important

Review skipped

Bot user detected.

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.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[deepsource-io]

Here's the code health analysis summary for commits d72f64d..d40498f. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
Test coverage	⚠️ Artifact not reported	Timed out: Artifact was never reported	View Check ↗
SQL	✅ Success		View Check ↗
Secrets	✅ Success		View Check ↗
PHP	❌ Failure	❗ 5 occurences introduced	View Check ↗
Docker	✅ Success		View Check ↗

---

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

[github-advanced-security]

Phpcs (reported by Codacy) found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.

[github-actions]

Infisical secrets check: ✅ No secrets leaked!

💻 Scan logs

2025-12-04T17:13:05Z INF scanning for exposed secrets...
5:13PM INF 429 commits scanned.
2025-12-04T17:13:05Z INF scan completed in 680ms
2025-12-04T17:13:05Z INF no leaks found