BadRequest error when updating google_spanner_instance with labels set at provider level

[ab-verily]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request.
• Please do not leave +1 or me too comments, they generate extra noise for issue followers and do not help prioritize the request.
• If you are interested in working on this issue or have submitted a pull request, please leave a comment.
• If an issue is assigned to a user, that user is claiming responsibility for the issue.
• Customers working with a Google Technical Account Manager or Customer Engineer can ask them to reach out internally to expedite investigation and resolution of this issue.

Terraform Version & Provider Version(s)

Terraform v1.8.5
on linux_amd64
+ provider registry.terraform.io/hashicorp/google v5.33.0
+ provider registry.terraform.io/hashicorp/google-beta v5.33.0

Affected Resource(s)

google_spanner_instance

Terraform Configuration

Current config:

provider "google" {
  project = local.project_id
  region  = local.region
}

resource "google_spanner_instance" "default" {
  project      = local.project_id
  config       = "regional-${local.region}"
  display_name = "instance-01"
  name         = "instance-01"
  num_nodes    = 1
}

New config I want to apply (set labels at the provider level):

provider "google" {
  project = local.project_id
  region  = local.region

  default_labels = {
    "label1" = "value1"
    "label2" = "value2"
  }
}

resource "google_spanner_instance" "default" {
  project      = local.project_id
  config       = "regional-${local.region}"
  display_name = "instance-01"
  name         = "instance-01"
  num_nodes    = 1
}

Debug Output

https://gist.github.com/ab-verily/e33b3eeb92cfea611d0ae00eeed121f4

Expected Behavior

The google_spanner_instance resource should have been updated with the labels set at the provider level.

Expected API request (with fieldMask set):

PATCH /v1/projects/project/instances/instance-01?alt=json HTTP/1.1
Host: spanner.googleapis.com
User-Agent: Terraform/1.8.5 (+https://www.terraform.io) Terraform-Plugin-SDK/2.33.0 terraform-provider-google/5.33.0
...
 {
  "fieldMask": "labels",
  "instance": {
   "displayName": "instance-01",
   "labels": {
    "label1": "value1",
    "label2": "value2"
   },
   "name": "projects/project/instances/%!s(\u003cnil\u003e)",
   "nodeCount": 1,
   "processingUnits": 1000
  }
 }

Actual Behavior

Apply Error:

Error: Error updating Instance "project/instance-01": googleapi: Error 400: Invalid UpdateInstance request.
Details:
[
  {
    "@type": "type.googleapis.com/google.rpc.BadRequest",
    "fieldViolations": [
      {
        "description": "Must specify a non-empty field mask.",
        "field": "field_mask"
      }
    ]
  },
  {
    "@type": "type.googleapis.com/google.rpc.DebugInfo",
    "detail": "[ORIGINAL ERROR] generic::invalid_argument: Invalid UpdateInstance request. [google.rpc.error_details_ext] { message: \"Invalid UpdateInstance request.\" details { [type.googleapis.com/google.rpc.BadRequest] { field_violations { field: \"field_mask\" description: \"Must specify a non-empty field mask.\" } } } } 485239697 { 1: \"Invalid UpdateInstance request.\" 2 { 2: \"Invalid [REDACTED] request.\" 3 { 1: \"type.googleapis.com/google.rpc.BadRequest\" 2 { 1 { 1: \"field_mask\" 2: \"Must specify a non-empty field mask.\" } } } } }"
  }
]

Actual API request (with empty fieldMask):

PATCH /v1/projects/project/instances/instance-01?alt=json HTTP/1.1
Host: spanner.googleapis.com
User-Agent: Terraform/1.8.5 (+https://www.terraform.io) Terraform-Plugin-SDK/2.33.0 terraform-provider-google/5.33.0
...
 {
  "fieldMask": "",
  "instance": {
   "displayName": "instance-01",
   "labels": {
    "label1": "value1",
    "label2": "value2"
   },
   "name": "projects/project/instances/%!s(\u003cnil\u003e)",
   "nodeCount": 1,
   "processingUnits": 1000
  }
 }

Steps to reproduce

1. Create google_spanner_instance resource:

provider "google" {
  project = local.project_id
  region  = local.region
}

resource "google_spanner_instance" "default" {
  project      = local.project_id
  config       = "regional-${local.region}"
  display_name = "instance-01"
  name         = "instance-01"
  num_nodes    = 1
}

2. Plan & Apply

3. Change config to set labels at the provider level:

provider "google" {
  project = local.project_id
  region  = local.region

  default_labels = {
    "label1" = "value1"
    "label2" = "value2"
  }
}

resource "google_spanner_instance" "default" {
  project      = local.project_id
  config       = "regional-${local.region}"
  display_name = "instance-01"
  name         = "instance-01"
  num_nodes    = 1
}

4. Plan:

Terraform will perform the following actions:

  # google_spanner_instance.default will be updated in-place
  ~ resource "google_spanner_instance" "default" {
      ~ effective_labels = {
          + "label1" = "value1"
          + "label2" = "value2"
        }
        id               = "project/instance-01"
        name             = "instance-01"
      ~ terraform_labels = {
          + "label1" = "value1"
          + "label2" = "value2"
        }
        # (8 unchanged attributes hidden)
    }

Plan: 0 to add, 1 to change, 0 to destroy.

5. Apply:

Error: Error updating Instance "project/instance-01": googleapi: Error 400: Invalid UpdateInstance request.
Details:
[
  {
    "@type": "type.googleapis.com/google.rpc.BadRequest",
    "fieldViolations": [
      {
        "description": "Must specify a non-empty field mask.",
        "field": "field_mask"
      }
    ]
  },
  {
    "@type": "type.googleapis.com/google.rpc.DebugInfo",
    "detail": "[ORIGINAL ERROR] generic::invalid_argument: Invalid UpdateInstance request. [google.rpc.error_details_ext] { message: \"Invalid UpdateInstance request.\" details { [type.googleapis.com/google.rpc.BadRequest] { field_violations { field: \"field_mask\" description: \"Must specify a non-empty field mask.\" } } } } 485239697 { 1: \"Invalid UpdateInstance request.\" 2 { 2: \"Invalid [REDACTED] request.\" 3 { 1: \"type.googleapis.com/google.rpc.BadRequest\" 2 { 1 { 1: \"field_mask\" 2: \"Must specify a non-empty field mask.\" } } } } }"
  }
]

Important Factoids

No response

References

No response

b/348054862

[ggtisc]

Confirmed issue!

Following the indications if the resource is created with config1 and then updated at provider level it returns an error 400: Invalid UpdateInstance request. It is the same for any change at provider level.