Skip to content

Commit

Permalink
More thoughts about startup task -- part 2: code form
Browse files Browse the repository at this point in the history
  • Loading branch information
DHowett committed Feb 7, 2025
1 parent f0ac7cd commit dc0566b
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 19 deletions.
71 changes: 56 additions & 15 deletions src/cascadia/TerminalApp/AppLogic.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -363,11 +363,9 @@ namespace winrt::TerminalApp::implementation
co_return;
}


const auto tryEnableStartupTask = _settings.GlobalSettings().StartOnUserLogin();
const auto task = co_await StartupTask::GetAsync(StartupTaskName);

auto taskState = task.State();
// If user has not set in json:
// If user has enabled in settings - enable in user settings
// If user has disabled in settings - disable in user settings (can this happen?)
Expand All @@ -386,26 +384,69 @@ namespace winrt::TerminalApp::implementation
// if user goes from enabled to diabled, try to disable in settings
// if user goes from disabled to enabled, try to enable in settings
// can we detect if RequestEnable succeeded?
std::optional<bool> newFinalStartupTaskState;
std::optional<bool> newFinalUserSettingsValue;
auto appState{ ApplicationState::SharedInstance() };
std::optional<bool> userRequestedStartupTaskState;
if (_settings.GlobalSettings().HasStartOnUserLogin())
{
userRequestedStartupTaskState.emplace(_settings.GlobalSettings().StartOnUserLogin());
}

std::optional<bool> lastSyncedStartupTaskState;
if (appState.HasLastStartOnUserLoginStateSyncedWithOS())
{
lastSyncedStartupTaskState.emplace(appState.LastStartOnUserLoginStateSyncedWithOS());
}

switch (task.State())
if (userRequestedStartupTaskState == lastSyncedStartupTaskState)
{
case StartupTaskState::Disabled:
if (tryEnableStartupTask)
// The user has not changed their state since we last checked (this could also indicate no state ever set);
// propagate changes from the OS down to the user settings file.
std::optional<bool> newFinalUserSettingsValue;
switch (task.State())
{
co_await task.RequestEnableAsync();
case StartupTaskState::Enabled: // user or Terminal enabled it
case StartupTaskState::EnabledByPolicy: // policy enabled it globally
newFinalUserSettingsValue = true;
break;
case StartupTaskState::DisabledByPolicy: // policy disabled it globally
case StartupTaskState::DisabledByUser: // user turned it off in Task Manager
newFinalUserSettingsValue = false;
break;
case StartupTaskState::Disabled: // never set
default:
break;
}

if (newFinalUserSettingsValue.has_value())
{
_settings.GlobalSettings().StartOnUserLogin(*newFinalUserSettingsValue);
appState.LastStartOnUserLoginStateSyncedWithOS(*newFinalUserSettingsValue);
// TODO SAVE SETTINGS AND IGNORE NEXT RELOAD???
}
}
else
{
// The user changed their state since we last checked;
// propagate changes from the user up to the OS.
if (userRequestedStartupTaskState == true /* explicit comparison fails for nullopt */)
{
auto newState{ co_await task.RequestEnableAsync() };
if (newState != StartupTaskState::Enabled)
{
// We could not enable it. It was disabled by policy. Disable it.
_settings.GlobalSettings().StartOnUserLogin(false);
appState.LastStartOnUserLoginStateSyncedWithOS(false);
}
else
{
appState.LastStartOnUserLoginStateSyncedWithOS(true);
}
}
break;
case StartupTaskState::DisabledByUser:
// TODO: GH#6254: define UX for other StartupTaskStates
break;
case StartupTaskState::Enabled:
if (!tryEnableStartupTask)
else if (userRequestedStartupTaskState == false /* explicit comparison fails for nullopt */)
{
task.Disable();
appState.LastStartOnUserLoginStateSyncedWithOS(false);
}
break;
}
}
CATCH_LOG();
Expand Down
2 changes: 1 addition & 1 deletion src/cascadia/TerminalSettingsModel/ApplicationState.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
MTSM_APPLICATION_STATE_FIELDS(MTSM_APPLICATION_STATE_GEN)
#undef MTSM_APPLICATION_STATE_GEN

