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.

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

adding queryable extensions to DataServiceQuery<T> #2475

Open
wants to merge 1 commit into
base: release-7.x
Choose a base branch
from

Conversation

corranrogue9
Copy link
Contributor

Issues

This pull request fixes #2409.

Description

From the issue, when a DataServiceQuery<T> is used as an IQueryable<T> for LINQ queries, the returned object is IQueryable<T>. This means that it cannot be passed to DataServiceContext.ExecuteBatch. To facilitate this, we will now have custom extension methods for DataServiceQuery<T> which are analogs to those extensions on IQueryable<T>, except they return DataServiceQuery<T> variants. This will allow them to still be used in DataServiceContext.ExecuteBatch. An explanation of the options discussed can be found here.

@pull-request-quantifier-deprecated

This PR has 881 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

Label      : Extra Large
Size       : +881 -0
Percentile : 96.03%

Total files changed: 9

Change summary by file extension:
.cs : +244 -0
.txt : +52 -0
.vb : +153 -0
.bsl : +432 -0

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detected.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.


Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

@@ -0,0 +1,1035 @@
//---------------------------------------------------------------------
// <copyright file="DataServiceQueryOfT.cs" company="Microsoft">
Copy link
Member

Choose a reason for hiding this comment

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

DataServiceQueryOfT

update

/// Extension methods for <see cref="IOrderedQueryable{T}"/>
/// </summary>
/// <threadsafety static="true"/>
public static class OrderedQueryableExtensions
Copy link
Member

Choose a reason for hiding this comment

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

any reason why do we add this in the Microsoft.Spatial project.

Copy link
Contributor

Choose a reason for hiding this comment

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

+1

@xuzhg
Copy link
Member

xuzhg commented Aug 9, 2022

namespace Microsoft.Spatial

copyright


Refers to: src/Microsoft.Spatial/OrderedQueryableExtensions.cs:1 in 9ff29b2. [](commit_id = 9ff29b2, deletion_comment = False)

[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static IOrderedQueryable<T> AsOrderedQueryable<T>(this IOrderedQueryable<T> queryable)
{
return queryable;
Copy link
Member

Choose a reason for hiding this comment

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

return queryable;

just returns the input? do nothing

public static IQueryable<T> AsQueryable<T>(this IQueryable<T> queryable)
{
return queryable;
}
Copy link
Member

Choose a reason for hiding this comment

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

any reason why do we add this in the Microsoft.Spatial project.

@@ -0,0 +1,24 @@
namespace Microsoft.Spatial
{
Copy link
Member

Choose a reason for hiding this comment

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

copyright

Copy link
Contributor

@KenitoInc KenitoInc left a comment

Choose a reason for hiding this comment

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

Can we have some unit or E2E tests on how these extensions can be used. E.g in ExecuteBatch as described in the issue.

/// Extension methods for <see cref="IOrderedQueryable{T}"/>
/// </summary>
/// <threadsafety static="true"/>
public static class OrderedQueryableExtensions
Copy link
Contributor

Choose a reason for hiding this comment

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

+1

@@ -0,0 +1,1035 @@
//---------------------------------------------------------------------
// <copyright file="DataServiceQueryOfT.cs" company="Microsoft">
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
// <copyright file="DataServiceQueryOfT.cs" company="Microsoft">
// <copyright file="DataServiceQueryExtensions.cs" company="Microsoft">

using System.Collections.Generic;
using System.Linq;
using System.Linq.Expressions;

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change

using System.Linq;
using System.Linq.Expressions;

using Microsoft.Spatial;
Copy link
Contributor

Choose a reason for hiding this comment

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

We shouldn't be having extensions in the spatial project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

client: batch + linq not working
3 participants