fix: missing export for api key auth middleware (#528)

Author: eduardomourar

smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/integration/AddHttpApiKeyAuthPlugin.java

@@ -44,6 +44,8 @@
 @SmithyInternalApi
 public final class AddHttpApiKeyAuthPlugin implements TypeScriptIntegration {
 
+    public static final String INTEGRATION_NAME = "HttpApiKeyAuth";
+
     /**
      * Plug into code generation for the client.
      *
@@ -62,15 +64,15 @@ public List<RuntimeClientPlugin> getClientPlugins() {
             // Add the config if the service uses HTTP API key authorization.
             RuntimeClientPlugin.builder()
                     .inputConfig(Symbol.builder()
-                            .namespace("./" + CodegenUtils.SOURCE_FOLDER + "/middleware/HttpApiKeyAuth", "/")
+                            .namespace("./" + CodegenUtils.SOURCE_FOLDER + "/middleware/" + INTEGRATION_NAME, "/")
                             .name("HttpApiKeyAuthInputConfig")
                             .build())
                     .resolvedConfig(Symbol.builder()
-                            .namespace("./" + CodegenUtils.SOURCE_FOLDER + "/middleware/HttpApiKeyAuth", "/")
+                            .namespace("./" + CodegenUtils.SOURCE_FOLDER + "/middleware/" + INTEGRATION_NAME, "/")
                             .name("HttpApiKeyAuthResolvedConfig")
                             .build())
                     .resolveFunction(Symbol.builder()
-                            .namespace("./" + CodegenUtils.SOURCE_FOLDER + "/middleware/HttpApiKeyAuth", "/")
+                            .namespace("./" + CodegenUtils.SOURCE_FOLDER + "/middleware/" + INTEGRATION_NAME, "/")
                             .name("resolveHttpApiKeyAuthConfig")
                             .build())
                     .servicePredicate((m, s) -> hasEffectiveHttpApiKeyAuthTrait(m, s))
@@ -79,7 +81,7 @@ public List<RuntimeClientPlugin> getClientPlugins() {
             // Add the middleware to operations that use HTTP API key authorization.
             RuntimeClientPlugin.builder()
                     .pluginFunction(Symbol.builder()
-                            .namespace("./" + CodegenUtils.SOURCE_FOLDER + "/middleware/HttpApiKeyAuth", "/")
+                            .namespace("./" + CodegenUtils.SOURCE_FOLDER + "/middleware/" + INTEGRATION_NAME, "/")
                             .name("getHttpApiKeyAuthPlugin")
                             .build())
                     .additionalPluginFunctionParamsSupplier((m, s, o) -> new HashMap<String, Object>() {{
@@ -119,7 +121,7 @@ public void writeAdditionalFiles(
 
         // Write the middleware source.
         writerFactory.accept(
-                Paths.get(CodegenUtils.SOURCE_FOLDER, "middleware", "HttpApiKeyAuth", "index.ts").toString(),
+                Paths.get(CodegenUtils.SOURCE_FOLDER, "middleware", INTEGRATION_NAME, "index.ts").toString(),
                 writer -> {
                         String source = IoUtils.readUtf8Resource(getClass(), "http-api-key-auth.ts");
                         writer.write("$L$L", noTouchNoticePrefix, "http-api-key-auth.ts");
@@ -128,7 +130,7 @@ public void writeAdditionalFiles(
 
         // Write the middleware tests.
         writerFactory.accept(
-                Paths.get(CodegenUtils.SOURCE_FOLDER, "middleware", "HttpApiKeyAuth", "index.spec.ts").toString(),
+                Paths.get(CodegenUtils.SOURCE_FOLDER, "middleware", INTEGRATION_NAME, "index.spec.ts").toString(),
                 writer -> {
                         writer.addDependency(SymbolDependency.builder()
                                 .dependencyType("devDependencies")
@@ -142,6 +144,20 @@ public void writeAdditionalFiles(
                 });
     }
 
+    @Override
+    public void writeAdditionalExports(
+            TypeScriptSettings settings,
+            Model model,
+            SymbolProvider symbolProvider,
+            TypeScriptWriter writer
+    ) {
+        boolean isClientSdk = settings.generateClient();
+        ServiceShape service = settings.getService(model);
+        if (isClientSdk && hasEffectiveHttpApiKeyAuthTrait(model, service)) {
+            writer.write("export * from \"./middleware/$1L\";", INTEGRATION_NAME);
+        }
+    }
+
     // The service has the effective trait if it's in the "effective auth schemes" response
     // AND if not all of the operations have the optional auth trait.
     private static boolean hasEffectiveHttpApiKeyAuthTrait(Model model, ServiceShape service) {

smithy-typescript-codegen/src/test/java/software/amazon/smithy/typescript/codegen/integration/AddHttpApiKeyAuthPluginTest.java

@@ -71,6 +71,10 @@ private void testInjects(String filename, String extra) {
         // Make sure that the middleware file was written and exports the plugin symbol.
         assertThat(manifest.getFileString(CodegenUtils.SOURCE_FOLDER + "/middleware/HttpApiKeyAuth/index.ts").get(),
                 containsString("export const getHttpApiKeyAuthPlugin"));
+
+        // Ensure that the middleware was being exported in the index file.
+        assertThat(manifest.getFileString(CodegenUtils.SOURCE_FOLDER + "/index.ts").get(),
+                containsString("from \"./middleware/HttpApiKeyAuth\""));  
     }
 
     private MockManifest generate(String filename)
@@ -124,5 +128,9 @@ private void testDoesNotInject(String filename) {
         // Make sure that the middleware file was not written.
         assertThat(manifest.hasFile(CodegenUtils.SOURCE_FOLDER + "/middleware/HttpApiKeyAuth/index.ts"),
                 is(false));
+
+        // Ensure that the middleware was not being exported in the index file.
+        assertThat(manifest.getFileString(CodegenUtils.SOURCE_FOLDER + "/index.ts").get(),
+            not(containsString("from \"./middleware/HttpApiKeyAuth\""))); 
     }
 }