Troubleshooting

Apply patches with composers post-install-cmd

I just want to introduce another approach that will apply Magento patches, in case your Magento instance isn’t hosted on Adobe’s Cloud infrastructure or can’t be applied as explained in How to apply a composer patch provided by Adobe for some reason.

1. Update your composer.json file

Add a new section “scripts” at the end of your composer.json file and validate your file with composer validate.

"scripts": {
    "post-install-cmd": [
        "patch -p1 < ./patches/MDVA-43395_EE_2.4.3-p1_COMPOSER_v1.patch"
    ]
}

"scripts": {

"post-install-cmd": [

"patch -p1 < ./patches/MDVA-43395_EE_2.4.3-p1_COMPOSER_v1.patch"

]

}

If you see ./composer.json is valid you are good to move on. Btw. your composer.lock file doesn’t need to be updated.

2. Create a folder ./patches/

Create a folder ./patches/ or something similar and copy your *.patch file in there.

3. Test it

Run composer install and wait. Your script and patch should be executed after Generating autoload files just like in the below output.

Generating autoload files
98 packages you are using are looking for funding.
Use the `composer fund` command to find out more!
> patch -p1 < ./patches/MDVA-43395_EE_2.4.3-p1_COMPOSER_v1.patch
patching file vendor/magento/module-email/Model/Template/Filter.php
patching file vendor/magento/framework/Filter/DirectiveProcessor/VarDirective.php

Generating autoload files

98 packages you are using are looking for funding.

Use the `composer fund` command to find out more!

> patch -p1 < ./patches/MDVA-43395_EE_2.4.3-p1_COMPOSER_v1.patch

patching file vendor/magento/module-email/Model/Template/Filter.php

patching file vendor/magento/framework/Filter/DirectiveProcessor/VarDirective.php

4. Deploy it

Commit your changes ( composer.json and ./patches/ ) folder and run your deployment procedure.

That’s it!

Magento 2 – How to fix ” The order confirmation email is not sent “

This morning I was working on an email issue ( multi-store ) where customers were able to purchase but didn’t receive the order confirmation email.

As always, I had a look at what has been deployed recently and checked pretty much all logs on the production environment. Unfortunately, I couldn’t find anything.

I started looking at database changes, especially the core_config_data table, and noticed that the template for the order confirmation was defined twice. This was kind of weird because those email settings were set to ” Use System Value “.

select * from core_config_data where path like 'sales_email/order%' order by scope;
+-----------+----------+----------+------------------------------------------+-------+---------------------+
| config_id | scope    | scope_id | path                                     | value | updated_at          |
+-----------+----------+----------+------------------------------------------+-------+---------------------+
|      1907 | default  |        0 | sales_email/order/template               | 27    | 2021-01-20 04:30:44 |
|      1908 | default  |        0 | sales_email/order/guest_template         | 27    | 2021-01-20 04:30:44 |
|      1909 | default  |        0 | sales_email/order/copy_to                | NULL  | 2021-04-06 07:33:12 ||
|      4293 | stores   |       21 | sales_email/order/template               | 27    | 2021-03-18 05:09:26 |
|      4296 | stores   |       21 | sales_email/order/guest_template         | 27    | 2021-03-18 05:09:26 |
|      4299 | stores   |       21 | sales_email/order/copy_to                | NULL  | 2021-03-20 05:12:37 |
+-----------+----------+----------+------------------------------------------+-------+---------------------+
6 rows in set (0.01 sec)

select * from core_config_data where path like 'sales_email/order%' order by scope;

+-----------+----------+----------+------------------------------------------+-------+---------------------+

+-----------+----------+----------+------------------------------------------+-------+---------------------+

| 1907 | default | 0 | sales_email/order/template | 27 | 2021-01-20 04:30:44 |

| 1908 | default | 0 | sales_email/order/guest_template | 27 | 2021-01-20 04:30:44 |

| 1909 | default | 0 | sales_email/order/copy_to | NULL | 2021-04-06 07:33:12 ||

