This repository has been archived by the owner on Feb 2, 2023. It is now read-only.
[ASDisplayNode] Add support for setting non-fatal error block #2993
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
garrettmoon
reviewed
Feb 6, 2017
AsyncDisplayKit/ASDisplayNode.h
Outdated
| @@ -53,6 +53,12 @@ typedef void (^ASDisplayNodeContextModifier)(_Nonnull CGContextRef context); | |||
| typedef ASLayoutSpec * _Nonnull(^ASLayoutSpecBlock)(__kindof ASDisplayNode * _Nonnull node, ASSizeRange constrainedSize); | |||
|
|
|||
| /** | |||
| * AsyncDisplayKit non-faltal error block. This block can be used for handling non-fatal errors. Useful for reporting | |||
AsyncDisplayKit/ASDisplayNode.h
Outdated
| @@ -256,6 +262,15 @@ NS_ASSUME_NONNULL_BEGIN | |||
| */ | |||
| @property (readonly) ASInterfaceState interfaceState; | |||
|
|
|||
| /** | |||
| * @abstract Class property that allows to set a block that can be called on non-fatal errors. This | |||
| * property can be useful for cases when Async Display Kit can recover from an anormal behavior, but | |||
AsyncDisplayKit/ASDisplayNode.h
Outdated
| /** | ||
| * @abstract Class property that allows to set a block that can be called on non-fatal errors. This | ||
| * property can be useful for cases when Async Display Kit can recover from an anormal behavior, but | ||
| * still gives the opportunity to use a reporting mechanism to catch occurrences in production. |
There was a problem hiding this comment.
Maybe add: "In development, ASDK will assert instead of calling this."
|
Jenkins, add to whitelist |
garrettmoon
reviewed
Feb 7, 2017
Base/ASAssert.h
Outdated
| @@ -59,3 +59,17 @@ | |||
| #define ASDisplayNodeCAssertPositiveReal(description, num) ASDisplayNodeCAssert(num >= 0 && num <= CGFLOAT_MAX, @"%@ must be a real positive integer.", description) | |||
| #define ASDisplayNodeCAssertInfOrPositiveReal(description, num) ASDisplayNodeCAssert(isinf(num) || (num >= 0 && num <= CGFLOAT_MAX), @"%@ must be infinite or a real positive integer.", description) | |||
|
|
|||
| #define ASDisplayNodeErrorDomain @"ASDisplayNodeErrorDomain" | |||
| #define ASDisplayNodeNonFatalErrorCode 0 | |||
There was a problem hiding this comment.
Total nit, but maybe make this 1? Many systems use zero as a non-error.
Base/ASAssert.h
Outdated
| #define ASDisplayNodeNonFatalErrorCode 0 | ||
|
|
||
| #define ASDisplayNodeAssertNonFatal(desc, ...) \ | ||
| ASDisplayNodeAssert(NO, desc, ##__VA_ARGS__); \ |
There was a problem hiding this comment.
I was thinking more along the lines of this above
#define ASDisplayNodeAssertNonFatal(condition, desc, ...)
ASDisplayNodeAssert(condition, desc, ##__VA_ARGS__);
if (condition) {
garrettmoon
approved these changes
Feb 7, 2017
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently Async Display Kit doesn't provide a mechanism for "asserting" in production. In many the framework can recover from failures, but that would happen silently when in production.
This code changes gives the ability to set a "non-fatal error block" on
ASDisplayNodeclass, so it can be plugged in many areas where we have asserts, for example, so developers have the change to capture and report such failures in production.This addresses #2807 .