audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation Class Reference

Inheritance diagram for audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation:

Collaboration diagram for audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation:

Classes
struct	Tag

Public Member Functions
	ResumedSnaphotUploadOperation (Tag, ProjectCloudExtension &projectCloudExtension, std::string_view snapshotId, std::string_view confirmationUrl)
	~ResumedSnaphotUploadOperation () override
Public Member Functions inherited from audacity::cloud::audiocom::sync::ProjectUploadOperation
virtual	~ProjectUploadOperation ()=default
virtual void	Start ()=0
virtual void	SetUploadData (const ProjectUploadData &data)=0
virtual bool	IsCompleted () const =0
Public Member Functions inherited from audacity::concurrency::ICancellable
virtual	~ICancellable ()=default
virtual void	Cancel ()=0

Static Public Member Functions
static void	Perform (ProjectCloudExtension &projectCloudExtension, std::string_view snapshotId, std::string_view confirmationUrl)

Private Member Functions
void	UploadSnapshot ()
void	CompleteSync ()
void	FailSync (CloudSyncError error)
void	FailSync (ResponseResult result)
void	UploadBlocks ()
void	Start () override
void	RefreshUrls ()
void	UpdateUrls (const ProjectSyncState &syncState)
void	MarkSnapshotSynced ()
void	SetUploadData (const ProjectUploadData &data) override
bool	IsCompleted () const override
void	Cancel () override

Private Attributes
ProjectCloudExtension &	mProjectCloudExtension
std::string	mProjectId
std::string	mSnapshotId
std::string	mConfirmationUrl
concurrency::CancellationContextPtr	mCancellationContext
std::optional< PendingProjectBlobData >	mPendingProjectBlobData
std::vector< PendingProjectBlockData >	mPendingProjectBlocks
std::shared_ptr< MissingBlocksUploader >	mMissingBlocksUploader
std::atomic< bool >	mCompleted { false }
bool	mHasExpiredUrls { false }

Detailed Description

Definition at line 78 of file ResumedSnaphotUploadOperation.cpp.

Constructor & Destructor Documentation

ResumedSnaphotUploadOperation()

audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::ResumedSnaphotUploadOperation ( Tag  , ProjectCloudExtension &  projectCloudExtension, std::string_view  snapshotId, std::string_view  confirmationUrl  )

inline

Definition at line 87 of file ResumedSnaphotUploadOperation.cpp.

       : mProjectCloudExtension { projectCloudExtension }
       , mProjectId { mProjectCloudExtension.GetCloudProjectId() }
       , mSnapshotId { snapshotId }
       , mConfirmationUrl { confirmationUrl }
       , mCancellationContext { concurrency::CancellationContext::Create() }
   {
   }

~ResumedSnaphotUploadOperation()

audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::~ResumedSnaphotUploadOperation ( )

inlineoverride

Definition at line 98 of file ResumedSnaphotUploadOperation.cpp.

   {
   }

Member Function Documentation

Cancel()

void audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::Cancel ( )

inlineoverrideprivatevirtual

Implements audacity::concurrency::ICancellable.

Definition at line 417 of file ResumedSnaphotUploadOperation.cpp.

   {
      mCancellationContext->Cancel();
      FailSync(CloudSyncError { CloudSyncError::Cancelled });
   }

References audacity::cloud::audiocom::sync::CloudSyncError::Cancelled.

CompleteSync()

void audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::CompleteSync ( )

inlineprivate

Definition at line 171 of file ResumedSnaphotUploadOperation.cpp.

   {
      if (!mCompleted.exchange(true))
         mProjectCloudExtension.OnSyncCompleted(this, {});
   }

FailSync() [1/2]

void audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::FailSync ( CloudSyncError  error )

inlineprivate

Definition at line 177 of file ResumedSnaphotUploadOperation.cpp.

   {
      if (!mCompleted.exchange(true))
         mProjectCloudExtension.OnSyncCompleted(this, error);
   }

FailSync() [2/2]

void audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::FailSync ( ResponseResult  result )

inlineprivate

Definition at line 183 of file ResumedSnaphotUploadOperation.cpp.

   {
      FailSync(CloudSyncError { DeduceError(result.Code), result.Content });
   }

