This repository was archived by the owner on Jul 26, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathLabelStudio.ts
More file actions
302 lines (270 loc) · 6.88 KB
/
LabelStudio.ts
File metadata and controls
302 lines (270 loc) · 6.88 KB
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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
import { expect } from 'chai';
type LSParams = Record<string, any>;
class LSParamsBuilder {
params: LSParams = {
config: '<View></View>',
interfaces: [
'panel',
'update',
'submit',
'skip',
'controls',
'infobar',
'topbar',
'instruction',
'side-column',
'ground-truth',
'annotations:tabs',
'annotations:menu',
'annotations:current',
'annotations:add-new',
'annotations:delete',
'annotations:view-all',
'predictions:tabs',
'predictions:menu',
'auto-annotation',
'edit-history',
],
task: {
id: 1,
data: {},
annotations: [],
predictions: [],
},
};
private ls: typeof LabelStudio = null;
constructor(ls: typeof LabelStudio) {
this.ls = ls;
}
init() {
this.ls.init(this.params);
}
private get _task() {
if (!this.params.task) {
this.params.task = {
id: 1,
};
}
return this.params.task;
}
private get _annotations() {
const task = this._task;
if (!task.annotations) {
task.annotations = [];
}
return task.annotations;
}
config(config) {
this.params.config = config;
return this;
}
data(data) {
this.params.task.data = data;
return this;
}
task(task) {
this.params.task = task;
return this;
}
annotations(annotations) {
this._task.annotations = annotations;
return this;
}
withAnnotation(annotation) {
this._annotations.push(annotation);
return this;
}
withResult(result) {
this._annotations.push({
id: this._annotations.length + 1001,
result,
});
return this;
}
interfaces(interfaces) {
this.params.interfaces = interfaces;
return this;
}
withInterface(interfaceName: string) {
if (this.params.interfaces.indexOf(interfaceName) < 0) {
this.params.interfaces.push(interfaceName);
}
return this;
}
withoutInterface(interfaceName: string) {
const idx = this.params.interfaces.indexOf(interfaceName);
const isExist = idx >= 0;
if (isExist) {
this.params.interfaces.splice(idx, 1);
}
return this;
}
eventListeners(eventListeners) {
this.params.eventListeners = eventListeners;
return this;
}
withEventListener(eventName, listener) {
if (!this.params.eventListeners) this.params.eventListeners = {};
this.params.eventListeners[eventName] = listener;
return this;
}
withParam(paramName, paramValue) {
this.params[paramName] = paramValue;
return this;
}
}
export const LabelStudio = {
/**
* Initializes LabelStudio intance with given configuration
*/
init(params: LSParams) {
cy.log('Initialize LSF');
const windowLoadCallback = (win: Cypress.AUTWindow) => {
win.DEFAULT_LSF_INIT = false;
win.LSF_CONFIG = {
interfaces: [
'panel',
'update',
'submit',
'skip',
'controls',
'infobar',
'topbar',
'instruction',
'side-column',
'ground-truth',
'annotations:tabs',
'annotations:menu',
'annotations:current',
'annotations:add-new',
'annotations:delete',
'annotations:view-all',
'predictions:tabs',
'predictions:menu',
'auto-annotation',
'edit-history',
],
...params,
};
Cypress.off('window:before:load', windowLoadCallback);
};
Cypress.on('window:before:load', windowLoadCallback);
cy
.visit('/')
.then(win => {
cy.log(`Default feature flags set ${JSON.stringify(win.APP_SETTINGS.feature_flags, null, ' ')}`);
const labelStudio = new win.LabelStudio('label-studio', win.LSF_CONFIG);
if (win.LSF_CONFIG.eventListeners) {
for (const [event, listener] of Object.entries(win.LSF_CONFIG.eventListeners)) {
labelStudio.on(event, listener);
}
}
expect(win.LabelStudio.instances.size).to.be.equal(1);
cy.get('.lsf-editor').should('be.visible');
cy.log('Label Studio initialized');
});
},
params() {
return new LSParamsBuilder(this);
},
/**
* Exports current result from LabelStudio's selected annotationStore
*/
serialize() {
return cy
.window()
.then(win => {
return win.Htx.annotationStore.selected.serializeAnnotation();
});
},
/**
* Wait until the objects are ready for interactions
* It uses inner logic of LabelStudio's object tag models
*/
waitForObjectsReady() {
cy.window().then({ timeout: 90000, }, win => {
return new Promise(resolve => {
const watchObjectsReady = () => {
const isReady = win.Htx?.annotationStore?.selected?.objects?.every(object => object.isReady);
if (isReady) {
resolve(true);
} else {
setTimeout(watchObjectsReady, 16);
}
};
watchObjectsReady();
});
});
},
/**
* Set feature flags on navigation
*/
setFeatureFlagsOnPageLoad(flags: Record<string, boolean>) {
Cypress
.on('window:before:load', win => {
win.FEATURE_FLAGS = flags;
});
},
/**
* Add new settings to previously set feature flags on navigation
*/
addFeatureFlagsOnPageLoad(flags: Record<string, boolean>) {
Cypress
.on('window:before:load', win => {
win.FEATURE_FLAGS = {
...(win.FEATURE_FLAGS || {}),
...flags,
};
});
},
/**
* Toggle feature flags on and off
*/
setFeatureFlags(flags: Record<string, boolean>) {
cy.log('Setting feature flags');
cy
.window()
.then(win => {
win.APP_SETTINGS = win.APP_SETTINGS ?? {};
win.APP_SETTINGS.feature_flags = {
...(win.APP_SETTINGS.feature_flags ?? {}),
...flags,
};
console.log(win.APP_SETTINGS);
});
},
/**
* Assers if the feature flag's state matches a given state
* Checks for enabled flags by default
*/
shouldHaveFeatureFlag(flagName: string, enabled = true) {
return this
.getFeatureFlag(flagName)
.then(flagValue => {
expect(flagValue).to.be.eq(enabled);
});
},
/**
* Returns Cypress wrapper around a feature flag value.
* Allows performing asserions on it using `.should()`
*/
featureFlag(flagName: string) {
return this.getFeatureFlag(flagName).then(flagValue => {
return flagValue;
});
},
/**
* Returns a value of a specific feature flag
*/
getFeatureFlag(flagName: string) {
return cy
.window()
.then(win => {
const featureFlags = (win.APP_SETTINGS?.feature_flags ?? {}) as Record<string, boolean>;
const flagValue = (flagName in featureFlags)
? featureFlags[flagName]
: window.APP_SETTINGS?.feature_flags_default_value === true;
return flagValue;
});
},
};