fix missing signingName in service metadata; Add content-type of rest-json

Author: AllanZhengYP

packages/protocol-rest/src/RestSerializer.spec.ts

@@ -1,13 +1,14 @@
 import {RestSerializer} from './RestSerializer';
-import {HttpEndpoint} from '@aws-sdk/types';
+import {HttpEndpoint, Structure} from '@aws-sdk/types';
 
 import {
     complexGetOperation,
     containsSubresourceGetOperation,
     minimalPostOperation,
     streamingPostOperation,
     simpleGetOperation,
-    simpleHeadOperation
+    simpleHeadOperation,
+    restJsonOperation
 } from './operations.fixture';
 
 describe('RestMarshaller', () => {
@@ -460,6 +461,48 @@ describe('RestMarshaller', () => {
                 expect(utf8Decoder.mock.calls.length).toBe(1);
                 expect(serialized.headers['x-amz-json']).toBe('base64');
             });
+
+            describe('content-type header', () => {
+                it('should not set Content-Type if payload is not supplied', () => {
+                    const toSerialize = {};
+                    const serialized = restMarshaller.serialize(restJsonOperation, toSerialize);
+                    expect(serialized.headers['Content-Type']).toBeUndefined();
+                });
+
+                it('should set Content-Type to \'application/json\' if payload is a structure', () => {
+                    const toSerialize = {Payload: {}};
+                    const serialized = restMarshaller.serialize(restJsonOperation, toSerialize);
+                    expect(serialized.headers['Content-Type']).toBe('application/json');
+                });
+
+                it('should set Content-Type to \'binary/octet-stream\' if payload is a blob', () => {
+                    const originPayload = (restJsonOperation.input.shape as Structure).members.Payload;
+                    (restJsonOperation.input.shape as Structure).members.Payload = {
+                        shape: {type: 'blob'}
+                    }
+                    const toSerialize = {Payload: 'payload blob'};
+                    const serialized = restMarshaller.serialize(restJsonOperation, toSerialize);
+                    expect(serialized.headers['Content-Type']).toBe('binary/octet-stream');
+                    (restJsonOperation.input.shape as Structure).members.Payload = originPayload;
+                });
+
+                it('generated content-type should not override the header serialized from input', () => {
+                    const toSerialize = {
+                        Payload: {},
+                        ContentType: 'ShouldNotOverride'
+                    };
+                    const serialized = restMarshaller.serialize(restJsonOperation, toSerialize);
+                    expect(serialized.headers['Content-Type']).toBe('ShouldNotOverride');
+                });
+
+                it('should default to use \'application/json\' Content-Type if no payload', () => {
+                    const payloadMember = (restJsonOperation.input.shape as Structure).payload;
+                    delete (restJsonOperation.input.shape as Structure).payload;
+                    const serialized = restMarshaller.serialize(restJsonOperation, {});
+                    expect(serialized.headers['Content-Type']).toBe('application/json');
+                    if (payloadMember) (restJsonOperation.input.shape as Structure).payload = payloadMember;
+                })
+            });
         });
     });
 });

packages/protocol-rest/src/RestSerializer.ts

@@ -13,7 +13,9 @@ import {
     QueryParameterBag,
     RequestSerializer,
     SerializationModel,
-    Structure as StructureShape
+    Structure as StructureShape,
+    SupportedProtocol,
+    Structure
 } from '@aws-sdk/types';
 
 import {
@@ -55,7 +57,10 @@ export class RestSerializer<StreamType> implements
         return {
             ...this.endpoint,
             body,
-            headers: serializedParts.headers,
+            headers: {
+                ...this.populateContentTypeHeader(operation, input),
+                ...serializedParts.headers
+            },
             method: httpTrait.method,
             query: serializedParts.query,
             path: serializedParts.uri
@@ -244,4 +249,34 @@ export class RestSerializer<StreamType> implements
             }
         }
     }
+
+    /**
+     * Add Content-Type header for rest-json protocol explicitly
+     * If payload is supplied in input, the content-type should be set according to payload shape;
+     * If payload is specified but not supplied in input, no content-type header is needed;
+     * If there's no payload in input shape, set content-type as 'application/json';
+     * @param operation 
+     */
+    private populateContentTypeHeader(operation: OperationModel, input: any): HeaderBag {
+        const contentTypeHeader = {};
+        const {
+            input: inputShape,
+            metadata: {protocol}
+        } = operation;
+        if (protocol !== 'rest-json') return contentTypeHeader
+        if (typeof (inputShape.shape as Structure).payload === 'string') {
+            const payloadMemberName = (inputShape.shape as Structure).payload!;
+            const payloadMember = (inputShape.shape as Structure).members[payloadMemberName];
+            const payload = input[payloadMemberName];
+            if (!payload) return contentTypeHeader;
+            if (payloadMember.shape.type === 'structure') {
+                return {'Content-Type': 'application/json'};
+            } else if (payloadMember.shape.type === 'blob') {
+                return {'Content-Type': 'binary/octet-stream'};
+            }
+        } else {
+            return {'Content-Type': 'application/json'};
+        }
+        return contentTypeHeader;
+    }
 }

packages/protocol-rest/src/operations.fixture.ts

@@ -442,4 +442,45 @@ export const simpleHeadOperation: OperationModel = {
         },
     },
     errors:[]
+}
+
+export const restJsonOperation: OperationModel = {
+    metadata: {
+        ...minimumMetadata,
+        protocol: 'rest-json'
+    },
+    name: 'RestJsonOperation',
+    http: {
+        method: 'GET',
+        requestUri: '/'
+    },
+    input: {
+        shape: {
+            type: 'structure',
+            required: [],
+            members: {
+                ContentType: {
+                    shape: {type: 'string'},
+                    location: 'headers',
+                    locationName: 'Content-Type'
+                },
+                Payload: {
+                    shape: {
+                        type: 'structure',
+                        required: [],
+                        members: {}
+                    }
+                }
+            },
+            payload: 'Payload'
+        }
+    },
+    output: {
+        shape: {
+            type: 'structure',
+            required: [],
+            members: {}
+        },
+    },
+    errors:[]
 }

packages/service-model/src/TreeModel/normalizeModel.ts

@@ -98,6 +98,7 @@ function pruneServiceMetadata<T extends ServiceMetadata>(metadata: T): ServiceMe
         'serviceFullName',
         'serviceId',
         'signatureVersion',
+        'signingName',
         'targetPrefix',
         'timestampFormat',
         'uid',