Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(google-maps): handle trying to access the map before it has been initialized #17805

Merged
merged 1 commit into from
Nov 27, 2019

Conversation

crisbeto
Copy link
Member

@crisbeto crisbeto commented Nov 24, 2019

As things are set up at the moment, the Google Map object will be initialized once the API has loaded, however all of the methods on the GoogleMap component assume that the object will always be defined. This means that if any of the methods are called before it is initialized, we'll throw a null pointer error. These changes add a more readable error so people know what to do.

@crisbeto crisbeto added P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent target: patch This PR is targeted for the next patch release labels Nov 24, 2019
@crisbeto crisbeto requested a review from a team as a code owner November 24, 2019 12:32
@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Nov 24, 2019
Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rather than letting everything no-op when the map is undefined, it seems like throwing an error would be better (a real error, not just "Cannot read xxx of null") so people know what they're doing is invalid

@crisbeto
Copy link
Member Author

Isn't that somewhat prone to race conditions? The consumer has no way of knowing when the maps has been initialized.

@jelbourn
Copy link
Member

If we no-op, the user still hits the race condition, they just get no feedback that it happened and that their call did nothing. Without these methods being async and completing once the API loads, I think it has to error.

…initialized

As things are set up at the moment, the Google `Map` object will be initialized once the API has loaded, however all of the methods on the `GoogleMap` component assume that the object will always be defined. This means that if any of the methods are called before it is initialized, we'll throw a null pointer error. These changes add a more readable error so people know what to do.
@crisbeto crisbeto force-pushed the google-maps-null-checks branch from 29afab4 to 549af93 Compare November 26, 2019 21:06
@crisbeto
Copy link
Member Author

I've reworked it based on the discussion @jelbourn.

Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jelbourn jelbourn added pr: lgtm action: merge The PR is ready for merge by the caretaker labels Nov 27, 2019
@jelbourn jelbourn merged commit d990243 into angular:master Nov 27, 2019
@angular-automatic-lock-bot
Copy link

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.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Dec 28, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker cla: yes PR author has agreed to Google's Contributor License Agreement P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent target: patch This PR is targeted for the next patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants