GraphQl. Add a mutation for subscribe feature

[atwixfirster]

Description (*)

There is a subscribe field on a standard Magento storefront:

Currently, GraphQl does not have a mutation which allow to subscribe guest/customer into a newsletter subscription.

Expected behavior (*)

Benefits

Additional information

A proposed schema:

type Mutation {
    subscribeEmailToNewsletter(input: SubscribeInput): SubscribeOutput @resolver(class: "\\Vendor\\ModuleGraphQl\\Model\\Resolver\\SubscribeEmailToNewsletter") @doc(description:"Adds an email into a newsletter subscription")
}

input SubscribeInput {
    email: String! @doc(description: "Email")
}

type SubscribeOutput {
    success: Boolean! @doc(description: "Returns 'true' if an email has been added to newsletter successfully")
    message: String! @doc(description: "Returns a success or an error messages")
}

Example of usage:

mutation {
  subscribeEmailToNewsletter(
    input: {
      email: "user@server.com"
    }
  ) {
    success
    message
  }
}

Response:

{
  "data": {
    "subscribeEmailToNewsletter": {
      "success": true,
      "message": "Thank you for your subscription."
    }
  }
}

[m2-assistant]

Hi @atwixfirster. Thank you for your report.
To help us process this issue please make sure that you provided the following information:

• Summary of the issue
• Information on your environment
• Steps to reproduce
• Expected and actual results

Please make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, please, add a comment to the issue:

@magento give me 2.4-develop instance - upcoming 2.4.x release

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

@atwixfirster do you confirm that you were able to reproduce the issue on vanilla Magento instance following steps to reproduce?

• yes
• no

---

• Join Magento Community Engineering Slack and ask your questions in #github channel.

[m2-assistant]

Hi @atwixfirster. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).

  Details

  If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.

• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.

• 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

• 4. Verify that the issue is reproducible on 2.4-develop branch

  Details

  - Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!

---

• Join Magento Community Engineering Slack and ask your questions in #github channel.

[m2-assistant]

Hi @paliarush. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).

  Details

  If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.

• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.

• 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

• 4. Verify that the issue is reproducible on 2.4-develop branch

  Details

  - Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!

---

• Join Magento Community Engineering Slack and ask your questions in #github channel.

[paliarush]

@atwixfirster, thank you for the proposal.

How about removing wrapper for the input (having email as an argument directly)? Such approach will be consistent with https://github.com/magento/architecture/blob/master/design-documents/graph-ql/extensibility.md

Also, why do we need message field in the response? How about removing it?

Could I ask you to create a PR with the proposed GraphQL schema in https://github.com/magento/architecture/tree/master/design-documents/graph-ql/coverage ?

Thanks

[atwixfirster]

Hi, @paliarush !

First of all thank you for your review.

How about removing wrapper for the input (having email as an argument directly)? Such approach will be consistent with https://github.com/magento/architecture/blob/master/design-documents/graph-ql/extensibility.md

Ok. I will.

My proposition has been created regarding to the existing DevDocs documentation:

Also, why do we need message field in the response? How about removing it?

The idea of message is display message to user. For example,

• Please enter a valid email address.
• Sorry, but the administrator denied subscription for guests. Please register.
• This email address is already assigned to another user.
• Thank you for your subscription.

Could I ask you to create a PR with the proposed GraphQL schema in https://github.com/magento/architecture/tree/master/design-documents/graph-ql/coverage ?

Can you please provide your clarification for the points above. After that I will create a PR with a correct schema.

Thank you!

[atwixfirster]

Could I ask you to create a PR with the proposed GraphQL schema in https://github.com/magento/architecture/tree/master/design-documents/graph-ql/coverage ?

done

magento/architecture#367