Why is the GetReservations method not running asynchronously?

Question

Why is the GetReservations method not running asynchronously?

Tom Meier 260

I am having trouble getting the GetReservations method to run asynchronously in my ReservationListingViewModel class in C#. Can someone please help me understand what I'm doing wrong? And I am also having an issue with using _reservations as private readonly. Thanks!

 public class ReservationListingViewModel:ViewModelBase
 {
     private readonly  ObservableCollection<ReservationViewModel> _reservations;

     public IEnumerable<ReservationViewModel>  Reservations => _reservations;

     
     public  ReservationListingViewModel()
     {
         InitializeAsync();

     }
     private async Task InitializeAsync()
     {
         _reservations = await GetReservations();
     }

     public async Task <ObservableCollection<ReservationViewModel>> GetReservations()
     {
         _reservations = new ObservableCollection<ReservationViewModel>();
         for (int i = 0; i < 1000; i++)
         {
             _reservations.Add(new ReservationViewModel(new Reservation("1,2", "Ron" + i, DateTime.Now, DateTime.Now)));
         }
         
         return _reservations;
     }

    

 }

Accepted answer

1 additional answer

Your answer

Answer 1

Anonymous

Hi @Tom Meier , Welcome to Microsoft Q&A,

In C#, you cannot directly call an asynchronous method from a constructor. Constructors do not support the await keyword, which is required to run asynchronous code properly.

A readonly field can only be assigned during the declaration or in a constructor. Since you are trying to assign _reservations in an asynchronous method (InitializeAsync), this violates the readonly constraint.

public class ReservationListingViewModel : ViewModelBase
{
    private ObservableCollection<ReservationViewModel> _reservations;

    public IEnumerable<ReservationViewModel> Reservations => _reservations;

    public ReservationListingViewModel()
    {
        // Initialize asynchronously
        InitializeAsync().ConfigureAwait(false);
    }

    private async Task InitializeAsync()
    {
        _reservations = await GetReservations();
    }

    public async Task<ObservableCollection<ReservationViewModel>> GetReservations()
    {
        var reservations = new ObservableCollection<ReservationViewModel>();
        for (int i = 0; i < 1000; i++)
        {
            reservations.Add(new ReservationViewModel(new Reservation("1,2", "Ron" + i, DateTime.Now, DateTime.Now)));
        }

        return reservations;
    }
}

Best Regards,

Jiale

If the answer is the right solution, please click "Accept Answer" and kindly upvote it. If you have extra questions about this answer, please click "Comment".

Note: Please follow the steps in our documentation to enable e-mail notifications if you want to receive the related email notification for this thread.

Tom Meier 260 Reputation points

2024-05-21T14:13:54.7166667+00:00

@Anonymous Thanks for your help but for some reason there is something still blocking that thread from running asyncronously. This seems like something that would have been done before but Im having difficulty finding a similiar example.
Tom Meier 260 Reputation points

2024-05-21T14:24:28.33+00:00

@Anonymous Thanks for your help but there is still some thread blocking
Bruce (SqlWork.com) 78,086 Reputation points Volunteer Moderator

2024-05-21T17:06:10.4966667+00:00
it a design error to have async code in the constructor. you should have a public async init called after the constructor, or convert to the factory pattern and have an async create:

// call init after construction: var model = new await model.InitialAsync(); // use factory var model = await ReservationListingViewModel.CreateAsync();
Tom Meier 260 Reputation points

2024-05-21T18:21:05.26+00:00

@Bruce (SqlWork.com) Thanks for keeping in mind that I am not a Senior Developer, but I was wondering will that code you just shared go into the constructor? Thanks ! This seems like an awful lot of code to await a for loop until its finished.

Bruce (SqlWork.com) 78,086 Volunteer Moderator

you don't need anything in the constructor. taking your original code:

 public class ReservationListingViewModel:ViewModelBase
 {
     private readonly ObservableCollection<ReservationViewModel> _reservations = new();
     public IEnumerable<ReservationViewModel> Reservations => _reservations;
     
     public  ReservationListingViewModel()
     {
     }

     public Task InitialAsync() => GetReservations();

     // not sure why this is async, as it has no async code
     public async Task <ObservableCollection<ReservationViewModel>> GetReservations()
     {
         _reservations.Clear();
         for (int i = 0; i < 1000; i++)
         {
             _reservations.Add(new ReservationViewModel(new Reservation("1,2", "Ron" + i, DateTime.Now, DateTime.Now)));
         }
         
         return _reservations;
     }

     public static async Task<ReservationListingViewModel> CreateAsync()
     {
         var r = new ReservationListingViewModel();
         await r.InitialAsync();
         return r;
     }
 }

then to use:

var r1 = new ReservationListingViewModel()
await r1.InitialAsync();

var r2 = await ReservationListingViewModel.CreateAsync();

Tom Meier 260 Reputation points

2024-05-21T22:27:23.9433333+00:00

@Bruce (SqlWork.com) what does then to use: mean? Anyway, none of it works. It's hard for me to believe I have to write this much code just for this small functionality.
Anonymous

2024-05-22T09:35:37.2266667+00:00

Then to use: means you can call it like that. You have to follow the rules of the programming language,
Tom Meier 260 Reputation points

2024-05-22T13:49:02.1066667+00:00

@Anonymous where do I put these statements?
var r1 = new ReservationListingViewModel()
await r1.InitialAsync();
var r2 = await ReservationListingViewModel.CreateAsync();

Anonymous

Hi @Tom Meier , You need to use this in your main function.

Assuming you initialize the ViewModel in MainWindow, you can do this:


public partial class MainWindow : Window

{

     public MainWindow()

     {

         InitializeComponent();

         InitializeViewModel();

     }

     private async void InitializeViewModel()

     {

         // Use the first method

         var r1 = new ReservationListingViewModel();

         await r1.InitialAsync();

         this.DataContext = r1;

         // Or use the second method

         var r2 = await ReservationListingViewModel.CreateAsync();

         this.DataContext = r2;

     }

}

Answer 2

I see a couple of problems.

C# does not support async constructor calls. Therefore calls made in a constructor (ctor) must be sync. This is by design. If InitializeAsync is only called here then there is no reason to make it async because that isn't supported. You must wait for the async call to complete before the ctor returns. Since you're using an ObservableCollection then this is fine because when the collection is eventually populated then the UX will get notified anyway.

public  ReservationListingViewModel()
{
   //This must be called sync, C# doesn't support async ctor calls
   InitializeAsync().GetAwaiter().Wait();
}

Note however that if the method throws an exception then it'll be wrapped in AggregateException which is confusing in a ctor call so you might need to wrap the call in a handler. Calling async methods synchronously is generally not recommended.

GetReservations is creating a new object and storing it in the field that the class is using. So as soon as the call starts you just stomped over your previous values. The InitializeAsync method technically does nothing. It takes the return value of the method (which is the value of _reservations) and stores it back into itself. Your GetReservations method should create and store the new collection in a temp variable. Then return the temp variable from the method. The InitializeAsync method can then assign it to the field, optionally after it does any post retrieval work.
_reservations is readonly. That means its value can only be set in the constructor, not any other method. So the assignment in IntializeAsync (and GetReservations) is not allowed. In general fields should be readonly if they shouldn't change. In this case you're changing a field after creation so it cannot be readonly. Remove the modifier. In general it is not a good idea to wipe a field after you've set it up since anyone watching that original value would miss the changes. Since you're using IEnumerable here that isn't an issue but if you were to ever switch the property to ObservableCollection so you actually gain the benefit of using that type then code tied to the original field won't suddenly recognize a new field because they are using the original value instead.

So rather than creating a new observable collection each time, you should create it readonly, get the new values and then clear the original collection and add the new values in. Something like this perhaps.

public async Task InitializeAsync ()
{
   var newItems = await GetReservations();

   //Clear original values
   _reservations.Clear();
   foreach (var item in newItems)
      _reservations.Add(item);
}

Note that this is going to trigger a lot of change notifications so you might want to "disable" any UX updates until you're done.

Tom Meier 260 Reputation points

2024-05-20T19:51:12+00:00

@Michael Taylor where is newItems being populated at?

Share via

Why is the GetReservations method not running asynchronously?

1 additional answer

Your answer