chore: undo and prevent circular imports

kuhe · kuhe · commit 130a9934a543 · 2025-10-15T13:22:03.000-04:00
diff --git a/.changeset/happy-weeks-ring.md b/.changeset/happy-weeks-ring.md
@@ -0,0 +1,7 @@
+---
+"@smithy/shared-ini-file-loader": patch
+"@smithy/util-endpoints": patch
+"@smithy/util-stream": patch
+---
+
+remove and ban circular imports
diff --git a/packages/shared-ini-file-loader/src/constants.ts b/packages/shared-ini-file-loader/src/constants.ts
@@ -0,0 +1,4 @@
+/**
+ * @internal
+ */
+export const CONFIG_PREFIX_SEPARATOR = ".";
diff --git a/packages/shared-ini-file-loader/src/getConfigData.ts b/packages/shared-ini-file-loader/src/getConfigData.ts
@@ -1,7 +1,7 @@
 import type { ParsedIniData } from "@smithy/types";
 import { IniSectionType } from "@smithy/types";
 
-import { CONFIG_PREFIX_SEPARATOR } from "./loadSharedConfigFiles";
+import { CONFIG_PREFIX_SEPARATOR } from "./constants";
 
 /**
  * Returns the config data from parsed ini data.
diff --git a/packages/shared-ini-file-loader/src/loadSharedConfigFiles.ts b/packages/shared-ini-file-loader/src/loadSharedConfigFiles.ts
@@ -40,10 +40,7 @@ export interface SharedConfigInit {
 
 const swallowError = () => ({});
 
-/**
- * @internal
- */
-export const CONFIG_PREFIX_SEPARATOR = ".";
+export { CONFIG_PREFIX_SEPARATOR } from "./constants";
 
 /**
  * Loads the config and credentials files.
diff --git a/packages/shared-ini-file-loader/src/parseIni.ts b/packages/shared-ini-file-loader/src/parseIni.ts
@@ -1,7 +1,7 @@
 import type { ParsedIniData } from "@smithy/types";
 import { IniSectionType } from "@smithy/types";
 
-import { CONFIG_PREFIX_SEPARATOR } from "./loadSharedConfigFiles";
+import { CONFIG_PREFIX_SEPARATOR } from "./constants";
 
 const prefixKeyRegex = /^([\w-]+)\s(["'])?([\w-@\+\.%:/]+)\2$/;
 const profileNameBlockList = ["__proto__", "profile __proto__"];
diff --git a/packages/util-endpoints/src/utils/callFunction.ts b/packages/util-endpoints/src/utils/callFunction.ts
@@ -1,17 +1,2 @@
-import type { EvaluateOptions, Expression, FunctionObject, FunctionReturn } from "../types";
-import { customEndpointFunctions } from "./customEndpointFunctions";
-import { endpointFunctions } from "./endpointFunctions";
-import { evaluateExpression } from "./evaluateExpression";
-
-export const callFunction = ({ fn, argv }: FunctionObject, options: EvaluateOptions): FunctionReturn => {
-  const evaluatedArgs = argv.map((arg) =>
-    ["boolean", "number"].includes(typeof arg) ? arg : evaluateExpression(arg as Expression, "arg", options)
-  );
-  const fnSegments = fn.split(".");
-  if (fnSegments[0] in customEndpointFunctions && fnSegments[1] != null) {
-    // @ts-ignore Element implicitly has an 'any' type
-    return customEndpointFunctions[fnSegments[0]][fnSegments[1]](...evaluatedArgs);
-  }
-  // @ts-ignore Element implicitly has an 'any' type
-  return endpointFunctions[fn](...evaluatedArgs);
-};
+// breaks circular import
+export { callFunction } from "./evaluateExpression";
diff --git a/packages/util-endpoints/src/utils/evaluateExpression.ts b/packages/util-endpoints/src/utils/evaluateExpression.ts
@@ -1,6 +1,7 @@
-import type { EvaluateOptions, Expression, FunctionObject, ReferenceObject } from "../types";
+import type { EvaluateOptions, Expression, FunctionObject, FunctionReturn, ReferenceObject } from "../types";
 import { EndpointError } from "../types";
-import { callFunction } from "./callFunction";
+import { customEndpointFunctions } from "./customEndpointFunctions";
+import { endpointFunctions } from "./endpointFunctions";
 import { evaluateTemplate } from "./evaluateTemplate";
 import { getReferenceValue } from "./getReferenceValue";
 
@@ -14,3 +15,16 @@ export const evaluateExpression = (obj: Expression, keyName: string, options: Ev
   }
   throw new EndpointError(`'${keyName}': ${String(obj)} is not a string, function or reference.`);
 };
+
+export const callFunction = ({ fn, argv }: FunctionObject, options: EvaluateOptions): FunctionReturn => {
+  const evaluatedArgs = argv.map((arg) =>
+    ["boolean", "number"].includes(typeof arg) ? arg : evaluateExpression(arg as Expression, "arg", options)
+  );
+  const fnSegments = fn.split(".");
+  if (fnSegments[0] in customEndpointFunctions && fnSegments[1] != null) {
+    // @ts-ignore Element implicitly has an 'any' type
+    return customEndpointFunctions[fnSegments[0]][fnSegments[1]](...evaluatedArgs);
+  }
+  // @ts-ignore Element implicitly has an 'any' type
+  return endpointFunctions[fn](...evaluatedArgs);
+};
diff --git a/packages/util-endpoints/src/utils/evaluateRules.ts b/packages/util-endpoints/src/utils/evaluateRules.ts
@@ -1,10 +1,10 @@
 import type { EndpointV2 } from "@smithy/types";
 
-import type { EvaluateOptions, RuleSetRules } from "../types";
+import type { EvaluateOptions, RuleSetRules, TreeRuleObject } from "../types";
 import { EndpointError } from "../types";
+import { evaluateConditions } from "./evaluateConditions";
 import { evaluateEndpointRule } from "./evaluateEndpointRule";
 import { evaluateErrorRule } from "./evaluateErrorRule";
-import { evaluateTreeRule } from "./evaluateTreeRule";
 
 export const evaluateRules = (rules: RuleSetRules, options: EvaluateOptions): EndpointV2 => {
   for (const rule of rules) {
@@ -26,3 +26,17 @@ export const evaluateRules = (rules: RuleSetRules, options: EvaluateOptions): En
   }
   throw new EndpointError(`Rules evaluation failed`);
 };
+
+export const evaluateTreeRule = (treeRule: TreeRuleObject, options: EvaluateOptions): EndpointV2 | undefined => {
+  const { conditions, rules } = treeRule;
+
+  const { result, referenceRecord } = evaluateConditions(conditions, options);
+  if (!result) {
+    return;
+  }
+
+  return evaluateRules(rules, {
+    ...options,
+    referenceRecord: { ...options.referenceRecord, ...referenceRecord },
+  });
+};
diff --git a/packages/util-endpoints/src/utils/evaluateTreeRule.ts b/packages/util-endpoints/src/utils/evaluateTreeRule.ts
@@ -1,19 +1,2 @@
-import type { EndpointV2 } from "@smithy/types";
-
-import type { EvaluateOptions, TreeRuleObject } from "../types";
-import { evaluateConditions } from "./evaluateConditions";
-import { evaluateRules } from "./evaluateRules";
-
-export const evaluateTreeRule = (treeRule: TreeRuleObject, options: EvaluateOptions): EndpointV2 | undefined => {
-  const { conditions, rules } = treeRule;
-
-  const { result, referenceRecord } = evaluateConditions(conditions, options);
-  if (!result) {
-    return;
-  }
-
-  return evaluateRules(rules, {
-    ...options,
-    referenceRecord: { ...options.referenceRecord, ...referenceRecord },
-  });
-};
+// breaks circular import
+export { evaluateTreeRule } from "./evaluateRules";
diff --git a/packages/util-endpoints/src/utils/getEndpointProperties.ts b/packages/util-endpoints/src/utils/getEndpointProperties.ts
@@ -1,5 +1,8 @@
+import type { EndpointObjectProperty } from "@smithy/types";
+
 import type { EndpointObjectProperties, EvaluateOptions } from "../types";
-import { getEndpointProperty } from "./getEndpointProperty";
+import { EndpointError } from "../types";
+import { evaluateTemplate } from "./evaluateTemplate";
 
 export const getEndpointProperties = (properties: EndpointObjectProperties, options: EvaluateOptions) =>
   Object.entries(properties).reduce(
@@ -9,3 +12,25 @@ export const getEndpointProperties = (properties: EndpointObjectProperties, opti
     }),
     {}
   );
+
+export const getEndpointProperty = (
+  property: EndpointObjectProperty,
+  options: EvaluateOptions
+): EndpointObjectProperty => {
+  if (Array.isArray(property)) {
+    return property.map((propertyEntry) => getEndpointProperty(propertyEntry, options));
+  }
+  switch (typeof property) {
+    case "string":
+      return evaluateTemplate(property, options);
+    case "object":
+      if (property === null) {
+        throw new EndpointError(`Unexpected endpoint property: ${property}`);
+      }
+      return getEndpointProperties(property, options);
+    case "boolean":
+      return property;
+    default:
+      throw new EndpointError(`Unexpected endpoint property type: ${typeof property}`);
+  }
+};
diff --git a/packages/util-endpoints/src/utils/getEndpointProperty.ts b/packages/util-endpoints/src/utils/getEndpointProperty.ts
@@ -1,28 +1,2 @@
-import type { EndpointObjectProperty } from "@smithy/types";
-
-import type { EvaluateOptions } from "../types";
-import { EndpointError } from "../types";
-import { evaluateTemplate } from "./evaluateTemplate";
-import { getEndpointProperties } from "./getEndpointProperties";
-
-export const getEndpointProperty = (
-  property: EndpointObjectProperty,
-  options: EvaluateOptions
-): EndpointObjectProperty => {
-  if (Array.isArray(property)) {
-    return property.map((propertyEntry) => getEndpointProperty(propertyEntry, options));
-  }
-  switch (typeof property) {
-    case "string":
-      return evaluateTemplate(property, options);
-    case "object":
-      if (property === null) {
-        throw new EndpointError(`Unexpected endpoint property: ${property}`);
-      }
-      return getEndpointProperties(property, options);
-    case "boolean":
-      return property;
-    default:
-      throw new EndpointError(`Unexpected endpoint property type: ${typeof property}`);
-  }
-};
+// breaks circular import
+export { getEndpointProperty } from "./getEndpointProperties";
diff --git a/packages/util-stream/src/blob/Uint8ArrayBlobAdapter.ts b/packages/util-stream/src/blob/Uint8ArrayBlobAdapter.ts
@@ -1,4 +1,5 @@
-import { transformFromString, transformToString } from "./transforms";
+import { fromBase64, toBase64 } from "@smithy/util-base64";
+import { fromUtf8, toUtf8 } from "@smithy/util-utf8";
 
 /**
  * Adapter for conversions of the native Uint8Array type.
@@ -12,7 +13,10 @@ export class Uint8ArrayBlobAdapter extends Uint8Array {
    */
   public static fromString(source: string, encoding = "utf-8"): Uint8ArrayBlobAdapter {
     if (typeof source === "string") {
-      return transformFromString(source, encoding);
+      if (encoding === "base64") {
+        return Uint8ArrayBlobAdapter.mutate(fromBase64(source));
+      }
+      return Uint8ArrayBlobAdapter.mutate(fromUtf8(source));
     }
     throw new Error(`Unsupported conversion from ${typeof source} to Uint8ArrayBlobAdapter.`);
   }
@@ -31,6 +35,9 @@ export class Uint8ArrayBlobAdapter extends Uint8Array {
    * @returns the blob as string.
    */
   public transformToString(encoding = "utf-8"): string {
-    return transformToString(this, encoding);
+    if (encoding === "base64") {
+      return toBase64(this);
+    }
+    return toUtf8(this);
   }
 }
diff --git a/packages/util-stream/src/blob/transforms.ts b/packages/util-stream/src/blob/transforms.ts
diff --git a/scripts/compilation/Inliner.js b/scripts/compilation/Inliner.js
@@ -176,6 +176,16 @@ module.exports = class Inliner {
           },
         }),
       ],
+      onwarn(warning) {
+        /*
+        Circular imports are not an error in the language spec,
+        but reasoning about the program and bundling becomes easier.
+        For that reason let's avoid them.
+         */
+        if (warning.code === "CIRCULAR_DEPENDENCY") {
+          throw Error(warning.message);
+        }
+      },
       external: (id) => {
         const relative = !!id.match(/^\.?\.?\//);
         if (!relative) {

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +/**
 + * @internal
 + */
 +export const CONFIG_PREFIX_SEPARATOR = ".";