fix(core): Updates ngForOf iterable error to use RuntimeError code #46526

jessicajaniuk · 2022-06-27T20:07:13Z

This updates the iterable differ error to use more up-to-date error
codes. It also adds a page to the documentation for the error.

PR Checklist

Please check if your PR fulfills the following requirements:

The commit message follows our guidelines: https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

Bugfix
Feature
Code style update (formatting, local variables)
Refactoring (no functional changes, no api changes)
Build related changes
CI related changes
Documentation content changes
angular.io application / infrastructure changes
Other... Please describe:

What is the current behavior?

The error thrown in ngForOf is a basic throw rather than using tree shakeable error codes with the runtime error class.

Issue Number: Fixes #28240

What is the new behavior?

The error thrown is tree shakable and has a documentation page.

Does this PR introduce a breaking change?

Yes
No

Other information

dylhunn

reviewed-for: public-api, fw-common

Looks great!

mary-poppins · 2022-06-27T21:45:58Z

You can preview 2b633b4 at https://pr46526-2b633b4.ngbuilds.io/.
You can preview 3d9f388 at https://pr46526-3d9f388.ngbuilds.io/.
You can preview b419d0f at https://pr46526-b419d0f.ngbuilds.io/.
You can preview 24a5d1f at https://pr46526-24a5d1f.ngbuilds.io/.
You can preview 3a72e96 at https://pr46526-3a72e96.ngbuilds.io/.

AndrewKushnir

Looks great, just some minor comments 👍

AndrewKushnir · 2022-06-27T21:58:53Z

packages/common/src/directives/ng_for_of.ts

+                `Cannot find a differ supporting object '${value}' of type '${
+                    getTypeName(
+                        value)}'. NgFor only supports binding to Iterables, such as Arrays. Did you mean to use the keyvalue pipe?`);


nit: we can split the long string into string concat to avoid unexpected formatting:

Suggested change

`Cannot find a differ supporting object '${value}' of type '${

getTypeName(

value)}'. NgFor only supports binding to Iterables, such as Arrays. Did you mean to use the keyvalue pipe?`);

`Cannot find a differ supporting object '${value}' of type '${getTypeName(value)}'. ` +

`NgFor only supports binding to Iterables, such as Arrays. Did you mean to use the keyvalue pipe?`);

We can also consider adding the Did you mean to use the keyvalue pipe? only when we come across an object (and add tests for various cases), otherwise it'd appear for other types as well, which might confuse users. WDYT?

I definitely like that. I've added a check to append that to the error message after detecting if it's an object.

This updates the iterable differ error to use more up-to-date error codes.

mary-poppins · 2022-06-27T22:31:05Z

You can preview 3cbefd8 at https://pr46526-3cbefd8.ngbuilds.io/.

AndrewKushnir

Reviewed-for: public-api

dylhunn · 2022-06-28T07:29:56Z

This PR was merged into the repository by commit f86e094.

This updates the iterable differ error to use more up-to-date error codes. PR Close #46526

dylhunn · 2022-06-28T17:31:33Z

