Update types and parser to keep metadata on operation IO shapes

jeskew · jeskew · commit ab8148bbf4ce · 2017-07-11T13:28:44.000-07:00
diff --git a/packages/service-model/__tests__/TreeModel/parser.ts b/packages/service-model/__tests__/TreeModel/parser.ts
@@ -112,7 +112,7 @@ describe('TreeModel parser', () => {
                 operations,
             }));
 
-            expect(api.operations.GetFoo.input.name).toBe('GetFooInput');
+            expect(api.operations.GetFoo.input.shape.name).toBe('GetFooInput');
             expect(api.shapes.Date).not.toBeDefined();
             expect(api.shapes._Date).toBeDefined();
             expect(api.shapes.Error).not.toBeDefined();
@@ -150,7 +150,7 @@ describe('TreeModel parser', () => {
             shapes,
         }));
 
-        const {members} = api.operations.GetFoo.output;
+        const {members} = api.operations.GetFoo.output.shape;
         Object.keys(members).forEach(memberName => {
             expect(members[memberName].shape.sensitive).toBe(true);
         });
@@ -185,7 +185,7 @@ describe('TreeModel parser', () => {
             },
         }));
 
-        const {shape} = api.operations.GetFoo.output.members.foo;
+        const {shape} = api.operations.GetFoo.output.shape.members.foo;
         expect((shape as List).min).toBe(10);
     });
 
@@ -216,7 +216,7 @@ describe('TreeModel parser', () => {
             },
         }));
 
-        const {shape} = api.operations.GetFoo.output.members.foo;
+        const {shape} = api.operations.GetFoo.output.shape.members.foo;
         expect((shape as Number).min).toBe(10);
     });
 
@@ -247,7 +247,7 @@ describe('TreeModel parser', () => {
             },
         }));
 
-        const {shape} = api.operations.GetFoo.output.members.foo;
+        const {shape} = api.operations.GetFoo.output.shape.members.foo;
         expect((shape as String).min).toBe(10);
     });
 
@@ -280,7 +280,7 @@ describe('TreeModel parser', () => {
             },
         }));
 
-        const {shape} = api.operations.GetFoo.output.members.foo;
+        const {shape} = api.operations.GetFoo.output.shape.members.foo;
         expect((shape as List).flattened).toBe(true);
     });
 
@@ -315,7 +315,7 @@ describe('TreeModel parser', () => {
             },
         }));
 
-        const {shape} = api.operations.GetFoo.output.members.foo;
+        const {shape} = api.operations.GetFoo.output.shape.members.foo;
         expect((shape as Map).flattened).toBe(true);
     });
 
@@ -350,7 +350,7 @@ describe('TreeModel parser', () => {
             },
         }));
 
-        const {shape} = api.operations.GetFoo.output.members.foo;
+        const {shape} = api.operations.GetFoo.output.shape.members.foo;
         expect((shape as Map).flattened).toBe(true);
     });
 
@@ -381,7 +381,7 @@ describe('TreeModel parser', () => {
             },
         }));
 
-        const {shape} = api.operations.GetFoo.output.members.foo;
+        const {shape} = api.operations.GetFoo.output.shape.members.foo;
         expect((shape as String).jsonValue).toBe(true);
     });
 
@@ -412,7 +412,7 @@ describe('TreeModel parser', () => {
             },
         }));
 
-        const {shape} = api.operations.GetFoo.output.members.foo;
+        const {shape} = api.operations.GetFoo.output.shape.members.foo;
         expect((shape as String).idempotencyToken).toBe(true);
     });
 
@@ -443,7 +443,7 @@ describe('TreeModel parser', () => {
             },
         }));
 
-        const {shape} = api.operations.GetFoo.output.members.foo;
+        const {shape} = api.operations.GetFoo.output.shape.members.foo;
         expect((shape as TreeModelString).enum).toEqual(['fizz', 'buzz', 'pop']);
     });
 
@@ -474,7 +474,7 @@ describe('TreeModel parser', () => {
             },
         }));
 
-        const {shape} = api.operations.GetFoo.output.members.foo;
+        const {shape} = api.operations.GetFoo.output.shape.members.foo;
         expect((shape as Blob).streaming).toBe(true);
     });
 
@@ -505,7 +505,7 @@ describe('TreeModel parser', () => {
             },
         }));
 
-        const {shape} = api.operations.GetFoo.output.members.foo;
+        const {shape} = api.operations.GetFoo.output.shape.members.foo;
         expect((shape as Timestamp).timestampFormat).toBe('atom');
     });
 
@@ -537,7 +537,7 @@ describe('TreeModel parser', () => {
             },
         }));
 
