LoginAsCustomer GraphQL #30130

KrishnaK-Z · 2020-09-21T14:32:48Z

Description (*)

This PR covers the Login as customer GraphQl functionality.

Related Pull Requests

magento/architecture#414

Fixed Issues (if relevant)

Manual testing scenarios (*)

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)

m2-assistant · 2020-09-21T14:32:51Z

Hi @KrishnaK-Z. 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.

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

rogyar

Hi @KrishnaK-Z. Thank you for your collaboration. Please, check my comments below.

rogyar · 2020-09-22T11:36:07Z

app/code/Magento/LoginAsCustomerGraphQl/etc/module.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" ?>
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
+	<module name="Magento_LoginAsCustomerGraphQl" setup_version="1.0.0">


You may omit the setup_version since we don't introduce changes to the database. In case it will happen in the future, it's recommended to use declarative schema that does not require setup_version either.

rogyar · 2020-09-22T11:38:44Z

app/code/Magento/LoginAsCustomerGraphQl/Model/Resolver/RequestCustomerToken.php

+    private $createCustomerToken;
+
+    /**
+     * RequestCustomerToken constructor.


Please, omit a short description of constructors. They don't provide useful information but use one more line of the file.

Please, remove unnecessary comments

rogyar · 2020-09-22T11:40:01Z

app/code/Magento/LoginAsCustomerGraphQl/Model/Resolver/RequestCustomerToken.php

+/**
+ * Gets customer token
+ *
+ * Class RequestCustomerToken


Please, omit the class name in the DocBlock, but leave the short description.

rogyar · 2020-09-22T11:41:21Z

app/code/Magento/LoginAsCustomerGraphQl/Model/LoginAsCustomer/CreateCustomerToken.php

+    ) {
+        $this->storeManager = $storeManager;
+        $this->tokenModelFactory = $tokenModelFactory;
+        $this->customer= $customer;


Please, do not inject models using DI. Use customerFactory to create the corresponding instance instead.

In case if you need to work with the existing customer instance, you may pass it as an argument to the execute method.

rogyar · 2020-09-22T11:44:52Z

app/code/Magento/LoginAsCustomerGraphQl/Model/LoginAsCustomer/CreateCustomerToken.php

+        $customerId = $this->customer->getId();
+        $customerToken = $this->tokenModelFactory->create();
+        return [
+            "customer_token" => $customerToken->createCustomerToken($customerId)->getToken()


We may have an unhandled exception upon creating customer token. For example if the system is unable to save a token to the database. I would recommend catching exception here.

rogyar · 2020-09-22T11:52:39Z

app/code/Magento/LoginAsCustomerGraphQl/composer.json

+    "type": "magento2-module",
+    "require": {},
+    "version": "1.0.0",
+    "require": {


Please, provide all the dependencies you use within the scope of the module. Like LoginAsCustomerApi, Customer, Store etc

rogyar · 2020-09-22T11:53:11Z

.../api-functional/testsuite/Magento/GraphQl/LoginAsCustomer/GenerateLoginCustomerTokenTest.php

+    private $adminTokenService;
+
+    /**
+     * Set Up


Please, avoid unnecessary comments

Please move tests under the LoginAsCustomerGraphQl module

@cspruiell Moved tests under the LoginAsCustomerGraphQl module but getting as below error now so do I have to revert it as earlier, please suggest.

Passed: 31456, Failed: 1, Incomplete: 0, Skipped: 0.
Data set: dev/tests/api-functional/testsuite/Magento/GraphQl/LoginAsCustomerGraphQl/GenerateLoginCustomerTokenTest.php
Location of /var/www/html/dev/tests/api-functional/testsuite/Magento/GraphQl/LoginAsCustomerGraphQl/GenerateLoginCustomerTokenTest.php does not match formal namespace: Magento\GraphQl\LoginAsCustomerGraphQl

rogyar · 2020-09-22T11:55:03Z

.../api-functional/testsuite/Magento/GraphQl/LoginAsCustomer/GenerateLoginCustomerTokenTest.php

+
+        $mutation = $this->getQuery($customerEmail);
+
+        $response = $this->graphQlMutation($mutation, [], '', $this->getAdminHeaderAuthentication('TestAdmin1', 'Zilker777'));


Please, make sure the line length does not exceed 120 characters

rogyar · 2020-09-22T11:57:19Z

.../api-functional/testsuite/Magento/GraphQl/LoginAsCustomer/GenerateLoginCustomerTokenTest.php

+     * @return string[]
+     * @throws AuthenticationException
+     */
+    public function getAdminHeaderAuthentication(string $userName, string $password)


