Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

generate auth params and bindings #453

Merged
merged 2 commits into from
Sep 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,11 @@ void execute() {
protocolGenerator.generateEndpointResolution(context);
});

writers.useFileWriter("auth.go", settings.getModuleName(), writer -> {
ProtocolGenerator.GenerationContext context = contextBuilder.writer(writer).build();
protocolGenerator.generateAuth(context);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should auth scheme generation be part of protocol generation? i remember the reasoning we used to put endpoint generation in there. we made the argument that an endpoint does have the transport protocol baked into it, so it is tied to a protocol. and the upside was that putting endpoint generation in protocol generation guarantees only one will be chosen.
i think this same sort of reasoning could be applied to auth scheme.
but im second-guessing whether we should have put endpoint generation in there at all. i think if we put auth scheme in protocol generation as well, we should prob get a better understanding of what belongs in here and what doesnt

});

writers.useFileWriter("endpoints_test.go", settings.getModuleName(), writer -> {
ProtocolGenerator.GenerationContext context = contextBuilder.writer(writer).build();
protocolGenerator.generateEndpointResolutionTests(context);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,32 +21,33 @@
* Collection of Symbol constants for golang universe types.
* See <a href="https://go.dev/ref/spec#Predeclared_identifiers">predeclared identifiers</a>.
*/
@SuppressWarnings("checkstyle:ConstantName")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit, but is this because the constant names aren't all uppercased?

public final class GoUniverseTypes {
public static Symbol tAny = universe("any");
public static Symbol tBool = universe("bool");
public static Symbol tByte = universe("byte");
public static Symbol tComparable = universe("comparable");

public static Symbol tComplex64 = universe("complex64");
public static Symbol tComplex128 = universe("complex128");
public static Symbol tError = universe("error");
public static Symbol tFloat32 = universe("float32");
public static Symbol tFloat64 = universe("float64");

public static Symbol tInt = universe("int");
public static Symbol tInt8 = universe("int8");
public static Symbol tInt16 = universe("int16");
public static Symbol tInt32 = universe("int32");
public static Symbol tInt64 = universe("int64");
public static Symbol tRune = universe("rune");
public static Symbol tString = universe("string");

public static Symbol tUint = universe("uint");
public static Symbol tUint8 = universe("uint8");
public static Symbol tUint16 = universe("uint16");
public static Symbol tUint32 = universe("uint32");
public static Symbol tUint64 = universe("uint64");
public static Symbol tUintptr = universe("uintptr");
public static final Symbol Any = universe("any");
public static final Symbol Bool = universe("bool");
public static final Symbol Byte = universe("byte");
public static final Symbol Comparable = universe("comparable");

public static final Symbol Complex64 = universe("complex64");
public static final Symbol Complex128 = universe("complex128");
public static final Symbol Error = universe("error");
public static final Symbol Float32 = universe("float32");
public static final Symbol Float64 = universe("float64");

public static final Symbol Int = universe("int");
public static final Symbol Int8 = universe("int8");
public static final Symbol Int16 = universe("int16");
public static final Symbol Int32 = universe("int32");
public static final Symbol Int64 = universe("int64");
public static final Symbol Rune = universe("rune");
public static final Symbol String = universe("string");

public static final Symbol Uint = universe("uint");
public static final Symbol Uint8 = universe("uint8");
public static final Symbol Uint16 = universe("uint16");
public static final Symbol Uint32 = universe("uint32");
public static final Symbol Uint64 = universe("uint64");
public static final Symbol Uintptr = universe("uintptr");

private GoUniverseTypes() {}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,15 @@ public void run() {
.renderStructure(() -> {
}, true);

writer.write("""
func (*$T) operationName() string {
return $S
}
""",
inputSymbol,
operationSymbol.getName()
);

// The output structure gets a metadata member added.
Symbol metadataSymbol = SymbolUtils.createValueSymbolBuilder("Metadata", SmithyGoDependency.SMITHY_MIDDLEWARE)
.build();
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
/*
* Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/

package software.amazon.smithy.go.codegen.auth;

import software.amazon.smithy.codegen.core.CodegenException;
import software.amazon.smithy.go.codegen.integration.ProtocolGenerator;

/**
* Entry point into smithy client auth generation.
*/
public class AuthGenerator {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: would annotate this with @SmithyInternalApi

private final ProtocolGenerator.GenerationContext context;

public AuthGenerator(ProtocolGenerator.GenerationContext context) {
this.context = context;
}

public void generate() {
if (context.getWriter().isEmpty()) {
throw new CodegenException("writer is required");
}

context.getWriter().get()
.write("$W", new AuthParametersGenerator(context).generate())
.write("")
.write("$W", new AuthParametersResolverGenerator(context).generate());
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
/*
* Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/

package software.amazon.smithy.go.codegen.auth;

import software.amazon.smithy.codegen.core.Symbol;
import software.amazon.smithy.go.codegen.GoUniverseTypes;

public record AuthParameter(String name, String docs, Symbol type) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: would annotate this with @SmithyInternalApi

public static final AuthParameter OPERATION = new AuthParameter(
"Operation",
"The name of the operation being invoked.",
GoUniverseTypes.String
);

public static final AuthParameter REGION = new AuthParameter(
"Region",
"The region in which the operation is being invoked.",
GoUniverseTypes.String
);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
/*
* Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/

package software.amazon.smithy.go.codegen.auth;

import static software.amazon.smithy.go.codegen.GoWriter.goDocTemplate;
import static software.amazon.smithy.go.codegen.GoWriter.goTemplate;

import java.util.ArrayList;
import software.amazon.smithy.codegen.core.Symbol;
import software.amazon.smithy.go.codegen.GoWriter;
import software.amazon.smithy.go.codegen.SymbolUtils;
import software.amazon.smithy.go.codegen.integration.ProtocolGenerator;
import software.amazon.smithy.utils.ListUtils;
import software.amazon.smithy.utils.MapUtils;

/**
* Generates auth scheme resolver parameters.
* By default, the only field that exists universally is the name of the operation being invoked. Services that use
* SigV4[A] will also have a field for the region.
* Additional parameters can be loaded via GoIntegration.
*/
public class AuthParametersGenerator {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: would annotate this with @SmithyInternalApi

public static final String STRUCT_NAME = "AuthResolverParameters";

public static final Symbol STRUCT_SYMBOL = SymbolUtils.createPointableSymbolBuilder(STRUCT_NAME).build();

private final ProtocolGenerator.GenerationContext context;

private final ArrayList<AuthParameter> fields = new ArrayList<>(
ListUtils.of(AuthParameter.OPERATION)
);

public AuthParametersGenerator(ProtocolGenerator.GenerationContext context) {
this.context = context;
}

public GoWriter.Writable generate() {
loadFields();

return goTemplate(
"""
$doc:W
type $name:L struct {
$fields:W
}
""",
MapUtils.of(
"doc", generateDocs(),
"name", STRUCT_NAME,
"fields", generateFields()
)
);
}

private GoWriter.Writable generateDocs() {
return goDocTemplate(
"$name:L contains the set of inputs necessary for auth scheme resolution.",
MapUtils.of("name", STRUCT_NAME)
);
}

private GoWriter.Writable generateFields() {
return (writer) -> {
for (var field: fields) {
writer.write("""
$W
$L $P
""",
goDocTemplate(field.docs()),
field.name(),
field.type()
);
}
};
}

private void loadFields() {
for (var integration: context.getIntegrations()) {
var plugins = integration.getClientPlugins().stream().filter(it ->
it.matchesService(context.getModel(), context.getService())).toList();
for (var plugin: plugins) {
fields.addAll(plugin.getAuthParameters());
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
/*
* Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/

package software.amazon.smithy.go.codegen.auth;

import software.amazon.smithy.codegen.core.Symbol;

public record AuthParametersResolver(Symbol resolver) { }
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: would annotate this with @SmithyInternalApi

Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
/*
* Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/

package software.amazon.smithy.go.codegen.auth;

import static software.amazon.smithy.go.codegen.GoWriter.goTemplate;

import java.util.ArrayList;
import software.amazon.smithy.codegen.core.Symbol;
import software.amazon.smithy.go.codegen.GoWriter;
import software.amazon.smithy.go.codegen.SymbolUtils;
import software.amazon.smithy.go.codegen.integration.ProtocolGenerator;
import software.amazon.smithy.utils.MapUtils;

/**
* Generates a single method which binds auth scheme resolver parameters from operation input and client options.
* The only value bound by default is the operation name. Generators must load additional bindings through
* GoIntegration.
*/
public class AuthParametersResolverGenerator {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: would annotate this with @SmithyInternalApi

public static final String FUNC_NAME = "bindAuthResolverParams";

public static final Symbol FUNC_SYMBOL = SymbolUtils.createValueSymbolBuilder(FUNC_NAME).build();

private final ProtocolGenerator.GenerationContext context;

private final ArrayList<AuthParametersResolver> resolvers = new ArrayList<>();

public AuthParametersResolverGenerator(ProtocolGenerator.GenerationContext context) {
this.context = context;
}

public GoWriter.Writable generate() {
loadResolvers();

return goTemplate("""
$operationNamer:W

func $name:L(input interface{}, options Options) $params:P {
params := &$params:T{
Operation: input.(operationNamer).operationName(),
}

$bindings:W

return params
}
""",
MapUtils.of(
"name", FUNC_NAME,
"operationNamer", generateOperationNamer(),
"params", AuthParametersGenerator.STRUCT_SYMBOL,
"bindings", generateResolvers()
));
}

private GoWriter.Writable generateOperationNamer() {
return (writer) -> {
writer.write("""
type operationNamer interface {
operationName() string
}
""");
};
}

private GoWriter.Writable generateResolvers() {
return (writer) -> {
for (var resolver: resolvers) {
writer.write("$T(params, input, options)", resolver.resolver());
}
};
}

private void loadResolvers() {
for (var integration: context.getIntegrations()) {
var plugins = integration.getClientPlugins().stream().filter(it ->
it.matchesService(context.getModel(), context.getService())).toList();
for (var plugin: plugins) {
resolvers.addAll(plugin.getAuthParameterResolvers());
}
}
}
}
Loading
Loading