update documentation and comments

README.md

@@ -95,15 +95,14 @@ TODO List:
 * ✓ Implement generic response body -> Response type handling (right now, this is hard-coded)
 * ✓ Implement codegen for services with xml structures (using Smithy models)
 * ✓ Implement codegen for others (using Smithy models)
-* Switch to aws-c-cal upsream once [PR for full static musl build support is merged](https://github.com/awslabs/aws-c-cal/pull/89) (see Dockerfile)
+* Switch to aws-c-cal upstream once [PR for full static musl build support is merged](https://github.com/awslabs/aws-c-cal/pull/89) (see Dockerfile)
 * Remove compiler 0.7.1 shims when 0.8.0 is released
 (new 2021-05-29. I will proceed in this order unless I get other requests)
-* Implement [AWS query protocol](https://awslabs.github.io/smithy/1.0/spec/aws/aws-query-protocol.html). This is the protocol in use by sts.getcalleridentity
+* ✓ Implement [AWS query protocol](https://awslabs.github.io/smithy/1.0/spec/aws/aws-query-protocol.html). This is the protocol in use by sts.getcalleridentity. Total service count 18
-* Implement [AWS Json 1.0 protocol](https://awslabs.github.io/smithy/1.0/spec/aws/aws-json-1_0-protocol.html)
+* Implement [AWS Json 1.0 protocol](https://awslabs.github.io/smithy/1.0/spec/aws/aws-json-1_0-protocol.html). Includes dynamodb. Total service count 18
-* Implement [AWS Json 1.1 protocol](https://awslabs.github.io/smithy/1.0/spec/aws/aws-json-1_1-protocol.html)
+* Implement [AWS Json 1.1 protocol](https://awslabs.github.io/smithy/1.0/spec/aws/aws-json-1_1-protocol.html). Includes ecs. Total service count 105
-* Implement [AWS restXml protocol](https://awslabs.github.io/smithy/1.0/spec/aws/aws-restxml-protocol.html)
+* Implement [AWS restXml protocol](https://awslabs.github.io/smithy/1.0/spec/aws/aws-restxml-protocol.html). Includes S3. Total service count 4.
-* Implement [AWS EC2 query protocol](https://awslabs.github.io/smithy/1.0/spec/aws/aws-ec2-query-protocol.html)
+* ✓ Implement [AWS EC2 query protocol](https://awslabs.github.io/smithy/1.0/spec/aws/aws-ec2-query-protocol.html). Includes EC2. Total service count 1.
-
 
 Compiler wishlist/watchlist:
 

src/aws.zig

@@ -55,22 +55,32 @@ pub const Aws = struct {
         });
         log.debug("proto: {s}", .{service.aws_protocol});
 
+        // It seems as though there are 3 major branches of the 6 protocols.
+        // 1. query/ec2_query, which are identical until you get to complex
+        //    structures. TBD if the shortcut we're taking for query to make
+        //    it return json will work on EC2, but my guess is yes.
+        // 2. *json*: These three appear identical for input (possible difference
+        //    for empty body serialization), but differ in error handling.
+        //    We're not doing a lot of error handling here, though.
+        // 3. rest_xml: This is a one-off for S3, never used since
         switch (service.aws_protocol) {
-            .query => return self.callQuery(request, service, action, options),
+            .query, .ec2_query => return self.callQuery(request, service, action, options),
-            .ec2_query => @compileError("EC2 Query protocol not yet supported"),
+            .rest_json_1, .json_1_0, .json_1_1 => @compileError("REST Json, Json 1.0/1.1 protocol not yet supported"),
-            .rest_json_1 => @compileError("REST Json 1 protocol not yet supported"),
-            .json_1_0 => @compileError("Json 1.0 protocol not yet supported"),
-            .json_1_1 => @compileError("Json 1.1 protocol not yet supported"),
             .rest_xml => @compileError("REST XML protocol not yet supported"),
         }
     }
 
     // Call using query protocol. This is documented as an XML protocol, but
-    // throwing a JSON accept header seems to work
+    // throwing a JSON accept header seems to work. EC2Query is very simliar to
+    // Query, so we'll handle both here. Realistically we probably don't effectively
+    // handle lists and maps properly anyway yet, so we'll go for it and see
+    // where it breaks. PRs and/or failing test cases appreciated.
     fn callQuery(self: Self, comptime request: anytype, service: anytype, action: anytype, options: Options) !FullResponse(request) {
         var buffer = std.ArrayList(u8).init(self.allocator);
         defer buffer.deinit();
         const writer = buffer.writer();
+        // TODO: transformation function should be refactored for operation
+        // with a Writer passed in so we don't have to allocate
         const transformer = struct {
             allocator: *std.mem.Allocator,
 
@@ -98,6 +108,7 @@ pub const Aws = struct {
                 .sigv4_service_name = service.sigv4_name,
             },
         );
+        // TODO: Can response handling be reused?
         defer response.deinit();
         if (response.response_code != 200) {
             log.err("call failed! return status: {d}", .{response.response_code});