createCustomer validation requirements #28888

michalderlatka · 2020-06-25T12:54:20Z

Description (*)

Currently createCustomer and updateCustomer are using same input CustomerInput. But for createCustomer some fields are required. Schema definition does not specify which ones are required. I followed https://github.com/magento/architecture/blob/master/design-documents/graph-ql/coverage/customer-email-password-update.md
and created newer mutation for customer update. Also createCustomer mutation will now use CustomerCreateInput which properly shows on schema level which fields are required.

Related Pull Requests

Fixed Issues (if relevant)

Fixes #28570

Manual testing scenarios (*)

Test customer mutations:
createCustomer
updateCustomerV2
updateCustomerEmail

Questions or comments

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)
All automated tests passed successfully (all builds are green)

…o 28570_createcustomer_graphql_schema

m2-assistant · 2020-06-25T12:54:22Z

Hi @michalderlatka. Thank you for your contribution
Here is some useful tips 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:

Database Compare
Functional Tests CE
Functional Tests EE,
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
WebAPI Tests

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

For more details, please, review the Magento Contributor Guide documentation.

michalderlatka · 2020-06-25T18:42:52Z

@magento run all tests

app/code/Magento/CustomerGraphQl/etc/schema.graphqls

cpartica · 2020-06-26T22:09:16Z

app/code/Magento/CustomerGraphQl/Model/Resolver/UpdateCustomerEmail.php

@@ -0,0 +1,78 @@
+<?php
+


add copyright

cpartica · 2020-06-26T22:09:41Z

app/code/Magento/CustomerGraphQl/Model/Resolver/UpdateCustomerEmail.php