| 4293 | stores | 21 | sales_email/order/template | 27 | 2021-03-18 05:09:26 |

| 4296 | stores | 21 | sales_email/order/guest_template | 27 | 2021-03-18 05:09:26 |

| 4299 | stores | 21 | sales_email/order/copy_to | NULL | 2021-03-20 05:12:37 |

+-----------+----------+----------+------------------------------------------+-------+---------------------+

6 rows in set (0.01 sec)

I ended up deleting the IDs 4293, 4296, 4299 which has fixed the issue immediately. I still don’t know why those values were set twice, but I hope this will help someone…sometime.

Magento Cloud – sendmail: /etc/msmtprc: line 6: command host needs an argument

This morning I ran a deployment on a fresh Magento Cloud environment and suddenly got the below SMTP error right after setup:upgrade, which was very unusual.

[2021-02-23 06:42:08] INFO: Running setup upgrade.
        [2021-02-23 06:56:37] INFO: Set flag: var/.deploy_is_failed
        [2021-02-23 06:56:37] ERROR: [126] The command "/bin/bash -c "set -o pipefail; php ./bin/magento setup:upgrade --keep-generated --ansi --no-interaction  | tee -a /app/var/log/install_upgrade.log"" failed. sendmail: /etc/msmtprc: line 6: command host needs an argument
        [2021-02-23 06:56:37] INFO: Set flag: var/.deploy_is_failed
        W: 
        W: In Processor.php line 129:
        W:                                                                                
        W:   The command "/bin/bash -c "set -o pipefail; php ./bin/magento setup:upgrade  
        W:    --keep-generated --ansi --no-interaction  | tee -a /app/var/log/install_up  
        W:   grade.log"" failed. sendmail: /etc/msmtprc: line 6: command host needs an a  
        W:   rgument                                                                      
        W:                                                                                
        W: 
        W: In InstallUpdate.php line 100:
        W:                                                                                
        W:   The command "/bin/bash -c "set -o pipefail; php ./bin/magento setup:upgrade  
        W:    --keep-generated --ansi --no-interaction  | tee -a /app/var/log/install_up  
        W:   grade.log"" failed. sendmail: /etc/msmtprc: line 6: command host needs an a  
        W:   rgument                                                                      
        W:                                                                                
        W: 
        W: In Setup.php line 58:
        W:                                                                                
        W:   The command "/bin/bash -c "set -o pipefail; php ./bin/magento setup:upgrade  
        W:    --keep-generated --ansi --no-interaction  | tee -a /app/var/log/install_up  
        W:   grade.log"" failed. sendmail: /etc/msmtprc: line 6: command host needs an a  
        W:   rgument                                                                      
        W:                                                                                
        W: 
        W: In Shell.php line 86:
        W:                                                                                
        W:   The command "/bin/bash -c "set -o pipefail; php ./bin/magento setup:upgrade  
        W:    --keep-generated --ansi --no-interaction  | tee -a /app/var/log/install_up  
        W:   grade.log"" failed. sendmail: /etc/msmtprc: line 6: command host needs an a  
        W:   rgument                                                                      
        W:                                                                                
        W: 
        W: deploy
        W:

[2021-02-23 06:42:08] INFO: Running setup upgrade.

[2021-02-23 06:56:37] INFO: Set flag: var/.deploy_is_failed

[2021-02-23 06:56:37] ERROR: [126] The command "/bin/bash -c "set -o pipefail; php ./bin/magento setup:upgrade --keep-generated --ansi --no-interaction | tee -a /app/var/log/install_upgrade.log"" failed. sendmail: /etc/msmtprc: line 6: command host needs an argument

[2021-02-23 06:56:37] INFO: Set flag: var/.deploy_is_failed

W: In Processor.php line 129:

W: The command "/bin/bash -c "set -o pipefail; php ./bin/magento setup:upgrade

W: --keep-generated --ansi --no-interaction | tee -a /app/var/log/install_up

