From 76b2d5929cb3ce575add5eb1e1cbd39260848664 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jo=C3=A3o=20Cabrita?= <joao.cabrita@opencraft.com>
Date: Mon, 5 Jul 2021 11:33:14 +0100
Subject: [PATCH] feat: Use `messages` field from API

When fetching details for discussion providers from the API,
the `messages` field is used if available and
displayed in the configuration page for each provider.

Related tickets:
* [TNL-8339](https://openedx.atlassian.net/browse/TNL-8339)
* [BB-4249 (OpenCraft Internal)](https://tasks.opencraft.com/browse/BB-4249)
---
 .../discussions/app-config-form/apps/lti/LtiConfigForm.jsx    | 4 ++++
 src/pages-and-resources/discussions/data/api.js               | 1 +
 src/pages-and-resources/discussions/data/redux.test.js        | 2 ++
 .../discussions/factories/mockApiResponses.js                 | 4 ++++
 4 files changed, 11 insertions(+)

diff --git a/src/pages-and-resources/discussions/app-config-form/apps/lti/LtiConfigForm.jsx b/src/pages-and-resources/discussions/app-config-form/apps/lti/LtiConfigForm.jsx
index dea767194..55136c472 100644
--- a/src/pages-and-resources/discussions/app-config-form/apps/lti/LtiConfigForm.jsx
+++ b/src/pages-and-resources/discussions/app-config-form/apps/lti/LtiConfigForm.jsx
@@ -56,6 +56,9 @@ function LtiConfigForm({
       <Form ref={formRef} onSubmit={handleSubmit}>
         <h3 className="mb-3">{title}</h3>
         <p>{intl.formatMessage(messages.formInstructions)}</p>
+        {app.messages && app.messages.map(msg => (
+          <p key={msg}>{msg}</p>
+        ))}
         <Form.Group controlId="consumerKey" isInvalid={isInvalidConsumerKey} className="mb-4">
           <Form.Control
             floatingLabel={intl.formatMessage(messages.consumerKey)}
@@ -111,6 +114,7 @@ LtiConfigForm.propTypes = {
       accessibility: PropTypes.string,
       contactEmail: PropTypes.string,
     }).isRequired,
+    messages: PropTypes.arrayOf(PropTypes.string),
   }).isRequired,
   appConfig: PropTypes.shape({
     consumerKey: PropTypes.string,
diff --git a/src/pages-and-resources/discussions/data/api.js b/src/pages-and-resources/discussions/data/api.js
index e3d331a00..e0f6c1d59 100644
--- a/src/pages-and-resources/discussions/data/api.js
+++ b/src/pages-and-resources/discussions/data/api.js
@@ -46,6 +46,7 @@ function normalizePluginConfig(data) {
 function normalizeApps(data) {
   const apps = Object.entries(data.providers.available).map(([key, app]) => ({
     id: key,
+    messages: app.messages,
     featureIds: app.features,
     // TODO: Fix this and get it from the backend!
     externalLinks: {
diff --git a/src/pages-and-resources/discussions/data/redux.test.js b/src/pages-and-resources/discussions/data/redux.test.js
index 49517d027..1b6df0b12 100644
--- a/src/pages-and-resources/discussions/data/redux.test.js
+++ b/src/pages-and-resources/discussions/data/redux.test.js
@@ -51,6 +51,7 @@ const legacyApp = {
     contactEmail: '',
   },
   hasFullSupport: false,
+  messages: [],
 };
 
 const piazzaApp = {
@@ -69,6 +70,7 @@ const piazzaApp = {
     contactEmail: '',
   },
   hasFullSupport: true,
+  messages: [],
 };
 
 let axiosMock;
diff --git a/src/pages-and-resources/discussions/factories/mockApiResponses.js b/src/pages-and-resources/discussions/factories/mockApiResponses.js
index 588e69f50..a1d246f8d 100644
--- a/src/pages-and-resources/discussions/factories/mockApiResponses.js
+++ b/src/pages-and-resources/discussions/factories/mockApiResponses.js
@@ -31,6 +31,7 @@ export const piazzaApiResponse = {
           accessibility: '',
           contact_email: '',
         },
+        messages: [],
       },
       piazza: {
         features: [
@@ -47,6 +48,7 @@ export const piazzaApiResponse = {
           accessibility: '',
           contact_email: '',
         },
+        messages: [],
       },
     },
   },
@@ -98,6 +100,7 @@ export const legacyApiResponse = {
           accessibility: '',
           contact_email: '',
         },
+        messages: [],
       },
       piazza: {
         features: [
@@ -114,6 +117,7 @@ export const legacyApiResponse = {
           accessibility: '',
           contact_email: '',
         },
+        messages: [],
       },
     },
   },