References audacity::cloud::audiocom::ResponseResult::Code, audacity::cloud::audiocom::ResponseResult::Content, and audacity::cloud::audiocom::sync::DeduceError().

Here is the call graph for this function:

IsCompleted()

bool audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::IsCompleted ( ) const

inlineoverrideprivatevirtual

Implements audacity::cloud::audiocom::sync::ProjectUploadOperation.

Definition at line 412 of file ResumedSnaphotUploadOperation.cpp.

   {
      return mCompleted.load();
   }

MarkSnapshotSynced()

void audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::MarkSnapshotSynced ( )

inlineprivate

Definition at line 376 of file ResumedSnaphotUploadOperation.cpp.

   {
      using namespace network_manager;
      Request request { mConfirmationUrl };
 
      SetCommonHeaders(request);
 
      auto response = NetworkManager::GetInstance().doPost(request, nullptr, 0);
 
      response->setRequestFinishedCallback(
         [this, response, weakThis = weak_from_this()](auto)
         {
            auto strongThis = weakThis.lock();
            if (!strongThis)
               return;
 
            CloudProjectsDatabase::Get().RemovePendingSnapshot(
               mProjectId, mSnapshotId);
 
            if (response->getError() != NetworkError::NoError)
            {
               FailSync(DeduceUploadError(*response));
               return;
            }
 
            CompleteSync();
         });
 
      mCancellationContext->OnCancelled(response);
   }

References audacity::cloud::audiocom::sync::DeduceUploadError(), audacity::network_manager::NetworkManager::doPost(), audacity::cloud::audiocom::sync::CloudProjectsDatabase::Get(), audacity::network_manager::NetworkManager::GetInstance(), audacity::cloud::audiocom::sync::CloudProjectsDatabase::RemovePendingSnapshot(), and audacity::cloud::audiocom::SetCommonHeaders().

Here is the call graph for this function:

Perform()

static void audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::Perform ( ProjectCloudExtension &  projectCloudExtension, std::string_view  snapshotId, std::string_view  confirmationUrl  )

inlinestatic

Definition at line 102 of file ResumedSnaphotUploadOperation.cpp.

   {
      auto& cloudProjectsDatabase = CloudProjectsDatabase::Get();
 
      auto operation = std::make_shared<ResumedSnaphotUploadOperation>(
         Tag {}, projectCloudExtension, snapshotId, confirmationUrl);
 
      const auto projectId = projectCloudExtension.GetCloudProjectId();
 
      operation->mPendingProjectBlobData =
         cloudProjectsDatabase.GetPendingProjectBlob(projectId, snapshotId);
 
      operation->mPendingProjectBlocks =
         cloudProjectsDatabase.GetPendingProjectBlocks(projectId, snapshotId);
 
      const int64_t totalBlocks = operation->mPendingProjectBlocks.size();
 
      if (operation->mPendingProjectBlobData)
      {
         operation->mHasExpiredUrls =
            IsUrlExpired(operation->mPendingProjectBlobData->UploadUrl);
      }
 
      for (const auto& block : operation->mPendingProjectBlocks)
      {
         if (operation->mHasExpiredUrls)
            break;
 
         operation->mHasExpiredUrls = IsUrlExpired(block.UploadUrl);
      }
 
      projectCloudExtension.OnSyncResumed(
         operation, totalBlocks,
         operation->mPendingProjectBlobData.has_value());
   }

References audacity::cloud::audiocom::sync::CloudProjectsDatabase::Get(), audacity::cloud::audiocom::sync::ProjectCloudExtension::GetCloudProjectId(), audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::IsUrlExpired(), and audacity::cloud::audiocom::sync::ProjectCloudExtension::OnSyncResumed().

Here is the call graph for this function:

RefreshUrls()

void audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::RefreshUrls ( )

inlineprivate