W: grade.log"" failed. sendmail: /etc/msmtprc: line 6: command host needs an a

W: rgument

W: In InstallUpdate.php line 100:

W: The command "/bin/bash -c "set -o pipefail; php ./bin/magento setup:upgrade

W: --keep-generated --ansi --no-interaction | tee -a /app/var/log/install_up

W: grade.log"" failed. sendmail: /etc/msmtprc: line 6: command host needs an a

W: rgument

W: In Setup.php line 58:

W: The command "/bin/bash -c "set -o pipefail; php ./bin/magento setup:upgrade

W: --keep-generated --ansi --no-interaction | tee -a /app/var/log/install_up

W: grade.log"" failed. sendmail: /etc/msmtprc: line 6: command host needs an a

W: rgument

W: In Shell.php line 86:

W: The command "/bin/bash -c "set -o pipefail; php ./bin/magento setup:upgrade

W: --keep-generated --ansi --no-interaction | tee -a /app/var/log/install_up

W: grade.log"" failed. sendmail: /etc/msmtprc: line 6: command host needs an a

W: rgument

W: deploy

I had a look at the recent changes and found a mail() function in the modules InstallSchema.php script.

$to_email = 'sdfsdf@sdfsdf.com';
$subject = 'New Installation of sdfsdfsdf M2 extension';
$headers = "MIME-Version: 1.0" . "\r\n";
$headers .= "Content-type:text/html;charset=UTF-8" . "\r\n";
$headers .= 'From: ' . $merchantmail . '' . "\r\n";
mail($to_email, $subject, $body, $headers);

$to_email = 'sdfsdf@sdfsdf.com';

$subject = 'New Installation of sdfsdfsdf M2 extension';

$headers = "MIME-Version: 1.0" . "\r\n";

$headers .= "Content-type:text/html;charset=UTF-8" . "\r\n";

$headers .= 'From: ' . $merchantmail . '' . "\r\n";

mail($to_email, $subject, $body, $headers);

In this particular case, a 3rd party module developer has implemented a tracking system to notify his agency about new module installations. It may work on some hosting platforms, but obviously not on Magento Cloud during the build process.

Notice: Use of undefined constant T_CURLY_OPEN – assumed ‘T_CURLY_OPEN’ in /var/www/src/setup/src/ Magento/Setup/Module/ Di/Code/Reader/FileClassScanner.php on line 72

Today I finally had some time to cleaned up my Dockerfile for Magento 2. I am using Alpine Linux for most of my Magento 2 projects which usually includes NGINX, PHP-FPM and MariaDB.

# Use Alpine Linux
FROM alpine:3.7

# Declare maintainer
MAINTAINER Tobias Forkel <tobias@forkel.me>

# Timezone
ENV TIMEZONE Australia/Melbourne

RUN addgroup -g 1000 www && \
    adduser -S www -G www -s /sbin/nologin -D

ADD https://repos.php.earth/alpine/phpearth.rsa.pub /etc/apk/keys/phpearth.rsa.pub
RUN echo "https://repos.php.earth/alpine/v3.7" >> /etc/apk/repositories

RUN apk --no-cache add \
    bash \
    git \
	openssl \
	nginx \
	supervisor \
	curl \
	mariadb \
	mariadb-client \
	libxml2-utils \
	php7.1-common \
	php7.1-fpm \
	php7.1-json \
....

# Use Alpine Linux

FROM alpine:3.7

# Declare maintainer

MAINTAINER Tobias Forkel <tobias@forkel.me>

# Timezone

ENV TIMEZONE Australia/Melbourne

RUN addgroup -g 1000 www && \

adduser -S www -G www -s /sbin/nologin -D

ADD https://repos.php.earth/alpine/phpearth.rsa.pub /etc/apk/keys/phpearth.rsa.pub

RUN echo "https://repos.php.earth/alpine/v3.7" >> /etc/apk/repositories

RUN apk --no-cache add \

bash \

git \

openssl \

nginx \

supervisor \

curl \

