fix: Replace raw `in` operator checks with `keyof`-validated type guards by Who-is-PS · Pull Request #4306 · cloudscape-design/components

Who-is-PS · 2026-02-26T17:53:57Z

Description

Replaces raw 'prop' in obj checks with keyof-validated alternatives across 6 components to prevent a class of bugs where TypeScript silently accepts invalid property name strings in in expressions.

This is a COE action item AWSUI-59006 from the property filter bug (YpPBAPz2BrqF) where a type change during refactoring silently broke a 'propertyKey' in newToken check because TypeScript doesn't validate the in operator — 'banana' in obj compiles without error.

Changes:

Added isStackableItem() and isRefObject() type guards to flashbar/utils.ts
Updated collapsible-flashbar.tsx to use isStackableItem() (2 checks) and isRefObject() (1 check)
Updated non-collapsible-flashbar.tsx to use isRefObject() (1 check)
Updated mixed-line-bar-chart/utils.ts to use keyof in isYThreshold() and isXThreshold() (2 checks)
Updated side-navigation/util.tsx to use inline keyof variables for 'href' and 'items' checks (2 checks)
Updated top-navigation/parts/utility.tsx to use inline keyof for 'items' check (1 check)
Updated button-dropdown/internal.tsx to use inline keyof for 'items' and 'badge' checks (2 checks)
Updated button-group/item-element.tsx to use inline keyof for 'popoverFeedback' check (1 check)

12 checks across 7 files, 6 components. No behavioral changes. Pure refactor for type safety.

Related links, issue #, if available: AWSUI-59006 and Tech Proposal. (k9wvA3eNMiZ9).

How has this been tested?

Review checklist

The following items are to be evaluated by the author(s) and the reviewer(s).

Correctness

Changes include appropriate documentation updates.
Changes are backward-compatible if not indicated, see CONTRIBUTING.md.
Changes do not include unsupported browser features, see CONTRIBUTING.md.
Changes were manually tested for accessibility, see accessibility guidelines.

Security

If the code handles URLs: all URLs are validated through the checkSafeUrl function.

Testing

Changes are covered with new/existing unit tests?
Changes are covered with new/existing integration tests?

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

codecov · 2026-02-26T18:09:43Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.43%. Comparing base (80272d6) to head (10e1bf2).
⚠️ Report is 14 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #4306   +/-   ##
=======================================
  Coverage   97.43%   97.43%           
=======================================
  Files         896      897    +1     
  Lines       26298    26352   +54     
  Branches     9496     9509   +13     
=======================================
+ Hits        25623    25677   +54     
  Misses        632      632           
  Partials       43       43

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

georgylobko

In overall I'm not following what is fundamentally different in this function after refactoring. Could you add a u tests that fails before the refactoring and passes after?

georgylobko · 2026-03-05T21:02:41Z

src/autosuggest/utils/utils.ts

 type SearchableTagFields = 'tags' | 'filteringTags';

-const isGroup = (option: AutosuggestItem) => 'type' in option && option.type === 'parent';
+const isGroup = (option: AutosuggestItem) => option.type === 'parent';


the type is optional

Suggested change

const isGroup = (option: AutosuggestItem) => option.type === 'parent';

const isGroup = (option: AutosuggestItem) => option?.type === 'parent';

georgylobko · 2026-03-05T21:03:21Z

src/autosuggest/autosuggest-option.tsx

-  const useEntered = 'type' in option && option.type === 'use-entered';
-  const isParent = 'type' in option && option.type === 'parent';
-  const isChild = 'type' in option && option.type === 'child';
+  const useEntered = option.type === 'use-entered';


Suggested change

const useEntered = option.type === 'use-entered';

const useEntered = option?.type === 'use-entered';

And the same for isParent and isChild

georgylobko · 2026-03-05T21:22:01Z

src/flashbar/utils.ts

+  return key in item;
+}
+
+export function isRefObject<T>(ref: React.Ref<T>): ref is React.RefObject<T> {


Should the ref argument be typed as any? When you call this function, you don't know the type of ref yet - that's exactly what this function is supposed to check

georgylobko · 2026-03-05T21:24:20Z

src/internal/components/option/utils/filter-options.ts

-export const isGroup = (option?: OptionDefinition | OptionGroup): option is OptionGroup =>
-  !!option && 'options' in option && !!option.options;
+export const isGroup = (option?: OptionDefinition | OptionGroup): option is OptionGroup => {
+  const key: keyof OptionGroup = 'options';


I'm not following what is fundamentally different in this function after refactoring. Could you add a u test that fails before the refactoring and passes after?

Who-is-PS added 3 commits February 26, 2026 18:14

fix: Refactor of in checks

09d3661

fix: Refactor of in checks

e9eb6de

fix: Refactor of in checks

8909d7e

Who-is-PS deployed to dev-pages-react18 February 26, 2026 18:04 — with GitHub Actions View deployment

Who-is-PS deployed to dev-pages-react16 February 26, 2026 18:04 — with GitHub Actions View deployment

Who-is-PS marked this pull request as ready for review March 3, 2026 16:22

Who-is-PS requested a review from a team as a code owner March 3, 2026 16:22

Who-is-PS requested review from amanabiy and georgylobko and removed request for a team March 3, 2026 16:22

move from interface to utils

10e1bf2

Who-is-PS deployed to dev-pages-react16 March 4, 2026 09:54 — with GitHub Actions View deployment

Who-is-PS deployed to dev-pages-react18 March 4, 2026 09:54 — with GitHub Actions View deployment

Who-is-PS marked this pull request as draft March 4, 2026 14:40

Who-is-PS marked this pull request as ready for review March 4, 2026 15:54

georgylobko reviewed Mar 5, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Replace raw `in` operator checks with `keyof`-validated type guards#4306

fix: Replace raw `in` operator checks with `keyof`-validated type guards#4306
Who-is-PS wants to merge 4 commits intomainfrom
dev-v3-philosr-refactor-3

Who-is-PS commented Feb 26, 2026 •

edited

Loading

Uh oh!

codecov bot commented Feb 26, 2026 •

edited

Loading

Uh oh!

georgylobko left a comment

Uh oh!

georgylobko Mar 5, 2026

Uh oh!

georgylobko Mar 5, 2026

Uh oh!

georgylobko Mar 5, 2026

Uh oh!

georgylobko Mar 5, 2026

Uh oh!

georgylobko Mar 5, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	const isGroup = (option: AutosuggestItem) => option.type === 'parent';
	const isGroup = (option: AutosuggestItem) => option?.type === 'parent';

	const useEntered = option.type === 'use-entered';
	const useEntered = option?.type === 'use-entered';

Conversation

Who-is-PS commented Feb 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changes:

How has this been tested?

Correctness

Security

Testing

Uh oh!

codecov bot commented Feb 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

georgylobko left a comment

Choose a reason for hiding this comment

Uh oh!

georgylobko Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

georgylobko Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

georgylobko Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

georgylobko Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

georgylobko Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Who-is-PS commented Feb 26, 2026 •

edited

Loading

codecov bot commented Feb 26, 2026 •

edited

Loading