Definition at line 287 of file ResumedSnaphotUploadOperation.cpp.

   {
      using namespace network_manager;
      Request request { GetServiceConfig().GetSnapshotSyncUrl(
         mProjectId, mSnapshotId) };
 
      SetCommonHeaders(request);
 
      auto response = NetworkManager::GetInstance().doGet(request);
 
      response->setRequestFinishedCallback(
         [this, response, weakThis = weak_from_this()](auto)
         {
            auto strongThis = weakThis.lock();
            if (!strongThis)
               return;
 
            if (response->getError() != NetworkError::NoError)
            {
               FailSync(DeduceUploadError(*response));
               return;
            }
 
            auto syncState =
               DeserializeProjectSyncState(response->readAll<std::string>());
 
            if (!syncState)
            {
               FailSync(
                  MakeClientFailure(XO("Failed to deserialize the response")));
               return;
            }
 
            UpdateUrls(*syncState);
 
            if (mPendingProjectBlobData.has_value())
               UploadSnapshot();
            else
               UploadBlocks();
         });
   }

References audacity::cloud::audiocom::sync::DeserializeProjectSyncState(), audacity::network_manager::NetworkManager::doGet(), audacity::network_manager::NetworkManager::GetInstance(), audacity::cloud::audiocom::GetServiceConfig(), audacity::cloud::audiocom::ServiceConfig::GetSnapshotSyncUrl(), audacity::cloud::audiocom::sync::MakeClientFailure(), audacity::cloud::audiocom::SetCommonHeaders(), and XO().

Here is the call graph for this function:

SetUploadData()

void audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::SetUploadData ( const ProjectUploadData &  data )

inlineoverrideprivatevirtual

Implements audacity::cloud::audiocom::sync::ProjectUploadOperation.

Definition at line 407 of file ResumedSnaphotUploadOperation.cpp.

   {
      // This method will never be called for resumed operations
   }

Start()

void audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::Start ( )

inlineoverrideprivatevirtual

Implements audacity::cloud::audiocom::sync::ProjectUploadOperation.

Definition at line 277 of file ResumedSnaphotUploadOperation.cpp.

   {
      if (mHasExpiredUrls)
         RefreshUrls();
      else if (mPendingProjectBlobData.has_value())
         UploadSnapshot();
      else
         UploadBlocks();
   }

UpdateUrls()

void audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::UpdateUrls ( const ProjectSyncState &  syncState )

inlineprivate

Definition at line 329 of file ResumedSnaphotUploadOperation.cpp.

   {
      if (mPendingProjectBlobData.has_value())
      {
         if (syncState.FileUrls.UploadUrl.empty())
         {
            mPendingProjectBlobData = {};
            CloudProjectsDatabase::Get().RemovePendingProjectBlob(
               mProjectId, mSnapshotId);
         }
         else
         {
            mPendingProjectBlobData->UploadUrl  = syncState.FileUrls.UploadUrl;
            mPendingProjectBlobData->ConfirmUrl = syncState.FileUrls.SuccessUrl;
            mPendingProjectBlobData->FailUrl    = syncState.FileUrls.SuccessUrl;
         }
      }
 
      std::unordered_map<std::string, UploadUrls> urlsLookup;
      for (const auto& urls : syncState.MissingBlocks)
         urlsLookup.emplace(urls.Id, urls);
 
      for (auto& block : mPendingProjectBlocks)
      {
         auto it = urlsLookup.find(block.BlockHash);
 
         if (it == urlsLookup.end())
         {
            CloudProjectsDatabase::Get().RemovePendingProjectBlock(
               mProjectId, block.BlockId);
 
            continue;
         }
 
         block.UploadUrl  = urlsLookup[block.BlockHash].UploadUrl;
         block.ConfirmUrl = urlsLookup[block.BlockHash].SuccessUrl;
         block.FailUrl    = urlsLookup[block.BlockHash].FailUrl;
      }
 
      mPendingProjectBlocks.erase(
         std::remove_if(
            mPendingProjectBlocks.begin(), mPendingProjectBlocks.end(),
            [&urlsLookup](auto& block)
            { return urlsLookup.find(block.BlockHash) == urlsLookup.end(); }),
         mPendingProjectBlocks.end());
   }

References audacity::cloud::audiocom::sync::ProjectSyncState::FileUrls, audacity::cloud::audiocom::sync::CloudProjectsDatabase::Get(), audacity::cloud::audiocom::sync::ProjectSyncState::MissingBlocks, audacity::cloud::audiocom::sync::CloudProjectsDatabase::RemovePendingProjectBlob(), audacity::cloud::audiocom::sync::CloudProjectsDatabase::RemovePendingProjectBlock(), audacity::cloud::audiocom::sync::UploadUrls::SuccessUrl, and audacity::cloud::audiocom::sync::UploadUrls::UploadUrl.

