From dev-return-10779-archive-asf-public=cust-asf.ponee.io@arrow.apache.org Sat Mar 2 20:09:23 2019 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx-eu-01.ponee.io (Postfix) with SMTP id C87A418064A for ; Sat, 2 Mar 2019 21:09:22 +0100 (CET) Received: (qmail 7385 invoked by uid 500); 2 Mar 2019 20:09:21 -0000 Mailing-List: contact dev-help@arrow.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@arrow.apache.org Delivered-To: mailing list dev@arrow.apache.org Received: (qmail 7373 invoked by uid 99); 2 Mar 2019 20:09:20 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd1-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 02 Mar 2019 20:09:20 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd1-us-west.apache.org (ASF Mail Server at spamd1-us-west.apache.org) with ESMTP id 73A68CA5E5 for ; Sat, 2 Mar 2019 20:09:20 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd1-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: 1.799 X-Spam-Level: * X-Spam-Status: No, score=1.799 tagged_above=-999 required=6.31 tests=[DKIMWL_WL_MED=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, HTML_MESSAGE=2, RCVD_IN_DNSWL_NONE=-0.0001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=disabled Authentication-Results: spamd1-us-west.apache.org (amavisd-new); dkim=pass (2048-bit key) header.d=gmail.com Received: from mx1-lw-us.apache.org ([10.40.0.8]) by localhost (spamd1-us-west.apache.org [10.40.0.7]) (amavisd-new, port 10024) with ESMTP id Wc-JPicZuxsE for ; Sat, 2 Mar 2019 20:09:18 +0000 (UTC) Received: from mail-ua1-f51.google.com (mail-ua1-f51.google.com [209.85.222.51]) by mx1-lw-us.apache.org (ASF Mail Server at mx1-lw-us.apache.org) with ESMTPS id 92C725F1C7 for ; Sat, 2 Mar 2019 20:09:18 +0000 (UTC) Received: by mail-ua1-f51.google.com with SMTP id j8so1019482uae.13 for ; Sat, 02 Mar 2019 12:09:18 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:references:in-reply-to:reply-to:from:date:message-id :subject:to:cc; bh=TwVnrTeiFWHWXrYwthku61PeFOHXkx1cnfQtk4PqDwE=; b=t5JXX8CGmPR6pYkkV7SBtBlJ8Ohjlm7Q26kgGw1i0sSKkWu3VcKuWxYUeJmdc4zr9u vJD9SWkb5hEqtn6Cvq/VSBKpL2JwQauXZBp3FyOjKz/pj0rMtMwaKexsd36AVATLFvu+ vPnvpGkTNRo9FeSi+9Moe4K1BZcgk3hIesTNsLVcDa1YUJCEmeBm1gHudbXRg5Ojr/Yf qpoyDFRkuR4DpQ7RxiKQ14SaRGM6rrXltppPkTwAIatj176sIprxn4JsuviGK1HU957e flVw3k1vpkjrlrEpwE1IcUDfJiHrtW38HLQ1dXwYoLTDT9oMV649Yiwziclaa5H7La+V L4JA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:reply-to :from:date:message-id:subject:to:cc; bh=TwVnrTeiFWHWXrYwthku61PeFOHXkx1cnfQtk4PqDwE=; b=WEIf7PMlDbOYKcFLYQ6fya2ScexYzEWmO91Dx9b12zQmWyXm1CmwEW3pZmu2vnQ6GX la9MLjb6na7LxNJh3CJBzjLanX40SZobrCrxMYEYBx6qJC7I5zuRlyZrxclSAolMawHJ Xe+WseoflWsJgU6q4/sXassTVChtap2DZXAuo0sc3xhts86QP+rMBgEL1ikSllYmqLmc ysHsIEz7b04ucDYbv6aCQb0/A6KEdb15ks8HTU4lfXO4JiM8BYi/1w2ytQIAqngGEWx3 VKMIEhajkARn2neruPjPFL1D+A0cymHIMWaVl/z6NtKNGz7jYX2tj/xxb1KZRYuSRYnX bMxw== X-Gm-Message-State: APjAAAWvkXXtozzmbmPpsRkAEMriEYsBHSmTh8AfpPDiiUke/kZd7DsW Kf6ZmDvtz5YSIMjN3uLeoDvmh2If5GGlFFgyuHk= X-Google-Smtp-Source: APXvYqy4/VRJ2jseOgagaSXQZlbKzdW6/x8OdItSIMVbcCMsqqZ5K+1zvmuI5lRUndUu1uQeZM6LJjcylX0IAFRcVhw= X-Received: by 2002:a67:2ed1:: with SMTP id u200mr5524664vsu.167.1551557357825; Sat, 02 Mar 2019 12:09:17 -0800 (PST) MIME-Version: 1.0 References: In-Reply-To: Reply-To: emkornfield@gmail.com From: Micah Kornfield Date: Sat, 2 Mar 2019 12:09:07 -0800 Message-ID: Subject: Re: [Discuss][Java] Codebase Housekeeping? To: Bryan Cutler Cc: dev@arrow.apache.org, Praveen Kumar Content-Type: multipart/alternative; boundary="00000000000029769e05832219f0" --00000000000029769e05832219f0 Content-Type: text/plain; charset="UTF-8" I created issues for 1,2 and 4. For #3 (Intellij hints/warnings), I'm not sure there is a good way to enforce this, so a one time cleanup could be helpful, but fear it going stale. Thanks, Micah On Wed, Feb 27, 2019 at 1:16 PM Bryan Cutler wrote: > These all sound good to me Micah, thanks for taking this on! Regarding > the javadoc codestyle in (2), I believe it was disabled because there were > just too many issues of missing docs at the time. Any documentation > additions are definitely welcome and hopefully we can eventually enable the > check :) > > Thanks, > Bryan > > On Tue, Feb 26, 2019 at 10:17 PM Micah Kornfield > wrote: > >> SGTM, I probably start filing JIRAs on Friday if no objections arise. >> >> On Tue, Feb 26, 2019 at 12:25 AM Praveen Kumar >> wrote: >> >> > Hi Micah, >> > >> > Thanks for bringing this up. >> > >> > I am +1 for all of them. Especially the lack of documentation in the the >> > classes is a little hard - i found myself checking documentation of >> > corresponding C++ classes to understand format initially. >> > >> > Lets wait a couple of days for more feedback and create actionable JIRAs >> > for the same? >> > >> > Thx. >> > >> > On Tue, Feb 26, 2019 at 11:34 AM Micah Kornfield > > >> > wrote: >> > >> >> Hi Java Arrow-Developers, >> >> I've been looking more into the java code base and I was wondering if >> >> people think any of the following might be worthwhile (or are strictly >> >> against them). My java infrastructure knowledge is a little stale, so >> if >> >> a >> >> suggestion I make is absolutely ridiculous I apologize. >> >> >> >> 1. Upgrade to JUnit 5 (the main advantage I know if is it has much >> >> cleaner >> >> syntax for asserts with Java8) [1] >> >> 2. Try to get a state where we can enforce with Checkstyle that at >> least >> >> every class has a javadoc comment? >> >> 3. Try to get the code to state where it shows no warnings in >> IntelliJ. >> >> At least in the Vector classes there seem to at least be warning about >> >> possibly making some methods/classes have more restricted visibility, I >> >> don't know if this due to insufficient test coverage or if they are >> >> legitimate. If it is the former, is there someplace we can pull in >> more >> >> tests to exercise the code? >> >> 4. Setup static type checking assuming NonNull values and annotate >> where >> >> values can be null (based on limited research [2][3][4] the checker >> >> framework might have the right set of annotations to use >> >> >> >> Thanks, >> >> Micah >> >> >> >> >> >> >> >> [1] >> >> >> >> >> https://stackoverflow.com/questions/40268446/junit-5-how-to-assert-an-exception-is-thrown >> >> [2] https://github.com/google/guava/issues/3031 >> >> [3] https://github.com/google/guava/issues/2960 >> >> [4] >> >> >> >> >> https://stackoverflow.com/questions/4963300/which-notnull-java-annotation-should-i-use >> >> >> > >> > --00000000000029769e05832219f0--