mirror of
https://github.com/fork-maintainers/iceraven-browser
synced 2024-11-15 18:12:54 +00:00
990bfa7e6d
* For #16900: implement async navgraph inflation For #16900: removed nav graph from xml For #16900: inflate navGraph programatically For #16900: Made NavGraph inflation asynchronous For #16900: Changed to block with runBlocking For #16900: Refactored blocking call into a function For 16900: NavGraph inflation is now async We now attach the nav graph (or check if its attached) on every nav call ( an extension function for NavController). This is done by checking the value of the job stored in PerfNavController.map which keeps track of the job with the NavController as a Key. If the job hasn't been completed, it will block the main thread until the job is done. The job itself is responsible for attaching the navgraph to the navcontroller (and the inflation of the latter too) For 16900: rebased upstream master For 16900: Rebase on master For #16900: Fixed Async Navgraph navigation per review comments. 1)The Asynchronous method is now found in NavGraphProvider.kt. It creates a job on the IO dispatcher 2)The Job is tracked through a WeakHashMap from Controller --> NavGraph 3)The Coroutine scope doesn't use MainScope() anymore 4)The Coroutine is cancelled if the Activity is destroyed 5)The tests mockk the blockForNavGraphInflation method through the FenixReoboelectricTestApplication instead of calling the mock every setup() For #16900: inflateNavGraphAsync now takes navController For #16900: Pass lifecycleScope to NavGraphProvider For #16900: removed unused mock For #16900: Added linter rules for navigate calls We need linting rules to make sure no one calls the NavController.navigate() methods For #16900: Added TestRule to help abstract the mocks in the code For 16900: Fix linting problems For #16900: Cleaned duplicated code in tests For #16900: cleaned up NavGraphTestRule for finished test For #16900: had to revert an accidentally edited file For #16900: rebased master * For #16900: Review nits for async navgraph This is composed of squash commits, the original messages can be found below: -> DisableNavGraphProviderAssertionRule + kdoc. Use test rule in RobolectricApplication. Fix failing CrashReporterControllerTest Fix blame by -> navigate in tests. This commit was generated by the following commands only: ``` find app/src/test -type f -exec sed -i '' "/import org.mozilla.fenix.ext.navigateBlockingForAsyncNavGraph/d" {} \; find app/src/test -type f -exec sed -i "" "s/navigateBlockingForAsyncNavGraph/navigate/g" {} \; git checkout app/src/test/resources/mockito-extensions/org.mockito.plugins.MockMaker ``` Fix various blame This is expected to be squashed into the first commit so, if so, it'd fix the blame. Move test rule to helpers pkg. add missing license header Add import change I missed fix unused imports Replace robolectricTestrunner with test rule. Improve navGraphProvider docs Remove unnecessary rule as defined by robolectric. add clarifying comment to robolectric remove unnecessary space * For #16900: nit fixes for MozillaNavigateCheck and lint fixes 3 squash commits: *Changed violation message and fixed the lint rule for MozillaNavigateCheck *Added suppression to NavController.kt *Fixed detekt violations * For 16900: Fixed failing tests Co-authored-by: Michael Comella <michael.l.comella@gmail.com>
401 lines
9.8 KiB
YAML
401 lines
9.8 KiB
YAML
build:
|
|
maxIssues: 0
|
|
weights:
|
|
# complexity: 2
|
|
# LongParameterList: 1
|
|
# style: 1
|
|
# comments: 1
|
|
|
|
processors:
|
|
active: true
|
|
exclude:
|
|
# - 'FunctionCountProcessor'
|
|
# - 'PropertyCountProcessor'
|
|
# - 'ClassCountProcessor'
|
|
# - 'PackageCountProcessor'
|
|
# - 'KtFileCountProcessor'
|
|
|
|
console-reports:
|
|
active: true
|
|
exclude:
|
|
# - 'ProjectStatisticsReport'
|
|
# - 'ComplexityReport'
|
|
# - 'NotificationReport'
|
|
# - 'FindingsReport'
|
|
# - 'BuildFailureReport'
|
|
# - 'HtmlOutputReport'
|
|
- 'PlainOutputReport'
|
|
- 'XmlOutputReport'
|
|
|
|
comments:
|
|
active: true
|
|
excludes: "**/*Test.kt, **/*Spec.kt, **/test/**, **/androidTest/**"
|
|
AbsentOrWrongFileLicense:
|
|
active: true
|
|
CommentOverPrivateFunction:
|
|
active: false
|
|
CommentOverPrivateProperty:
|
|
active: false
|
|
EndOfSentenceFormat:
|
|
active: false
|
|
endOfSentenceFormat: ([.?!][ \t\n\r\f<])|([.?!]$)
|
|
UndocumentedPublicClass:
|
|
active: false
|
|
searchInNestedClass: true
|
|
searchInInnerClass: true
|
|
searchInInnerObject: true
|
|
searchInInnerInterface: true
|
|
UndocumentedPublicFunction:
|
|
active: false
|
|
|
|
complexity:
|
|
active: true
|
|
ComplexCondition:
|
|
active: true
|
|
threshold: 4
|
|
ComplexInterface:
|
|
active: false
|
|
threshold: 10
|
|
includeStaticDeclarations: false
|
|
ComplexMethod:
|
|
active: true
|
|
threshold: 15
|
|
ignoreSingleWhenExpression: true
|
|
LabeledExpression:
|
|
active: false
|
|
LargeClass:
|
|
active: true
|
|
excludes: "**/*Test.kt, **/*Spec.kt, **/test/**, **/androidTest/**"
|
|
# Had to increase the threshold as RC13 started counting lines of code
|
|
# https://github.com/mozilla-mobile/fenix/issues/4861
|
|
threshold: 200
|
|
LongMethod:
|
|
active: true
|
|
excludes: "**/*Test.kt, **/*Spec.kt, **/test/**, **/androidTest/**"
|
|
# Had to increase the threshold as RC13 started counting lines of code
|
|
# https://github.com/mozilla-mobile/fenix/issues/4861
|
|
threshold: 75
|
|
LongParameterList:
|
|
active: true
|
|
excludes: "**/*Controller.kt, **/*Integration.kt"
|
|
functionThreshold: 6
|
|
constructorThreshold: 7
|
|
ignoreDefaultParameters: false
|
|
ignoreDataClasses: true
|
|
MethodOverloading:
|
|
active: false
|
|
threshold: 6
|
|
NestedBlockDepth:
|
|
active: true
|
|
threshold: 4
|
|
StringLiteralDuplication:
|
|
active: false
|
|
excludes: "**/*Test.kt, **/*Spec.kt, **/test/**, **/androidTest/**"
|
|
threshold: 3
|
|
ignoreAnnotation: true
|
|
excludeStringsWithLessThan5Characters: true
|
|
ignoreStringsRegex: '$^'
|
|
TooManyFunctions:
|
|
active: true
|
|
excludes: "**/*Test.kt, **/*Spec.kt, **/test/**, **/androidTest/**"
|
|
thresholdInFiles: 11
|
|
thresholdInClasses: 11
|
|
thresholdInInterfaces: 11
|
|
thresholdInObjects: 11
|
|
thresholdInEnums: 11
|
|
|
|
mozilla-detekt-rules:
|
|
active: true
|
|
MozillaBannedPropertyAccess:
|
|
active: true
|
|
# BuildConfig.Debug: This property tests whether the application was built
|
|
# with the debuggable flag or not. Use a check for different build variants,
|
|
# instead.
|
|
bannedProperties: "BuildConfig.DEBUG"
|
|
MozillaStrictModeSuppression:
|
|
active: true
|
|
excludes: "**/*Test.kt, **/*Spec.kt, **/test/**, **/androidTest/**"
|
|
MozillaCorrectUnitTestRunner:
|
|
active: true
|
|
MozillaRunBlockingCheck:
|
|
active: true
|
|
excludes: "**/*Test.kt, **/*Spec.kt, **/test/**, **/androidTest/**"
|
|
MozillaUseLazyMonitored:
|
|
active: true
|
|
MozillaNavigateCheck:
|
|
active: true
|
|
excludes: "**/*Test.kt, **/*Spec.kt, **/test/**, **/androidTest/**"
|
|
|
|
empty-blocks:
|
|
active: true
|
|
EmptyCatchBlock:
|
|
active: true
|
|
allowedExceptionNameRegex: "^(ignore|expected).*"
|
|
EmptyClassBlock:
|
|
active: true
|
|
EmptyDefaultConstructor:
|
|
active: true
|
|
EmptyDoWhileBlock:
|
|
active: true
|
|
EmptyElseBlock:
|
|
active: true
|
|
EmptyFinallyBlock:
|
|
active: true
|
|
EmptyForBlock:
|
|
active: true
|
|
EmptyFunctionBlock:
|
|
active: true
|
|
excludes: "**/*Test.kt, **/*Spec.kt, **/test/**, **/androidTest/**"
|
|
EmptyIfBlock:
|
|
active: true
|
|
EmptyInitBlock:
|
|
active: true
|
|
EmptyKtFile:
|
|
active: true
|
|
EmptySecondaryConstructor:
|
|
active: true
|
|
EmptyWhenBlock:
|
|
active: true
|
|
EmptyWhileBlock:
|
|
active: true
|
|
|
|
exceptions:
|
|
active: true
|
|
ExceptionRaisedInUnexpectedLocation:
|
|
active: false
|
|
methodNames: 'toString,hashCode,equals,finalize'
|
|
InstanceOfCheckForException:
|
|
active: false
|
|
NotImplementedDeclaration:
|
|
active: false
|
|
PrintStackTrace:
|
|
active: false
|
|
RethrowCaughtException:
|
|
active: false
|
|
ReturnFromFinally:
|
|
active: false
|
|
SwallowedException:
|
|
active: false
|
|
ThrowingExceptionFromFinally:
|
|
active: false
|
|
ThrowingExceptionInMain:
|
|
active: false
|
|
ThrowingExceptionsWithoutMessageOrCause:
|
|
active: false
|
|
exceptions: 'IllegalArgumentException,IllegalStateException,IOException'
|
|
ThrowingNewInstanceOfSameException:
|
|
active: false
|
|
TooGenericExceptionCaught:
|
|
active: true
|
|
exceptionNames:
|
|
- ArrayIndexOutOfBoundsException
|
|
- Error
|
|
- Exception
|
|
- IllegalMonitorStateException
|
|
- NullPointerException
|
|
- IndexOutOfBoundsException
|
|
- RuntimeException
|
|
- Throwable
|
|
TooGenericExceptionThrown:
|
|
active: true
|
|
exceptionNames:
|
|
- Error
|
|
- Exception
|
|
- Throwable
|
|
- RuntimeException
|
|
|
|
formatting:
|
|
autoCorrect: true
|
|
|
|
naming:
|
|
active: true
|
|
ClassNaming:
|
|
active: true
|
|
classPattern: '[A-Z$][a-zA-Z0-9$]*'
|
|
EnumNaming:
|
|
active: true
|
|
enumEntryPattern: '^[A-Z][_a-zA-Z0-9]*'
|
|
ForbiddenClassName:
|
|
active: false
|
|
forbiddenName: ''
|
|
FunctionMaxLength:
|
|
active: false
|
|
maximumFunctionNameLength: 30
|
|
FunctionMinLength:
|
|
active: false
|
|
minimumFunctionNameLength: 3
|
|
FunctionNaming:
|
|
active: true
|
|
excludes: "**/*Test.kt, **/*Spec.kt, **/test/**, **/androidTest/**"
|
|
functionPattern: '^([a-z$][a-zA-Z$0-9]*)|(`.*`)$'
|
|
excludeClassPattern: '$^'
|
|
MatchingDeclarationName:
|
|
active: true
|
|
MemberNameEqualsClassName:
|
|
active: false
|
|
ignoreOverridden: true
|
|
ObjectPropertyNaming:
|
|
active: true
|
|
propertyPattern: '[A-Za-z][_A-Za-z0-9]*'
|
|
PackageNaming:
|
|
active: true
|
|
packagePattern: '^[a-z]+(\.[a-z][a-z0-9]*)*$'
|
|
TopLevelPropertyNaming:
|
|
active: true
|
|
constantPattern: '[A-Z][_A-Z0-9]*'
|
|
propertyPattern: '[a-z][A-Za-z\d]*'
|
|
privatePropertyPattern: '(_)?[a-z][A-Za-z0-9]*'
|
|
VariableMaxLength:
|
|
active: false
|
|
maximumVariableNameLength: 64
|
|
VariableMinLength:
|
|
active: false
|
|
minimumVariableNameLength: 1
|
|
VariableNaming:
|
|
active: true
|
|
variablePattern: '[a-z][A-Za-z0-9]*'
|
|
privateVariablePattern: '(_)?[a-z][A-Za-z0-9]*'
|
|
excludeClassPattern: '$^'
|
|
|
|
performance:
|
|
active: true
|
|
ForEachOnRange:
|
|
active: true
|
|
SpreadOperator:
|
|
active: true
|
|
excludes: "**/*Test.kt, **/*Spec.kt, **/test/**, **/androidTest/**"
|
|
UnnecessaryTemporaryInstantiation:
|
|
active: true
|
|
|
|
potential-bugs:
|
|
active: true
|
|
DuplicateCaseInWhenExpression:
|
|
active: true
|
|
EqualsAlwaysReturnsTrueOrFalse:
|
|
active: false
|
|
EqualsWithHashCodeExist:
|
|
active: true
|
|
ExplicitGarbageCollectionCall:
|
|
active: true
|
|
InvalidRange:
|
|
active: false
|
|
IteratorHasNextCallsNextMethod:
|
|
active: false
|
|
IteratorNotThrowingNoSuchElementException:
|
|
active: false
|
|
LateinitUsage:
|
|
active: false
|
|
excludes: "**/*Test.kt, **/*Spec.kt, **/test/**, **/androidTest/**"
|
|
excludeAnnotatedProperties: ""
|
|
ignoreOnClassesPattern: ""
|
|
UnconditionalJumpStatementInLoop:
|
|
active: false
|
|
UnreachableCode:
|
|
active: true
|
|
UnsafeCallOnNullableType:
|
|
active: false
|
|
UnsafeCast:
|
|
active: false
|
|
UselessPostfixExpression:
|
|
active: false
|
|
WrongEqualsTypeParameter:
|
|
active: false
|
|
|
|
style:
|
|
active: true
|
|
CollapsibleIfStatements:
|
|
active: true
|
|
DataClassContainsFunctions:
|
|
active: false
|
|
conversionFunctionPrefix: 'to'
|
|
EqualsNullCall:
|
|
active: false
|
|
ExpressionBodySyntax:
|
|
active: false
|
|
ForbiddenComment:
|
|
active: true
|
|
values: 'TODO:,FIXME:,STOPSHIP:'
|
|
ForbiddenImport:
|
|
active: false
|
|
imports: ''
|
|
FunctionOnlyReturningConstant:
|
|
active: false
|
|
ignoreOverridableFunction: true
|
|
excludedFunctions: 'describeContents'
|
|
LoopWithTooManyJumpStatements:
|
|
active: false
|
|
maxJumpCount: 1
|
|
MagicNumber:
|
|
active: true
|
|
excludes: "**/*Test.kt, **/*Spec.kt, **/test/**, **/androidTest/**"
|
|
ignoreNumbers: '-1,0,1,2'
|
|
ignoreHashCodeFunction: false
|
|
ignorePropertyDeclaration: false
|
|
ignoreConstantDeclaration: true
|
|
ignoreCompanionObjectPropertyDeclaration: true
|
|
ignoreAnnotation: false
|
|
ignoreNamedArgument: true
|
|
ignoreEnums: false
|
|
MaxLineLength:
|
|
active: true
|
|
excludes: "**/*Test.kt, **/*Spec.kt, **/test/**, **/androidTest/**"
|
|
maxLineLength: 120
|
|
excludePackageStatements: false
|
|
excludeImportStatements: false
|
|
MayBeConst:
|
|
active: true
|
|
ModifierOrder:
|
|
active: true
|
|
NestedClassesVisibility:
|
|
active: false
|
|
NewLineAtEndOfFile:
|
|
active: true
|
|
NoTabs:
|
|
active: true
|
|
OptionalAbstractKeyword:
|
|
active: true
|
|
OptionalUnit:
|
|
active: false
|
|
OptionalWhenBraces:
|
|
active: false
|
|
ProtectedMemberInFinalClass:
|
|
active: false
|
|
RedundantVisibilityModifierRule:
|
|
active: false
|
|
ReturnCount:
|
|
active: true
|
|
max: 3
|
|
excludedFunctions: "equals"
|
|
SafeCast:
|
|
active: true
|
|
SerialVersionUIDInSerializableClass:
|
|
active: false
|
|
SpacingBetweenPackageAndImports:
|
|
active: true
|
|
ThrowsCount:
|
|
active: true
|
|
max: 2
|
|
TrailingWhitespace:
|
|
active: false
|
|
UnnecessaryAbstractClass:
|
|
active: true
|
|
UnnecessaryInheritance:
|
|
active: false
|
|
UnnecessaryParentheses:
|
|
active: false
|
|
UntilInsteadOfRangeTo:
|
|
active: false
|
|
UnusedImports:
|
|
active: false
|
|
UnusedPrivateMember:
|
|
active: false
|
|
UseDataClass:
|
|
active: false
|
|
excludeAnnotatedClasses: ""
|
|
UtilityClassWithPublicConstructor:
|
|
active: false
|
|
WildcardImport:
|
|
active: true
|
|
excludes: "**/*Test.kt, **/*Spec.kt, **/test/**, **/androidTest/**"
|
|
excludeImports: 'java.util.*,kotlinx.android.synthetic.*'
|