-        expect(api.operations.GetFoo.output.required).toEqual(['foo']);
+        expect(api.operations.GetFoo.output.shape.required).toEqual(['foo']);
     });
 
     it('should preserve payload traits on structures', () => {
@@ -568,7 +568,7 @@ describe('TreeModel parser', () => {
             },
         }));
 
-        expect(api.operations.GetFoo.output.payload).toEqual('foo');
+        expect(api.operations.GetFoo.output.shape.payload).toEqual('foo');
     });
 
     it('should preserve exception traits on structures', () => {
@@ -595,7 +595,7 @@ describe('TreeModel parser', () => {
             },
         }));
 
-        expect(api.operations.GetFoo.errors[0].exception).toEqual(true);
+        expect(api.operations.GetFoo.errors[0].shape.exception).toEqual(true);
     });
 
     it('should preserve error codes on structures', () => {
@@ -623,7 +623,8 @@ describe('TreeModel parser', () => {
             },
         }));
 
-        expect(api.operations.GetFoo.errors[0].exceptionCode).toEqual('PANIC');
+        expect(api.operations.GetFoo.errors[0].shape.exceptionCode)
+            .toEqual('PANIC');
     });
 
     it('should standardize xmlNamespace traits on structures', () => {
@@ -666,11 +667,11 @@ describe('TreeModel parser', () => {
             },
         }));
 
-        expect(api.operations.GetFoo.output.members.foo.xmlNamespace)
+        expect(api.operations.GetFoo.output.shape.members.foo.xmlNamespace)
             .toEqual({uri: xmlNamespace.uri});
-        expect(api.operations.GetFoo.output.members.bar.xmlNamespace)
+        expect(api.operations.GetFoo.output.shape.members.bar.xmlNamespace)
             .toEqual(xmlNamespace);
-        expect(api.operations.GetFoo.output.members.baz.xmlNamespace)
+        expect(api.operations.GetFoo.output.shape.members.baz.xmlNamespace)
             .toBeUndefined();
     });
 
@@ -702,7 +703,7 @@ describe('TreeModel parser', () => {
             },
         }));
 
-        const {shape} = (api.operations.GetFoo.output.members.foo.shape as TreeModelList).member;
+        const {shape} = (api.operations.GetFoo.output.shape.members.foo.shape as TreeModelList).member;
         expect(shape).toBe(api.shapes[shape.name]);
     });
 
@@ -736,7 +737,7 @@ describe('TreeModel parser', () => {
             },
         }));
 
-        const map = api.operations.GetFoo.output.members.foo.shape as TreeModelMap;
+        const map = api.operations.GetFoo.output.shape.members.foo.shape as TreeModelMap;
         expect(map.key.shape).toBe(api.shapes[map.key.shape.name]);
         expect(map.value.shape).toBe(api.shapes[map.value.shape.name]);
     });
@@ -767,7 +768,7 @@ describe('TreeModel parser', () => {
             shapes,
         }));
 
-        const {members} = api.operations.GetFoo.output;
+        const {members} = api.operations.GetFoo.output.shape;
         for (let memberName of Object.keys(members)) {
             const member = members[memberName];
             expect(member.shape).toBe(api.shapes[member.shape.name]);
@@ -805,7 +806,7 @@ describe('TreeModel parser', () => {
             },
         }));
 
-        expect(api.operations.GetFoo.output.members.foo.documentation)
+        expect(api.operations.GetFoo.output.shape.members.foo.documentation)
             .toEqual('foo member of GetFooOutput');
     });
 });
diff --git a/packages/service-model/lib/TreeModel/parser.ts b/packages/service-model/lib/TreeModel/parser.ts
@@ -35,6 +35,7 @@ import {
     Boolean as ProtocolBoolean,
     Number,
     String as ProtocolString,
+    ServiceMetadata,
     Timestamp as ProtocolTimestamp,
     XmlNamespace,
 } from '@aws/types';
