[codegen] Output-versioned function invokes

CHANGELOG_PENDING.md

@@ -1,15 +1,14 @@
 ### Improvements
 
-- Fix #547: Implement fully qualified imports for generated programs from PCL
-[#596](https://github.com/pulumi/pulumi-java/pull/596)
+- [codegen] **Breaking**
+  [#163](https://github.com/pulumi/pulumi-java/issues/163): function
+  invokes now accept `Output<T>` in their arguments and return
+  `Output<T>` instead of `CompletableFuture<T>`
+  [#612](https://github.com/pulumi/pulumi-java/pull/612).
 
-- Fix #419: Remove SDK dependency on Mockito
-
-- Support for using [jbang](https://jbang.dev)
-
-- Stack resource is now considered internal and cannot be directly instantiated by the user. 
-  The TestResult returned in tests is now an interface and no longer exposes fields.
+- [sdk] `Stack` resource is now considered internal and cannot be
+  directly instantiated by the user. Instead of inheriting from
+  `Stack`, please use the `Pulumi.run` form to define resources in
+  your stack as shown in the README.
 
 ### Bug Fixes
-
-Fix #627 - sanitize codegen sdk version input in pulumi-java-gen

pkg/codegen/java/gen.go

@@ -1514,14 +1514,25 @@ func (mod *modContext) genFunctions(ctx *classFileContext, addClass addClassMeth
 		resultClass := tokenToFunctionResultClassName(mod, fun.Token)
 		resultFQN := outputsPkg.Dot(resultClass)
 		inputsPkg := javaPkg.Dot(names.Ident("inputs"))
+
+		// Generating "{Function}Args" class for invokes that return Output<T>
+		// builders for this class allow outputs as inputs for their properties
 		argsClass := names.Ident(tokenToName(fun.Token) + "Args")
 		argsFQN := inputsPkg.Dot(argsClass)
 
+		// Generating "{Function}PlainArgs" class for invokes that return CompletableFuture<T>
+		// builders for this class only allow non-outputs as inputs for their properties
+		plainArgsClass := names.Ident(tokenToName(fun.Token) + "PlainArgs")
+		plainArgsFQN := inputsPkg.Dot(plainArgsClass)
+
 		var argsType string
+		var plainArgsType string
 		if fun.Inputs == nil {
 			argsType = ctx.ref(names.InvokeArgs)
+			plainArgsType = ctx.ref(names.InvokeArgs)
 		} else {
 			argsType = ctx.ref(argsFQN)
+			plainArgsType = ctx.ref(plainArgsFQN)
 		}
 
 		var returnType string
@@ -1531,44 +1542,93 @@ func (mod *modContext) genFunctions(ctx *classFileContext, addClass addClassMeth
 			returnType = ctx.imports.Ref(names.Void)
 		}
 
+		// default method name returns Output<ReturnType>
 		methodName := tokenToFunctionName(fun.Token)
 
+		// another "plain" overload will return CompletableFuture<ReturnType>
+		plainMethodName := methodName + "Plain"
+
 		// Emit datasource inputs method
 		invokeOptions := ctx.ref(names.InvokeOptions)
 
 		if hasAllOptionalInputs(fun) {
+			// Generate invoke that return Output<T>
 			printCommentFunction(ctx, fun, indent)
-			// Add no args invoke
+			// Add no args invoke (returns Output<T>)
 			fprintf(w, "    public static %s<%s> %s() {\n",
-				ctx.ref(names.CompletableFuture), returnType, methodName)
+				ctx.ref(names.Output), returnType, methodName)
 			fprintf(w,
 				"        return %s(%s.Empty, %s.Empty);\n",
 				methodName, argsType, invokeOptions)
 			fprintf(w, "    }\n")
 
+			// Generate invoke that return CompletableFuture<T>
+			printCommentFunction(ctx, fun, indent)
+			fprintf(w, "    public static %s<%s> %s() {\n",
+				ctx.ref(names.CompletableFuture), returnType, plainMethodName)
+			fprintf(w,
+				"        return %s(%s.Empty, %s.Empty);\n",
+				plainMethodName, plainArgsType, invokeOptions)
+			fprintf(w, "    }\n")
 		}
 
-		// Add args only invoke
+		// Output version: add args only invoke
 		printCommentFunction(ctx, fun, indent)
 		fprintf(w, "    public static %s<%s> %s(%s args) {\n",
-			ctx.ref(names.CompletableFuture), returnType, methodName, argsType)
+			ctx.ref(names.Output), returnType, methodName, argsType)
 		fprintf(w,
 			"        return %s(args, %s.Empty);\n",
 			methodName, invokeOptions)
 		fprintf(w, "    }\n")
 
-		// Add full invoke
+		// CompletableFuture version: add args only invoke
+		printCommentFunction(ctx, fun, indent)
+		fprintf(w, "    public static %s<%s> %s(%s args) {\n",
+			ctx.ref(names.CompletableFuture), returnType, plainMethodName, plainArgsType)
+		fprintf(w,
+			"        return %s(args, %s.Empty);\n",
+			plainMethodName, invokeOptions)
+		fprintf(w, "    }\n")
+
+		// Output version: add full invoke
 		printCommentFunction(ctx, fun, indent)
 		fprintf(w, "    public static %s<%s> %s(%s args, %s options) {\n",
-			ctx.ref(names.CompletableFuture), returnType, methodName, argsType, invokeOptions)
+			ctx.ref(names.Output), returnType, methodName, argsType, invokeOptions)
+		fprintf(w,
+			"        return %s.getInstance().invoke(\"%s\", %s.of(%s.class), args, %s.withVersion(options));\n",
+			ctx.ref(names.Deployment), fun.Token, ctx.ref(names.TypeShape), returnType, mod.utilitiesRef(ctx))
+		fprintf(w, "    }\n")
+
+		// CompletableFuture version: add full invoke
+		// notice how the implementation now uses `invokeAsync` instead of `invoke`
+		printCommentFunction(ctx, fun, indent)
+		fprintf(w, "    public static %s<%s> %s(%s args, %s options) {\n",
+			ctx.ref(names.CompletableFuture), returnType, plainMethodName, plainArgsType, invokeOptions)
 		fprintf(w,
 			"        return %s.getInstance().invokeAsync(\"%s\", %s.of(%s.class), args, %s.withVersion(options));\n",
 			ctx.ref(names.Deployment), fun.Token, ctx.ref(names.TypeShape), returnType, mod.utilitiesRef(ctx))
 		fprintf(w, "    }\n")
 
 		// Emit the args and result types, if any.
 		if fun.Inputs != nil {
+			// Generate "{Function}Args" class for invokes that return Output<T>
+			// Notice here using fun.Inputs.InputShape.Properties which use the shape which accepting Outputs
 			if err := addClass(inputsPkg, argsClass, func(ctx *classFileContext) error {
+				args := &plainType{
+					mod:                   mod,
+					name:                  ctx.className.String(),
+					baseClass:             "com.pulumi.resources.InvokeArgs",
+					propertyTypeQualifier: inputsQualifier,
+					properties:            fun.Inputs.InputShape.Properties,
+				}
+				return args.genInputType(ctx)
+			}); err != nil {
+				return err
+			}
+
+			// Generate "{Function}PlainArgs" class for invokes that return CompletableFuture<T>
+			// Notice here using fun.Inputs.Properties which use the plain shape (not accepting Outputs)
+			if err := addClass(inputsPkg, plainArgsClass, func(ctx *classFileContext) error {
 				args := &plainType{
 					mod:                   mod,
 					name:                  ctx.className.String(),

pkg/codegen/java/gen_program.go

@@ -869,12 +869,9 @@ func (g *generator) genLocalVariable(w io.Writer, localVariable *pcl.LocalVariab
 	g.genIndent(w)
 	if isInvokeCall {
 		g.functionInvokes[variableName] = functionSchema
-		// convert CompletableFuture<T> to Output<T> using Output.of
-		// TODO: call the Output<T>-version of invokes when the SDK allows it.
-		functionDefinition := outputOf(localVariable.Definition.Value)
 		// TODO: lowerExpression isn't what we expect: function call should extract outputs into .apply(...) calls
 		//functionDefinitionWithApplies := g.lowerExpression(functionDefinition, localVariable.Definition.Value.Type())
-		g.Fgenf(w, "final var %s = %v;\n", variableName, functionDefinition)
+		g.Fgenf(w, "final var %s = %v;\n", variableName, localVariable.Definition.Value)
 	} else {
 		variable := localVariable.Definition.Value
 		g.Fgenf(w, "final var %s = %v;\n", variableName, g.lowerExpression(variable, variable.Type()))

pkg/codegen/java/gen_program_expressions.go

@@ -203,26 +203,6 @@ func (g *generator) functionName(tokenArg model.Expression) (string, string) {
 	return names.Title(module) + "Functions" + "." + member, names.Title(member)
 }
 
-// outputOf creates a new call to the output intrinsic.
-func outputOf(promise model.Expression) model.Expression {
-	promiseType, ok := promise.Type().(*model.PromiseType)
-	if !ok {
-		return promise
-	}
-
-	return &model.FunctionCallExpression{
-		Name: intrinsicOutput,
-		Signature: model.StaticFunctionSignature{
-			Parameters: []model.Parameter{{
-				Name: "promise",
-				Type: promiseType,
-			}},
-			ReturnType: model.NewOutputType(promiseType.ElementType),
-		},
-		Args: []model.Expression{promise},
-	}
-}
-
 func (g *generator) GenFunctionCallExpression(w io.Writer, expr *model.FunctionCallExpression) {
 	switch expr.Name {
 	case pcl.IntrinsicConvert:

pkg/codegen/java/gen_test.go

@@ -35,6 +35,10 @@ var javaSpecificTests = []*test.SDKTest{
 		Directory:   "mini-awsx",
 		Description: "Regression tests extracted from trying to codegen awsx",
 	},
+	{
+		Directory:   "output-funcs-edgeorder",
+		Description: "Testing EdgeOrder functions which return Output<T>",
+	},
 }
 
 func adaptTest(t *test.SDKTest) *test.SDKTest {
@@ -54,8 +58,6 @@ func adaptTest(t *test.SDKTest) *test.SDKTest {
 		t.Skip = codegen.NewStringSet("java/any") // TODO
 	case "plain-object-defaults":
 		t.Skip = codegen.NewStringSet("java/any") // TODO
-	case "output-funcs":
-		t.Skip = codegen.NewStringSet("java/any") // TODO
 	case "regress-8403":
 		t.Skip = codegen.NewStringSet("java/any") // TODO
 	case "plain-object-disable-defaults":

pkg/codegen/java/typeshape.go

@@ -187,6 +187,13 @@ func (ts TypeShape) Optional() TypeShape {
 	}
 }
 
+func (ts TypeShape) Output() TypeShape {
+	return TypeShape{
+		Type:       names.Output,
+		Parameters: []TypeShape{ts},
+	}
+}
+
 func (ts TypeShape) UnOptional() (bool, TypeShape) {
 	if ts.Type.Equal(names.Optional) {
 		return true, ts.Parameters[0]

pkg/codegen/testing/test/testdata/aws-eks-pp/MyStack.java

@@ -66,7 +66,7 @@ public static void stack(Context ctx) {
             .tags(Map.of("Name", "pulumi-vpc-rt"))
             .build());
 
-        final var zones = Output.of(AwsFunctions.getAvailabilityZones());
+        final var zones = AwsFunctions.getAvailabilityZones();
 
         final var vpcSubnet = zones.applyValue(getAvailabilityZonesResult -> {
             final var resources = new ArrayList<Subnet>();

pkg/codegen/testing/test/testdata/aws-fargate-pp/MyStack.java

@@ -43,13 +43,13 @@ public static void main(String[] args) {
     }
 
     public static void stack(Context ctx) {
-        final var vpc = Output.of(Ec2Functions.getVpc(GetVpcArgs.builder()
+        final var vpc = Ec2Functions.getVpc(GetVpcArgs.builder()
             .default_(true)
-            .build()));
+            .build());
 
-        final var subnets = Output.of(Ec2Functions.getSubnetIds(GetSubnetIdsArgs.builder()
+        final var subnets = Ec2Functions.getSubnetIds(GetSubnetIdsArgs.builder()
             .vpcId(vpc.applyValue(getVpcResult -> getVpcResult.id()))
-            .build()));
+            .build());
 
         var webSecurityGroup = new SecurityGroup("webSecurityGroup", SecurityGroupArgs.builder()        
             .vpcId(vpc.applyValue(getVpcResult -> getVpcResult.id()))

pkg/codegen/testing/test/testdata/aws-webserver-pp/MyStack.java

@@ -32,14 +32,14 @@ public static void stack(Context ctx) {
                 .build())
             .build());
 
-        final var ami = Output.of(AwsFunctions.getAmi(GetAmiArgs.builder()
+        final var ami = AwsFunctions.getAmi(GetAmiArgs.builder()
             .filters(GetAmiFilterArgs.builder()
                 .name("name")
                 .values("amzn-ami-hvm-*-x86_64-ebs")
                 .build())
             .owners("137112412989")
             .mostRecent(true)
-            .build()));
+            .build());
 
         var server = new Instance("server", InstanceArgs.builder()        
             .tags(Map.of("Name", "web-server-www"))

pkg/codegen/testing/test/testdata/azure-sa-pp/MyStack.java

@@ -23,9 +23,9 @@ public static void stack(Context ctx) {
         final var config = ctx.config();
         final var storageAccountNameParam = config.get("storageAccountNameParam");
         final var resourceGroupNameParam = config.get("resourceGroupNameParam");
-        final var resourceGroupVar = Output.of(CoreFunctions.getResourceGroup(GetResourceGroupArgs.builder()
+        final var resourceGroupVar = CoreFunctions.getResourceGroup(GetResourceGroupArgs.builder()
             .name(resourceGroupNameParam)
-            .build()));
+            .build());
 
         final var locationParam = config.get("locationParam").orElse(resourceGroupVar.applyValue(getResourceGroupResult -> getResourceGroupResult.location()));
         final var storageAccountTierParam = config.get("storageAccountTierParam").orElse("Standard");

pkg/codegen/testing/test/testdata/mini-awsclassic/java/codegen-manifest.json

@@ -10,6 +10,7 @@
     "src/main/java/com/pulumi/aws/config_endpoints/inputs/Endpoints.java",
     "src/main/java/com/pulumi/aws/ec2_getAmi/Ec2_getAmiFunctions.java",
     "src/main/java/com/pulumi/aws/ec2_getAmi/inputs/GetAmiArgs.java",
+    "src/main/java/com/pulumi/aws/ec2_getAmi/inputs/GetAmiPlainArgs.java",
     "src/main/java/com/pulumi/aws/ec2_getAmi/outputs/GetAmiResult.java",
     "src/main/java/com/pulumi/aws/iam_instanceProfile/InstanceProfile.java",
     "src/main/java/com/pulumi/aws/iam_instanceProfile/InstanceProfileArgs.java",

pkg/codegen/testing/test/testdata/mini-awsclassic/java/src/main/java/com/pulumi/aws/ec2_getAmi/Ec2_getAmiFunctions.java

@@ -5,17 +5,25 @@
 
 import com.pulumi.aws.Utilities;
 import com.pulumi.aws.ec2_getAmi.inputs.GetAmiArgs;
+import com.pulumi.aws.ec2_getAmi.inputs.GetAmiPlainArgs;
 import com.pulumi.aws.ec2_getAmi.outputs.GetAmiResult;
+import com.pulumi.core.Output;
 import com.pulumi.core.TypeShape;
 import com.pulumi.deployment.Deployment;
 import com.pulumi.deployment.InvokeOptions;
 import java.util.concurrent.CompletableFuture;
 
 public final class Ec2_getAmiFunctions {
-    public static CompletableFuture<GetAmiResult> getAmi(GetAmiArgs args) {
+    public static Output<GetAmiResult> getAmi(GetAmiArgs args) {
         return getAmi(args, InvokeOptions.Empty);
     }
-    public static CompletableFuture<GetAmiResult> getAmi(GetAmiArgs args, InvokeOptions options) {
+    public static CompletableFuture<GetAmiResult> getAmiPlain(GetAmiPlainArgs args) {
+        return getAmiPlain(args, InvokeOptions.Empty);
+    }
+    public static Output<GetAmiResult> getAmi(GetAmiArgs args, InvokeOptions options) {
+        return Deployment.getInstance().invoke("aws:ec2/getAmi:getAmi", TypeShape.of(GetAmiResult.class), args, Utilities.withVersion(options));
+    }
+    public static CompletableFuture<GetAmiResult> getAmiPlain(GetAmiPlainArgs args, InvokeOptions options) {
         return Deployment.getInstance().invokeAsync("aws:ec2/getAmi:getAmi", TypeShape.of(GetAmiResult.class), args, Utilities.withVersion(options));
     }
 }