Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
E
edx-platform
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
edx
edx-platform
Commits
eab6363d
Commit
eab6363d
authored
Oct 03, 2017
by
Diana Huang
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Make the welcome message disappear after sevent days of first viewing.
parent
f4c08bbc
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
75 additions
and
4 deletions
+75
-4
openedx/features/course_experience/static/course_experience/js/WelcomeMessage.js
+23
-4
openedx/features/course_experience/static/course_experience/js/spec/WelcomeMessage_spec.js
+52
-0
No files found.
openedx/features/course_experience/static/course_experience/js/WelcomeMessage.js
View file @
eab6363d
...
@@ -3,11 +3,10 @@ import 'jquery.cookie';
...
@@ -3,11 +3,10 @@ import 'jquery.cookie';
export
class
WelcomeMessage
{
// eslint-disable-line import/prefer-default-export
export
class
WelcomeMessage
{
// eslint-disable-line import/prefer-default-export
constructor
(
options
)
{
static
dismissWelcomeMessage
(
dismissUrl
)
{
$
(
'.dismiss-message button'
).
click
(()
=>
{
$
.
ajax
({
$
.
ajax
({
type
:
'POST'
,
type
:
'POST'
,
url
:
options
.
dismissUrl
,
url
:
dismissUrl
,
headers
:
{
headers
:
{
'X-CSRFToken'
:
$
.
cookie
(
'csrftoken'
),
'X-CSRFToken'
:
$
.
cookie
(
'csrftoken'
),
},
},
...
@@ -15,6 +14,26 @@ export class WelcomeMessage { // eslint-disable-line import/prefer-default-expo
...
@@ -15,6 +14,26 @@ export class WelcomeMessage { // eslint-disable-line import/prefer-default-expo
$
(
'.welcome-message'
).
hide
();
$
(
'.welcome-message'
).
hide
();
},
},
});
});
});
}
constructor
(
options
)
{
// Dismiss the welcome message if the user clicks dismiss, or auto-dismiss if
// the user doesn't click dismiss in 7 days from when it was first viewed.
// Check to see if the welcome message has been displayed at all.
if
(
$
(
'.welcome-message'
).
length
>
0
)
{
// If the welcome message has been viewed.
if
(
$
.
cookie
(
'welcome-message-viewed'
)
===
'True'
)
{
// If the timer cookie no longer exists, dismiss the welcome message permanently.
if
(
$
.
cookie
(
'welcome-message-timer'
)
!==
'True'
)
{
WelcomeMessage
.
dismissWelcomeMessage
(
options
.
dismissUrl
);
}
}
else
{
// Set both the viewed cookie and the timer cookie.
$
.
cookie
(
'welcome-message-viewed'
,
'True'
,
{
expires
:
365
});
$
.
cookie
(
'welcome-message-timer'
,
'True'
,
{
expires
:
7
});
}
}
$
(
'.dismiss-message button'
).
click
(()
=>
WelcomeMessage
.
dismissWelcomeMessage
(
options
.
dismissUrl
));
}
}
}
}
openedx/features/course_experience/static/course_experience/js/spec/WelcomeMessage_spec.js
View file @
eab6363d
...
@@ -30,4 +30,56 @@ describe('Welcome Message factory', () => {
...
@@ -30,4 +30,56 @@ describe('Welcome Message factory', () => {
requests
.
restore
();
requests
.
restore
();
});
});
});
});
describe
(
'Ensure cookies behave as expected'
,
()
=>
{
const
endpointUrl
=
'/course/course_id/dismiss_message/'
;
function
deleteAllCookies
()
{
const
cookies
=
document
.
cookie
.
split
(
';'
);
cookies
.
forEach
((
cookie
)
=>
{
const
eqPos
=
cookie
.
indexOf
(
'='
);
const
name
=
eqPos
>
-
1
?
cookie
.
substr
(
0
,
eqPos
)
:
cookie
;
document
.
cookie
=
`
${
name
}
=;expires=Thu, 01 Jan 1970 00:00:00 GMT`
;
});
}
beforeEach
(()
=>
{
deleteAllCookies
();
});
function
createWelcomeMessage
()
{
loadFixtures
(
'course_experience/fixtures/welcome-message-fragment.html'
);
new
WelcomeMessage
({
dismissUrl
:
endpointUrl
});
// eslint-disable-line no-new
}
it
(
'Cookies are created if none exist.'
,
()
=>
{
createWelcomeMessage
();
expect
(
$
.
cookie
(
'welcome-message-viewed'
)).
toBe
(
'True'
);
expect
(
$
.
cookie
(
'welcome-message-timer'
)).
toBe
(
'True'
);
});
it
(
'Nothing is hidden or dismissed if the timer is still active'
,
()
=>
{
const
$message
=
$
(
'.welcome-message'
);
$
.
cookie
(
'welcome-message-viewed'
,
'True'
);
$
.
cookie
(
'welcome-message-timer'
,
'True'
);
createWelcomeMessage
();
expect
(
$message
.
attr
(
'style'
)).
toBe
(
undefined
);
});
it
(
'Message is dismissed if the timer has expired and the message has been viewed.'
,
()
=>
{
const
requests
=
mockRequests
(
this
);
$
.
cookie
(
'welcome-message-viewed'
,
'True'
);
createWelcomeMessage
();
const
$message
=
$
(
'.welcome-message'
);
expectRequest
(
requests
,
'POST'
,
endpointUrl
,
);
respondWithJson
(
requests
);
expect
(
$message
.
attr
(
'style'
)).
toBe
(
'display: none;'
);
requests
.
restore
();
});
});
});
});
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment