ChallengeModifying execution approaches

time to read 5 min | 968 words

In RavenDB, we had this piece of code:

internal T[] LoadInternal<T>(string[] ids, string[] includes)
        {
            if(ids.Length == 0)
                return new T[0];

            IncrementRequestCount();
            Debug.WriteLine(string.Format("Bulk loading ids [{0}] from {1}", string.Join(", ", ids), StoreIdentifier));
            MultiLoadResult multiLoadResult;
            JsonDocument[] includeResults;
            JsonDocument[] results;
#if !SILVERLIGHT
            var sp = Stopwatch.StartNew();
#else
            var startTime = DateTime.Now;
#endif
            bool firstRequest = true;
            do
            {
                IDisposable disposable = null;
                if (firstRequest == false) // if this is a repeated request, we mustn't use the cached result, but have to re-query the server
                    disposable = DatabaseCommands.DisableAllCaching();
                using (disposable)
                    multiLoadResult = DatabaseCommands.Get(ids, includes);

                firstRequest = false;
                includeResults = SerializationHelper.RavenJObjectsToJsonDocuments(multiLoadResult.Includes).ToArray();
                results = SerializationHelper.RavenJObjectsToJsonDocuments(multiLoadResult.Results).ToArray();
            } while (
                AllowNonAuthoritiveInformation == false &&
                results.Any(x => x.NonAuthoritiveInformation ?? false) &&
#if !SILVERLIGHT
                sp.Elapsed < NonAuthoritiveInformationTimeout
#else 
                (DateTime.Now - startTime) < NonAuthoritiveInformationTimeout
#endif
                );

            foreach (var include in includeResults)
            {
                TrackEntity<object>(include);
            }

            return results
                .Select(TrackEntity<T>)
                .ToArray();
        }

And we needed to take this same piece of code and execute it in:

  • Async fashion
  • As part of a batch of queries (sending multiple requests to RavenDB in a single HTTP call).

Everything else is the same, but in each case the marked line is completely different.

When we had only one additional option, I choose the direct approach, and implement it using;

public Task<T[]> LoadAsync<T>(string[] ids)
{
    IncrementRequestCount();
    return AsyncDatabaseCommands.MultiGetAsync(ids)
        .ContinueWith(task => task.Result.Select(TrackEntity<T>).ToArray());
}

You might notice a few differences between those approaches. The implementation behave, most of the time, the same, but all the behavior for edge cases is wrong. The reason for that, by the way, is that initially the Load and LoadAsync impl was functionality the same, but the Load behavior kept getting more sophisticated, and I kept forgetting to also update the LoadAsync behavior.

When I started building support for batches, this really stumped me. The last thing that I wanted to do is to either try to maintain complex logic in three different location or have different behaviors depending if you were using a direct call, a batch or async call. Just trying to document that gave me a headache.

How would you approach solving this problem?

More posts in "Challenge" series:

  1. (19 Jan 2017) What does this code do?
  2. (26 Jul 2016) The race condition in the TCP stack, answer
  3. (25 Jul 2016) The race condition in the TCP stack
  4. (28 Apr 2015) What is the meaning of this change?
  5. (26 Sep 2013) Spot the bug
  6. (27 May 2013) The problem of locking down tasks…
  7. (17 Oct 2011) Minimum number of round trips
  8. (23 Aug 2011) Recent Comments with Future Posts
  9. (02 Aug 2011) Modifying execution approaches
  10. (29 Apr 2011) Stop the leaks
  11. (23 Dec 2010) This code should never hit production
  12. (17 Dec 2010) Your own ThreadLocal
  13. (03 Dec 2010) Querying relative information with RavenDB
  14. (29 Jun 2010) Find the bug
  15. (23 Jun 2010) Dynamically dynamic
  16. (28 Apr 2010) What killed the application?
  17. (19 Mar 2010) What does this code do?
  18. (04 Mar 2010) Robust enumeration over external code
  19. (16 Feb 2010) Premature optimization, and all of that…
  20. (12 Feb 2010) Efficient querying
  21. (10 Feb 2010) Find the resource leak
  22. (21 Oct 2009) Can you spot the bug?
  23. (18 Oct 2009) Why is this wrong?
  24. (17 Oct 2009) Write the check in comment
  25. (15 Sep 2009) NH Prof Exporting Reports
  26. (02 Sep 2009) The lazy loaded inheritance many to one association OR/M conundrum
  27. (01 Sep 2009) Why isn’t select broken?
  28. (06 Aug 2009) Find the bug fixes
  29. (26 May 2009) Find the bug
  30. (14 May 2009) multi threaded test failure
  31. (11 May 2009) The regex that doesn’t match
  32. (24 Mar 2009) probability based selection
  33. (13 Mar 2009) C# Rewriting
  34. (18 Feb 2009) write a self extracting program
  35. (04 Sep 2008) Don't stop with the first DSL abstraction
  36. (02 Aug 2008) What is the problem?
  37. (28 Jul 2008) What does this code do?
  38. (26 Jul 2008) Find the bug fix
  39. (05 Jul 2008) Find the deadlock
  40. (03 Jul 2008) Find the bug
  41. (02 Jul 2008) What is wrong with this code
  42. (05 Jun 2008) why did the tests fail?
  43. (27 May 2008) Striving for better syntax
  44. (13 Apr 2008) calling generics without the generic type
  45. (12 Apr 2008) The directory tree
  46. (24 Mar 2008) Find the version
  47. (21 Jan 2008) Strongly typing weakly typed code
  48. (28 Jun 2007) Windsor Null Object Dependency Facility