Please, make sure that you use the private scope for the test methods that don't require public access.

rogyar · 2020-09-22T11:59:50Z

dev/tests/integration/testsuite/Magento/LoginAsCustomer/_files/admin.php

+try {
+    $userModel->setData($adminInfo);
+    $userModel->setRoleId(1);
+    $userModel->save();


Please, do not use deprecated methods for saving data. Use the resource model or repository instead.

KrishnaK-Z · 2020-09-22T15:10:23Z

@rogyar Update the PR as suggested. Please have a look.

nihara47 · 2020-11-18T09:53:03Z

@magento run Static Tests

nihara47

Hi @KrishnaK-Z. I've outlined some unresolved points. Please, address them when you will have a chance.

The failing functional tests are not related to your changes. But the failing static tests tell that you have 1 undeclared dependency. This point should be resolved as well.

Thank you!

Hi @rogyar for the Failing static test case I have removed the undeclared one from module.xml but still the same failed case. Can you suggest on this and let me know what can be done to get rid of this. I did follow https://devdocs.magento.com/guides/v2.4/architecture/archi_perspectives/components/modules/mod_depend.html

nihara47 · 2020-11-18T11:27:14Z

@magento run all tests

cspruiell · 2020-11-18T14:36:11Z

Hi @KrishnaK-Z. I've outlined some unresolved points. Please, address them when you will have a chance.
The failing functional tests are not related to your changes. But the failing static tests tell that you have 1 undeclared dependency. This point should be resolved as well.
Thank you!

Hi @rogyar for the Failing static test case I have removed the undeclared one from module.xml but still the same failed case. Can you suggest on this and let me know what can be done to get rid of this. I did follow https://devdocs.magento.com/guides/v2.4/architecture/archi_perspectives/components/modules/mod_depend.html

Hi @nihara47, there are two changes you need that will address the static failures:

the root composer.json file needs to have this new module added
this module's composer.json file needs to have the soft dependency on LoginAsCustomer added to the 'suggest' section.

nihara47 · 2020-11-18T14:57:35Z

* the root composer.json file needs to have this new module added

Hi @cspruiell When you say the root composer.json file needs to have this new module added
Do you mean the root composer magento2/composer.json or any other path. can you explain please.

cspruiell · 2020-11-18T14:58:49Z

* the root composer.json file needs to have this new module added
Hi @cspruiell When you say the root composer.json file needs to have this new module added
Do you mean the root composer magento2/composer.json or any other path. can you explain please.

Yes, magento2/composer.json

nihara47 · 2020-11-19T08:07:37Z

@magento run Static Tests

nihara47 · 2020-11-19T09:44:18Z

@magento run Static Tests

nihara47 · 2020-11-19T12:18:08Z

@magento run all tests

nihara47 · 2020-11-20T06:00:06Z

Hi @cspruiell thanks for the suggestion. It worked actually. @cspruiell and @rogyar the suggested changes has been updated. Currently there is only one static test case pending which adding this module to root composer.json. I believe @cpartica will take care for this.

There are multiple test cases failing which belongs to some other modules like Magento_Checkout or Magento_PurchaseOrder etc and these are changing time to time. For ex. please check attached one.

nihara47 · 2020-11-23T14:56:23Z

@magento run WebAPI Tests

nihara47 · 2020-11-24T05:24:13Z

@magento run all tests

cspruiell · 2020-11-25T22:05:27Z

app/code/Magento/LoginAsCustomerGraphQl/Model/LoginAsCustomer/CreateCustomerToken.php

+                __('Customer email provided does not exist')
+            );
+        }
+


We also need to validate that the 'allow_remote_shopping_assistance' setting is enabled for the customer. See https://github.com/magento/architecture/pull/414/files#diff-ccdc60253a5ea983cb68248c51500c3cdc077232bd52ded6cb08d4af9cba8d2bR39

cspruiell · 2020-11-25T22:07:09Z

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