@@ -65,7 +66,11 @@ export function fromApiModel(model: ApiModel): TreeModel {
     const {documentation = `${metadata.serviceFullName} service`} = normalized;
 
     const shapes = fromApiModelShapeMap(normalized.shapes);
-    const operations = fromApiModelOperationMap(normalized.operations, shapes);
+    const operations = fromApiModelOperationMap(
+        normalized.operations,
+        shapes,
+        metadata
+    );
 
     return {
         documentation,
@@ -131,37 +136,45 @@ function fromApiModelShapeMap(shapeMap: ShapeMap): TreeModelShapeMap {
 
 function fromApiModelOperationMap(
     operationMap: NormalizedOperationMap,
-    shapes: TreeModelShapeMap
+    shapes: TreeModelShapeMap,
+    metadata: ServiceMetadata
 ): TreeModelOperationMap {
     return Object.keys(operationMap).reduce((
         carry: TreeModelOperationMap,
         operationName: string
     ) => {
         const {
             name,
-            errors: errorDeclaration,
+            errors,
             http,
-            input: inputDeclaration,
-            output: outputDeclaration,
+            input,
+            output,
         } = operationMap[operationName];
         const {
             documentation = `${name} operation`,
         } = operationMap[operationName];
-        const input = shapes[inputDeclaration.shape] as TreeModelStructure;
-        const output = shapes[outputDeclaration.shape] as TreeModelStructure;
-        const errors = errorDeclaration.map(errorShape => (
-            shapes[errorShape.shape] as TreeModelStructure
-        ));
 
-        carry[operationName] = {
-            documentation,
-            errors,
-            http,
-            input,
-            name,
-            output
+        return {
+            ...carry,
+            [operationName]: {
+                documentation,
+                http,
+                name,
+                metadata,
+                input: {
+                    ...input,
+                    shape: shapes[input.shape] as TreeModelStructure,
+                },
+                output: {
+                    ...output,
+                    shape: shapes[output.shape] as TreeModelStructure,
+                },
+                errors: errors.map(errorShape => ({
+                    ...errorShape,
+                    shape: shapes[errorShape.shape] as TreeModelStructure
+                })),
+            }
         };
-        return carry;
     }, {});
 }
 
diff --git a/packages/service-model/lib/TreeModel/types.ts b/packages/service-model/lib/TreeModel/types.ts
@@ -98,16 +98,25 @@ export interface TreeModelMember extends Partial<Documented>, Member {
     shape: TreeModelShape;
 }
 
+/**
+ * @inheritDoc
+ *
+ * This member's shape must be a structure.
+ */
+export interface TreeModelOperationMember extends TreeModelMember {
+    shape: TreeModelStructure;
+}
+
 /**
  * @inheritDoc
  *
  * Additionally contains a name and documentation string, as do all shapes
  * referenced by this operation.
  */
 export interface TreeModelOperation extends NamedAndDocumented<OperationModel> {
-    input: TreeModelStructure;
-    output: TreeModelStructure;
-    errors: Array<TreeModelStructure>;
+    input: TreeModelOperationMember;
+    output: TreeModelOperationMember;
+    errors: Array<TreeModelOperationMember>;
 }
 
 export interface TreeModelOperationMap {
diff --git a/packages/types/http.ts b/packages/types/http.ts
@@ -7,19 +7,23 @@ export interface HttpMessage<StreamType = Uint8Array> {
     body?: ArrayBuffer|ArrayBufferView|string|StreamType;
 }
 
+export interface HttpEndpoint {
+    protocol: string;
+    hostname: string;
+    port?: number;
+    path: string;
+    query?: {[key: string]: string|Array<string>};
+}
+
 /**
  * Represents an HTTP message constructed to be sent to a host. Contains
  * addressing information in addition to standard message properties.
  */
 export interface HttpRequest<StreamType = Uint8Array> extends
-    HttpMessage<StreamType>
+    HttpMessage<StreamType>,
+    HttpEndpoint
 {
     method: string;
-    protocol: string;
-    hostname: string;
-    port: number;
-    path: string;
-    query?: {[key: string]: string|Array<string>};
 }
 
 /**
diff --git a/packages/types/index.ts b/packages/types/index.ts
@@ -1,6 +1,8 @@
 export * from './credentials';
 export * from './http';
 export * from './crypto';
+export * from './marshaller';
 export * from './protocol';
 export * from './response';
+export * from './unmarshaller';
 export * from './util';
diff --git a/packages/types/protocol.ts b/packages/types/protocol.ts
@@ -81,13 +81,11 @@ export interface HttpTrait {
 
 export interface OperationModel {
     http: HttpTrait;
-    input: Structure;
-    output: Structure;
-    errors: Array<Structure>;
-}
-
-export interface GeneratedOperationModel extends OperationModel {
+    name: string;
     metadata: ServiceMetadata;
+    input: Member;
+    output: Member;
+    errors: Array<Member>;
 }
 
 export type SupportedProtocol = 'json'|'rest-json'|'rest-xml'|'query'|'ec2';
@@ -101,7 +99,7 @@ export interface ServiceMetadata {
     protocol: SupportedProtocol;
     serviceAbbreviation?: string;
     serviceFullName: string;
-    signatureVersion: 'v4'|'s3'|string;
+    signatureVersion: SupportedSignatureVersion|string;
     /**
      * Required for json-rpc services.
      */
@@ -115,4 +113,4 @@ export interface ServiceMetadata {
      * Required for query services.
      */
     xmlNamespace?: string;
-}
+}
