Generate header methods

Summary:
Internal :
User post -https://fb.workplace.com/groups/thriftusers/permalink/1451667708875970/

Context: Hack Thrift Client throws away rpc headers received as part of the response from server. In c++, the common <rpc> method also throws away the headers but based on an annotation - GenerateDeprecatedHeaderClientMethods, an additional method header_<rpc> is generated that would return the headers along with response.

This diff :

- uses the annotation added in previous diff to generate `header_` methods.
  - when present, the common `<rpc>` method would call `<header_rpc>` method and discard the header. This reduces the duplicate code between the two
- In addition `genAwaitResponse` is replaces with `genAwaitResponseWithHeaders`, so that we can change the `genAwaitResponse` to return headers and eventually remove `genAwaitResponseWithHeaders`.
  - instead of discarding headers in `genAwaitResponse`, headers will be discarded in `<rpc>`.

Reviewed By: iahs

Differential Revision: D70428261

fbshipit-source-id: b566e5aa73d1ca6821f4ea1e612c51856b42b382

Author: Rashmi Makheja

third-party/thrift/src/thrift/compiler/ast/uri.h

@@ -170,6 +170,8 @@ inline constexpr auto kHackWrapperUri =
     "facebook.com/thrift/annotation/hack/Wrapper";
 inline constexpr auto kHackModuleInternalUri =
     "facebook.com/thrift/annotation/hack/ModuleInternal";
+inline constexpr auto kHackGenerateClientMethodsWithHeaders =
+    "facebook.com/thrift/annotation/hack/GenerateClientMethodsWithHeaders";
 
 // Go:
 inline constexpr auto kGoNameUri = "facebook.com/thrift/annotation/go/Name";

third-party/thrift/src/thrift/compiler/generate/t_hack_generator.cc

@@ -887,6 +887,11 @@ class t_hack_generator : public t_concat_generator {
         nullptr;
   }
 
