components/autofill_assistant/browser/protocol_utils.h

// Copyright 2018 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_AUTOFILL_ASSISTANT_BROWSER_PROTOCOL_UTILS_H_
#define COMPONENTS_AUTOFILL_ASSISTANT_BROWSER_PROTOCOL_UTILS_H_

#include <deque>
#include <map>
#include <memory>
#include <string>
#include <vector>

#include "components/autofill_assistant/browser/actions/action.h"
#include "components/autofill_assistant/browser/script.h"
#include "components/autofill_assistant/browser/service.pb.h"

class GURL;

namespace autofill_assistant {
// Autofill assistant protocol related convenient utils.
class ProtocolUtils {
 public:
  // Create getting autofill assistant scripts request for the given
  // |url|.
  static std::string CreateGetScriptsRequest(
      const GURL& url,
      const std::map<std::string, std::string>& parameters,
      const ClientContextProto& client_context);

  using Scripts = std::map<Script*, std::unique_ptr<Script>>;
  // Parse assistant scripts from the given |response|, which should not be an
  // empty string.
  //
  // Parsed assistant scripts are returned through |scripts|, which should not
  // be nullptr. Returned scripts are guaranteed to be fully initialized, and
  // have a name, path and precondition.
  //
  // Return false if parse failed, otherwise return true.
  static bool ParseScripts(const std::string& response,
                           std::vector<std::unique_ptr<Script>>* scripts);

  // Create initial request to get script actions for the given |script_path|.
  static std::string CreateInitialScriptActionsRequest(
      const std::string& script_path,
      const GURL& url,
      const std::map<std::string, std::string>& parameters,
      const std::string& server_payload,
      const ClientContextProto& client_context);

  // Create request to get next sequence of actions for a script.
  static std::string CreateNextScriptActionsRequest(
      const std::string& previous_server_payload,
      const std::vector<ProcessedActionProto>& processed_actions,
      const ClientContextProto& client_context);

  // Parse actions from the given |response|, which can be an empty string.
  //
  // Pass in nullptr for |return_server_payload| to indicate no need to return
  // server payload. Parsed actions are returned through |actions|, which should
  // not be nullptr. Return false if parse failed, otherwise return true.
  static bool ParseActions(const std::string& response,
                           std::string* return_server_payload,
                           std::vector<std::unique_ptr<Action>>* actions);

 private:
  // To avoid instantiate this class by accident.
  ProtocolUtils() = delete;
  ~ProtocolUtils() = delete;
};
}  // namespace autofill_assistant

#endif  // COMPONENTS_AUTOFILL_ASSISTANT_BROWSER_PROTOCOL_UTILS_H_