File: mock_translate_kit_lib.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (321 lines) | stat: -rw-r--r-- 11,946 bytes parent folder | download | duplicates (5)
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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifdef UNSAFE_BUFFERS_BUILD
// TODO(crbug.com/390223051): Remove C-library calls to fix the errors.
#pragma allow_unsafe_libc_calls
#endif

// This file implements the ABI of libtranslatekit only for testing. It is not
// used in production.
// This mock implementation runs as follows:
// TranslateKitCreateTranslator()
//   - If the source language is "cause_crash", crash.
//   - Check the file "dict.dat" in the language package.
//   - If the file exists, create and returns a FakeTranslator.
//   - Otherwise, return a null pointer.
// TranslatorTranslate()
//   - If the input text is "SIMULATE_ERROR", return false.
//   - If the input text is "CAUSE_CRASH", crash.
//   - If the input text is "CHECK_NOT_EXIST_FILE", check if the file
//     "not_exist_file" exists in the language package. And pass the result of
//     Open() and FileExists() to the callback, and return true.
//   - Otherwise, pass the concatenation of the content of "dict.dat" and the
//     input text to the callback, and return true.

#include <cstddef>
#include <cstdint>
#include <cstring>
#include <string>
#include <string_view>

#include "base/check.h"
#include "base/compiler_specific.h"
#include "base/logging.h"
#include "base/process/process.h"
#include "base/strings/strcat.h"
#include "base/strings/to_string.h"
#include "base/types/pass_key.h"
#include "build/build_config.h"
#include "components/services/on_device_translation/proto/translate_kit_api.pb.h"
#include "components/services/on_device_translation/translate_kit_structs.h"

#if BUILDFLAG(IS_WIN)
#define TRANSLATE_KIT_EXPORT __declspec(dllexport)
#else
#define TRANSLATE_KIT_EXPORT __attribute__((visibility("default")))
#endif

using chrome::on_device_translation::TranslateKitLanguagePackageConfig;

namespace {

// The storage backend is a global variable, set by InitializeStorageBackend().
struct StorageBackend {
  FileExistsFn file_exists;
  OpenForReadOnlyMemoryMapFn open_for_read_only_memory_map;
  DeleteReadOnlyMemoryRegionFn delete_read_only_memory_region;
  ReadOnlyMemoryRegionDataFn read_only_memory_region_data;
  ReadOnlyMemoryRegionLengthFn read_only_memory_region_length;
  std::uintptr_t user_data;
} g_storage_backend;

// FileExists() is a wrapper around the FileExistsFn.
DISABLE_CFI_DLSYM bool FileExists(const std::string_view file_name,
                                  bool* is_directory) {
  CHECK(g_storage_backend.file_exists);
  return g_storage_backend.file_exists(file_name.data(), file_name.size(),
                                       is_directory,
                                       g_storage_backend.user_data);
}

// FakeReadOnlyMemoryMap is a wrapper around the OpenForReadOnlyMemoryMapFn,
// DeleteReadOnlyMemoryRegionFn, ReadOnlyMemoryRegionDataFn, and
// ReadOnlyMemoryRegionLengthFn.
class FakeReadOnlyMemoryMap {
 public:
  DISABLE_CFI_DLSYM static std::unique_ptr<FakeReadOnlyMemoryMap> MaybeCreate(
      std::string_view path) {
    CHECK(g_storage_backend.open_for_read_only_memory_map);
    std::uintptr_t data_ptr = g_storage_backend.open_for_read_only_memory_map(
        path.data(), path.size(), g_storage_backend.user_data);
    if (data_ptr == 0) {
      return nullptr;
    }
    return std::make_unique<FakeReadOnlyMemoryMap>(
        data_ptr, base::PassKey<FakeReadOnlyMemoryMap>());
  }

  FakeReadOnlyMemoryMap(std::uintptr_t ptr,
                        base::PassKey<FakeReadOnlyMemoryMap>)
      : ptr_(ptr) {}
  DISABLE_CFI_DLSYM ~FakeReadOnlyMemoryMap() {
    CHECK(g_storage_backend.delete_read_only_memory_region);
    g_storage_backend.delete_read_only_memory_region(
        ptr_, g_storage_backend.user_data);
  }
  FakeReadOnlyMemoryMap(const FakeReadOnlyMemoryMap&) = delete;
  FakeReadOnlyMemoryMap& operator=(const FakeReadOnlyMemoryMap&) = delete;

