Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Don't treat the COM subcommands as distinct for telemetry #2792

Merged
merged 2 commits into from
Dec 22, 2022
Merged

Don't treat the COM subcommands as distinct for telemetry #2792

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
86944d1
Don't treat the COM subcommands as distinct for telemetry
JohnMcPMS Dec 21, 2022
4047265
PR feedback
JohnMcPMS Dec 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion src/AppInstallerCLICore/Command.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -907,7 +907,7 @@ namespace AppInstaller::CLI
return arguments;
}

int Execute(Execution::Context& context, std::unique_ptr<Command>& command)
void ExecuteWithoutLoggingSuccess(Execution::Context& context, Command* command)
{
try
{
Expand All @@ -923,6 +923,11 @@ namespace AppInstaller::CLI
{
context.SetTerminationHR(Workflow::HandleException(context, std::current_exception()));
}
}

int Execute(Execution::Context& context, std::unique_ptr<Command>& command)
{
ExecuteWithoutLoggingSuccess(context, command.get());

if (SUCCEEDED(context.GetTerminationHR()))
{
Expand Down
2 changes: 2 additions & 0 deletions src/AppInstallerCLICore/Command.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,5 +140,7 @@ namespace AppInstaller::CLI
return result;
}

void ExecuteWithoutLoggingSuccess(Execution::Context& context, Command* command);

int Execute(Execution::Context& context, std::unique_ptr<Command>& command);
}
39 changes: 29 additions & 10 deletions src/AppInstallerCLICore/ContextOrchestrator.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,9 @@ namespace AppInstaller::CLI::Execution
if (item->IsOnFirstCommand())
{
THROW_HR_IF(HRESULT_FROM_WIN32(ERROR_INSTALL_ALREADY_RUNNING), FindById(item->GetId()));

// Log the beginning of the item
item->GetContext().GetThreadGlobals().GetTelemetryLogger().LogCommand(item->GetItemCommandName());
}

std::string commandQueueName{ GetCommandQueueName(item->GetNextCommand().Name()) };
Expand Down Expand Up @@ -246,34 +249,37 @@ namespace AppInstaller::CLI::Execution
}

// Get the item's command and execute it.
HRESULT terminationHR = S_OK;
HRESULT exceptionHR = S_OK;
try
{
std::unique_ptr<Command> command = item->PopNextCommand();

std::unique_ptr<AppInstaller::ThreadLocalStorage::PreviousThreadGlobals> setThreadGlobalsToPreviousState = item->GetContext().SetForCurrentThread();

item->GetContext().GetThreadGlobals().GetTelemetryLogger().LogCommand(command->FullName());
command->ValidateArguments(item->GetContext().Args);

item->GetContext().EnableCtrlHandler();

terminationHR = ::AppInstaller::CLI::Execute(item->GetContext(), command);
::AppInstaller::CLI::ExecuteWithoutLoggingSuccess(item->GetContext(), command.get());
}
WINGET_CATCH_STORE(terminationHR, APPINSTALLER_CLI_ERROR_COMMAND_FAILED);
WINGET_CATCH_STORE(exceptionHR, APPINSTALLER_CLI_ERROR_COMMAND_FAILED);

if (FAILED(terminationHR))
if (FAILED(exceptionHR))
{
// ::Execute sometimes catches exceptions and returns hresults based on those exceptions without the context
// being updated with that hresult. This sets the termination hr directly so that the context always
// Set the termination hr directly from any exception that escaped so that the context always
// has the result of the operation no matter how it failed.
item->GetContext().SetTerminationHR(terminationHR);
item->GetContext().SetTerminationHR(exceptionHR);
}

item->GetContext().EnableCtrlHandler(false);

if (FAILED(terminationHR) || item->IsComplete())
if (FAILED(item->GetContext().GetTerminationHR()) || item->IsComplete())
{
if (SUCCEEDED(item->GetContext().GetTerminationHR()))
{
item->GetContext().GetThreadGlobals().GetTelemetryLogger().LogCommandSuccess(item->GetItemCommandName());
}

RemoveItemInState(*item, OrchestratorQueueItemState::Running, true);
}
else
Expand Down Expand Up @@ -334,6 +340,19 @@ namespace AppInstaller::CLI::Execution
(GetSourceId() == comparedId.GetSourceId()));
}

std::string_view OrchestratorQueueItem::GetItemCommandName() const
{
// The goal is that these should match the winget.exe commands for easy correlation.
switch (m_operationType)
{
case PackageOperationType::Search: return "root:search"sv;
case PackageOperationType::Install: return "root:install"sv;
case PackageOperationType::Upgrade: return "root:upgrade"sv;
case PackageOperationType::Uninstall: return "root:uninstall"sv;
default: return "unknown";
}
}

std::unique_ptr<OrchestratorQueueItem> OrchestratorQueueItemFactory::CreateItemForInstall(std::wstring packageId, std::wstring sourceId, std::unique_ptr<COMContext> context, bool isUpgrade)
{
std::unique_ptr<OrchestratorQueueItem> item = std::make_unique<OrchestratorQueueItem>(OrchestratorQueueItemId(std::move(packageId), std::move(sourceId)), std::move(context), isUpgrade ? PackageOperationType::Upgrade : PackageOperationType::Install);
Expand All @@ -351,7 +370,7 @@ namespace AppInstaller::CLI::Execution

std::unique_ptr<OrchestratorQueueItem> OrchestratorQueueItemFactory::CreateItemForSearch(std::wstring packageId, std::wstring sourceId, std::unique_ptr<COMContext> context)
{
std::unique_ptr<OrchestratorQueueItem> item = std::make_unique<OrchestratorQueueItem>(OrchestratorQueueItemId(std::move(packageId), std::move(sourceId)), std::move(context), PackageOperationType::None);
std::unique_ptr<OrchestratorQueueItem> item = std::make_unique<OrchestratorQueueItem>(OrchestratorQueueItemId(std::move(packageId), std::move(sourceId)), std::move(context), PackageOperationType::Search);
return item;
}
}
5 changes: 3 additions & 2 deletions src/AppInstallerCLICore/ContextOrchestrator.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ namespace AppInstaller::CLI::Execution

enum class PackageOperationType
{
None,
Search,
Install,
Upgrade,
Uninstall,
Expand Down Expand Up @@ -77,6 +77,7 @@ namespace AppInstaller::CLI::Execution
bool IsComplete() const { return m_commands.empty(); }
bool IsApplicableForInstallingSource() const { return m_operationType == PackageOperationType::Install || m_operationType == PackageOperationType::Upgrade; }
PackageOperationType GetPackageOperationType() const { return m_operationType; }
std::string_view GetItemCommandName() const;

private:
OrchestratorQueueItemState m_state = OrchestratorQueueItemState::NotQueued;
Expand All @@ -86,7 +87,7 @@ namespace AppInstaller::CLI::Execution
std::deque<std::unique_ptr<Command>> m_commands;
bool m_isOnFirstCommand = true;
OrchestratorQueue* m_currentQueue = nullptr;
PackageOperationType m_operationType = PackageOperationType::None;
PackageOperationType m_operationType;
};

struct OrchestratorQueueItemFactory
Expand Down