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 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
|
// Copyright 2018 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "ash/assistant/test/test_assistant_service.h"
#include <memory>
#include <utility>
#include <vector>
#include "base/task/sequenced_task_runner.h"
#include "base/time/time.h"
#include "base/unguessable_token.h"
#include "chromeos/ash/services/assistant/public/cpp/assistant_service.h"
#include "mojo/public/cpp/bindings/pending_receiver.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace ash {
using assistant::AssistantInteractionMetadata;
using assistant::AssistantInteractionResolution;
using assistant::AssistantInteractionSubscriber;
using assistant::AssistantInteractionType;
using assistant::AssistantSuggestion;
// Subscriber that will ensure the LibAssistant contract is enforced.
// More specifically, it will ensure that:
// - A conversation is finished before starting a new one.
// - No responses (text, card, ...) are sent before starting or after
// finishing an interaction.
class LibassistantContractChecker : public AssistantInteractionSubscriber {
public:
LibassistantContractChecker() = default;
LibassistantContractChecker(const LibassistantContractChecker&) = delete;
LibassistantContractChecker& operator=(const LibassistantContractChecker&) =
delete;
~LibassistantContractChecker() override = default;
// DefaultAssistantInteractionSubscriber implementation:
void OnInteractionStarted(
const AssistantInteractionMetadata& metadata) override {
if (current_state_ == ConversationState::kInProgress) {
ADD_FAILURE()
<< "Cannot start a new Assistant interaction without finishing the "
"previous interaction first.";
}
current_state_ = ConversationState::kInProgress;
}
void OnInteractionFinished(
AssistantInteractionResolution resolution) override {
// Note: We do not check |current_state_| here as this method can be called
// even if no interaction is in progress.
current_state_ = ConversationState::kFinished;
}
void OnHtmlResponse(const std::string& response,
const std::string& fallback) override {
CheckResponse();
}
void OnSuggestionsResponse(
const std::vector<assistant::AssistantSuggestion>& response) override {
CheckResponse();
}
void OnTextResponse(const std::string& response) override { CheckResponse(); }
void OnOpenUrlResponse(const ::GURL& url, bool in_background) override {
CheckResponse();
}
void OnOpenAppResponse(const assistant::AndroidAppInfo& app_info) override {
CheckResponse();
}
private:
void CheckResponse() {
if (current_state_ == ConversationState::kNotStarted)
ADD_FAILURE() << "Cannot send a response before starting an interaction.";
if (current_state_ == ConversationState::kFinished) {
ADD_FAILURE()
<< "Cannot send a response after finishing the interaction.";
}
}
enum class ConversationState {
kNotStarted,
kInProgress,
kFinished,
};
ConversationState current_state_ = ConversationState::kNotStarted;
};
// Subscriber that tracks the current interaction.
class CurrentInteractionSubscriber : public AssistantInteractionSubscriber {
public:
CurrentInteractionSubscriber() = default;
CurrentInteractionSubscriber(CurrentInteractionSubscriber&) = delete;
CurrentInteractionSubscriber& operator=(CurrentInteractionSubscriber&) =
delete;
~CurrentInteractionSubscriber() override = default;
// AssistantInteractionSubscriber implementation:
void OnInteractionStarted(
const AssistantInteractionMetadata& metadata) override {
current_interaction_ = metadata;
}
void OnInteractionFinished(
AssistantInteractionResolution resolution) override {
current_interaction_ = std::nullopt;
}
std::optional<AssistantInteractionMetadata> current_interaction() {
return current_interaction_;
}
private:
std::optional<AssistantInteractionMetadata> current_interaction_ =
std::nullopt;
};
class InteractionResponse::Response {
public:
Response() = default;
virtual ~Response() = default;
virtual void SendTo(AssistantInteractionSubscriber* receiver) = 0;
};
class TextResponse : public InteractionResponse::Response {
public:
explicit TextResponse(const std::string& text) : text_(text) {}
TextResponse(const TextResponse&) = delete;
TextResponse& operator=(const TextResponse&) = delete;
~TextResponse() override = default;
void SendTo(AssistantInteractionSubscriber* receiver) override {
receiver->OnTextResponse(text_);
}
private:
std::string text_;
};
class SuggestionsResponse : public InteractionResponse::Response {
public:
explicit SuggestionsResponse(const std::string& text) : text_(text) {}
SuggestionsResponse(const SuggestionsResponse&) = delete;
SuggestionsResponse& operator=(const SuggestionsResponse&) = delete;
~SuggestionsResponse() override = default;
void SendTo(AssistantInteractionSubscriber* receiver) override {
std::vector<AssistantSuggestion> suggestions;
suggestions.emplace_back();
auto& suggestion = suggestions.back();
suggestion.text = text_;
suggestion.id = base::UnguessableToken::Create();
receiver->OnSuggestionsResponse(suggestions);
}
private:
std::string text_;
};
class ResolutionResponse : public InteractionResponse::Response {
public:
using Resolution = InteractionResponse::Resolution;
explicit ResolutionResponse(Resolution resolution)
: resolution_(resolution) {}
ResolutionResponse(const ResolutionResponse&) = delete;
ResolutionResponse& operator=(const ResolutionResponse&) = delete;
~ResolutionResponse() override = default;
void SendTo(AssistantInteractionSubscriber* receiver) override {
receiver->OnInteractionFinished(resolution_);
}
private:
Resolution resolution_;
};
TestAssistantService::TestAssistantService()
: libassistant_contract_checker_(
std::make_unique<LibassistantContractChecker>()),
current_interaction_subscriber_(
std::make_unique<CurrentInteractionSubscriber>()) {
AddAssistantInteractionSubscriber(libassistant_contract_checker_.get());
AddAssistantInteractionSubscriber(current_interaction_subscriber_.get());
}
TestAssistantService::~TestAssistantService() = default;
void TestAssistantService::SetInteractionResponse(
std::unique_ptr<InteractionResponse> response) {
interaction_response_ = std::move(response);
}
std::optional<AssistantInteractionMetadata>
TestAssistantService::current_interaction() {
return current_interaction_subscriber_->current_interaction();
}
void TestAssistantService::StartEditReminderInteraction(
const std::string& client_id) {}
void TestAssistantService::StartTextInteraction(
const std::string& query,
assistant::AssistantQuerySource source,
bool allow_tts) {
StartInteraction(AssistantInteractionType::kText, source, query);
}
void TestAssistantService::StartVoiceInteraction() {
StartInteraction(AssistantInteractionType::kVoice);
}
void TestAssistantService::StopActiveInteraction(bool cancel_conversation) {
if (!running_active_interaction_)
return;
running_active_interaction_ = false;
for (auto& subscriber : interaction_subscribers_) {
subscriber.OnInteractionFinished(
AssistantInteractionResolution::kInterruption);
}
}
void TestAssistantService::AddAssistantInteractionSubscriber(
AssistantInteractionSubscriber* subscriber) {
interaction_subscribers_.AddObserver(subscriber);
}
void TestAssistantService::RemoveAssistantInteractionSubscriber(
AssistantInteractionSubscriber* subscriber) {
interaction_subscribers_.RemoveObserver(subscriber);
}
mojo::PendingReceiver<libassistant::mojom::NotificationDelegate>
TestAssistantService::GetPendingNotificationDelegate() {
return mojo::PendingReceiver<libassistant::mojom::NotificationDelegate>();
}
void TestAssistantService::RetrieveNotification(
const assistant::AssistantNotification& notification,
int action_index) {}
void TestAssistantService::DismissNotification(
const assistant::AssistantNotification& notification) {}
void TestAssistantService::OnAccessibilityStatusChanged(
bool spoken_feedback_enabled) {}
void TestAssistantService::OnColorModeChanged(bool dark_mode_enabled) {
dark_mode_enabled_ = dark_mode_enabled;
}
void TestAssistantService::SendAssistantFeedback(
const assistant::AssistantFeedback& feedback) {}
void TestAssistantService::AddTimeToTimer(const std::string& id,
base::TimeDelta duration) {}
void TestAssistantService::PauseTimer(const std::string& id) {}
void TestAssistantService::RemoveAlarmOrTimer(const std::string& id) {}
void TestAssistantService::ResumeTimer(const std::string& id) {}
void TestAssistantService::StartInteraction(
assistant::AssistantInteractionType type,
assistant::AssistantQuerySource source,
const std::string& query) {
if (running_active_interaction_) {
StopActiveInteraction(/*cancel_conversation=*/false);
}
// Pretend to respond asynchronously.
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE,
base::BindOnce(&TestAssistantService::InteractionStarted,
weak_factory_.GetWeakPtr(), type, source, query));
}
void TestAssistantService::InteractionStarted(
assistant::AssistantInteractionType type,
assistant::AssistantQuerySource source,
const std::string& query) {
DCHECK(!running_active_interaction_);
AssistantInteractionMetadata metadata{type, source, query};
for (auto& subscriber : interaction_subscribers_) {
subscriber.OnInteractionStarted(metadata);
}
running_active_interaction_ = true;
if (interaction_response_)
SendInteractionResponse();
}
void TestAssistantService::SendInteractionResponse() {
DCHECK(interaction_response_);
DCHECK(running_active_interaction_);
for (auto& subscriber : interaction_subscribers_)
interaction_response_->SendTo(&subscriber);
DCHECK(!current_interaction());
interaction_response_.reset();
running_active_interaction_ = false;
}
InteractionResponse::InteractionResponse() = default;
InteractionResponse::~InteractionResponse() = default;
InteractionResponse* InteractionResponse::AddTextResponse(
const std::string& text) {
AddResponse(std::make_unique<TextResponse>(text));
return this;
}
InteractionResponse* InteractionResponse::AddSuggestionChip(
const std::string& text) {
AddResponse(std::make_unique<SuggestionsResponse>(text));
return this;
}
InteractionResponse* InteractionResponse::AddResolution(Resolution resolution) {
AddResponse(std::make_unique<ResolutionResponse>(resolution));
return this;
}
void InteractionResponse::AddResponse(std::unique_ptr<Response> response) {
responses_.push_back(std::move(response));
}
void InteractionResponse::SendTo(AssistantInteractionSubscriber* receiver) {
for (auto& response : responses_)
response->SendTo(receiver);
}
} // namespace ash
|