+  bool should_generate_client_header_methods(const t_named* tnamed) const {
+    return tnamed->find_structured_annotation_or_null(
+               kHackGenerateClientMethodsWithHeaders) != nullptr;
+  }
+
   std::string php_namespace(const t_program* p) const {
     std::string php_ns = p->get_namespace("php");
     if (!php_ns.empty()) {
@@ -7133,6 +7138,11 @@ void t_hack_generator::_generate_service_client_child_fn(
     return;
   }
 
+  bool is_oneway = tfunction->qualifier() == t_function_qualifier::oneway;
+  bool gen_header_method = !is_oneway &&
+      (should_generate_client_header_methods(tfunction) ||
+       should_generate_client_header_methods(tservice));
+  bool is_void = tfunction->return_type()->is_void();
   std::string funname =
       find_hack_name(tfunction) + (legacy_arrays ? "__LEGACY_ARRAYS" : "");
   std::string long_name = php_servicename_mangle(mangled_services_, tservice);
@@ -7144,16 +7154,44 @@ void t_hack_generator::_generate_service_client_child_fn(
       type_to_typehint(tfunction->return_type().get_type());
 
   generate_php_docstring(out, tfunction);
-  indent(out) << (has_hack_module_internal(tservice) ||
-                          has_hack_module_internal(tfunction)
-                      ? "internal"
-                      : "public")
-              << " async function " << funname << "("
-              << argument_list(
-                     tfunction->params(), "", true, nullable_everything_)
-              << "): Awaitable<" + return_typehint + "> {\n";
+  auto generate_method_decl = [&](bool is_header_method) {
+    indent(out) << (has_hack_module_internal(tservice) ||
+                            has_hack_module_internal(tfunction)
+                        ? "internal"
+                        : "public")
+                << " async function " << (is_header_method ? "header_" : "")
+                << funname << "("
+                << argument_list(
+                       tfunction->params(), "", true, nullable_everything_)
+                << "): Awaitable<";
+
+    if (is_header_method) {
+      if (!is_void) {
+        out << "(" << return_typehint << ", ?dict<string,string>)";
+      } else {
+        out << "?dict<string,string>";
+      }
+    } else {
+      out << return_typehint;
+    }
+    out << "> {\n";
+  };
 
+  generate_method_decl(false);
   indent_up();
+  if (gen_header_method) {
+    indent(out) << (!is_void ? "return (" : "") << "await $this->header_"
+                << funname << "("
+                << argument_list(tfunction->params(), "", false) << ")";
+    if (!is_void) {
+      out << ")[0]";
+    }
+    out << ";\n";
+    scope_down(out);
+    out << "\n";
+    generate_method_decl(true);
+    indent_up();
+  }
 
   indent(out) << "$hh_frame_metadata = $this->getHHFrameMetadata();\n";
   indent(out) << "if ($hh_frame_metadata !== null) {\n";
@@ -7178,24 +7216,40 @@ void t_hack_generator::_generate_service_client_child_fn(
               << "\", $args);\n";
   _generate_current_seq_id(out, tservice, tfunction);
 
-  if (tfunction->qualifier() != t_function_qualifier::oneway) {
-    if (!tfunction->return_type()->is_void()) {
-      indent(out) << "return ";
+  if (is_oneway) {
+    out << indent() << "await $this->genAwaitNoResponse($rpc_options);\n";
+    scope_down(out);
+    out << "\n";
+    return;
+  }
+
+  std::string resultname = generate_function_helper_name(
+      tservice, tfunction, PhpFunctionNameSuffix::RESULT);
+
+  std::string rpc_call = fmt::format(
+      "await $this->genAwaitResponseWithReadHeaders({}::class, \"{}\", {}, $currentseqid, $rpc_options{})",
+      resultname,
+      tfunction->name(),
+      is_void ? "true" : "false",
+      legacy_arrays ? ", shape('read_options' => \\THRIFT_MARK_LEGACY_ARRAYS)"
+                    : "");
+
+  if (gen_header_method) {
+    if (is_void) {
+      // return headers only if void
+      indent(out) << "return (" << rpc_call << ")[1];\n";
     } else {
-      indent(out);
+      // return both response and headers
+      indent(out) << "return " << rpc_call << ";\n";
     }
-    std::string resultname = generate_function_helper_name(
-        tservice, tfunction, PhpFunctionNameSuffix::RESULT);
-    bool is_void = tfunction->return_type()->is_void();
-    out << "await $this->genAwaitResponse(" << resultname << "::class, " << "\""
-        << tfunction->name() << "\", " << (is_void ? "true" : "false")
-        << ", $currentseqid, $rpc_options";
-    if (legacy_arrays) {
-      out << ", shape('read_options' => \\THRIFT_MARK_LEGACY_ARRAYS)";
-    }
-    out << ");\n";
   } else {
-    out << indent() << "await $this->genAwaitNoResponse($rpc_options);\n";
+    // return nothing if void
+    if (is_void) {
+      indent(out) << rpc_call << ";\n";
+    } else {
+      // return response only
+      indent(out) << "return (" << rpc_call << ")[0];\n";
+    }
   }
   scope_down(out);
   out << "\n";

third-party/thrift/src/thrift/compiler/test/fixtures/adapter/out/hack/gen-hack/AdapterService.php

@@ -100,7 +100,7 @@ trait AdapterServiceClientBase {
     $args = \facebook\thrift\test\AdapterService_count_args::withDefaultValues();
     await $this->asyncHandler_->genBefore(AdapterServiceStaticMetadata::THRIFT_SVC_NAME, "count", $args);
     $currentseqid = $this->sendImplHelper($args, "count", false, AdapterServiceStaticMetadata::THRIFT_SVC_NAME );
-    return await $this->genAwaitResponse(\facebook\thrift\test\AdapterService_count_result::class, "count", false, $currentseqid, $rpc_options);
+    return (await $this->genAwaitResponseWithReadHeaders(\facebook\thrift\test\AdapterService_count_result::class, "count", false, $currentseqid, $rpc_options))[0];
   }
 
   /**
@@ -119,7 +119,7 @@ trait AdapterServiceClientBase {
     ));
     await $this->asyncHandler_->genBefore(AdapterServiceStaticMetadata::THRIFT_SVC_NAME, "adaptedTypes", $args);
     $currentseqid = $this->sendImplHelper($args, "adaptedTypes", false, AdapterServiceStaticMetadata::THRIFT_SVC_NAME );
-    return await $this->genAwaitResponse(\facebook\thrift\test\AdapterService_adaptedTypes_result::class, "adaptedTypes", false, $currentseqid, $rpc_options);
+    return (await $this->genAwaitResponseWithReadHeaders(\facebook\thrift\test\AdapterService_adaptedTypes_result::class, "adaptedTypes", false, $currentseqid, $rpc_options))[0];
   }
 
 }

third-party/thrift/src/thrift/compiler/test/fixtures/adapter/out/hack/gen-hack/Service.php

@@ -91,7 +91,7 @@ trait ServiceClientBase {
     ));
     await $this->asyncHandler_->genBefore(ServiceStaticMetadata::THRIFT_SVC_NAME, "func", $args);
     $currentseqid = $this->sendImplHelper($args, "func", false, ServiceStaticMetadata::THRIFT_SVC_NAME );
-    return await $this->genAwaitResponse(\facebook\thrift\test\Service_func_result::class, "func", false, $currentseqid, $rpc_options);
+    return (await $this->genAwaitResponseWithReadHeaders(\facebook\thrift\test\Service_func_result::class, "func", false, $currentseqid, $rpc_options))[0];
   }
 
 }

third-party/thrift/src/thrift/compiler/test/fixtures/basic-annotations/out/hack/gen-hack/BadService.php

@@ -80,7 +80,7 @@ public function createBadInteraction(): BadService_BadInteraction {
     $args = BadService_bar_args::withDefaultValues();
     await $this->asyncHandler_->genBefore(BadServiceStaticMetadata::THRIFT_SVC_NAME, "bar", $args);
     $currentseqid = $this->sendImplHelper($args, "bar", false, BadServiceStaticMetadata::THRIFT_SVC_NAME );
-    return await $this->genAwaitResponse(BadService_bar_result::class, "bar", false, $currentseqid, $rpc_options);
+    return (await $this->genAwaitResponseWithReadHeaders(BadService_bar_result::class, "bar", false, $currentseqid, $rpc_options))[0];
   }
 
 }
@@ -130,7 +130,7 @@ public function __construct(\TProtocol $input, ?\TProtocol $output = null, ?\ITh
     $args = BadService_BadInteraction_foo_args::withDefaultValues();
     await $this->asyncHandler_->genBefore("BadService", "BadInteraction.foo", $args);
     $currentseqid = $this->sendImpl_foo();
-    await $this->genAwaitResponse(BadService_BadInteraction_foo_result::class, "foo", true, $currentseqid, $rpc_options);
+    await $this->genAwaitResponseWithReadHeaders(BadService_BadInteraction_foo_result::class, "foo", true, $currentseqid, $rpc_options);
   }
 
   protected function sendImpl_foo(): int {

third-party/thrift/src/thrift/compiler/test/fixtures/basic-annotations/out/hack/gen-hack/FooBarBazService.php

@@ -115,7 +115,7 @@ trait FooBarBazServiceClientBase {
     $args = FooBarBazService_foo_args::withDefaultValues();
     await $this->asyncHandler_->genBefore(FooBarBazServiceStaticMetadata::THRIFT_SVC_NAME, "foo", $args);
     $currentseqid = $this->sendImplHelper($args, "foo", false, FooBarBazServiceStaticMetadata::THRIFT_SVC_NAME );
-    await $this->genAwaitResponse(FooBarBazService_foo_result::class, "foo", true, $currentseqid, $rpc_options);
+    await $this->genAwaitResponseWithReadHeaders(FooBarBazService_foo_result::class, "foo", true, $currentseqid, $rpc_options);
   }
 
   /**
@@ -132,7 +132,7 @@ trait FooBarBazServiceClientBase {
     $args = FooBarBazService_bar_args::withDefaultValues();
     await $this->asyncHandler_->genBefore(FooBarBazServiceStaticMetadata::THRIFT_SVC_NAME, "bar", $args);
     $currentseqid = $this->sendImplHelper($args, "bar", false, FooBarBazServiceStaticMetadata::THRIFT_SVC_NAME );
-    await $this->genAwaitResponse(FooBarBazService_bar_result::class, "bar", true, $currentseqid, $rpc_options);
+    await $this->genAwaitResponseWithReadHeaders(FooBarBazService_bar_result::class, "bar", true, $currentseqid, $rpc_options);
   }
 
   /**
@@ -149,7 +149,7 @@ trait FooBarBazServiceClientBase {
     $args = FooBarBazService_baz_args::withDefaultValues();
     await $this->asyncHandler_->genBefore(FooBarBazServiceStaticMetadata::THRIFT_SVC_NAME, "baz", $args);
     $currentseqid = $this->sendImplHelper($args, "baz", false, FooBarBazServiceStaticMetadata::THRIFT_SVC_NAME );
-    await $this->genAwaitResponse(FooBarBazService_baz_result::class, "baz", true, $currentseqid, $rpc_options);
+    await $this->genAwaitResponseWithReadHeaders(FooBarBazService_baz_result::class, "baz", true, $currentseqid, $rpc_options);
   }
 
 }

third-party/thrift/src/thrift/compiler/test/fixtures/basic-annotations/out/hack/gen-hack/MyService.php

@@ -209,7 +209,7 @@ trait MyServiceClientBase {
     $args = MyService_ping_args::withDefaultValues();
     await $this->asyncHandler_->genBefore(MyServiceStaticMetadata::THRIFT_SVC_NAME, "ping", $args);
     $currentseqid = $this->sendImplHelper($args, "ping", false, MyServiceStaticMetadata::THRIFT_SVC_NAME );
-    await $this->genAwaitResponse(MyService_ping_result::class, "ping", true, $currentseqid, $rpc_options);
+    await $this->genAwaitResponseWithReadHeaders(MyService_ping_result::class, "ping", true, $currentseqid, $rpc_options);
   }
 
   /**
@@ -226,7 +226,7 @@ trait MyServiceClientBase {
     $args = MyService_getRandomData_args::withDefaultValues();
     await $this->asyncHandler_->genBefore(MyServiceStaticMetadata::THRIFT_SVC_NAME, "getRandomData", $args);
     $currentseqid = $this->sendImplHelper($args, "getRandomData", false, MyServiceStaticMetadata::THRIFT_SVC_NAME );
-    return await $this->genAwaitResponse(MyService_getRandomData_result::class, "getRandomData", false, $currentseqid, $rpc_options);
+    return (await $this->genAwaitResponseWithReadHeaders(MyService_getRandomData_result::class, "getRandomData", false, $currentseqid, $rpc_options))[0];
   }
 
   /**
@@ -245,7 +245,7 @@ trait MyServiceClientBase {
     ));
     await $this->asyncHandler_->genBefore(MyServiceStaticMetadata::THRIFT_SVC_NAME, "hasDataById", $args);
     $currentseqid = $this->sendImplHelper($args, "hasDataById", false, MyServiceStaticMetadata::THRIFT_SVC_NAME );
-    return await $this->genAwaitResponse(MyService_hasDataById_result::class, "hasDataById", false, $currentseqid, $rpc_options);
+    return (await $this->genAwaitResponseWithReadHeaders(MyService_hasDataById_result::class, "hasDataById", false, $currentseqid, $rpc_options))[0];
   }
 
   /**
@@ -264,7 +264,7 @@ trait MyServiceClientBase {
     ));
     await $this->asyncHandler_->genBefore(MyServiceStaticMetadata::THRIFT_SVC_NAME, "getDataById", $args);
     $currentseqid = $this->sendImplHelper($args, "getDataById", false, MyServiceStaticMetadata::THRIFT_SVC_NAME );
-    return await $this->genAwaitResponse(MyService_getDataById_result::class, "getDataById", false, $currentseqid, $rpc_options);
+    return (await $this->genAwaitResponseWithReadHeaders(MyService_getDataById_result::class, "getDataById", false, $currentseqid, $rpc_options))[0];
   }
 
   /**
@@ -285,7 +285,7 @@ trait MyServiceClientBase {
     ));
     await $this->asyncHandler_->genBefore(MyServiceStaticMetadata::THRIFT_SVC_NAME, "putDataById", $args);
     $currentseqid = $this->sendImplHelper($args, "putDataById", false, MyServiceStaticMetadata::THRIFT_SVC_NAME );
-    await $this->genAwaitResponse(MyService_putDataById_result::class, "putDataById", true, $currentseqid, $rpc_options);
+    await $this->genAwaitResponseWithReadHeaders(MyService_putDataById_result::class, "putDataById", true, $currentseqid, $rpc_options);
   }
 
   /**
@@ -323,7 +323,7 @@ trait MyServiceClientBase {
     $args = MyService_doNothing_args::withDefaultValues();
     await $this->asyncHandler_->genBefore(MyServiceStaticMetadata::THRIFT_SVC_NAME, "doNothing", $args);
     $currentseqid = $this->sendImplHelper($args, "doNothing", false, MyServiceStaticMetadata::THRIFT_SVC_NAME );
-    await $this->genAwaitResponse(MyService_doNothing_result::class, "doNothing", true, $currentseqid, $rpc_options);
+    await $this->genAwaitResponseWithReadHeaders(MyService_doNothing_result::class, "doNothing", true, $currentseqid, $rpc_options);
   }
 
 }

third-party/thrift/src/thrift/compiler/test/fixtures/basic-annotations/out/hack/gen-hack/MyServicePrioChild.php

@@ -73,7 +73,7 @@ trait MyServicePrioChildClientBase {
     $args = MyServicePrioChild_pang_args::withDefaultValues();
     await $this->asyncHandler_->genBefore(MyServicePrioChildStaticMetadata::THRIFT_SVC_NAME, "pang", $args);
     $currentseqid = $this->sendImplHelper($args, "pang", false, MyServicePrioChildStaticMetadata::THRIFT_SVC_NAME );
-    await $this->genAwaitResponse(MyServicePrioChild_pang_result::class, "pang", true, $currentseqid, $rpc_options);
+    await $this->genAwaitResponseWithReadHeaders(MyServicePrioChild_pang_result::class, "pang", true, $currentseqid, $rpc_options);
   }
 
 }

third-party/thrift/src/thrift/compiler/test/fixtures/basic-annotations/out/hack/gen-hack/MyServicePrioParent.php

@@ -94,7 +94,7 @@ trait MyServicePrioParentClientBase {
     $args = MyServicePrioParent_ping_args::withDefaultValues();
     await $this->asyncHandler_->genBefore(MyServicePrioParentStaticMetadata::THRIFT_SVC_NAME, "ping", $args);
     $currentseqid = $this->sendImplHelper($args, "ping", false, MyServicePrioParentStaticMetadata::THRIFT_SVC_NAME );
-    await $this->genAwaitResponse(MyServicePrioParent_ping_result::class, "ping", true, $currentseqid, $rpc_options);
+    await $this->genAwaitResponseWithReadHeaders(MyServicePrioParent_ping_result::class, "ping", true, $currentseqid, $rpc_options);
   }
 
   /**
@@ -111,7 +111,7 @@ trait MyServicePrioParentClientBase {
     $args = MyServicePrioParent_pong_args::withDefaultValues();
     await $this->asyncHandler_->genBefore(MyServicePrioParentStaticMetadata::THRIFT_SVC_NAME, "pong", $args);
     $currentseqid = $this->sendImplHelper($args, "pong", false, MyServicePrioParentStaticMetadata::THRIFT_SVC_NAME );
-    await $this->genAwaitResponse(MyServicePrioParent_pong_result::class, "pong", true, $currentseqid, $rpc_options);
+    await $this->genAwaitResponseWithReadHeaders(MyServicePrioParent_pong_result::class, "pong", true, $currentseqid, $rpc_options);
   }
 
 }

third-party/thrift/src/thrift/compiler/test/fixtures/basic-structured-annotations/out/hack/gen-hack/MyService.php

@@ -100,7 +100,7 @@ trait MyServiceClientBase {
     $args = \test\fixtures\basic-structured-annotations\MyService_first_args::withDefaultValues();
     await $this->asyncHandler_->genBefore(MyServiceStaticMetadata::THRIFT_SVC_NAME, "first", $args);
     $currentseqid = $this->sendImplHelper($args, "first", false, MyServiceStaticMetadata::THRIFT_SVC_NAME );
-    return await $this->genAwaitResponse(\test\fixtures\basic-structured-annotations\MyService_first_result::class, "first", false, $currentseqid, $rpc_options);
+    return (await $this->genAwaitResponseWithReadHeaders(\test\fixtures\basic-structured-annotations\MyService_first_result::class, "first", false, $currentseqid, $rpc_options))[0];
   }
 
   /**
@@ -119,7 +119,7 @@ trait MyServiceClientBase {
     ));
     await $this->asyncHandler_->genBefore(MyServiceStaticMetadata::THRIFT_SVC_NAME, "second", $args);
     $currentseqid = $this->sendImplHelper($args, "second", false, MyServiceStaticMetadata::THRIFT_SVC_NAME );
-    return await $this->genAwaitResponse(\test\fixtures\basic-structured-annotations\MyService_second_result::class, "second", false, $currentseqid, $rpc_options);
+    return (await $this->genAwaitResponseWithReadHeaders(\test\fixtures\basic-structured-annotations\MyService_second_result::class, "second", false, $currentseqid, $rpc_options))[0];
   }
 
 }

third-party/thrift/src/thrift/compiler/test/fixtures/basic/out/hack/gen-hack/DbMixedStackArguments.php

@@ -103,7 +103,7 @@ public function getDataByKey1(string $key): Awaitable<string>;
     ));
     await $this->asyncHandler_->genBefore(DbMixedStackArgumentsStaticMetadata::THRIFT_SVC_NAME, "getDataByKey0", $args);
     $currentseqid = $this->sendImplHelper($args, "getDataByKey0", false, DbMixedStackArgumentsStaticMetadata::THRIFT_SVC_NAME );
-    return await $this->genAwaitResponse(\test\fixtures\basic\DbMixedStackArguments_getDataByKey0_result::class, "getDataByKey0", false, $currentseqid, $rpc_options);
+    return (await $this->genAwaitResponseWithReadHeaders(\test\fixtures\basic\DbMixedStackArguments_getDataByKey0_result::class, "getDataByKey0", false, $currentseqid, $rpc_options))[0];
   }
 
   /**
@@ -122,7 +122,7 @@ public function getDataByKey1(string $key): Awaitable<string>;
     ));
     await $this->asyncHandler_->genBefore(DbMixedStackArgumentsStaticMetadata::THRIFT_SVC_NAME, "getDataByKey1", $args);
     $currentseqid = $this->sendImplHelper($args, "getDataByKey1", false, DbMixedStackArgumentsStaticMetadata::THRIFT_SVC_NAME );
-    return await $this->genAwaitResponse(\test\fixtures\basic\DbMixedStackArguments_getDataByKey1_result::class, "getDataByKey1", false, $currentseqid, $rpc_options);
+    return (await $this->genAwaitResponseWithReadHeaders(\test\fixtures\basic\DbMixedStackArguments_getDataByKey1_result::class, "getDataByKey1", false, $currentseqid, $rpc_options))[0];
   }
 
 }

third-party/thrift/src/thrift/compiler/test/fixtures/basic/out/hack/gen-hack/FB303Service.php

@@ -82,7 +82,7 @@ public function renamed_rpc(int $renamed_parameter): Awaitable<\test\fixtures\ba
     ));
     await $this->asyncHandler_->genBefore(FB303ServiceStaticMetadata::THRIFT_SVC_NAME, "renamed_rpc", $args);
     $currentseqid = $this->sendImplHelper($args, "renamed_rpc", false, FB303ServiceStaticMetadata::THRIFT_SVC_NAME );
-    return await $this->genAwaitResponse(\test\fixtures\basic\FB303Service_renamed_rpc_result::class, "simple_rpc", false, $currentseqid, $rpc_options);
+    return (await $this->genAwaitResponseWithReadHeaders(\test\fixtures\basic\FB303Service_renamed_rpc_result::class, "simple_rpc", false, $currentseqid, $rpc_options))[0];
   }
 
 }