Weave Code
Longrunning Laravel Package
google/longrunning
Idiomatic PHP client for Google Long‑Running Operations API. Install via Composer and use with REST or gRPC to manage operations (poll, cancel, delete, list) across Google Cloud services. Part of google-cloud-php; authentication/debug guides included.
At a glance
Frequently asked questions about Longrunning
- What is google/longrunning used for in a Laravel application?
- google/longrunning is the PHP client for the Google Long-Running Operations API. It lets you get, list, cancel, delete, and poll operations returned by GCP services such as BigQuery, Compute Engine, Vertex AI, and Cloud Build. In Laravel, use it inside jobs or services to manage asynchronous GCP work without writing custom polling loops. It does not replace the service-specific google/cloud-* client that starts the operation.
- How do I install google/longrunning in Laravel with Composer?
- Run composer require google/longrunning in your Laravel project. The package is part of google-cloud-php and uses Composer autoloading, so no Laravel package discovery or service provider is required. For cleaner code, bind Google\Cloud\LongRunning\Operation\OperationClient as a singleton in a service provider and read credentials from config/services.php. Check Packagist for the exact PHP and dependency constraints before upgrading.
- How do I authenticate google/longrunning with GCP from Laravel?
- Create a GCP service account with the IAM roles needed for the target service and provide the JSON key through the client keyFilePath option or Application Default Credentials. In Laravel, centralize the path or credentials in config/services.php and env variables instead of hard-coding them. Follow the google-cloud-php authentication guide for service accounts and workload identity options. Never commit service account JSON files to your repository.
- Does google/longrunning support REST and gRPC, and is ext-grpc required?
- Yes, the component supports REST over HTTP/1.1 and gRPC. REST works without ext-grpc, which is useful in simple or low-throughput Laravel deployments. gRPC requires the PHP gRPC extension and is recommended for high-throughput or streaming scenarios where lower latency matters. You can start with REST and switch to gRPC later by installing ext-grpc and configuring the client for gRPC.
- How do I poll a Google long-running operation until done in Laravel?
- Fetch the operation with OperationClient::getOperation using the operation name returned by the GCP service, then check the operation done flag or use pollUntilDone where available in your client version. In Laravel, run the polling loop inside a ShouldQueue job with exponential backoff and a maximum timeout rather than blocking a web request. Store the operation ID so retries and Horizon monitoring can resume or report progress. Log terminal errors and notify users when the operation completes or fails.
- Can I use google/longrunning with Laravel queues, Horizon, and notifications?
- The package has no native Laravel queue or Horizon integration, but you can call its OperationClient from ShouldQueue jobs. A common pattern is to dispatch a job that starts the GCP operation, then dispatch a poller job that checks status and sends a Laravel notification on completion or failure. Horizon monitors the Laravel jobs themselves, not the GCP operation, so store operation metadata if you want custom progress views. This keeps long-running GCP work out of synchronous requests.
- Which PHP and Laravel versions work with google/longrunning?
- The package is part of google-cloud-php and the assessment context indicates PHP 8.1 or newer should be enforced with Composer. It is not tied to a specific Laravel version; use a Laravel release that supports your PHP version, such as Laravel 9, 10, or 11. Always verify the exact php and ext-* requirements on Packagist for the version you install. Test your chosen Laravel and PHP combination in CI before deploying.
- Is google/longrunning stable and maintained for production use?
- The README marks this component as beta but mostly stable and working toward a release candidate. It is maintained as part of the official google-cloud-php project, so authentication and debugging guidance are consistent with other GCP SDKs. For production, pin a tested version, wrap calls behind an interface, and monitor GCP quotas and operation failures. Alternatives include direct REST or gRPC calls or custom polling logic, but you would lose the generated client conveniences.
- How do I cancel, delete, or list long-running operations with google/longrunning?
- OperationClient provides methods for getting, listing, canceling, and deleting operations by name. Cancellation is typically best-effort and depends on whether the underlying GCP service supports canceling that operation. For batch jobs, handle ListOperations partial success and retry failed resources instead of assuming every operation succeeded. Check the official LongRunning API documentation for method semantics and error behavior.
- How should I handle failures, timeouts, and testing for GCP operations in Laravel?
- Wrap OperationClient calls in try/catch blocks, log Google exceptions with Laravel Log, and use failed() queue hooks plus notifications for terminal failures. Add retry and timeout limits around polling, and use exponential backoff to reduce API calls and cost spikes. For testing, put GCP calls behind a CloudOperationManager or similar interface and mock it in unit tests; run limited integration tests against a non-production GCP project. Handle partial success in list operations so failed resources can be retried safely.
Weaver
How can I help you explore Laravel packages today?