bool ApplicationState::HasLastStartOnUserloginStateSyncedWithOS() const noexcept
bool ApplicationState::HasLastStartOnUserLoginStateSyncedWithOS() const noexcept
{
const auto state = _state.lock_shared();
return state->LastStartOnUserLoginStateSyncedWithOS.has_value();
Expand Down
2 changes: 1 addition & 1 deletion src/cascadia/TerminalSettingsModel/ApplicationState.h
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
MTSM_APPLICATION_STATE_FIELDS(MTSM_APPLICATION_STATE_GEN)
#undef MTSM_APPLICATION_STATE_GEN

bool HasLastStartOnUserloginStateSyncedWithOS() const noexcept;
bool HasLastStartOnUserLoginStateSyncedWithOS() const noexcept;

private:
struct state_t
Expand Down
4 changes: 2 additions & 2 deletions src/cascadia/TerminalSettingsModel/ApplicationState.idl
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ namespace Microsoft.Terminal.Settings.Model
Windows.Foundation.Collections.IVector<InfoBarMessage> DismissedMessages;
Windows.Foundation.Collections.IVector<String> AllowedCommandlines;

Boolean LastStartOnUserloginStateSyncedWithOS;
Boolean HasLastStartOnUserloginStateSyncedWithOS();
Boolean LastStartOnUserLoginStateSyncedWithOS;
Boolean HasLastStartOnUserLoginStateSyncedWithOS();
}
}

1 comment on commit dc0566b

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@check-spelling-bot Report

🔴 Please review

See the 📜action log or 📝 job summary for details.

Unrecognized words (1)

diabled

These words are not needed and should be removed abcd ABCDEFGHIJ abcdefghijk ABCDEFGHIJKLMNOPQRS ABCDEFGHIJKLMNOPQRST ABCDEFGHIJKLMNOPQRSTUVWXY allocs appium Argb asan autocrlf backported bytebuffer cac CLE codenav codepath commandline COMMITID componentization constness dealloc deserializers DISPATCHNOTIFY DTest entrypoints EVENTID FINDUP fuzzer hlocal hstring IInput Interner keyscan Munged numlock offboarded pids positionals Productize pseudoterminal remoting renamer roadmap ruleset SELECTALL somefile Stringable tearoff TODOs touchpad TREX Unregistering USERDATA vectorize viewports wsl

To accept these unrecognized words as correct and remove the previously acknowledged and now absent words, you could run the following commands

... in a clone of the [email protected]:microsoft/terminal.git repository
on the dev/duhowett/startup-task-thoughts branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.24/apply.pl' |
perl - 'https://github.com/microsoft/terminal/actions/runs/13190920496/attempts/1'
Errors (1)

See the 📜action log or 📝 job summary for details.

❌ Errors Count
❌ ignored-expect-variant 2

See ❌ Event descriptions for more information.

✏️ Contributor please read this

By default the command suggestion will generate a file named based on your commit. That's generally ok as long as you add the file to your commit. Someone can reorganize it later.

If the listed items are:

  • ... misspelled, then please correct them instead of using the command.
  • ... names, please add them to .github/actions/spelling/allow/names.txt.
  • ... APIs, you can add them to a file in .github/actions/spelling/allow/.
  • ... just things you're using, please add them to an appropriate file in .github/actions/spelling/expect/.
  • ... tokens you only need in one place and shouldn't generally be used, you can add an item in an appropriate file in .github/actions/spelling/patterns/.

See the README.md in each directory for more information.

🔬 You can test your commits without appending to a PR by creating a new branch with that extra change and pushing it to your fork. The check-spelling action will run in response to your push -- it doesn't require an open pull request. By using such a branch, you can limit the number of typos your peers see you make. 😉

If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

Please sign in to comment.