CatalogExportApi auto-generation #16

bricht · 2020-11-23T15:12:38Z

-Added a Setup/Recurring class to autogenerate the CatalogExportApi files upon se:up
-Removed the cliCommand
-Removed the manually added files from CatalogExportApi/Api/Data

Description (*)

Related Pull Requests

https://github.com/magento-commerce/commerce-data-export-ee/pull/3

Fixed Issues (if relevant)

Fixes CatalogExportApi autogeneration catalog-storefront#430

Questions or comments

Code Review Checklist (*)

Story AC is completed
proposed changes correspond to Magento Technical Vision
new or changed code is covered with web-api/integration tests (if applicable)
no backward incompatible changes

-Added a Setup/Recurring class to autogenerate the CatalogExportApi files upon se:up -Removed the cliCommand -Removed the manually added files from CatalogExportApi/Api/Data

bricht · 2020-11-23T15:12:49Z

@magento run all tests

-Added php generator requirement

bricht · 2020-11-24T08:29:45Z

@magento run all tests

- Static fixes

bricht · 2020-11-25T12:57:04Z

@magento run WebAPI Tests

- Added comments to README describing DTO generation and necessity for nette/php-generator

bricht · 2020-11-25T16:56:35Z

@magento run all tests

bricht · 2020-11-26T11:36:27Z

@magento run WebAPI Tests

-docblock fix -added return type

bricht · 2020-11-26T11:58:47Z

@magento run all tests

slavvka · 2020-11-30T16:12:44Z

@magento run WebAPI Tests

RuslanKostiv1 · 2020-12-01T01:00:17Z

Build fails while installation @bricht

11:22:59 [testsuitegroup0] [Progress: 369 / 1331]
11:22:59 [testsuitegroup0] Module 'Magento_CatalogExport':
11:22:59 [testsuitegroup0] [Progress: 370 / 1331]
11:22:59 [testsuitegroup0] Module 'Magento_CatalogExportApi':
11:22:59 [testsuitegroup0] Running schema recurring...
11:22:59 [testsuitegroup0] In Recurring.php line 82:
11:22:59 [testsuitegroup0] 
11:22:59 [testsuitegroup0]   [RuntimeException]
11:22:59 [testsuitegroup0]   Could not generate ExportApi DTO's Error: Class 'Nette\PhpGenerator\PhpFile
11:22:59 [testsuitegroup0]   ' not found in /var/www/html/app/code/Magento/CatalogExportApi/Setup/Recurr
11:22:59 [testsuitegroup0]   ing.php:204
11:22:59 [testsuitegroup0]   Stack trace:
11:22:59 [testsuitegroup0]   #0 /var/www/html/app/code/Magento/CatalogExportApi/Setup/Recurring.php(80):
11:22:59 [testsuitegroup0]    Magento\CatalogExportApi\Setup\Recurring->generateFiles()
11:22:59 [testsuitegroup0]   #1 /var/www/html/setup/src/Magento/Setup/Model/Installer.php(1117): Magento
11:22:59 [testsuitegroup0]   \CatalogExportApi\Setup\Recurring->install()
11:22:59 [testsuitegroup0]   #2 /var/www/html/setup/src/Magento/Setup/Model/Installer.php(895): Magento\
11:22:59 [testsuitegroup0]   Setup\Model\Installer->handleDBSchemaData()
11:22:59 [testsuitegroup0]   #3 [internal function]: Magento\Setup\Model\Installer->installSchema()
11:22:59 [testsuitegroup0]   #4 /var/www/html/setup/src/Magento/Setup/Model/Installer.php(389): call_use
11:22:59 [testsuitegroup0]   r_func_array()
11:22:59 [testsuitegroup0]   #5 /var/www/html/setup/src/Magento/Setup/Console/Command/InstallCommand.php
11:22:59 [testsuitegroup0]   (231): Magento\Setup\Model\Installer->install()
11:22:59 [testsuitegroup0]   #6 /var/www/html/vendor/symfony/console/Command/Command.php(255): Magento\S
11:22:59 [testsuitegroup0]   etup\Console\Command\InstallCommand->execute()
11:22:59 [testsuitegroup0]   #7 /var/www/html/vendor/symfony/console/Application.php(1000): Symfony\Comp
11:22:59 [testsuitegroup0]   onent\Console\Command\Command->run()
11:22:59 [testsuitegroup0]   #8 /var/www/html/vendor/symfony/console/Application.php(271): Symfony\Compo
11:22:59 [testsuitegroup0]   nent\Console\Application->doRunCommand()
11:22:59 [testsuitegroup0]   #9 /var/www/html/lib/internal/Magento/Framework/Console/Cli.php(115): Symfo
11:22:59 [testsuitegroup0]   ny\Component\Console\Application->doRun()
11:22:59 [testsuitegroup0]   #10 /var/www/html/vendor/symfony/console/Application.php(147): Magento\Fram
11:22:59 [testsuitegroup0]   ework\Console\Cli->doRun()
11:22:59 [testsuitegroup0]   #11 /var/www/html/bin/magento(23): Symfony\Component\Console\Application->r
11:22:59 [testsuitegroup0]   un()
11:22:59 [testsuitegroup0]   #12 {main}

