components/data_sharing/public/data_sharing_network_loader.h

// 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_DATA_SHARING_PUBLIC_DATA_SHARING_NETWORK_LOADER_H_
#define COMPONENTS_DATA_SHARING_PUBLIC_DATA_SHARING_NETWORK_LOADER_H_

#include <memory>
#include <string>
#include <vector>

#include "base/functional/callback_forward.h"
#include "components/data_sharing/public/group_data.h"
#include "net/traffic_annotation/network_traffic_annotation.h"

class GURL;

namespace data_sharing {

// Class for fetching data sharing related data from network.
class DataSharingNetworkLoader {
 public:
  // GENERATED_JAVA_ENUM_PACKAGE: (
  //   org.chromium.components.data_sharing)
  enum class NetworkLoaderStatus {
    kUnknown = 0,
    kSuccess = 1,
    kTransientFailure = 2,
    kPersistentFailure = 3
  };

  // GENERATED_JAVA_ENUM_PACKAGE: (
  //   org.chromium.components.data_sharing)
  enum class DataSharingRequestType {
    kUnknown = 0,
    kCreateGroup = 1,
    kReadGroups = 2,
    kReadAllGroups = 3,
    kUpdateGroup = 4,
    kDeleteGroups = 5,
    kTestRequest = 6,
    kWarmup = 7,
    kAutocomplete = 8,
    kLookup = 9,
    kMutateConnectionLabel = 10,
    kBlockPerson = 11,
    kLeaveGroup = 12,
    kJoinGroup = 13,
  };

  struct LoadResult {
    LoadResult();
    LoadResult(std::string result_bytes,
               NetworkLoaderStatus status,
               int network_error_code);
    ~LoadResult();

    std::string result_bytes;
    NetworkLoaderStatus status;
    int network_error_code;
  };

  // Callback to return the network response to the caller.
  using NetworkLoaderCallback =
      base::OnceCallback<void(std::unique_ptr<LoadResult>)>;

  DataSharingNetworkLoader() = default;
  virtual ~DataSharingNetworkLoader() = default;

  // Disallow copy/assign.
  DataSharingNetworkLoader(const DataSharingNetworkLoader&) = delete;
  DataSharingNetworkLoader& operator=(const DataSharingNetworkLoader&) = delete;

  // Called to fetch data from the network. Callback will be invoked once the
  // fetch completes. If an error occurs, a nullptr will be passed to the
  // callback.
  // TODO(ssid): Deprecate this function, use the one with `request_type`.
  virtual void LoadUrl(const GURL& gurl,
                       const std::vector<std::string>& scopes,
                       const std::string& post_data,
                       const net::NetworkTrafficAnnotationTag& annotation_tag,
                       NetworkLoaderCallback callback) = 0;

  // Called to fetch data from the network. Callback will be invoked once the
  // fetch completes. If an error occurs, a nullptr will be passed to the
  // callback.
  virtual void LoadUrl(const GURL& gurl,
                       const std::vector<std::string>& scopes,
                       const std::string& post_data,
                       DataSharingRequestType requestType,
                       NetworkLoaderCallback callback) = 0;
};

}  // namespace data_sharing

#endif  // COMPONENTS_DATA_SHARING_PUBLIC_DATA_SHARING_NETWORK_LOADER_H_