1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
/* Any copyright is dedicated to the Public Domain.
http://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
const EXPORTED_SYMBOLS = ["FormHistoryTestUtils"];
const { XPCOMUtils } = ChromeUtils.import(
"resource://gre/modules/XPCOMUtils.jsm"
);
XPCOMUtils.defineLazyModuleGetters(this, {
FormHistory: "resource://gre/modules/FormHistory.jsm",
});
/**
* Provides a js-friendly promise-based API around FormHistory, and utils.
*
* @note This is not a 100% complete implementation, it is intended for quick
* additions and check, thus further changes may be necessary for different
* use-cases.
*/
var FormHistoryTestUtils = {
makeListener(resolve, reject) {
let results = [];
return {
_results: results,
handleResult(result) {
results.push(result);
},
handleError(error) {
reject(error);
},
handleCompletion(errored) {
if (!errored) {
resolve(results);
}
},
};
},
/**
* Adds values to form history.
*
* @param {string} fieldname The field name.
* @param {array} additions Array of entries describing the values to add.
* Each entry can either be a string, or an object with the shape
* { value, source}.
* @returns {Promise} Resolved once the operation is complete.
*/
async add(fieldname, additions = []) {
// Additions are made one by one, so multiple identical entries are properly
// applied.
additions = additions.map(v => (typeof v == "string" ? { value: v } : v));
for (let { value, source } of additions) {
await new Promise((resolve, reject) => {
FormHistory.update(
Object.assign({ fieldname }, { op: "bump", value, source }),
this.makeListener(resolve, reject)
);
});
}
},
/**
* Counts values from form history.
*
* @param {string} fieldname The field name.
* @param {array} filters Objects describing the search properties.
* @returns {number} The number of entries found.
*/
async count(fieldname, filters = {}) {
let results = await new Promise((resolve, reject) => {
FormHistory.count(
Object.assign({ fieldname }, filters),
this.makeListener(resolve, reject)
);
});
return results[0];
},
/**
* Removes values from form history.
* If you want to remove all history, use clear() instead.
*
* @param {string} fieldname The field name.
* @param {array} removals Array of entries describing the values to add.
* Each entry can either be a string, or an object with the shape
* { value, source}. If source is specified, only the source relation will
* be removed, while the global form history value persists.
* @param {object} window The window containing the urlbar.
* @returns {Promise} Resolved once the operation is complete.
*/
remove(fieldname, removals) {
let changes = removals.map(v => {
let criteria = typeof v == "string" ? { value: v } : v;
return Object.assign({ fieldname, op: "remove" }, criteria);
});
return new Promise((resolve, reject) => {
FormHistory.update(changes, this.makeListener(resolve, reject));
});
},
/**
* Removes all values from form history.
* If you want to remove individual values, use remove() instead.
*
* @param {string} fieldname The field name whose history should be cleared.
* Can be omitted to clear all form history.
* @returns {Promise} Resolved once the operation is complete.
*/
clear(fieldname) {
return new Promise((resolve, reject) => {
let baseChange = fieldname ? { fieldname } : {};
FormHistory.update(
Object.assign(baseChange, { op: "remove" }),
this.makeListener(resolve, reject)
);
});
},
/**
* Searches form history.
*
* @param {string} fieldname The field name.
* @param {array} filters Objects describing the search properties.
* @returns {Promise} Resolved once the operation is complete.
* @resolves {Array} Array of found form history entries.
*/
search(fieldname, filters = {}) {
return new Promise((resolve, reject) => {
FormHistory.search(
null,
Object.assign({ fieldname }, filters),
this.makeListener(resolve, reject)
);
});
},
/**
* Gets autocomplete results from form history.
*
* @param {string} searchString The search string.
* @param {string} fieldname The field name.
* @param {array} filters Objects describing the search properties.
* @returns {Promise} Resolved once the operation is complete.
* @resolves {Array} Array of found form history entries.
*/
autocomplete(searchString, fieldname, filters = {}) {
return new Promise((resolve, reject) => {
FormHistory.getAutoCompleteResults(
searchString,
Object.assign({ fieldname }, filters),
this.makeListener(resolve, reject)
);
});
},
};
|
