# mage-os/mageos-async-events-gcp

> GCP event sinks for mage-os/mageos-async-events

`composer require mage-os/mageos-async-events-gcp`

Canonical URL: https://packagento.com/mage-os/mageos-async-events-gcp

## At a glance

- **Vendor**: mage-os (https://packagento.com/mage-os.md)
- **Latest version**: 4.0.3 — released 2026-02-09
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/mage-os/mageos-async-events-gcp and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require mage-os/mageos-async-events-gcp:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

GCP event sinks for mage-os/mageos-async-events

## README

GCP event sinks for [mageos-async-events](https://github.com/mage-os/mageos-async-events)

### Installation

```sh
composer require mage-os/mageos-async-events-gcp
```

### Authenticating with Google Cloud Client Libraries

This module relies on Google's PHP Cloud Client Libraries. Each event sink uses a corresponding library to perform
requests to Google Cloud.

For more information about the client libraries, please see https://cloud.google.com/php/docs/reference

As per the [Authentication Guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md), the
recommended way to authenticate to the Google Cloud PHP library is to use Application Default Credentials (ADC),
which discovers your credentials automatically, based on the environment where your code is running.

Application Default Credentials (ADC) typically come in the form of a credential JSON file. This file can include
credentials for workload identity federation, workforce identity federation, or a service account key.

There are many ways to obtain an ADC, so you must review and choose a method that fits your use case.

> [!IMPORTANT]
> Service account keys can pose a security risk if not managed correctly. Whenever possible, opt for a more secure
> alternative to service account keys.

To authenticate using different methods, refer to the following guides:

- **Service Account Key:** [Service account key authentication](https://cloud.google.com/docs/authentication/provide-credentials-adc#wlif-key)
- **Workload Identity Federation:** [Workload Identity Federation authentication](https://cloud.google.com/docs/authentication/provide-credentials-adc#wlif)
- **Google Cloud Services:** If your code is running on a supported Google Cloud service such as Compute Engine, you can authenticate by attaching a service account. Read more about [Google Cloud services that support attaching a service account](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa)
- **GKE or GKE Enterprise:** [Containerized authentication](https://cloud.google.com/docs/authentication/provide-credentials-adc#containerized)

### GCP event sinks

#### Google Pub/Sub

**Setup Application Default Credentials (ADC)**

A Service Account with the `Pub/Sub Publisher` role is required so that the notifier can relay events into Google
Pub/Sub.

Under `Stores -> Services -> Async Events GCP` set the `ADC Path`.

![gcp-pubsub-config example](docs/gcp-pubsub-config.png)

**Create a Pub/Sub Subscription**

The following is an example to create a Pub/Sub subscription for the `example.event`

```sh
curl --location --request POST 'https://test.mageos.dev/rest/V1/async_event' \
--header 'Authorization: Bearer TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
    "asyncEvent": {
        "event_name": "example.event",
        "recipient_url": "Google Pub/Sub Topic",
        "verification_token": "supersecret",
        "metadata": "pubsub"
    }
}'
```

## Recent Versions

| Version | Released |
|---|---|
| 4.0.3 | 2026-02-09 |
| 4.0.1 | 2025-10-31 |
| 4.0.0 | 2024-07-24 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| google/cloud-pubsub | ^2.0 |
| mage-os/mageos-async-events | ^4.0 |
| php | >=8.1 |

## Quality

Latest release (4.0.3) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Pass | 0 |  |
| PHPMD | Pass | 0 |  |
| Cpd | Pass | 0 |  |
| Composer validate | Pass | 0 |  |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 17 | 17 | – | – |
| 2.4.8 | – | 17 | 17 | – |
| 2.4.9 | – | – | 17 | 17 |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["mage-os/mageos-async-events-gcp"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

mage-os is a Magento 2 vendor on Packagento. See https://packagento.com/mage-os.md for their full catalogue.