RuslanKostiv1

please take a look into build logs

mslabko · 2020-12-01T18:21:30Z

@magento run WebAPI Tests

mslabko · 2020-12-01T19:25:19Z

@magento run WebAPI Tests

-Fixed namespace

bricht · 2020-12-02T10:05:03Z

@magento run all tests

bricht · 2020-12-02T11:55:22Z

@magento run WebAPI Tests

mslabko · 2020-12-02T16:16:46Z

app/code/Magento/CatalogExportApi/Setup/Recurring.php

     */
-    protected function execute(InputInterface $input, OutputInterface $output): ?int
+    public function install(SchemaSetupInterface $setup, ModuleContextInterface $context): void


Please, create a separate class with "generation" logic - so we can use it inside Recurring/di compile ...

le0n4ik · 2020-12-02T21:46:34Z

You can use following plugin to intercept the GenerateApplicationCode operation:

Index: app/code/Magento/CatalogExport/Plugin/GenerateApplicationCode.php
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
--- app/code/Magento/CatalogExport/Plugin/GenerateApplicationCode.php	(date 1606938749913)
+++ app/code/Magento/CatalogExport/Plugin/GenerateApplicationCode.php	(date 1606938749913)
@@ -0,0 +1,27 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CatalogExport\Plugin;
+
+use Magento\Setup\Module\Di\App\Task\Operation\ApplicationCodeGenerator;
+
+/**
+ * @see \Magento\Setup\Module\Di\App\Task\Operation\ApplicationCodeGenerator
+ */
+class GenerateApplicationCode
+{
+    /**
+     * @param ApplicationCodeGenerator $subject
+     * @return void
+     */
+    public function afterDoOperation(
+        ApplicationCodeGenerator $subject
+    ): void {
+        // TODO: Implement plugin method.
+        $result = true;
+    }
+}
\ No newline at end of file
Index: app/code/Magento/CatalogExport/etc/di.xml
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
--- app/code/Magento/CatalogExport/etc/di.xml	(revision 47a365a72c81af47bab4b51f1196b4a95c285e69)
+++ app/code/Magento/CatalogExport/etc/di.xml	(date 1606944914618)
@@ -52,4 +52,7 @@
             </argument>
         </arguments>
     </type>
+    <type name="Magento\Setup\Module\Di\App\Task\Operation\ApplicationCodeGenerator">
+        <plugin name="GenerateGrpcCode" type="Magento\CatalogExport\Plugin\GenerateApplicationCode" sortOrder="0"/>
+    </type>
 </config>

-Moved export api generator code from CatalogExportApi to CatalogExport module -Added plugin which generates dtos during setup:di:compile

bricht · 2020-12-03T17:12:05Z

@magento run all tests

-Static fix

-Improved generation class and fixed docblock bugs in generated classes

bricht · 2020-12-07T09:40:38Z

@magento run all tests

-Test fixes

bricht · 2020-12-07T14:41:01Z

@magento run all tests

-Static fix

bricht · 2020-12-08T07:07:01Z

@magento run all tests

This reverts commit a80dc6f.

bricht · 2020-12-08T14:23:09Z

The WebAPI test failure has been fixed in magento/catalog-storefront#436 . Test is failing because the order of variants is not consistent, so it was using wrong variant to match.

The Static test failure doesnt make a whole lot of sense. It is saying that the generated getter/setter return type is invalid, which I expect is because the returned class might not exist at the time the test is run on the class, however it does exist by the end of generation.

For example:

Return typehint of method                                              
Magento\CatalogExportApi\Api\Data\Product::getImage() has invalid      
type Magento\CatalogExportApi\Api\Data\ImageDeprecated.

bricht · 2020-12-08T14:24:28Z

The rest of the failures are unrelated to my changes from what I can tell

bricht · 2020-12-09T15:26:26Z

@magento run all tests

RuslanKostiv1 · 2020-12-09T17:41:22Z

@magento run Static Tests

RuslanKostiv1 · 2020-12-09T18:27:40Z

@magento run Static Tests

RuslanKostiv1 · 2020-12-09T19:12:58Z

@magento run Static Tests, Magento Health Index

RuslanKostiv1 · 2020-12-09T20:08:14Z

