Skip to content

azurerm_eventhub - fix perpetual diff with message_retention#30169

Merged
mbfrahry merged 4 commits intohashicorp:mainfrom
jiaweitao001:fix_eventhub_retention_bug
Jul 21, 2025
Merged

azurerm_eventhub - fix perpetual diff with message_retention#30169
mbfrahry merged 4 commits intohashicorp:mainfrom
jiaweitao001:fix_eventhub_retention_bug

Conversation

@jiaweitao001
Copy link
Collaborator

@jiaweitao001 jiaweitao001 commented Jul 17, 2025

Community Note

  • Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
  • Please do not leave comments along the lines of "+1", "me too" or "any updates", they generate extra noise for PR followers and do not help prioritize for review

Description

The previous PR will break acc tests because the retention_description is a computed attribute. The API returns a value even it's not defined by user.

message_retention has the same behavior. When tombstone_retention_time_in_hours presents, the API returns an outrange number which will cause a panic.

PR Checklist

  • I have followed the guidelines in our Contributing Documentation.
  • I have checked to ensure there aren't other open Pull Requests for the same update/change.
  • I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
  • I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
  • I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
    For example: “resource_name_here - description of change e.g. adding property new_property_name_here

Changes to existing Resource / Data Source

  • I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation).
  • I have written new tests for my resource or datasource changes & updated any relevant documentation.
  • I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests.
  • (For changes that include a state migration only). I have manually tested the migration path between relevant versions of the provider.

Testing

  • My submission includes Test coverage as described in the Contribution Guide and the tests pass. (if this is not possible for any reason, please include details of why you did or could not add test coverage)
image

Change Log

Below please provide what should go into the changelog (if anything) conforming to the Changelog Format documented here.

  • azurerm_resource - support for the thing1 property [GH-00000]

This is a (please select all that apply):

  • Bug Fix
  • New Feature (ie adding a service, resource, or data source)
  • Enhancement
  • Breaking Change

Related Issue(s)

Fixes #29427

Rollback Plan

If a change needs to be reverted, we will publish an updated version of the provider.

Changes to Security Controls

Are there any changes to security controls (access controls, encryption, logging) in this pull request? If so, explain.

Note

If this PR changes meaningfully during the course of review please update the title and description as required.

@jiaweitao001 jiaweitao001 force-pushed the fix_eventhub_retention_bug branch from 4f757c1 to cf9bfc9 Compare July 17, 2025 06:33
@jiaweitao001 jiaweitao001 changed the title eventhub_resource: fix conflict state drift on retention description eventhub_resource: fix state drift on retention description Jul 17, 2025
Copy link
Member

@mbfrahry mbfrahry left a comment

Choose a reason for hiding this comment

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

Hey @jiaweitao001, this looks good except I think we can one step further by opening an issue on the rest api specs as returning a number that causes a panic seems wrong

return err
}

if props.RetentionDescription == nil || props.RetentionDescription.TombstoneRetentionTimeInHours == nil {
Copy link
Member

Choose a reason for hiding this comment

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

If TombstoneRetentionTimeInHours is returning a bogus number that causes a panic, that seems like an api issue. Would it make sense to open an issue on the rest api specs and leave a comment for that here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Hi @mbfrahry , the issue is created Azure/azure-rest-api-specs#36018

Copy link
Member

@mbfrahry mbfrahry left a comment

Choose a reason for hiding this comment

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

Just a quick change for that message and we're there

return err
}

// API returns a bogus MessageRetentionInDays when TombstoneRetentionTimeInHours is set. Tracking issue: https://github.com/Azure/azure-rest-api-specs/issues/36018
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
// API returns a bogus MessageRetentionInDays when TombstoneRetentionTimeInHours is set. Tracking issue: https://github.com/Azure/azure-rest-api-specs/issues/36018
// TODO - the `props.RetentionDescription.TombstoneRetentionTimeInHours == nil` check can be removed when https://github.com/Azure/azure-rest-api-specs/issues/36018 is fixed

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fixed.

Copy link
Member

@mbfrahry mbfrahry left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for those changes

@mbfrahry mbfrahry changed the title eventhub_resource: fix state drift on retention description eventhub_resource: fix perpetual diff with message_retention Jul 21, 2025
@mbfrahry mbfrahry added this to the v4.38.0 milestone Jul 21, 2025
@mbfrahry mbfrahry changed the title eventhub_resource: fix perpetual diff with message_retention azurerm_eventhub - fix perpetual diff with message_retention Jul 21, 2025
@mbfrahry mbfrahry merged commit a6a0028 into hashicorp:main Jul 21, 2025
33 checks passed
@github-actions
Copy link
Contributor

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 21, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants