You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by GitBox <gi...@apache.org> on 2022/03/23 09:20:23 UTC

[GitHub] [spark] LuciferYang opened a new pull request #35949: [DONT MERGE] Enable `ImportOrder` check of Java code

LuciferYang opened a new pull request #35949:
URL: https://github.com/apache/spark/pull/35949


   <!--
   Thanks for sending a pull request!  Here are some tips for you:
     1. If this is your first time, please read our contributor guidelines: https://spark.apache.org/contributing.html
     2. Ensure you have added or run the appropriate tests for your PR: https://spark.apache.org/developer-tools.html
     3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][SPARK-XXXX] Your PR title ...'.
     4. Be sure to keep the PR description updated to reflect all changes.
     5. Please write your PR title to summarize what this PR proposes.
     6. If possible, provide a concise example to reproduce the issue for a faster review.
     7. If you want to add a new configuration, please read the guideline first for naming configurations in
        'core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala'.
     8. If you want to add or modify an error type or message, please read the guideline first in
        'core/src/main/resources/error/README.md'.
   -->
   
   ### What changes were proposed in this pull request?
   <!--
   Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue. 
   If possible, please consider writing useful notes for better and faster reviews in your PR. See the examples below.
     1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
     2. If you fix some SQL features, you can provide some references of other DBMSes.
     3. If there is design documentation, please add the link.
     4. If there is a discussion in the mailing list, please add the link.
   -->
   
   
   ### Why are the changes needed?
   <!--
   Please clarify why the changes are needed. For instance,
     1. If you propose a new API, clarify the use case for a new API.
     2. If you fix a bug, you can clarify why it is a bug.
   -->
   
   
   ### Does this PR introduce _any_ user-facing change?
   <!--
   Note that it means *any* user-facing change including all aspects such as the documentation fix.
   If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible.
   If possible, please also clarify if this is a user-facing change compared to the released Spark versions or within the unreleased branches such as master.
   If no, write 'No'.
   -->
   
   
   ### How was this patch tested?
   <!--
   If tests were added, say they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
   If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
   If tests were not added, please describe why they were not added and/or why it was difficult to add.
   If benchmark tests were added, please run the benchmarks in GitHub Actions for the consistent environment, and the instructions could accord to: https://spark.apache.org/developer-tools.html#github-workflow-benchmarks.
   -->
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] LuciferYang edited a comment on pull request #35949: [DONT MERGE] Enabled `ImportOrder` check of Java code

Posted by GitBox <gi...@apache.org>.
LuciferYang edited a comment on pull request #35949:
URL: https://github.com/apache/spark/pull/35949#issuecomment-1076152386


   The example of following the `ImportOrder` check rule:
   
   ```java
   import java.io.IOException;
   import java.nio.ByteBuffer;
   
   
   import scala.Tuple2;
   
   import com.google.common.collect.ImmutableMap;
   import com.google.common.collect.Sets;
   
   import org.apache.spark.network.buffer.ManagedBuffer;
   import org.apache.spark.network.buffer.NioManagedBuffer;
   
   import static org.apache.spark.network.shuffle.RetryingBlockTransferor.BlockTransferStarter;
   import static org.junit.Assert.*;
   import static org.mockito.Mockito.*;
   ```
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] LuciferYang commented on pull request #35949: [DONT MERGE] Enabled `ImportOrder` check of Java code

Posted by GitBox <gi...@apache.org>.
LuciferYang commented on pull request #35949:
URL: https://github.com/apache/spark/pull/35949#issuecomment-1076450821


   So should we remove this `TODO`, It seems unlikely to have a chance to finish it ...
   
    


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] LuciferYang commented on pull request #35949: [DONT MERGE] Enabled `ImportOrder` check of Java code

Posted by GitBox <gi...@apache.org>.
LuciferYang commented on pull request #35949:
URL: https://github.com/apache/spark/pull/35949#issuecomment-1076148330


   The `ImportOrder` check of Java is disabled now and there is a TODO:
   
   https://github.com/apache/spark/blob/4817b0189a1d3f37db784e62b1d8c6e3aef6921d/dev/checkstyle.xml#L156-L163
   
   I try to re-enable it and change the rule as follows:
   
   ```xml
        <module name="ImportOrder">
               <!-- simple imports -->
               <property name="separated" value="true"/>
               <property name="ordered" value="true"/>
               <property name="groups" value="/^javax?\./,scala,*,org.apache.spark"/>
               <!-- static imports -->
               <property name="option" value="bottom"/>
               <property name="staticGroups" value=""/>
               <property name="sortStaticImportsAlphabetically" value="true"/>
               <property name="separatedStaticGroups" value="true"/>
           </module>
   ```
   
   The `no-static imports` is consistent with scala code, the `static imports`  is an independent group after `no-static imports`, and it sorted by alphabetically.
   
   @srowen @dongjoon-hyun @HyukjinKwon I wonder if we need to complete this TODO ?
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] LuciferYang commented on pull request #35949: [DONT MERGE] Enabled `ImportOrder` check of Java code