+}
+
+type Customer {
+    allow_remote_shopping_assistance: Boolean! @doc(description: "Indicates whether the customer has enabled remote shopping assistance")


The GetCustomer resolver will need to be updated to return this new value

Added a new fixture for this with setAssistanceAllowed enabled

cspruiell · 2020-11-25T22:08:09Z

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

+
+input CustomerUpdateInput {
+    allow_remote_shopping_assistance: Boolean @doc(description: "Indicates whether the customer has enabled remote shopping assistance")
+}


Resolvers using these inputs will need to be updated to ensure allow_remote_shopping_assistance is persisted.

I don't see the changes for this. The createCustomer & updateCustomer mutations need to be updated so that allow_remote_shopping_assistance is persisted

mutation { createCustomerV2(input: { email: "test@example.com" firstname: "Test" lastname: "Magento" password: "T3stP4ssw0rd" allow_remote_shopping_assistance: true}) { customer { firstname lastname email allow_remote_shopping_assistance } } }

nihara47 · 2020-11-26T13:50:48Z

@magento run all tests

m2-assistant · 2020-12-04T14:43:02Z

Hi @KrishnaK-Z, 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.

LoginAsCustomer GraphQL

68875db

ghost added this to Pending Review in Pull Requests Dashboard Sep 21, 2020

magento-engcom-team added the Component: LoginAsCustomerGraphQl label Sep 21, 2020

ghost added the Progress: pending review label Sep 21, 2020

magento-engcom-team added Release Line: 2.4 Partner: EY partners-contribution Pull Request is created by Magento Partner labels Sep 21, 2020

nrkapoor added this to the 2.4.2 milestone Sep 21, 2020

sidolov added the Project: GraphQL label Sep 21, 2020

rogyar self-assigned this Sep 22, 2020

rogyar requested changes Sep 22, 2020

View reviewed changes

ghost moved this from Pending Review to Changes Requested in Pull Requests Dashboard Sep 22, 2020

rogyar added the Award: complex label Sep 22, 2020

ghost added Progress: needs update and removed Progress: pending review labels Sep 22, 2020

rogyar added Award: test coverage Progress: pending review and removed Progress: needs update labels Sep 22, 2020

Updated the module as suggested

12d2523

nrkapoor assigned KrishnaK-Z and unassigned rogyar Sep 23, 2020

nrkapoor requested review from melnikovi, cspruiell, prabhuram93, cpartica and dthampy September 23, 2020 11:34

nrkapoor linked an issue Sep 23, 2020 that may be closed by this pull request

B2B GraphQL :: Login as Customer #29480

Closed

nrkapoor requested a review from rogyar September 23, 2020 11:35

m2-community-project bot assigned nihara47 Nov 18, 2020

nihara47 reviewed Nov 18, 2020

View reviewed changes

static tests changes

89cc0d9

static tests changes

1c50d72

Code formatting

4845457

m2-community-project bot assigned cspruiell Nov 25, 2020

cspruiell suggested changes Nov 25, 2020

View reviewed changes

m2-community-project bot moved this from Review in Progress to Changes Requested in GraphQL Pull Requests Dashboard Nov 25, 2020

m2-community-project bot added Progress: needs update and removed Progress: review labels Nov 25, 2020

Suggested changes - 26Nov2020

95e1ecc

keharper mentioned this pull request Nov 27, 2020

GraphQL: Add coverage for Shopper Assistance magento/devdocs#8281

Closed

8 tasks

m2-community-project bot moved this from Changes Requested to Review in Progress in GraphQL Pull Requests Dashboard Dec 1, 2020

m2-community-project bot added Progress: review and removed Progress: needs update labels Dec 1, 2020

magento-engcom-team merged commit 36b33cd into magento:2.4-develop Dec 4, 2020

nrkapoor moved this from Review in Progress to Recently Merged in GraphQL Pull Requests Dashboard Dec 20, 2020


		$mutation = $this->getQuery($customerEmail);

		$response = $this->graphQlMutation($mutation, [], '', $this->getAdminHeaderAuthentication('TestAdmin1', 'Zilker777'));

LoginAsCustomer GraphQL #30130

LoginAsCustomer GraphQL #30130

Conversation

KrishnaK-Z commented Sep 21, 2020

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

m2-assistant bot commented Sep 21, 2020

rogyar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KrishnaK-Z commented Sep 22, 2020

nihara47 commented Nov 18, 2020

nihara47 left a comment • edited Loading

Choose a reason for hiding this comment

nihara47 commented Nov 18, 2020

cspruiell commented Nov 18, 2020

nihara47 commented Nov 18, 2020

cspruiell commented Nov 18, 2020

nihara47 commented Nov 19, 2020

nihara47 commented Nov 19, 2020

nihara47 commented Nov 19, 2020

nihara47 commented Nov 20, 2020

nihara47 commented Nov 23, 2020

nihara47 commented Nov 24, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cspruiell Dec 2, 2020 • edited Loading

Choose a reason for hiding this comment

nihara47 commented Nov 26, 2020

m2-assistant bot commented Dec 4, 2020

nihara47 left a comment •

edited

Loading

cspruiell Dec 2, 2020 •

edited

Loading