File: frame_host_interceptor.h

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 (69 lines) | stat: -rw-r--r-- 2,672 bytes parent folder | download | duplicates (7)
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
// 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.

#ifndef CONTENT_TEST_FRAME_HOST_INTERCEPTOR_H_
#define CONTENT_TEST_FRAME_HOST_INTERCEPTOR_H_

#include <map>
#include <memory>

#include "content/common/frame.mojom.h"
#include "content/public/browser/web_contents_observer.h"
#include "mojo/public/cpp/bindings/pending_associated_remote.h"
#include "mojo/public/cpp/bindings/pending_remote.h"
#include "third_party/blink/public/mojom/navigation/navigation_params.mojom-forward.h"

namespace content {

class RenderFrameHost;

// Allows intercepting calls to mojom::FrameHost (e.g. BeginNavigation) just
// before they are dispatched to the implementation. This enables unit/browser
// tests to scrutinize/alter the parameters, or simulate race conditions by
// triggering other calls just before dispatching the original call.
//
// NOTE: DidCommitProvisionalLoad is handled separately, because it is in a
// transient state right now, and is soon going away from mojom::FrameHost.
class FrameHostInterceptor : public WebContentsObserver {
 public:
  // Constructs an instance that will intercept FrameHost calls in any frame of
  // the |web_contents| while the instance is in scope.
  explicit FrameHostInterceptor(WebContents* web_contents);

  FrameHostInterceptor(const FrameHostInterceptor&) = delete;
  FrameHostInterceptor& operator=(const FrameHostInterceptor&) = delete;

  ~FrameHostInterceptor() override;

  // Called just before BeginNavigation IPC would be dispatched to
  // |render_frame_host|.
  //
  // Return false to cancel the dispatching of this message.
  //
  // Return true (and/or modify args as needed) to dispatch this message to the
  // original implementation.
  //
  // By default this method returns true (e.g. doesn't do anything to the
  // original messages and just forwards them to the original implementation).
  virtual bool WillDispatchBeginNavigation(
      RenderFrameHost* render_frame_host,
      blink::mojom::CommonNavigationParamsPtr* common_params,
      blink::mojom::BeginNavigationParamsPtr* begin_params,
      mojo::PendingRemote<blink::mojom::BlobURLToken>* blob_url_token,
      mojo::PendingAssociatedRemote<mojom::NavigationClient>*
          navigation_client);

 private:
  class FrameAgent;

  // WebContentsObserver:
  void RenderFrameCreated(RenderFrameHost* render_frame_host) override;
  void RenderFrameDeleted(RenderFrameHost* render_frame_host) override;

  std::map<RenderFrameHost*, std::unique_ptr<FrameAgent>> frame_agents_;
};

}  // namespace content

#endif  // CONTENT_TEST_FRAME_HOST_INTERCEPTOR_H_