[jira] [Created] (YARN-10270) TODO comments exist in trunk while the related issues are already fixed.

["Rungroj Maipradit (Jira)" <ji...@apache.org>]

Rungroj Maipradit created YARN-10270:
----------------------------------------

             Summary: TODO comments exist in trunk while the related issues are already fixed.
                 Key: YARN-10270
                 URL: https://issues.apache.org/jira/browse/YARN-10270
             Project: Hadoop YARN
          Issue Type: Improvement
            Reporter: Rungroj Maipradit


In a research project, we analyzed the source code of Hadoop looking for comments with on-hold SATDs (self-admitted technical debt) that could be fixed already. An on-hold SATD is a TODO/FIXME comment blocked by an issue. If this blocking issue is already resolved, the related todo can be implemented (or sometimes it is already implemented, but the comment is left in the code causing confusions). As we found a few instances of these in YARN, we decided to collect them in a ticket, so they are documented and can be addressed sooner or later.

A list of code comments that mention already closed issues.

* A code comment recommends rewriting the mergeSkyline method once YARN-5328 is committed. The current message still exists in trunk while the resolution of YARN-5328 is fixed.
{code:java}
// TODO:
// rewrite this function with shift and merge once YARN-5328 is committed
/** First, getHistory the pipeline submission time. */
{code}
Comment location: https://github.com/apache/hadoop/blob/trunk/hadoop-tools/hadoop-resourceestimator/src/main/java/org/apache/hadoop/resourceestimator/solver/preprocess/SolverPreprocessor.java#L137

* A code comment mentions a temporary fix for NM callback and refers to YARN-8265. YARN-8265 is already closed, but a comment says that the feature will be implemented in YARN-8286. (https://issues.apache.org/jira/browse/YARN-8265?focusedCommentId=16473105&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-16473105). YARN-8286 could be referenced in the source code comment.
{code:java}
// A docker container might get a different IP if the container is
// relaunched by the NM, so we need to keep checking the status.
// This is a temporary fix until the NM provides a callback for
// container relaunch (see YARN-8265).
{code}
Comment location: https://github.com/apache/hadoop/blob/trunk/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-services/hadoop-yarn-services-core/src/main/java/org/apache/hadoop/yarn/service/component/instance/ComponentInstance.java#L684

* The code comment suggests revisiting the AMRMProxyService.initializePipeline method in YARN-6128, but YARN-6128 is already fixed. The comment was added in a commit message referencing YARN-6127 (https://github.com/apache/hadoop/commit/49aa60e50d20f8c18ed6f00fa8966244536fe7da). It seems that this part of the code remained untouched in the commit related to YARN-6128 (https://github.com/apache/hadoop/commit/d5f66888b8d767ee6706fab9950c194a1bf26d32).
{code:java}
// TODO: revisit in AMRMProxy HA in YARN-6128
// Remove the existing pipeline
{code}
Comment location: https://github.com/apache/hadoop/blob/trunk/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/amrmproxy/AMRMProxyService.java#L463




--
This message was sent by Atlassian Jira
(v8.3.4#803005)

---------------------------------------------------------------------
To unsubscribe, e-mail: yarn-dev-unsubscribe@hadoop.apache.org
For additional commands, e-mail: yarn-dev-help@hadoop.apache.org