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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
odoo.define('mail/static/src/utils/utils.js', function (require) {
'use strict';
const { delay } = require('web.concurrency');
const {
patch: webUtilsPatch,
unaccent,
unpatch: webUtilsUnpatch,
} = require('web.utils');
//------------------------------------------------------------------------------
// Public
//------------------------------------------------------------------------------
const classPatchMap = new WeakMap();
const eventHandledWeakMap = new WeakMap();
/**
* Returns the given string after cleaning it. The goal of the clean is to give
* more convenient results when comparing it to potential search results, on
* which the clean should also be called before comparing them.
*
* @param {string} searchTerm
* @returns {string}
*/
function cleanSearchTerm(searchTerm) {
return unaccent(searchTerm.toLowerCase());
}
/**
* Executes the provided functions in order, but with a potential delay between
* them if they take too much time. This is done in order to avoid blocking the
* main thread for too long.
*
* @param {function[]} functions
* @param {integer} [maxTimeFrame=100] time (in ms) until a delay is introduced
*/
async function executeGracefully(functions, maxTimeFrame = 100) {
let startDate = new Date();
for (const func of functions) {
if (new Date() - startDate > maxTimeFrame) {
await new Promise(resolve => setTimeout(resolve));
startDate = new Date();
}
await func();
}
}
/**
* Returns whether the given event has been handled with the given markName.
*
* @param {Event} ev
* @param {string} markName
* @returns {boolean}
*/
function isEventHandled(ev, markName) {
if (!eventHandledWeakMap.get(ev)) {
return false;
}
return eventHandledWeakMap.get(ev).includes(markName);
}
/**
* Marks the given event as handled by the given markName. Useful to allow
* handlers in the propagation chain to make a decision based on what has
* already been done.
*
* @param {Event} ev
* @param {string} markName
*/
function markEventHandled(ev, markName) {
if (!eventHandledWeakMap.get(ev)) {
eventHandledWeakMap.set(ev, []);
}
eventHandledWeakMap.get(ev).push(markName);
}
/**
* Wait a task tick, so that anything in micro-task queue that can be processed
* is processed.
*/
async function nextTick() {
await delay(0);
}
/**
* Inspired by web.utils:patch utility function
*
* @param {Class} Class
* @param {string} patchName
* @param {Object} patch
* @returns {function} unpatch function
*/
function patchClassMethods(Class, patchName, patch) {
let metadata = classPatchMap.get(Class);
if (!metadata) {
metadata = {
origMethods: {},
patches: {},
current: []
};
classPatchMap.set(Class, metadata);
}
if (metadata.patches[patchName]) {
throw new Error(`Patch [${patchName}] already exists`);
}
metadata.patches[patchName] = patch;
applyPatch(Class, patch);
metadata.current.push(patchName);
function applyPatch(Class, patch) {
Object.keys(patch).forEach(function (methodName) {
const method = patch[methodName];
if (typeof method === "function") {
const original = Class[methodName];
if (!(methodName in metadata.origMethods)) {
metadata.origMethods[methodName] = original;
}
Class[methodName] = function (...args) {
const previousSuper = this._super;
this._super = original;
const res = method.call(this, ...args);
this._super = previousSuper;
return res;
};
}
});
}
return () => unpatchClassMethods.bind(Class, patchName);
}
/**
* @param {Class} Class
* @param {string} patchName
* @param {Object} patch
* @returns {function} unpatch function
*/
function patchInstanceMethods(Class, patchName, patch) {
return webUtilsPatch(Class, patchName, patch);
}
/**
* Inspired by web.utils:unpatch utility function
*
* @param {Class} Class
* @param {string} patchName
*/
function unpatchClassMethods(Class, patchName) {
let metadata = classPatchMap.get(Class);
if (!metadata) {
return;
}
classPatchMap.delete(Class);
// reset to original
for (let k in metadata.origMethods) {
Class[k] = metadata.origMethods[k];
}
// apply other patches
for (let name of metadata.current) {
if (name !== patchName) {
patchClassMethods(Class, name, metadata.patches[name]);
}
}
}
/**
* @param {Class} Class
* @param {string} patchName
*/
function unpatchInstanceMethods(Class, patchName) {
return webUtilsUnpatch(Class, patchName);
}
//------------------------------------------------------------------------------
// Export
//------------------------------------------------------------------------------
return {
cleanSearchTerm,
executeGracefully,
isEventHandled,
markEventHandled,
nextTick,
patchClassMethods,
patchInstanceMethods,
unpatchClassMethods,
unpatchInstanceMethods,
};
});
|
