refactor: convert icon-factory.js to typescript

[davidmurdoch]

No description provided.

[github-actions]

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.99%. Comparing base (e775193) to head (8e21b92).

❗ Current head 8e21b92 differs from pull request most recent head 08b602a. Consider uploading reports for the commit 08b602a to get more accurate results

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #23823      +/-   ##
===========================================
+ Coverage    67.36%   68.99%   +1.63%     
===========================================
  Files         1282     1164     -118     
  Lines        50011    44513    -5498     
  Branches     12983    11887    -1096     
===========================================
- Hits         33685    30709    -2976     
+ Misses       16326    13804    -2522     

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

[metamaskbot]

Builds ready [8e21b92]

• builds: chrome, firefox
• builds (beta): chrome
• builds (flask): chrome, firefox
• builds (MMI): chrome, firefox
• builds (test): chrome, firefox
• builds (test-flask): chrome, firefox
• build viz: Build System
• mv3: Background Module Init Stats
• mv3: UI Init Stats
• mv3: Module Load Stats
• mv3: Bundle Size Stats
• mv2: E2e Actions Stats
• code coverage: Report
• storybook: Storybook
• typescript migration: Dashboard
• all artifacts
• bundle viz:

  • background: 0, 1, 2, 3, 4, 5
  • common: 0, 1, 2, 3, 4, 5, 6
  • content-script: 0
  • ui: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1034 ± 508 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	62	208	121	40	19
		domContentLoaded	10	79	27	17	8
		load	50	2567	1034	1058	508
		domInteractive	10	79	27	17	8

Bundle size diffs

• background: 0 Bytes (0.00%)
• ui: 452 Bytes (0.01%)
• common: 0 Bytes (0.00%)

[DDDDDanica]

Should be boolean here?

Suggested change

	): tokenMetadata is TokenMetadata {
	): boolean {

[davidmurdoch]

No, the iconExistsFor function acts as a type guard via a type predicate (the tokenMetadata is TokenMetadata part).

It enables the following, where tokenMetadata is optional in iconExistsFor, but not in imageElFor. TypeScript isn't "smart" enough to infer that tokenMetadata is never null/undefined when iconExistsFor returns true, so a type predicate is used to give TypeScript that information, otherwise we'd have to cast TokenMetadata or check for null/undefined again inside the if statement.

    if (iconExistsFor(address, tokenMetadata)) {
      return imageElFor(tokenMetadata);
    }

See https://www.typescriptlang.org/docs/handbook/2/narrowing.html#using-type-predicates for details.

[DDDDDanica]

thanks ! it makes sense !

[NiranjanaBinoy]

The changes look good to me, and I tested them locally.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[metamaskbot]

Builds ready [f4bfed4]

• builds: chrome, firefox
• builds (beta): chrome
• builds (flask): chrome, firefox
• builds (MMI): chrome, firefox
• builds (test): chrome, firefox
• builds (test-flask): chrome, firefox
• build viz: Build System
• mv3: Background Module Init Stats
• mv3: UI Init Stats
• mv3: Module Load Stats
• mv3: Bundle Size Stats
• mv2: E2e Actions Stats
• code coverage: Report
• storybook: Storybook
• typescript migration: Dashboard
• all artifacts
• bundle viz:

  • background: 0, 1, 2, 3, 4, 5
  • common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9
  • content-script: 0
  • offscreen: 0
  • ui: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (457 ± 372 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	78	426	142	98	47
		domContentLoaded	10	78	28	22	10
		load	44	2115	457	776	372
		domInteractive	10	78	28	22	10

Bundle size diffs [🚨 Warning! Bundle size has increased!]

• background: 0 Bytes (0.00%)
• ui: 0 Bytes (0.00%)
• common: 452 Bytes (0.01%)