mariadb \

mariadb-client \

libxml2-utils \

php7.1-common \

php7.1-fpm \

php7.1-json \

....

While testing my updated Dockerfile I came across the following PHP notice which prevented the deployment scripts from finishing the Magento 2 setup.

Notice: Use of undefined constant T_CURLY_OPEN - assumed 'T_CURLY_OPEN' in /var/www/src/setup/src/Magento/Setup/Module/ Di/Code/Reader/FileClassScanner.php on line 72

1	Notice: Use of undefined constant T_CURLY_OPEN - assumed 'T_CURLY_OPEN' in /var/www/src/setup/src/Magento/Setup/Module/ Di/Code/Reader/FileClassScanner.php on line 72

The problem was simply a missing PHP extension php7.1-tokenizer which has resolved the issue after re-creating the container with –build.

docker-compose up -d --build

1	docker-compose up -d --build

The use of function filectime() / filemtime() is discouraged in Magento2

The problem I had today was located in a helper ( [Namespace]\[Module]\Helper\FileSystem ) which I have created for some basic filesystem operations. The below message was the result of Magento’s EQP which I use before I commit any code.

 68 | WARNING | The use of function filectime() is discouraged
 69 | WARNING | The use of function filemtime() is discouraged

1 2	68 \| WARNING \| The use of function filectime() is discouraged 69 \| WARNING \| The use of function filemtime() is discouraged

The warning message basically means, I should find another way to get the creation and modification time of a file because of Magento’s coding standards. I have done that a couple of times already and would like to share my solution this time. First you have to pass \Magento\Framework\Filesystem\Driver\File in your existing constructor or create a new one.

protected $driverFile;
...
public function __construct(
    ...
    \Magento\Framework\Filesystem\Driver\File $driverFile,
    ...
) {
    $this->driverFile = $driverFile;
    ...
    parent::__construct($context);
}

protected $driverFile;

...

public function __construct(

...

\Magento\Framework\Filesystem\Driver\File $driverFile,

...

) {

$this->driverFile = $driverFile;

...

parent::__construct($context);

}

Once you have re-compiled your code, you have access to the file stats as follows.

$file = '/absolute/path/to/your/file.extension';
$fileData = $this->driverFile->stat($file);

1 2	$file = '/absolute/path/to/your/file.extension'; $fileData = $this->driverFile->stat($file);

Beside ctime and mtime the array $fileData should have other file information like size, atime, uid and gid.

UI Components and searchResultToOutput in Magento2

Today I had to fix the following issue in a custom module. The error appeared on the UI Component list view.

Fatal error: Method Magento\Ui\TemplateEngine\Xhtml\Result::__toString() must not throw an exception, caught TypeError: Argument 1 passed to Magento\Framework\View\Element\UiComponent\DataProvider\DataProvider::searchResultToOutput() must implement interface Magento\Framework\Api\Search\SearchResultInterface, instance of [Namespace]\[Module]\Model\ResourceModel\Team\Collection given, called in

Fatal error: Method Magento\Ui\TemplateEngine\Xhtml\Result::__toString() must not throw an exception, caught TypeError: Argument 1 passed to Magento\Framework\View\Element\UiComponent\DataProvider\DataProvider::searchResultToOutput() must implement interface Magento\Framework\Api\Search\SearchResultInterface, instance of [Namespace]\[Module]\Model\ResourceModel\Team\Collection given, called in

I found the reason of the problem in the di.xml file. All what was missing was the following virtualType node. After adding this and re-compiling the code, the list view was fixed.

<virtualType name="[Namespace]\[Module]\Model\ResourceModel\Team\Collection" type="Magento\Framework\View\Element\UiComponent\DataProvider\SearchResult">
    <arguments>
        <argument name="mainTable" xsi:type="string">[namespace]_[module]_team</argument>
        <argument name="resourceModel" xsi:type="string">[Namespace]\[Module]\Model\ResourceModel\Team</argument>
    </arguments>
</virtualType>

