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
|
// 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 COMPONENTS_LENS_LENS_OVERLAY_REQUEST_ID_GENERATOR_H_
#define COMPONENTS_LENS_LENS_OVERLAY_REQUEST_ID_GENERATOR_H_
#include <optional>
#include "third_party/lens_server_proto/lens_overlay_routing_info.pb.h"
#include "third_party/lens_server_proto/lens_overlay_server.pb.h"
#include "third_party/lens_server_proto/lens_overlay_service_deps.pb.h"
namespace lens {
class TestLensOverlayQueryController;
// The update modes for the request id generator.
enum class RequestIdUpdateMode {
// Indicates that the request should be modified for the initial set of
// requests, e.e. incrementing the sequence id, image sequence id, and long
// context id.
kInitialRequest = 0,
// Indicates that the request id should be modified for a full image request,
// i.e. incrementing the image sequence, sequence id, and creating a new
// analytics id.
kFullImageRequest = 1,
// Indicates that the request id should be modified for a page content
// request, i.e. incrementing the sequence id and creating a new analytics
// id.
kPageContentRequest = 2,
// Indicates that the request id should be modified for a partial page content
// request, i.e. incrementing the sequence id and creating a new analytics
// id.
kPartialPageContentRequest = 3,
// Indicates that the request id should be modified for an interaction
// request, i.e. incrementing the sequence id and creating a new analytics
// id.
kInteractionRequest = 4,
// Indicates that the request id should be modified for a search url.
// i.e. just incrementing the sequence id.
kSearchUrl = 5,
// Indicates that the request id should be modified for opening in a new tab.
// i.e. just creating a new analytics id, but not storing it for future
// updates.
kOpenInNewTab = 6,
};
// Manages creating lens overlay request IDs. Owned by a single Lens overlay
// query controller.
class LensOverlayRequestIdGenerator {
public:
LensOverlayRequestIdGenerator();
~LensOverlayRequestIdGenerator();
// Resets the request id generator, creating a new uuid and resetting the
// sequence.
void ResetRequestId();
// Updates the request id based on the given update mode and returns the
// request id proto.
std::unique_ptr<lens::LensOverlayRequestId> GetNextRequestId(
RequestIdUpdateMode update_mode);
// Returns the current analytics id as a base32 encoded string.
std::string GetBase32EncodedAnalyticsId();
// Sets the routing info to be included in the request id and returns the new
// request id with this routing info.
std::unique_ptr<lens::LensOverlayRequestId> SetRoutingInfo(
lens::LensOverlayRoutingInfo routing_info);
bool HasRoutingInfo() { return routing_info_.has_value(); }
protected:
friend class TestLensOverlayQueryController;
// Returns the request id of the current requests stored in the request id
// generator.
std::unique_ptr<lens::LensOverlayRequestId> GetCurrentRequestIdForTesting() {
return GetCurrentRequestId();
}
private:
// Returns the request id of the current requests stored in the request id
// generator.
std::unique_ptr<lens::LensOverlayRequestId> GetCurrentRequestId();
// The current uuid. Valid for the duration of a Lens overlay session.
uint64_t uuid_;
// The analytics id for the current request. Will be updated on each
// query.
std::string analytics_id_;
// The current sequence id.
int sequence_id_;
// The current image sequence id.
int image_sequence_id_;
// The current long context id.
int long_context_id_;
// The current routing info. Not guaranteed to exist if not returned from the
// server.
std::optional<lens::LensOverlayRoutingInfo> routing_info_;
};
} // namespace lens
#endif // COMPONENTS_LENS_LENS_OVERLAY_REQUEST_ID_GENERATOR_H_
|
