read deprecation message for resource deprecations

[DanielMSchmidt]

Fixes #

Target Release

1.15.x

Rollback Plan

• If a change needs to be reverted, we will roll out an update to the code within 7 days.

Changes to Security Controls

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

CHANGELOG entry

• This change is user-facing and I added a changelog entry.
• This change is not user-facing.

[ansgarm]

successfully tested this locally, using this PR and a few others:

• add deprecation_message to grpc proto and schema structs terraform-plugin-go#600
• add support for attribute level deprecation messages terraform-plugin-mux#346
• feat: add deprecation messages for attributes and blocks in configschema terraform-plugin-sdk#1553
• feat: add deprecation messages for attributes and blocks in configschema terraform-plugin-framework#1276

[dbanck]

I think we should also include the new deprecation message in the provider schema JSON so that other consumers, such as language servers, can display it. This should be relatively easy to do by updating:

terraform/internal/command/jsonprovider/attribute.go

Lines 13 to 24 in c8a05ab

	type Attribute struct {
	AttributeType json.RawMessage `json:"type,omitempty"`
	AttributeNestedType *NestedType `json:"nested_type,omitempty"`
	Description string `json:"description,omitempty"`
	DescriptionKind string `json:"description_kind,omitempty"`
	Deprecated bool `json:"deprecated,omitempty"`
	Required bool `json:"required,omitempty"`
	Optional bool `json:"optional,omitempty"`
	Computed bool `json:"computed,omitempty"`
	Sensitive bool `json:"sensitive,omitempty"`
	WriteOnly bool `json:"write_only,omitempty"`
	}

[ansgarm]

I think we should also include the new deprecation message in the provider schema JSON

I agree – the only remark I'd have before we do that, would be to check this with large providers like AWS / Azure / Google. As they might have lots of these and this might cause their schema size to explode even further. I would at least like to test this locally to see how much that schema increases in size to get some rough percentage.

[DanielMSchmidt]

@dbanck & @ansgarm good thinking! I'll make a separate PR for that and include some testing with AWS, Azure and Google 👍

[ewbankkit]

For the Terraform AWS Provider:

For Terraform Plugin SDKv2:

% grep 'Deprecated: ' internal/service/*/*.go | wc -l
      72

For Terraform Plugin Framework:

% grep DeprecationMessage internal/service/*/*.go | wc -l
      23

so, less than 100 deprecation messages so far and each message is usually less than 100 characters (often something like status is deprecated. Use state instead.). A tiny fraction of the overall provider schema JSON size.