File: form_fetch_batcher.mm

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; 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 (137 lines) | stat: -rw-r--r-- 4,896 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
// 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.

#import "components/autofill/ios/browser/form_fetch_batcher.h"

#import <algorithm>

#import "base/functional/bind.h"
#import "base/memory/weak_ptr.h"
#import "base/metrics/histogram_functions.h"
#import "base/not_fatal_until.h"
#import "base/task/task_runner.h"
#import "base/time/time.h"
#import "components/autofill/core/common/form_data.h"
#import "components/autofill/ios/browser/autofill_driver_ios_bridge.h"
#import "ios/web/public/js_messaging/web_frame.h"

namespace autofill {

namespace {
// Filters the `forms` by `form_name`. No op if `form_name` is nullopt.
// This filter is the equivalent of the form name filter
// in autofill:ExtractFormData(). Will still filter if the `form_name` string is
// empty as long as it is not nullopt.
std::optional<std::vector<FormData>> ApplyFormFilterIfNeeded(
    std::optional<std::u16string> form_name,
    std::optional<std::vector<FormData>> forms) {
  if (!forms || !form_name) {
    return forms;
  }

  std::vector<FormData> filtered_forms;
  std::ranges::copy_if(
      *forms, std::back_inserter(filtered_forms),
      [&](const std::u16string& name) { return name == *form_name; },
      &FormData::name);
  return filtered_forms;
}
}  // namespace

FormFetchBatcher::FormFetchBatcher(id<AutofillDriverIOSBridge> bridge,
                                   base::WeakPtr<web::WebFrame> frame,
                                   base::TimeDelta batch_period)
    : bridge_(bridge), frame_(frame), batch_period_(batch_period) {}

FormFetchBatcher::~FormFetchBatcher() = default;

void FormFetchBatcher::PushRequestAndRun(
    FormFetchCompletion&& completion,
    std::optional<std::u16string> form_name_filter) {
  fetch_requests_.emplace_back(
      base::BindOnce(&ApplyFormFilterIfNeeded, std::move(form_name_filter))
          .Then(std::move(completion)));

  // Cancel the current task by invalidating the weak pointer of the scheduled
  // callback.
  weak_factory_.InvalidateWeakPtrs();

  batch_scheduled_ = true;

  // Run the batch immediately.
  Run();
}

void FormFetchBatcher::PushRequest(
    FormFetchCompletion&& completion,
    std::optional<std::u16string> form_name_filter) {
  fetch_requests_.emplace_back(
      base::BindOnce(&ApplyFormFilterIfNeeded, std::move(form_name_filter))
          .Then(std::move(completion)));

  if (!batch_scheduled_) {
    batch_scheduled_ = true;
    base::SequencedTaskRunner::GetCurrentDefault()->PostDelayedTask(
        FROM_HERE,
        base::BindOnce(&FormFetchBatcher::Run, weak_factory_.GetWeakPtr()),
        batch_period_);
  }
}

void FormFetchBatcher::Run() {
  // There should be at least one fetch request in the batch when running it.
  CHECK_GT(fetch_requests_.size(), 0u);
  // Running the batch should only be done when there was an actual batch
  // scheduled.
  CHECK(batch_scheduled_);

  if (frame_) {
    auto completion =
        base::BindOnce(&FormFetchBatcher::Complete, weak_factory_.GetWeakPtr());
    [bridge_ fetchFormsFiltered:NO
                       withName:u""
                        inFrame:frame_.get()
              completionHandler:std::move(completion)];
  } else {
    // If the frame disappeared when we're about to run the batch, complete
    // immediately.
    Complete(std::nullopt);
  }
}

void FormFetchBatcher::Complete(
    std::optional<std::vector<autofill::FormData>> forms) {
  // Complete() should only be done when there are queued requests.
  CHECK_GT(fetch_requests_.size(), 0u);
  // Completing the batch should only be done when there was an actual batch
  // scheduled.
  CHECK(batch_scheduled_);

  base::UmaHistogramCounts100("Autofill.iOS.FormExtraction.ForScan.BatchSize",
                              fetch_requests_.size());

  // The batch is being completed so a new batch can be scheduled starting from
  // now which includes new requests pushed by the completion blocks that are
  // about to be completed here.
  batch_scheduled_ = false;

  // Make a local copy of the queue of completion blocks so the vector cannot
  // be resized if one of the callback pushes a new request in the
  // `fetch_requests_` queue. Resizing the vector will invalidate the iteration
  // loop. Any new requests that were pushed when emptying the loop will be
  // pushed to the next scheduled batch. A new batch will be scheduled if
  // needed.
  std::vector<FormFetchCompletion> fetch_requests_copy =
      std::move(fetch_requests_);
  fetch_requests_ = std::vector<FormFetchCompletion>();

  // Complete the original requests. New requests may be pushed to
  // fetch_requests_ when completing the blocks here but this won't affect this
  // loop.
  for (auto& fetch_request : fetch_requests_copy) {
    std::move(fetch_request).Run(forms);
  }
}

}  // namespace autofill