-
Notifications
You must be signed in to change notification settings - Fork 244
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
feat(jsii-diff): also check stability transitions #592
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
import reflect = require('jsii-reflect'); | ||
import spec = require('jsii-spec'); | ||
import { ApiElement, ComparisonContext } from './types'; | ||
|
||
export function compareStabilities(original: reflect.Documentable & ApiElement, updated: reflect.Documentable, context: ComparisonContext) { | ||
// Nothing to do in these cases | ||
if (original.docs.stability === undefined || original.docs.stability === updated.docs.stability) { return; } | ||
|
||
// Not allowed to disavow stability | ||
if (updated.docs.stability === undefined) { | ||
context.mismatches.report({ | ||
ruleKey: 'removed-stability', | ||
message: `stability was '${original.docs.stability}', has been removed`, | ||
violator: original, | ||
}); | ||
return; | ||
} | ||
|
||
const allowed = allowedTransitions(original.docs.stability); | ||
if (!allowed.includes(updated.docs.stability)) { | ||
context.mismatches.report({ | ||
ruleKey: 'changed-stability', | ||
message: `stability not allowed to go from '${original.docs.stability}' to '${updated.docs.stability}'`, | ||
violator: original, | ||
}); | ||
} | ||
} | ||
|
||
function allowedTransitions(start: spec.Stability): spec.Stability[] { | ||
switch (start) { | ||
// Experimental can go to stable or be deprecated | ||
case spec.Stability.Experimental: | ||
return [spec.Stability.Stable, spec.Stability.Deprecated]; | ||
|
||
// Stable can be deprecated | ||
case spec.Stability.Stable: | ||
return [spec.Stability.Deprecated]; | ||
|
||
// Deprecated can be reinstated | ||
case spec.Stability.Deprecated: | ||
return [spec.Stability.Stable]; | ||
} | ||
|
||
throw new Error(`Unrecognized stability: ${start}`); | ||
} |
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
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.
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.
Is that the case where stability is inherited? What happens if you change the stability of the oRent module/type, is it inherited by the Jsii compiler! Can we evened even have an undefined stability for an api?
Also, wasn’t this what we wanted to do for the CFN layer?
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.
Inheritance has already been calculated at this level. I thought for the CFN layer we introduce a new explicit stability level (
imported
), not(nothing)
.