9b247ebba7
When adding many search conditions (e.g., when matching many items with the `key` condition), the query can fail due to either the bound parameter limit or the expression tree size limit. To avoid this, add support for an 'inlineFilter' property on search conditions when using the 'is' or 'isNot' operator. 'inlineFilter' is a function that returns a quoted value suitable for direct embedding in the SQL statement, or false if not valid. Multiple consecutive conditions for the same 'inlineFilter' field are combined into an `IN (x, y, z)` condition.
324 lines
11 KiB
JavaScript
324 lines
11 KiB
JavaScript
describe("Zotero.Search", function() {
|
|
describe("#save()", function () {
|
|
it("should fail without a name", function* () {
|
|
var s = new Zotero.Search;
|
|
s.addCondition('title', 'is', 'test');
|
|
var e = yield getPromiseError(s.saveTx());
|
|
assert.ok(e);
|
|
assert.equal(e.constructor.name, Error.prototype.constructor.name); // TEMP: Error mismatch
|
|
assert.equal(e.message, "Name not provided for saved search");
|
|
});
|
|
|
|
it("should save a new search", function* () {
|
|
// Save search
|
|
var s = new Zotero.Search;
|
|
s.name = "Test";
|
|
s.addCondition('title', 'is', 'test');
|
|
var id = yield s.saveTx();
|
|
assert.typeOf(id, 'number');
|
|
|
|
// Check saved search
|
|
s = Zotero.Searches.get(id);
|
|
assert.ok(s);
|
|
assert.instanceOf(s, Zotero.Search);
|
|
assert.equal(s.libraryID, Zotero.Libraries.userLibraryID);
|
|
assert.equal(s.name, "Test");
|
|
var conditions = s.getConditions();
|
|
assert.lengthOf(Object.keys(conditions), 1);
|
|
assert.property(conditions, "0");
|
|
var condition = conditions[0];
|
|
assert.propertyVal(condition, 'condition', 'title')
|
|
assert.propertyVal(condition, 'operator', 'is')
|
|
assert.propertyVal(condition, 'value', 'test')
|
|
assert.propertyVal(condition, 'required', false)
|
|
});
|
|
|
|
it("should add a condition to an existing search", function* () {
|
|
// Save search
|
|
var s = new Zotero.Search;
|
|
s.libraryID = Zotero.Libraries.userLibraryID;
|
|
s.name = "Test";
|
|
s.addCondition('title', 'is', 'test');
|
|
var id = yield s.saveTx();
|
|
assert.typeOf(id, 'number');
|
|
|
|
// Add condition
|
|
s = yield Zotero.Searches.getAsync(id);
|
|
s.addCondition('title', 'contains', 'foo');
|
|
var saved = yield s.saveTx();
|
|
assert.isTrue(saved);
|
|
|
|
// Check saved search
|
|
s = yield Zotero.Searches.getAsync(id);
|
|
var conditions = s.getConditions();
|
|
assert.lengthOf(Object.keys(conditions), 2);
|
|
});
|
|
|
|
it("should remove a condition from an existing search", function* () {
|
|
// Save search
|
|
var s = new Zotero.Search;
|
|
s.libraryID = Zotero.Libraries.userLibraryID;
|
|
s.name = "Test";
|
|
s.addCondition('title', 'is', 'test');
|
|
s.addCondition('title', 'contains', 'foo');
|
|
var id = yield s.saveTx();
|
|
assert.typeOf(id, 'number');
|
|
|
|
// Remove condition
|
|
s = yield Zotero.Searches.getAsync(id);
|
|
s.removeCondition(0);
|
|
var saved = yield s.saveTx();
|
|
assert.isTrue(saved);
|
|
|
|
// Check saved search
|
|
s = yield Zotero.Searches.getAsync(id);
|
|
var conditions = s.getConditions();
|
|
assert.lengthOf(Object.keys(conditions), 1);
|
|
assert.property(conditions, "0");
|
|
assert.propertyVal(conditions[0], 'value', 'foo')
|
|
});
|
|
});
|
|
|
|
describe("#search()", function () {
|
|
let win;
|
|
let fooItem;
|
|
let foobarItem;
|
|
|
|
before(function* () {
|
|
// Hidden browser, which requires a browser window, needed for charset detection
|
|
// (until we figure out a better way)
|
|
win = yield loadBrowserWindow();
|
|
fooItem = yield importFileAttachment("search/foo.html");
|
|
foobarItem = yield importFileAttachment("search/foobar.html");
|
|
});
|
|
|
|
after(function* () {
|
|
if (win) {
|
|
win.close();
|
|
}
|
|
yield fooItem.eraseTx();
|
|
yield foobarItem.eraseTx();
|
|
});
|
|
|
|
describe("Conditions", function () {
|
|
describe("attachmentContent", function () {
|
|
it("should find text in HTML files", function* () {
|
|
var s = new Zotero.Search();
|
|
s.libraryID = foobarItem.libraryID;
|
|
s.addCondition('fulltextContent', 'contains', 'foo bar');
|
|
var matches = yield s.search();
|
|
assert.sameMembers(matches, [foobarItem.id]);
|
|
});
|
|
|
|
it("should work in subsearch", function* () {
|
|
var s = new Zotero.Search();
|
|
s.libraryID = foobarItem.libraryID;
|
|
s.addCondition('fulltextContent', 'contains', 'foo bar');
|
|
|
|
var s2 = new Zotero.Search();
|
|
s2.setScope(s);
|
|
s2.addCondition('title', 'contains', 'foobar');
|
|
var matches = yield s2.search();
|
|
assert.sameMembers(matches, [foobarItem.id]);
|
|
});
|
|
});
|
|
|
|
describe("collection", function () {
|
|
it("should find item in collection", function* () {
|
|
var col = yield createDataObject('collection');
|
|
var item = yield createDataObject('item', { collections: [col.id] });
|
|
|
|
var s = new Zotero.Search();
|
|
s.libraryID = item.libraryID;
|
|
s.addCondition('collection', 'is', col.key);
|
|
var matches = yield s.search();
|
|
assert.sameMembers(matches, [item.id]);
|
|
});
|
|
|
|
it("should find items not in collection", function* () {
|
|
var col = yield createDataObject('collection');
|
|
var item = yield createDataObject('item', { collections: [col.id] });
|
|
|
|
var s = new Zotero.Search();
|
|
s.libraryID = item.libraryID;
|
|
s.addCondition('collection', 'isNot', col.key);
|
|
var matches = yield s.search();
|
|
assert.notInclude(matches, item.id);
|
|
});
|
|
|
|
it("shouldn't find item in collection with no items", function* () {
|
|
var col = yield createDataObject('collection');
|
|
var item = yield createDataObject('item');
|
|
|
|
var s = new Zotero.Search();
|
|
s.libraryID = item.libraryID;
|
|
s.addCondition('collection', 'is', col.key);
|
|
var matches = yield s.search();
|
|
assert.lengthOf(matches, 0);
|
|
});
|
|
|
|
it("should find item in subcollection in recursive mode", function* () {
|
|
var col1 = yield createDataObject('collection');
|
|
var col2 = yield createDataObject('collection', { parentID: col1.id });
|
|
var item = yield createDataObject('item', { collections: [col2.id] });
|
|
|
|
var s = new Zotero.Search();
|
|
s.libraryID = item.libraryID;
|
|
s.addCondition('collection', 'is', col1.key);
|
|
s.addCondition('recursive', 'true');
|
|
var matches = yield s.search();
|
|
assert.sameMembers(matches, [item.id]);
|
|
});
|
|
});
|
|
|
|
describe("fileTypeID", function () {
|
|
it("should search by attachment file type", function* () {
|
|
let s = new Zotero.Search();
|
|
s.addCondition('fileTypeID', 'is', Zotero.FileTypes.getID('webpage'));
|
|
let matches = yield s.search();
|
|
assert.sameMembers(matches, [fooItem.id, foobarItem.id]);
|
|
});
|
|
});
|
|
|
|
describe("fulltextWord", function () {
|
|
it("should return matches with full-text conditions", function* () {
|
|
let s = new Zotero.Search();
|
|
s.addCondition('fulltextWord', 'contains', 'foo');
|
|
let matches = yield s.search();
|
|
assert.lengthOf(matches, 2);
|
|
assert.sameMembers(matches, [fooItem.id, foobarItem.id]);
|
|
});
|
|
|
|
it("should not return non-matches with full-text conditions", function* () {
|
|
let s = new Zotero.Search();
|
|
s.addCondition('fulltextWord', 'contains', 'baz');
|
|
let matches = yield s.search();
|
|
assert.lengthOf(matches, 0);
|
|
});
|
|
|
|
it("should return matches for full-text conditions in ALL mode", function* () {
|
|
let s = new Zotero.Search();
|
|
s.addCondition('joinMode', 'all');
|
|
s.addCondition('fulltextWord', 'contains', 'foo');
|
|
s.addCondition('fulltextWord', 'contains', 'bar');
|
|
let matches = yield s.search();
|
|
assert.deepEqual(matches, [foobarItem.id]);
|
|
});
|
|
|
|
it("should not return non-matches for full-text conditions in ALL mode", function* () {
|
|
let s = new Zotero.Search();
|
|
s.addCondition('joinMode', 'all');
|
|
s.addCondition('fulltextWord', 'contains', 'mjktkiuewf');
|
|
s.addCondition('fulltextWord', 'contains', 'zijajkvudk');
|
|
let matches = yield s.search();
|
|
assert.lengthOf(matches, 0);
|
|
});
|
|
|
|
it("should return a match that satisfies only one of two full-text condition in ANY mode", function* () {
|
|
let s = new Zotero.Search();
|
|
s.addCondition('joinMode', 'any');
|
|
s.addCondition('fulltextWord', 'contains', 'bar');
|
|
s.addCondition('fulltextWord', 'contains', 'baz');
|
|
let matches = yield s.search();
|
|
assert.deepEqual(matches, [foobarItem.id]);
|
|
});
|
|
});
|
|
|
|
describe("key", function () {
|
|
it("should allow more than max bound parameters", function* () {
|
|
let s = new Zotero.Search();
|
|
let max = Zotero.DB.MAX_BOUND_PARAMETERS + 100;
|
|
for (let i = 0; i < max; i++) {
|
|
s.addCondition('key', 'is', Zotero.DataObjectUtilities.generateKey());
|
|
}
|
|
yield s.search();
|
|
});
|
|
});
|
|
|
|
describe("savedSearch", function () {
|
|
it("should return items in the saved search", function* () {
|
|
var search = yield createDataObject('search');
|
|
var itemTitle = search.getConditions()[0].value;
|
|
var item = yield createDataObject('item', { title: itemTitle })
|
|
|
|
var s = new Zotero.Search;
|
|
s.libraryID = Zotero.Libraries.userLibraryID;
|
|
s.addCondition('savedSearch', 'is', search.key);
|
|
var matches = yield s.search();
|
|
assert.deepEqual(matches, [item.id]);
|
|
});
|
|
|
|
it("should return items not in the saved search for isNot operator", function* () {
|
|
var search = yield createDataObject('search');
|
|
var itemTitle = search.getConditions()[0].value;
|
|
var item = yield createDataObject('item', { title: itemTitle })
|
|
|
|
var s = new Zotero.Search;
|
|
s.libraryID = Zotero.Libraries.userLibraryID;
|
|
s.addCondition('savedSearch', 'isNot', search.key);
|
|
var matches = yield s.search();
|
|
assert.notInclude(matches, item.id);
|
|
});
|
|
});
|
|
});
|
|
});
|
|
|
|
describe("#toJSON()", function () {
|
|
it("should output all data", function* () {
|
|
let s = new Zotero.Search();
|
|
s.name = "Test";
|
|
s.addCondition('joinMode', 'any');
|
|
s.addCondition('fulltextContent/regexp', 'contains', 's.+');
|
|
let json = s.toJSON();
|
|
assert.equal(json.name, "Test");
|
|
|
|
assert.lengthOf(json.conditions, 2);
|
|
|
|
assert.equal(json.conditions[0].condition, 'joinMode');
|
|
assert.equal(json.conditions[0].operator, 'any');
|
|
// TODO: Change to 'is' + 'any'?
|
|
assert.strictEqual(json.conditions[0].value, '');
|
|
assert.notProperty(json.conditions[0], 'id');
|
|
assert.notProperty(json.conditions[0], 'required');
|
|
assert.notProperty(json.conditions[0], 'mode');
|
|
|
|
assert.equal(json.conditions[1].condition, 'fulltextContent/regexp');
|
|
assert.equal(json.conditions[1].operator, 'contains');
|
|
assert.equal(json.conditions[1].value, 's.+');
|
|
assert.notProperty(json.conditions[1], 'mode');
|
|
});
|
|
});
|
|
|
|
describe("#fromJSON()", function () {
|
|
it("should update all data", function* () {
|
|
let s = new Zotero.Search();
|
|
s.name = "Test";
|
|
s.addCondition('joinMode', 'any');
|
|
s.addCondition('title', 'isNot', 'foo');
|
|
let json = s.toJSON();
|
|
json.name = "Test 2";
|
|
json.conditions = [
|
|
{
|
|
condition: 'title',
|
|
operator: 'contains',
|
|
value: 'foo'
|
|
},
|
|
{
|
|
condition: 'year',
|
|
operator: 'is',
|
|
value: '2016'
|
|
}
|
|
];
|
|
s.fromJSON(json);
|
|
assert.equal(s.name, "Test 2");
|
|
var conditions = s.getConditions();
|
|
assert.lengthOf(Object.keys(conditions), 2);
|
|
assert.equal(conditions["0"].condition, 'title');
|
|
assert.equal(conditions["0"].operator, 'contains');
|
|
assert.equal(conditions["0"].value, 'foo');
|
|
assert.equal(conditions["1"].condition, 'year');
|
|
assert.equal(conditions["1"].operator, 'is');
|
|
assert.equal(conditions["1"].value, '2016');
|
|
});
|
|
});
|
|
});
|