@jessicajaniuk I think you may actually want a negative error code here since you have a guide added, as per this instruction

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@angular/animations](https://github.com/angular/angular) | dependencies | patch | [`14.0.3` -> `14.0.4`](https://renovatebot.com/diffs/npm/@angular%2fanimations/14.0.3/14.0.4) | | [@angular/common](https://github.com/angular/angular) | dependencies | patch | [`14.0.3` -> `14.0.4`](https://renovatebot.com/diffs/npm/@angular%2fcommon/14.0.3/14.0.4) | | [@angular/compiler](https://github.com/angular/angular) | dependencies | patch | [`14.0.3` -> `14.0.4`](https://renovatebot.com/diffs/npm/@angular%2fcompiler/14.0.3/14.0.4) | | [@angular/compiler-cli](https://github.com/angular/angular) | devDependencies | patch | [`14.0.3` -> `14.0.4`](https://renovatebot.com/diffs/npm/@angular%2fcompiler-cli/14.0.3/14.0.4) | | [@angular/core](https://github.com/angular/angular) | dependencies | patch | [`14.0.3` -> `14.0.4`](https://renovatebot.com/diffs/npm/@angular%2fcore/14.0.3/14.0.4) | | [@angular/forms](https://github.com/angular/angular) | dependencies | patch | [`14.0.3` -> `14.0.4`](https://renovatebot.com/diffs/npm/@angular%2fforms/14.0.3/14.0.4) | | [@angular/platform-browser](https://github.com/angular/angular) | dependencies | patch | [`14.0.3` -> `14.0.4`](https://renovatebot.com/diffs/npm/@angular%2fplatform-browser/14.0.3/14.0.4) | | [@angular/platform-browser-dynamic](https://github.com/angular/angular) | dependencies | patch | [`14.0.3` -> `14.0.4`](https://renovatebot.com/diffs/npm/@angular%2fplatform-browser-dynamic/14.0.3/14.0.4) | --- ### Release Notes <details> <summary>angular/angular</summary> ### [`v14.0.4`](https://github.com/angular/angular/blob/HEAD/CHANGELOG.md#1404-2022-06-29) [Compare Source](angular/angular@14.0.3...14.0.4) ##### animations | Commit | Type | Description | | -- | -- | -- | | [51be9bbe29](angular/angular@51be9bb) | fix | cleanup DOM elements when the root view is removed ([#45143](angular/angular#45143)) | | [999aca86c8](angular/angular@999aca8) | fix | enable shadowElements to leave when their parent does ([#46459](angular/angular#46459)) | ##### common | Commit | Type | Description | | -- | -- | -- | | [42aed6b13e](angular/angular@42aed6b) | fix | handle CSS custom properties in NgStyle ([#46451](angular/angular#46451)) | ##### core | Commit | Type | Description | | -- | -- | -- | | [1e7f22f00a](angular/angular@1e7f22f) | fix | trigger `ApplicationRef.destroy` when Platform is destroyed ([#46497](angular/angular#46497)) | | [8bde2dbc71](angular/angular@8bde2db) | fix | Update ngfor error code to be negative ([#46555](angular/angular#46555)) | | [57e8fc00eb](angular/angular@57e8fc0) | fix | Updates error to use RuntimeError code ([#46526](angular/angular#46526)) | ##### forms | Commit | Type | Description | | -- | -- | -- | | [74a26d870e](angular/angular@74a26d8) | fix | Convert existing reactive errors to use RuntimeErrorCode. ([#46560](angular/angular#46560)) | | [747872212d](angular/angular@7478722) | fix | Update a Forms validator error to use RuntimeError ([#46537](angular/angular#46537)) | ##### router | Commit | Type | Description | | -- | -- | -- | | [d6fac9e914](angular/angular@d6fac9e) | fix | Ensure that new `RouterOutlet` instances work after old ones are destroyed ([#46554](angular/angular#46554)) | #### Special Thanks Alan Agius, Alex Rickabaugh, Andrew Kushnir, Andrew Scott, Bezael, Chad Ramos, Chellappan, Cédric Exbrayat, Dylan Hunn, George Kalpakas, Jeremy Meiss, Jessica Janiuk, Joey Perrott, KMathy, Kristiyan Kostadinov, Paul Gschwendtner, Pawel Kozlowski, Ramesh Thiruchelvam, Vaibhav Kumar, arturovt, dario-piotrowicz and renovate\[bot]  </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1437 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

angular-automatic-lock-bot · 2022-07-29T16:06:42Z

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}

jessicajaniuk added the area: core Issues related to the framework runtime label Jun 27, 2022

ngbot bot added this to the Backlog milestone Jun 27, 2022

jessicajaniuk force-pushed the ngforof-iterable branch from 2b633b4 to 3d9f388 Compare June 27, 2022 20:35

AndrewKushnir modified the milestones: Backlog, Fixit H1'2022 Jun 27, 2022

jessicajaniuk force-pushed the ngforof-iterable branch 4 times, most recently from b419d0f to 24a5d1f Compare June 27, 2022 21:10

