Enabling management of default Dialogflow resources without terraform import: is_default_x fields

mmv1/products/dialogflowcx/Flow.yaml

@@ -27,17 +27,35 @@ timeouts: !ruby/object:Api::Timeouts
   update_minutes: 40
 custom_code: !ruby/object:Provider::Terraform::CustomCode
   custom_import: templates/terraform/custom_import/dialogflowcx_flow.go.erb
-  pre_create: templates/terraform/pre_create/dialogflow_set_location.go.erb
+  pre_create: templates/terraform/pre_create/dialogflowcx_set_location_skip_default_obj.go.erb
   pre_update: templates/terraform/pre_create/dialogflow_set_location.go.erb
-  pre_delete: templates/terraform/pre_create/dialogflow_set_location.go.erb
+  pre_delete: templates/terraform/pre_delete/dialogflowcx_set_location_skip_default_obj.go.erb
   pre_read: templates/terraform/pre_create/dialogflow_set_location.go.erb
+virtual_fields:
+  - !ruby/object:Api::Type::Boolean
+    name: is_default_start_flow
+    immutable: true
+    description: |
+      Marks this as the [Default Start Flow](https://cloud.google.com/dialogflow/cx/docs/concept/flow#start) for an agent. When you create an agent, the Default Start Flow is created automatically.
+      The Default Start Flow cannot be deleted; deleting the `google_dialogflow_cx_flow` resource does nothing to the underlying GCP resources.
 examples:
+  - !ruby/object:Provider::Terraform::Examples
+    name: 'dialogflowcx_flow_basic'
+    primary_resource_id: 'basic_flow'
+    vars:
+      agent_name: 'dialogflowcx-agent'
   - !ruby/object:Provider::Terraform::Examples
     name: 'dialogflowcx_flow_full'
     primary_resource_id: 'basic_flow'
     vars:
       agent_name: 'dialogflowcx-agent'
       bucket_name: 'dialogflowcx-bucket'
+  - !ruby/object:Provider::Terraform::Examples
+    skip_docs: true
+    name: 'dialogflowcx_flow_default_start_flow'
+    primary_resource_id: 'default_start_flow'
+    vars:
+      agent_name: 'dialogflowcx-agent'
 skip_sweeper: true
 id_format: '{{parent}}/flows/{{name}}'
 import_format: ['{{parent}}/flows/{{name}}']

mmv1/products/dialogflowcx/Intent.yaml

@@ -27,16 +27,41 @@ timeouts: !ruby/object:Api::Timeouts
   update_minutes: 40
 custom_code: !ruby/object:Provider::Terraform::CustomCode
   custom_import: templates/terraform/custom_import/dialogflowcx_intent.go.erb
-  pre_create: templates/terraform/pre_create/dialogflow_set_location.go.erb
+  pre_create: templates/terraform/pre_create/dialogflowcx_set_location_skip_default_obj.go.erb
   pre_update: templates/terraform/pre_create/dialogflow_set_location.go.erb
-  pre_delete: templates/terraform/pre_create/dialogflow_set_location.go.erb
+  pre_delete: templates/terraform/pre_delete/dialogflowcx_set_location_skip_default_obj.go.erb
   pre_read: templates/terraform/pre_create/dialogflow_set_location.go.erb
+virtual_fields:
+  - !ruby/object:Api::Type::Boolean
+    name: is_default_welcome_intent
+    immutable: true
+    description: |
+      Marks this as the [Default Welcome Intent](https://cloud.google.com/dialogflow/cx/docs/concept/intent#welcome) for an agent. When you create an agent, a Default Welcome Intent is created automatically.
+      The Default Welcome Intent cannot be deleted; deleting the `google_dialogflow_cx_intent` resource does nothing to the underlying GCP resources.
+  - !ruby/object:Api::Type::Boolean
+    name: is_default_negative_intent
+    immutable: true
+    description: |
+      Marks this as the [Default Negative Intent](https://cloud.google.com/dialogflow/cx/docs/concept/intent#negative) for an agent. When you create an agent, a Default Negative Intent is created automatically.
+      The Default Negative Intent cannot be deleted; deleting the `google_dialogflow_cx_intent` resource does nothing to the underlying GCP resources.
 examples:
   - !ruby/object:Provider::Terraform::Examples
     name: 'dialogflowcx_intent_full'
     primary_resource_id: 'basic_intent'
     vars:
       agent_name: 'dialogflowcx-agent'
+  - !ruby/object:Provider::Terraform::Examples
+    skip_docs: true
+    name: 'dialogflowcx_intent_default_negative_intent'
+    primary_resource_id: 'default_negative_intent'
+    vars:
+      agent_name: 'dialogflowcx-agent'
+  - !ruby/object:Provider::Terraform::Examples
+    skip_docs: true
+    name: 'dialogflowcx_intent_default_welcome_intent'
+    primary_resource_id: 'default_welcome_intent'
+    vars:
+      agent_name: 'dialogflowcx-agent'
 skip_sweeper: true
 id_format: '{{parent}}/intents/{{name}}'
 import_format: ['{{parent}}/intents/{{name}}']
@@ -141,9 +166,11 @@ properties:
       If the supplied value is negative, the intent is ignored in runtime detect intent requests.
   - !ruby/object:Api::Type::Boolean
     name: 'isFallback'
+    output: true
     description: |
       Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation.
       Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
+      To manage the fallback intent, set `is_default_negative_intent = true`
   - !ruby/object:Api::Type::KeyValueLabels
     name: 'labels'
     description: |

mmv1/provider/terraform/virtual_fields.rb

@@ -49,12 +49,17 @@ class VirtualFields < Api::Object
       # The default value for the field (defaults to false)
       attr_reader :default_value
 
+      # If set to true, changes in the field's value require recreating the
+      # resource.
+      attr_reader :immutable
+
       def validate
         super
         check :name, type: String, required: true
         check :description, type: String, required: true
         check :type, type: Class, default: Api::Type::Boolean
         check :default_value, default: false
+        check :immutable, default: false
       end
     end
   end

mmv1/templates/terraform/custom_import/dialogflowcx_flow.go.erb

@@ -15,4 +15,9 @@ if err != nil {
 }
 d.SetId(id)
 
+// Set is_default_start_flow if the resource is actually the Default Start Flow
+if d.Get("name").(string) == "00000000-0000-0000-0000-000000000000" {
+    d.Set("is_default_start_flow", true)
+}
+
 return []*schema.ResourceData{d}, nil

mmv1/templates/terraform/custom_import/dialogflowcx_intent.go.erb

@@ -15,4 +15,12 @@
 	}
 	d.SetId(id)
 
+	// Set is_default_X if the resource is actually a Default Intent
+	if d.Get("name").(string) == "00000000-0000-0000-0000-000000000000" {
+		d.Set("is_default_welcome_intent", true)
+	}
+	if d.Get("name").(string) == "00000000-0000-0000-0000-000000000001" {
+		d.Set("is_default_negative_intent", true)
+	}
+
 	return []*schema.ResourceData{d}, nil

mmv1/templates/terraform/examples/dialogflowcx_flow_default_start_flow.tf.erb

@@ -0,0 +1,76 @@
+resource "google_dialogflow_cx_agent" "agent" {
+  display_name          = "<%= ctx[:vars]["agent_name"] %>"
+  location              = "global"
+  default_language_code = "en"
+  time_zone             = "America/New_York"
+}
+
+resource "google_dialogflow_cx_intent" "default_welcome_intent" {
+  parent                    = google_dialogflow_cx_agent.agent.id
+  is_default_welcome_intent = true
+  display_name              = "Default Welcome Intent"
+  priority                  = 1
+  training_phrases {
+    parts {
+      text = "Hello"
+    }
+    repeat_count = 1
+  }
+}
+
+
+resource "google_dialogflow_cx_flow" "<%= ctx[:primary_resource_id] %>" {
+  parent                = google_dialogflow_cx_agent.agent.id
+  is_default_start_flow = true
+  display_name          = "Default Start Flow"
+  description           = "A start flow created along with the agent"
+
+  nlu_settings {
+    classification_threshold = 0.3
+    model_type               = "MODEL_TYPE_STANDARD"
+  }
+
+  transition_routes {
+    intent = google_dialogflow_cx_intent.default_welcome_intent.id
+    trigger_fulfillment {
+      messages {
+        text {
+          text = ["Response to default welcome intent."]
+        }
+      }
+    }
+  }
+
+  event_handlers {
+    event = "custom-event"
+    trigger_fulfillment {
+      messages {
+        text {
+          text = ["This is a default flow."]
+        }
+      }
+    }
+  }
+
+  event_handlers {
+    event = "sys.no-match-default"
+    trigger_fulfillment {
+      messages {
+        text {
+          text = ["We've updated the default flow no-match response!"]
+        }
+      }
+    }
+  }
+
+  event_handlers {
+    event = "sys.no-input-default"
+    trigger_fulfillment {
+      messages {
+        text {
+          text = ["We've updated the default flow no-input response!"]
+        }
+      }
+    }
+  }
+}

mmv1/templates/terraform/examples/dialogflowcx_intent_default_negative_intent.tf.erb

@@ -0,0 +1,20 @@
+resource "google_dialogflow_cx_agent" "agent" {
+  display_name          = "<%= ctx[:vars]["agent_name"] %>"
+  location              = "global"
+  default_language_code = "en"
+  time_zone             = "America/New_York"
+}
+
+
+resource "google_dialogflow_cx_intent" "<%= ctx[:primary_resource_id] %>" {
+  parent                     = google_dialogflow_cx_agent.agent.id
+  is_default_negative_intent = true
+  display_name               = "Default Negative Intent"
+  priority                   = 1
+  training_phrases {
+     parts {
+         text = "Never match this phrase"
+     }
+     repeat_count = 1
+  }
+}

mmv1/templates/terraform/examples/dialogflowcx_intent_default_welcome_intent.tf.erb

@@ -0,0 +1,20 @@
+resource "google_dialogflow_cx_agent" "agent" {
+  display_name          = "<%= ctx[:vars]["agent_name"] %>"
+  location              = "global"
+  default_language_code = "en"
+  time_zone             = "America/New_York"
+}
+
+
+resource "google_dialogflow_cx_intent" "<%= ctx[:primary_resource_id] %>" {
+  parent                    = google_dialogflow_cx_agent.agent.id
+  is_default_welcome_intent = true
+  display_name              = "Default Welcome Intent"
+  priority                  = 1
+  training_phrases {
+     parts {
+         text = "Hello"
+     }
+     repeat_count = 1
+  }
+}

mmv1/templates/terraform/pre_create/dialogflowcx_set_location_skip_default_obj.go.erb

@@ -0,0 +1,42 @@
+
+// extract location from the parent
+location := ""
+
+if parts := regexp.MustCompile(`locations\/([^\/]*)\/`).FindStringSubmatch(d.Get("parent").(string)); parts != nil {
+    location = parts[1]
+} else {
+    return fmt.Errorf(
+        "Saw %s when the parent is expected to contains location %s",
+        d.Get("parent"),
+        "projects/{{project}}/locations/{{location}}/...",
+    )
+}
+
+url = strings.Replace(url,"-dialogflow",fmt.Sprintf("%s-dialogflow",location),1)
+
+// if it's a default object Dialogflow creates for you, "Update" instead of "Create"
+isDefaultStartFlow, _ := d.Get("is_default_start_flow").(bool)
+isDefaultWelcomeIntent, _ := d.Get("is_default_welcome_intent").(bool)
+isDefaultNegativeIntent, _ := d.Get("is_default_negative_intent").(bool)
+if isDefaultStartFlow || isDefaultWelcomeIntent || isDefaultNegativeIntent {
+    // hardcode the default object ID:
+    var defaultObjName string
+    if isDefaultStartFlow || isDefaultWelcomeIntent {
+        defaultObjName = "00000000-0000-0000-0000-000000000000"
+    }
+    if isDefaultNegativeIntent {
+        defaultObjName = "00000000-0000-0000-0000-000000000001"
+    }
+
+    // Store the ID
+    d.Set("name", defaultObjName)
+    id, err := tpgresource.ReplaceVars(d, config, "<%= id_format(object) -%>")
+    if err != nil {
+        return fmt.Errorf("Error constructing id: %s", err)
+    }
+    d.SetId(id)
+
+    // and defer to the Update method:
+    log.Printf("[DEBUG] Updating default <%= resource_name -%>")
+    return resource<%= resource_name -%>Update(d, meta)
+}

mmv1/templates/terraform/pre_delete/dialogflowcx_set_location_skip_default_obj.go.erb

@@ -0,0 +1,25 @@
+
+// extract location from the parent
+location := ""
+
+if parts := regexp.MustCompile(`locations\/([^\/]*)\/`).FindStringSubmatch(d.Get("parent").(string)); parts != nil {
+    location = parts[1]
+} else {
+    return fmt.Errorf(
+        "Saw %s when the parent is expected to contains location %s",
+        d.Get("parent"),
+        "projects/{{project}}/locations/{{location}}/...",
+    )
+}
+
+url = strings.Replace(url,"-dialogflow",fmt.Sprintf("%s-dialogflow",location),1)
+
+// if it's a default object Dialogflow creates for you, skip deletion
+isDefaultStartFlow, _ := d.Get("is_default_start_flow").(bool)
+isDefaultWelcomeIntent, _ := d.Get("is_default_welcome_intent").(bool)
+isDefaultNegativeIntent, _ := d.Get("is_default_negative_intent").(bool)
+if isDefaultStartFlow || isDefaultWelcomeIntent || isDefaultNegativeIntent {
+    // we can't delete these resources so do nothing
+    log.Printf("[DEBUG] Not deleting default <%= resource_name -%>")
+    return nil
+}

mmv1/templates/terraform/resource.erb

@@ -155,6 +155,9 @@ func Resource<%= resource_name -%>() *schema.Resource {
             "<%= field.name -%>": {
                 Type: <%= tf_type(field) -%>,
                 Optional: true,
+<%       if field.immutable -%>
+                ForceNew: true,
+<%       end -%>
 <%       unless field.default_value.nil? -%>
                 Default:  <%= go_literal(field.default_value) -%>,
 <%       end -%>