@magento run Static Tests, Magento Health Index

RuslanKostiv1 · 2020-12-09T20:56:08Z

@magento import pr to magento-commerce/commerce-data-export

magento-engcom-team · 2020-12-09T20:57:11Z

@RuslanKostiv1 the pull request successfully imported.

…e-data-export-2 [Imported] Support for ratings & reviews in Storefront App

MDEE-40: fix key issue

CatalogExportApi auto-generation

293f39d

-Added a Setup/Recurring class to autogenerate the CatalogExportApi files upon se:up -Removed the cliCommand -Removed the manually added files from CatalogExportApi/Api/Data

CatalogExportApi auto-generation

32ab424

-Added php generator requirement

CatalogExportApi auto-generation

8f681ae

- Static fixes

CatalogExportApi auto-generation

e64d267

- Added comments to README describing DTO generation and necessity for nette/php-generator

CatalogExportApi auto-generation

4a108b7

-docblock fix -added return type

RuslanKostiv1 suggested changes Dec 1, 2020

View reviewed changes

CatalogExportApi auto-generation

b6da498

-Fixed namespace

mslabko reviewed Dec 2, 2020

View reviewed changes

CatalogExportApi auto-generation

3e0668a

-Moved export api generator code from CatalogExportApi to CatalogExport module -Added plugin which generates dtos during setup:di:compile

jekabs added 3 commits December 4, 2020 17:26

CatalogExportApi auto-generation

c8b6def

-Static fix

CatalogExportApi auto-generation

b7b46a0

-Improved generation class and fixed docblock bugs in generated classes

Merge branch 'main' into 430_catalog-export-api-autogen

95d7c40

CatalogExportApi auto-generation

88bc3f0

-Test fixes

CatalogExportApi auto-generation

a80dc6f

-Static fix

Revert "CatalogExportApi auto-generation"

18b6437

This reverts commit a80dc6f.

Static tests fixes

3244b05

Static tests fixes

b3953d4

Static tests fixes

d027f3e

RuslanKostiv1 added 2 commits December 9, 2020 15:29

Documentation update.

ba94037

Documentation update.

c96499c

mmansoor-magento merged commit e74ea72 into magento:main Dec 10, 2020

mmansoor-magento pushed a commit that referenced this pull request Dec 10, 2020

Merge pull request #16 from magento-commerce/imported-magento-commerc…

9049847

…e-data-export-2 [Imported] Support for ratings & reviews in Storefront App

magento-devops-reposync-svc pushed a commit that referenced this pull request Nov 4, 2021

Merge pull request #16 from magento-troll/MDEE-40-fix-key-issue

194d9e2

MDEE-40: fix key issue

CatalogExportApi auto-generation #16

CatalogExportApi auto-generation #16

Uh oh!

Conversation

bricht commented Nov 23, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Questions or comments

Code Review Checklist (*)

Uh oh!

bricht commented Nov 23, 2020

Uh oh!

bricht commented Nov 24, 2020

Uh oh!

bricht commented Nov 25, 2020

Uh oh!

bricht commented Nov 25, 2020

Uh oh!

bricht commented Nov 26, 2020

Uh oh!

bricht commented Nov 26, 2020

Uh oh!

slavvka commented Nov 30, 2020

Uh oh!

RuslanKostiv1 commented Dec 1, 2020

Uh oh!

RuslanKostiv1 left a comment

Choose a reason for hiding this comment

Uh oh!

mslabko commented Dec 1, 2020

Uh oh!

mslabko commented Dec 1, 2020

Uh oh!

bricht commented Dec 2, 2020

Uh oh!

bricht commented Dec 2, 2020

Uh oh!

mslabko Dec 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

le0n4ik commented Dec 2, 2020

Uh oh!

bricht commented Dec 3, 2020

Uh oh!

bricht commented Dec 7, 2020

Uh oh!

bricht commented Dec 7, 2020

Uh oh!

bricht commented Dec 8, 2020

Uh oh!

bricht commented Dec 8, 2020

Uh oh!

bricht commented Dec 8, 2020

Uh oh!

bricht commented Dec 9, 2020

Uh oh!

RuslanKostiv1 commented Dec 9, 2020

Uh oh!

RuslanKostiv1 commented Dec 9, 2020

Uh oh!

RuslanKostiv1 commented Dec 9, 2020

Uh oh!

RuslanKostiv1 commented Dec 9, 2020

Uh oh!

RuslanKostiv1 commented Dec 9, 2020

Uh oh!

magento-engcom-team commented Dec 9, 2020

Uh oh!

Uh oh!

bricht commented Nov 23, 2020 •

edited

Loading

mslabko Dec 2, 2020 •

edited

Loading