Skip to content

Updated LoginButton events to respond to GlobalProvider #115

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

Merged
shweaver-MSFT merged 4 commits into from
Jul 12, 2021
Merged

Updated LoginButton events to respond to GlobalProvider #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
800f787
Updated LoginButton events to fire Login/Logout Completed events in r…
shweaver-MSFT Jun 11, 2021
e42f61e
Merge branch 'dev/7.1.0' into shweaver/login-events
shweaver-MSFT Jun 24, 2021
6c2ca9f
Refactored LoginButton.cs to accomodate for new event pattern
shweaver-MSFT Jun 29, 2021
7d5bdde
Removed unecessary IsLoading set
shweaver-MSFT Jul 12, 2021
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
2 changes: 1 addition & 1 deletion CommunityToolkit.Graph.Uwp/Controls/LoginButton/LoginButton.Properties.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ public partial class LoginButton
public User UserDetails
{
get { return (User)GetValue(UserDetailsProperty); }
set { SetValue(UserDetailsProperty, value); }
protected set { SetValue(UserDetailsProperty, value); }
}

/// <summary>
Expand Down
284 changes: 169 additions & 115 deletions CommunityToolkit.Graph.Uwp/Controls/LoginButton/LoginButton.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ namespace CommunityToolkit.Graph.Uwp.Controls
/// The <see cref="LoginButton"/> control is a button which can be used to sign the user in or show them profile details.
/// </summary>
[TemplatePart(Name = LoginButtonPart, Type = typeof(Button))]
[TemplatePart(Name = SignOutButtonPart, Type = typeof(ButtonBase))]
[TemplatePart(Name = LogoutButtonPart, Type = typeof(ButtonBase))]
public partial class LoginButton : Control
{
private const string LoginButtonPart = "PART_LoginButton";
private const string SignOutButtonPart = "PART_SignOutButton";
private const string LogoutButtonPart = "PART_LogoutButton";

private Button _loginButton;
private ButtonBase _signOutButton;
private ButtonBase _logoutButton;

private bool _isLoading;

Expand All @@ -48,17 +48,87 @@ public LoginButton()
{
this.DefaultStyleKey = typeof(LoginButton);

ProviderManager.Instance.ProviderStateChanged += (sender, args) => LoadData();
ProviderManager.Instance.ProviderUpdated += OnProviderUpdated;
ProviderManager.Instance.ProviderStateChanged += OnProviderStateChanged;
}

/// <summary>
/// Update the enablement state of the button in relation to the _isLoading property.
/// Initiates logging in with the current <see cref="IProvider"/> registered in the <see cref="ProviderManager"/>.
/// </summary>
protected void UpdateButtonEnablement()
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
public async Task SignInAsync()
{
if (_loginButton != null)
if (IsLoading)
{
_loginButton.IsEnabled = !_isLoading;
return;
}

var provider = ProviderManager.Instance.GlobalProvider;
if (provider != null)
{
try
{
IsLoading = true;

var cargs = new CancelEventArgs();
LoginInitiated?.Invoke(this, cargs);
if (cargs.Cancel)
{
throw new OperationCanceledException();
}

await provider.SignInAsync();

if (provider.State != ProviderState.SignedIn)
{
throw new Exception("Login did not complete.");
}
}
catch (Exception e)
{
IsLoading = false;
LoginFailed?.Invoke(this, new LoginFailedEventArgs(e));
}
}
}

/// <summary>
/// Log a signed-in user out.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
public async Task SignOutAsync()
{
if (IsLoading)
{
return;
}

IsLoading = true;

var cargs = new CancelEventArgs();
LogoutInitiated?.Invoke(this, cargs);
if (cargs.Cancel)
{
return;
}

var provider = ProviderManager.Instance.GlobalProvider;
if (provider != null)
{
try
{
await provider.SignOutAsync();

if (provider.State != ProviderState.SignedOut)
{
throw new Exception("Logout did not complete.");
}
}
finally
{
// There is no LogoutFailed event, so we do nothing.
IsLoading = false;
}
}
}

Expand All @@ -79,171 +149,155 @@ protected override void OnApplyTemplate()
_loginButton.Click += LoginButton_Click;
}

if (_signOutButton != null)
if (_logoutButton != null)
{
_signOutButton.Click -= LoginButton_Click;
_logoutButton.Click -= LogoutButton_Click;
}

_signOutButton = GetTemplateChild(SignOutButtonPart) as ButtonBase;
_logoutButton = GetTemplateChild(LogoutButtonPart) as ButtonBase;

if (_signOutButton != null)
if (_logoutButton != null)
{
_signOutButton.Click += SignOutButton_Click;
_logoutButton.Click += LogoutButton_Click;
}

LoadData();
}

private async void LoginButton_Click(object sender, RoutedEventArgs e)
/// <summary>
/// Show the user details flyout.
/// </summary>
protected void ShowFlyout()
{
if (this.UserDetails != null)
if (FlyoutBase.GetAttachedFlyout(_loginButton) is FlyoutBase flyout)
{
if (FlyoutBase.GetAttachedFlyout(_loginButton) is FlyoutBase flyout)
{
flyout.ShowAt(_loginButton);
}
flyout.ShowAt(_loginButton);
}
else
}

