mirrors/zotero
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Avoid unnecessary tag queries (regression from React tag selector)

Browse source
This commit is contained in:
Dan Stillman 2019-03-15 12:46:27 -04:00
parent 48953f7176
commit 94ccba45b9
2 changed files with 72 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

32
chrome/content/zotero/containers/tagSelector.jsx
View file

@ -68,14 +68,11 @@ Zotero.TagSelector = class TagSelectorContainer extends React.Component {
default: default:
return; return;
} }
return this.setState({tags: await this.getTags()});
} }
if (type == 'item' || type == 'item-tag') { // Ignore item events other than 'trash'
if (event == 'redraw') { if (type == 'item' && event != 'trash') {
return; return;
}
return this.setState({tags: await this.getTags()});
} }
// If a selected tag no longer exists, deselect it // If a selected tag no longer exists, deselect it
@ -93,6 +90,27 @@ Zotero.TagSelector = class TagSelectorContainer extends React.Component {
} }
return; return;
} }
// TODO: Check libraryID for some events to avoid refreshing unnecessarily on sync changes?
var newTags = await this.getTags();
if (type == 'item-tag' && event == 'remove') {
let changed = false;
let visibleTags = newTags.map(tag => tag.tag);
for (let id of ids) {
let tag = extraData[id].tag;
if (this.selectedTags.has(tag) && !visibleTags.includes(tag)) {
this.selectedTags.delete(tag);
changed = true;
}
}
if (changed && typeof(this.props.onSelection) === 'function') {
this.props.onSelection(this.selectedTags);
}
}
return this.setState({tags: newTags});
} }
async getTags(tagsInScope, tagColors) { async getTags(tagsInScope, tagColors) {

58
test/tests/tagSelectorTest.js
View file

@ -413,37 +413,73 @@ describe("Tag Selector", function () {
assert.notInclude(getRegularTags(), "A"); assert.notInclude(getRegularTags(), "A");
}); });
it("should deselect a tag when removed from the last item in this view", async function () {
var libraryID = Zotero.Libraries.userLibraryID;
await selectLibrary(win);
var tag1 = Zotero.Utilities.randomString();
var tag2 = Zotero.Utilities.randomString();
var promise = waitForTagSelector(win);
var item1 = await createDataObject('item', { tags: [{ tag: tag1 }] });
var item2 = await createDataObject('item', { tags: [{ tag: tag2 }] });
await promise;
tagSelector.handleTagSelected(tag1);
await waitForTagSelector(win);
// Tag selector should show the selected tag
assert.include(getRegularTags(), tag1);
// And not the unselected one
assert.notInclude(getRegularTags(), tag2);
// Remove tag from item
promise = waitForTagSelector(win);
item1.removeTag(tag1);
await item1.saveTx();
await promise;
// Notifier item-tag remove triggers #onSelected, which eventually triggers #onItemViewChanged
await waitForTagSelector(win);
// Removed tag should no longer be shown or selected
assert.notInclude(getRegularTags(), tag1);
assert.notInclude(Array.from(tagSelector.getTagSelection()), tag1);
// Other tags should be shown again
assert.include(getRegularTags(), tag2);
});
it("should deselect a tag when deleted from a library", async function () { it("should deselect a tag when deleted from a library", async function () {
var libraryID = Zotero.Libraries.userLibraryID; var libraryID = Zotero.Libraries.userLibraryID;
await selectLibrary(win); await selectLibrary(win);
var promise = waitForTagSelector(win); var promise = waitForTagSelector(win);
await createDataObject('item', { tags: [{ tag: 'A' }] }); var tag1 = Zotero.Utilities.randomString();
await createDataObject('item', { tags: [{ tag: 'B' }] }); var tag2 = Zotero.Utilities.randomString();
await createDataObject('item', { tags: [{ tag: tag1 }] });
await createDataObject('item', { tags: [{ tag: tag2 }] });
await promise; await promise;
tagSelector.handleTagSelected('A'); tagSelector.handleTagSelected(tag1);
await waitForTagSelector(win); await waitForTagSelector(win);
// Tag selector should show the selected tag // Tag selector should show the selected tag
assert.include(getRegularTags(), 'A'); assert.include(getRegularTags(), tag1);
// And not the unselected one // And not the unselected one
assert.notInclude(getRegularTags(), 'B'); assert.notInclude(getRegularTags(), tag2);
// Remove tag from library // Remove tag from library
promise = waitForTagSelector(win); promise = waitForTagSelector(win);
await Zotero.Tags.removeFromLibrary(libraryID, Zotero.Tags.getID('A')); await Zotero.Tags.removeFromLibrary(libraryID, Zotero.Tags.getID(tag1));
// notify item-tag remove // Notifier item-tag remove
await promise; await promise;
// notify tag delete which triggers #onSelected, which eventually triggers #onItemViewChanged // Notifier tag delete triggers #onSelected, which eventually triggers #onItemViewChanged
await waitForTagSelector(win); await waitForTagSelector(win);
// Deleted tag should no longer be shown or selected // Deleted tag should no longer be shown or selected
assert.notInclude(getRegularTags(), 'A'); assert.notInclude(getRegularTags(), tag1);
assert.notInclude(Array.from(tagSelector.getTagSelection()), 'A'); assert.notInclude(Array.from(tagSelector.getTagSelection()), tag1);
// Other tags should be shown again // Other tags should be shown again
assert.include(getRegularTags(), 'B'); assert.include(getRegularTags(), tag2);
}); });
}); });