summaryrefslogtreecommitdiffstats
path: root/toolkit/components/translations/tests/browser/browser_translations_actor_sync_models.js
blob: 1d1877fc38bef38ce75e1fa820308afb3a0ee1ef (plain)
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
/* Any copyright is dedicated to the Public Domain.
   http://creativecommons.org/publicdomain/zero/1.0/ */

"use strict";

/**
 * An actor unit test for testing RemoteSettings update behavior. This uses the
 * recommendations from:
 *
 * https://firefox-source-docs.mozilla.org/services/settings/index.html#unit-tests
 */
add_task(async function test_translations_actor_sync_update() {
  const { remoteClients, cleanup } = await setupActorTest({
    autoDownloadFromRemoteSettings: true,
    languagePairs: [
      { fromLang: "en", toLang: "es" },
      { fromLang: "es", toLang: "en" },
    ],
  });

  const decoder = new TextDecoder();
  const modelsPromise = TranslationsParent.getLanguageTranslationModelFiles(
    "en",
    "es"
  );

  await remoteClients.translationModels.resolvePendingDownloads(
    FILES_PER_LANGUAGE_PAIR
  );

  const oldModels = await modelsPromise;

  is(
    decoder.decode(oldModels.model.buffer),
    "Mocked download: test-translation-models model.enes.intgemm.alphas.bin 1.0",
    "The version 1.0 model is downloaded."
  );

  const newModelRecords = createRecordsForLanguagePair("en", "es");
  for (const newModelRecord of newModelRecords) {
    newModelRecord.version = "1.1";
  }

  info('Emitting a remote client "sync" event with an updated record.');
  await remoteClients.translationModels.client.emit("sync", {
    data: {
      created: [],
      updated: newModelRecords.map(newRecord => ({
        old: oldModels[newRecord.fileType].record,
        new: newRecord,
      })),
      deleted: [],
    },
  });

  const updatedModelsPromise =
    TranslationsParent.getLanguageTranslationModelFiles("en", "es");

  await remoteClients.translationModels.resolvePendingDownloads(
    FILES_PER_LANGUAGE_PAIR
  );

  const { model: updatedModel } = await updatedModelsPromise;

  is(
    decoder.decode(updatedModel.buffer),
    "Mocked download: test-translation-models model.enes.intgemm.alphas.bin 1.1",
    "The version 1.1 model is downloaded."
  );

  return cleanup();
});

/**
 * An actor unit test for testing RemoteSettings delete behavior.
 */
add_task(async function test_translations_actor_sync_delete() {
  const { remoteClients, cleanup } = await setupActorTest({
    autoDownloadFromRemoteSettings: true,
    languagePairs: [
      { fromLang: "en", toLang: "es" },
      { fromLang: "es", toLang: "en" },
    ],
  });

  const decoder = new TextDecoder();
  const modelsPromise = TranslationsParent.getLanguageTranslationModelFiles(
    "en",
    "es"
  );

  await remoteClients.translationModels.resolvePendingDownloads(
    FILES_PER_LANGUAGE_PAIR
  );

  const { model } = await modelsPromise;

  is(
    decoder.decode(model.buffer),
    "Mocked download: test-translation-models model.enes.intgemm.alphas.bin 1.0",
    "The version 1.0 model is downloaded."
  );

  info('Emitting a remote client "sync" event with a deleted record.');
  await remoteClients.translationModels.client.emit("sync", {
    data: {
      created: [],
      updated: [],
      deleted: [model.record],
    },
  });

  let errorMessage;
  await TranslationsParent.getLanguageTranslationModelFiles("en", "es").catch(
    error => {
      errorMessage = error?.message;
    }
  );

  is(
    errorMessage,
    'No model file was found for "en" to "es."',
    "The model was successfully removed."
  );

  return cleanup();
});

/**
 * An actor unit test for testing RemoteSettings creation behavior.
 */
add_task(async function test_translations_actor_sync_create() {
  const { remoteClients, cleanup } = await setupActorTest({
    autoDownloadFromRemoteSettings: true,
    languagePairs: [
      { fromLang: "en", toLang: "es" },
      { fromLang: "es", toLang: "en" },
    ],
  });

  const decoder = new TextDecoder();
  const modelsPromise = TranslationsParent.getLanguageTranslationModelFiles(
    "en",
    "es"
  );

  await remoteClients.translationModels.resolvePendingDownloads(
    FILES_PER_LANGUAGE_PAIR
  );

  is(
    decoder.decode((await modelsPromise).model.buffer),
    "Mocked download: test-translation-models model.enes.intgemm.alphas.bin 1.0",
    "The version 1.0 model is downloaded."
  );

  info('Emitting a remote client "sync" event with new records.');
  await remoteClients.translationModels.client.emit("sync", {
    data: {
      created: createRecordsForLanguagePair("en", "fr"),
      updated: [],
      deleted: [],
    },
  });

  const updatedModelsPromise =
    TranslationsParent.getLanguageTranslationModelFiles("en", "fr");

  await remoteClients.translationModels.resolvePendingDownloads(
    FILES_PER_LANGUAGE_PAIR
  );

  const { vocab, lex, model } = await updatedModelsPromise;

  is(
    decoder.decode(vocab.buffer),
    "Mocked download: test-translation-models vocab.enfr.spm 1.0",
    "The en to fr vocab is downloaded."
  );
  is(
    decoder.decode(lex.buffer),
    "Mocked download: test-translation-models lex.50.50.enfr.s2t.bin 1.0",
    "The en to fr lex is downloaded."
  );
  is(
    decoder.decode(model.buffer),
    "Mocked download: test-translation-models model.enfr.intgemm.alphas.bin 1.0",
    "The en to fr model is downloaded."
  );

  return cleanup();
});

add_task(async function test_translations_parent_download_size() {
  const { cleanup } = await setupActorTest({
    languagePairs: [
      { fromLang: "en", toLang: "es" },
      { fromLang: "es", toLang: "en" },
      { fromLang: "en", toLang: "de" },
      { fromLang: "de", toLang: "en" },
    ],
  });

  const directSize =
    await TranslationsParent.getExpectedTranslationDownloadSize("en", "es");
  // Includes model, lex, and vocab files (x3), each mocked at 123 bytes.
  is(
    directSize,
    3 * 123,
    "Returned the expected download size for a direct translation."
  );

  const pivotSize = await TranslationsParent.getExpectedTranslationDownloadSize(
    "es",
    "de"
  );
  // Includes a pivot (x2), model, lex, and vocab files (x3), each mocked at 123 bytes.
  is(
    pivotSize,
    2 * 3 * 123,
    "Returned the expected download size for a pivot."
  );

  const notApplicableSize =
    await TranslationsParent.getExpectedTranslationDownloadSize(
      "unknown",
      "unknown"
    );
  is(
    notApplicableSize,
    0,
    "Returned the expected download size for an unknown or not applicable model."
  );
  return cleanup();
});