Weave Code
Actions Laravel Package
opscale-co/actions
Opscale Actions is a Laravel package for encapsulating business logic in reusable, testable action classes. Compose actions with dependency injection and validation to keep controllers and models thin, improve code organization, and make complex workflows easier to test and maintain.
At a glance
Frequently asked questions about Actions
- What is Opscale Actions and what problem does it solve in Laravel?
- Opscale Actions is a Laravel package for encapsulating business logic in reusable, testable action classes. It supports composing actions with dependency injection and validation, which helps keep controllers and models thin. Teams use it to organize complex workflows and make them easier to test and maintain.
- How do I install opscale-co/actions in a Laravel application?
- Install the package with Composer by running composer require opscale-co/actions. The provided context does not list required service provider or config publishing steps, so check the repository README for any Laravel-specific setup. After installation, you define action classes and compose them through dependency injection.
- Which Laravel and PHP versions does opscale-co/actions support?
- The provided materials do not specify minimum Laravel or PHP versions for opscale-co/actions. Version 4.1.0 is described as a minor release with a feature addition and no documented breaking changes. You should verify supported versions in the package composer.json and README before upgrading.
- How does the AsListener attribute work in Opscale Actions 4.1.0?
- Version 4.1.0 adds AsListener attribute support and a ListenerAdapter that extends the action pattern into Laravel’s event-listener system. The adapter is intended to route domain events to action classes without requiring a parallel listener class hierarchy. It likely bridges Laravel’s event dispatcher to the package’s action invocation contract, but exact registration semantics should be confirmed in the docs.
- Does AsListener support queued listeners and Laravel queue configuration?
- The provided technical assessment flags queued listener support, queue configuration, and shouldQueue behavior as open questions rather than documented guarantees. The adapter may inherit Laravel event-dispatcher assumptions around queuing and payload delivery, but this needs verification. Pilot the feature on low-risk events and test synchronous versus queued dispatch, retries, and failure handling before broad adoption.
- Can a single action listen to multiple Laravel events with AsListener?
- The release notes summarized here do not specify how multiple events per action are handled by AsListener. The maintainers should be asked whether one adapted action can map to several events or whether each event needs its own listener registration. Test the behavior explicitly if your workflow routes more than one event to the same action.
- Does Opscale Actions follow Laravel event auto-discovery conventions?
- The provided context does not confirm whether AsListener supports auto-discovery or follows Laravel’s event discovery conventions. It also notes that teams should confirm whether listener discovery requires cache clearing or config changes. Verify these details with the maintainers or in the package documentation before relying on discovery in production.
- How should I test actions and adapted event listeners in a Laravel app?
- Because actions are intended as reusable units of business logic, test them directly with your normal Laravel testing approach and cover validation and dependency injection paths. For ListenerAdapter, run your existing test suite on a branch, add one adapted action listener behind a feature flag, and compare dispatch and failure behavior with native listeners. The provided assessment notes that test coverage for listener failure and retry paths is an open question.
- What are the production risks of using ListenerAdapter for event listeners?
- The technical risk is described as moderate-low, with concerns around listener registration, queue compatibility, dependency injection inside adapted actions, shouldQueue support, failure handling, and event payload shape. Synchronous adapted listeners could add latency to event dispatch if actions perform I/O, while queued listeners shift load to workers. Watch for adapter misconfiguration, actions that assume HTTP context, silent non-discovery after cache or config changes, and retry behavior that differs from native listeners.
- When should I use native Laravel listeners versus action listeners?
- Use native Laravel listeners for simple event handling, and consider adapted action listeners when the listener contains reusable business logic that benefits from the action pattern. Teams should standardize the preferred pattern because the package now exposes two listener integration styles. Pilot the adapter on low-risk internal events, document the pattern, and then expand to domain events with clear ownership.
Weaver
How can I help you explore Laravel packages today?