  DISABLE_CFI_DLSYM const void* data() {
    CHECK(g_storage_backend.read_only_memory_region_data);
    return g_storage_backend.read_only_memory_region_data(
        ptr_, g_storage_backend.user_data);
  }
  DISABLE_CFI_DLSYM uint64_t size() {
    CHECK(g_storage_backend.read_only_memory_region_length);
    return g_storage_backend.read_only_memory_region_length(
        ptr_, g_storage_backend.user_data);
  }

 private:
  std::uintptr_t ptr_;
};

// This class implements a fake translator.
// Its Translate() method concatenates the content of "dict.dat" in the
// language package and the input text, and returns it as the translation
// result.
class FakeTranslator {
 public:
  static std::unique_ptr<FakeTranslator> MaybeCreate(
      size_t index,
      const std::string_view package_path) {
    std::string dict_path = base::StrCat({package_path, "/dict.dat"});
    auto dict_data = FakeReadOnlyMemoryMap::MaybeCreate(dict_path);
    bool is_directory = false;
    CHECK_EQ(!!dict_data, FileExists(dict_path, &is_directory));
    if (!dict_data) {
      return nullptr;
    }
    return std::make_unique<FakeTranslator>(package_path, std::move(dict_data),
                                            base::PassKey<FakeTranslator>());
  }

  FakeTranslator(const std::string_view package_path,
                 std::unique_ptr<FakeReadOnlyMemoryMap> dict,
                 base::PassKey<FakeTranslator>)
      : package_path_(package_path), dict_(std::move(dict)) {}
  ~FakeTranslator() = default;
  FakeTranslator(const FakeTranslator&) = delete;
  FakeTranslator& operator=(const FakeTranslator&) = delete;

  std::string Translate(const std::string_view input) {
    return base::StrCat(
        {std::string_view(reinterpret_cast<const char*>(dict_->data()),
                          dict_->size()),
         input});
  }

  const std::string& package_path() const { return package_path_; }

 private:
  const std::string package_path_;
  std::unique_ptr<FakeReadOnlyMemoryMap> dict_;
};

// This class implements a fake TranslateKit.
// It creates a FakeTranslator for each language pair if the language package
// contains "dict.dat".
class FakeTranslateKit {
 public:
  FakeTranslateKit() = default;
  ~FakeTranslateKit() = default;
  FakeTranslateKit(const FakeTranslateKit&) = delete;
  FakeTranslateKit& operator=(const FakeTranslateKit&) = delete;

  void SetConfig(TranslateKitLanguagePackageConfig config) {
    config_ = std::move(config);
  }
  std::unique_ptr<FakeTranslator> MaybeCreateTranslator(
      const std::string_view source_lang,
      const std::string_view target_lang) {
    for (int index = 0; index < config_.packages().size(); ++index) {
      const auto& package = config_.packages().at(index);
      if (package.language1() == source_lang &&
          package.language2() == target_lang) {
        return FakeTranslator::MaybeCreate(index, package.package_path());
      }
    }
    return nullptr;
  }

 private:
  TranslateKitLanguagePackageConfig config_;
};

}  // namespace