+        array $value = null,
+        array $args = null
+    ) {
+        /** @var \Magento\GraphQl\Model\Query\ContextInterface $context */


cpartica · 2020-06-26T22:10:17Z

app/code/Magento/CustomerGraphQl/Model/Resolver/UpdateCustomerEmail.php

+            throw new GraphQlAuthorizationException(__('The current customer isn\'t authorized.'));
+        }
+
+        if (empty($args['email']) || empty($args['password'])) {


isn't this enforced by schema?

cpartica · 2020-06-26T22:11:39Z

app/code/Magento/CustomerGraphQl/Model/Resolver/UpdateCustomerEmail.php

+        $customer = $this->getCustomer->execute($context);
+        $this->updateCustomerAccount->execute(
+            $customer,
+            ['email' => $args['email'], 'password' => $args['password']],


unsafe array index, could cause an exception:
we usually do : $email = $args['email'] ?? null
I think the input is enforced by schema
try catch should take care of it, if you really want to show some error to graphql

michalderlatka · 2020-06-30T11:44:56Z

@magento run all tests

…(static test fix)

michalderlatka · 2020-07-07T05:58:14Z

@magento run all tests

app/code/Magento/CustomerGraphQl/etc/schema.graphqls

cpartica · 2020-07-08T00:15:43Z

app/code/Magento/CustomerGraphQl/etc/schema.graphqls

@@ -17,14 +17,16 @@ type Query {
 type Mutation {
    generateCustomerToken(email: String!, password: String!): CustomerToken @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\GenerateCustomerToken") @doc(description:"Retrieve the customer token")
    changeCustomerPassword(currentPassword: String!, newPassword: String!): Customer @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\ChangePassword") @doc(description:"Changes the password for the logged-in customer")
-    createCustomer (input: CustomerInput!): CustomerOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\CreateCustomer") @doc(description:"Create customer account")
-    updateCustomer (input: CustomerInput!): CustomerOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\UpdateCustomer") @doc(description:"Update the customer's personal information")
+    createCustomer (input: CustomerCreateInput!): CustomerOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\CreateCustomer") @doc(description:"Create customer account")


we can't change inputs on existing queries, so createCustomer (input: CustomerInput!): has to remain like this
and do a createCustomerV2 that uses CustomerCreateInput

cpartica · 2020-07-08T00:17:49Z

dev/tests/api-functional/testsuite/Magento/GraphQl/Customer/CreateCustomerTest.php

@@ -116,14 +116,18 @@ public function testCreateCustomerAccountWithoutPassword()
     */
    public function testCreateCustomerIfInputDataIsEmpty()
    {
+        $exceptionMessage = 'Field CustomerCreateInput.email of required type String! was not provided.


a string either has "\n" or we can't do multi line strings like this. We usually don't add multi line exceptions

app/code/Magento/CustomerGraphQl/Model/Resolver/UpdateCustomerEmail.php

cpartica · 2020-07-08T00:19:46Z

app/code/Magento/CustomerGraphQl/Model/Resolver/UpdateCustomerEmail.php

+    }
+
+    /**
+     * @inheritdoc


you can add a proper description here

michalderlatka · 2020-07-09T13:05:49Z

@magento run all tests

cpartica · 2020-07-09T21:01:37Z

@michalderlatka plz fix the static failures, some of those were exposed in the comments of the PR

cpartica · 2020-07-09T21:04:17Z

app/code/Magento/CustomerGraphQl/Model/Resolver/UpdateCustomerEmail.php

+    }
+
+    /**
+     * Resolves customer email update mutation


we use "Resolve" imperative format. - you used Resolves as descriptive format
Also add params annotation
also add supress annotation, because not all params are used here:

PHP Code Mess has found error(s): /var/www/html/app/code/Magento/CustomerGraphQl/Model/Resolver/UpdateCustomerEmail.php:58 Avoid unused parameters such as '$field'. /var/www/html/app/code/Magento/CustomerGraphQl/Model/Resolver/UpdateCustomerEmail.php:60 Avoid unused parameters such as '$info'. /var/www/html/app/code/Magento/CustomerGraphQl/Model/Resolver/UpdateCustomerEmail.php:61 Avoid unused parameters such as '$value'.

…(static test fix)

michalderlatka · 2020-07-13T11:40:19Z

@magento run all tests

cpartica · 2020-07-14T21:23:16Z

@magento run all tests

m2-assistant · 2020-07-16T14:39:01Z

Hi @michalderlatka, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

michalderlatka added 2 commits June 25, 2020 14:32

magento#28570: createCustomer does not match validation requirements

1943018

Merge branch '2.4-develop' of https://github.com/magento/magento2 int…

887f191

…o 28570_createcustomer_graphql_schema

ghost added the Progress: pending review label Jun 25, 2020

magento-engcom-team added Component: CustomerGraphQl Release Line: 2.4 labels Jun 25, 2020

michalderlatka added PAP Partners acceleration program Project: GraphQL labels Jun 25, 2020

cpartica reviewed Jun 26, 2020

View reviewed changes

app/code/Magento/CustomerGraphQl/etc/schema.graphqls Show resolved Hide resolved

ghost assigned cpartica Jun 26, 2020

cpartica requested changes Jun 26, 2020

View reviewed changes

ghost added Progress: needs update and removed Progress: pending review labels Jun 26, 2020

magento#28570: createCustomer does not match validation requirements

b5208cd

magento#28570: createCustomer does not match validation requirements …

0f7d805

…(static test fix)

cpartica requested changes Jul 8, 2020

View reviewed changes

ghost added Progress: to approve and removed Progress: needs update labels Jul 8, 2020

magento#28570: createCustomer does not match validation requirements

592f5de

cpartica requested changes Jul 9, 2020

View reviewed changes

ghost added Progress: needs update and removed Progress: to approve labels Jul 9, 2020

cpartica removed the Progress: needs update label Jul 9, 2020

magento#28570: createCustomer does not match validation requirements …

3a4cfa1

…(static test fix)

nrkapoor added this to the 2.4.1 milestone Jul 14, 2020

nrkapoor requested review from avattam06, prabhuram93 and danielrenaud July 14, 2020 14:30

cpartica approved these changes Jul 14, 2020

View reviewed changes

ghost added the Progress: ready for testing label Jul 14, 2020

Merge branch '2.4-develop' into 28570_createcustomer_graphql_schema

2e77e22

ghost added Progress: testing in progress Progress: accept and removed Progress: ready for testing Progress: testing in progress labels Jul 14, 2020

magento-engcom-team mentioned this pull request Jul 16, 2020

GraphQL Schema for createCustomer does not match validation requirements #28570

Closed

magento-engcom-team pushed a commit that referenced this pull request Jul 16, 2020

ENGCOM-7839: createCustomer validation requirements #28888

5d7682d

magento-engcom-team merged commit cb4e788 into magento:2.4-develop Jul 16, 2020

keharper mentioned this pull request Aug 4, 2020

GraphQL: New mutations for managing customers magento/devdocs#7673

Merged

createCustomer validation requirements #28888

createCustomer validation requirements #28888

Uh oh!

Conversation

michalderlatka commented Jun 25, 2020

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

Uh oh!

m2-assistant bot commented Jun 25, 2020

Uh oh!

michalderlatka commented Jun 25, 2020

Uh oh!

Uh oh!

cpartica Jun 26, 2020

Choose a reason for hiding this comment

Uh oh!

cpartica Jun 26, 2020

Choose a reason for hiding this comment

Uh oh!

cpartica Jun 26, 2020

Choose a reason for hiding this comment

Uh oh!

cpartica Jun 26, 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!

michalderlatka commented Jun 30, 2020

Uh oh!

michalderlatka commented Jul 7, 2020

Uh oh!

Uh oh!

cpartica Jul 8, 2020

Choose a reason for hiding this comment

Uh oh!

cpartica Jul 8, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cpartica Jul 8, 2020

Choose a reason for hiding this comment

Uh oh!

michalderlatka commented Jul 9, 2020

Uh oh!

cpartica commented Jul 9, 2020

Uh oh!

cpartica Jul 9, 2020

Choose a reason for hiding this comment

Uh oh!

michalderlatka commented Jul 13, 2020

Uh oh!

cpartica commented Jul 14, 2020

Uh oh!

m2-assistant bot commented Jul 16, 2020

Uh oh!

Uh oh!

cpartica Jun 26, 2020 •

edited

Loading