-
Notifications
You must be signed in to change notification settings - Fork 946
Remove error messages for deprecated APIs #2857
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
Conversation
Binary Size ReportAffected SDKs
Test Logs |
behavior.`); | ||
logError( | ||
"Support for 'timestampsInSnapshots: false' will be removed soon. " + | ||
'You must update your code to handle Timestamp objects.' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you think of putting the helpful text about how to handle this in a file like packages/firestore/deprecation.md
and then linked to it? Then this could be
"Support for 'timestampsInSnapshots: false' will be removed. " +
'See https://github.com/firebase/firebase-js-sdk/packages/firestore/deprecation.md#timestamps'
It's almost as short but remains just as helpful.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I expanded on the comment in our API docs and added a GIST with the comment (since we can't permalink to the API doc).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is probably better linked to a file actually in the repo rather than a personal gist, similar to what we did here: https://github.com/firebase/firebase-android-sdk/blob/fa9a8c78ad8cae66dec02da9edb40c5303286cc8/firebase-firestore/src/main/java/com/google/firebase/firestore/remote/AbstractStream.java#L282
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FWIW I went back to the original error message (but left the updates to the API documentation). This error message is so old that the number of people that see this probably does not warrant any extra steps.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LG with a few style nits. Thanks!
This PR removes error messages for APIs that are no longer supported and reduces the size for messages that warn about deprecated usage.