Here is the call graph for this function:

UploadBlocks()

void audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::UploadBlocks ( )

inlineprivate

Definition at line 188 of file ResumedSnaphotUploadOperation.cpp.

   {
      if (mPendingProjectBlocks.empty())
         MarkSnapshotSynced();
 
      auto project = mProjectCloudExtension.GetProject().lock();
 
      if (!project)
      {
         FailSync({ SyncResultCode::InternalClientError });
         return;
      }
 
      auto& waveTrackFactory   = WaveTrackFactory::Get(*project);
      auto& sampleBlockFactory = waveTrackFactory.GetSampleBlockFactory();
 
      std::vector<BlockUploadTask> blockTasks;
      blockTasks.reserve(mPendingProjectBlocks.size());
 
      for (const auto& pendingBlock : mPendingProjectBlocks)
      {
         BlockUploadTask task;
 
         task.BlockUrls = { {},
                            pendingBlock.UploadUrl,
                            pendingBlock.ConfirmUrl,
                            pendingBlock.FailUrl };
 
         task.Block.Format =
            static_cast<sampleFormat>(pendingBlock.BlockSampleFormat);
         task.Block.Hash = pendingBlock.BlockHash;
         task.Block.Id   = pendingBlock.BlockId;
         try
         {
            task.Block.Block = sampleBlockFactory->CreateFromId(
               task.Block.Format, pendingBlock.BlockId);
 
            blockTasks.push_back(std::move(task));
         }
         catch (const FileException& e)
         {
            // We have failed to resume the upload, local data is missing
            CloudProjectsDatabase::Get().RemovePendingSnapshot(
               mProjectId, mSnapshotId);
            FailSync(
               { SyncResultCode::InternalClientError,
                 ToUTF8(
                    XO("Local project data was removed before the sync has completed")
                       .Translation()) });
            return;
         }
      }
 
      mMissingBlocksUploader = MissingBlocksUploader::Create(
         mCancellationContext, GetServiceConfig(), std::move(blockTasks),
         [this, weakThis = weak_from_this()](
            const MissingBlocksUploadProgress& progress,
            const LockedBlock& block, ResponseResult blockResponseResult)
         {
            auto strongThis = weakThis.lock();
            if (!strongThis)
               return;
 
            if (
               blockResponseResult.Code != SyncResultCode::ConnectionFailed &&
               blockResponseResult.Code != SyncResultCode::Cancelled)
               CloudProjectsDatabase::Get().RemovePendingProjectBlock(
                  mProjectId, block.Id);
 
            mProjectCloudExtension.OnBlockUploaded(
               *this, block.Hash,
               blockResponseResult.Code == SyncResultCode::Success);
 
            const auto completed =
               progress.UploadedBlocks == progress.TotalBlocks ||
               progress.FailedBlocks != 0;
 
            const bool succeeded = completed && progress.FailedBlocks == 0;
 
            if (!completed)
               return;
 
            if (succeeded)
               MarkSnapshotSynced();
            else
               FailSync(std::move(blockResponseResult));
         });
   }

References audacity::cloud::audiocom::sync::LockedBlock::Block, audacity::cloud::audiocom::sync::BlockUploadTask::Block, audacity::cloud::audiocom::sync::BlockUploadTask::BlockUrls, audacity::cloud::audiocom::Cancelled, audacity::cloud::audiocom::ResponseResult::Code, audacity::cloud::audiocom::ConnectionFailed, audacity::cloud::audiocom::sync::MissingBlocksUploader::Create(), audacity::cloud::audiocom::sync::MissingBlocksUploadProgress::FailedBlocks, audacity::cloud::audiocom::sync::LockedBlock::Format, audacity::cloud::audiocom::sync::CloudProjectsDatabase::Get(), WaveTrackFactory::Get(), audacity::cloud::audiocom::GetServiceConfig(), audacity::cloud::audiocom::sync::LockedBlock::Hash, audacity::cloud::audiocom::sync::LockedBlock::Id, audacity::cloud::audiocom::InternalClientError, project, audacity::cloud::audiocom::sync::CloudProjectsDatabase::RemovePendingProjectBlock(), audacity::cloud::audiocom::sync::CloudProjectsDatabase::RemovePendingSnapshot(), anonymous_namespace{StretchingSequenceIntegrationTest.cpp}::sampleBlockFactory, audacity::cloud::audiocom::Success, audacity::cloud::audiocom::sync::MissingBlocksUploadProgress::TotalBlocks, audacity::ToUTF8(), audacity::cloud::audiocom::sync::MissingBlocksUploadProgress::UploadedBlocks, audacity::cloud::audiocom::sync::UploadUrls::UploadUrl, and XO().

