From 0a731167db498e93ed1532db2ed6f0bc41c583f7 Mon Sep 17 00:00:00 2001
From: James Bardin <j.bardin@gmail.com>
Date: Tue, 15 Jan 2019 11:59:15 -0500
Subject: [PATCH] add a round trip through the shims during apply

Cycle through the shim operations after Apply, to ensure that we can
converge on a stable value for for Plan. While the shims produce valid
values in both directions, helper/schema sometimes does not agree on
which containers should be empty or null.
---
 helper/plugin/grpc_provider.go | 38 +++++++++++++++++++++++++++++++++-
 1 file changed, 37 insertions(+), 1 deletion(-)

diff --git a/helper/plugin/grpc_provider.go b/helper/plugin/grpc_provider.go
index d3ff07717..42c2b6d0d 100644
--- a/helper/plugin/grpc_provider.go
+++ b/helper/plugin/grpc_provider.go
@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"log"
 	"regexp"
 	"sort"
 	"strconv"
@@ -728,10 +729,10 @@ func (s *GRPCProviderServer) ApplyResourceChange(_ context.Context, req *proto.A
 		return resp, nil
 	}
 
+	plannedState := hcl2shim.FlatmapValueFromHCL2(plannedStateVal)
 	if newInstanceState != nil {
 		// here we use the planned state to check for unknown/zero containers values
 		// when normalizing the flatmap.
-		plannedState := hcl2shim.FlatmapValueFromHCL2(plannedStateVal)
 		newInstanceState.Attributes = normalizeFlatmapContainers(plannedState, newInstanceState.Attributes, true)
 	}
 
@@ -749,6 +750,41 @@ func (s *GRPCProviderServer) ApplyResourceChange(_ context.Context, req *proto.A
 
 	newStateVal = copyMissingValues(newStateVal, plannedStateVal)
 
+	if newInstanceState != nil {
+		prevVal := newStateVal
+		for i := 0; ; i++ {
+			// cycle through the shims, to ensure that the plan will create an
+			// identical value
+			shimmedState, err := res.ShimInstanceStateFromValue(prevVal)
+			if err != nil {
+				resp.Diagnostics = convert.AppendProtoDiag(resp.Diagnostics, err)
+				return resp, nil
+			}
+			shimmedState.Attributes = normalizeFlatmapContainers(shimmedState.Attributes, shimmedState.Attributes, false)
+
+			tmpVal, err := hcl2shim.HCL2ValueFromFlatmap(shimmedState.Attributes, block.ImpliedType())
+			if err != nil {
+				resp.Diagnostics = convert.AppendProtoDiag(resp.Diagnostics, err)
+				return resp, nil
+			}
+
+			tmpVal = copyMissingValues(tmpVal, prevVal)
+
+			if tmpVal.RawEquals(prevVal) {
+				newStateVal = tmpVal
+				break
+			}
+
+			if i < 2 {
+				prevVal = tmpVal
+				continue
+			}
+
+			log.Printf("[ERROR] hcl2shims failed to converge for value: %#v\n", newStateVal)
+			break
+		}
+	}
+
 	newStateVal = copyTimeoutValues(newStateVal, plannedStateVal)
 
 	newStateMP, err := msgpack.Marshal(newStateVal, block.ImpliedType())