chore: use guarded for-in

Author: kuhe

.changeset/nasty-walls-tap.md

@@ -0,0 +1,8 @@
+---
+"@smithy/undici-http-handler": patch
+"@smithy/node-http-handler": patch
+"@smithy/server-common": patch
+"@smithy/core": patch
+---
+
+switch for-in loops to guarded

.oxlintrc.json

@@ -10,6 +10,7 @@
   "rules": {
     "@typescript-eslint/consistent-type-imports": "error",
     "@typescript-eslint/no-import-type-side-effects": "error",
+    "guard-for-in": "error",
     "no-sparse-arrays": "off",
     "no-unused-vars": ["error", { "args": "none", "caughtErrorsIgnorePattern": "^ignored", "varsIgnorePattern": "^_" }],
     "unicorn/no-new-array": "off",

api-snapshot/api.json

@@ -132,6 +132,7 @@
     "getRetryConfiguration": "function",
     "getSmithyContext": "function",
     "getValueFromTextNode": "function",
+    "hasOwn": "function",
     "invalidFunction": "function",
     "invalidProvider": "function",
     "isSerializableHeaderValue": "function",

packages/core/src/legacy-root-exports/util-identity-and-auth/DefaultIdentityProviderConfig.ts

@@ -1,3 +1,4 @@
+import { hasOwn } from "@smithy/core/client";
 import type { HttpAuthSchemeId, Identity, IdentityProvider, IdentityProviderConfig } from "@smithy/types";
 
 /**
@@ -14,6 +15,7 @@ export class DefaultIdentityProviderConfig implements IdentityProviderConfig {
    */
   constructor(config: Record<HttpAuthSchemeId, IdentityProvider<Identity> | undefined>) {
     for (const key in config) {
+      if (!hasOwn(config, key)) continue;
       const value = config[key];
       if (value !== undefined) {
         this.authSchemes.set(key, value);

packages/core/src/submodules/cbor/codec-v1/CborShapeDeserializer.ts

@@ -1,3 +1,4 @@
+import { hasOwn } from "@smithy/core/client";
 import { SerdeContext } from "@smithy/core/protocols";
 import { NormalizedSchema } from "@smithy/core/schema";
 import { NumericValue, _parseEpochTimestamp, fromBase64 } from "@smithy/core/serde";
@@ -80,6 +81,7 @@ export class CborShapeDeserializer extends SerdeContext implements ShapeDeserial
         const targetSchema = ns.getValueSchema();
 
         for (const key in value) {
+          if (!hasOwn(value, key)) continue;
           const itemValue = this.readValue(targetSchema, value[key]);
           newObject[key] = itemValue;
         }
@@ -89,6 +91,7 @@ export class CborShapeDeserializer extends SerdeContext implements ShapeDeserial
         if (isUnion) {
           keys = new Set<string>();
           for (const k in value) {
+            if (!hasOwn(value, k)) continue;
             if (k !== "__type") {
               keys.add(k);
             }
@@ -105,6 +108,7 @@ export class CborShapeDeserializer extends SerdeContext implements ShapeDeserial
         if (isUnion && keys?.size === 1) {
           let newObjectEmpty = true;
           for (const _ in newObject) {
+            if (!hasOwn(newObject, _)) continue;
             newObjectEmpty = false;
             break;
           }
@@ -116,6 +120,7 @@ export class CborShapeDeserializer extends SerdeContext implements ShapeDeserial
           // This if-block is for backwards compatibility support and should not be copied
           // to other implementations.
           for (const k in value) {
+            if (!hasOwn(value, k)) continue;
             if (!(k in newObject)) {
               // we have no type information, so copy as-is from CBOR-derived object.
               newObject[k] = value[k];

packages/core/src/submodules/cbor/codec-v1/CborShapeSerializer.ts

@@ -1,3 +1,4 @@
+import { hasOwn } from "@smithy/core/client";
 import { SerdeContext } from "@smithy/core/protocols";
 import { NormalizedSchema } from "@smithy/core/schema";
 import { _parseEpochTimestamp, fromBase64, generateIdempotencyToken } from "@smithy/core/serde";
@@ -66,6 +67,7 @@ export class CborShapeSerializer extends SerdeContext implements ShapeSerializer
       if (ns.isMapSchema()) {
         const sparse = !!ns.getMergedTraits().sparse;
         for (const key in sourceObject) {
+          if (!hasOwn(sourceObject, key)) continue;
           const value = this.serialize(ns.getValueSchema(), sourceObject[key]);
           if (value != null || sparse) {
             newObject[key] = value;
@@ -86,6 +88,7 @@ export class CborShapeSerializer extends SerdeContext implements ShapeSerializer
           // This if-block is for backwards compatibility support and should not be copied
           // to other implementations.
           for (const k in sourceObject) {
+            if (!hasOwn(sourceObject, k)) continue;
             if (!(k in newObject)) {
               // we have no type information, so serialize with Document rules.
               newObject[k] = this.serialize(15 satisfies DocumentSchema, sourceObject[k]);
@@ -102,6 +105,7 @@ export class CborShapeSerializer extends SerdeContext implements ShapeSerializer
           return newArray;
         }
         for (const key in sourceObject) {
+          if (!hasOwn(sourceObject, key)) continue;
           newObject[key] = this.serialize(ns.getValueSchema(), sourceObject[key]);
         }
       } else if (ns.isBigDecimalSchema()) {

packages/core/src/submodules/cbor/codec-v2/CborShapeDeserializer2.ts

@@ -1,3 +1,4 @@
+import { hasOwn } from "@smithy/core/client";
 import { SerdeContext } from "@smithy/core/protocols";
 import { NormalizedSchema } from "@smithy/core/schema";
 import { NumericValue, _parseEpochTimestamp, nv } from "@smithy/core/serde";
@@ -173,6 +174,7 @@ function readStruct(ns: NormalizedSchema, count: number, startPos: number): any
   if (isUnion) {
     let resultEmpty = true;
     for (const _ in result) {
+      if (!hasOwn(result, _)) continue;
       resultEmpty = false;
       break;
     }
@@ -348,6 +350,7 @@ function readMapIndefinite(ns: NormalizedSchema): any {
         if (isUnion) {
           let resultEmpty = true;
           for (const _ in result) {
+            if (!hasOwn(result, _)) continue;
             resultEmpty = false;
             break;
           }
@@ -694,6 +697,7 @@ function transformObject(ns: NormalizedSchema, value: any): any {
   if (ns.isMapSchema()) {
     const targetSchema = ns.getValueSchema();
     for (const key in value) {
+      if (!hasOwn(value, key)) continue;
       newObject[key] = transformObject(targetSchema, value[key]);
     }
   } else if (ns.isStructSchema()) {
@@ -702,6 +706,7 @@ function transformObject(ns: NormalizedSchema, value: any): any {
     if (isUnion) {
       keys = new Set<string>();
       for (const k in value) {
+        if (!hasOwn(value, k)) continue;
         if (k !== "__type") {
           keys.add(k);
         }
@@ -718,6 +723,7 @@ function transformObject(ns: NormalizedSchema, value: any): any {
     if (isUnion && keys?.size === 1) {
       let newObjectEmpty = true;
       for (const _ in newObject) {
+        if (!hasOwn(newObject, _)) continue;
         newObjectEmpty = false;
         break;
       }
@@ -727,6 +733,7 @@ function transformObject(ns: NormalizedSchema, value: any): any {
       }
     } else if (typeof value.__type === "string") {
       for (const k in value) {
+        if (!hasOwn(value, k)) continue;
         if (!(k in newObject)) {
           newObject[k] = value[k];
         }

packages/core/src/submodules/cbor/codec-v2/CborShapeSerializer2.ts

@@ -1,3 +1,4 @@
+import { hasOwn } from "@smithy/core/client";
 import { SerdeContext } from "@smithy/core/protocols";
 import { NormalizedSchema } from "@smithy/core/schema";
 import { NumericValue, fromBase64, generateIdempotencyToken } from "@smithy/core/serde";
@@ -353,6 +354,7 @@ function writeStruct(ns: NormalizedSchema, value: Record<string, unknown>, serde
 
   if (typeof value.__type === "string") {
     for (const k in value) {
+      if (!hasOwn(value, k)) continue;
       if (!memberNames.includes(k)) {
         writeString(k);
         writeUntypedValue(value[k]);
@@ -419,6 +421,7 @@ function writeMap(ns: NormalizedSchema, value: Record<string, unknown>, isDocume
 
   const keys: string[] = [];
   for (const k in value) {
+    if (!hasOwn(value, k)) continue;
     const v = value[k];
     if (isDocument ? v !== undefined : v != null || sparse) {
       keys.push(k);

packages/core/src/submodules/cbor/parseCborBody.ts

@@ -1,3 +1,4 @@
+import { hasOwn } from "@smithy/core/client";
 import { HttpRequest as __HttpRequest, collectBody } from "@smithy/core/protocols";
 import { calculateBodyLength } from "@smithy/core/serde";
 import type {
@@ -75,6 +76,7 @@ export const loadSmithyRpcV2CborErrorCode = (output: HttpResponse, data: any): s
 
   let codeKey: string | undefined;
   for (const key in data) {
+    if (!hasOwn(data, key)) continue;
     if (key.toLowerCase() === "code") {
       codeKey = key;
       break;
@@ -122,6 +124,7 @@ export const buildHttpRpcRequest = async (
   }
   if (endpoint.headers) {
     for (const name in endpoint.headers) {
+      if (!hasOwn(endpoint.headers, name)) continue;
       contents.headers[name] = endpoint.headers[name];
     }
   }

packages/core/src/submodules/client/hasOwn.ts

@@ -0,0 +1,6 @@
+/**
+ * @internal
+ */
+export function hasOwn(o: object, k: string) {
+  return Object.prototype.hasOwnProperty.call(o, k);
+}