fix: check dependencies when adding imports

Author: kuhe

smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptWriter.java

@@ -16,10 +16,13 @@
 package software.amazon.smithy.typescript.codegen;
 
 import java.nio.file.Path;
+import java.util.List;
+import java.util.Set;
 import java.util.function.BiFunction;
 import java.util.function.UnaryOperator;
 import software.amazon.smithy.codegen.core.CodegenException;
 import software.amazon.smithy.codegen.core.Symbol;
+import software.amazon.smithy.codegen.core.SymbolDependency;
 import software.amazon.smithy.codegen.core.SymbolReference;
 import software.amazon.smithy.codegen.core.SymbolWriter;
 import software.amazon.smithy.model.Model;
@@ -29,6 +32,7 @@
 import software.amazon.smithy.model.traits.DeprecatedTrait;
 import software.amazon.smithy.model.traits.DocumentationTrait;
 import software.amazon.smithy.model.traits.InternalTrait;
+import software.amazon.smithy.utils.SetUtils;
 import software.amazon.smithy.utils.SmithyUnstableApi;
 import software.amazon.smithy.utils.StringUtils;
 
@@ -49,6 +53,32 @@
 @SmithyUnstableApi
 public final class TypeScriptWriter extends SymbolWriter<TypeScriptWriter, ImportDeclarations> {
     public static final String CODEGEN_INDICATOR = "// smithy-typescript generated code\n";
+    public static final Set<String> EXEMPT_DEPENDENCIES = SetUtils.of(
+        "buffer",
+        "child_process",
+        "crypto",
+        "dns",
+        "dns/promises",
+        "events",
+        "fs",
+        "fs/promises",
+        "http",
+        "http2",
+        "https",
+        "os",
+        "path",
+        "path/posix",
+        "path/win32",
+        "process",
+        "stream",
+        "stream/consumers",
+        "stream/promises",
+        "stream/web",
+        "tls",
+        "url",
+        "util",
+        "zlib"
+    );
 
     private final String moduleName;
     private final boolean withAttribution;
@@ -114,6 +144,38 @@ public TypeScriptWriter addIgnoredDefaultImport(String name, String from, String
      */
     @Deprecated
     public TypeScriptWriter addImport(String name, String as, String from) {
+        final boolean isPackageImport =
+            from.startsWith("@")
+                || (!from.startsWith("/") && !from.startsWith("."));
+
+        if (isPackageImport) {
+            String[] packageNameSegments = from.split("/");
+            String packageName =
+                from.startsWith("@")
+                    ? packageNameSegments[0] + "/" + packageNameSegments[1]
+                    : packageNameSegments[0];
+            List<SymbolDependency> dependencies = getDependencies();
+            if (!EXEMPT_DEPENDENCIES.contains(packageName)
+                && dependencies.stream().noneMatch(dep -> dep.getPackageName().equals(packageName))) {
+                throw new CodegenException("""
+                        The import %s does not correspond to a registered dependency.
+                        TypeScriptWriter::addDependency() is required before ::addImport(), or call ::addImportUnchecked().
+                        """.formatted(from));
+            }
+        }
+
+        getImportContainer().addImport(name, as, from);
+        return this;
+    }
+
+    /**
+     * Imports a type using an alias from a module only if necessary.
+     * @return Returns the writer.
+     *
+     * @deprecated Use {@link TypeScriptWriter#addImport(String, String, TypeScriptDependency)} addImport}
+     */
+    @Deprecated
+    public TypeScriptWriter addImportUnchecked(String name, String as, String from) {
         getImportContainer().addImport(name, as, from);
         return this;
     }
@@ -126,6 +188,15 @@ public TypeScriptWriter addImport(String name, String as, String from) {
      * @param from PackageContainer to import the type from.
      * @return Returns the writer.
      */
+    public TypeScriptWriter addImport(String name, String as, Dependency from) {
+        addDependency(from);
+        return this.addImport(name, as, from.getPackageName());
+    }
+
+    /**
+     * @deprecated use {@link #addImport(String name, String as, Dependency from)}.
+     */
+    @Deprecated
     public TypeScriptWriter addImport(String name, String as, PackageContainer from) {
         return this.addImport(name, as, from.getPackageName());
     }

smithy-typescript-codegen/src/test/java/software/amazon/smithy/typescript/codegen/TypeScriptWriterTest.java

@@ -21,15 +21,17 @@ public void writesDocStrings() {
     public void doesNotAddNewlineBetweenManagedAndExplicitImports() {
         TypeScriptWriter writer = new TypeScriptWriter("foo");
         writer.write("import { Foo } from \"baz\";");
-        writer.addImport("Baz", "Baz", "hello");
+        writer.addImport("Baz", "Baz", "./hello");
         writer.addImport("Bar", "__Bar", TypeScriptDependency.SMITHY_TYPES);
         writer.addRelativeImport("Qux", "__Qux", Paths.get("./qux"));
         String result = writer.toString();
 
-        assertThat(result, equalTo(CODEGEN_INDICATOR + "import { Qux as __Qux } from \"./qux\";\n"
-                + "import { Bar as __Bar } from \"@smithy/types\";\n"
-                + "import { Baz } from \"hello\";\n"
-                + "import { Foo } from \"baz\";\n"));
+        assertThat(result, equalTo("""
+            %simport { Baz } from "./hello";
+            import { Qux as __Qux } from "./qux";
+            import { Bar as __Bar } from "@smithy/types";
+            import { Foo } from "baz";
+            """.formatted(CODEGEN_INDICATOR)));
     }
 
     @Test