search

Azure / azure-sdk-for-c

This repository is for active development of the Azure SDK for Embedded C. For consumers of the SDK we recommend visiting our versioned developer docs at https://azure.github.io/azure-sdk-for-c.
MIT License
224 stars 120 forks source link

Missing the "stepResults" in "lastInstallresult" of device twin json. #2701

Closed lillianxu-eaton closed 9 months ago

lillianxu-eaton commented 9 months ago

It causes the deployment status shows "Failed" on second OTA trial.

github-actions[bot] commented 9 months ago

Thank you for your contribution @lillianxu-eaton! We will review the pull request and get back to you soon.

lillianxu-eaton commented 9 months ago

Hi,

Second option is chosen for this contribution. Company = "Eaton Corporation"

Feel free to reach out to me if I could provide additional information.

Thanks Lillian Xu

From: microsoft-github-policy-service[bot] @.> Sent: Wednesday, November 29, 2023 10:05 AM To: Azure/azure-sdk-for-c @.> Cc: Xu, Lillian @.>; Mention @.> Subject: [EXTERNAL] Re: [Azure/azure-sdk-for-c] Missing the "stepResults" in "lastInstallresult" of device twin json. (PR #2701)

@lillianxu-eatonhttps://github.com/lillianxu-eaton 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:

@microsoft-github-policy-service agree

@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 Microsoft Corporation and its affiliates ("Microsoft") for Your contributions to Microsoft 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 Microsoft under this Agreement. "Project" means any of the projects owned or managed by Microsoft and offered under a license approved by the Open Source Initiative (www.opensource.orghttp://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.

    • Copyright License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, 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.
    • Patent License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, 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.
    • 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 Microsoft. You agree to notify Microsoft 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 Microsoft.

- Reply to this email directly, view it on GitHubhttps://github.com/Azure/azure-sdk-for-c/pull/2701#issuecomment-1832072062, or unsubscribehttps://github.com/notifications/unsubscribe-auth/A2MODZWE62LTVLLBWXE4TX3YG5FK5AVCNFSM6AAAAAA77T4VTSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMZSGA3TEMBWGI. You are receiving this because you were mentioned.Message ID: @.**@.>>

lillianxu-eaton commented 9 months ago

@microsoft-github-policy-service agree company="Eaton Corporation"

From: microsoft-github-policy-service[bot] @.> Sent: Thursday, November 30, 2023 9:10 AM To: Azure/azure-sdk-for-c @.> Cc: Xu, Lillian @.>; Mention @.> Subject: [EXTERNAL] Re: [Azure/azure-sdk-for-c] Missing the "stepResults" in "lastInstallresult" of device twin json. (PR #2701)

@lillianxu-eatonhttps://github.com/lillianxu-eaton the command you issued was incorrect. Please try again.

Examples are:

@microsoft-github-policy-service agree

and

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

- Reply to this email directly, view it on GitHubhttps://github.com/Azure/azure-sdk-for-c/pull/2701#issuecomment-1833853511, or unsubscribehttps://github.com/notifications/unsubscribe-auth/A2MODZSQMWSNKTTEMRYWMKLYHCHVHAVCNFSM6AAAAAA77T4VTSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMZTHA2TGNJRGE. You are receiving this because you were mentioned.Message ID: @.**@.>>

lillianxu-eaton commented 9 months ago

Hi Valerie,

The Microsoft team advised us that the device twin should be below.

Here is how it should look:

                "lastInstallResult": {
                    "extendedResultCode": 0,
                    "resultCode": 0,
                    "resultDetails": "Success",
                    "stepResults": {
                        "step_0": {
                            "extendedResultCode": 0,
                            "resultCode": 0
                        }
                    }
                },

Therefore, the part below is removed. Otherwise, the buffer will be overflowed and the device will be reset.

@.***

Thanks

Lillian

From: Valerie Avva Lim @.> Sent: Monday, December 4, 2023 7:18 PM To: Azure/azure-sdk-for-c @.> Cc: Xu, Lillian @.>; Mention @.> Subject: [EXTERNAL] Re: [Azure/azure-sdk-for-c] Missing the "stepResults" in "lastInstallresult" of device twin json. (PR #2701)

@vaavva commented on this pull request.

In sdk/src/azure/iot/az_iot_adu_client.chttps://github.com/Azure/azure-sdk-for-c/pull/2701#discussion_r1414687396:

@@ -279,20 +284,11 @@ AZ_NODISCARD az_result az_iot_adu_client_get_agent_state_payload(

   _az_RETURN_IF_FAILED(az_json_writer_append_int32(

       ref_json_writer, last_install_result->step_results[i].extended_result_code));

Why would this section for the result details be removed?

- Reply to this email directly, view it on GitHubhttps://github.com/Azure/azure-sdk-for-c/pull/2701#pullrequestreview-1763688441, or unsubscribehttps://github.com/notifications/unsubscribe-auth/A2MODZXOQVVLRXVWPMUDMO3YHZR3HAVCNFSM6AAAAAA77T4VTSVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMYTONRTGY4DQNBUGE. You are receiving this because you were mentioned.Message ID: @.**@.>>

ericwolz commented 9 months ago

@lillianxu-eaton

Therefore, the part below is removed. Otherwise, the buffer will be overflowed and the device will be reset.

Can you provide more details on this? Buffer overflows should be checked by the json_writer APIs.

Is there a callstack for when this happens?

lillianxu-eaton commented 9 months ago

Hi Eric,

There should be only two items in the step_0. @.***

But the part below will add the "resultDetails" to device twin. Please see the screenshot below. This causes the device reset.

@.***

@.***

From: Eric Wolz @.> Sent: Tuesday, December 5, 2023 2:34 PM To: Azure/azure-sdk-for-c @.> Cc: Xu, Lillian @.>; Mention @.> Subject: [EXTERNAL] Re: [Azure/azure-sdk-for-c] Missing the "stepResults" in "lastInstallresult" of device twin json. (PR #2701)

You don't often get email from @.**@.>. Learn why this is importanthttps://aka.ms/LearnAboutSenderIdentification

@lillianxu-eatonhttps://github.com/lillianxu-eaton

Therefore, the part below is removed. Otherwise, the buffer will be overflowed and the device will be reset.

Can you provide more details on this? Buffer overflows should be checked by the json_writer APIs.

Is there a callstack for when this happens?

- Reply to this email directly, view it on GitHubhttps://github.com/Azure/azure-sdk-for-c/pull/2701#issuecomment-1841492171, or unsubscribehttps://github.com/notifications/unsubscribe-auth/A2MODZSFNL3VJE5ONLFIR5TYH5ZJ3AVCNFSM6AAAAAA77T4VTSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQNBRGQ4TEMJXGE. You are receiving this because you were mentioned.Message ID: @.**@.>>

lillianxu-eaton commented 9 months ago

Hi Eric,

I reviewed the code and the resultDetails is in the step_result structure. See below screenshot for details. @.***

The "result_details" in both "lastInstallResult" and "stepResults" are set to string "Success" after the firmware is updated successfully. Could you please advise any potential issues?

Thanks

Lillian

From: Xu, Lillian Sent: Tuesday, December 5, 2023 3:14 PM To: Azure/azure-sdk-for-c @.>; Azure/azure-sdk-for-c @.> Cc: Mention @.***> Subject: RE: [EXTERNAL] Re: [Azure/azure-sdk-for-c] Missing the "stepResults" in "lastInstallresult" of device twin json. (PR #2701)

Hi Eric,

There should be only two items in the step_0. @.***

But the part below will add the "resultDetails" to device twin. Please see the screenshot below. This causes the device reset.

@.***

@.***

From: Eric Wolz @.**@.>> Sent: Tuesday, December 5, 2023 2:34 PM To: Azure/azure-sdk-for-c @.**@.>> Cc: Xu, Lillian @.**@.>>; Mention @.**@.>> Subject: [EXTERNAL] Re: [Azure/azure-sdk-for-c] Missing the "stepResults" in "lastInstallresult" of device twin json. (PR #2701)

You don't often get email from @.**@.>. Learn why this is importanthttps://aka.ms/LearnAboutSenderIdentification

@lillianxu-eatonhttps://github.com/lillianxu-eaton

Therefore, the part below is removed. Otherwise, the buffer will be overflowed and the device will be reset.

Can you provide more details on this? Buffer overflows should be checked by the json_writer APIs.

Is there a callstack for when this happens?

- Reply to this email directly, view it on GitHubhttps://github.com/Azure/azure-sdk-for-c/pull/2701#issuecomment-1841492171, or unsubscribehttps://github.com/notifications/unsubscribe-auth/A2MODZSFNL3VJE5ONLFIR5TYH5ZJ3AVCNFSM6AAAAAA77T4VTSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQNBRGQ4TEMJXGE. You are receiving this because you were mentioned.Message ID: @.**@.>>

vaavva commented 9 months ago

@lillianxu-eaton The screenshots don't appear to have been attached - please try to attach them again from the github website instead of replying through email

I have confirmed that result details should still be included, as seen in this documentation: https://learn.microsoft.com/en-us/azure/iot-hub-device-update/device-update-plug-and-play#agent-metadata

If you're running into a buffer overflow, have you tried increasing the size of the buffer passed in to AzureIoTADUClient_SendAgentState?

vaavva commented 9 months ago

@lillianxu-eaton I have opened a separate pull request (https://github.com/Azure/azure-sdk-for-c/pull/2708) to include the necessary testing changes and align with the documented format. Please let me know if you have issues with the fix in that PR after increasing your buffer size.