/// <summary>
/// Hide the user details flyout.
/// </summary>
protected void HideFlyout()
{
if (FlyoutBase.GetAttachedFlyout(_loginButton) is FlyoutBase flyout)
{
var cargs = new CancelEventArgs();
LoginInitiated?.Invoke(this, cargs);
flyout.Hide();
}
}

if (!cargs.Cancel)
{
await SignInAsync();
}
/// <summary>
/// Update the enablement state of the button in relation to the _isLoading property.
/// </summary>
protected void UpdateButtonEnablement()
{
if (_loginButton != null)
{
_loginButton.IsEnabled = !_isLoading;
}
}

private async void SignOutButton_Click(object sender, RoutedEventArgs e)
private void OnProviderUpdated(object sender, IProvider e)
{
await SignOutAsync();
if (e == null)
{
ClearUserDetails();
}
}

private async void LoadData()
private async void OnProviderStateChanged(object sender, ProviderStateChangedEventArgs e)
{
var provider = ProviderManager.Instance.GlobalProvider;
switch (provider?.State)
switch (provider.State)
{
case ProviderState.Loading:
case ProviderState.SignedIn:
IsLoading = true;
await SetUserDetails();
IsLoading = false;
LoginCompleted?.Invoke(this, new EventArgs());
break;

case ProviderState.SignedIn:
try
{
IsLoading = true;
case ProviderState.SignedOut:
ClearUserDetails();
IsLoading = false;
LogoutCompleted?.Invoke(this, new EventArgs());
break;

// https://github.com/microsoftgraph/microsoft-graph-toolkit/blob/master/src/components/mgt-login/mgt-login.ts#L139
// TODO: Batch with photo request later? https://github.com/microsoftgraph/msgraph-sdk-dotnet-core/issues/29
UserDetails = await provider.GetClient().GetMeAsync();
}
catch (Exception e)
{
LoginFailed?.Invoke(this, new LoginFailedEventArgs(e));
}
finally
{
IsLoading = false;
}
case ProviderState.Loading:
IsLoading = true;
break;
}
}

private async void LoginButton_Click(object sender, RoutedEventArgs e)
{
var provider = ProviderManager.Instance.GlobalProvider;
switch (provider.State)
{
case ProviderState.SignedIn:
ShowFlyout();
break;

case ProviderState.SignedOut:
default:
UserDetails = null; // What if this was user provided? Should we not hook into these events then?
IsLoading = false;
await SignInAsync();
break;
}
}

/// <summary>
/// Initiates logging in with the current <see cref="IProvider"/> registered in the <see cref="ProviderManager"/>.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
public async Task SignInAsync()
private async void LogoutButton_Click(object sender, RoutedEventArgs e)
{
HideFlyout();
await SignOutAsync();
}

private async void LoadData()
{
if (UserDetails != null || IsLoading)
if (IsLoading)
{
return;
}

var provider = ProviderManager.Instance.GlobalProvider;

if (provider != null)
switch (provider?.State)
{
try
{
case ProviderState.Loading:
IsLoading = true;
await provider.SignInAsync();
break;

if (provider.State == ProviderState.SignedIn)
case ProviderState.SignedIn:
if (UserDetails == null)
{
// TODO: include user details?
LoginCompleted?.Invoke(this, new EventArgs());

LoadData();
await SignInAsync();
}
else

IsLoading = false;
break;

case ProviderState.SignedOut:
if (UserDetails != null)
{
LoginFailed?.Invoke(this, new LoginFailedEventArgs(new TimeoutException("Login did not complete.")));
await SignOutAsync();
}
}
catch (Exception e)
{
LoginFailed?.Invoke(this, new LoginFailedEventArgs(e));
}
finally
{

IsLoading = false;
}
break;
}
}

/// <summary>
/// Log a signed-in user out.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
public async Task SignOutAsync()
private async Task SetUserDetails()
{
// Close Menu
if (FlyoutBase.GetAttachedFlyout(_loginButton) is FlyoutBase flyout)
{
flyout.Hide();
}

if (IsLoading)
{
return;
}

var cargs = new CancelEventArgs();
LogoutInitiated?.Invoke(this, cargs);

if (cargs.Cancel)
{
return;
}

if (UserDetails != null)
{
UserDetails = null;
}
else
{
return; // No-op
}

var provider = ProviderManager.Instance.GlobalProvider;

if (provider != null)
{
IsLoading = true;
await provider.SignOutAsync();
IsLoading = false;

LogoutCompleted?.Invoke(this, new EventArgs());
// https://github.com/microsoftgraph/microsoft-graph-toolkit/blob/master/src/components/mgt-login/mgt-login.ts#L139
// TODO: Batch with photo request later? https://github.com/microsoftgraph/msgraph-sdk-dotnet-core/issues/29
UserDetails = await provider.GetClient().GetMeAsync();
}
}

private void ClearUserDetails()
{
UserDetails = null;
}
}
}
2 changes: 1 addition & 1 deletion CommunityToolkit.Graph.Uwp/Controls/LoginButton/LoginButton.xaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
<StackPanel>
<local:PersonView PersonDetails="{Binding UserDetails, Converter={StaticResource UserToPersonConverter}, RelativeSource={RelativeSource TemplatedParent}}"
PersonViewType="TwoLines" />
<HyperlinkButton x:Name="PART_SignOutButton">
<HyperlinkButton x:Name="PART_LogoutButton">
<TextBlock Text="Sign Out" />
</HyperlinkButton>
</StackPanel>
Expand Down