yireo / magento2-byattribute-graph-ql

yireo/magento2-byattribute-graph-ql

Show any listing of any product attribute in GraphQL

  • Jisse Reitsma (Yireo)
magento2-module Compatibility: 2.4.7 Code Quality: Fail Tests: N/A Security: Pass OSL-3.0

Yireo ByAttribute GraphQL for Magento 2

This Magento 2 extension adds a GraphQL endpoint for accessing product attributes via GraphQL. This requires at least Magento 2.3 or higher.

To install this module, run:

composer require yireo/magento2-byattribute-graph-ql
./bin/magento module:enable Yireo_ByAttributeGraphQl

Sample GraphQL queries

Here are some sample GraphQL queries to show the usage of this extension:

{
  productAttribute(code:"material") {
    id
    code
    label
    default_value
    options {
      value
      label
      product_count
    }
  }
}

Or if you want to return less information (and include a category filter):

{
  productAttribute(code:"color", category_id: 42) {
    id
    options {
      value
    }
  }
}

TODO

  • Cache vital parts of product count
  • Refactor ProductCounter and split it up in smaller classes

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog,
and this project adheres to Semantic Versioning.

[Unreleased]

[0.1.1] - 29 July 2020

Added

  • Magento 2.4 compatibility

[0.1.0] - Undocumented

Versions
Version Stability QA Status Compatibility Released
0.1.1 stable Fail Magento 2.4.7 Details 2020-07-29 12:44:07
0.1.0 stable Not tested Not yet tested Details 2019-06-15 15:56:03

Requires 6

Package Constraint
magento/framework ^100.0|^101.0|^102.0|^103.0
magento/module-eav ^100.0|^101.0|^102.0
magento/module-catalog ^101.0|^102.0|^103.0|^104.0
magento/module-graph-ql ^100.3
laminas/laminas-db *
php >=7.0.0

Requires-dev 2

Package Constraint
phpunit/phpunit *
composer/composer *@dev

Suggests 1

Package Reason
yireo/magento2-byattribute2 *

Compatibility

Each Magento release line is installed on its supported PHP versions, then the module is built (DI compilation + static-content deploy) and its unit and integration suites are run. The matrix shows the lines and PHP versions the module is confirmed to install and run on. Code-quality results further down (phpstan, phpcs, …) are reported separately and never affect compatibility.

Compatibility matrix (Magento × PHP)
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 Pass Pass
2.4.8 Pass Fail di error
2.4.9 not tested not tested

Code Quality

Advisory checks against the module's source. Static analysis runs once across the whole module; PHPStan re-runs per Magento + PHP version because resolvable symbols differ between releases. These NEVER affect the Compatibility badge. 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.

Static analysis results
Tool Status Findings Summary
PHPCS Warning 6 6 warnings (ruleset: Magento2) — 6 auto-fixable with phpcbf
PHPMD Warning 9 9 rule violations (UnusedFormalParameter:9)
Cpd Pass 0
Composer validate Info 2 valid; 2 advisory notes (composer validate --strict)

PHPStan

Type-checks the module's PHP against a real Magento install at the configured gate level. Re-runs per Magento and PHP version because resolvable symbols differ between releases.

PHPStan results by Magento and PHP version
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 3 3
2.4.8 3 7
2.4.9 N/A N/A

Tests

Unit and integration suites, run for each applicable Magento and PHP version. A test failure speaks to the module's behaviour, not its compatibility with a Magento line, so it is reported here separately and never reddens the compatibility matrix.

Unit tests

Unit tests results by Magento and PHP version
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

Integration tests results by Magento and PHP version
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

Security checks run directly against the module: an audit of its declared dependencies for known vulnerabilities (composer audit) and a scan of its source for malware and web-shell signatures. Each runs once. A malware detection fails the version outright.

Security results
Tool Status Findings Summary
Composer audit Pass 0
Malware scan Pass 0
License
OSL-3.0
Homepage
https://www.yireo.com/software/magento-extensions/byattribute2
Authors

More from yireo

View vendor
Make it pay

Turn an existing module into recurring revenue.

If you already maintain a Magento 2 module on GitHub or GitLab, listing it on Packagento takes about five minutes. We mirror your tags, handle distribution signing, and route paid licenses through Stripe Connect, so you can keep shipping the way you already do.