Fix SimulatedTemperatureSensor Module Status Issues on Stop command

[sush-101]

Issue description:
Expected Behavior
When changing the module status from Running to Stopped via the Azure portal, the module on the device should stop successfully.

Actual Behavior
After setting the module to Stopped, running sudo iotedge list shows the SimulatedTemperatureSensor module in a Failed (139) state instead of Stopped.

Fix:
This pull request addresses the issues causing the SimulatedTemperatureSensor module to fail with exit code 139 when it receives a stop command from the Azure portal. The fixes involve handling task cancellation exceptions and adding a delay to ensure a graceful shutdown.

Initially, the SimulatedTemperatureSensor module encountered exit code 139 due to improper handling of task cancellations, leading to a segmentation fault. To address this, handling for TaskCanceledException was added in the SendEvents method to log a message when the task is canceled.

Additionally, a 2-second delay was added upon receiving the SIGTERM signal from Docker to ensure proper time is given for a graceful shutdown. This delay allows the module to complete any ongoing operations and release resources properly before shutting down.

Changes made:

• Added handling for TaskCanceledException in the SendEvents method to log a message when the task is canceled.
• Added a 2-second delay upon receiving the SIGTERM signal from Docker to ensure proper time for graceful shutdown.
• Updated ShutdownHandler to include the delay for ensuring all operations complete gracefully before shutdown.

These changes address the issues causing the SimulatedTemperatureSensor module to fail with exit codes 139 and 143, ensuring the module transitions to the stopped state correctly.

Azure IoT Edge PR checklist:

This checklist is used to make sure that common guidelines for a pull request are followed.

General Guidelines and Best Practices

• I have read the contribution guidelines.
• Title of the pull request is clear and informative.
• Description of the pull request includes a concise summary of the enhancement or bug fix.

Testing Guidelines

• Pull request includes test coverage for the included changes.
• Description of the pull request includes
  • concise summary of tests added/modified
  • local testing done.

Draft PRs

• Open the PR in Draft mode if it is:
  • Work in progress or not intended to be merged.
  • Encountering multiple pipeline failures and working on fixes.

Note: We use the kodiakhq bot to merge PRs once the necessary checks and approvals are in place. When it merges a PR, kodiakhq converts the PR title to the commit title, PR description to the commit description, and squashes all the commits in the PR to a single commit. The net effect is that entire PR becomes a single commit. Please follow the best practices mentioned here for the PR title and description

[sush-101]

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

[sush-101]

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

…

On Mon, 3 Feb 2025 at 4:23 PM, microsoft-github-policy-service[bot] < ***@***.***> wrote: @sush-101 <https://github.com/sush-101> 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 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.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 GitHub <#7420 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AOG3LXBEBVAASO56ZJIT2ID2N5DBBAVCNFSM6AAAAABWLZJY4CVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMMZQGYYDCNZSGA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[abaranwal-ms]

nit: can we add a simple comment, explaining - why wait

[sush-101]

Thanks, added a comment.

[arpit-ag]

do we really need this to be debug level. If added for debugging purpose, then we should remove it.

[sush-101]

Changed the level to info.

[arpit-ag]

seems this change is a code re-arrangement, is it intentional? If not, would suggest to only keep the actual changes in PR for batter change review.

[sush-101]

Done

[damonbarry]

Should the Console.Writeline calls be converted to logger.LogInformation/LogWarning/LogError/etc. calls since you added the logger?

[damonbarry]

This shutdown handler is used by all our modules, not just tempSensor--we should carefully consider whether we want to add this behavior to all our modules. Also, a two-second fixed delay isn't guaranteed to solve the problem; on slower devices like Raspberry Pi, for example, it might not be enough time.

It should be the responsibility of completed.Wait(shutdownWaitPeriod) to provide enough time for operations to complete and resources to shut down. Have you looked into why this call isn't sufficient for tempSensor? Maybe tempSensor-specific shutdown code is doing something wrong? Or did you add this delay "just in case"?