extern "C" {

TRANSLATE_KIT_EXPORT bool GetTranslateKitVersion(TranslateKitVersion* version) {
  CHECK(version);
  CHECK(version->buffer);
  CHECK(version->buffer_size);

  // Always return a maximum version.
  constexpr char kMaxVersion[] = "9999.99.99.99";
  strncpy(version->buffer, kMaxVersion, sizeof(kMaxVersion));
  version->buffer_size = sizeof(kMaxVersion) - 1;
  return true;
}

TRANSLATE_KIT_EXPORT void InitializeStorageBackend(
    FileExistsFn file_exists,
    OpenForReadOnlyMemoryMapFn open_for_read_only_memory_map,
    DeleteReadOnlyMemoryRegionFn delete_read_only_memory_region,
    ReadOnlyMemoryRegionDataFn read_only_memory_region_data,
    ReadOnlyMemoryRegionLengthFn read_only_memory_region_length,
    std::uintptr_t user_data) {
  g_storage_backend.file_exists = file_exists;
  g_storage_backend.open_for_read_only_memory_map =
      open_for_read_only_memory_map;
  g_storage_backend.delete_read_only_memory_region =
      delete_read_only_memory_region;
  g_storage_backend.read_only_memory_region_data = read_only_memory_region_data;
  g_storage_backend.read_only_memory_region_length =
      read_only_memory_region_length;
  g_storage_backend.user_data = user_data;
}

TRANSLATE_KIT_EXPORT uintptr_t CreateTranslateKit() {
  return reinterpret_cast<uintptr_t>(new FakeTranslateKit());
}

TRANSLATE_KIT_EXPORT void DeleteTranslateKit(uintptr_t kit_ptr) {
  CHECK(kit_ptr);
  delete reinterpret_cast<FakeTranslateKit*>(kit_ptr);
}

TRANSLATE_KIT_EXPORT bool TranslateKitSetLanguagePackages(
    uintptr_t kit_ptr,
    TranslateKitSetLanguagePackagesArgs args) {
  CHECK(kit_ptr);

  TranslateKitLanguagePackageConfig config;
  if (!config.ParseFromArray(args.package_config, args.package_config_size)) {
    return false;
  }
  reinterpret_cast<FakeTranslateKit*>(kit_ptr)->SetConfig(std::move(config));
  return true;
}

TRANSLATE_KIT_EXPORT uintptr_t
TranslateKitCreateTranslator(uintptr_t kit_ptr,
                             TranslateKitLanguage source_lang,
                             TranslateKitLanguage target_lang) {
  CHECK(kit_ptr);
  if (std::string_view(source_lang.language_code,
                       source_lang.language_code_size) == "crash") {
    LOG(ERROR) << "Intentionally terminating current process to simulate"
                  " the on device translation service crash for testing.";
    // Use `TerminateCurrentProcessImmediately()` instead of `CHECK()` to avoid
    // 'Fatal error' dialog on Windows debug.
    base::Process::TerminateCurrentProcessImmediately(1);
  }
  auto translator =
      reinterpret_cast<FakeTranslateKit*>(kit_ptr)->MaybeCreateTranslator(
          std::string_view(source_lang.language_code,
                           source_lang.language_code_size),
          std::string_view(target_lang.language_code,
                           target_lang.language_code_size));
  if (translator) {
    return reinterpret_cast<uintptr_t>(translator.release());
  }
  return 0;
}

TRANSLATE_KIT_EXPORT void DeleteTranslator(uintptr_t translator_ptr) {
  CHECK(translator_ptr);
  delete reinterpret_cast<FakeTranslator*>(translator_ptr);
}

typedef void (*TranslateCallbackFn)(TranslateKitOutputText, std::uintptr_t);
DISABLE_CFI_DLSYM TRANSLATE_KIT_EXPORT bool TranslatorTranslate(
    uintptr_t translator_ptr,
    TranslateKitInputText input,
    TranslateCallbackFn callback,
    std::uintptr_t user_data) {
  CHECK(translator_ptr);

  std::string_view input_string(input.input_text, input.input_text_size);
  if (input_string == "SIMULATE_ERROR") {
    return false;
  }

  if (input_string == "CAUSE_CRASH") {
    LOG(ERROR) << "Intentionally terminating current process to simulate"
                  " the on device translation service crash for testing.";
    // Use `TerminateCurrentProcessImmediately()` instead of `CHECK()` to avoid
    // 'Fatal error' dialog on Windows debug.
    base::Process::TerminateCurrentProcessImmediately(1);
  }

  if (input_string == "CHECK_NOT_EXIST_FILE") {
    const std::string not_exsit_file_name = base::StrCat(
        {reinterpret_cast<FakeTranslator*>(translator_ptr)->package_path(),
         "/not_exist_file"});
    std::unique_ptr<FakeReadOnlyMemoryMap> data =
        FakeReadOnlyMemoryMap::MaybeCreate(not_exsit_file_name);
    bool is_directory = false;
    bool file_exists = FileExists(not_exsit_file_name, &is_directory);
    const std::string result = base::StrCat({
        "Result of Open(): ",
        data ? "OK" : "Failed",
        ", result of FileExists(): ",
        base::ToString(file_exists),
        ", is_directory: ",
        base::ToString(is_directory),
    });
    callback(TranslateKitOutputText(result.data(), result.size()), user_data);
    return true;
  }
  const auto output = reinterpret_cast<FakeTranslator*>(translator_ptr)
                          ->Translate(input_string);
  // Just pass the input text.
  callback(TranslateKitOutputText(output.data(), output.size()), user_data);
  return true;
}

}  // extern C