summaryrefslogtreecommitdiffstats
path: root/toolkit/components/ml/tests/browser/head.js
blob: 99d27ce18aa0d30a5a4312ba4c6941e02279355e (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
/* Any copyright is dedicated to the Public Domain.
   http://creativecommons.org/publicdomain/zero/1.0/ */

/// <reference path="../../../../../toolkit/components/translations/tests/browser/shared-head.js" />

"use strict";

/**
 * @type {import("../../content/SummarizerModel.sys.mjs")}
 */
const { SummarizerModel } = ChromeUtils.importESModule(
  "chrome://global/content/ml/SummarizerModel.sys.mjs"
);

/**
 * @type {import("../../actors/MLEngineParent.sys.mjs")}
 */
const { MLEngineParent } = ChromeUtils.importESModule(
  "resource://gre/actors/MLEngineParent.sys.mjs"
);

// This test suite shares some utility functions with translations as they work in a very
// similar fashion. Eventually, the plan is to unify these two components.
Services.scriptloader.loadSubScript(
  "chrome://mochitests/content/browser/toolkit/components/translations/tests/browser/shared-head.js",
  this
);

function getDefaultModelRecords() {
  return [
    {
      name: "summarizer-model",
      version: SummarizerModel.MODEL_MAJOR_VERSION + ".0",
    },
  ];
}

function getDefaultWasmRecords() {
  return [
    {
      name: "inference-engine",
      version: MLEngineParent.WASM_MAJOR_VERSION + ".0",
    },
  ];
}

/**
 * Creates a local RemoteSettingsClient for use within tests.
 *
 * @param {boolean} autoDownloadFromRemoteSettings
 * @param {object[]} models
 * @returns {AttachmentMock}
 */
async function createMLModelsRemoteClient(
  autoDownloadFromRemoteSettings,
  models = getDefaultModelRecords()
) {
  const { RemoteSettings } = ChromeUtils.importESModule(
    "resource://services-settings/remote-settings.sys.mjs"
  );
  const mockedCollectionName = "test-ml-models";
  const client = RemoteSettings(
    `${mockedCollectionName}-${_remoteSettingsMockId++}`
  );
  const metadata = {};
  await client.db.clear();
  await client.db.importChanges(
    metadata,
    Date.now(),
    models.map(({ name, version }) => ({
      id: crypto.randomUUID(),
      name,
      version,
      last_modified: Date.now(),
      schema: Date.now(),
      attachment: {
        hash: `${crypto.randomUUID()}`,
        size: `123`,
        filename: name,
        location: `main-workspace/ml-models/${crypto.randomUUID()}.bin`,
        mimetype: "application/octet-stream",
      },
    }))
  );

  return createAttachmentMock(
    client,
    mockedCollectionName,
    autoDownloadFromRemoteSettings
  );
}

async function createAndMockMLRemoteSettings({
  models = getDefaultModelRecords(),
  autoDownloadFromRemoteSettings = false,
} = {}) {
  const remoteClients = {
    models: await createMLModelsRemoteClient(
      autoDownloadFromRemoteSettings,
      models
    ),
    wasm: await createMLWasmRemoteClient(autoDownloadFromRemoteSettings),
  };

  MLEngineParent.mockRemoteSettings(remoteClients.wasm.client);
  SummarizerModel.mockRemoteSettings(remoteClients.models.client);

  return {
    async removeMocks() {
      await remoteClients.models.client.attachments.deleteAll();
      await remoteClients.models.client.db.clear();
      await remoteClients.wasm.client.attachments.deleteAll();
      await remoteClients.wasm.client.db.clear();

      MLEngineParent.removeMocks();
      SummarizerModel.removeMocks();
    },
    remoteClients,
  };
}

/**
 * Creates a local RemoteSettingsClient for use within tests.
 *
 * @param {boolean} autoDownloadFromRemoteSettings
 * @returns {AttachmentMock}
 */
async function createMLWasmRemoteClient(autoDownloadFromRemoteSettings) {
  const { RemoteSettings } = ChromeUtils.importESModule(
    "resource://services-settings/remote-settings.sys.mjs"
  );
  const mockedCollectionName = "test-translation-wasm";
  const client = RemoteSettings(
    `${mockedCollectionName}-${_remoteSettingsMockId++}`
  );
  const metadata = {};
  await client.db.clear();
  await client.db.importChanges(
    metadata,
    Date.now(),
    getDefaultWasmRecords().map(({ name, version }) => ({
      id: crypto.randomUUID(),
      name,
      version,
      last_modified: Date.now(),
      schema: Date.now(),
    }))
  );

  return createAttachmentMock(
    client,
    mockedCollectionName,
    autoDownloadFromRemoteSettings
  );
}