Allow (ignore) duplicate document versions sent by client in didChange

[radeksimko]

We initially set more restrictive rules to better understand the reality of how clients behave.

It has emerged that some clients (Sublime Text LSP 1.1.0 in particular), can send duplicate didChange requests. Below is a snippet of a log demonstrating that.

Server Version

0.9.0

Terraform Version

0.13.0

Client Version

Sublime Text LSP plugin 1.1.0

Terraform Configuration Files

terraform {
  required_providers {
    # 0.12
    # random  = "3.0.0"
    # null    = "3.0.0"
    # grafana = "1.6.0"
    # vault   = "2.15.0"

    # 0.13+
    random = {
      source  = "hashicorp/random"
      version = "3.0.0"
    }
    null = {
      source  = "hashicorp/null"
      version = "3.0.0"
    }
    grafana = {
      source  = "grafana/grafana"
      version = "1.6.0"
    }
    vault = {
      source  = "hashicorp/vault"
      version = "2.15.0"
    }
  }
}

module "ref" {
  source = "./sub"
  count  = 1
}

provider "vault" {
  auth_login {
    namespace = "value"
  }
}

provider "grafana" {
  alias = "value"
  auth  = "value"
}

provider "random" {
}

resource "vault_auth_backend" "blah" {

}

provider "azurestack" {
  arm_endpoint = "value"
}

Log Output

terraform: 2020/11/19 10:19:15 server.go:265: Checking request for "textDocument/didChange": {"textDocument":{"version":58,"uri":"file:///private/var/workspace/tf-test/github/main.tf"},"contentChanges":[{"text":"terraform {\n  required_providers {\n    # 0.12\n    # random  = \"3.0.0\"\n    # null    = \"3.0.0\"\n    # grafana = \"1.6.0\"\n    # vault   = \"2.15.0\"\n\n    # 0.13+\n    random = {\n      source  = \"hashicorp/random\"\n      version = \"3.0.0\"\n    }\n    null = {\n      source  = \"hashicorp/null\"\n      version = \"3.0.0\"\n    }\n    grafana = {\n      source  = \"grafana/grafana\"\n      version = \"1.6.0\"\n    }\n    vault = {\n      source  = \"hashicorp/vault\"\n      version = \"2.15.0\"\n    }\n  }\n}\n\nmodule \"ref\" {\n  source = \"./sub\"\n  count  = 1\n}\n\nprovider \"vault\" {\n  auth_login {\n    namespace = \"value\"\n  }\n}\n\nprovider \"grafana\" {\n  alias = \"value\"\n  auth  = \"value\"\n}\n\nprovider \"random\" {\n}\n\nresource \"vault_auth_backend\" \"blah\" {\n\n}\n\nprovider \"azurestack\" {\n  arm_endpoint = \"value\"\n}\n"}]}

...

terraform: 2020/11/19 10:19:15 server.go:265: Checking request for "textDocument/didChange": {"textDocument":{"version":58,"uri":"file:///private/var/workspace/tf-test/github/main.tf"},"contentChanges":[{"text":"terraform {\n  required_providers {\n    # 0.12\n    # random  = \"3.0.0\"\n    # null    = \"3.0.0\"\n    # grafana = \"1.6.0\"\n    # vault   = \"2.15.0\"\n\n    # 0.13+\n    random = {\n      source  = \"hashicorp/random\"\n      version = \"3.0.0\"\n    }\n    null = {\n      source  = \"hashicorp/null\"\n      version = \"3.0.0\"\n    }\n    grafana = {\n      source  = \"grafana/grafana\"\n      version = \"1.6.0\"\n    }\n    vault = {\n      source  = \"hashicorp/vault\"\n      version = \"2.15.0\"\n    }\n  }\n}\n\nmodule \"ref\" {\n  source = \"./sub\"\n  count  = 1\n}\n\nprovider \"vault\" {\n  auth_login {\n    namespace = \"value\"\n  }\n}\n\nprovider \"grafana\" {\n  alias = \"value\"\n  auth  = \"value\"\n}\n\nprovider \"random\" {\n}\n\nresource \"vault_auth_backend\" \"blah\" {\n\n}\n\nprovider \"azurestack\" {\n  arm_endpoint = \"value\"\n}\n"}]}

...

terraform: 2020/11/19 10:19:15 server.go:342: Discarding error from notification to "textDocument/didChange": Old version (58) received, current version is 58. Unable to update file:///private/var/workspace/tf-test/github/main.tf. This is likely a bug, please report it.

Expected Behavior

didChange should not have returned error when the version and content match exactly, but it should probably still log this event.

Actual Behavior

didChange returned error.

[github-actions]

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