Posted by GitBox <gi...@apache.org>.
LuciferYang commented on pull request #35949:
URL: https://github.com/apache/spark/pull/35949#issuecomment-1076362880


   @srowen for `static imports`, would you mind dividing them into separate groups?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] LuciferYang commented on pull request #35949: [DONT MERGE] Enabled `ImportOrder` check of Java code

Posted by GitBox <gi...@apache.org>.
LuciferYang commented on pull request #35949:
URL: https://github.com/apache/spark/pull/35949#issuecomment-1076455165


   > We could, I also don't care much about the TODO statement either
   
   ok


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] LuciferYang commented on pull request #35949: [DONT MERGE] Enabled `ImportOrder` check of Java code

Posted by GitBox <gi...@apache.org>.
LuciferYang commented on pull request #35949:
URL: https://github.com/apache/spark/pull/35949#issuecomment-1076350536


   So we can accept a weak rule similar to the following: imports are grouped and interior of each group can be disordered ?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] srowen commented on pull request #35949: [DONT MERGE] Enabled `ImportOrder` check of Java code

Posted by GitBox <gi...@apache.org>.
srowen commented on pull request #35949:
URL: https://github.com/apache/spark/pull/35949#issuecomment-1076332674


   I think this is mostly too much noise to bother with. Most imports are nearly-correctly-ordered and it matters little anyway. If there is a weaker check we can enforce (e.g. are imports grouped, if not ordered, correctly) that might be OK to try to enforce


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] LuciferYang edited a comment on pull request #35949: [DONT MERGE] Enabled `ImportOrder` check of Java code

Posted by GitBox <gi...@apache.org>.
LuciferYang edited a comment on pull request #35949:
URL: https://github.com/apache/spark/pull/35949#issuecomment-1076362880


   @srowen for `static imports`, would you mind dividing them into a separate groups?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] srowen commented on pull request #35949: [DONT MERGE] Enabled `ImportOrder` check of Java code

Posted by GitBox <gi...@apache.org>.
srowen commented on pull request #35949:
URL: https://github.com/apache/spark/pull/35949#issuecomment-1076453791


   We could, I also don't care much about the TODO statement either


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] LuciferYang commented on pull request #35949: [DONT MERGE] Enabled `ImportOrder` check of Java code

Posted by GitBox <gi...@apache.org>.
LuciferYang commented on pull request #35949:
URL: https://github.com/apache/spark/pull/35949#issuecomment-1076359608


   Set `order` to `false` can ignore the order check
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] LuciferYang commented on pull request #35949: [DONT MERGE] Enabled `ImportOrder` check of Java code

Posted by GitBox <gi...@apache.org>.
LuciferYang commented on pull request #35949:
URL: https://github.com/apache/spark/pull/35949#issuecomment-1076152386


   The example of following the `ImportOrder` check rule:
   
   ```java
   import java.io.IOException;
   import java.nio.ByteBuffer;
   import java.util.Arrays;
   import java.util.LinkedHashSet;
   import java.util.List;
   import java.util.Map;
   
   import com.google.common.collect.ImmutableMap;
   import com.google.common.collect.Sets;
   import org.junit.Test;
   import org.mockito.stubbing.Answer;
   import org.mockito.stubbing.Stubber;
   
   import org.apache.spark.network.buffer.ManagedBuffer;
   import org.apache.spark.network.buffer.NioManagedBuffer;
   import org.apache.spark.network.util.MapConfigProvider;
   import org.apache.spark.network.util.TransportConf;
   
   import static org.apache.spark.network.shuffle.RetryingBlockTransferor.BlockTransferStarter;
   import static org.junit.Assert.*;
   import static org.mockito.Mockito.*;
   ```
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] LuciferYang commented on pull request #35949: [DONT MERGE] Enabled `ImportOrder` check of Java code

Posted by GitBox <gi...@apache.org>.
LuciferYang commented on pull request #35949:
URL: https://github.com/apache/spark/pull/35949#issuecomment-1076381525


   > So we can accept a weak rule similar to the following: imports are grouped and interior of each group can be disordered ?
   
   If this, still 180 files need to be changed :(
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] srowen commented on pull request #35949: [DONT MERGE] Enabled `ImportOrder` check of Java code

Posted by GitBox <gi...@apache.org>.
srowen commented on pull request #35949:
URL: https://github.com/apache/spark/pull/35949#issuecomment-1076405660


   I see, it's still a big change then. I'm not sure it's worth it.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] LuciferYang closed pull request #35949: [DONT MERGE] Enabled `ImportOrder` check of Java code

Posted by GitBox <gi...@apache.org>.
LuciferYang closed pull request #35949:
URL: https://github.com/apache/spark/pull/35949


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org