File: messaging_util_unittest.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 (311 lines) | stat: -rw-r--r-- 11,425 bytes parent folder | download | duplicates (6)
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
// Copyright 2017 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "extensions/renderer/api/messaging/messaging_util.h"

#include <array>
#include <memory>
#include <string>
#include <string_view>

#include "base/strings/stringprintf.h"
#include "extensions/common/api/messaging/message.h"
#include "extensions/common/api/messaging/messaging_endpoint.h"
#include "extensions/common/extension_builder.h"
#include "extensions/common/mojom/context_type.mojom.h"
#include "extensions/common/mojom/message_port.mojom-shared.h"
#include "extensions/renderer/bindings/api_binding_test.h"
#include "extensions/renderer/bindings/api_binding_test_util.h"
#include "extensions/renderer/native_extension_bindings_system_test_base.h"
#include "extensions/renderer/script_context.h"
#include "gin/converter.h"
#include "v8/include/v8.h"

namespace extensions {

namespace {

struct TestCase {
  v8::Local<v8::Value> passed_id;
  std::string_view expected_id;
  bool should_pass;
};

}  // anonymous namespace

using MessagingUtilTest = APIBindingTest;

TEST_F(MessagingUtilTest, TestMaximumMessageSize) {
  v8::HandleScope handle_scope(isolate());
  v8::Local<v8::Context> context = MainContext();

  constexpr char kMessageTooLongError[] =
      "Message length exceeded maximum allowed length.";

  v8::Local<v8::Value> long_message =
      V8ValueFromScriptSource(context, "'a'.repeat(1024 *1024 * 65)");
  std::string error;
  std::unique_ptr<Message> message = messaging_util::MessageFromV8(
      context, long_message, mojom::SerializationFormat::kJson, &error);
  EXPECT_FALSE(message);
  EXPECT_EQ(kMessageTooLongError, error);
}

TEST_F(MessagingUtilTest, TestParseMessageOptionsFrameId) {
  v8::HandleScope handle_scope(isolate());
  v8::Local<v8::Context> context = MainContext();

  static constexpr struct {
    int expected_frame_id;
    const char* string_options;
  } test_cases[] = {
      {messaging_util::kNoFrameId, "({})"},
      {messaging_util::kNoFrameId, "({frameId: undefined})"},
      // Note: we don't test null here, because the argument parsing code
      // ensures we would never pass undefined to ParseMessageOptions (and
      // there's a DCHECK to validate it). The null case is tested in the tabs'
      // API hooks delegate test.
      {0, "({frameId: 0})"},
      {2, "({frameId: 2})"},
  };

  for (const auto& test_case : test_cases) {
    SCOPED_TRACE(test_case.string_options);
    v8::Local<v8::Value> value =
        V8ValueFromScriptSource(context, test_case.string_options);
    ASSERT_FALSE(value.IsEmpty());
    ASSERT_TRUE(value->IsObject());
    messaging_util::MessageOptions options =
        messaging_util::ParseMessageOptions(context, value.As<v8::Object>(),
                                            messaging_util::PARSE_FRAME_ID);
    EXPECT_EQ(test_case.expected_frame_id, options.frame_id);
  }
}

// Tests the result of GetEventForChannel().
TEST_F(MessagingUtilTest, TestGetEventForChannel) {
  ExtensionId id1('a', 32);
  ExtensionId id2('b', 32);

  // Exercise a bunch of possible channel endpoints -> extensions.
  // This technically isn't exhaustive, but should give us pretty reasonable
  // coverage.

  // sendRequest, Extension -> Self
  {
    EXPECT_EQ(messaging_util::kOnRequestEvent,
              messaging_util::GetEventForChannel(
                  MessagingEndpoint::ForExtension(id1), id1,
                  mojom::ChannelType::kSendRequest));
  }

  // sendRequest, Extension 2 -> Extension 1
  {
    EXPECT_EQ(messaging_util::kOnRequestExternalEvent,
              messaging_util::GetEventForChannel(
                  MessagingEndpoint::ForExtension(id2), id1,
                  mojom::ChannelType::kSendRequest));
  }

  // sendMessage, Extension -> Self
  {
    EXPECT_EQ(messaging_util::kOnMessageEvent,
              messaging_util::GetEventForChannel(
                  MessagingEndpoint::ForExtension(id1), id1,
                  mojom::ChannelType::kSendMessage));
  }

  // sendMessage, Extension 2 -> Extension 1
  {
    EXPECT_EQ(messaging_util::kOnMessageExternalEvent,
              messaging_util::GetEventForChannel(
                  MessagingEndpoint::ForExtension(id2), id1,
                  mojom::ChannelType::kSendMessage));
  }

  // sendMessage, Web Page -> Extension
  {
    EXPECT_EQ(
        messaging_util::kOnMessageExternalEvent,
        messaging_util::GetEventForChannel(MessagingEndpoint::ForWebPage(), id1,
                                           mojom::ChannelType::kSendMessage));
  }

  // sendMessage, Content Script -> Extension
  {
    EXPECT_EQ(messaging_util::kOnMessageEvent,
              messaging_util::GetEventForChannel(
                  MessagingEndpoint::ForContentScript(id1), id1,
                  mojom::ChannelType::kSendMessage));
  }

  // sendMessage, User Script -> Extension
  {
    EXPECT_EQ(messaging_util::kOnUserScriptMessageEvent,
              messaging_util::GetEventForChannel(
                  MessagingEndpoint::ForUserScript(id1), id1,
                  mojom::ChannelType::kSendMessage));
  }

  // connect, Extension -> Self
  {
    EXPECT_EQ(
        messaging_util::kOnConnectEvent,
        messaging_util::GetEventForChannel(MessagingEndpoint::ForExtension(id1),
                                           id1, mojom::ChannelType::kConnect));
  }

  // connect, Extension 2 -> Extension 1
  {
    EXPECT_EQ(
        messaging_util::kOnConnectExternalEvent,
        messaging_util::GetEventForChannel(MessagingEndpoint::ForExtension(id2),
                                           id1, mojom::ChannelType::kConnect));
  }

  // connect, Web Page -> Extension
  {
    EXPECT_EQ(
        messaging_util::kOnConnectExternalEvent,
        messaging_util::GetEventForChannel(MessagingEndpoint::ForWebPage(), id1,
                                           mojom::ChannelType::kConnect));
  }

  // connect, Content Script -> Extension
  {
    EXPECT_EQ(messaging_util::kOnConnectEvent,
              messaging_util::GetEventForChannel(
                  MessagingEndpoint::ForContentScript(id1), id1,
                  mojom::ChannelType::kConnect));
  }

  // connect, User Script -> Extension
  {
    EXPECT_EQ(messaging_util::kOnUserScriptConnectEvent,
              messaging_util::GetEventForChannel(
                  MessagingEndpoint::ForUserScript(id1), id1,
                  mojom::ChannelType::kConnect));
  }

  // connect, Native App -> Extension
  {
    EXPECT_EQ(messaging_util::kOnConnectNativeEvent,
              messaging_util::GetEventForChannel(
                  MessagingEndpoint::ForNativeApp("some app"), id1,
                  mojom::ChannelType::kNative));
  }
}

using MessagingUtilWithSystemTest = NativeExtensionBindingsSystemUnittest;

TEST_F(MessagingUtilWithSystemTest, TestGetTargetIdFromExtensionContext) {
  v8::HandleScope handle_scope(isolate());
  v8::Local<v8::Context> context = MainContext();

  scoped_refptr<const Extension> extension = ExtensionBuilder("foo").Build();
  RegisterExtension(extension);

  ScriptContext* script_context = CreateScriptContext(
      context, extension.get(), mojom::ContextType::kPrivilegedExtension);
  script_context->set_url(extension->url());

  std::string other_id(32, 'a');
  const auto test_cases = std::to_array<TestCase>({
      // If the extension ID is not provided, the bindings use the calling
      // extension's.
      {v8::Null(isolate()), extension->id(), true},
      // We treat the empty string to be the same as null, even though it's
      // somewhat unfortunate.
      // See https://crbug.com/823577.
      {gin::StringToV8(isolate(), ""), extension->id(), true},
      {gin::StringToV8(isolate(), extension->id()), extension->id(), true},
      {gin::StringToV8(isolate(), other_id), other_id, true},
      {gin::StringToV8(isolate(), "invalid id"), std::string_view(), false},
  });

  for (size_t i = 0; i < std::size(test_cases); ++i) {
    SCOPED_TRACE(base::StringPrintf("Test Case: %d", static_cast<int>(i)));
    const auto& test_case = test_cases[i];
    std::string target;
    std::string error;
    EXPECT_EQ(test_case.should_pass,
              messaging_util::GetTargetExtensionId(
                  script_context, test_case.passed_id, "runtime.sendMessage",
                  &target, &error));
    EXPECT_EQ(test_case.expected_id, target);
    EXPECT_EQ(test_case.should_pass, error.empty()) << error;
  }
}

TEST_F(MessagingUtilWithSystemTest, TestGetTargetIdFromWebContext) {
  v8::HandleScope handle_scope(isolate());
  v8::Local<v8::Context> context = MainContext();

  ScriptContext* script_context =
      CreateScriptContext(context, nullptr, mojom::ContextType::kWebPage);
  script_context->set_url(GURL("https://example.com"));

  std::string other_id(32, 'a');
  const auto test_cases = std::to_array<TestCase>({
      // A web page should always have to specify the extension id.
      {gin::StringToV8(isolate(), other_id), other_id, true},
      {v8::Null(isolate()), std::string_view(), false},
      {gin::StringToV8(isolate(), ""), std::string_view(), false},
      {gin::StringToV8(isolate(), "invalid id"), std::string_view(), false},
  });

  for (size_t i = 0; i < std::size(test_cases); ++i) {
    SCOPED_TRACE(base::StringPrintf("Test Case: %d", static_cast<int>(i)));
    const auto& test_case = test_cases[i];
    std::string target;
    std::string error;
    EXPECT_EQ(test_case.should_pass,
              messaging_util::GetTargetExtensionId(
                  script_context, test_case.passed_id, "runtime.sendMessage",
                  &target, &error));
    EXPECT_EQ(test_case.expected_id, target);
    EXPECT_EQ(test_case.should_pass, error.empty()) << error;
  }
}

TEST_F(MessagingUtilWithSystemTest, TestGetTargetIdFromUserScriptContext) {
  v8::HandleScope handle_scope(isolate());
  v8::Local<v8::Context> context = MainContext();

  scoped_refptr<const Extension> extension = ExtensionBuilder("foo").Build();
  RegisterExtension(extension);

  ScriptContext* script_context = CreateScriptContext(
      context, extension.get(), mojom::ContextType::kUserScript);
  script_context->set_url(extension->url());

  std::string other_id(32, 'a');
  const auto test_cases = std::to_array<TestCase>({
      // If the extension ID is not provided, the bindings use the calling
      // extension's.
      {v8::Null(isolate()), extension->id(), true},
      // We treat the empty string to be the same as null, even though it's
      // somewhat unfortunate.
      // See https://crbug.com/823577.
      {gin::StringToV8(isolate(), ""), extension->id(), true},
      {gin::StringToV8(isolate(), extension->id()), extension->id(), true},
      // User scripts may not target other extensions.
      {gin::StringToV8(isolate(), other_id), std::string_view(), false},
  });

  for (size_t i = 0; i < std::size(test_cases); ++i) {
    SCOPED_TRACE(base::StringPrintf("Test Case: %d", static_cast<int>(i)));
    const auto& test_case = test_cases[i];
    std::string target;
    std::string error;
    EXPECT_EQ(test_case.should_pass,
              messaging_util::GetTargetExtensionId(
                  script_context, test_case.passed_id, "runtime.sendMessage",
                  &target, &error));
    EXPECT_EQ(test_case.expected_id, target);
    EXPECT_EQ(test_case.should_pass, error.empty()) << error;
  }
}

}  // namespace extensions