feat: send individuals emails with pluggable component #6
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| import { getConfig } from '@edx/frontend-platform'; | ||
| import { getAuthenticatedHttpClient } from '@edx/frontend-platform/auth'; | ||
| import { logError } from '@edx/frontend-platform/logging'; | ||
|
|
||
| export async function getLearnersEmailInstructorTask(courseId, search) { | ||
| const endpointUrl = `${getConfig().LMS_BASE_URL}/platform-plugin-communications/${courseId}/api/search_learners?query=${search}&page=1&page_size=10`; | ||
| try { | ||
| const response = await getAuthenticatedHttpClient().get(endpointUrl); | ||
| return response; | ||
| } catch (error) { | ||
| logError(error); | ||
| throw new Error(error); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| import { getAuthenticatedHttpClient } from '@edx/frontend-platform/auth'; | ||
| import { getConfig } from '@edx/frontend-platform'; | ||
| import { logError } from '@edx/frontend-platform/logging'; | ||
|
|
||
| import { getLearnersEmailInstructorTask } from './api'; | ||
|
|
||
| jest.mock('@edx/frontend-platform/auth', () => ({ | ||
| getAuthenticatedHttpClient: jest.fn(), | ||
| })); | ||
| jest.mock('@edx/frontend-platform', () => ({ | ||
| getConfig: jest.fn(), | ||
| })); | ||
| jest.mock('@edx/frontend-platform/logging', () => ({ | ||
| logError: jest.fn(), | ||
| })); | ||
|
|
||
| describe('getLearnersEmailInstructorTask', () => { | ||
| const mockCourseId = 'course123'; | ||
| const mockSearch = 'testuser'; | ||
| const mockResponseData = { data: 'someData' }; | ||
| const mockConfig = { LMS_BASE_URL: 'http://localhost' }; | ||
|
|
||
| beforeEach(() => { | ||
| getConfig.mockReturnValue(mockConfig); | ||
| getAuthenticatedHttpClient.mockReturnValue({ | ||
| get: jest.fn().mockResolvedValue(mockResponseData), | ||
| }); | ||
| }); | ||
|
|
||
| it('successfully fetches data', async () => { | ||
| const data = await getLearnersEmailInstructorTask(mockCourseId, mockSearch); | ||
| expect(data).toEqual(mockResponseData); | ||
| expect(getAuthenticatedHttpClient().get).toHaveBeenCalledWith( | ||
| `http://localhost/platform-plugin-communications/${mockCourseId}/api/search_learners?query=${mockSearch}&page=1&page_size=10`, | ||
| ); | ||
| }); | ||
|
|
||
| it('handles an error', async () => { | ||
| getAuthenticatedHttpClient().get.mockRejectedValue(new Error('Network error')); | ||
|
|
||
| await expect(getLearnersEmailInstructorTask(mockCourseId, mockSearch)).rejects.toThrow('Network error'); | ||
| expect(logError).toHaveBeenCalledWith(new Error('Network error')); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| import React, { useState } from 'react'; | ||
| import PropTypes from 'prop-types'; | ||
| import { AsyncTypeahead } from 'react-bootstrap-typeahead'; | ||
| import { v4 as uuidv4 } from 'uuid'; | ||
| import { Form, Chip, Container } from '@edx/paragon'; | ||
| import { Person, Close } from '@edx/paragon/icons'; | ||
| import { injectIntl, intlShape } from '@edx/frontend-platform/i18n'; | ||
| import { getLearnersEmailInstructorTask } from './api'; | ||
| import messages from './messages'; | ||
|
|
||
| import './styles.scss'; | ||
|
|
||
| function IndividualEmails(props) { | ||
| const { | ||
| courseId, handleEmailSelected, emailList, handleDeleteEmail, | ||
| intl, | ||
| } = props; | ||
| const [isLoading, setIsLoading] = useState(false); | ||
| const [options, setOptions] = useState([]); | ||
| const [inputValue] = useState([]); | ||
|
|
||
| const handleSearchEmailLearners = async (userEmail) => { | ||
| setIsLoading(true); | ||
| try { | ||
| const response = await getLearnersEmailInstructorTask(courseId, userEmail); | ||
| const { results } = response.data; | ||
| const formatResult = results.map((item) => ({ id: uuidv4(), ...item })); | ||
| setOptions(formatResult); | ||
| } catch (error) { | ||
| // eslint-disable-next-line no-console | ||
| console.error('error autocomplete input', error.message); | ||
|
Comment on lines
+30
to
+31
There was a problem hiding this comment. why a console error instead of a standard logError? |
||
| } finally { | ||
| setIsLoading(false); | ||
| } | ||
| }; | ||
|
|
||
| const filterBy = (option) => option.name || option.email || option.username; | ||
| const handleDeleteEmailSelected = (id) => { | ||
| if (handleDeleteEmail) { | ||
| handleDeleteEmail(id); | ||
| } | ||
| }; | ||
|
|
||
| const handleSelectedLearnerEmail = (selected) => { | ||
| const [itemSelected] = selected || [{ email: '' }]; | ||
| const isEmailAdded = emailList.some((item) => item.email === itemSelected.email); | ||
|
|
||
| if (selected && !isEmailAdded) { | ||
| handleEmailSelected(selected); | ||
| } | ||
| }; | ||
|
|
||
| return ( | ||
| <Container className="col-12 my-5"> | ||
| <Form.Label className="mt-3" data-testid="learners-email-input-label">{intl.formatMessage(messages.individualEmailsLabelLearnersInputLabel)}</Form.Label> | ||
| <AsyncTypeahead | ||
| filterBy={filterBy} | ||
| id="async-autocompleinput" | ||
| isLoading={isLoading} | ||
| labelKey="username" | ||
| minLength={3} | ||
| onSearch={handleSearchEmailLearners} | ||
| options={options} | ||
| name="studentEmail" | ||
| selected={inputValue} | ||
| data-testid="input-typeahead" | ||
| placeholder={intl.formatMessage(messages.individualEmailsLabelLearnersInputPlaceholder)} | ||
| onChange={handleSelectedLearnerEmail} | ||
| renderMenuItemChildren={({ name, email }) => ( | ||
| <span data-testid="autocomplete-email-option">{name ? `${name} -` : name} {email}</span> | ||
|
Comment on lines
+69
to
+70
There was a problem hiding this comment. The search query can also be the username. Would the name/email combination appear even though I'm looking for the student by their username? wouldn't that be confusing? There was a problem hiding this comment. I can add the username as well, no problem. For me is not confusing due to the user can see the name/email of the student in the list an selected that one |
||
| )} | ||
| /> | ||
| <Container className="email-list"> | ||
| <Form.Label className="col-12" data-testid="learners-email-list-label">{intl.formatMessage(messages.individualEmailsLabelLearnersListLabel)}</Form.Label> | ||
| {emailList.map(({ id, email }) => ( | ||
| <Chip | ||
| variant="light" | ||
| className="email-chip" | ||
| iconBefore={Person} | ||
| iconAfter={Close} | ||
| onIconAfterClick={() => handleDeleteEmailSelected(id)} | ||
| key={id} | ||
| data-testid="email-list-chip" | ||
| > | ||
| {email} | ||
| </Chip> | ||
| ))} | ||
| </Container> | ||
|
|
||
| </Container> | ||
| ); | ||
| } | ||
|
|
||
| IndividualEmails.defaultProps = { | ||
| courseId: '', | ||
| handleEmailSelected: () => {}, | ||
| handleDeleteEmail: () => {}, | ||
| emailList: [], | ||
| }; | ||
|
|
||
| IndividualEmails.propTypes = { | ||
| courseId: PropTypes.string, | ||
| handleEmailSelected: PropTypes.func, | ||
| handleDeleteEmail: PropTypes.func, | ||
| emailList: PropTypes.arrayOf( | ||
| PropTypes.shape({ | ||
| id: PropTypes.string, | ||
| email: PropTypes.string, | ||
| username: PropTypes.string, | ||
| }), | ||
| ), | ||
| intl: intlShape.isRequired, | ||
| }; | ||
|
|
||
| export default injectIntl(IndividualEmails); | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why is the page and page_size fixed? shouldn't it be parametrized?