[m3admin] non-strict jsonpb unmarshalling (#117)

When we unmarshal responses from the m3coordinator, the default jsonpb behavior is to not allow unknown fields. This means that new fields added by m3db to the proto can break the operator. This fixes that and future-proofs us against new fields.
m3db · Apr 8, 2019 · 61d54d0 · 61d54d0
1 parent e1e7579
commit 61d54d0
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 48 deletions.
diff --git a/pkg/controller/config.go b/pkg/controller/config.go
diff --git a/pkg/m3admin/namespace/client.go b/pkg/m3admin/namespace/client.go
@@ -128,7 +128,11 @@ func (n *namespaceClient) List() (*admin.NamespaceGetResponse, error) {
 		ioutil.ReadAll(resp.Body)
 		resp.Body.Close()
 	}()
-	if err := jsonpb.Unmarshal(resp.Body, data); err != nil {
+
+	um := &jsonpb.Unmarshaler{
+		AllowUnknownFields: true,
+	}
+	if err := um.Unmarshal(resp.Body, data); err != nil {
 		return nil, err
 	}
 

diff --git a/pkg/m3admin/namespace/client_test.go b/pkg/m3admin/namespace/client_test.go
@@ -96,14 +96,14 @@ func TestCreateErr(t *testing.T) {
 func TestGet(t *testing.T) {
 	s := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		w.WriteHeader(200)
-		w.Write([]byte(`{"registry":{"namespaces":{"default":{"bootstrapEnabled":true,"flushEnabled":true,"writesToCommitLog":true,"cleanupEnabled":true,"repairEnabled":false,"retentionOptions":{"retentionPeriodNanos":"172800000000000","blockSizeNanos":"7200000000000","bufferFutureNanos":"600000000000","bufferPastNanos":"600000000000","blockDataExpiry":true,"blockDataExpiryAfterNotAccessPeriodNanos":"300000000000"},"snapshotEnabled":false,"indexOptions":{"enabled":true,"blockSizeNanos":"7200000000000"}},"m3db-cluster":{"bootstrapEnabled":true,"flushEnabled":true,"writesToCommitLog":true,"cleanupEnabled":true,"repairEnabled":false,"retentionOptions":{"retentionPeriodNanos":"172800000000000","blockSizeNanos":"7200000000000","bufferFutureNanos":"600000000000","bufferPastNanos":"600000000000","blockDataExpiry":true,"blockDataExpiryAfterNotAccessPeriodNanos":"300000000000"},"snapshotEnabled":false,"indexOptions":{"enabled":true,"blockSizeNanos":"7200000000000"}}}}}`))
+		w.Write([]byte(`{"registry":{"namespaces":{"default":{"bootstrapEnabled":true,"flushEnabled":true,"writesToCommitLog":true,"cleanupEnabled":true,"repairEnabled":false,"retentionOptions":{"retentionPeriodNanos":"172800000000000","blockSizeNanos":"7200000000000","bufferFutureNanos":"600000000000","bufferPastNanos":"600000000000","blockDataExpiry":true,"blockDataExpiryAfterNotAccessPeriodNanos":"300000000000"},"snapshotEnabled":false,"indexOptions":{"enabled":true,"blockSizeNanos":"7200000000000"}},"m3db-cluster":{"bootstrapEnabled":true,"flushEnabled":true,"writesToCommitLog":true,"cleanupEnabled":true,"repairEnabled":false,"retentionOptions":{"retentionPeriodNanos":"172800000000000","blockSizeNanos":"7200000000000","bufferFutureNanos":"600000000000","bufferPastNanos":"600000000000","blockDataExpiry":true,"blockDataExpiryAfterNotAccessPeriodNanos":"300000000000"},"snapshotEnabled":false,"schemaOptions":{},"indexOptions":{"enabled":true,"blockSizeNanos":"7200000000000"}}}}}`))
 	}))
 	defer s.Close()
 	client := newNamespaceClient(t, s.URL)
 
 	resp, err := client.List()
 	require.NotNil(t, resp)
-	require.Nil(t, err)
+	require.NoError(t, err)
 }
 
 func TestGet_Nil(t *testing.T) {

diff --git a/pkg/m3admin/placement/client.go b/pkg/m3admin/placement/client.go
@@ -105,7 +105,11 @@ func (p *placementClient) Get() (m3placement.Placement, error) {
 		ioutil.ReadAll(resp.Body)
 		resp.Body.Close()
 	}()
-	if err := jsonpb.Unmarshal(resp.Body, data); err != nil {
+
+	um := &jsonpb.Unmarshaler{
+		AllowUnknownFields: true,
+	}
+	if err := um.Unmarshal(resp.Body, data); err != nil {
 		return nil, err
 	}
 	if data.Placement == nil {