jessicajaniuk changed the title ~~fix(core): Add a better check and error message for ngForOf iterables~~ fix(core): Updates ngForOf iterable error to use RuntimeError code Jun 27, 2022

jessicajaniuk force-pushed the ngforof-iterable branch from 24a5d1f to 3a72e96 Compare June 27, 2022 21:36

jessicajaniuk marked this pull request as ready for review June 27, 2022 21:43

pullapprove bot requested review from alxhub, AndrewKushnir and dylhunn June 27, 2022 21:43

dylhunn approved these changes Jun 27, 2022

View reviewed changes

pullapprove bot requested a review from atscott June 27, 2022 21:44

jessicajaniuk added action: review The PR is still awaiting reviews from at least one requested reviewer aio: preview action: presubmit The PR is in need of a google3 presubmit labels Jun 27, 2022

jessicajaniuk added the target: patch This PR is targeted for the next patch release label Jun 27, 2022

AndrewKushnir reviewed Jun 27, 2022

View reviewed changes

pullapprove bot requested a review from AndrewKushnir June 27, 2022 22:04

fix(core): Updates error to use RuntimeError code

3cbefd8

This updates the iterable differ error to use more up-to-date error codes.

jessicajaniuk force-pushed the ngforof-iterable branch from 3a72e96 to 3cbefd8 Compare June 27, 2022 22:20

AndrewKushnir approved these changes Jun 27, 2022

View reviewed changes

pullapprove bot requested a review from AndrewKushnir June 27, 2022 22:37

AndrewKushnir approved these changes Jun 27, 2022

View reviewed changes

jessicajaniuk removed request for atscott and alxhub June 27, 2022 22:50

dylhunn closed this in f86e094 Jun 28, 2022

dylhunn pushed a commit that referenced this pull request Jun 28, 2022

fix(core): Updates error to use RuntimeError code (#46526)

57e8fc0

This updates the iterable differ error to use more up-to-date error codes. PR Close #46526

This was referenced Jul 1, 2022

build(deps-dev): bump @angular/language-service from 12.2.4 to 14.0.4 numbersprotocol/capture-lite#1761

Closed

build(deps-dev): bump @angular/compiler from 12.2.4 to 14.0.4 numbersprotocol/capture-lite#1755

Closed

angular-automatic-lock-bot bot locked and limited conversation to collaborators Jul 29, 2022

jessicajaniuk deleted the ngforof-iterable branch January 27, 2023 16:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(core): Updates ngForOf iterable error to use RuntimeError code #46526

fix(core): Updates ngForOf iterable error to use RuntimeError code #46526

jessicajaniuk commented Jun 27, 2022 •

edited

dylhunn left a comment

mary-poppins commented Jun 27, 2022

AndrewKushnir left a comment

AndrewKushnir Jun 27, 2022

AndrewKushnir Jun 27, 2022

jessicajaniuk Jun 27, 2022

mary-poppins commented Jun 27, 2022

AndrewKushnir left a comment

dylhunn commented Jun 28, 2022

dylhunn commented Jun 28, 2022

angular-automatic-lock-bot bot commented Jul 29, 2022

fix(core): Updates ngForOf iterable error to use RuntimeError code #46526

fix(core): Updates ngForOf iterable error to use RuntimeError code #46526

Conversation

jessicajaniuk commented Jun 27, 2022 • edited

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

dylhunn left a comment

Choose a reason for hiding this comment

mary-poppins commented Jun 27, 2022

AndrewKushnir left a comment

Choose a reason for hiding this comment

AndrewKushnir Jun 27, 2022

Choose a reason for hiding this comment

AndrewKushnir Jun 27, 2022

Choose a reason for hiding this comment

jessicajaniuk Jun 27, 2022

Choose a reason for hiding this comment

mary-poppins commented Jun 27, 2022

AndrewKushnir left a comment

Choose a reason for hiding this comment

dylhunn commented Jun 28, 2022

dylhunn commented Jun 28, 2022

angular-automatic-lock-bot bot commented Jul 29, 2022

jessicajaniuk commented Jun 27, 2022 •

edited