File: dom_message_observer.h

package info (click to toggle)
chromium 138.0.7204.157-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 6,071,864 kB
  • sloc: cpp: 34,936,859; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,967; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (66 lines) | stat: -rw-r--r-- 2,116 bytes parent folder | download | duplicates (3)
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
// 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.

#ifndef CHROME_TEST_INTERACTION_DOM_MESSAGE_OBSERVER_H_
#define CHROME_TEST_INTERACTION_DOM_MESSAGE_OBSERVER_H_

#include <string>
#include <vector>

#include "content/public/test/browser_test_utils.h"
#include "ui/base/interaction/element_identifier.h"
#include "ui/base/interaction/state_observer.h"

// Base class that uses a DOMMessageQueue to observe messages coming from an
// instrumented web page. The page must already be instrumented.
class DomMessageObserverBase {
 public:
  // This will hard-fail if `instrumented_webcontents` isn't actually an
  // instrumented WebContents.
  explicit DomMessageObserverBase(
      ui::ElementIdentifier instrumented_webcontents);

 protected:
  virtual void OnMessageReceived(const std::string& message) = 0;

 private:
  void AddCallback();
  void OnMessageAvailable();

  content::DOMMessageQueue queue_;
};

// Observes DOM messages emitted by `instrumented_webcontents`; the reported
// state is the most recent message.
class LatestDomMessageObserver : DomMessageObserverBase,
                                 public ui::test::StateObserver<std::string> {
 public:
  explicit LatestDomMessageObserver(
      ui::ElementIdentifier instrumented_webcontents);
  ~LatestDomMessageObserver() override;

 protected:
  // DomMessageObserverBase:
  void OnMessageReceived(const std::string& message) override;
};

// Observes DOM messages emitted by `instrumented_webcontents`; the reported
// state is the ordered list of all messages received.
class DomMessageHistoryObserver
    : DomMessageObserverBase,
      ui::test::StateObserver<std::vector<std::string>> {
 public:
  explicit DomMessageHistoryObserver(
      ui::ElementIdentifier instrumented_webcontents);
  ~DomMessageHistoryObserver() override;

 protected:
  // DomMessageObserverBase:
  void OnMessageReceived(const std::string& message) override;

 private:
  std::vector<std::string> messages_;
};

#endif  // CHROME_TEST_INTERACTION_DOM_MESSAGE_OBSERVER_H_