<argument name="mainTable" xsi:type="string">[namespace]_[module]_team</argument>

<argument name="resourceModel" xsi:type="string">[Namespace]\[Module]\Model\ResourceModel\Team</argument>

</arguments>

</virtualType>

UI Component Listing And Not registered handle in Magento2

Today I created a new listing for a custom module, but unfortunately all what I got was the error message below.

Not registered handle [namespace]_[module]_team_index_data_source

1	Not registered handle [namespace]_[module]_team_index_data_source

After digging around for few minutes I noticed the above handler was actually missing in the di.xml file. I simply added the following collections argument and re-compiled the code.

<type name="Magento\Framework\View\Element\UiComponent\DataProvider\CollectionFactory">
    <arguments>
        <argument name="collections" xsi:type="array">
            ...
            <item name="[namespace]_[module]_team_index_data_source" xsi:type="string">[Namespace]\[Module]\Model\ResourceModel\Team\Collection</item>
            ...
        </argument>
    </arguments>
</type>

...

<item name="[namespace]_[module]_team_index_data_source" xsi:type="string">[Namespace]\[Module]\Model\ResourceModel\Team\Collection</item>

...

</argument>

</arguments>

</type>

All good!

Update composer.lock without updating code

Recently I had to fix a broken composer.lock but without actually updating code. I have found the composer option ” nothing ” which updates the composer.lock file only.

$ composer update nothing

1	$ composer update nothing

Once the command ran successfully, you should see a line ” Writing lock file ” in the output.

$ composer update nothing
Loading composer repositories with package information
Updating dependencies (including require-dev)
Nothing to install or update
Writing lock file
Generating autoload files

$ composer update nothing

Loading composer repositories with package information

Updating dependencies (including require-dev)

Nothing to install or update

Writing lock file

Generating autoload files

If you have issues with dependencies you can update the composer.lock file with –ignore-platform-reqs.

$ composer update nothing --ignore-platform-reqs

1	$ composer update nothing --ignore-platform-reqs

Missing required argument $name of Xtento\ProductExport\Logger\Logger.

If you are using Xtento in combination with an automated product importer, you may have seen the following error before.

Missing required argument $name of Xtento\ProductExport\Logger\Logger.

1	Missing required argument $name of Xtento\ProductExport\Logger\Logger.

The error message appears right after saving a product. The reason is that, at least one of your products in Products > Catalog has no Name. To fix this, you can update the name manually via MySQL queries or simply delete the products and import again correctly.

Bulk Update Customizable Product Options in Magento2

Today I had to bulk-update the Price and Max Characters in the tab Customizable Options for hundreds of simple products based on the title.

I knew that it could be done programmatically but I figured out that it can be done just by updating the table catalog_product_option and catalog_product_option_price. First I got a comma separated list of option_id’s based on a specific title.

SELECT GROUP_CONCAT(option_id SEPARATOR ",") AS option_ids FROM catalog_product_option_title WHERE title = 'Some Message';

1	SELECT GROUP_CONCAT(option_id SEPARATOR ",") AS option_ids FROM catalog_product_option_title WHERE title = 'Some Message';

277,281,284,286,289,292,293,294,295

1	277,281,284,286,289,292,293,294,295

With the comma separated list I was able to update the value of the Price and Max Characters as follows.

1. Price

UPDATE catalog_product_option_price SET price = 5.000 WHERE option_id IN (277,281,284,286,289,292,293,294,295);

1	UPDATE catalog_product_option_price SET price = 5.000 WHERE option_id IN (277,281,284,286,289,292,293,294,295);

2. Max Characters

UPDATE catalog_product_option SET max_characters = 300 WHERE option_id IN (277,281,284,286,289,292,293,294,295);

1	UPDATE catalog_product_option SET max_characters = 300 WHERE option_id IN (277,281,284,286,289,292,293,294,295);

Possible that you have to flush the cache ( php/magento cache:flush ) and re-index everything ( php/magento indexer:reindex ) to see the results.