saveourtool/diktat

`MAGIC_NUMBER` false positive when `Long` constants are used together with `kotlin.time.Duration` extensions

Open

#1,934 opened on Jun 19, 2024

View on GitHubContributor guide
 (5 comments) (0 reactions) (0 assignees)Kotlin (40 forks)github user discovery
buggood first issue

Repository metrics

Stars
 (571 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Describe the bug

The following constant declarations trigger the MAGIC_NUMBER false positive:

import kotlin.time.Duration.Companion.minutes
import kotlin.time.Duration.Companion.seconds

val fooTimeout = 10L.seconds

val barTimeout = 10L.minutes

Environment information

  • diktat version: 2.0.0
  • build tool: Maven
  • how is diktat run: plugin
  • kotlin version: 1.7.22
  • operating system: Any

Contributor guide

Research direction
Investigate how the MAGIC NUMBER rule checks for magic numbers and why it fails to ignore Long constants when they are followed by an extension on Duration. Look at the rule's AST visitor and how it handles property initializers with chained calls like '10L.seconds'.
Tech stack
kotlin
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Kotlinstatic analysis
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40