Add DependsOnId on Add Related Object API

[DButoyez]

Issues

This pull request fixes ##3056

Description

This change request aims to add support for dependsOnID to the AddRelatedObject API in order to enable saving an object using SaveChangesOptions.BatchWithSingleChangeset | SaveChangesOptions.UseJsonBatch.

Checklist (Uncheck if it is not completed)

• Test cases added
• Build and test with one-click build and test script passed

Additional work necessary

If documentation update is needed, please add "Docs Needed" label to the issue and provide details about the required document change in the issue.

[microsoft-github-policy-service]

@DButoyez please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

• (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

@microsoft-github-policy-service agree

• (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ),
and conveys certain license rights to the .NET Foundation ( “.NET Foundation” ) for Your contributions to
.NET Foundation open source projects. This Agreement is effective as of the latest signature date below.

1. Definitions.

“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to .NET Foundation under this Agreement.

“Project” means any of the projects owned or managed by .NET Foundation and offered under a license
approved by the Open Source Initiative (www.opensource.org).

“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”

“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.

2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.

3. Originality of Work. You represent that each of Your Submissions is entirely Your
original work. Should You wish to Submit materials that are not Your original work,
You may Submit them separately to the Project if You (a) retain all copyright and
license information that was in the materials as you received them, (b) in the
description accompanying your Submission, include the phrase "Submission
containing materials of a third party:" followed by the names of the third party and any
licenses or other restrictions of which You are aware, and (c) follow any other
instructions in the Project's written guidelines concerning Submissions.

4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.

5. Licenses.

a. Copyright License. You grant .NET Foundation, and those who receive the Submission directly
or indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable
license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform,
and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing
rights to third parties.

b. Patent License. You grant .NET Foundation, and those who receive the Submission directly or
indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license
under Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.

c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3 ). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6 , THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.

7. Notice to .NET Foundation. You agree to notify .NET Foundation in writing of any facts or
circumstances of which You later become aware that would make Your representations in this
Agreement inaccurate in any respect.

8. Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.

9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.

10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by .NET Foundation.

.NET Foundation dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1.

[gathogojr]

Suggested change

	Assert.Equal(201, (response.First() as ChangeOperationResponse).StatusCode);
	Assert.Equal(201, (response.Last() as ChangeOperationResponse).StatusCode);
	Assert.Equal(201, Assert.IsType<ChangeOperationResponse>(response.First()).StatusCode);
	Assert.Equal(201, Assert.IsType<ChangeOperationResponse>(response.Last()).StatusCode);

• safer - avoid NullReferenceException in your test
• neater

[gathogojr]

I addition, I suggest you add an assert statement above the two statements to verify that result has at least two elements, otherwise .First() can also be the .Last(). We want to confirm that both POST requests for Bank and BankAccount happened

[gathogojr]

Verified that the payload looks good:

{
  "requests": [
    {
      "id": "1",
      "atomicityGroup": "22d9a80c-30e8-4546-9ac8-1f2c4c5369fa",
      "method": "POST",
      "url": "http://localhost/odata/Banks",
      "headers": {
        "odata-version": "4.0",
        "odata-maxversion": "4.0",
        "content-type": "application/json;odata.metadata=minimal",
        "accept": "application/json;odata.metadata=minimal",
        "accept-charset": "UTF-8",
        "user-agent": "Microsoft.OData.Client/8.0.1"
      },
      "body": {
        "Id": 45,
        "Location": "KE",
        "Name": "Test Bank"
      }
    },
    {
      "id": "2",
      "atomicityGroup": "22d9a80c-30e8-4546-9ac8-1f2c4c5369fa",
      "dependsOn": [
        "1"
      ],
      "method": "POST",
      "url": "http://localhost/odata/$1/BankAccounts",
      "headers": {
        "odata-version": "4.0",
        "odata-maxversion": "4.0",
        "content-type": "application/json;odata.metadata=minimal",
        "accept": "application/json;odata.metadata=minimal",
        "accept-charset": "UTF-8",
        "user-agent": "Microsoft.OData.Client/8.0.1"
      },
      "body": {
        "AccountNumber": "4567890",
        "BankId": 45,
        "Id": 890
      }
    }
  ]
}

[gathogojr]

The DataServiceContext generated by OData Connected Service would contain methods with the following signatures:

public virtual void AddToBanks(Bank bank)
{
    base.AddObject("Banks", bank);
}

public virtual void AddToBankAccounts(BankAccount bankAccount)
{
    base.AddObject("BankAccounts", bankAccount);
}

The [more common]/alternative way that people accomplish this that doesn't involve calling AddObject and AddRelatedObject directly is the following:

var bank = new Bank { /***/ };
var bankAccount = new BankAccount { /***/ };

_context.AddToBanks(bank);
_context.AddToBankAccounts(bankAccount);

// THEN
_context.AddLink(source: bank, sourceProperty: "BankAccounts", target: bankAccount); // Where "sourceProperty" MUST be a collection-valued navigation property

// Or

_context.SetLink(source: bankAccount, sourceProperty: "Bank", target: bank); // Where "sourceProperty" MUST be a single-valued navigation property

You may want to add another test that does things this way to confirm that it works as expected.

[DButoyez]

This might not work as the change is mostly geared towards the AddRelatedObject for the AddLink and SetLink APIs we would need to also implement a fix for them.

[gathogojr]

@DButoyez Did you try it out?

[gathogojr]

You might be surprised to find that they work as expected. But you'd only know for certain if you tried it out practically

[DButoyez]

The AddLink method doesn't automatically populate the dependsOnID on the targert resource a similar change will have to be made:

I have replicated using the below code and I'm getting the dependsOnID exception:
Request Id reference [1] in Uri [$1/BankAccounts/$ref] is not found in effective depends-on-Ids [] of the request

public async Task JsonBatchSequencingSingeChangeSetTestAddLink()
{
    // Create new BankAccounts object
    var bank = new Bank
    {
        Id = 45,
        Name = "Test Bank",
        Location = "KE",
        BankAccounts = new List<BankAccount>()
    };

    // Create new BankAccount object
    var bankAccount = new BankAccount
    {
        Id = 890,
        AccountNumber = "4567890",
        BankId = bank.Id,
        Bank = bank
    };

    _context.AddObject("Banks", bank);
    _context.AddObject("BankAccounts", bankAccount);

    // THEN
    _context.AddLink(source: bank, sourceProperty: "BankAccounts", target: bankAccount);

    // Save both entities in a single batch request using JSON
    var response = await _context.SaveChangesAsync(SaveChangesOptions.BatchWithSingleChangeset | SaveChangesOptions.UseJsonBatch);
    Assert.Equal(2, response.Count());

    var bankResponse = response.First() as ChangeOperationResponse;
    var bankAccountResponse = response.Last() as ChangeOperationResponse;

    Assert.NotNull(bankResponse);
    Assert.NotNull(bankAccountResponse);

    Assert.Equal(201, bankResponse.StatusCode);
    Assert.Equal(201, bankAccountResponse.StatusCode);
}