Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
C
coopwire-hypothesis
Project
Project
Details
Activity
Releases
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
孙灵跃 Leon Sun
coopwire-hypothesis
Commits
248458e4
Unverified
Commit
248458e4
authored
Jan 14, 2020
by
Lyza Gardner
Committed by
GitHub
Jan 14, 2020
Browse files
Options
Browse Files
Download
Plain Diff
Merge pull request #1672 from hypothesis/annotation-init
Move new-annotation initialization into the store
parents
765fafc5
71fd83ff
Changes
6
Show whitespace changes
Inline
Side-by-side
Showing
6 changed files
with
340 additions
and
294 deletions
+340
-294
annotation.js
src/sidebar/components/annotation.js
+1
-13
annotation-test.js
src/sidebar/components/test/annotation-test.js
+2
-40
annotations.js
src/sidebar/store/modules/annotations.js
+53
-40
annotations-test.js
src/sidebar/store/modules/test/annotations-test.js
+280
-15
index-test.js
src/sidebar/store/test/index-test.js
+0
-186
annotation-fixtures.js
src/sidebar/test/annotation-fixtures.js
+4
-0
No files found.
src/sidebar/components/annotation.js
View file @
248458e4
...
...
@@ -92,25 +92,13 @@ function AnnotationController(
*/
newlyCreatedByHighlightButton
=
self
.
annotation
.
$highlight
||
false
;
// New annotations (just created locally by the client, rather then
// received from the server) have some fields missing. Add them.
//
// FIXME: This logic should go in the `addAnnotations` Redux action once all
// required state is in the store.
self
.
annotation
.
user
=
self
.
annotation
.
user
||
session
.
state
.
userid
;
self
.
annotation
.
user_info
=
self
.
annotation
.
user_info
||
session
.
state
.
user_info
;
self
.
annotation
.
group
=
self
.
annotation
.
group
||
groups
.
focused
().
id
;
// FIXME: This logic needs to move into the `annotations` store module
if
(
!
self
.
annotation
.
permissions
)
{
self
.
annotation
.
permissions
=
permissions
.
default
(
self
.
annotation
.
user
,
self
.
annotation
.
group
);
}
self
.
annotation
.
text
=
self
.
annotation
.
text
||
''
;
if
(
!
Array
.
isArray
(
self
.
annotation
.
tags
))
{
self
.
annotation
.
tags
=
[];
}
// Automatically save new highlights to the server when they're created.
// Note that this line also gets called when the user logs in (since
...
...
src/sidebar/components/test/annotation-test.js
View file @
248458e4
...
...
@@ -245,35 +245,14 @@ describe('annotation', function() {
});
describe
(
'initialization'
,
function
()
{
it
(
"sets the user of annotations that don't have one"
,
function
()
{
// You can create annotations while logged out and then login.
// When you login a new AnnotationController instance is created for
// each of your annotations, and on initialization it will set the
// annotation's user to your username from the session.
const
annotation
=
fixtures
.
newAnnotation
();
annotation
.
user
=
undefined
;
fakeSession
.
state
.
userid
=
'acct:bill@localhost'
;
fakeSession
.
state
.
user_info
=
{
display_name
:
'Bill Jones'
,
};
createDirective
(
annotation
);
assert
.
equal
(
annotation
.
user
,
'acct:bill@localhost'
);
assert
.
deepEqual
(
annotation
.
user_info
,
{
display_name
:
'Bill Jones'
,
});
});
it
(
'sets the permissions of new annotations'
,
function
()
{
// You can create annotations while logged out and then login.
// When you login a new AnnotationController instance is created for
// each of your annotations, and on initialization it will set the
// annotation's permissions using your username from the session.
const
annotation
=
fixtures
.
newAnnotation
();
annotation
.
user
=
annotation
.
permissions
=
undefined
;
annotation
.
permissions
=
undefined
;
annotation
.
group
=
'__world__'
;
fakeSession
.
state
.
userid
=
'acct:bill@localhost'
;
fakePermissions
.
default
=
function
(
userid
,
group
)
{
return
{
read
:
[
userid
,
group
],
...
...
@@ -284,19 +263,10 @@ describe('annotation', function() {
assert
.
deepEqual
(
annotation
.
permissions
,
fakePermissions
.
default
(
fakeSession
.
state
.
userid
,
annotation
.
group
)
fakePermissions
.
default
(
annotation
.
user
,
annotation
.
group
)
);
});
it
(
'sets the tags and text fields for new annotations'
,
function
()
{
const
annotation
=
fixtures
.
newAnnotation
();
delete
annotation
.
tags
;
delete
annotation
.
text
;
createDirective
(
annotation
);
assert
.
equal
(
annotation
.
text
,
''
);
assert
.
deepEqual
(
annotation
.
tags
,
[]);
});
it
(
'preserves the permissions of existing annotations'
,
function
()
{
const
annotation
=
fixtures
.
newAnnotation
();
annotation
.
permissions
=
{
...
...
@@ -795,14 +765,6 @@ describe('annotation', function() {
assert
.
notCalled
(
fakeStore
.
removeDraft
);
});
});
it
(
"sets the annotation's group to the focused group"
,
function
()
{
fakeGroups
.
focused
=
function
()
{
return
{
id
:
'test-id'
};
};
const
controller
=
createDirective
(
fixtures
.
newAnnotation
()).
controller
;
assert
.
equal
(
controller
.
annotation
.
group
,
'test-id'
);
});
});
describe
(
'saving an edited an annotation'
,
function
()
{
...
...
src/sidebar/store/modules/annotations.js
View file @
248458e4
...
...
@@ -48,17 +48,21 @@ function findByTag(annotations, tag) {
}
/**
* Initialize the status flags and properties of a new annotation.
* Set custom private fields on an annotation object about to be added to the
* store's collection of `annotations`.
*
* `annotation` may either be new (unsaved) or a persisted annotation retrieved
* from the service.
*
* @param {Object} annotation
* @param {Number} tag - The `$tag` value that should be used for this
* if it doesn't have a `$tag` already
* @return {Object} - annotation with local (`$*`) fields set
*/
function
initializeAnnot
(
annotation
,
tag
)
{
function
initializeAnnot
ation
(
annotation
,
tag
)
{
let
orphan
=
annotation
.
$orphan
;
if
(
!
annotation
.
id
)
{
// Currently the user ID, permissions and group of new annotations are
// initialized in the <annotation> component controller because the session
// state and focused group are not stored in the Redux store. Once they are,
// that initialization should be moved here.
// New annotations must be anchored
orphan
=
false
;
}
...
...
@@ -91,7 +95,7 @@ const update = {
const
updated
=
[];
let
nextTag
=
state
.
nextTag
;
action
.
annotations
.
forEach
(
function
(
annot
)
{
action
.
annotations
.
forEach
(
annot
=>
{
let
existing
;
if
(
annot
.
id
)
{
existing
=
findByID
(
state
.
annotations
,
annot
.
id
);
...
...
@@ -111,12 +115,12 @@ const update = {
updatedTags
[
existing
.
$tag
]
=
true
;
}
}
else
{
added
.
push
(
initializeAnnot
(
annot
,
't'
+
nextTag
));
added
.
push
(
initializeAnnot
ation
(
annot
,
't'
+
nextTag
));
++
nextTag
;
}
});
state
.
annotations
.
forEach
(
function
(
annot
)
{
state
.
annotations
.
forEach
(
annot
=>
{
if
(
!
updatedIDs
[
annot
.
id
]
&&
!
updatedTags
[
annot
.
$tag
])
{
unchanged
.
push
(
annot
);
}
...
...
@@ -218,29 +222,14 @@ function updateFlagStatus(id, isFlagged) {
};
}
/** Add annotations to the currently displayed set. */
function
addAnnotations
(
annotations
,
now
)
{
now
=
now
||
new
Date
();
// Add dates to new annotations. These are ignored by the server but used
// when sorting unsaved annotation cards.
annotations
=
annotations
.
map
(
function
(
annot
)
{
if
(
annot
.
id
)
{
return
annot
;
}
return
Object
.
assign
(
{
// Date.prototype.toISOString returns a 0-offset (UTC) ISO8601
// datetime.
created
:
now
.
toISOString
(),
updated
:
now
.
toISOString
(),
},
annot
);
});
/**
* Add these `annotations` to the current collection of annotations in the store.
*
* @param {Object}[] annotations - Array of annotation objects to add.
*/
function
addAnnotations
(
annotations
)
{
return
function
(
dispatch
,
getState
)
{
const
added
=
annotations
.
filter
(
function
(
annot
)
{
const
added
=
annotations
.
filter
(
annot
=>
{
return
!
findByID
(
getState
().
annotations
.
annotations
,
annot
.
id
);
});
...
...
@@ -250,6 +239,7 @@ function addAnnotations(annotations, now) {
currentAnnotationCount
:
getState
().
annotations
.
annotations
.
length
,
});
// If we're not in the sidebar, we're done here.
if
(
!
getState
().
viewer
.
isSidebar
)
{
return
;
}
...
...
@@ -330,19 +320,42 @@ function hideAnnotation(id) {
}
/**
* Create a new annotation
* Create a new annotation (as-yet unpersisted)
*
* This method has several responsibilities:
* 1. Set some default data attributes on the annotation
* 2. Remove any existing, empty drafts
* 3. Add the annotation to the current collection of annotations
* 4. Change focused tab to the applicable one for the new annotation's meta-type
* 5. Expand all of the new annotation's parents
*
*/
function
createAnnotation
(
ann
,
now
=
new
Date
())
{
return
(
dispatch
,
getState
)
=>
{
/**
* Extend the new, unsaved annotation object with defaults for some
* required data fields.
*
* The method does 4 tasks:
* 1. Removes any existing empty drafts.
* 2. Creates a new annotation.
* 3. Changes the focused tab to match that of the newly created annotation.
* 4. Expands the collapsed state of all new annotation's parents.
* Note: the `created` and `updated` values will be ignored and superseded
* by the service when the annotation is persisted, but they are used
* app-side for annotation card sorting until then.
*/
function
createAnnotation
(
ann
)
{
return
dispatch
=>
{
ann
=
Object
.
assign
(
{
created
:
now
.
toISOString
(),
group
:
getState
().
groups
.
focusedGroupId
,
tags
:
[],
text
:
''
,
updated
:
now
.
toISOString
(),
user
:
getState
().
session
.
userid
,
user_info
:
getState
().
session
.
user_info
,
},
ann
);
// When a new annotation is created, remove any existing annotations
// that are empty.
dispatch
(
drafts
.
actions
.
deleteNewAndEmptyDrafts
([
ann
]));
dispatch
(
addAnnotations
([
ann
]));
// If the annotation is of type note or annotation, make sure
// the appropriate tab is selected. If it is of type reply, user
...
...
src/sidebar/store/modules/test/annotations-test.js
View file @
248458e4
const
annotations
=
require
(
'../annotations'
);
const
createStore
FromModules
=
require
(
'../../create-store'
);
const
createStore
=
require
(
'../../create-store'
);
const
drafts
=
require
(
'../drafts'
);
const
fixtures
=
require
(
'../../../test/annotation-fixtures'
);
const
metadata
=
require
(
'../../../util/annotation-metadata'
);
const
groups
=
require
(
'../groups'
);
const
selection
=
require
(
'../selection'
);
const
session
=
require
(
'../session'
);
const
viewer
=
require
(
'../viewer'
);
const
uiConstants
=
require
(
'../../../ui-constants'
);
const
{
actions
,
selectors
}
=
annotations
;
/**
* Create a Redux store which handles annotation, selection and draft actions.
*/
function
createStore
()
{
return
createStoreFromModules
([
annotations
,
selection
,
drafts
,
viewer
],
[{}]
);
function
createTestStore
()
{
return
createStore
(
[
annotations
,
selection
,
drafts
,
groups
,
session
,
viewer
],
[{}]
);
}
// Tests for most of the functionality in reducers/annotations.js are currently
// in the tests for the whole Redux store
describe
(
'sidebar/store/modules/annotations'
,
function
()
{
describe
(
'isWaitingToAnchorAnnotations'
,
()
=>
{
describe
(
'#addAnnotations()'
,
function
()
{
const
ANCHOR_TIME_LIMIT
=
1000
;
let
clock
;
let
store
;
function
tagForID
(
id
)
{
const
storeAnn
=
store
.
findAnnotationByID
(
id
);
if
(
!
storeAnn
)
{
throw
new
Error
(
`No annotation with ID
${
id
}
`
);
}
return
storeAnn
.
$tag
;
}
beforeEach
(
function
()
{
clock
=
sinon
.
useFakeTimers
();
store
=
createTestStore
();
});
afterEach
(
function
()
{
clock
.
restore
();
});
it
(
'adds annotations not in the store'
,
function
()
{
const
annot
=
fixtures
.
defaultAnnotation
();
store
.
addAnnotations
([
annot
]);
assert
.
match
(
store
.
getState
().
annotations
.
annotations
,
[
sinon
.
match
(
annot
),
]);
});
it
(
'does not change `selectedTab` state if annotations are already loaded'
,
function
()
{
const
annot
=
fixtures
.
defaultAnnotation
();
store
.
addAnnotations
([
annot
]);
const
page
=
fixtures
.
oldPageNote
();
store
.
addAnnotations
([
page
]);
assert
.
equal
(
store
.
getState
().
selection
.
selectedTab
,
uiConstants
.
TAB_ANNOTATIONS
);
});
it
(
'sets `selectedTab` to "note" if only page notes are present'
,
function
()
{
const
page
=
fixtures
.
oldPageNote
();
store
.
addAnnotations
([
page
]);
assert
.
equal
(
store
.
getState
().
selection
.
selectedTab
,
uiConstants
.
TAB_NOTES
);
});
it
(
'leaves `selectedTab` as "annotation" if annotations and/or page notes are present'
,
function
()
{
const
page
=
fixtures
.
oldPageNote
();
const
annot
=
fixtures
.
defaultAnnotation
();
store
.
addAnnotations
([
annot
,
page
]);
assert
.
equal
(
store
.
getState
().
selection
.
selectedTab
,
uiConstants
.
TAB_ANNOTATIONS
);
});
it
(
'assigns a local tag to annotations'
,
function
()
{
const
annotA
=
Object
.
assign
(
fixtures
.
defaultAnnotation
(),
{
id
:
'a1'
});
const
annotB
=
Object
.
assign
(
fixtures
.
defaultAnnotation
(),
{
id
:
'a2'
});
store
.
addAnnotations
([
annotA
,
annotB
]);
const
tags
=
store
.
getState
().
annotations
.
annotations
.
map
(
function
(
a
)
{
return
a
.
$tag
;
});
assert
.
deepEqual
(
tags
,
[
't1'
,
't2'
]);
});
it
(
'updates annotations with matching IDs in the store'
,
function
()
{
const
annot
=
fixtures
.
defaultAnnotation
();
store
.
addAnnotations
([
annot
]);
const
update
=
Object
.
assign
({},
fixtures
.
defaultAnnotation
(),
{
text
:
'update'
,
});
store
.
addAnnotations
([
update
]);
const
updatedAnnot
=
store
.
getState
().
annotations
.
annotations
[
0
];
assert
.
equal
(
updatedAnnot
.
text
,
'update'
);
});
it
(
'updates annotations with matching tags in the store'
,
function
()
{
const
annot
=
fixtures
.
newAnnotation
();
annot
.
$tag
=
'local-tag'
;
store
.
addAnnotations
([
annot
]);
const
saved
=
Object
.
assign
({},
annot
,
{
id
:
'server-id'
});
store
.
addAnnotations
([
saved
]);
const
annots
=
store
.
getState
().
annotations
.
annotations
;
assert
.
equal
(
annots
.
length
,
1
);
assert
.
equal
(
annots
[
0
].
id
,
'server-id'
);
});
it
(
'preserves anchoring status of updated annotations'
,
function
()
{
const
annot
=
fixtures
.
defaultAnnotation
();
store
.
addAnnotations
([
annot
]);
store
.
updateAnchorStatus
({
[
tagForID
(
annot
.
id
)]:
'anchored'
});
const
update
=
Object
.
assign
({},
fixtures
.
defaultAnnotation
(),
{
text
:
'update'
,
});
store
.
addAnnotations
([
update
]);
const
updatedAnnot
=
store
.
getState
().
annotations
.
annotations
[
0
];
assert
.
isFalse
(
updatedAnnot
.
$orphan
);
});
it
(
'sets the timeout flag on annotations that fail to anchor within a time limit'
,
function
()
{
const
annot
=
fixtures
.
defaultAnnotation
();
store
.
addAnnotations
([
annot
]);
clock
.
tick
(
ANCHOR_TIME_LIMIT
);
assert
.
isTrue
(
store
.
getState
().
annotations
.
annotations
[
0
].
$anchorTimeout
);
});
it
(
'does not set the timeout flag on annotations that do anchor within a time limit'
,
function
()
{
const
annot
=
fixtures
.
defaultAnnotation
();
store
.
addAnnotations
([
annot
]);
store
.
updateAnchorStatus
({
[
tagForID
(
annot
.
id
)]:
'anchored'
});
clock
.
tick
(
ANCHOR_TIME_LIMIT
);
assert
.
isFalse
(
store
.
getState
().
annotations
.
annotations
[
0
].
$anchorTimeout
);
});
it
(
'does not attempt to modify orphan status if annotations are removed before anchoring timeout expires'
,
function
()
{
const
annot
=
fixtures
.
defaultAnnotation
();
store
.
addAnnotations
([
annot
]);
store
.
updateAnchorStatus
({
[
tagForID
(
annot
.
id
)]:
'anchored'
});
store
.
removeAnnotations
([
annot
]);
assert
.
doesNotThrow
(
function
()
{
clock
.
tick
(
ANCHOR_TIME_LIMIT
);
});
});
it
(
'does not expect annotations to anchor on the stream'
,
function
()
{
const
isOrphan
=
function
()
{
return
!!
metadata
.
isOrphan
(
store
.
getState
().
annotations
.
annotations
[
0
]);
};
const
annot
=
fixtures
.
defaultAnnotation
();
store
.
setAppIsSidebar
(
false
);
store
.
addAnnotations
([
annot
]);
clock
.
tick
(
ANCHOR_TIME_LIMIT
);
assert
.
isFalse
(
isOrphan
());
});
it
(
'initializes the $orphan field for new annotations'
,
function
()
{
store
.
addAnnotations
([
fixtures
.
newAnnotation
()]);
assert
.
isFalse
(
store
.
getState
().
annotations
.
annotations
[
0
].
$orphan
);
});
});
describe
(
'#isWaitingToAnchorAnnotations'
,
()
=>
{
it
(
'returns true if there are unanchored annotations'
,
()
=>
{
const
unanchored
=
Object
.
assign
(
fixtures
.
oldAnnotation
(),
{
$orphan
:
'undefined'
,
...
...
@@ -130,7 +299,7 @@ describe('sidebar/store/modules/annotations', function() {
describe
(
'#hideAnnotation'
,
function
()
{
it
(
'sets the `hidden` state to `true`'
,
function
()
{
const
store
=
createStore
();
const
store
=
create
Test
Store
();
const
ann
=
fixtures
.
moderatedAnnotation
({
hidden
:
false
});
store
.
dispatch
(
actions
.
addAnnotations
([
ann
]));
...
...
@@ -143,7 +312,7 @@ describe('sidebar/store/modules/annotations', function() {
describe
(
'#unhideAnnotation'
,
function
()
{
it
(
'sets the `hidden` state to `false`'
,
function
()
{
const
store
=
createStore
();
const
store
=
create
Test
Store
();
const
ann
=
fixtures
.
moderatedAnnotation
({
hidden
:
true
});
store
.
dispatch
(
actions
.
addAnnotations
([
ann
]));
...
...
@@ -156,7 +325,7 @@ describe('sidebar/store/modules/annotations', function() {
describe
(
'#removeAnnotations'
,
function
()
{
it
(
'removes the annotation'
,
function
()
{
const
store
=
createStore
();
const
store
=
create
Test
Store
();
const
ann
=
fixtures
.
defaultAnnotation
();
store
.
dispatch
(
actions
.
addAnnotations
([
ann
]));
store
.
dispatch
(
actions
.
removeAnnotations
([
ann
]));
...
...
@@ -210,7 +379,7 @@ describe('sidebar/store/modules/annotations', function() {
},
].
forEach
(
testCase
=>
{
it
(
`updates the flagged status of an annotation when a
${
testCase
.
description
}
`
,
()
=>
{
const
store
=
createStore
();
const
store
=
create
Test
Store
();
const
ann
=
fixtures
.
defaultAnnotation
();
ann
.
flagged
=
testCase
.
wasFlagged
;
ann
.
moderation
=
testCase
.
oldModeration
;
...
...
@@ -226,8 +395,22 @@ describe('sidebar/store/modules/annotations', function() {
});
describe
(
'#createAnnotation'
,
function
()
{
let
clock
;
let
now
;
let
store
;
beforeEach
(()
=>
{
// Stop the clock to keep the current date from advancing
clock
=
sinon
.
useFakeTimers
();
now
=
new
Date
();
store
=
createTestStore
();
});
afterEach
(()
=>
{
clock
.
restore
();
});
it
(
'should create an annotation'
,
function
()
{
const
store
=
createStore
();
const
ann
=
fixtures
.
oldAnnotation
();
store
.
dispatch
(
actions
.
createAnnotation
(
ann
));
assert
.
equal
(
...
...
@@ -236,8 +419,91 @@ describe('sidebar/store/modules/annotations', function() {
);
});
it
(
'should set basic default properties on a new/empty annotation'
,
()
=>
{
store
.
dispatch
(
actions
.
createAnnotation
({
id
:
'myID'
},
now
));
const
createdAnnotation
=
selectors
.
findAnnotationByID
(
store
.
getState
(),
'myID'
);
assert
.
include
(
createdAnnotation
,
{
created
:
now
.
toISOString
(),
updated
:
now
.
toISOString
(),
text
:
''
,
});
assert
.
isArray
(
createdAnnotation
.
tags
);
});
it
(
'should set user properties on a new/empty annotation'
,
()
=>
{
store
.
dispatch
(
actions
.
createAnnotation
({
id
:
'myID'
},
now
));
const
createdAnnotation
=
selectors
.
findAnnotationByID
(
store
.
getState
(),
'myID'
);
assert
.
equal
(
createdAnnotation
.
user
,
store
.
getState
().
session
.
userid
);
assert
.
equal
(
createdAnnotation
.
user_info
,
store
.
getState
().
session
.
user_info
);
});
it
(
'should set group to currently-focused group if not set on annotation'
,
()
=>
{
store
.
dispatch
(
actions
.
createAnnotation
({
id
:
'myID'
},
now
));
const
createdAnnotation
=
selectors
.
findAnnotationByID
(
store
.
getState
(),
'myID'
);
assert
.
equal
(
createdAnnotation
.
group
,
store
.
getState
().
groups
.
focusedGroupId
);
});
it
(
'should set not overwrite properties if present'
,
()
=>
{
store
.
dispatch
(
actions
.
createAnnotation
(
{
id
:
'myID'
,
created
:
'when'
,
updated
:
'then'
,
text
:
'my annotation'
,
tags
:
[
'foo'
,
'bar'
],
group
:
'fzzy'
,
user
:
'acct:foo@bar.com'
,
user_info
:
{
display_name
:
'Herbivore Fandango'
,
},
},
now
)
);
const
createdAnnotation
=
selectors
.
findAnnotationByID
(
store
.
getState
(),
'myID'
);
assert
.
include
(
createdAnnotation
,
{
created
:
'when'
,
updated
:
'then'
,
text
:
'my annotation'
,
group
:
'fzzy'
,
user
:
'acct:foo@bar.com'
,
});
assert
.
include
(
createdAnnotation
.
tags
,
'foo'
,
'bar'
);
assert
.
equal
(
createdAnnotation
.
user_info
.
display_name
,
'Herbivore Fandango'
);
});
it
(
'should change tab focus to TAB_ANNOTATIONS when a new annotation is created'
,
function
()
{
const
store
=
createStore
();
store
.
dispatch
(
actions
.
createAnnotation
(
fixtures
.
oldAnnotation
()));
assert
.
equal
(
store
.
getState
().
selection
.
selectedTab
,
...
...
@@ -246,7 +512,6 @@ describe('sidebar/store/modules/annotations', function() {
});
it
(
'should change tab focus to TAB_NOTES when a new note annotation is created'
,
function
()
{
const
store
=
createStore
();
store
.
dispatch
(
actions
.
createAnnotation
(
fixtures
.
oldPageNote
()));
assert
.
equal
(
store
.
getState
().
selection
.
selectedTab
,
...
...
@@ -255,7 +520,7 @@ describe('sidebar/store/modules/annotations', function() {
});
it
(
'should expand parent of created annotation'
,
function
()
{
const
store
=
createStore
();
const
store
=
create
Test
Store
();
store
.
dispatch
(
actions
.
addAnnotations
([
{
...
...
src/sidebar/store/test/index-test.js
View file @
248458e4
...
...
@@ -2,12 +2,10 @@ const immutable = require('seamless-immutable');
const
storeFactory
=
require
(
'../index'
);
const
annotationFixtures
=
require
(
'../../test/annotation-fixtures'
);
const
metadata
=
require
(
'../../util/annotation-metadata'
);
const
uiConstants
=
require
(
'../../ui-constants'
);
const
defaultAnnotation
=
annotationFixtures
.
defaultAnnotation
;
const
newAnnotation
=
annotationFixtures
.
newAnnotation
;
const
oldPageNote
=
annotationFixtures
.
oldPageNote
;
const
fixtures
=
immutable
({
pair
:
[
...
...
@@ -123,190 +121,6 @@ describe('store', function() {
});
});
describe
(
'#addAnnotations()'
,
function
()
{
const
ANCHOR_TIME_LIMIT
=
1000
;
let
clock
;
beforeEach
(
function
()
{
clock
=
sinon
.
useFakeTimers
();
});
afterEach
(
function
()
{
clock
.
restore
();
});
it
(
'adds annotations not in the store'
,
function
()
{
const
annot
=
defaultAnnotation
();
store
.
addAnnotations
([
annot
]);
assert
.
match
(
store
.
getState
().
annotations
.
annotations
,
[
sinon
.
match
(
annot
),
]);
});
it
(
'does not change `selectedTab` state if annotations are already loaded'
,
function
()
{
const
annot
=
defaultAnnotation
();
store
.
addAnnotations
([
annot
]);
const
page
=
oldPageNote
();
store
.
addAnnotations
([
page
]);
assert
.
equal
(
store
.
getState
().
selection
.
selectedTab
,
uiConstants
.
TAB_ANNOTATIONS
);
});
it
(
'sets `selectedTab` to "note" if only page notes are present'
,
function
()
{
const
page
=
oldPageNote
();
store
.
addAnnotations
([
page
]);
assert
.
equal
(
store
.
getState
().
selection
.
selectedTab
,
uiConstants
.
TAB_NOTES
);
});
it
(
'leaves `selectedTab` as "annotation" if annotations and/or page notes are present'
,
function
()
{
const
page
=
oldPageNote
();
const
annot
=
defaultAnnotation
();
store
.
addAnnotations
([
annot
,
page
]);
assert
.
equal
(
store
.
getState
().
selection
.
selectedTab
,
uiConstants
.
TAB_ANNOTATIONS
);
});
it
(
'assigns a local tag to annotations'
,
function
()
{
const
annotA
=
Object
.
assign
(
defaultAnnotation
(),
{
id
:
'a1'
});
const
annotB
=
Object
.
assign
(
defaultAnnotation
(),
{
id
:
'a2'
});
store
.
addAnnotations
([
annotA
,
annotB
]);
const
tags
=
store
.
getState
().
annotations
.
annotations
.
map
(
function
(
a
)
{
return
a
.
$tag
;
});
assert
.
deepEqual
(
tags
,
[
't1'
,
't2'
]);
});
it
(
'updates annotations with matching IDs in the store'
,
function
()
{
const
annot
=
defaultAnnotation
();
store
.
addAnnotations
([
annot
]);
const
update
=
Object
.
assign
({},
defaultAnnotation
(),
{
text
:
'update'
});
store
.
addAnnotations
([
update
]);
const
updatedAnnot
=
store
.
getState
().
annotations
.
annotations
[
0
];
assert
.
equal
(
updatedAnnot
.
text
,
'update'
);
});
it
(
'updates annotations with matching tags in the store'
,
function
()
{
const
annot
=
newAnnotation
();
annot
.
$tag
=
'local-tag'
;
store
.
addAnnotations
([
annot
]);
const
saved
=
Object
.
assign
({},
annot
,
{
id
:
'server-id'
});
store
.
addAnnotations
([
saved
]);
const
annots
=
store
.
getState
().
annotations
.
annotations
;
assert
.
equal
(
annots
.
length
,
1
);
assert
.
equal
(
annots
[
0
].
id
,
'server-id'
);
});
// We add temporary created and updated timestamps to annotations to ensure
// that they sort correctly in the sidebar. These fields are ignored by the
// server.
it
(
'adds created/updated timestamps to new annotations'
,
function
()
{
const
now
=
new
Date
();
const
nowStr
=
now
.
toISOString
();
store
.
addAnnotations
([
newAnnotation
()],
now
);
const
annot
=
store
.
getState
().
annotations
.
annotations
[
0
];
assert
.
equal
(
annot
.
created
,
nowStr
);
assert
.
equal
(
annot
.
updated
,
nowStr
);
});
it
(
'does not overwrite existing created/updated timestamps in new annotations'
,
function
()
{
const
now
=
new
Date
();
const
annot
=
newAnnotation
();
annot
.
created
=
'2000-01-01T01:02:03Z'
;
annot
.
updated
=
'2000-01-01T04:05:06Z'
;
store
.
addAnnotations
([
annot
],
now
);
const
result
=
store
.
getState
().
annotations
.
annotations
[
0
];
assert
.
equal
(
result
.
created
,
annot
.
created
);
assert
.
equal
(
result
.
updated
,
annot
.
updated
);
});
it
(
'preserves anchoring status of updated annotations'
,
function
()
{
const
annot
=
defaultAnnotation
();
store
.
addAnnotations
([
annot
]);
store
.
updateAnchorStatus
({
[
tagForID
(
annot
.
id
)]:
'anchored'
});
const
update
=
Object
.
assign
({},
defaultAnnotation
(),
{
text
:
'update'
});
store
.
addAnnotations
([
update
]);
const
updatedAnnot
=
store
.
getState
().
annotations
.
annotations
[
0
];
assert
.
isFalse
(
updatedAnnot
.
$orphan
);
});
it
(
'sets the timeout flag on annotations that fail to anchor within a time limit'
,
function
()
{
const
annot
=
defaultAnnotation
();
store
.
addAnnotations
([
annot
]);
clock
.
tick
(
ANCHOR_TIME_LIMIT
);
assert
.
isTrue
(
store
.
getState
().
annotations
.
annotations
[
0
].
$anchorTimeout
);
});
it
(
'does not set the timeout flag on annotations that do anchor within a time limit'
,
function
()
{
const
annot
=
defaultAnnotation
();
store
.
addAnnotations
([
annot
]);
store
.
updateAnchorStatus
({
[
tagForID
(
annot
.
id
)]:
'anchored'
});
clock
.
tick
(
ANCHOR_TIME_LIMIT
);
assert
.
isFalse
(
store
.
getState
().
annotations
.
annotations
[
0
].
$anchorTimeout
);
});
it
(
'does not attempt to modify orphan status if annotations are removed before anchoring timeout expires'
,
function
()
{
const
annot
=
defaultAnnotation
();
store
.
addAnnotations
([
annot
]);
store
.
updateAnchorStatus
({
[
tagForID
(
annot
.
id
)]:
'anchored'
});
store
.
removeAnnotations
([
annot
]);
assert
.
doesNotThrow
(
function
()
{
clock
.
tick
(
ANCHOR_TIME_LIMIT
);
});
});
it
(
'does not expect annotations to anchor on the stream'
,
function
()
{
const
isOrphan
=
function
()
{
return
!!
metadata
.
isOrphan
(
store
.
getState
().
annotations
.
annotations
[
0
]);
};
const
annot
=
defaultAnnotation
();
store
.
setAppIsSidebar
(
false
);
store
.
addAnnotations
([
annot
]);
clock
.
tick
(
ANCHOR_TIME_LIMIT
);
assert
.
isFalse
(
isOrphan
());
});
it
(
'initializes the $orphan field for new annotations'
,
function
()
{
store
.
addAnnotations
([
newAnnotation
()]);
assert
.
isFalse
(
store
.
getState
().
annotations
.
annotations
[
0
].
$orphan
);
});
it
(
'adds multiple new annotations'
,
function
()
{
store
.
addAnnotations
([
fixtures
.
newPair
[
0
]]);
store
.
addAnnotations
([
fixtures
.
newPair
[
1
]]);
assert
.
equal
(
store
.
getState
().
annotations
.
annotations
.
length
,
2
);
});
});
describe
(
'#removeAnnotations()'
,
function
()
{
it
(
'removes annotations from the current state'
,
function
()
{
const
annot
=
defaultAnnotation
();
...
...
src/sidebar/test/annotation-fixtures.js
View file @
248458e4
...
...
@@ -45,6 +45,8 @@ function publicAnnotation() {
/** Return an annotation domain model object for a new annotation
* (newly-created client-side, not yet saved to the server).
* Components will never see this data structure, as it will have been
* amended by store reducers.
*/
function
newAnnotation
()
{
return
{
...
...
@@ -54,6 +56,7 @@ function newAnnotation() {
references
:
[],
text
:
'Annotation text'
,
tags
:
[
'tag_1'
,
'tag_2'
],
user
:
'acct:bill@localhost'
,
};
}
...
...
@@ -89,6 +92,7 @@ function newHighlight() {
id
:
undefined
,
$highlight
:
true
,
target
:
[{
source
:
'http://example.org'
}],
user
:
'acct:bill@localhost'
,
};
}
...
...
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