Here is the call graph for this function:

UploadSnapshot()

void audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::UploadSnapshot ( )

inlineprivate

Definition at line 141 of file ResumedSnaphotUploadOperation.cpp.

   {
      const auto urls = UploadUrls { {},
                                     mPendingProjectBlobData->UploadUrl,
                                     mPendingProjectBlobData->ConfirmUrl,
                                     mPendingProjectBlobData->FailUrl };
 
      DataUploader::Get().Upload(
         mCancellationContext, GetServiceConfig(), urls,
         mPendingProjectBlobData->BlobData,
         [this, weakThis = weak_from_this()](auto result)
         {
            auto strongThis = weakThis.lock();
            if (!strongThis)
               return;
 
            if (!IsUploadRecoverable(result.Code))
               CloudProjectsDatabase::Get().RemovePendingProjectBlob(
                  mProjectId, mSnapshotId);
 
            if (result.Code == SyncResultCode::Success)
            {
               mProjectCloudExtension.OnProjectDataUploaded(*this);
               UploadBlocks();
            }
            else
               FailSync(std::move(result));
         });
   }

References audacity::cloud::audiocom::sync::CloudProjectsDatabase::Get(), audacity::cloud::audiocom::sync::DataUploader::Get(), audacity::cloud::audiocom::GetServiceConfig(), audacity::cloud::audiocom::IsUploadRecoverable(), audacity::cloud::audiocom::sync::CloudProjectsDatabase::RemovePendingProjectBlob(), audacity::cloud::audiocom::Success, audacity::cloud::audiocom::sync::DataUploader::Upload(), and audacity::cloud::audiocom::sync::UploadUrls::UploadUrl.

Here is the call graph for this function:

Member Data Documentation

mCancellationContext

concurrency::CancellationContextPtr audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::mCancellationContext

private

Definition at line 429 of file ResumedSnaphotUploadOperation.cpp.

mCompleted

std::atomic<bool> audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::mCompleted { false }

private

Definition at line 436 of file ResumedSnaphotUploadOperation.cpp.

mConfirmationUrl

std::string audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::mConfirmationUrl

private

Definition at line 427 of file ResumedSnaphotUploadOperation.cpp.

mHasExpiredUrls

bool audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::mHasExpiredUrls { false }

private

Definition at line 438 of file ResumedSnaphotUploadOperation.cpp.

mMissingBlocksUploader

std::shared_ptr<MissingBlocksUploader> audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::mMissingBlocksUploader

private

Definition at line 434 of file ResumedSnaphotUploadOperation.cpp.

mPendingProjectBlobData

std::optional<PendingProjectBlobData> audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::mPendingProjectBlobData

private

Definition at line 431 of file ResumedSnaphotUploadOperation.cpp.

mPendingProjectBlocks

std::vector<PendingProjectBlockData> audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::mPendingProjectBlocks

private

Definition at line 432 of file ResumedSnaphotUploadOperation.cpp.

mProjectCloudExtension

ProjectCloudExtension& audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::mProjectCloudExtension

private

Definition at line 423 of file ResumedSnaphotUploadOperation.cpp.

mProjectId

std::string audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::mProjectId

private

Definition at line 425 of file ResumedSnaphotUploadOperation.cpp.

mSnapshotId

std::string audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::mSnapshotId

private

Definition at line 426 of file ResumedSnaphotUploadOperation.cpp.

---

The documentation for this class was generated from the following file:

• ResumedSnaphotUploadOperation.cpp