client/goma_blob.h

// Copyright 2018 The Goma 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 DEVTOOLS_GOMA_CLIENT_GOMA_BLOB_H_
#define DEVTOOLS_GOMA_CLIENT_GOMA_BLOB_H_

#include <memory>
#include <string>

#include "http.h"

namespace devtools_goma {

class ExecReq_Input;
class FileBlob;
class FileServiceClient;
class FileServiceHttpClient;
class RequesterInfo;

// BlobClient uploads/downloads file blob between client and server.
class BlobClient {
 public:
  // Uploader uploads file blob from client to server.
  class Uploader {
   public:
    virtual ~Uploader() = default;

    Uploader(Uploader&&) = delete;
    Uploader(const Uploader&) = delete;
    Uploader& operator=(const Uploader&) = delete;
    Uploader& operator=(Uploader&&) = delete;

    // Computes hash key of the file.
    // Input data will not have any content. hash only.
    virtual bool ComputeKey() = 0;

    // Uploads file blob to server.
    virtual bool Upload() = 0;

    // Embeds file blob in input.
    virtual bool Embed() = 0;

    // Following methods are valid only after one of above 3 methods call.
    const std::string& hash_key() const { return hash_key_; }
    virtual const HttpClient::Status& http_status() const = 0;

    // Fills in input.
    virtual bool GetInput(ExecReq_Input* input) const = 0;

   protected:
    explicit Uploader(std::string filename);

    const std::string filename_;
    std::string hash_key_;
  };

  virtual ~BlobClient() = default;

  BlobClient(BlobClient&&) = delete;
  BlobClient(const BlobClient&) = delete;
  BlobClient& operator=(const BlobClient&) = delete;
  BlobClient& operator=(BlobClient&&) = delete;

  // NewUploader creates new uploader for the filename.
  virtual std::unique_ptr<Uploader> NewUploader(
      std::string filename,
      const RequesterInfo& requester_info,
      std::string trace_id) = 0;
  // TODO: Downloader

 protected:
  BlobClient() = default;
};

// FileServiceBlobClient is BlobClient using FileServiceHttpClient.
class FileServiceBlobClient : public BlobClient {
 public:
  explicit FileServiceBlobClient(
      std::unique_ptr<FileServiceHttpClient> file_service_client)
      : BlobClient(),
        file_service_(std::move(file_service_client)) {
  }
  ~FileServiceBlobClient() override = default;

  FileServiceHttpClient* file_service() const {
    return file_service_.get();
  }

  std::unique_ptr<BlobClient::Uploader> NewUploader(
      std::string filename,
      const RequesterInfo& requester_info,
      std::string trace_id) override;

 private:
  std::unique_ptr<FileServiceHttpClient> file_service_;
};

}  // namespace devtools_goma

#endif  // DEVTOOLS_GOMA_CLIENT_GOMA_BLOB_H_