PUT/POST Requests for XML endpoints (e.g. S3 CreateBucket)

[deevus]

It's currently not possible to call any XML endpoints that require a struct for their payload such as S3 CreateBucket.

pub const create_bucket: struct {
    // ...
    Request: type = struct {
        // ...
        create_bucket_configuration: ?struct {
            location_constraint: ?[]const u8 = null,
            location: ?struct {
                type: ?[]const u8 = null,
                name: ?[]const u8 = null,

                pub fn fieldNameFor(_: @This(), comptime field_name: []const u8) []const u8 {
                    const mappings = .{
                        .type = "Type",
                        .name = "Name",
                    };
                    return @field(mappings, field_name);
                }
            } = null,
            bucket: ?struct {
                // ...
            } = null,

            // ...

        } = null,

        // ...

        pub const http_payload: []const u8 = "create_bucket_configuration";

        // ...

    },
    
    // ...
} = .{};

Code in question:

aws-sdk-for-zig/src/aws.zig

Lines 241 to 245 in ebb727c

	// We will assign the body to the value of the field denoted by
	// the http_payload declaration on the request type.
	// Hopefully these will always be ?[]const u8, otherwise
	// we should see a compile error on this line
	aws_request.body = @field(request, ActionRequest.http_payload).?;

It seems like it needs a way to convert the parameters into an XML string. Did you have any plans for that?

[deevus]

As the comment states, there is a compile error:

error: expected type '[]const u8', found 's3.create_bucket__struct_12352__struct_12357__struct_12488'
                        aws_request.body = @field(request, ActionRequest.http_payload).?;
                                           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^~
.zig-cache/o/f61facc5f6ef3305aeb8453fef86bd6d/src/models/s3.zig:443:39: note: struct declared here
        create_bucket_configuration: ?struct {

[deevus]

As a side note, it would be very nice to generate non-comptime structs for request parameters. That would greatly improve the developer experience.

[elerch]

rest_xml is a one-off just for S3. What is needed here is an XML serialization function (which is only used for S3).

I'll see what I can put together.

[elerch]

Pushed a few commits to address this...it is not on zig-develop yet but please take a look. I haven't used the SDK directly with create_bucket, but the unit test was based on traffic interception with the CLI and everything also matches the docs, so I'm pretty confident it should work as of f4c306a.

zig fetch --save https://git.lerch.org/api/packages/lobo/generic/aws-sdk-with-models/f4c306a2dfc1d54904466659cae50bbf04bfe5b2/f4c306a2dfc1d54904466659cae50bbf04bfe5b2-with-models.tar.gz hopefully will do the trick

[deevus]

This looks promising. I will test this week and let you know.

[deevus]

I haven't got around to this as I worked around using CreateBucket.

I'm using LocalStack to test our AWS interactions. It could be a great way to test here as well.