Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix webapi product custom attribute preprocessor execution #38657

Open
wants to merge 1 commit into
base: 2.4-develop
Choose a base branch
from

Conversation

gustavosolomon
Copy link

Description

This fixes the issue related to Webapi product custom attribute preprocessors described in the following issue:

#38633

Basically this fixes the validation mechanism that checks which preprocessor should run.

This also updates some function names and interface parameters, which is related to the issue fix.

Fixed Issues

  1. Fixes [Issue] Webapi product custom attribute preprocessor #38633

Manual testing scenarios

  1. Inject an processor object, using "customAttributePreprocessors" array in ServiceInputProcessor class.
  2. The processor injected to "customAttributePreprocessors" array should implement PreprocessorInterface interface. (Example bellow)
  3. Clear cache / generated code.
  4. Send a POST request to product API endpoint, in order to create/update some product data.
  5. Include manufacturer value inside custom_attributes data
  6. Processor process function should execute the desired code. (IE: die('manufacturer: it works');
<?php

declare(strict_types=1);

namespace Vendor\Module\Webapi\CustomAttribute;

use Magento\Framework\Webapi\CustomAttribute\PreprocessorInterface;

class TestProcessor implements PreprocessorInterface
{
    public function shouldBeProcessed(string $key, $attribute): bool
    {
        return true;
    }

    public function process(string $key, &$attribute)
    {
        // Do something with the attribute
        die('manufacturer: Do something with the attribute here');
    }

    public function getAffectedAttributes(): array
    {
        return ['manufacturer'];
    }
}

Contribution checklist

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/integration tests (if applicable)
  • README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
  • All automated tests passed successfully (all builds are green)

Copy link

m2-assistant bot commented Apr 24, 2024

Hi @gustavosolomon. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.

Add the comment under your pull request to deploy test or vanilla Magento instance:
  • @magento give me test instance - deploy test instance based on PR changes
  • @magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

  • @magento run all tests - run or re-run all required tests against the PR changes
  • @magento run <test-build(s)> - run or re-run specific test build(s)
    For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names.

Allowed build names are:
  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. Semantic Version Checker

You can find more information about the builds here
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.


For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

@m2-community-project m2-community-project bot added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Apr 24, 2024
@m2-community-project m2-community-project bot added this to Pending Review in Pull Requests Dashboard Apr 24, 2024
@gustavosolomon
Copy link
Author

@magento run all tests

@gustavosolomon gustavosolomon marked this pull request as draft April 24, 2024 17:39
@gustavosolomon gustavosolomon marked this pull request as ready for review April 24, 2024 17:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: pending review
Projects
Pull Requests Dashboard
  
Pending Review
Development

Successfully merging this pull request may close these issues.

[Issue] Webapi product custom attribute preprocessor
1 participant