Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Issue
Here is an example of an activity that creates an evaluation record:
Notice that I have explicitly provided
typeof Schema.Stringas the third generic argument.This tells TypeScript that the activity's successful result is a
string. However, I haven't provided the the corresponding runtime schema.TypeScript currently accepts this declaration without reporting an error. This happens because
successanderrorare always optional in thedefineActivitydeclaration:The same optional properties are also accepted by the internal
makeTypedActivityhelper. When a schema is omitted,makeTypedActivityfalls back toSchema.VoidorSchema.Never:This allows the generic type and runtime schema to disagree.
In the example above:
string.Schema.Voidbecausesuccesswas omitted.The same mismatch is possible when a non-default
Errorgeneric is provided but its correspondingerrorschema isomitted.
Solution
This change makes the optionality of
successanderrordepend on the generic types supplied todefineActivity:successremains optional whenSuccessis the defaultSchema.Void.errorremains optional whenErroris the defaultSchema.Never.Successgeneric requires a correspondingsuccessschema.Errorgeneric requires a correspondingerrorschema.Normal inferred declarations continue to work.