coap-gateway: Fixing device status to offline when the access token expires

[jkralik]

Summary by CodeRabbit

• Tests
  • Enhanced testing for device status updates with respect to access token expiration.
• Bug Fixes
  • Improved handling of device sign-in when access token is close to expiration, ensuring devices can sign off properly before token expiration.

[coderabbitai]

Walkthrough

The recent modifications focus on enhancing the device status update mechanism within a CoAP gateway service. A significant update includes the introduction of a wait duration for better handling of OAuth server shutdowns and token expiration scenarios. Additionally, test functions have been renamed and adjusted to accommodate the new delay parameter, and a new test ensures proper behavior when access tokens are nearing expiration. The signIn logic has also been refined to prevent device sign-in issues related to token validity.

Changes

Files	Change Summaries
.../service/devicesStatusUpdater_test.go	Added wait parameter to onboardDeviceAndGetDevice, renamed test functions for clarity, and introduced a new test for expiring tokens.
coap-gateway/service/signIn.go	Updated getSignInDataFromClaims to handle token expiration more gracefully by adjusting validUntil and error handling.

🐇✨
In the realm of code, where the bytes roam free,
A rabbit hopped in, with changes to see.
With a wait and a tick, it refined the flow,
Ensuring devices, their status would show.
"Fear not the expiration," it whispered with glee,
"For I've made the tokens as smart as can be!"
🌟🐾

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 5a5b13d and dbec41d.

Files selected for processing (2)

• coap-gateway/service/devicesStatusUpdater_test.go (5 hunks)
• coap-gateway/service/signIn.go (1 hunks)

Additional comments: 6

coap-gateway/service/devicesStatusUpdater_test.go (5)

• 31-31: The addition of the wait time.Duration parameter to the onboardDeviceAndGetDevice function is a significant change. It allows for more precise control over the simulation of access token expiration scenarios in tests. This change enhances the testing framework's ability to mimic real-world conditions more accurately.
• 49-55: The logic for shutting down the OAuth server, waiting for a specified duration, and then restarting it is a clever way to simulate the expiration of access tokens in a controlled environment. This approach ensures that the tests can accurately assess the system's behavior in scenarios where access tokens are about to expire.
• 69-80: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [77-86]

Renaming the test function to TestDevicesStatusAccessTokenHasNoExpiration and adjusting the call to onboardDeviceAndGetDevice to include the wait duration parameter improves the clarity and specificity of the test. It makes it evident that this test is focused on scenarios where access tokens do not have an expiration time.

• 97-121: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [91-102]

Similarly, renaming the test function to TestDevicesStatusAccessTokenHasExpiration and adjusting the call to include the wait duration parameter clarifies the intent of the test. It focuses on scenarios where access tokens have an expiration time, allowing for a more targeted assessment of the system's behavior.

• 107-120: The addition of the TestDevicesStatusAccessTokenHasExpirationAndTokenWillExpire test function is a valuable enhancement to the test suite. It specifically targets scenarios where access tokens are on the verge of expiring, providing a critical assessment of the system's ability to handle such situations effectively.

coap-gateway/service/signIn.go (1)

• 232-236: The updated logic in getSignInDataFromClaims for calculating validUntil based on the access token's expiration time is a critical improvement. It proactively identifies situations where the remaining validity of an access token is insufficient, thereby preventing potential issues related to abrupt device disconnections. This change enhances the system's reliability by ensuring that devices are prompted to sign off in a timely manner before their access tokens expire.

[sonarqubecloud]

Quality Gate failed

Failed conditions
66.7% Coverage on New Code (required ≥ 75%)

See analysis details on SonarCloud