Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Integrated Optimizely Prompt Experiment #52

Merged
merged 13 commits into from
Jul 11, 2024
Merged

feat: Integrated Optimizely Prompt Experiment #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
2fb1862
feat: Integrated Optimizely Prompt Experiment
rijuma Jun 26, 2024
3412f8f
fix: Fixed useOptimizelyExperiment() infinite updates
rijuma Jul 1, 2024
8482d7b
feat: trigger survey monkey on chat close (#55)
alangsto Jul 3, 2024
62aaec8
chore: Added unit tests to useOptimizelyExperiment()
rijuma Jul 3, 2024
58691b9
chore: Updated tests to silence warnings on CI
rijuma Jul 8, 2024
bd16de8
chore: Added coverage for experiment on Sidebar
rijuma Jul 8, 2024
8d96749
fix: Updated Sidebar test and fixed warning
rijuma Jul 11, 2024
7e6a5a1
chore: Added test coverage for ToggleXpertButton component
rijuma Jul 11, 2024
7867ea2
chore: Updated logic for privacy policy in Dixclosure
rijuma Jul 11, 2024
cb402b8
fix: Added ensureConfig() rather than conditioning the render
rijuma Jul 11, 2024
c055843
fix: Casting number to string for useDecision() payload.
rijuma Jul 11, 2024
03ce47e
Merge branch 'main' into rijuma/optimizely-prompt-experiment
rijuma Jul 11, 2024
03b500a
chore: Updated test based on Optimizely fix
rijuma Jul 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Default CI
on:
on:
push:
branches:
- 'main'
Expand Down Expand Up @@ -28,7 +28,7 @@ jobs:
- name: Lint
run: npm run lint
- name: Test
run: npm run test
run: npm run test:ci
- name: Build
run: npm run build
- name: i18n_extract
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
- name: Install dependencies
run: npm ci
- name: Test
run: npm run test
run: npm run test:ci
- name: Release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down
68 changes: 52 additions & 16 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@
"lint:fix": "fedx-scripts eslint --fix --ext .js --ext .jsx .",
"snapshot": "fedx-scripts jest --updateSnapshot",
"start": "fedx-scripts webpack-dev-server --progress",
"test": "fedx-scripts jest --coverage --passWithNoTests"
"test": "fedx-scripts jest --coverage --passWithNoTests",
"test:ci": "fedx-scripts jest --silent --coverage --passWithNoTests"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This reduces CI checks log file size from 30KB to 8KB by silencing warnings.
At some point warnings should be reduced, but we are not taking them into account on the CI, so we just might just remove them.

Copy link
Member Author

@rijuma rijuma Jul 11, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, some warnings are caused by external libraries, like @openedx/paragon icons for example. When testing, the library renders the icons as <IconMock /> by the use of a string reference rather than a component causing the following warning:

    Warning: <IconMock /> is using incorrect casing. Use PascalCase for React components, or lowercase for HTML elements.
        at IconMock
        at button
        at /Users/marcos/edx/src/frontend-lib-learning-assistant/node_modules/react-bootstrap/cjs/Button.js:28:23
        at children (/Users/marcos/edx/src/frontend-lib-learning-assistant/node_modules/@openedx/paragon/src/Button/index.jsx:12:3)
        at div
        at isOpen (/Users/marcos/edx/src/frontend-lib-learning-assistant/src/components/ToggleXpertButton/index.jsx:20:3)
        at Provider (/Users/marcos/edx/src/frontend-lib-learning-assistant/node_modules/react-redux/lib/components/Provider.js:21:20)
        at IntlProvider (/Users/marcos/edx/src/frontend-lib-learning-assistant/node_modules/react-intl/src/components/provider.js:33:47)
        at children (/Users/marcos/edx/src/frontend-lib-learning-assistant/src/utils/utils.test.jsx:19:22)

This warning stacks up for every render.

},
"files": [
"/dist"
Expand Down Expand Up @@ -72,6 +73,7 @@
"@reduxjs/toolkit": "1.8.1",
"@testing-library/jest-dom": "6.4.5",
"@testing-library/react": "^12.1.5",
"@testing-library/react-hooks": "^8.0.1",
"@testing-library/user-event": "^14.4.3",
"glob": "7.2.3",
"husky": "7.0.4",
Expand Down
4 changes: 3 additions & 1 deletion src/components/Disclosure/index.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@ import React from 'react';

import { Hyperlink, Icon } from '@openedx/paragon';
import { Chat } from '@openedx/paragon/icons';
import { getConfig } from '@edx/frontend-platform/config';
import { ensureConfig, getConfig } from '@edx/frontend-platform/config';

import './Disclosure.scss';

ensureConfig(['PRIVACY_POLICY_URL']);

const Disclosure = ({ children }) => (
<div className="disclosure d-flex flex-column align-items-stretch px-4 py-3">
<h2 className="text-light-100">
Expand Down
27 changes: 18 additions & 9 deletions src/components/Sidebar/index.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,15 @@ import {
} from '@openedx/paragon';
import { Close } from '@openedx/paragon/icons';

import { clearMessages } from '../../data/thunks';
import { PROMPT_EXPERIMENT_FLAG, PROMPT_EXPERIMENT_KEY } from '../../constants/experiments';
import { showControlSurvey, showVariationSurvey } from '../../utils/surveyMonkey';

import APIError from '../APIError';
import ChatBox from '../ChatBox';
import Disclosure from '../Disclosure';
import MessageForm from '../MessageForm';
import './Sidebar.scss';
import {
clearMessages,
} from '../../data/thunks';

const Sidebar = ({
courseId,
Expand All @@ -28,7 +29,9 @@ const Sidebar = ({
apiError,
disclosureAcknowledged,
messageList,
experiments,
} = useSelector(state => state.learningAssistant);
const { variationKey } = experiments?.[PROMPT_EXPERIMENT_FLAG] || {};
const chatboxContainerRef = useRef(null);
const dispatch = useDispatch();

Expand Down Expand Up @@ -69,17 +72,20 @@ const Sidebar = ({
const handleClick = () => {
setIsOpen(false);

// check to see if hotjar is available, then trigger hotjar event if user has sent and received a message
const hasWindow = typeof window !== 'undefined';
if (hasWindow && window.hj && messageList.length >= 2) {
window.hj('event', 'ocm_learning_assistant_chat_closed');
if (messageList.length >= 2) {
if (variationKey === PROMPT_EXPERIMENT_KEY) {
showVariationSurvey();
} else {
showControlSurvey();
}
}
};

const handleClearMessages = () => {
dispatch(clearMessages());
sendTrackEvent('edx.ui.lms.learning_assistant.clear', {
course_id: courseId,
...(variationKey ? { experiment_name: PROMPT_EXPERIMENT_FLAG, variation_key: variationKey } : {}),
});
};

Expand All @@ -88,7 +94,7 @@ const Sidebar = ({
);

const getSidebar = () => (
<div className="h-100 d-flex flex-column justify-content-stretch">
<div className="h-100 d-flex flex-column justify-content-stretch" data-testid="sidebar-xpert">
<div className="d-flex flex-column align-items-center p-3">
<h1 className="font-weight-bold mb-3">
Hi, I&apos;m Xpert!
Expand Down Expand Up @@ -119,6 +125,7 @@ const Sidebar = ({
aria-label="clear"
variant="primary"
type="button"
data-testid="sidebar-clear-btn"
>
Clear
</Button>
Expand All @@ -130,16 +137,18 @@ const Sidebar = ({
isOpen && (
<div
className="sidebar position-fixed"
data-testid="sidebar"
>
<IconButton
className="chat-close position-absolute m-2 border-0"
src={Close}
iconAs={Icon}
data-testid="close-button"
onClick={handleClick}
alt="close"
aria-label="close"
variant="primary"
invertColors={!disclosureAcknowledged}
data-testid="close-button"
/>
{disclosureAcknowledged ? (getSidebar()) : (<Disclosure>{getMessageForm()}</Disclosure>)}
</div>
Expand Down
Loading
Loading