Plugin Structure & JS GraphQL

Plugin Project Folder Structure

• insomnia - This folder contains all the required API Requests and workflows to set up a new retailer with sample data and workflows for each of the Fluent Apps.
• postman - The postman folder contains the current API Collection for setting up a retailer, and installing and running the sample plugin rules.
• src - This folder will contain all the java source code. You will write your custom Rules in this folder.
• graphql  - This folder will contain all the queries and mutation . Java class are  auto generated for each query and mutation.
• java - You will write the JUnit / unit test cases/classes in this folder.
• pom.xml - It is an XML file that contains information about the project and configuration details used by Maven to build the project. It contains default values for most projects.

GraphQL within IntelliJ

• graphql - This folder contains all the GraphQL queries and mutations. 
• GetOrderById.graphql - This is an example GraphQL query which we will be using in our demonstrations later in the course.
• schema.json - This is the JSON version of Fluent's schema.
• apollo-client:generate - This plugin generates a Java class/code for the GraphQL queries/mutations written in the GraphQL folder.

Step 1. Create a  GraphQLConfig file

Step 2. Replace the code in the graphqlconfig file with the code below

1{
2"projects": {
3"<YOUR_PROJECT_NAME>": {
4"schemaPath": "src/main/graphql/<YOUR_PROJECT_GROUP_PATH>/schema.json",
5"extensions": {
6"endpoints": {
7"sandbox": {
8"url": "https://<YOUR_FLUENT_ACCOUNT_ID>.sandbox.api.fluentretail.com/graphql",
9"headers": {
10"Authorization": "Bearer ${env:AUTH_TOKEN_ENV}"
11}
12}
13}
14}
15}
16}
17}

Step 3. Fill the placeholders with your Fluent Account values in your graphqlconfig  file 

• grahqlConfig - This is the generated graphqlConfig file 
• <YOUR_PROJECT_NAME>- This is your project name. Add a short unique Project name, mostly your accountID for eg "FCTRAINAU543"
• <YOUR_PROJECT_GROUP_PATH> - This is the path of the  schema.json file in your project. In our plugin project, schema.json is under com. training folder so  this  <YOUR_PROJECT_GROUP_PATH> value is replaced with "com. training" so it will be  "src/main/graphql/com.training/schema.json"
• url - You should replace < Your_Fluent_Account_ID>  with your accountID . For eg "https://FCTRAINAU543.sandbox.api.fluentretail.com/graphql"
• Authoriszation - This is an environment variable. It is an authorisation token generated after an account is authorised in Postman. This value is filled at the run time.

Modify and run a GraphQL query

Step 1. Modify Query

• In your plugin project's src/main/graphql/com.training/queries folder, open the "GetOrderById.graphql" file.  Add the total price field to the query as per the query given below.  

1query GetOrderById($id: ID!) {
2    orderById(id: $id) {
3        id
4        ref
5        type
6        status
7        totalPrice
8        attributes {
9          name
10          type
11          value
12        }
13    }
14}

Step 2. Run the Query

• Fill the AUTH_TOKEN_ENV environment variable: AUTH_TOKEN_ENV is the environment variable that gets the value of access_token, which you get after authentication of the retailer from POSTMAN collection.
• Enter any valid order ID (Note: the query needs this ID as a variable) and run the query. 

Step 3. Generate the Java class using the Apollo GraphQL plugin for IntelliJ