-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #30 from abema/add-no-expiry-date-param
Add no expiry date param
- Loading branch information
Showing
11 changed files
with
440 additions
and
91 deletions.
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
9 changes: 0 additions & 9 deletions
9
flagfit-flagtype/src/main/java/tv/abema/flagfit/FlagfitDeprecatedParams.kt
This file was deleted.
Oops, something went wrong.
10 changes: 10 additions & 0 deletions
10
flagfit-lint/src/main/java/tv/abema/flagfit/AnnotationPackagePath.kt
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,10 @@ | ||
| package tv.abema.flagfit | ||
|
|
||
| object AnnotationPackagePath { | ||
| const val PACKAGE_PATH_WIP = "tv.abema.flagfit.FlagType.WorkInProgress" | ||
| const val PACKAGE_PATH_EXPERIMENT = "tv.abema.flagfit.FlagType.Experiment" | ||
| const val PACKAGE_PATH_OPS = "tv.abema.flagfit.FlagType.Ops" | ||
| const val PACKAGE_PATH_PERMISSION = "tv.abema.flagfit.FlagType.Permission" | ||
| const val PACKAGE_PATH_BOOLEAN_FLAG = "tv.abema.flagfit.annotation.BooleanFlag" | ||
| const val PACKAGE_PATH_VARIATION_FLAG = "tv.abema.flagfit.annotation.VariationFlag" | ||
| } |
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
114 changes: 114 additions & 0 deletions
114
flagfit-lint/src/main/java/tv/abema/flagfit/FlagTypeExpiryDateIllegalParamDetector.kt
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,114 @@ | ||
| package tv.abema.flagfit | ||
|
|
||
| import com.android.tools.lint.detector.api.AnnotationInfo | ||
| import com.android.tools.lint.detector.api.AnnotationUsageInfo | ||
| import com.android.tools.lint.detector.api.AnnotationUsageType | ||
| import com.android.tools.lint.detector.api.Category | ||
| import com.android.tools.lint.detector.api.Detector | ||
| import com.android.tools.lint.detector.api.Implementation | ||
| import com.android.tools.lint.detector.api.Issue | ||
| import com.android.tools.lint.detector.api.JavaContext | ||
| import com.android.tools.lint.detector.api.Location | ||
| import com.android.tools.lint.detector.api.Scope | ||
| import com.android.tools.lint.detector.api.Severity | ||
| import com.android.tools.lint.detector.api.SourceCodeScanner | ||
| import org.jetbrains.uast.UElement | ||
| import java.time.LocalDate | ||
| import java.time.format.DateTimeFormatter | ||
| import java.time.format.DateTimeParseException | ||
| import java.util.EnumSet | ||
|
|
||
| class FlagTypeExpiryDateIllegalParamDetector : Detector(), SourceCodeScanner { | ||
|
|
||
| override fun applicableAnnotations(): List<String> { | ||
| return listOf( | ||
| AnnotationPackagePath.PACKAGE_PATH_WIP, | ||
| AnnotationPackagePath.PACKAGE_PATH_EXPERIMENT, | ||
| AnnotationPackagePath.PACKAGE_PATH_OPS, | ||
| AnnotationPackagePath.PACKAGE_PATH_PERMISSION, | ||
| ) | ||
| } | ||
|
|
||
| override fun isApplicableAnnotationUsage(type: AnnotationUsageType): Boolean { | ||
| return type == AnnotationUsageType.DEFINITION || super.isApplicableAnnotationUsage(type) | ||
| } | ||
|
|
||
| @Suppress("NewApi") | ||
| override fun visitAnnotationUsage( | ||
| context: JavaContext, | ||
| element: UElement, | ||
| annotationInfo: AnnotationInfo, | ||
| usageInfo: AnnotationUsageInfo, | ||
| ) { | ||
| val qualifiedName = annotationInfo.qualifiedName | ||
| val location = context.getLocation(element) | ||
| val annotationAttributes = annotationInfo.annotation.attributeValues | ||
| val expiryDate = (annotationAttributes.firstOrNull { it.name == "expiryDate" } | ||
| ?.evaluate() as String?) ?: "" | ||
| if (expiryDate == FlagType.EXPIRY_DATE_INFINITE) { | ||
| reportInfiniteExpiryDateErrorIfNeeded(qualifiedName, context, element, location) | ||
| return | ||
| } | ||
| if (!isDateFormatValid(expiryDate)) { | ||
| val message = "The value of expireDate is not in the correct date format.\n" + | ||
| "Please set the expiration date in the following format: \"yyyy-mm-dd\"" | ||
| context.report(ISSUE_ILLEGAL_DATE, element, location, message) | ||
| } | ||
| } | ||
|
|
||
| private fun reportInfiniteExpiryDateErrorIfNeeded( | ||
| qualifiedName: String, | ||
| context: JavaContext, | ||
| element: UElement, | ||
| location: Location, | ||
| ) { | ||
| when (qualifiedName) { | ||
| AnnotationPackagePath.PACKAGE_PATH_WIP, AnnotationPackagePath.PACKAGE_PATH_EXPERIMENT -> { | ||
| val message = "`NO_EXPIRE_DATE` cannot be set for the expireDate of `@FlagType.WorkInProgress` and `@FlagType.Experiment`.\n" + | ||
| "Please set the expiration date in the following format: \"yyyy-mm-dd\"" | ||
| context.report(ISSUE_ILLEGAL_NO_EXPIRE_PARAM, element, location, message) | ||
| } | ||
|
|
||
| AnnotationPackagePath.PACKAGE_PATH_OPS, AnnotationPackagePath.PACKAGE_PATH_PERMISSION -> { | ||
| // do nothing | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun isDateFormatValid(dateString: String): Boolean { | ||
| val formatter = DateTimeFormatter.ISO_LOCAL_DATE | ||
| return try { | ||
| LocalDate.parse(dateString, formatter) | ||
| true | ||
| } catch (ex: DateTimeParseException) { | ||
| false | ||
| } | ||
| } | ||
|
|
||
| companion object { | ||
| val ISSUE_ILLEGAL_NO_EXPIRE_PARAM = Issue.create( | ||
| id = "FlagfitIllegalNoExpireParam", | ||
| briefDescription = "The argument of expireDate is illigal.", | ||
| explanation = "Do not set NO_EXPIRE_DATE for @FlagType.WorkInProgress and @FlagType.Experiment...", | ||
| category = Category.PRODUCTIVITY, | ||
| priority = 4, | ||
| severity = Severity.ERROR, | ||
| implementation = Implementation( | ||
| FlagTypeExpiryDateIllegalParamDetector::class.java, | ||
| EnumSet.of(Scope.JAVA_FILE, Scope.TEST_SOURCES) | ||
| ) | ||
| ) | ||
| val ISSUE_ILLEGAL_DATE = Issue.create( | ||
| id = "FlagfitIllegalDate", | ||
| briefDescription = "The argument of expireDate is illigal.", | ||
| explanation = "The value of expireDate should be in the format \"yyyy-MM-dd\"", | ||
| category = Category.PRODUCTIVITY, | ||
| priority = 6, | ||
| severity = Severity.ERROR, | ||
| implementation = Implementation( | ||
| FlagTypeExpiryDateIllegalParamDetector::class.java, | ||
| EnumSet.of(Scope.JAVA_FILE, Scope.TEST_SOURCES) | ||
| ) | ||
| ) | ||
| } | ||
| } |
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
Oops, something went wrong.