issue
dict | pr
dict | pr_details
dict |
|---|---|---|
{
"body": "The html-proofer that is included in Travis build indicates that we have some broken links.\r\n\r\n```shell\r\nRunning [\"HtmlCheck\", \"ImageCheck\", \"ScriptCheck\", \"LinkCheck\"] on [\"./_site/\"] on *.html... \r\nChecking 391 external links...\r\nRan on 133 files!\r\n- ./_site/patterns/acyclic-visitor/index.html\r\n * internally linking to ../visitor/README.md, which does not exist (line 1)\r\n- ./_site/patterns/half-sync-half-async/index.html\r\n * External link http://www.cs.wustl.edu/~schmidt/PDF/PLoP-95.pdf failed: 404 No error\r\n- ./_site/patterns/intercepting-filter/index.html\r\n * External link http://www.javagyan.com/tutorials/corej2eepatterns/presentation-tier-patterns failed: 403 No error\r\n * External link https://struts.apache.org/docs/interceptors.html failed: 404 No error\r\nhtmlproofer 3.0.6 | Error: HTML-Proofer found 4 failures!\r\nThe command \"bash cibuild.sh\" exited with 1.\r\n```\r\n\r\nSee full log at https://travis-ci.org/iluwatar/java-design-patterns/builds/565304449",
"comments": [
{
"body": "@iluwatar , \r\nHi, can I look at this change? ",
"created_at": "2019-09-05T11:36:33Z"
},
{
"body": "Yes @snehalatapandit ",
"created_at": "2019-09-05T19:24:15Z"
},
{
"body": "Hi @iluwatar, it seems this is again failing for different link\r\nhttps://travis-ci.org/iluwatar/java-design-patterns/builds/583292258\r\nIn https://github.com/iluwatar/java-design-patterns/tree/master/partial-response credit section we are providing link for Partial Response in RESTful API Design and its respective URL is no more active and gives Page Not found error, hence Automagic is also failing\r\n\r\nDo let me know if I can take this up ?",
"created_at": "2019-09-19T18:59:36Z"
},
{
"body": "Please go ahead @hbothra15 ",
"created_at": "2019-09-20T05:11:14Z"
},
{
"body": "Done, and created a PR for the same",
"created_at": "2019-09-20T19:59:25Z"
}
],
"number": 915,
"title": "Fix broken links"
} | {
"body": "Pull request title :\r\nFix broken links\r\n#915\r\n\r\nPull request description : \r\n1. Changed the link of BSD Unix networking subsystem (In Real world examples and Credits in half-sync-half-async/README.md)\r\n2. Changed the link of Struts 2 - Interceptors (In intercepting-filter/README.md)\r\n3. Removed the credits of Presentation Tier Patterns from Javagyan tutorial as Javagyan does not seem to be available now.\r\n",
"number": 921,
"review_comments": [],
"title": "Fix broken links #915"
} | {
"commits": [
{
"message": "Fix broken links #915"
}
],
"files": [
{
"diff": "@@ -27,11 +27,11 @@ Use Half-Sync/Half-Async pattern when\n \n ## Real world examples\n \n-* [BSD Unix networking subsystem](http://www.cs.wustl.edu/~schmidt/PDF/PLoP-95.pdf)\n+* [BSD Unix networking subsystem](https://www.dre.vanderbilt.edu/~schmidt/PDF/PLoP-95.pdf)\n * [Real Time CORBA](http://www.omg.org/news/meetings/workshops/presentations/realtime2001/4-3_Pyarali_thread-pool.pdf)\n * [Android AsyncTask framework](http://developer.android.com/reference/android/os/AsyncTask.html)\n \n ## Credits\n \n-* [Douglas C. Schmidt and Charles D. Cranor - Half Sync/Half Async](http://www.cs.wustl.edu/~schmidt/PDF/PLoP-95.pdf)\n+* [Douglas C. Schmidt and Charles D. Cranor - Half Sync/Half Async](https://www.dre.vanderbilt.edu/~schmidt/PDF/PLoP-95.pdf)\n * [Pattern Oriented Software Architecture Vol I-V](http://www.amazon.com/Pattern-Oriented-Software-Architecture-Volume-Patterns/dp/0471958697)",
"filename": "half-sync-half-async/README.md",
"status": "modified"
},
{
"diff": "@@ -30,9 +30,8 @@ Use the Intercepting Filter pattern when\n ## Real world examples\n \n * [javax.servlet.FilterChain](https://tomcat.apache.org/tomcat-8.0-doc/servletapi/javax/servlet/FilterChain.html) and [javax.servlet.Filter](https://tomcat.apache.org/tomcat-8.0-doc/servletapi/javax/servlet/Filter.html)\n-* [Struts 2 - Interceptors](https://struts.apache.org/docs/interceptors.html)\n+* [Struts 2 - Interceptors](https://struts.apache.org/core-developers/interceptors.html)\n \n ## Credits\n \n * [TutorialsPoint - Intercepting Filter](http://www.tutorialspoint.com/design_pattern/intercepting_filter_pattern.htm)\n-* [Presentation Tier Patterns](http://www.javagyan.com/tutorials/corej2eepatterns/presentation-tier-patterns)",
"filename": "intercepting-filter/README.md",
"status": "modified"
}
]
} |
{
"body": "https://github.com/iluwatar/java-design-patterns/blob/987994f0fe5747e5524bc43c3b2000bee478c0c3/singleton/src/main/java/com/iluwatar/singleton/ThreadSafeDoubleCheckLocking.java#L43-L45\r\nInstance will be null, and you can create a singleton object by reflection without an exception. ",
"comments": [
{
"body": "Yes, that is true. But I think that is the way the code is supposed to work. It allows creating one and only one instance, right?",
"created_at": "2018-07-07T05:52:32Z"
},
{
"body": "Actually you can create another instance via `ThreadSafeDoubleCheckLocking.getInstance()`, or as many instances as possible via reflection.",
"created_at": "2018-07-07T06:09:05Z"
},
{
"body": "Can someone verify this?",
"created_at": "2018-07-19T18:19:55Z"
},
{
"body": "@iluwatar Sure. I will have a look at it.",
"created_at": "2018-08-15T14:34:02Z"
},
{
"body": "I tried testing this and it is still possible to create multiple instances if only using reflection. I saw this solution on StackOverflow which will not allow reflection to access private methods and it worked for me.\r\n\r\nSo I made this change:\r\n\r\nprivate ThreadSafeDoubleCheckLocking() {\r\n // to prevent instantiating by Reflection call\r\n\t checkPermission();\r\n if (instance != null) {\r\n throw new IllegalStateException(\"Already initialized.\");\r\n }\r\n numOfInstances++;\r\n }\r\n \r\n void checkPermission() {\r\n Class self = sun.reflect.Reflection.getCallerClass(1);\r\n Class caller = sun.reflect.Reflection.getCallerClass(3);\r\n if (self != caller) {\r\n throw new java.lang.IllegalAccessError();\r\n }\r\n }\r\n\r\nI would really appreciate feedback. ",
"created_at": "2018-09-29T11:22:42Z"
},
{
"body": "I think we can create multiple instances of a singleton class only in case of lazy initialization as in the above example.\r\nIf we change that to eager initialization, this check will be sufficient to create multiple instances of this class.",
"created_at": "2018-09-29T11:48:36Z"
},
{
"body": "Using sun.reflect.Reflection is not recommended and I don't really understand why it is able to create multiple instances inspite of what you have done in the constructor to try to avoid it, but this is something that can be done. Using reflection is not allowed on Google App Engine, I just saw, so maybe people are working around the security threat in that way. I found this solution here btw, forgot to mention in the previous comment: https://stackoverflow.com/questions/7566626/how-to-restrict-developers-to-use-reflection-to-access-private-methods-and-const",
"created_at": "2018-09-29T14:24:25Z"
},
{
"body": "@iluwatar May I pick this up?",
"created_at": "2019-09-05T01:41:11Z"
},
{
"body": "@Azureyjt please go ahead",
"created_at": "2019-09-05T04:15:22Z"
},
{
"body": "PR created. Please kindly review it :) @iluwatar ",
"created_at": "2019-09-05T06:04:47Z"
}
],
"number": 761,
"title": "ThreadSafeDoubleCheckLocking.java: Instantiating by Reflection call will be successful if you do that firstly"
} | {
"body": "This PR solves issue #761 \r\n\r\n- Add a flag to record whether the constructor is invoked for the first time. If not, throw corresponding exception.\r\n- Add test case to test creating new instance by reflection.",
"number": 920,
"review_comments": [],
"title": "Fix issue #761"
} | {
"commits": [
{
"message": "Fix issue #761: ThreadSafeDoubleCheckLocking.java: Instantiating by Reflection call will be successful if you do that firstly"
}
],
"files": [
{
"diff": "@@ -38,5 +38,9 @@\n <artifactId>junit-jupiter-engine</artifactId>\n <scope>test</scope>\n </dependency>\n+ <dependency>\n+ <groupId>junit</groupId>\n+ <artifactId>junit</artifactId>\n+ </dependency>\n </dependencies>\n </project>",
"filename": "singleton/pom.xml",
"status": "modified"
},
{
"diff": "@@ -35,12 +35,16 @@ public final class ThreadSafeDoubleCheckLocking {\n \n private static volatile ThreadSafeDoubleCheckLocking instance;\n \n+ private static boolean flag = true;\n+\n /**\n * private constructor to prevent client from instantiating.\n */\n private ThreadSafeDoubleCheckLocking() {\n // to prevent instantiating by Reflection call\n- if (instance != null) {\n+ if (flag) {\n+ flag = false;\n+ } else {\n throw new IllegalStateException(\"Already initialized.\");\n }\n }",
"filename": "singleton/src/main/java/com/iluwatar/singleton/ThreadSafeDoubleCheckLocking.java",
"status": "modified"
},
{
"diff": "@@ -22,6 +22,11 @@\n */\n package com.iluwatar.singleton;\n \n+import org.junit.Test;\n+\n+import java.lang.reflect.Constructor;\n+import java.lang.reflect.InvocationTargetException;\n+\n /**\n * Date: 12/29/15 - 19:26 PM\n *\n@@ -36,4 +41,15 @@ public ThreadSafeDoubleCheckLockingTest() {\n super(ThreadSafeDoubleCheckLocking::getInstance);\n }\n \n+ /**\n+ * Test creating new instance by refection\n+ */\n+ @Test(expected = InvocationTargetException.class)\n+ public void testCreatingNewInstanceByRefection() throws Exception {\n+ ThreadSafeDoubleCheckLocking instance1 = ThreadSafeDoubleCheckLocking.getInstance();\n+ Constructor constructor = ThreadSafeDoubleCheckLocking.class.getDeclaredConstructor();\n+ constructor.setAccessible(true);\n+ ThreadSafeDoubleCheckLocking instance2 = (ThreadSafeDoubleCheckLocking) constructor.newInstance(null);\n+ }\n+\n }\n\\ No newline at end of file",
"filename": "singleton/src/test/java/com/iluwatar/singleton/ThreadSafeDoubleCheckLockingTest.java",
"status": "modified"
}
]
} |
{
"body": "See log https://travis-ci.org/iluwatar/java-design-patterns/builds/564609653\r\n\r\nThe problem seems to be related to s3_website and Java version",
"comments": [
{
"body": "I made a PR to take care of the Java issue, but a bunch of other errors came up with SSL errors in the HTML-Proofer and \"Access key can't be null\" errors in the s3_website push. I'll have to look into that.",
"created_at": "2019-07-29T22:02:33Z"
},
{
"body": "There's more information about the web site update at https://github.com/iluwatar/java-design-patterns/wiki/07.-Working-with-the-web-site",
"created_at": "2019-07-30T04:57:08Z"
},
{
"body": "@ptrax I merged the PR and it seems that the web site update system now works. See https://java-design-patterns.com it has the deployed commit information on the bottom of the screen. The access keys you mentioned are defined in the `secure` fields of [.travis.yml](https://github.com/iluwatar/java-design-patterns/blob/gh-pages/.travis.yml)",
"created_at": "2019-07-30T05:02:31Z"
},
{
"body": "Thanks @iluwatar, I had just realized a few minutes ago that the access tokens weren't working since the PR came from my fork which didn't have access to those secure environment variables. Figured a post-merge build would work!",
"created_at": "2019-07-30T05:04:12Z"
},
{
"body": "Well done for fixing this, much appreciated @ptrax :+1: ",
"created_at": "2019-07-30T05:09:25Z"
}
],
"number": 912,
"title": "Web site update failing"
} | {
"body": "- This PR makes Travis CI use Java 8, which requires the Trusty build environment. \r\n- Refer to the issue #912 \r\n\r\nThis comes from a known issue with the S3_website repo, which is not actively maintained. It seems to not support anything higher than Java 8, which makes the gh-pages build fail when Travis CI tries to use Java 11. \r\n\r\n",
"number": 913,
"review_comments": [],
"title": "Change Travis CI to use Java 8 for S3_website "
} | {
"commits": [
{
"message": "Changed Travis CI to Trusty Build Env and Java 8"
},
{
"message": "Updating curl"
},
{
"message": "Changed to Bionic"
},
{
"message": "Package update for libcurl"
}
],
"files": [
{
"diff": "@@ -1,3 +1,4 @@\n+dist: trusty # Xenial build environment won't allow installation of Java 8\n env:\n global:\n - NOKOGIRI_USE_SYSTEM_LIBRARIES=true # speeds up installation of html-proofer\n@@ -7,8 +8,20 @@ env:\n language: ruby\n rvm:\n - 2.2.0\n+jdk:\n+- oraclejdk8\n \n+before_install:\n+ - sudo apt-get update\n+ - sudo apt-get install -y curl libcurl4-openssl-dev\n+ \n install: bundle install --jobs=3 --retry=3\n+\n+addons:\n+ apt:\n+ packages:\n+ - oracle-java8-installer\n+ \n script: bash cibuild.sh\n after_script: if [ \"$TRAVIS_BRANCH\" == \"gh-pages\" ]; then travis_retry bundle exec s3_website push; fi\n ",
"filename": ".travis.yml",
"status": "modified"
}
]
} |
{
"body": "Java Design Patterns is analyzed with SonarQube.com static analysis. The analysis shows some blocker level code smells that should be fixed:\n\nhttps://sonarqube.com/component_issues/index?id=com.iluwatar%3Ajava-design-patterns#resolved=false|severities=BLOCKER|types=CODE_SMELL\n",
"comments": [
{
"body": "I will take care of this.\n",
"created_at": "2016-10-26T13:52:23Z"
},
{
"body": "Thank you @sangupta you're good to go!\n",
"created_at": "2016-10-27T16:21:33Z"
},
{
"body": "@sangupta are you still working on this?",
"created_at": "2017-02-11T23:29:14Z"
},
{
"body": "@iluwatar Am sorry - have been pressed for time lately. Will have sometime in March - when I should be able to lend a helping hand.\r\n",
"created_at": "2017-02-12T12:55:30Z"
},
{
"body": "@iluwatar I can pick this if no one else is looking at it, to start with I could begin with dao. Is it okay?",
"created_at": "2017-05-02T15:16:31Z"
},
{
"body": "@Praveer-grover this is ok, please go ahead.",
"created_at": "2017-05-07T08:24:35Z"
},
{
"body": "Updated sonarqube url\r\nhttps://sonarcloud.io/project/issues?id=com.iluwatar%3Ajava-design-patterns&resolved=false&severities=BLOCKER&types=CODE_SMELL\r\n\r\n@Praveer-grover Are you still working on these issues? Let me know if you want me to share some modules?\r\n",
"created_at": "2017-09-18T13:57:51Z"
},
{
"body": "Ping @Praveer-grover ",
"created_at": "2017-09-19T05:52:13Z"
},
{
"body": "@mookkiah Are you planning to completely work on this ticket or you need a helping hand? ;)",
"created_at": "2017-09-21T10:51:43Z"
},
{
"body": "Either way is fine for me. As @Praveer-grover is not responding, I will look at sonarqube reported issues in prototype module (maybe this weekend). @dosdebug, you are welcome to help another module. Please just comment so we don't step on each other.",
"created_at": "2017-09-21T18:55:12Z"
},
{
"body": "@mookkiah I will be working on `dao` and `naked-objects-dom` then.",
"created_at": "2017-09-22T02:26:01Z"
},
{
"body": "Hey @mookkiah and @dosdebug are you guys still working on this?",
"created_at": "2017-12-25T10:28:32Z"
},
{
"body": "I will work on prototype module. ",
"created_at": "2017-12-26T00:17:12Z"
},
{
"body": "@iluwatar No Sir, not working on this.",
"created_at": "2018-01-02T09:48:36Z"
},
{
"body": "Ok @mookkiah I will keep the issue `under construction`",
"created_at": "2018-01-02T17:32:53Z"
},
{
"body": "Note : \r\nThe problem with the `dao` seems to be cause by the fact that SonarQube does not support `@Nested` : SQ currently ignores any `@Nested` classes, in other words it does not verify if there is a test within or not. ",
"created_at": "2018-01-19T11:45:10Z"
},
{
"body": "There are still 4 blockers and 37 criticals. See https://sonarcloud.io/project/issues?id=com.iluwatar%3Ajava-design-patterns&resolved=false&severities=BLOCKER%2CCRITICAL&types=CODE_SMELL. This issue is free for taking, if someone would like to help.",
"created_at": "2018-11-04T18:04:55Z"
},
{
"body": "Hm.... there is something strange here. I just opened one of the `Blockers` : https://sonarcloud.io/project/issues?id=com.iluwatar%3Ajava-design-patterns&open=AVfejjZoPl_GJI-SB0qL&resolved=false&severities=BLOCKER and although the analysis is run on `October 24, 2018, 10:43 PM Version 1.21.0-SNAPSHOT` SonarCloud is displaying outdated source code : from 2 years ago instead of the one fixed in #810....\r\n\r\nOh, actually #810 has been merged on `October 25` : a day later. I guess the analysis does not contain the changes done in #810 ( if I am to trust the timestamps of GitHub and SonarCloud ). I would guess the blockers will be fixed in the next analysis.\r\n\r\nJust my 2c ;)\r\n\r\nPS : This may explain the 4 blockers but the criticals still need to be fixed.",
"created_at": "2018-11-06T13:32:12Z"
},
{
"body": "@iluwatar I will start working on this and raise a PR shortly.",
"created_at": "2018-11-13T10:50:51Z"
},
{
"body": "Ok @IAmPramod ",
"created_at": "2018-11-18T19:31:50Z"
},
{
"body": "@iluwatar Is this available ?",
"created_at": "2019-02-13T08:40:11Z"
},
{
"body": "@IAmPramod Are you still working on this ?",
"created_at": "2019-02-13T09:43:13Z"
},
{
"body": "Hi @iluwatar : Pull request raised for this ",
"created_at": "2019-02-13T10:28:34Z"
}
],
"number": 508,
"title": "SonarQube reports code smells"
} | {
"body": "Fix blocker issues on sonar\r\n\r\nSolves #508 \r\n\r\n- Fix the 4 blocker issues related to : \r\n naked-objects-dom\r\n naked-objects-integtests",
"number": 810,
"review_comments": [
{
"body": "We should use `assertNull(simpleObject.getName())` here.",
"created_at": "2018-10-21T05:08:51Z"
},
{
"body": "Use `assertEquals(name, simpleObject.getName())` here.",
"created_at": "2018-10-21T05:09:52Z"
},
{
"body": "What I feel is, it's good that AssertJ was used for assertions. It makes assertions readable, I was planning to either use Hamcrest or AssertJ in all modules. So I think we should keep assertion as is. And I will raise other issue to discuss assertion options.",
"created_at": "2018-10-22T06:18:50Z"
},
{
"body": "What I feel is, it's good that AssertJ was used for assertions. It makes assertions readable, I was planning to either use Hamcrest or AssertJ in all modules. So I think we should keep assertion as is. And I will raise other issue to discuss assertion options.",
"created_at": "2018-10-22T06:19:49Z"
},
{
"body": "What I feel is, it's good that AssertJ was used for assertions. It makes assertions readable, I was planning to either use Hamcrest or AssertJ in all modules. So I think we should keep assertion as is. And I will raise other issue to discuss assertion options.",
"created_at": "2018-10-22T06:21:36Z"
},
{
"body": "What I feel is, it's good that AssertJ was used for assertions. It makes assertions readable, I was planning to either use Hamcrest or AssertJ in all modules. So I think we should keep assertion as is. And I will raise other issue to discuss assertion options.",
"created_at": "2018-10-22T06:22:16Z"
}
],
"title": "Fix blocker issues on Sonar #508"
} | {
"commits": [
{
"message": "Fix blocker issues on Sonar"
},
{
"message": "Replace Assertj assertions with JUnit ones"
}
],
"files": [
{
"diff": "@@ -14,7 +14,8 @@\n */\n package domainapp.dom.modules.simple;\n \n-import static org.assertj.core.api.Assertions.assertThat;\n+import static org.junit.Assert.assertEquals;\n+import static org.junit.Assert.assertNull;\n \n import org.junit.Before;\n import org.junit.Test;\n@@ -30,24 +31,18 @@ public class SimpleObjectTest {\n public void setUp() throws Exception {\n simpleObject = new SimpleObject();\n }\n-\n- /**\n- * Test for Names for SimpleObjects\n- */\n- public static class Name extends SimpleObjectTest {\n-\n- @Test\n- public void happyCase() throws Exception {\n- // given\n- String name = \"Foobar\";\n- assertThat(simpleObject.getName()).isNull();\n-\n- // when\n- simpleObject.setName(name);\n-\n- // then\n- assertThat(simpleObject.getName()).isEqualTo(name);\n- }\n+ \n+ @Test\n+ public void testName() throws Exception {\n+ // given\n+ String name = \"Foobar\";\n+ assertNull(simpleObject.getName());\n+\n+ // when\n+ simpleObject.setName(name);\n+\n+ // then\n+ assertEquals(name, simpleObject.getName());\n }\n \n }",
"filename": "naked-objects/dom/src/test/java/domainapp/dom/modules/simple/SimpleObjectTest.java",
"status": "modified"
},
{
"diff": "@@ -14,9 +14,10 @@\n */\n package domainapp.dom.modules.simple;\n \n-import static org.assertj.core.api.Assertions.assertThat;\n-\n import com.google.common.collect.Lists;\n+\n+import static org.junit.Assert.assertEquals;\n+\n import java.util.List;\n import org.apache.isis.applib.DomainObjectContainer;\n import org.apache.isis.core.unittestsupport.jmocking.JUnitRuleMockery2;\n@@ -46,63 +47,52 @@ public void setUp() throws Exception {\n simpleObjects = new SimpleObjects();\n simpleObjects.container = mockContainer;\n }\n-\n- /**\n- * Test Creation of Simple Objects\n- */\n- public static class Create extends SimpleObjectsTest {\n-\n- @Test\n- public void happyCase() throws Exception {\n-\n- // given\n- final SimpleObject simpleObject = new SimpleObject();\n-\n- final Sequence seq = context.sequence(\"create\");\n- context.checking(new Expectations() {\n- {\n- oneOf(mockContainer).newTransientInstance(SimpleObject.class);\n- inSequence(seq);\n- will(returnValue(simpleObject));\n-\n- oneOf(mockContainer).persistIfNotAlready(simpleObject);\n- inSequence(seq);\n- }\n- });\n-\n- // when\n- final SimpleObject obj = simpleObjects.create(\"Foobar\");\n-\n- // then\n- assertThat(obj).isEqualTo(simpleObject);\n- assertThat(obj.getName()).isEqualTo(\"Foobar\");\n- }\n-\n+ \n+ @Test\n+ public void testCreate() throws Exception {\n+\n+ // given\n+ final SimpleObject simpleObject = new SimpleObject();\n+\n+ final Sequence seq = context.sequence(\"create\");\n+ context.checking(new Expectations() {\n+ {\n+ oneOf(mockContainer).newTransientInstance(SimpleObject.class);\n+ inSequence(seq);\n+ will(returnValue(simpleObject));\n+\n+ oneOf(mockContainer).persistIfNotAlready(simpleObject);\n+ inSequence(seq);\n+ }\n+ });\n+\n+ // when\n+ String objectName = \"Foobar\";\n+ final SimpleObject obj = simpleObjects.create(objectName);\n+\n+ // then\n+ assertEquals(simpleObject, obj);\n+ assertEquals(objectName, obj.getName());\n }\n+ \n+ @Test\n+ public void testListAll() throws Exception {\n \n- /**\n- * Test Listing of Simple Objects\n- */\n- public static class ListAll extends SimpleObjectsTest {\n+ // given\n+ final List<SimpleObject> all = Lists.newArrayList();\n \n- @Test\n- public void happyCase() throws Exception {\n+ context.checking(new Expectations() {\n+ {\n+ oneOf(mockContainer).allInstances(SimpleObject.class);\n+ will(returnValue(all));\n+ }\n+ });\n \n- // given\n- final List<SimpleObject> all = Lists.newArrayList();\n+ // when\n+ final List<SimpleObject> list = simpleObjects.listAll();\n \n- context.checking(new Expectations() {\n- {\n- oneOf(mockContainer).allInstances(SimpleObject.class);\n- will(returnValue(all));\n- }\n- });\n-\n- // when\n- final List<SimpleObject> list = simpleObjects.listAll();\n-\n- // then\n- assertThat(list).isEqualTo(all);\n- }\n+ // then\n+ assertEquals(all, list);\n }\n+\n }",
"filename": "naked-objects/dom/src/test/java/domainapp/dom/modules/simple/SimpleObjectsTest.java",
"status": "modified"
},
{
"diff": "@@ -18,30 +18,37 @@\n */\n package domainapp.integtests.tests.modules.simple;\n \n-import static org.assertj.core.api.Assertions.assertThat;\n+import static org.junit.Assert.assertEquals;\n+import static org.junit.Assert.assertNotNull;\n \n-import domainapp.dom.modules.simple.SimpleObject;\n-import domainapp.fixture.scenarios.RecreateSimpleObjects;\n-import domainapp.integtests.tests.SimpleAppIntegTest;\n import javax.inject.Inject;\n+\n import org.apache.isis.applib.DomainObjectContainer;\n import org.apache.isis.applib.fixturescripts.FixtureScripts;\n import org.apache.isis.applib.services.wrapper.DisabledException;\n import org.apache.isis.applib.services.wrapper.InvalidException;\n import org.junit.Before;\n import org.junit.Test;\n \n+import domainapp.dom.modules.simple.SimpleObject;\n+import domainapp.fixture.scenarios.RecreateSimpleObjects;\n+import domainapp.integtests.tests.SimpleAppIntegTest;\n+\n /**\n * Test Fixtures with Simple Objects\n */\n public class SimpleObjectIntegTest extends SimpleAppIntegTest {\n \n @Inject\n FixtureScripts fixtureScripts;\n+ @Inject\n+ DomainObjectContainer container;\n \n RecreateSimpleObjects fs;\n SimpleObject simpleObjectPojo;\n SimpleObject simpleObjectWrapped;\n+ \n+ private static final String NEW_NAME = \"new name\";\n \n @Before\n public void setUp() throws Exception {\n@@ -51,80 +58,59 @@ public void setUp() throws Exception {\n \n simpleObjectPojo = fs.getSimpleObjects().get(0);\n \n- assertThat(simpleObjectPojo).isNotNull();\n+ assertNotNull(simpleObjectPojo);\n simpleObjectWrapped = wrap(simpleObjectPojo);\n }\n-\n- /**\n- * Test Object Name accessibility\n- */\n- public static class Name extends SimpleObjectIntegTest {\n-\n- @Test\n- public void accessible() throws Exception {\n- // when\n- final String name = simpleObjectWrapped.getName();\n- // then\n- assertThat(name).isEqualTo(fs.names.get(0));\n- }\n-\n- @Test\n- public void cannotBeUpdatedDirectly() throws Exception {\n-\n- // expect\n- expectedExceptions.expect(DisabledException.class);\n-\n- // when\n- simpleObjectWrapped.setName(\"new name\");\n- }\n+ \n+ @Test\n+ public void testNameAccessible() throws Exception {\n+ // when\n+ final String name = simpleObjectWrapped.getName();\n+ // then\n+ assertEquals(fs.names.get(0), name);\n }\n+ \n+ @Test\n+ public void testNameCannotBeUpdatedDirectly() throws Exception {\n \n- /**\n- * Test Validation of SimpleObject Names\n- */\n- public static class UpdateName extends SimpleObjectIntegTest {\n-\n- @Test\n- public void happyCase() throws Exception {\n-\n- // when\n- simpleObjectWrapped.updateName(\"new name\");\n+ // expect\n+ expectedExceptions.expect(DisabledException.class);\n \n- // then\n- assertThat(simpleObjectWrapped.getName()).isEqualTo(\"new name\");\n- }\n-\n- @Test\n- public void failsValidation() throws Exception {\n+ // when\n+ simpleObjectWrapped.setName(NEW_NAME);\n+ }\n+ \n+ @Test\n+ public void testUpdateName() throws Exception {\n \n- // expect\n- expectedExceptions.expect(InvalidException.class);\n- expectedExceptions.expectMessage(\"Exclamation mark is not allowed\");\n+ // when\n+ simpleObjectWrapped.updateName(NEW_NAME);\n \n- // when\n- simpleObjectWrapped.updateName(\"new name!\");\n- }\n+ // then\n+ assertEquals(NEW_NAME, simpleObjectWrapped.getName());\n }\n+ \n+ @Test\n+ public void testUpdateNameFailsValidation() throws Exception {\n \n- /**\n- * Test ContainerTitle generation based on SimpleObject Name\n- */\n- public static class Title extends SimpleObjectIntegTest {\n-\n- @Inject\n- DomainObjectContainer container;\n+ // expect\n+ expectedExceptions.expect(InvalidException.class);\n+ expectedExceptions.expectMessage(\"Exclamation mark is not allowed\");\n \n- @Test\n- public void interpolatesName() throws Exception {\n+ // when\n+ simpleObjectWrapped.updateName(NEW_NAME + \"!\");\n+ }\n+ \n+ @Test\n+ public void testInterpolatesName() throws Exception {\n \n- // given\n- final String name = simpleObjectWrapped.getName();\n+ // given\n+ final String name = simpleObjectWrapped.getName();\n \n- // when\n- final String title = container.titleOf(simpleObjectWrapped);\n+ // when\n+ final String title = container.titleOf(simpleObjectWrapped);\n \n- // then\n- assertThat(title).isEqualTo(\"Object: \" + name);\n- }\n+ // then\n+ assertEquals(\"Object: \" + name, title);\n }\n }",
"filename": "naked-objects/integtests/src/test/java/domainapp/integtests/tests/modules/simple/SimpleObjectIntegTest.java",
"status": "modified"
},
{
"diff": "@@ -18,24 +18,28 @@\n */\n package domainapp.integtests.tests.modules.simple;\n \n-import static org.assertj.core.api.Assertions.assertThat;\n+import static org.junit.Assert.assertEquals;\n \n-import com.google.common.base.Throwables;\n-import domainapp.dom.modules.simple.SimpleObject;\n-import domainapp.dom.modules.simple.SimpleObjects;\n-import domainapp.fixture.modules.simple.SimpleObjectsTearDown;\n-import domainapp.fixture.scenarios.RecreateSimpleObjects;\n-import domainapp.integtests.tests.SimpleAppIntegTest;\n import java.sql.SQLIntegrityConstraintViolationException;\n import java.util.List;\n+\n import javax.inject.Inject;\n+\n import org.apache.isis.applib.fixturescripts.FixtureScript;\n import org.apache.isis.applib.fixturescripts.FixtureScripts;\n import org.hamcrest.Description;\n import org.hamcrest.Matcher;\n import org.hamcrest.TypeSafeMatcher;\n import org.junit.Test;\n \n+import com.google.common.base.Throwables;\n+\n+import domainapp.dom.modules.simple.SimpleObject;\n+import domainapp.dom.modules.simple.SimpleObjects;\n+import domainapp.fixture.modules.simple.SimpleObjectsTearDown;\n+import domainapp.fixture.scenarios.RecreateSimpleObjects;\n+import domainapp.integtests.tests.SimpleAppIntegTest;\n+\n /**\n * Fixture Pattern Integration Test\n */\n@@ -46,104 +50,90 @@ public class SimpleObjectsIntegTest extends SimpleAppIntegTest {\n @Inject\n SimpleObjects simpleObjects;\n \n- /**\n- * Test Listing of All Simple Objects\n- */\n- public static class ListAll extends SimpleObjectsIntegTest {\n+ @Test\n+ public void testListAll() throws Exception {\n \n- @Test\n- public void happyCase() throws Exception {\n+ // given\n+ RecreateSimpleObjects fs = new RecreateSimpleObjects();\n+ fixtureScripts.runFixtureScript(fs, null);\n+ nextTransaction();\n \n- // given\n- RecreateSimpleObjects fs = new RecreateSimpleObjects();\n- fixtureScripts.runFixtureScript(fs, null);\n- nextTransaction();\n+ // when\n+ final List<SimpleObject> all = wrap(simpleObjects).listAll();\n \n- // when\n- final List<SimpleObject> all = wrap(simpleObjects).listAll();\n+ // then\n+ assertEquals(fs.getSimpleObjects().size(), all.size());\n \n- // then\n- assertThat(all).hasSize(fs.getSimpleObjects().size());\n-\n- SimpleObject simpleObject = wrap(all.get(0));\n- assertThat(simpleObject.getName()).isEqualTo(fs.getSimpleObjects().get(0).getName());\n- }\n-\n- @Test\n- public void whenNone() throws Exception {\n+ SimpleObject simpleObject = wrap(all.get(0));\n+ assertEquals(fs.getSimpleObjects().get(0).getName(), simpleObject.getName());\n+ }\n+ \n+ @Test\n+ public void testListAllWhenNone() throws Exception {\n \n- // given\n- FixtureScript fs = new SimpleObjectsTearDown();\n- fixtureScripts.runFixtureScript(fs, null);\n- nextTransaction();\n+ // given\n+ FixtureScript fs = new SimpleObjectsTearDown();\n+ fixtureScripts.runFixtureScript(fs, null);\n+ nextTransaction();\n \n- // when\n- final List<SimpleObject> all = wrap(simpleObjects).listAll();\n+ // when\n+ final List<SimpleObject> all = wrap(simpleObjects).listAll();\n \n- // then\n- assertThat(all).hasSize(0);\n- }\n+ // then\n+ assertEquals(0, all.size());\n }\n+ \n+ @Test\n+ public void testCreate() throws Exception {\n \n+ // given\n+ FixtureScript fs = new SimpleObjectsTearDown();\n+ fixtureScripts.runFixtureScript(fs, null);\n+ nextTransaction();\n \n- /**\n- * Test Creation of Simple Objects\n- */\n- public static class Create extends SimpleObjectsIntegTest {\n-\n- @Test\n- public void happyCase() throws Exception {\n-\n- // given\n- FixtureScript fs = new SimpleObjectsTearDown();\n- fixtureScripts.runFixtureScript(fs, null);\n- nextTransaction();\n-\n- // when\n- wrap(simpleObjects).create(\"Faz\");\n-\n- // then\n- final List<SimpleObject> all = wrap(simpleObjects).listAll();\n- assertThat(all).hasSize(1);\n- }\n-\n- @Test\n- public void whenAlreadyExists() throws Exception {\n-\n- // given\n- FixtureScript fs = new SimpleObjectsTearDown();\n- fixtureScripts.runFixtureScript(fs, null);\n- nextTransaction();\n- wrap(simpleObjects).create(\"Faz\");\n- nextTransaction();\n-\n- // then\n- expectedExceptions.expectCause(causalChainContains(SQLIntegrityConstraintViolationException.class));\n-\n- // when\n- wrap(simpleObjects).create(\"Faz\");\n- nextTransaction();\n- }\n-\n- private static Matcher<? extends Throwable> causalChainContains(final Class<?> cls) {\n- return new TypeSafeMatcher<Throwable>() {\n- @Override\n- protected boolean matchesSafely(Throwable item) {\n- final List<Throwable> causalChain = Throwables.getCausalChain(item);\n- for (Throwable throwable : causalChain) {\n- if (cls.isAssignableFrom(throwable.getClass())) {\n- return true;\n- }\n- }\n- return false;\n- }\n+ // when\n+ wrap(simpleObjects).create(\"Faz\");\n \n- @Override\n- public void describeTo(Description description) {\n- description.appendText(\"exception with causal chain containing \" + cls.getSimpleName());\n+ // then\n+ final List<SimpleObject> all = wrap(simpleObjects).listAll();\n+ assertEquals(1, all.size());\n+ }\n+ \n+ @Test\n+ public void testCreateWhenAlreadyExists() throws Exception {\n+\n+ // given\n+ FixtureScript fs = new SimpleObjectsTearDown();\n+ fixtureScripts.runFixtureScript(fs, null);\n+ nextTransaction();\n+ wrap(simpleObjects).create(\"Faz\");\n+ nextTransaction();\n+\n+ // then\n+ expectedExceptions.expectCause(causalChainContains(SQLIntegrityConstraintViolationException.class));\n+\n+ // when\n+ wrap(simpleObjects).create(\"Faz\");\n+ nextTransaction();\n+ }\n+ \n+ private static Matcher<? extends Throwable> causalChainContains(final Class<?> cls) {\n+ return new TypeSafeMatcher<Throwable>() {\n+ @Override\n+ protected boolean matchesSafely(Throwable item) {\n+ final List<Throwable> causalChain = Throwables.getCausalChain(item);\n+ for (Throwable throwable : causalChain) {\n+ if (cls.isAssignableFrom(throwable.getClass())) {\n+ return true;\n+ }\n }\n- };\n- }\n+ return false;\n+ }\n+\n+ @Override\n+ public void describeTo(Description description) {\n+ description.appendText(\"exception with causal chain containing \" + cls.getSimpleName());\n+ }\n+ };\n }\n-\n }",
"filename": "naked-objects/integtests/src/test/java/domainapp/integtests/tests/modules/simple/SimpleObjectsIntegTest.java",
"status": "modified"
}
]
} |
{
"body": "See Travis log https://api.travis-ci.org/v3/job/329176022/log.txt",
"comments": [
{
"body": "Ping @Rzeposlaw, care to investigate?",
"created_at": "2018-01-16T19:37:01Z"
},
{
"body": "Why this is messy when I open the Travis log?",
"created_at": "2018-01-19T12:25:44Z"
},
{
"body": "@iluwatar I would like to work on it :)",
"created_at": "2018-01-23T00:08:46Z"
},
{
"body": "Ok @sharmin03 ",
"created_at": "2018-01-23T21:23:21Z"
},
{
"body": "Flaky test disabled in https://github.com/iluwatar/java-design-patterns/commit/17ea0b17f68e6d20917dfd2937db28de83d9bf27. Still needs to be fixed.",
"created_at": "2018-03-31T07:27:11Z"
}
],
"number": 699,
"title": "Intermittent failure in Balking pattern"
} | {
"body": "Fix intermittent failure\r\n\r\nEnable the \"wash\" test for the Balking pattern\r\nSolves #699\r\n\r\nThe problem here was that sometimes, the ExecutorService execute the second instruction instead of the first one.\r\nWe can see it in the log file : https://api.travis-ci.org/v3/job/329176022/log.txt\r\n(the pool-1-thread-2 was launch before).\r\nSo the machineStateGlobal variable was set to ENABLED.\r\n\r\nThe fix proposed here is to set the machineStateGlobal variable for each execution. It will not depend anymore on the order.",
"number": 809,
"review_comments": [],
"title": "Fix intermittent failure in Balking pattern describe in #699"
} | {
"commits": [
{
"message": "Fix intermittent failure in Balking pattern describe in #699"
},
{
"message": "Fix build error on checkstyle"
}
],
"files": [
{
"diff": "@@ -22,31 +22,36 @@\n */\n package com.iluwatar.balking;\n \n-import org.junit.jupiter.api.Disabled;\n-import org.junit.jupiter.api.Test;\n+import static org.junit.jupiter.api.Assertions.assertEquals;\n \n import java.util.concurrent.ExecutorService;\n import java.util.concurrent.Executors;\n import java.util.concurrent.TimeUnit;\n \n-import static org.junit.jupiter.api.Assertions.assertEquals;\n+import org.junit.jupiter.api.Test;\n \n /**\n * Tests for {@link WashingMachine}\n */\n public class WashingMachineTest {\n \n- private volatile WashingMachineState machineStateGlobal;\n+ private WashingMachineState machineStateGlobal;\n \n- @Disabled\n @Test\n public void wash() throws Exception {\n WashingMachine washingMachine = new WashingMachine();\n ExecutorService executorService = Executors.newFixedThreadPool(2);\n- executorService.execute(washingMachine::wash);\n executorService.execute(() -> {\n washingMachine.wash();\n- machineStateGlobal = washingMachine.getWashingMachineState();\n+ if (machineStateGlobal == null) {\n+ machineStateGlobal = washingMachine.getWashingMachineState();\n+ }\n+ });\n+ executorService.execute(() -> {\n+ washingMachine.wash();\n+ if (machineStateGlobal == null) {\n+ machineStateGlobal = washingMachine.getWashingMachineState();\n+ }\n });\n executorService.shutdown();\n try {",
"filename": "balking/src/test/java/com/iluwatar/balking/WashingMachineTest.java",
"status": "modified"
}
]
} |
{
"body": "See Travis log https://api.travis-ci.org/v3/job/329176022/log.txt",
"comments": [
{
"body": "Ping @Rzeposlaw, care to investigate?",
"created_at": "2018-01-16T19:37:01Z"
},
{
"body": "Why this is messy when I open the Travis log?",
"created_at": "2018-01-19T12:25:44Z"
},
{
"body": "@iluwatar I would like to work on it :)",
"created_at": "2018-01-23T00:08:46Z"
},
{
"body": "Ok @sharmin03 ",
"created_at": "2018-01-23T21:23:21Z"
},
{
"body": "Flaky test disabled in https://github.com/iluwatar/java-design-patterns/commit/17ea0b17f68e6d20917dfd2937db28de83d9bf27. Still needs to be fixed.",
"created_at": "2018-03-31T07:27:11Z"
}
],
"number": 699,
"title": "Intermittent failure in Balking pattern"
} | {
"body": "Fix intermittent failure\r\n\r\n- Enable the \"wash\" test for the Balking pattern\r\n\r\nSolves #699 \r\n\r\n- The problem here was that sometimes, the ExecutorService execute the second instruction instead of the first one.\r\nWe can see it in the log file : https://api.travis-ci.org/v3/job/329176022/log.txt\r\n(the pool-1-thread-2 was launch before).\r\nSo the machineStateGlobal variable was set to ENABLED.\r\n\r\n- The fix proposed here is to set the machineStateGlobal variable for each execution. It will not depend anymore on the order.\r\n",
"number": 808,
"review_comments": [],
"title": "Fix intermittent failure in Balking pattern describe in #699"
} | {
"commits": [
{
"message": "Fix intermittent failure in Balking pattern describe in #699"
},
{
"message": "Fix build error due to wrong indentation"
}
],
"files": [
{
"diff": "@@ -22,14 +22,13 @@\n */\n package com.iluwatar.balking;\n \n-import org.junit.jupiter.api.Disabled;\n-import org.junit.jupiter.api.Test;\n+import static org.junit.jupiter.api.Assertions.assertEquals;\n \n import java.util.concurrent.ExecutorService;\n import java.util.concurrent.Executors;\n import java.util.concurrent.TimeUnit;\n \n-import static org.junit.jupiter.api.Assertions.assertEquals;\n+import org.junit.jupiter.api.Test;\n \n /**\n * Tests for {@link WashingMachine}\n@@ -38,12 +37,14 @@ public class WashingMachineTest {\n \n private volatile WashingMachineState machineStateGlobal;\n \n- @Disabled\n @Test\n public void wash() throws Exception {\n WashingMachine washingMachine = new WashingMachine();\n ExecutorService executorService = Executors.newFixedThreadPool(2);\n- executorService.execute(washingMachine::wash);\n+ executorService.execute(() -> {\n+ washingMachine.wash();\n+ machineStateGlobal = washingMachine.getWashingMachineState();\n+ });\n executorService.execute(() -> {\n washingMachine.wash();\n machineStateGlobal = washingMachine.getWashingMachineState();",
"filename": "balking/src/test/java/com/iluwatar/balking/WashingMachineTest.java",
"status": "modified"
}
]
} |
{
"body": "See https://travis-ci.org/iluwatar/java-design-patterns/builds/278878833",
"comments": [
{
"body": "Ping @rastdeepanshu",
"created_at": "2017-09-23T07:08:15Z"
},
{
"body": "@iluwatar i'll take a look.",
"created_at": "2017-09-23T10:30:13Z"
},
{
"body": "https://s3.amazonaws.com/archive.travis-ci.org/jobs/297472315/log.txt?X-Amz-Expires=30&X-Amz-Date=20171105T181140Z&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJRYRXRSVGNKPKO5A/20171105/us-east-1/s3/aws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=673ea97270fea2a3704c49a677d2d9c2ae9abcadce308545a49b2784928bd785",
"created_at": "2017-11-05T18:17:55Z"
},
{
"body": "https://travis-ci.org/iluwatar/java-design-patterns/builds/304766483?utm_source=email&utm_medium=notification",
"created_at": "2017-11-20T14:48:01Z"
},
{
"body": "@rastdeepanshu it still sometimes fails, will you try to solve it?",
"created_at": "2018-01-10T18:54:11Z"
},
{
"body": "@iluwatar I'll take a look. ",
"created_at": "2018-01-10T21:07:04Z"
},
{
"body": "@rastdeepanshu any progress?",
"created_at": "2018-03-07T19:54:07Z"
},
{
"body": "Flaky test disabled in https://github.com/iluwatar/java-design-patterns/commit/17ea0b17f68e6d20917dfd2937db28de83d9bf27. Still needs to be fixed.",
"created_at": "2018-03-31T07:27:05Z"
},
{
"body": "Unfortunately the fix did not work. See https://api.travis-ci.org/v3/job/384940670/log.txt. Reopening this issue.",
"created_at": "2018-06-03T11:07:06Z"
}
],
"number": 643,
"title": "Intermittent test failure in Throttling pattern"
} | {
"body": "Resolves #643 \r\n\r\nRoot Cause\r\n---\r\nTest cases failed due to presence of global state in `CallsCount`. Because `AppTest` was executed before `B2BServiceTest`, it scheduled 1 sec timer using `ThrottleTimerImpl` class. While resetting it used that global `CallCount.reset()` method, which reset all counters. So that causes thread safety issue because of unintended sharing of application state between test cases, which is not a good practice.\r\n\r\nSolution\r\n---\r\n\r\nSolution was not to have global state using `static` map. Rather global state should be maintained using single object and passing that as dependency wherever needed.\r\n\r\nTodos\r\n---\r\n- [x] Update class diagram. (Once solution is approved)",
"number": 803,
"review_comments": [],
"title": "Resolves #643, test cases failed due to global state in CallsCount"
} | {
"commits": [
{
"message": "Resolves #643, test cases failed due to presence of global state in CallsCount. Because AppTest was executed before B2BServiceTest, it scheduled 1 sec timer using ThrottleTimerImpl class. While resetting it used that global CallCount class reset() method, which reset all counters. So that causes thread safety issue because of unintended sharing of application state between test cases, which is not a good practice."
},
{
"message": "Updated class diagram png and added UCLS file"
}
],
"files": [
{
"diff": "",
"filename": "throttling/etc/throttling-pattern.png",
"status": "modified"
},
{
"diff": "@@ -0,0 +1,88 @@\n+<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n+<class-diagram version=\"1.2.2\" icons=\"true\" always-add-relationships=\"false\" generalizations=\"true\" realizations=\"true\" \n+ associations=\"true\" dependencies=\"false\" nesting-relationships=\"true\" router=\"FAN\"> \n+ <class id=\"1\" language=\"java\" name=\"com.iluwatar.throttling.CallsCount\" project=\"throttling\" \n+ file=\"/throttling/src/main/java/com/iluwatar/throttling/CallsCount.java\" binary=\"false\" corner=\"BOTTOM_RIGHT\"> \n+ <position height=\"211\" width=\"256\" x=\"656\" y=\"228\"/> \n+ <display autosize=\"false\" stereotype=\"true\" package=\"true\" initial-value=\"false\" signature=\"true\" \n+ sort-features=\"false\" accessors=\"true\" visibility=\"true\"> \n+ <attributes public=\"true\" package=\"true\" protected=\"true\" private=\"true\" static=\"true\"/> \n+ <operations public=\"true\" package=\"true\" protected=\"true\" private=\"true\" static=\"true\"/> \n+ </display> \n+ </class> \n+ <class id=\"2\" language=\"java\" name=\"com.iluwatar.throttling.Tenant\" project=\"throttling\" \n+ file=\"/throttling/src/main/java/com/iluwatar/throttling/Tenant.java\" binary=\"false\" corner=\"BOTTOM_RIGHT\"> \n+ <position height=\"-1\" width=\"-1\" x=\"465\" y=\"524\"/> \n+ <display autosize=\"true\" stereotype=\"true\" package=\"true\" initial-value=\"false\" signature=\"true\" \n+ sort-features=\"false\" accessors=\"true\" visibility=\"true\"> \n+ <attributes public=\"true\" package=\"true\" protected=\"true\" private=\"true\" static=\"true\"/> \n+ <operations public=\"true\" package=\"true\" protected=\"true\" private=\"true\" static=\"true\"/> \n+ </display> \n+ </class> \n+ <class id=\"3\" language=\"java\" name=\"com.iluwatar.throttling.B2BService\" project=\"throttling\" \n+ file=\"/throttling/src/main/java/com/iluwatar/throttling/B2BService.java\" binary=\"false\" corner=\"BOTTOM_RIGHT\"> \n+ <position height=\"-1\" width=\"-1\" x=\"464\" y=\"192\"/> \n+ <display autosize=\"true\" stereotype=\"true\" package=\"true\" initial-value=\"false\" signature=\"true\" \n+ sort-features=\"false\" accessors=\"true\" visibility=\"true\"> \n+ <attributes public=\"true\" package=\"true\" protected=\"true\" private=\"true\" static=\"true\"/> \n+ <operations public=\"true\" package=\"true\" protected=\"true\" private=\"true\" static=\"true\"/> \n+ </display> \n+ </class> \n+ <interface id=\"4\" language=\"java\" name=\"com.iluwatar.throttling.timer.Throttler\" project=\"throttling\" \n+ file=\"/throttling/src/main/java/com/iluwatar/throttling/timer/Throttler.java\" binary=\"false\" corner=\"BOTTOM_RIGHT\"> \n+ <position height=\"-1\" width=\"-1\" x=\"167\" y=\"174\"/> \n+ <display autosize=\"true\" stereotype=\"true\" package=\"true\" initial-value=\"false\" signature=\"true\" \n+ sort-features=\"false\" accessors=\"true\" visibility=\"true\"> \n+ <attributes public=\"true\" package=\"true\" protected=\"true\" private=\"true\" static=\"true\"/> \n+ <operations public=\"true\" package=\"true\" protected=\"true\" private=\"true\" static=\"true\"/> \n+ </display> \n+ </interface> \n+ <class id=\"5\" language=\"java\" name=\"com.iluwatar.throttling.timer.ThrottleTimerImpl\" project=\"throttling\" \n+ file=\"/throttling/src/main/java/com/iluwatar/throttling/timer/ThrottleTimerImpl.java\" binary=\"false\" \n+ corner=\"BOTTOM_RIGHT\"> \n+ <position height=\"-1\" width=\"-1\" x=\"166\" y=\"396\"/> \n+ <display autosize=\"true\" stereotype=\"true\" package=\"true\" initial-value=\"false\" signature=\"true\" \n+ sort-features=\"false\" accessors=\"true\" visibility=\"true\"> \n+ <attributes public=\"true\" package=\"true\" protected=\"true\" private=\"true\" static=\"true\"/> \n+ <operations public=\"true\" package=\"true\" protected=\"true\" private=\"true\" static=\"true\"/> \n+ </display> \n+ </class> \n+ <association id=\"6\"> \n+ <end type=\"SOURCE\" refId=\"3\" navigable=\"false\"> \n+ <attribute id=\"7\" name=\"callsCount\"/> \n+ <multiplicity id=\"8\" minimum=\"0\" maximum=\"1\"/> \n+ </end> \n+ <end type=\"TARGET\" refId=\"1\" navigable=\"true\"/> \n+ <display labels=\"true\" multiplicity=\"true\"/> \n+ </association> \n+ <dependency id=\"9\"> \n+ <end type=\"SOURCE\" refId=\"3\"/> \n+ <end type=\"TARGET\" refId=\"4\"/> \n+ </dependency> \n+ <dependency id=\"10\"> \n+ <end type=\"SOURCE\" refId=\"3\"/> \n+ <end type=\"TARGET\" refId=\"2\"/> \n+ </dependency> \n+ <association id=\"11\"> \n+ <end type=\"SOURCE\" refId=\"5\" navigable=\"false\"> \n+ <attribute id=\"12\" name=\"callsCount\"/> \n+ <multiplicity id=\"13\" minimum=\"0\" maximum=\"1\"/> \n+ </end> \n+ <end type=\"TARGET\" refId=\"1\" navigable=\"true\"/> \n+ <display labels=\"true\" multiplicity=\"true\"/> \n+ </association> \n+ <dependency id=\"14\"> \n+ <end type=\"SOURCE\" refId=\"2\"/> \n+ <end type=\"TARGET\" refId=\"1\"/> \n+ </dependency> \n+ <realization id=\"15\"> \n+ <end type=\"SOURCE\" refId=\"5\"/> \n+ <end type=\"TARGET\" refId=\"4\"/> \n+ </realization> \n+ <classifier-display autosize=\"true\" stereotype=\"true\" package=\"true\" initial-value=\"false\" signature=\"true\" \n+ sort-features=\"false\" accessors=\"true\" visibility=\"true\"> \n+ <attributes public=\"true\" package=\"true\" protected=\"true\" private=\"true\" static=\"true\"/> \n+ <operations public=\"true\" package=\"true\" protected=\"true\" private=\"true\" static=\"true\"/> \n+ </classifier-display> \n+ <association-display labels=\"true\" multiplicity=\"true\"/>\n+</class-diagram>\n\\ No newline at end of file",
"filename": "throttling/etc/throttling-pattern.ucls",
"status": "added"
},
{
"diff": "@@ -53,14 +53,14 @@ public class App {\n * @param args main arguments\n */\n public static void main(String[] args) {\n-\n- Tenant adidas = new Tenant(\"Adidas\", 5);\n- Tenant nike = new Tenant(\"Nike\", 6);\n+ CallsCount callsCount = new CallsCount();\n+ Tenant adidas = new Tenant(\"Adidas\", 5, callsCount);\n+ Tenant nike = new Tenant(\"Nike\", 6, callsCount);\n \n ExecutorService executorService = Executors.newFixedThreadPool(2);\n \n- executorService.execute(() -> makeServiceCalls(adidas));\n- executorService.execute(() -> makeServiceCalls(nike));\n+ executorService.execute(() -> makeServiceCalls(adidas, callsCount));\n+ executorService.execute(() -> makeServiceCalls(nike, callsCount));\n \n executorService.shutdown();\n try {\n@@ -73,9 +73,9 @@ public static void main(String[] args) {\n /**\n * Make calls to the B2BService dummy API\n */\n- private static void makeServiceCalls(Tenant tenant) {\n- Throttler timer = new ThrottleTimerImpl(10);\n- B2BService service = new B2BService(timer);\n+ private static void makeServiceCalls(Tenant tenant, CallsCount callsCount) {\n+ Throttler timer = new ThrottleTimerImpl(10, callsCount);\n+ B2BService service = new B2BService(timer, callsCount);\n for (int i = 0; i < 20; i++) {\n service.dummyCustomerApi(tenant);\n // Sleep is introduced to keep the output in check and easy to view and analyze the results.",
"filename": "throttling/src/main/java/com/iluwatar/throttling/App.java",
"status": "modified"
},
{
"diff": "@@ -35,8 +35,10 @@\n class B2BService {\n \n private static final Logger LOGGER = LoggerFactory.getLogger(B2BService.class);\n+ private final CallsCount callsCount;\n \n- public B2BService(Throttler timer) {\n+ public B2BService(Throttler timer, CallsCount callsCount) {\n+ this.callsCount = callsCount;\n timer.start();\n }\n \n@@ -46,13 +48,13 @@ public B2BService(Throttler timer) {\n */\n public int dummyCustomerApi(Tenant tenant) {\n String tenantName = tenant.getName();\n- long count = CallsCount.getCount(tenantName);\n+ long count = callsCount.getCount(tenantName);\n LOGGER.debug(\"Counter for {} : {} \", tenant.getName(), count);\n if (count >= tenant.getAllowedCallsPerSecond()) {\n LOGGER.error(\"API access per second limit reached for: {}\", tenantName);\n return -1;\n }\n- CallsCount.incrementCount(tenantName);\n+ callsCount.incrementCount(tenantName);\n return getRandomCustomerId();\n }\n ",
"filename": "throttling/src/main/java/com/iluwatar/throttling/B2BService.java",
"status": "modified"
},
{
"diff": "@@ -38,21 +38,21 @@\n public final class CallsCount {\n \n private static final Logger LOGGER = LoggerFactory.getLogger(CallsCount.class);\n- private static Map<String, AtomicLong> tenantCallsCount = new ConcurrentHashMap<>();\n+ private Map<String, AtomicLong> tenantCallsCount = new ConcurrentHashMap<>();\n \n /**\n * Add a new tenant to the map.\n * @param tenantName name of the tenant.\n */\n- public static void addTenant(String tenantName) {\n+ public void addTenant(String tenantName) {\n tenantCallsCount.putIfAbsent(tenantName, new AtomicLong(0));\n }\n \n /**\n * Increment the count of the specified tenant.\n * @param tenantName name of the tenant.\n */\n- public static void incrementCount(String tenantName) {\n+ public void incrementCount(String tenantName) {\n tenantCallsCount.get(tenantName).incrementAndGet();\n }\n \n@@ -61,14 +61,14 @@ public static void incrementCount(String tenantName) {\n * @param tenantName name of the tenant.\n * @return the count of the tenant.\n */\n- public static long getCount(String tenantName) {\n+ public long getCount(String tenantName) {\n return tenantCallsCount.get(tenantName).get();\n }\n \n /**\n * Resets the count of all the tenants in the map.\n */\n- public static void reset() {\n+ public void reset() {\n LOGGER.debug(\"Resetting the map.\");\n for (Entry<String, AtomicLong> e : tenantCallsCount.entrySet()) {\n tenantCallsCount.put(e.getKey(), new AtomicLong(0));",
"filename": "throttling/src/main/java/com/iluwatar/throttling/CallsCount.java",
"status": "modified"
},
{
"diff": "@@ -38,13 +38,13 @@ public class Tenant {\n * @param allowedCallsPerSecond The number of calls allowed for a particular tenant.\n * @throws InvalidParameterException If number of calls is less than 0, throws exception.\n */\n- public Tenant(String name, int allowedCallsPerSecond) {\n+ public Tenant(String name, int allowedCallsPerSecond, CallsCount callsCount) {\n if (allowedCallsPerSecond < 0) {\n throw new InvalidParameterException(\"Number of calls less than 0 not allowed\");\n }\n this.name = name;\n this.allowedCallsPerSecond = allowedCallsPerSecond;\n- CallsCount.addTenant(name);\n+ callsCount.addTenant(name);\n }\n \n public String getName() {",
"filename": "throttling/src/main/java/com/iluwatar/throttling/Tenant.java",
"status": "modified"
},
{
"diff": "@@ -37,10 +37,12 @@\n */\n public class ThrottleTimerImpl implements Throttler {\n \n- private int throttlePeriod;\n- \n- public ThrottleTimerImpl(int throttlePeriod) {\n+ private final int throttlePeriod;\n+ private final CallsCount callsCount;\n+\n+ public ThrottleTimerImpl(int throttlePeriod, CallsCount callsCount) {\n this.throttlePeriod = throttlePeriod;\n+ this.callsCount = callsCount;\n }\n \n /**\n@@ -51,7 +53,7 @@ public void start() {\n new Timer(true).schedule(new TimerTask() {\n @Override\n public void run() {\n- CallsCount.reset();\n+ callsCount.reset();\n }\n }, 0, throttlePeriod);\n }",
"filename": "throttling/src/main/java/com/iluwatar/throttling/timer/ThrottleTimerImpl.java",
"status": "modified"
},
{
"diff": "@@ -33,18 +33,19 @@\n */\n public class B2BServiceTest {\n \n- @Disabled\n+ private CallsCount callsCount = new CallsCount();\n+\n @Test\n public void dummyCustomerApiTest() {\n- Tenant tenant = new Tenant(\"testTenant\", 2);\n+ Tenant tenant = new Tenant(\"testTenant\", 2, callsCount);\n // In order to assure that throttling limits will not be reset, we use an empty throttling implementation\n Throttler timer = () -> { };\n- B2BService service = new B2BService(timer);\n+ B2BService service = new B2BService(timer, callsCount);\n \n for (int i = 0; i < 5; i++) {\n service.dummyCustomerApi(tenant);\n }\n- long counter = CallsCount.getCount(tenant.getName());\n+ long counter = callsCount.getCount(tenant.getName());\n assertEquals(2, counter, \"Counter limit must be reached\");\n }\n }",
"filename": "throttling/src/test/java/com/iluwatar/throttling/B2BServiceTest.java",
"status": "modified"
},
{
"diff": "@@ -36,7 +36,7 @@ public class TenantTest {\n @Test\n public void constructorTest() {\n assertThrows(InvalidParameterException.class, () -> {\n- Tenant tenant = new Tenant(\"FailTenant\", -1);\n+ Tenant tenant = new Tenant(\"FailTenant\", -1, new CallsCount());\n });\n }\n }",
"filename": "throttling/src/test/java/com/iluwatar/throttling/TenantTest.java",
"status": "modified"
}
]
} |
{
"body": "See Travis log https://api.travis-ci.org/v3/job/329176022/log.txt",
"comments": [
{
"body": "Ping @Rzeposlaw, care to investigate?",
"created_at": "2018-01-16T19:37:01Z"
},
{
"body": "Why this is messy when I open the Travis log?",
"created_at": "2018-01-19T12:25:44Z"
},
{
"body": "@iluwatar I would like to work on it :)",
"created_at": "2018-01-23T00:08:46Z"
},
{
"body": "Ok @sharmin03 ",
"created_at": "2018-01-23T21:23:21Z"
},
{
"body": "Flaky test disabled in https://github.com/iluwatar/java-design-patterns/commit/17ea0b17f68e6d20917dfd2937db28de83d9bf27. Still needs to be fixed.",
"created_at": "2018-03-31T07:27:11Z"
}
],
"number": 699,
"title": "Intermittent failure in Balking pattern"
} | {
"body": "Resolves #699 \r\n\r\nWhile performing unit test cases there was race condition between two threads, so it was not guaranteed to work every time. Used an interface `DelayProvider` for simulating delay, and while unit testing fake delay provider is used that eradicates the use of Threads in unit test cases, which is not a good practice.\r\n\r\n**This issue could also have been resolved by increasing the `Thread.sleep(50)` interval to higher value, but being design patterns repository I opted for better approach of not using threads when unit testing, due to complication of unit testing.**\r\n\r\n- [ ] Update class diagram if needed. `DelayProvider` is an internal class so I am not sure if we should incorporate it in class diagram\r\n- [ ] Do we have a better name than `DelayProvider`?",
"number": 802,
"review_comments": [],
"title": "Resolves #699 Intermittent failure was due to Thread.sleep in the code"
} | {
"commits": [
{
"message": "Intermittent failure was due to Thread.sleep in the code. While performing unit test cases there was race condition between two threads, so it was not guaranteed to work every time. Used an interface DelayProvider for simulating delay, and while unit testing fake delay provider is used that eradicates the use of Threads in unit test cases, which is not a good practice."
}
],
"files": [
{
"diff": "@@ -0,0 +1,10 @@\n+package com.iluwatar.balking;\n+\n+import java.util.concurrent.TimeUnit;\n+\n+/**\n+ * An interface to simulate delay while executing some work.\n+ */\n+public interface DelayProvider {\n+ void executeAfterDelay(long interval, TimeUnit timeUnit, Runnable task);\n+}",
"filename": "balking/src/main/java/com/iluwatar/balking/DelayProvider.java",
"status": "added"
},
{
"diff": "@@ -25,17 +25,38 @@\n import org.slf4j.Logger;\n import org.slf4j.LoggerFactory;\n \n+import java.util.concurrent.TimeUnit;\n+\n /**\n * Washing machine class\n */\n public class WashingMachine {\n \n private static final Logger LOGGER = LoggerFactory.getLogger(WashingMachine.class);\n-\n+ private final DelayProvider delayProvider;\n private WashingMachineState washingMachineState;\n \n+ /**\n+ * Creates a new instance of WashingMachine\n+ */\n public WashingMachine() {\n- washingMachineState = WashingMachineState.ENABLED;\n+ this((interval, timeUnit, task) -> {\n+ try {\n+ Thread.sleep(timeUnit.toMillis(interval));\n+ } catch (InterruptedException ie) {\n+ ie.printStackTrace();\n+ }\n+ task.run();\n+ });\n+ }\n+\n+ /**\n+ * Creates a new instance of WashingMachine using provided delayProvider. This constructor is used only for\n+ * unit testing purposes.\n+ */\n+ public WashingMachine(DelayProvider delayProvider) {\n+ this.delayProvider = delayProvider;\n+ this.washingMachineState = WashingMachineState.ENABLED;\n }\n \n public WashingMachineState getWashingMachineState() {\n@@ -56,12 +77,8 @@ public void wash() {\n washingMachineState = WashingMachineState.WASHING;\n }\n LOGGER.info(\"{}: Doing the washing\", Thread.currentThread().getName());\n- try {\n- Thread.sleep(50);\n- } catch (InterruptedException ie) {\n- ie.printStackTrace();\n- }\n- endOfWashing();\n+\n+ this.delayProvider.executeAfterDelay(50, TimeUnit.MILLISECONDS, this::endOfWashing);\n }\n \n /**",
"filename": "balking/src/main/java/com/iluwatar/balking/WashingMachine.java",
"status": "modified"
},
{
"diff": "@@ -22,11 +22,8 @@\n */\n package com.iluwatar.balking;\n \n-import org.junit.jupiter.api.Disabled;\n import org.junit.jupiter.api.Test;\n \n-import java.util.concurrent.ExecutorService;\n-import java.util.concurrent.Executors;\n import java.util.concurrent.TimeUnit;\n \n import static org.junit.jupiter.api.Assertions.assertEquals;\n@@ -36,32 +33,39 @@\n */\n public class WashingMachineTest {\n \n- private volatile WashingMachineState machineStateGlobal;\n+ private FakeDelayProvider fakeDelayProvider = new FakeDelayProvider();\n \n- @Disabled\n @Test\n- public void wash() throws Exception {\n- WashingMachine washingMachine = new WashingMachine();\n- ExecutorService executorService = Executors.newFixedThreadPool(2);\n- executorService.execute(washingMachine::wash);\n- executorService.execute(() -> {\n- washingMachine.wash();\n- machineStateGlobal = washingMachine.getWashingMachineState();\n- });\n- executorService.shutdown();\n- try {\n- executorService.awaitTermination(10, TimeUnit.SECONDS);\n- } catch (InterruptedException ie) {\n- ie.printStackTrace();\n- }\n+ public void wash() {\n+ WashingMachine washingMachine = new WashingMachine(fakeDelayProvider);\n+\n+ washingMachine.wash();\n+ washingMachine.wash();\n+\n+ WashingMachineState machineStateGlobal = washingMachine.getWashingMachineState();\n+\n+ fakeDelayProvider.task.run();\n+\n+ // washing machine remains in washing state\n assertEquals(WashingMachineState.WASHING, machineStateGlobal);\n+\n+ // washing machine goes back to enabled state\n+ assertEquals(WashingMachineState.ENABLED, washingMachine.getWashingMachineState());\n }\n \n @Test\n- public void endOfWashing() throws Exception {\n+ public void endOfWashing() {\n WashingMachine washingMachine = new WashingMachine();\n washingMachine.wash();\n assertEquals(WashingMachineState.ENABLED, washingMachine.getWashingMachineState());\n }\n \n+ private class FakeDelayProvider implements DelayProvider {\n+ private Runnable task;\n+\n+ @Override\n+ public void executeAfterDelay(long interval, TimeUnit timeUnit, Runnable task) {\n+ this.task = task;\n+ }\n+ }\n }\n\\ No newline at end of file",
"filename": "balking/src/test/java/com/iluwatar/balking/WashingMachineTest.java",
"status": "modified"
}
]
} |
{
"body": "The row that has an exception was:\r\nhayes.accept(conUnix); // Hayes modem with Unix configurator\r\n\r\nBecause of ConfigureForUnixVisitor didn't implements HayesVisitor.\r\n\r\n#java-design-patterns/acyclic-visitor",
"comments": [
{
"body": "@iluwatar That is not a bug, it is expected to happen. I will change the log level and use `instanceof` instead to resolve the confusion.",
"created_at": "2018-08-15T14:32:01Z"
},
{
"body": "Well done @npathai Thank you!",
"created_at": "2018-09-25T19:46:23Z"
}
],
"number": 781,
"title": "ClassCastException was throwed in App.java#52"
} | {
"body": "#781 Resolve ClassCastException in App.java \r\n Resolved ClassCastException thrown because ConfigureForUnixVisitor didn't implements HayesVisitor. \r\nImplemented AllModemVisitor in ConfigureForUnixVisitor class and added visit(Hayes hayes) method.",
"number": 783,
"review_comments": [],
"title": "#781: Resolve ClassCastException in App.java "
} | {
"commits": [
{
"message": "Resolve ClassCastException in App.java #781"
}
],
"files": [
{
"diff": "@@ -26,13 +26,17 @@\n import org.slf4j.LoggerFactory;\n \n /**\n- * ConfigureForUnixVisitor class implements zoom's visit method for Unix \n+ * ConfigureForUnixVisitor class implements zoom's and hayes' visit method for Unix \n * manufacturer\n */\n-public class ConfigureForUnixVisitor implements ModemVisitor, ZoomVisitor {\n+public class ConfigureForUnixVisitor implements AllModemVisitor {\n \n private static final Logger LOGGER = LoggerFactory.getLogger(ConfigureForUnixVisitor.class);\n-\n+ \n+ public void visit(Hayes hayes) {\n+ LOGGER.info(hayes + \" used with Dos configurator.\");\n+ }\n+ \n public void visit(Zoom zoom) {\n LOGGER.info(zoom + \" used with Unix configurator.\");\n }",
"filename": "acyclic-visitor/src/main/java/com/iluwatar/acyclicvisitor/ConfigureForUnixVisitor.java",
"status": "modified"
}
]
} |
{
"body": "Java Design Patterns is analyzed with SonarQube.com static analysis. The analysis shows some blocker level code smells that should be fixed:\n\nhttps://sonarqube.com/component_issues/index?id=com.iluwatar%3Ajava-design-patterns#resolved=false|severities=BLOCKER|types=CODE_SMELL\n",
"comments": [
{
"body": "I will take care of this.\n",
"created_at": "2016-10-26T13:52:23Z"
},
{
"body": "Thank you @sangupta you're good to go!\n",
"created_at": "2016-10-27T16:21:33Z"
},
{
"body": "@sangupta are you still working on this?",
"created_at": "2017-02-11T23:29:14Z"
},
{
"body": "@iluwatar Am sorry - have been pressed for time lately. Will have sometime in March - when I should be able to lend a helping hand.\r\n",
"created_at": "2017-02-12T12:55:30Z"
},
{
"body": "@iluwatar I can pick this if no one else is looking at it, to start with I could begin with dao. Is it okay?",
"created_at": "2017-05-02T15:16:31Z"
},
{
"body": "@Praveer-grover this is ok, please go ahead.",
"created_at": "2017-05-07T08:24:35Z"
},
{
"body": "Updated sonarqube url\r\nhttps://sonarcloud.io/project/issues?id=com.iluwatar%3Ajava-design-patterns&resolved=false&severities=BLOCKER&types=CODE_SMELL\r\n\r\n@Praveer-grover Are you still working on these issues? Let me know if you want me to share some modules?\r\n",
"created_at": "2017-09-18T13:57:51Z"
},
{
"body": "Ping @Praveer-grover ",
"created_at": "2017-09-19T05:52:13Z"
},
{
"body": "@mookkiah Are you planning to completely work on this ticket or you need a helping hand? ;)",
"created_at": "2017-09-21T10:51:43Z"
},
{
"body": "Either way is fine for me. As @Praveer-grover is not responding, I will look at sonarqube reported issues in prototype module (maybe this weekend). @dosdebug, you are welcome to help another module. Please just comment so we don't step on each other.",
"created_at": "2017-09-21T18:55:12Z"
},
{
"body": "@mookkiah I will be working on `dao` and `naked-objects-dom` then.",
"created_at": "2017-09-22T02:26:01Z"
},
{
"body": "Hey @mookkiah and @dosdebug are you guys still working on this?",
"created_at": "2017-12-25T10:28:32Z"
},
{
"body": "I will work on prototype module. ",
"created_at": "2017-12-26T00:17:12Z"
},
{
"body": "@iluwatar No Sir, not working on this.",
"created_at": "2018-01-02T09:48:36Z"
},
{
"body": "Ok @mookkiah I will keep the issue `under construction`",
"created_at": "2018-01-02T17:32:53Z"
},
{
"body": "Note : \r\nThe problem with the `dao` seems to be cause by the fact that SonarQube does not support `@Nested` : SQ currently ignores any `@Nested` classes, in other words it does not verify if there is a test within or not. ",
"created_at": "2018-01-19T11:45:10Z"
},
{
"body": "There are still 4 blockers and 37 criticals. See https://sonarcloud.io/project/issues?id=com.iluwatar%3Ajava-design-patterns&resolved=false&severities=BLOCKER%2CCRITICAL&types=CODE_SMELL. This issue is free for taking, if someone would like to help.",
"created_at": "2018-11-04T18:04:55Z"
},
{
"body": "Hm.... there is something strange here. I just opened one of the `Blockers` : https://sonarcloud.io/project/issues?id=com.iluwatar%3Ajava-design-patterns&open=AVfejjZoPl_GJI-SB0qL&resolved=false&severities=BLOCKER and although the analysis is run on `October 24, 2018, 10:43 PM Version 1.21.0-SNAPSHOT` SonarCloud is displaying outdated source code : from 2 years ago instead of the one fixed in #810....\r\n\r\nOh, actually #810 has been merged on `October 25` : a day later. I guess the analysis does not contain the changes done in #810 ( if I am to trust the timestamps of GitHub and SonarCloud ). I would guess the blockers will be fixed in the next analysis.\r\n\r\nJust my 2c ;)\r\n\r\nPS : This may explain the 4 blockers but the criticals still need to be fixed.",
"created_at": "2018-11-06T13:32:12Z"
},
{
"body": "@iluwatar I will start working on this and raise a PR shortly.",
"created_at": "2018-11-13T10:50:51Z"
},
{
"body": "Ok @IAmPramod ",
"created_at": "2018-11-18T19:31:50Z"
},
{
"body": "@iluwatar Is this available ?",
"created_at": "2019-02-13T08:40:11Z"
},
{
"body": "@IAmPramod Are you still working on this ?",
"created_at": "2019-02-13T09:43:13Z"
},
{
"body": "Hi @iluwatar : Pull request raised for this ",
"created_at": "2019-02-13T10:28:34Z"
}
],
"number": 508,
"title": "SonarQube reports code smells"
} | {
"body": "As per http://www.artima.com/intv/bloch13.html, clone method in java is\r\nbroken or confusing. So staying away from clone method.\r\n\r\n\r\nSonarQube reports code smells #508\r\n\r\n- SonarQube recommends Remove this \"clone\" implementation; use a copy constructor or copy factory instead\r\n\r\nPull request description\r\n\r\n- introduced copy method which uses copy constructor. keeps the implementation transparent and expect developer to make deep copy during copy operation.\r\n\r\n",
"number": 709,
"review_comments": [],
"title": "issue 508 - using copy constructor to implement prototype."
} | {
"commits": [
{
"message": "issue 508 - using copy constructor to implement prototype.\n\nAs per http://www.artima.com/intv/bloch13.html, clone method in java is\nbroken or confusing. So staying away from clone method."
}
],
"files": [
{
"diff": "@@ -52,15 +52,15 @@ public static void main(String[] args) {\n Warlord warlord;\n Beast beast;\n \n- factory = new HeroFactoryImpl(new ElfMage(), new ElfWarlord(), new ElfBeast());\n+ factory = new HeroFactoryImpl(new ElfMage(\"cooking\"), new ElfWarlord(\"cleaning\"), new ElfBeast(\"protecting\"));\n mage = factory.createMage();\n warlord = factory.createWarlord();\n beast = factory.createBeast();\n LOGGER.info(mage.toString());\n LOGGER.info(warlord.toString());\n LOGGER.info(beast.toString());\n \n- factory = new HeroFactoryImpl(new OrcMage(), new OrcWarlord(), new OrcBeast());\n+ factory = new HeroFactoryImpl(new OrcMage(\"axe\"), new OrcWarlord(\"sword\"), new OrcBeast(\"laser\"));\n mage = factory.createMage();\n warlord = factory.createWarlord();\n beast = factory.createBeast();",
"filename": "prototype/src/main/java/com/iluwatar/prototype/App.java",
"status": "modified"
},
{
"diff": "@@ -30,6 +30,6 @@\n public abstract class Beast extends Prototype {\n \n @Override\n- public abstract Beast clone() throws CloneNotSupportedException;\n+ public abstract Beast copy() throws CloneNotSupportedException;\n \n }",
"filename": "prototype/src/main/java/com/iluwatar/prototype/Beast.java",
"status": "modified"
},
{
"diff": "@@ -28,17 +28,25 @@\n *\n */\n public class ElfBeast extends Beast {\n+ \n+ private String helpType;\n \n- public ElfBeast() {}\n+ public ElfBeast(String helpType) {\n+ this.helpType = helpType;\n+ }\n+\n+ public ElfBeast(ElfBeast elfBeast) {\n+ this.helpType = elfBeast.helpType;\n+ }\n \n @Override\n- public Beast clone() throws CloneNotSupportedException {\n- return new ElfBeast();\n+ public Beast copy() throws CloneNotSupportedException {\n+ return new ElfBeast(this);\n }\n \n @Override\n public String toString() {\n- return \"Elven eagle\";\n+ return \"Elven eagle helps in \" + helpType;\n }\n \n }",
"filename": "prototype/src/main/java/com/iluwatar/prototype/ElfBeast.java",
"status": "modified"
},
{
"diff": "@@ -29,16 +29,25 @@\n */\n public class ElfMage extends Mage {\n \n- public ElfMage() {}\n+ \n+ private String helpType;\n+ \n+ public ElfMage(String helpType) {\n+ this.helpType = helpType;\n+ }\n+\n+ public ElfMage(ElfMage elfMage) {\n+ this.helpType = elfMage.helpType;\n+ }\n \n @Override\n- public Mage clone() throws CloneNotSupportedException {\n- return new ElfMage();\n+ public ElfMage copy() throws CloneNotSupportedException {\n+ return new ElfMage(this);\n }\n \n @Override\n public String toString() {\n- return \"Elven mage\";\n+ return \"Elven mage helps in \" + helpType;\n }\n \n }",
"filename": "prototype/src/main/java/com/iluwatar/prototype/ElfMage.java",
"status": "modified"
},
{
"diff": "@@ -29,16 +29,24 @@\n */\n public class ElfWarlord extends Warlord {\n \n- public ElfWarlord() {}\n+ private String helpType;\n+ \n+ public ElfWarlord(String helpType) {\n+ this.helpType = helpType;\n+ }\n+\n+ public ElfWarlord(ElfWarlord elfWarlord) {\n+ this.helpType = elfWarlord.helpType;\n+ }\n \n @Override\n- public Warlord clone() throws CloneNotSupportedException {\n- return new ElfWarlord();\n+ public ElfWarlord copy() throws CloneNotSupportedException {\n+ return new ElfWarlord(this);\n }\n \n @Override\n public String toString() {\n- return \"Elven warlord\";\n+ return \"Elven warlord helps in \" + helpType;\n }\n \n }",
"filename": "prototype/src/main/java/com/iluwatar/prototype/ElfWarlord.java",
"status": "modified"
},
{
"diff": "@@ -47,7 +47,7 @@ public HeroFactoryImpl(Mage mage, Warlord warlord, Beast beast) {\n */\r\n public Mage createMage() {\r\n try {\r\n- return mage.clone();\r\n+ return mage.copy();\r\n } catch (CloneNotSupportedException e) {\r\n return null;\r\n }\r\n@@ -58,7 +58,7 @@ public Mage createMage() {\n */\r\n public Warlord createWarlord() {\r\n try {\r\n- return warlord.clone();\r\n+ return warlord.copy();\r\n } catch (CloneNotSupportedException e) {\r\n return null;\r\n }\r\n@@ -69,7 +69,7 @@ public Warlord createWarlord() {\n */\r\n public Beast createBeast() {\r\n try {\r\n- return beast.clone();\r\n+ return beast.copy();\r\n } catch (CloneNotSupportedException e) {\r\n return null;\r\n }\r",
"filename": "prototype/src/main/java/com/iluwatar/prototype/HeroFactoryImpl.java",
"status": "modified"
},
{
"diff": "@@ -30,6 +30,6 @@\n public abstract class Mage extends Prototype {\n \n @Override\n- public abstract Mage clone() throws CloneNotSupportedException;\n+ public abstract Mage copy() throws CloneNotSupportedException;\n \n }",
"filename": "prototype/src/main/java/com/iluwatar/prototype/Mage.java",
"status": "modified"
},
{
"diff": "@@ -28,17 +28,26 @@\n *\n */\n public class OrcBeast extends Beast {\n+ \n+ private String weapon;\n \n- public OrcBeast() {}\n+ public OrcBeast(String weapon) {\n+ this.weapon = weapon;\n+ }\n+ \n+ public OrcBeast(OrcBeast orcBeast) {\n+ this.weapon = orcBeast.weapon;\n+ }\n \n @Override\n- public Beast clone() throws CloneNotSupportedException {\n- return new OrcBeast();\n+ public Beast copy() throws CloneNotSupportedException {\n+ return new OrcBeast(this);\n }\n \n @Override\n public String toString() {\n- return \"Orcish wolf\";\n+ return \"Orcish wolf attacks with \" + weapon;\n }\n+ \n \n }",
"filename": "prototype/src/main/java/com/iluwatar/prototype/OrcBeast.java",
"status": "modified"
},
{
"diff": "@@ -29,16 +29,24 @@\n */\n public class OrcMage extends Mage {\n \n- public OrcMage() {}\n+ private String weapon;\n+\n+ public OrcMage(String weapon) {\n+ this.weapon = weapon;\n+ }\n+ \n+ public OrcMage(OrcMage orcMage) {\n+ this.weapon = orcMage.weapon;\n+ }\n \n @Override\n- public Mage clone() throws CloneNotSupportedException {\n- return new OrcMage();\n+ public OrcMage copy() throws CloneNotSupportedException {\n+ return new OrcMage(this);\n }\n \n @Override\n public String toString() {\n- return \"Orcish mage\";\n+ return \"Orcish mage attacks with \" + weapon;\n }\n \n }",
"filename": "prototype/src/main/java/com/iluwatar/prototype/OrcMage.java",
"status": "modified"
},
{
"diff": "@@ -29,16 +29,24 @@\n */\n public class OrcWarlord extends Warlord {\n \n- public OrcWarlord() {}\n+ private String weapon;\n+\n+ public OrcWarlord(String weapon) {\n+ this.weapon = weapon;\n+ }\n+ \n+ public OrcWarlord(OrcWarlord orcWarlord) {\n+ this.weapon = orcWarlord.weapon;\n+ }\n \n @Override\n- public Warlord clone() throws CloneNotSupportedException {\n- return new OrcWarlord();\n+ public OrcWarlord copy() throws CloneNotSupportedException {\n+ return new OrcWarlord(this);\n }\n \n @Override\n public String toString() {\n- return \"Orcish warlord\";\n+ return \"Orcish warlord attacks with \" + weapon;\n }\n \n }",
"filename": "prototype/src/main/java/com/iluwatar/prototype/OrcWarlord.java",
"status": "modified"
},
{
"diff": "@@ -29,7 +29,6 @@\n */\n public abstract class Prototype implements Cloneable {\n \n- @Override\n- public abstract Object clone() throws CloneNotSupportedException;\n+ public abstract Object copy() throws CloneNotSupportedException;\n \n }",
"filename": "prototype/src/main/java/com/iluwatar/prototype/Prototype.java",
"status": "modified"
},
{
"diff": "@@ -30,6 +30,6 @@\n public abstract class Warlord extends Prototype {\n \n @Override\n- public abstract Warlord clone() throws CloneNotSupportedException;\n+ public abstract Warlord copy() throws CloneNotSupportedException;\n \n }",
"filename": "prototype/src/main/java/com/iluwatar/prototype/Warlord.java",
"status": "modified"
},
{
"diff": "@@ -43,18 +43,18 @@ public void testFactory() throws Exception {\n final Warlord warlord = mock(Warlord.class);\n final Beast beast = mock(Beast.class);\n \n- when(mage.clone()).thenThrow(CloneNotSupportedException.class);\n- when(warlord.clone()).thenThrow(CloneNotSupportedException.class);\n- when(beast.clone()).thenThrow(CloneNotSupportedException.class);\n+ when(mage.copy()).thenThrow(CloneNotSupportedException.class);\n+ when(warlord.copy()).thenThrow(CloneNotSupportedException.class);\n+ when(beast.copy()).thenThrow(CloneNotSupportedException.class);\n \n final HeroFactoryImpl factory = new HeroFactoryImpl(mage, warlord, beast);\n assertNull(factory.createMage());\n assertNull(factory.createWarlord());\n assertNull(factory.createBeast());\n \n- verify(mage).clone();\n- verify(warlord).clone();\n- verify(beast).clone();\n+ verify(mage).copy();\n+ verify(warlord).copy();\n+ verify(beast).copy();\n verifyNoMoreInteractions(mage, warlord, beast);\n }\n ",
"filename": "prototype/src/test/java/com/iluwatar/prototype/HeroFactoryImplTest.java",
"status": "modified"
},
{
"diff": "@@ -41,12 +41,12 @@\n public class PrototypeTest<P extends Prototype> {\n static Collection<Object[]> dataProvider() {\n return Arrays.asList(\n- new Object[]{new OrcBeast(), \"Orcish wolf\"},\n- new Object[]{new OrcMage(), \"Orcish mage\"},\n- new Object[]{new OrcWarlord(), \"Orcish warlord\"},\n- new Object[]{new ElfBeast(), \"Elven eagle\"},\n- new Object[]{new ElfMage(), \"Elven mage\"},\n- new Object[]{new ElfWarlord(), \"Elven warlord\"}\n+ new Object[]{new OrcBeast(\"axe\"), \"Orcish wolf attacks with axe\"},\n+ new Object[]{new OrcMage(\"sword\"), \"Orcish mage attacks with sword\"},\n+ new Object[]{new OrcWarlord(\"laser\"), \"Orcish warlord attacks with laser\"},\n+ new Object[]{new ElfBeast(\"cooking\"), \"Elven eagle helps in cooking\"},\n+ new Object[]{new ElfMage(\"cleaning\"), \"Elven mage helps in cleaning\"},\n+ new Object[]{new ElfWarlord(\"protecting\"), \"Elven warlord helps in protecting\"}\n );\n }\n \n@@ -55,7 +55,7 @@ static Collection<Object[]> dataProvider() {\n public void testPrototype(P testedPrototype, String expectedToString) throws Exception {\n assertEquals(expectedToString, testedPrototype.toString());\n \n- final Object clone = testedPrototype.clone();\n+ final Object clone = testedPrototype.copy();\n assertNotNull(clone);\n assertNotSame(clone, testedPrototype);\n assertSame(testedPrototype.getClass(), clone.getClass());",
"filename": "prototype/src/test/java/com/iluwatar/prototype/PrototypeTest.java",
"status": "modified"
}
]
} |
{
"body": "Seems like lastServedId field from LoadBlanacer.class is shared among all instances.\r\nI think this is not threadsafe and will crash when mutiple threads will try to increment it.\r\n\r\nhttps://github.com/iluwatar/java-design-patterns/blob/390c33e36e82b558e8cab6028d96e49c0a20da9f/monostate/src/main/java/com/iluwatar/monostate/LoadBalancer.java#L39",
"comments": [
{
"body": "@Krandelbord You are correct. It is not thread safe as field is being shared without synchronization. Can you raise a PR with the fix?",
"created_at": "2017-11-17T09:22:56Z"
},
{
"body": "Perhaps change to atomicInteger?!",
"created_at": "2017-11-18T09:03:19Z"
},
{
"body": "If I use AtomicInteger then I have to make reading, comparing, incrementing, and setting to zero as one atomic operation.\r\nIt will end up in something like that\r\n```\r\nprivate static AtomicInteger lastServedId = new AtomicInteger();\r\n public void serverRequest(Request request) {\r\n int serverIdToUse = lastServedId.getAndUpdate((lastServedId) -> lastServedId < servers.size() - 1 ? ++lastServedId : 0);\r\n Server server = servers.get(serverIdToUse);\r\n server.serve(request);\r\n }\r\n```\r\nDoesn't look good. So I decided to make method synchronized.",
"created_at": "2017-11-19T11:09:47Z"
},
{
"body": "Is Volatile a Solution?!",
"created_at": "2017-11-21T05:36:02Z"
},
{
"body": "No, ```volatile``` is not suitable for cases where you want to read-update-write as an atomic operation; access to a volatile variable never has the potential to block: you're only ever doing a simple read or write ([source](https://www.javamex.com/tutorials/synchronization_volatile.shtml)).\r\n\r\nSince we're doing changes in this class, could you also fix the misleading variable name ```serverIdToUse```: the value has nothing to do with the actual identifier of the server, it is just the index of the next server to use from ```List<Server> servers```",
"created_at": "2017-11-27T20:34:57Z"
}
],
"number": 666,
"title": "Is it threadsafe ? "
} | {
"body": "fixes #666 to make it threadsafe\r\nBTW: Moved id to static initizalizer block since it used only here.",
"number": 668,
"review_comments": [],
"title": "added synchronized keyword to method that reads from server poll"
} | {
"commits": [
{
"message": "added synchronized keyword to method that reads from server poll"
}
],
"files": [
{
"diff": "@@ -35,10 +35,10 @@\n \n public class LoadBalancer {\n private static List<Server> servers = new ArrayList<>();\n- private static int id;\n private static int lastServedId;\n \n static {\n+ int id = 0;\n servers.add(new Server(\"localhost\", 8081, ++id));\n servers.add(new Server(\"localhost\", 8080, ++id));\n servers.add(new Server(\"localhost\", 8082, ++id));\n@@ -67,14 +67,12 @@ public static int getLastServedId() {\n /**\n * Handle request\n */\n- public void serverRequest(Request request) {\n+ public synchronized void serverRequest(Request request) {\n if (lastServedId >= servers.size()) {\n lastServedId = 0;\n }\n Server server = servers.get(lastServedId++);\n server.serve(request);\n }\n-\n-\n-\n+ \n }",
"filename": "monostate/src/main/java/com/iluwatar/monostate/LoadBalancer.java",
"status": "modified"
}
]
} |
{
"body": "Hello!\r\n\r\nThank you for your work.\r\nI found one small problem in command pattern. I agree that code should be light as possible and some details may be ommited, but examples should be correct.\r\nProblem: InvisibilitySpell and ShrinkSpell have incorrect redo and undo mechanism. For example: if you execute ShrinkSpeel 2 times Goblin will never return to Big size.\r\nI think we should add stack of states in commands to properly handle redo and undo operations.",
"comments": [
{
"body": "@iluwatar I'd like to work on this.\r\n\r\nThe Size enumerated type has small, medium, large, and undefined. It seems that only small and medium are ever used. Should \"large\" and \"undefined\" be removed? Or should the goblin start out large?",
"created_at": "2017-05-27T14:25:07Z"
},
{
"body": "Ok @mattj256 you can start work on this. I think we can remove the unused enumerations.",
"created_at": "2017-05-29T17:41:46Z"
},
{
"body": "@iluwatar A Goblin initially starts with `NORMAL` size. Casting a shrink spell will make it `SMALL`. What if a shrink spell is casted again? Should size be cyclic e.g. `Small -> Normal -> Large -> Small`? Or, if Goblin is already `SMALL`, casting shrink spell should not work?",
"created_at": "2017-09-21T15:08:48Z"
},
{
"body": "@dosdebug I would say shrink spell makes smaller until the smallest possible (SMALL) after which it has no effect.",
"created_at": "2017-09-21T17:53:03Z"
},
{
"body": "@iluwatar Sure, a PR is submitted to you. Please see when you have time.",
"created_at": "2017-09-22T02:26:36Z"
}
],
"number": 547,
"title": "Incorrect history stack handling in command pattern"
} | {
"body": "This PR is related to #547 which seems not a question to me but removed unused enumerations to avoid misunderstanding.",
"number": 641,
"review_comments": [
{
"body": "Is there any use for keeping this constructor explicitly?",
"created_at": "2017-09-25T11:27:53Z"
},
{
"body": "Not really but I wanted to keep the change as small as possible.",
"created_at": "2017-09-25T16:34:05Z"
},
{
"body": "Yes, we should probably remove it.",
"created_at": "2017-09-26T04:35:14Z"
}
],
"title": "Removes unused size and visibility enumerations"
} | {
"commits": [
{
"message": "Removes unused size and visibility enumerations"
}
],
"files": [
{
"diff": "@@ -29,7 +29,7 @@\n */\r\n public enum Size {\r\n \r\n- SMALL(\"small\"), NORMAL(\"normal\"), LARGE(\"large\"), UNDEFINED(\"\");\r\n+ SMALL(\"small\"), NORMAL(\"normal\");\r\n \r\n private String title;\r\n \r",
"filename": "command/src/main/java/com/iluwatar/command/Size.java",
"status": "modified"
},
{
"diff": "@@ -29,7 +29,7 @@\n */\r\n public enum Visibility {\r\n \r\n- VISIBLE(\"visible\"), INVISIBLE(\"invisible\"), UNDEFINED(\"\");\r\n+ VISIBLE(\"visible\"), INVISIBLE(\"invisible\");\r\n \r\n private String title;\r\n \r",
"filename": "command/src/main/java/com/iluwatar/command/Visibility.java",
"status": "modified"
},
{
"diff": "@@ -40,7 +40,9 @@ public class Wizard {\n private Deque<Command> undoStack = new LinkedList<>();\n private Deque<Command> redoStack = new LinkedList<>();\n \n- public Wizard() {}\n+ public Wizard() {\n+ // comment to ignore sonar issue: LEVEL critical\n+ }\n \n /**\n * Cast spell",
"filename": "command/src/main/java/com/iluwatar/command/Wizard.java",
"status": "modified"
}
]
} |
{
"body": "When using the search box on the [patterns](http://java-design-patterns.com/patterns/) site I wanted to see the Prototype pattern. \r\n\r\nI started writing:\r\n- `p` - not much changed\r\n- `r` - the same\r\n- `o` - every pattern disappeared\r\n- this continues until `p`\r\n- `p` - 3 patterns appear: `Naked Objects` (how?), `Property` and `Prototype`\r\n- `e` - still 3 patterns appearing\r\n\r\nWhy does searching act so weird? I suppose this is a bug",
"comments": [
{
"body": "Ping @markusmo3 ",
"created_at": "2017-08-10T05:43:31Z"
},
{
"body": "Its a black box... magic... i dont understand myself ^^\r\nAnyone is free to try and fix it!\r\n\r\nHere some important parts:\r\n* it uses elasticlunr.com\r\n* https://github.com/iluwatar/java-design-patterns/blob/gh-pages/search_index.json\r\n* https://github.com/iluwatar/java-design-patterns/blob/gh-pages/static/js/search.js\r\n* https://github.com/iluwatar/java-design-patterns/blob/98827c9537ef868fda01868b2f6dc91d28b2a36c/pages/patterns.html#L18-L24",
"created_at": "2017-08-23T15:37:53Z"
},
{
"body": "Thanks @markusmo3 looks like nice puzzle :smile: ",
"created_at": "2017-08-23T18:44:58Z"
},
{
"body": "I took a stab at this and realized that replacing it with Lunr which supports wildcard searches makes it possible to search by shorter substrings.\r\n\r\nAdditionally, I removed the index boosts on certain fields, as they were never used anyway - they don't affect what is being returned by the query, only the score field in the result items and so far, this field isn't used by this application",
"created_at": "2017-09-01T03:58:44Z"
},
{
"body": "@danielsiwiec see https://github.com/iluwatar/java-design-patterns/issues/653 Any idea what is going on?",
"created_at": "2017-10-08T20:22:26Z"
}
],
"number": 607,
"title": "Searching for patterns doesn't work as expected"
} | {
"body": "Addresses issue #607",
"number": 625,
"review_comments": [],
"title": "Replace elasticlunr with lunr as it allows wildcard searches #607"
} | {
"commits": [
{
"message": "Replace elasticlunr with lunr as it allows wildcard searches #607"
},
{
"message": "fix lunr website url"
},
{
"message": "remove stemmer"
},
{
"message": "remove content and date from the search index"
}
],
"files": [
{
"diff": "@@ -14,7 +14,7 @@\n \n <!-- Only load Lunr if we are on the one pattern search page -->\n {% if url_parts[0] == \"patterns\" and url_parts.size == 1 %}\n- <script type=\"text/javascript\" src=\"{{ '/static/js/elasticlunr.min.js' | prepend: site.baseurl }}\"></script>\n+ <script type=\"text/javascript\" src=\"{{ '/static/js/lunr.min.js' | prepend: site.baseurl }}\"></script>\n <script type=\"text/javascript\" src=\"{{ '/static/js/search.js' | prepend: site.baseurl }}\"></script>\n {% endif %}\n ",
"filename": "_includes/footerScripts.html",
"status": "modified"
},
{
"diff": "@@ -18,7 +18,7 @@\n <div class=\"list-item-search\">\n <div class=\"input-group\">\n <i class=\"fa fa-search input-group-addon\" aria-hidden=\"true\"\n- data-toggle=\"tooltip\" data-placement=\"left\" title=\"Powered by elasticlunr.com\"></i>\n+ data-toggle=\"tooltip\" data-placement=\"left\" title=\"Powered by lunrjs.com\"></i>\n <input type=\"text\" class=\"form-control\" id=\"searchBox\" placeholder=\"logging...\">\n </div>\n </div>",
"filename": "pages/patterns.html",
"status": "modified"
},
{
"diff": "@@ -0,0 +1 @@\n+!function(){var e=function(t){var r=new e.Builder;return r.pipeline.add(e.trimmer,e.stopWordFilter,e.stemmer),r.searchPipeline.add(e.stemmer),t.call(r,r),r.build()};e.version=\"2.1.3\",e.utils={},e.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),e.utils.asString=function(e){return void 0===e||null===e?\"\":e.toString()},e.FieldRef=function(t,r){this.docRef=t,this.fieldName=r,this._stringValue=r+e.FieldRef.joiner+t},e.FieldRef.joiner=\"/\",e.FieldRef.fromString=function(t){var r=t.indexOf(e.FieldRef.joiner);if(-1===r)throw\"malformed field ref string\";var i=t.slice(0,r),n=t.slice(r+1);return new e.FieldRef(n,i)},e.FieldRef.prototype.toString=function(){return this._stringValue},e.idf=function(e,t){var r=0;for(var i in e)\"_index\"!=i&&(r+=Object.keys(e[i]).length);var n=(t-r+.5)/(r+.5);return Math.log(1+Math.abs(n))},e.Token=function(e,t){this.str=e||\"\",this.metadata=t||{}},e.Token.prototype.toString=function(){return this.str},e.Token.prototype.update=function(e){return this.str=e(this.str,this.metadata),this},e.Token.prototype.clone=function(t){return t=t||function(e){return e},new e.Token(t(this.str,this.metadata),this.metadata)},e.tokenizer=function(t){if(null==t||void 0==t)return[];if(Array.isArray(t))return t.map(function(t){return new e.Token(e.utils.asString(t).toLowerCase())});for(var r=t.toString().trim().toLowerCase(),i=r.length,n=[],s=0,o=0;s<=i;s++){var a=s-o;(r.charAt(s).match(e.tokenizer.separator)||s==i)&&(a>0&&n.push(new e.Token(r.slice(o,s),{position:[o,a],index:n.length})),o=s+1)}return n},e.tokenizer.separator=/[\\s\\-]+/,e.Pipeline=function(){this._stack=[]},e.Pipeline.registeredFunctions=Object.create(null),e.Pipeline.registerFunction=function(t,r){r in this.registeredFunctions&&e.utils.warn(\"Overwriting existing registered function: \"+r),t.label=r,e.Pipeline.registeredFunctions[t.label]=t},e.Pipeline.warnIfFunctionNotRegistered=function(t){t.label&&t.label in this.registeredFunctions||e.utils.warn(\"Function is not registered with pipeline. This may cause problems when serialising the index.\\n\",t)},e.Pipeline.load=function(t){var r=new e.Pipeline;return t.forEach(function(t){var i=e.Pipeline.registeredFunctions[t];if(!i)throw new Error(\"Cannot load unregistered function: \"+t);r.add(i)}),r},e.Pipeline.prototype.add=function(){Array.prototype.slice.call(arguments).forEach(function(t){e.Pipeline.warnIfFunctionNotRegistered(t),this._stack.push(t)},this)},e.Pipeline.prototype.after=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(-1==i)throw new Error(\"Cannot find existingFn\");i+=1,this._stack.splice(i,0,r)},e.Pipeline.prototype.before=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(-1==i)throw new Error(\"Cannot find existingFn\");this._stack.splice(i,0,r)},e.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);-1!=t&&this._stack.splice(t,1)},e.Pipeline.prototype.run=function(e){for(var t=this._stack.length,r=0;r<t;r++){var i=this._stack[r];e=e.reduce(function(t,r,n){var s=i(r,n,e);return void 0===s||\"\"===s?t:t.concat(s)},[])}return e},e.Pipeline.prototype.runString=function(t){var r=new e.Token(t);return this.run([r]).map(function(e){return e.toString()})},e.Pipeline.prototype.reset=function(){this._stack=[]},e.Pipeline.prototype.toJSON=function(){return this._stack.map(function(t){return e.Pipeline.warnIfFunctionNotRegistered(t),t.label})},e.Vector=function(e){this._magnitude=0,this.elements=e||[]},e.Vector.prototype.positionForIndex=function(e){if(0==this.elements.length)return 0;for(var t=0,r=this.elements.length/2,i=r-t,n=Math.floor(i/2),s=this.elements[2*n];i>1&&(s<e&&(t=n),s>e&&(r=n),s!=e);)i=r-t,n=t+Math.floor(i/2),s=this.elements[2*n];return s==e?2*n:s>e?2*n:s<e?2*(n+1):void 0},e.Vector.prototype.insert=function(e,t){this.upsert(e,t,function(){throw\"duplicate index\"})},e.Vector.prototype.upsert=function(e,t,r){this._magnitude=0;var i=this.positionForIndex(e);this.elements[i]==e?this.elements[i+1]=r(this.elements[i+1],t):this.elements.splice(i,0,e,t)},e.Vector.prototype.magnitude=function(){if(this._magnitude)return this._magnitude;for(var e=0,t=this.elements.length,r=1;r<t;r+=2){var i=this.elements[r];e+=i*i}return this._magnitude=Math.sqrt(e)},e.Vector.prototype.dot=function(e){for(var t=0,r=this.elements,i=e.elements,n=r.length,s=i.length,o=0,a=0,u=0,l=0;u<n&&l<s;)(o=r[u])<(a=i[l])?u+=2:o>a?l+=2:o==a&&(t+=r[u+1]*i[l+1],u+=2,l+=2);return t},e.Vector.prototype.similarity=function(e){return this.dot(e)/(this.magnitude()*e.magnitude())},e.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,r=0;t<this.elements.length;t+=2,r++)e[r]=this.elements[t];return e},e.Vector.prototype.toJSON=function(){return this.elements},e.stemmer=function(){var e={ational:\"ate\",tional:\"tion\",enci:\"ence\",anci:\"ance\",izer:\"ize\",bli:\"ble\",alli:\"al\",entli:\"ent\",eli:\"e\",ousli:\"ous\",ization:\"ize\",ation:\"ate\",ator:\"ate\",alism:\"al\",iveness:\"ive\",fulness:\"ful\",ousness:\"ous\",aliti:\"al\",iviti:\"ive\",biliti:\"ble\",logi:\"log\"},t={icate:\"ic\",ative:\"\",alize:\"al\",iciti:\"ic\",ical:\"ic\",ful:\"\",ness:\"\"},r=\"[aeiouy]\",i=\"[^aeiou][^aeiouy]*\",n=new RegExp(\"^([^aeiou][^aeiouy]*)?[aeiouy][aeiou]*[^aeiou][^aeiouy]*\"),s=new RegExp(\"^([^aeiou][^aeiouy]*)?[aeiouy][aeiou]*[^aeiou][^aeiouy]*[aeiouy][aeiou]*[^aeiou][^aeiouy]*\"),o=new RegExp(\"^([^aeiou][^aeiouy]*)?[aeiouy][aeiou]*[^aeiou][^aeiouy]*([aeiouy][aeiou]*)?$\"),a=new RegExp(\"^([^aeiou][^aeiouy]*)?[aeiouy]\"),u=/^(.+?)(ss|i)es$/,l=/^(.+?)([^s])s$/,d=/^(.+?)eed$/,h=/^(.+?)(ed|ing)$/,c=/.$/,f=/(at|bl|iz)$/,p=new RegExp(\"([^aeiouylsz])\\\\1$\"),y=new RegExp(\"^\"+i+r+\"[^aeiouwxy]$\"),m=/^(.+?[^aeiou])y$/,g=/^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/,x=/^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/,v=/^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/,w=/^(.+?)(s|t)(ion)$/,k=/^(.+?)e$/,Q=/ll$/,L=new RegExp(\"^\"+i+r+\"[^aeiouwxy]$\"),T=function(r){var i,T,S,b,P,E,I;if(r.length<3)return r;if(\"y\"==(S=r.substr(0,1))&&(r=S.toUpperCase()+r.substr(1)),b=u,P=l,b.test(r)?r=r.replace(b,\"$1$2\"):P.test(r)&&(r=r.replace(P,\"$1$2\")),b=d,P=h,b.test(r)){var F=b.exec(r);(b=n).test(F[1])&&(b=c,r=r.replace(b,\"\"))}else P.test(r)&&(i=(F=P.exec(r))[1],(P=a).test(i)&&(r=i,E=p,I=y,(P=f).test(r)?r+=\"e\":E.test(r)?(b=c,r=r.replace(b,\"\")):I.test(r)&&(r+=\"e\")));return(b=m).test(r)&&(r=(i=(F=b.exec(r))[1])+\"i\"),(b=g).test(r)&&(i=(F=b.exec(r))[1],T=F[2],(b=n).test(i)&&(r=i+e[T])),(b=x).test(r)&&(i=(F=b.exec(r))[1],T=F[2],(b=n).test(i)&&(r=i+t[T])),b=v,P=w,b.test(r)?(i=(F=b.exec(r))[1],(b=s).test(i)&&(r=i)):P.test(r)&&(i=(F=P.exec(r))[1]+F[2],(P=s).test(i)&&(r=i)),(b=k).test(r)&&(i=(F=b.exec(r))[1],P=o,E=L,((b=s).test(i)||P.test(i)&&!E.test(i))&&(r=i)),b=Q,P=s,b.test(r)&&P.test(r)&&(b=c,r=r.replace(b,\"\")),\"y\"==S&&(r=S.toLowerCase()+r.substr(1)),r};return function(e){return e.update(T)}}(),e.Pipeline.registerFunction(e.stemmer,\"stemmer\"),e.generateStopWordFilter=function(e){var t=e.reduce(function(e,t){return e[t]=t,e},{});return function(e){if(e&&t[e.toString()]!==e.toString())return e}},e.stopWordFilter=e.generateStopWordFilter([\"a\",\"able\",\"about\",\"across\",\"after\",\"all\",\"almost\",\"also\",\"am\",\"among\",\"an\",\"and\",\"any\",\"are\",\"as\",\"at\",\"be\",\"because\",\"been\",\"but\",\"by\",\"can\",\"cannot\",\"could\",\"dear\",\"did\",\"do\",\"does\",\"either\",\"else\",\"ever\",\"every\",\"for\",\"from\",\"get\",\"got\",\"had\",\"has\",\"have\",\"he\",\"her\",\"hers\",\"him\",\"his\",\"how\",\"however\",\"i\",\"if\",\"in\",\"into\",\"is\",\"it\",\"its\",\"just\",\"least\",\"let\",\"like\",\"likely\",\"may\",\"me\",\"might\",\"most\",\"must\",\"my\",\"neither\",\"no\",\"nor\",\"not\",\"of\",\"off\",\"often\",\"on\",\"only\",\"or\",\"other\",\"our\",\"own\",\"rather\",\"said\",\"say\",\"says\",\"she\",\"should\",\"since\",\"so\",\"some\",\"than\",\"that\",\"the\",\"their\",\"them\",\"then\",\"there\",\"these\",\"they\",\"this\",\"tis\",\"to\",\"too\",\"twas\",\"us\",\"wants\",\"was\",\"we\",\"were\",\"what\",\"when\",\"where\",\"which\",\"while\",\"who\",\"whom\",\"why\",\"will\",\"with\",\"would\",\"yet\",\"you\",\"your\"]),e.Pipeline.registerFunction(e.stopWordFilter,\"stopWordFilter\"),e.trimmer=function(e){return e.update(function(e){return e.replace(/^\\W+/,\"\").replace(/\\W+$/,\"\")})},e.Pipeline.registerFunction(e.trimmer,\"trimmer\"),e.TokenSet=function(){this.final=!1,this.edges={},this.id=e.TokenSet._nextId,e.TokenSet._nextId+=1},e.TokenSet._nextId=1,e.TokenSet.fromArray=function(t){for(var r=new e.TokenSet.Builder,i=0,n=t.length;i<n;i++)r.insert(t[i]);return r.finish(),r.root},e.TokenSet.fromClause=function(t){return\"editDistance\"in t?e.TokenSet.fromFuzzyString(t.term,t.editDistance):e.TokenSet.fromString(t.term)},e.TokenSet.fromFuzzyString=function(t,r){for(var i=new e.TokenSet,n=[{node:i,editsRemaining:r,str:t}];n.length;){var s=n.pop();if(s.str.length>0){var o;(u=s.str.charAt(0))in s.node.edges?o=s.node.edges[u]:(o=new e.TokenSet,s.node.edges[u]=o),1==s.str.length?o.final=!0:n.push({node:o,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining>0&&s.str.length>1){var a,u=s.str.charAt(1);u in s.node.edges?a=s.node.edges[u]:(a=new e.TokenSet,s.node.edges[u]=a),s.str.length<=2?a.final=!0:n.push({node:a,editsRemaining:s.editsRemaining-1,str:s.str.slice(2)})}if(s.editsRemaining>0&&1==s.str.length&&(s.node.final=!0),s.editsRemaining>0&&s.str.length>=1){if(\"*\"in s.node.edges)l=s.node.edges[\"*\"];else{var l=new e.TokenSet;s.node.edges[\"*\"]=l}1==s.str.length?l.final=!0:n.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.editsRemaining>0){if(\"*\"in s.node.edges)d=s.node.edges[\"*\"];else{var d=new e.TokenSet;s.node.edges[\"*\"]=d}0==s.str.length?d.final=!0:n.push({node:d,editsRemaining:s.editsRemaining-1,str:s.str})}if(s.editsRemaining>0&&s.str.length>1){var h,c=s.str.charAt(0),f=s.str.charAt(1);f in s.node.edges?h=s.node.edges[f]:(h=new e.TokenSet,s.node.edges[f]=h),1==s.str.length?h.final=!0:n.push({node:h,editsRemaining:s.editsRemaining-1,str:c+s.str.slice(2)})}}return i},e.TokenSet.fromString=function(t){for(var r=new e.TokenSet,i=r,n=!1,s=0,o=t.length;s<o;s++){var a=t[s],u=s==o-1;if(\"*\"==a)n=!0,r.edges[a]=r,r.final=u;else{var l=new e.TokenSet;l.final=u,r.edges[a]=l,r=l,n&&(r.edges[\"*\"]=i)}}return i},e.TokenSet.prototype.toArray=function(){for(var e=[],t=[{prefix:\"\",node:this}];t.length;){var r=t.pop(),i=Object.keys(r.node.edges),n=i.length;r.node.final&&e.push(r.prefix);for(var s=0;s<n;s++){var o=i[s];t.push({prefix:r.prefix.concat(o),node:r.node.edges[o]})}}return e},e.TokenSet.prototype.toString=function(){if(this._str)return this._str;for(var e=this.final?\"1\":\"0\",t=Object.keys(this.edges).sort(),r=t.length,i=0;i<r;i++){var n=t[i];e=e+n+this.edges[n].id}return e},e.TokenSet.prototype.intersect=function(t){for(var r=new e.TokenSet,i=void 0,n=[{qNode:t,output:r,node:this}];n.length;){i=n.pop();for(var s=Object.keys(i.qNode.edges),o=s.length,a=Object.keys(i.node.edges),u=a.length,l=0;l<o;l++)for(var d=s[l],h=0;h<u;h++){var c=a[h];if(c==d||\"*\"==d){var f=i.node.edges[c],p=i.qNode.edges[d],y=f.final&&p.final,m=void 0;c in i.output.edges?(m=i.output.edges[c]).final=m.final||y:((m=new e.TokenSet).final=y,i.output.edges[c]=m),n.push({qNode:p,output:m,node:f})}}}return r},e.TokenSet.Builder=function(){this.previousWord=\"\",this.root=new e.TokenSet,this.uncheckedNodes=[],this.minimizedNodes={}},e.TokenSet.Builder.prototype.insert=function(t){var r,i=0;if(t<this.previousWord)throw new Error(\"Out of order word insertion\");for(n=0;n<t.length&&n<this.previousWord.length&&t[n]==this.previousWord[n];n++)i++;this.minimize(i),r=0==this.uncheckedNodes.length?this.root:this.uncheckedNodes[this.uncheckedNodes.length-1].child;for(var n=i;n<t.length;n++){var s=new e.TokenSet,o=t[n];r.edges[o]=s,this.uncheckedNodes.push({parent:r,char:o,child:s}),r=s}r.final=!0,this.previousWord=t},e.TokenSet.Builder.prototype.finish=function(){this.minimize(0)},e.TokenSet.Builder.prototype.minimize=function(e){for(var t=this.uncheckedNodes.length-1;t>=e;t--){var r=this.uncheckedNodes[t],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}},e.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},e.Index.prototype.search=function(t){return this.query(function(r){new e.QueryParser(t,r).parse()})},e.Index.prototype.query=function(t){var r=new e.Query(this.fields),i=Object.create(null),n=Object.create(null);t.call(r,r);for(b=0;b<r.clauses.length;b++){var s=r.clauses[b],o=null;o=s.usePipeline?this.pipeline.runString(s.term):[s.term];for(var a=0;a<o.length;a++){var u=o[a];s.term=u;for(var l=e.TokenSet.fromClause(s),d=this.tokenSet.intersect(l).toArray(),h=0;h<d.length;h++)for(var c=d[h],f=this.invertedIndex[c],p=f._index,y=0;y<s.fields.length;y++){var m=s.fields[y],g=f[m],x=Object.keys(g);m in n||(n[m]=new e.Vector),n[m].upsert(p,1*s.boost,function(e,t){return e+t});for(var v=0;v<x.length;v++){var w,k,Q=x[v],L=new e.FieldRef(Q,m);w=g[Q],k=new e.MatchData(c,m,w),L in i?i[L].combine(k):i[L]=k}}}}for(var T=Object.keys(i),S={},b=0;b<T.length;b++){var P=e.FieldRef.fromString(T[b]),E=P.docRef,I=this.fieldVectors[P],F=n[P.fieldName].similarity(I);E in S?(S[E].score+=F,S[E].matchData.combine(i[P])):S[E]={ref:E,score:F,matchData:i[P]}}return Object.keys(S).map(function(e){return S[e]}).sort(function(e,t){return t.score-e.score})},e.Index.prototype.toJSON=function(){var t=Object.keys(this.invertedIndex).sort().map(function(e){return[e,this.invertedIndex[e]]},this),r=Object.keys(this.fieldVectors).map(function(e){return[e,this.fieldVectors[e].toJSON()]},this);return{version:e.version,fields:this.fields,fieldVectors:r,invertedIndex:t,pipeline:this.pipeline.toJSON()}},e.Index.load=function(t){var r={},i={},n=t.fieldVectors,s={},o=t.invertedIndex,a=new e.TokenSet.Builder,u=e.Pipeline.load(t.pipeline);t.version!=e.version&&e.utils.warn(\"Version mismatch when loading serialised index. Current version of lunr '\"+e.version+\"' does not match serialized index '\"+t.version+\"'\");for(h=0;h<n.length;h++){var l=(c=n[h])[0],d=c[1];i[l]=new e.Vector(d)}for(var h=0;h<o.length;h++){var c=o[h],f=c[0],p=c[1];a.insert(f),s[f]=p}return a.finish(),r.fields=t.fields,r.fieldVectors=i,r.invertedIndex=s,r.tokenSet=a.root,r.pipeline=u,new e.Index(r)},e.Builder=function(){this._ref=\"id\",this._fields=[],this.invertedIndex=Object.create(null),this.fieldTermFrequencies={},this.fieldLengths={},this.tokenizer=e.tokenizer,this.pipeline=new e.Pipeline,this.searchPipeline=new e.Pipeline,this.documentCount=0,this._b=.75,this._k1=1.2,this.termIndex=0,this.metadataWhitelist=[]},e.Builder.prototype.ref=function(e){this._ref=e},e.Builder.prototype.field=function(e){this._fields.push(e)},e.Builder.prototype.b=function(e){this._b=e<0?0:e>1?1:e},e.Builder.prototype.k1=function(e){this._k1=e},e.Builder.prototype.add=function(t){var r=t[this._ref];this.documentCount+=1;for(var i=0;i<this._fields.length;i++){var n=this._fields[i],s=t[n],o=this.tokenizer(s),a=this.pipeline.run(o),u=new e.FieldRef(r,n),l=Object.create(null);this.fieldTermFrequencies[u]=l,this.fieldLengths[u]=0,this.fieldLengths[u]+=a.length;for(var d=0;d<a.length;d++){var h=a[d];if(void 0==l[h]&&(l[h]=0),l[h]+=1,void 0==this.invertedIndex[h]){var c=Object.create(null);c._index=this.termIndex,this.termIndex+=1;for(var f=0;f<this._fields.length;f++)c[this._fields[f]]=Object.create(null);this.invertedIndex[h]=c}void 0==this.invertedIndex[h][n][r]&&(this.invertedIndex[h][n][r]=Object.create(null));for(var p=0;p<this.metadataWhitelist.length;p++){var y=this.metadataWhitelist[p],m=h.metadata[y];void 0==this.invertedIndex[h][n][r][y]&&(this.invertedIndex[h][n][r][y]=[]),this.invertedIndex[h][n][r][y].push(m)}}}},e.Builder.prototype.calculateAverageFieldLengths=function(){for(var t=Object.keys(this.fieldLengths),r=t.length,i={},n={},s=0;s<r;s++){var o=e.FieldRef.fromString(t[s]);n[a=o.fieldName]||(n[a]=0),n[a]+=1,i[a]||(i[a]=0),i[a]+=this.fieldLengths[o]}for(s=0;s<this._fields.length;s++){var a=this._fields[s];i[a]=i[a]/n[a]}this.averageFieldLength=i},e.Builder.prototype.createFieldVectors=function(){for(var t={},r=Object.keys(this.fieldTermFrequencies),i=r.length,n=0;n<i;n++){for(var s=e.FieldRef.fromString(r[n]),o=s.fieldName,a=this.fieldLengths[s],u=new e.Vector,l=this.fieldTermFrequencies[s],d=Object.keys(l),h=d.length,c=0;c<h;c++){var f=d[c],p=l[f],y=this.invertedIndex[f]._index,m=e.idf(this.invertedIndex[f],this.documentCount)*((this._k1+1)*p)/(this._k1*(1-this._b+this._b*(a/this.averageFieldLength[o]))+p),g=Math.round(1e3*m)/1e3;u.insert(y,g)}t[s]=u}this.fieldVectors=t},e.Builder.prototype.createTokenSet=function(){this.tokenSet=e.TokenSet.fromArray(Object.keys(this.invertedIndex).sort())},e.Builder.prototype.build=function(){return this.calculateAverageFieldLengths(),this.createFieldVectors(),this.createTokenSet(),new e.Index({invertedIndex:this.invertedIndex,fieldVectors:this.fieldVectors,tokenSet:this.tokenSet,fields:this._fields,pipeline:this.searchPipeline})},e.Builder.prototype.use=function(e){var t=Array.prototype.slice.call(arguments,1);t.unshift(this),e.apply(this,t)},e.MatchData=function(e,t,r){for(var i=Object.create(null),n=Object.keys(r),s=0;s<n.length;s++){var o=n[s];i[o]=r[o].slice()}this.metadata=Object.create(null),this.metadata[e]=Object.create(null),this.metadata[e][t]=i},e.MatchData.prototype.combine=function(e){for(var t=Object.keys(e.metadata),r=0;r<t.length;r++){var i=t[r],n=Object.keys(e.metadata[i]);void 0==this.metadata[i]&&(this.metadata[i]=Object.create(null));for(var s=0;s<n.length;s++){var o=n[s],a=Object.keys(e.metadata[i][o]);void 0==this.metadata[i][o]&&(this.metadata[i][o]=Object.create(null));for(var u=0;u<a.length;u++){var l=a[u];void 0==this.metadata[i][o][l]?this.metadata[i][o][l]=e.metadata[i][o][l]:this.metadata[i][o][l]=this.metadata[i][o][l].concat(e.metadata[i][o][l])}}}},e.Query=function(e){this.clauses=[],this.allFields=e},e.Query.wildcard=new String(\"*\"),e.Query.wildcard.NONE=0,e.Query.wildcard.LEADING=1,e.Query.wildcard.TRAILING=2,e.Query.prototype.clause=function(t){return\"fields\"in t||(t.fields=this.allFields),\"boost\"in t||(t.boost=1),\"usePipeline\"in t||(t.usePipeline=!0),\"wildcard\"in t||(t.wildcard=e.Query.wildcard.NONE),t.wildcard&e.Query.wildcard.LEADING&&t.term.charAt(0)!=e.Query.wildcard&&(t.term=\"*\"+t.term),t.wildcard&e.Query.wildcard.TRAILING&&t.term.slice(-1)!=e.Query.wildcard&&(t.term=t.term+\"*\"),this.clauses.push(t),this},e.Query.prototype.term=function(e,t){var r=t||{};return r.term=e,this.clause(r),this},e.QueryParseError=function(e,t,r){this.name=\"QueryParseError\",this.message=e,this.start=t,this.end=r},e.QueryParseError.prototype=new Error,e.QueryLexer=function(e){this.lexemes=[],this.str=e,this.length=e.length,this.pos=0,this.start=0,this.escapeCharPositions=[]},e.QueryLexer.prototype.run=function(){for(var t=e.QueryLexer.lexText;t;)t=t(this)},e.QueryLexer.prototype.sliceString=function(){for(var e=[],t=this.start,r=this.pos,i=0;i<this.escapeCharPositions.length;i++)r=this.escapeCharPositions[i],e.push(this.str.slice(t,r)),t=r+1;return e.push(this.str.slice(t,this.pos)),this.escapeCharPositions.length=0,e.join(\"\")},e.QueryLexer.prototype.emit=function(e){this.lexemes.push({type:e,str:this.sliceString(),start:this.start,end:this.pos}),this.start=this.pos},e.QueryLexer.prototype.escapeCharacter=function(){this.escapeCharPositions.push(this.pos-1),this.pos+=1},e.QueryLexer.prototype.next=function(){if(this.pos>=this.length)return e.QueryLexer.EOS;var t=this.str.charAt(this.pos);return this.pos+=1,t},e.QueryLexer.prototype.width=function(){return this.pos-this.start},e.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},e.QueryLexer.prototype.backup=function(){this.pos-=1},e.QueryLexer.prototype.acceptDigitRun=function(){var t,r;do{r=(t=this.next()).charCodeAt(0)}while(r>47&&r<58);t!=e.QueryLexer.EOS&&this.backup()},e.QueryLexer.prototype.more=function(){return this.pos<this.length},e.QueryLexer.EOS=\"EOS\",e.QueryLexer.FIELD=\"FIELD\",e.QueryLexer.TERM=\"TERM\",e.QueryLexer.EDIT_DISTANCE=\"EDIT_DISTANCE\",e.QueryLexer.BOOST=\"BOOST\",e.QueryLexer.lexField=function(t){return t.backup(),t.emit(e.QueryLexer.FIELD),t.ignore(),e.QueryLexer.lexText},e.QueryLexer.lexTerm=function(t){if(t.width()>1&&(t.backup(),t.emit(e.QueryLexer.TERM)),t.ignore(),t.more())return e.QueryLexer.lexText},e.QueryLexer.lexEditDistance=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.EDIT_DISTANCE),e.QueryLexer.lexText},e.QueryLexer.lexBoost=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.BOOST),e.QueryLexer.lexText},e.QueryLexer.lexEOS=function(t){t.width()>0&&t.emit(e.QueryLexer.TERM)},e.QueryLexer.termSeparator=e.tokenizer.separator,e.QueryLexer.lexText=function(t){for(;;){var r=t.next();if(r==e.QueryLexer.EOS)return e.QueryLexer.lexEOS;if(92!=r.charCodeAt(0)){if(\":\"==r)return e.QueryLexer.lexField;if(\"~\"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexEditDistance;if(\"^\"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexBoost;if(r.match(e.QueryLexer.termSeparator))return e.QueryLexer.lexTerm}else t.escapeCharacter()}},e.QueryParser=function(t,r){this.lexer=new e.QueryLexer(t),this.query=r,this.currentClause={},this.lexemeIdx=0},e.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var t=e.QueryParser.parseFieldOrTerm;t;)t=t(this);return this.query},e.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},e.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},e.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},e.QueryParser.parseFieldOrTerm=function(t){var r=t.peekLexeme();if(void 0!=r)switch(r.type){case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i=\"expected either a field or a term, found \"+r.type;throw r.str.length>=1&&(i+=\" with value '\"+r.str+\"'\"),new e.QueryParseError(i,r.start,r.end)}},e.QueryParser.parseField=function(t){var r=t.consumeLexeme();if(void 0!=r){if(-1==t.query.allFields.indexOf(r.str)){var i=t.query.allFields.map(function(e){return\"'\"+e+\"'\"}).join(\", \"),n=\"unrecognised field '\"+r.str+\"', possible fields: \"+i;throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.fields=[r.str];var s=t.peekLexeme();if(void 0==s){n=\"expecting term, found nothing\";throw new e.QueryParseError(n,r.start,r.end)}switch(s.type){case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:n=\"expecting term, found '\"+s.type+\"'\";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseTerm=function(t){var r=t.consumeLexeme();if(void 0!=r){t.currentClause.term=r.str.toLowerCase(),-1!=r.str.indexOf(\"*\")&&(t.currentClause.usePipeline=!1);var i=t.peekLexeme();if(void 0!=i)switch(i.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;default:var n=\"Unexpected lexeme type '\"+i.type+\"'\";throw new e.QueryParseError(n,i.start,i.end)}else t.nextClause()}},e.QueryParser.parseEditDistance=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){s=\"edit distance must be numeric\";throw new e.QueryParseError(s,r.start,r.end)}t.currentClause.editDistance=i;var n=t.peekLexeme();if(void 0!=n)switch(n.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;default:var s=\"Unexpected lexeme type '\"+n.type+\"'\";throw new e.QueryParseError(s,n.start,n.end)}else t.nextClause()}},e.QueryParser.parseBoost=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){s=\"boost must be numeric\";throw new e.QueryParseError(s,r.start,r.end)}t.currentClause.boost=i;var n=t.peekLexeme();if(void 0!=n)switch(n.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;default:var s=\"Unexpected lexeme type '\"+n.type+\"'\";throw new e.QueryParseError(s,n.start,n.end)}else t.nextClause()}},function(e,t){\"function\"==typeof define&&define.amd?define(t):\"object\"==typeof exports?module.exports=t():e.lunr=t()}(this,function(){return e})}();",
"filename": "static/js/lunr.min.js",
"status": "added"
},
{
"diff": "@@ -44,37 +44,28 @@ function initSidebar() {\n }\n \n function initLunrIndex() {\n- // Initalize lunr with the fields it will be searching on. I've given title\n- // a boost of 10 to indicate matches on this field are more important.\n- window.idx = elasticlunr(function() {\n- this.setRef('id');\n- this.addField('title', {\n- boost: 5\n- });\n- this.addField('category', {\n- boost: 3\n- });\n- this.addField('tags', {\n- boost: 3\n- });\n- this.addField('date');\n- this.addField('content', {\n- boost: 2\n- });\n- });\n-\n // Download the data from the JSON file we generated\n window.search_index = $.getJSON(\"{{ '/search_index.json' | prepend: site.baseurl }}\");\n \n // Wait for the data to load and add it to lunr\n window.search_index.then(function(loaded_data) {\n- $.each(loaded_data, function(index, value) {\n- window.idx.addDoc(\n- $.extend({\n- \"id\": index\n- }, value)\n- );\n- });\n+ window.idx = lunr(function() {\n+ // remove stemmer to prevent 'caching' to be mapped to 'cach'\n+ this.pipeline.remove(lunr.stemmer)\n+\n+ this.ref('id');\n+ this.field('title');\n+ this.field('category');\n+ this.field('tags');\n+\n+ loaded_data.forEach(function (doc, index) {\n+ this.add(\n+ $.extend({\n+ \"id\": index\n+ }, doc)\n+ );\n+ }, this)\n+ });\n });\n }\n \n@@ -113,22 +104,7 @@ function updateResults() {\n var intersectionQuery = catsQuery.filter(tagsQuery);\n \n var text = $('#searchBox').val();\n- var results = window.idx.search(text, {\n- fields: {\n- title: {\n- boost: 5\n- },\n- category: {\n- boost: 3\n- },\n- tags: {\n- boost: 3\n- },\n- content: {\n- boost: 2\n- }\n- }\n- });\n+ var results = window.idx.search(text + '*');\n \n window.search_index.then(function(loaded_data) {\n // Are there any results?",
"filename": "static/js/search.js",
"status": "modified"
}
]
} |
{
"body": "Something wrong with the ReaderWriterLock unit tests.\n\nSee Travis builds:\n\nhttps://travis-ci.org/iluwatar/java-design-patterns/builds/101906103\nhttps://travis-ci.org/iluwatar/java-design-patterns/builds/101915400\nhttps://travis-ci.org/iluwatar/java-design-patterns/builds/101917864\n",
"comments": [
{
"body": "From the log file of [Travis-Ci](https://api.travis-ci.org/jobs/101915401/log.txt?deansi=true), it pointouts that reader thread submited to the thread pool cannot be executed in 149(99+50)ms. I suspect that the Travis-Ci has a high load and it can't assume the read can executed in accurate time. I have revised the test case with another form. \n\n> Failed tests: \n> ReaderAndWriterTest.testReadAndWrite:45 \n> Wanted but not invoked:\n> reader.read();\n> -> at com.iluwatar.reader.writer.lock.ReaderAndWriterTest.testReadAndWrite(ReaderAndWriterTest.java:45)\n> \n> However, there were other interactions with this mock:\n> reader.run();\n> -> at java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:511)\n\n``` java\n @Test\n public void testReadAndWrite() throws Exception {\n\n ReaderWriterLock lock = new ReaderWriterLock();\n\n Reader reader1 = spy(new Reader(\"Reader 1\", lock.readLock()));\n Writer writer1 = spy(new Writer(\"Writer 1\", lock.writeLock()));\n\n executeService.submit(reader1);\n // Let reader1 execute first\n Thread.sleep(50);\n executeService.submit(writer1);\n\n45: verify(reader1, timeout(99).atLeastOnce()).read();\n verify(writer1, after(10).never()).write();\n verify(writer1, timeout(100).atLeastOnce()).write();\n\n }\n```\n",
"created_at": "2016-01-13T01:29:31Z"
},
{
"body": "@hoswey just create pull request when ready\n",
"created_at": "2016-01-13T19:19:27Z"
}
],
"number": 343,
"title": "ReaderWriterLock unit tests fail on CI"
} | {
"body": "fix issue #343 ReaderWriterLock unit tests fail on CI\n",
"number": 344,
"review_comments": [],
"title": "fix issue #343 ReaderWriterLock unit tests fail on CI"
} | {
"commits": [
{
"message": "fix issue #343 ReaderWriterLock unit tests fail on CI"
}
],
"files": [
{
"diff": "@@ -18,8 +18,7 @@\n * readers will be blocked until the writer is finished writing.\n * \n * <p>\n- * This example use two mutex to demonstrate the concurrent access of multiple readers and\n- * writers.\n+ * This example use two mutex to demonstrate the concurrent access of multiple readers and writers.\n * \n * \n * @author hongshuwei@gmail.com\n@@ -33,15 +32,15 @@ public class App {\n */\n public static void main(String[] args) {\n \n- ExecutorService executeService = Executors.newFixedThreadPool(1000);\n+ ExecutorService executeService = Executors.newFixedThreadPool(10);\n ReaderWriterLock lock = new ReaderWriterLock();\n \n- // Start 10 readers\n- IntStream.range(0, 10)\n+ // Start 5 readers\n+ IntStream.range(0, 5)\n .forEach(i -> executeService.submit(new Reader(\"Reader \" + i, lock.readLock())));\n \n- // Start 10 writers\n- IntStream.range(0, 10)\n+ // Start 5 writers\n+ IntStream.range(0, 5)\n .forEach(i -> executeService.submit(new Writer(\"Writer \" + i, lock.writeLock())));\n // In the system console, it can see that the read operations are executed concurrently while\n // write operations are exclusive.",
"filename": "reader-writer-lock/src/main/java/com/iluwatar/reader/writer/lock/App.java",
"status": "modified"
},
{
"diff": "@@ -34,7 +34,7 @@ public void run() {\n */\n public void read() throws InterruptedException {\n System.out.println(name + \" begin\");\n- Thread.sleep(100);\n+ Thread.sleep(250);\n System.out.println(name + \" finish\");\n }\n }",
"filename": "reader-writer-lock/src/main/java/com/iluwatar/reader/writer/lock/Reader.java",
"status": "modified"
},
{
"diff": "@@ -34,7 +34,7 @@ public void run() {\n */\n public void write() throws InterruptedException {\n System.out.println(name + \" begin\");\n- Thread.sleep(100);\n+ Thread.sleep(250);\n System.out.println(name + \" finish\");\n }\n }",
"filename": "reader-writer-lock/src/main/java/com/iluwatar/reader/writer/lock/Writer.java",
"status": "modified"
},
{
"diff": "@@ -1,87 +1,81 @@\n package com.iluwatar.reader.writer.lock;\n \n-import static org.mockito.Mockito.after;\n-import static org.mockito.Mockito.spy;\n-import static org.mockito.Mockito.timeout;\n-import static org.mockito.Mockito.verify;\n+import static org.mockito.Mockito.inOrder;\n \n import java.util.concurrent.ExecutorService;\n import java.util.concurrent.Executors;\n import java.util.concurrent.TimeUnit;\n \n-import org.junit.After;\n-import org.junit.Before;\n-import org.junit.Ignore;\n import org.junit.Test;\n+import org.mockito.InOrder;\n \n /**\n * @author hongshuwei@gmail.com\n */\n-public class ReaderAndWriterTest {\n+public class ReaderAndWriterTest extends StdOutTest {\n \n- ExecutorService executeService;\n \n- @Before\n- public void setup() {\n- executeService = Executors.newFixedThreadPool(2);\n- }\n \n /**\n * Verify reader and writer can only get the lock to read and write orderly\n */\n- @Ignore // intermittent failures when executed on CI\n @Test\n public void testReadAndWrite() throws Exception {\n \n ReaderWriterLock lock = new ReaderWriterLock();\n \n- Reader reader1 = spy(new Reader(\"Reader 1\", lock.readLock()));\n- Writer writer1 = spy(new Writer(\"Writer 1\", lock.writeLock()));\n+ Reader reader1 = new Reader(\"Reader 1\", lock.readLock());\n+ Writer writer1 = new Writer(\"Writer 1\", lock.writeLock());\n \n+ ExecutorService executeService = Executors.newFixedThreadPool(2);\n executeService.submit(reader1);\n // Let reader1 execute first\n- Thread.sleep(50);\n+ Thread.sleep(150);\n executeService.submit(writer1);\n \n- verify(reader1, timeout(99).atLeastOnce()).read();\n- verify(writer1, after(10).never()).write();\n- verify(writer1, timeout(100).atLeastOnce()).write();\n+ executeService.shutdown();\n+ try {\n+ executeService.awaitTermination(10, TimeUnit.SECONDS);\n+ } catch (InterruptedException e) {\n+ System.out.println(\"Error waiting for ExecutorService shutdown\");\n+ }\n \n+ final InOrder inOrder = inOrder(getStdOutMock());\n+ inOrder.verify(getStdOutMock()).println(\"Reader 1 begin\");\n+ inOrder.verify(getStdOutMock()).println(\"Reader 1 finish\");\n+ inOrder.verify(getStdOutMock()).println(\"Writer 1 begin\");\n+ inOrder.verify(getStdOutMock()).println(\"Writer 1 finish\");\n }\n \n /**\n * Verify reader and writer can only get the lock to read and write orderly\n */\n- @Ignore // intermittent failures when executed on CI\n @Test\n public void testWriteAndRead() throws Exception {\n \n ExecutorService executeService = Executors.newFixedThreadPool(2);\n ReaderWriterLock lock = new ReaderWriterLock();\n \n- Reader reader1 = spy(new Reader(\"Reader 1\", lock.readLock()));\n- Writer writer1 = spy(new Writer(\"Writer 1\", lock.writeLock()));\n+ Reader reader1 = new Reader(\"Reader 1\", lock.readLock());\n+ Writer writer1 = new Writer(\"Writer 1\", lock.writeLock());\n \n executeService.submit(writer1);\n- // Let reader1 execute first\n- Thread.sleep(50);\n+ // Let writer1 execute first\n+ Thread.sleep(150);\n executeService.submit(reader1);\n \n- verify(writer1, timeout(99).atLeastOnce()).write();\n- verify(reader1, after(10).never()).read();\n- verify(reader1, timeout(100).atLeastOnce()).read();\n-\n-\n- }\n-\n- @After\n- public void tearDown() {\n executeService.shutdown();\n try {\n executeService.awaitTermination(10, TimeUnit.SECONDS);\n } catch (InterruptedException e) {\n System.out.println(\"Error waiting for ExecutorService shutdown\");\n }\n+\n+ final InOrder inOrder = inOrder(getStdOutMock());\n+ inOrder.verify(getStdOutMock()).println(\"Writer 1 begin\");\n+ inOrder.verify(getStdOutMock()).println(\"Writer 1 finish\");\n+ inOrder.verify(getStdOutMock()).println(\"Reader 1 begin\");\n+ inOrder.verify(getStdOutMock()).println(\"Reader 1 finish\");\n }\n }\n ",
"filename": "reader-writer-lock/src/test/java/com/iluwatar/reader/writer/lock/ReaderAndWriterTest.java",
"status": "modified"
},
{
"diff": "@@ -1,25 +1,23 @@\n package com.iluwatar.reader.writer.lock;\n \n+import static org.mockito.Mockito.inOrder;\n import static org.mockito.Mockito.spy;\n-import static org.mockito.Mockito.timeout;\n-import static org.mockito.Mockito.verify;\n \n import java.util.concurrent.ExecutorService;\n import java.util.concurrent.Executors;\n import java.util.concurrent.TimeUnit;\n \n-import org.junit.Ignore;\n import org.junit.Test;\n+import org.mockito.InOrder;\n \n /**\n * @author hongshuwei@gmail.com\n */\n-public class ReaderTest {\n+public class ReaderTest extends StdOutTest {\n \n /**\n * Verify that multiple readers can get the read lock concurrently\n */\n- @Ignore // intermittent failures when executed on CI\n @Test\n public void testRead() throws Exception {\n \n@@ -30,18 +28,23 @@ public void testRead() throws Exception {\n Reader reader2 = spy(new Reader(\"Reader 2\", lock.readLock()));\n \n executeService.submit(reader1);\n+ Thread.sleep(150);\n executeService.submit(reader2);\n \n- // Read operation will hold the read lock 100 milliseconds, so here we guarantee that each\n- // readers can read in 99 milliseconds to prove that multiple read can perform in the same time.\n- verify(reader1, timeout(99).atLeastOnce()).read();\n- verify(reader2, timeout(99).atLeastOnce()).read();\n-\n executeService.shutdown();\n try {\n executeService.awaitTermination(10, TimeUnit.SECONDS);\n } catch (InterruptedException e) {\n System.out.println(\"Error waiting for ExecutorService shutdown\");\n }\n+\n+ // Read operation will hold the read lock 250 milliseconds, so here we prove that multiple reads\n+ // can be performed in the same time.\n+ final InOrder inOrder = inOrder(getStdOutMock());\n+ inOrder.verify(getStdOutMock()).println(\"Reader 1 begin\");\n+ inOrder.verify(getStdOutMock()).println(\"Reader 2 begin\");\n+ inOrder.verify(getStdOutMock()).println(\"Reader 1 finish\");\n+ inOrder.verify(getStdOutMock()).println(\"Reader 2 finish\");\n+\n }\n }",
"filename": "reader-writer-lock/src/test/java/com/iluwatar/reader/writer/lock/ReaderTest.java",
"status": "modified"
},
{
"diff": "@@ -0,0 +1,53 @@\n+package com.iluwatar.reader.writer.lock;\n+\n+import org.junit.After;\n+import org.junit.Before;\n+\n+import java.io.PrintStream;\n+\n+import static org.mockito.Mockito.mock;\n+\n+/**\n+ * Date: 12/10/15 - 8:37 PM\n+ *\n+ * @author Jeroen Meulemeester\n+ */\n+public abstract class StdOutTest {\n+\n+ /**\n+ * The mocked standard out {@link PrintStream}, required since some actions don't have any\n+ * influence on accessible objects, except for writing to std-out using {@link System#out}\n+ */\n+ private final PrintStream stdOutMock = mock(PrintStream.class);\n+\n+ /**\n+ * Keep the original std-out so it can be restored after the test\n+ */\n+ private final PrintStream stdOutOrig = System.out;\n+\n+ /**\n+ * Inject the mocked std-out {@link PrintStream} into the {@link System} class before each test\n+ */\n+ @Before\n+ public void setUp() {\n+ System.setOut(this.stdOutMock);\n+ }\n+\n+ /**\n+ * Removed the mocked std-out {@link PrintStream} again from the {@link System} class\n+ */\n+ @After\n+ public void tearDown() {\n+ System.setOut(this.stdOutOrig);\n+ }\n+\n+ /**\n+ * Get the mocked stdOut {@link PrintStream}\n+ *\n+ * @return The stdOut print stream mock, renewed before each test\n+ */\n+ final PrintStream getStdOutMock() {\n+ return this.stdOutMock;\n+ }\n+\n+}",
"filename": "reader-writer-lock/src/test/java/com/iluwatar/reader/writer/lock/StdOutTest.java",
"status": "added"
},
{
"diff": "@@ -1,26 +1,23 @@\n package com.iluwatar.reader.writer.lock;\n \n-import static org.mockito.Mockito.after;\n+import static org.mockito.Mockito.inOrder;\n import static org.mockito.Mockito.spy;\n-import static org.mockito.Mockito.timeout;\n-import static org.mockito.Mockito.verify;\n \n import java.util.concurrent.ExecutorService;\n import java.util.concurrent.Executors;\n import java.util.concurrent.TimeUnit;\n \n-import org.junit.Ignore;\n import org.junit.Test;\n+import org.mockito.InOrder;\n \n /**\n * @author hongshuwei@gmail.com\n */\n-public class WriterTest {\n+public class WriterTest extends StdOutTest {\n \n /**\n * Verify that multiple writers will get the lock in order.\n */\n- @Ignore // intermittent failures when executed on CI\n @Test\n public void testWrite() throws Exception {\n \n@@ -32,23 +29,22 @@ public void testWrite() throws Exception {\n \n executeService.submit(writer1);\n // Let write1 execute first\n- Thread.sleep(50);\n+ Thread.sleep(150);\n executeService.submit(writer2);\n \n- // Write operation will hold the write lock 100 milliseconds, so here we verify that when two\n- // write excute concurrently\n- // 1. The first write will get the lock and and write in 60ms\n- // 2. The second writer will cannot get the lock when first writer get the lock\n- // 3. The second writer will get the lock as last\n- verify(writer1, timeout(10).atLeastOnce()).write();\n- verify(writer2, after(10).never()).write();\n- verify(writer2, timeout(100).atLeastOnce()).write();\n-\n executeService.shutdown();\n try {\n executeService.awaitTermination(10, TimeUnit.SECONDS);\n } catch (InterruptedException e) {\n System.out.println(\"Error waiting for ExecutorService shutdown\");\n }\n+ // Write operation will hold the write lock 250 milliseconds, so here we verify that when two\n+ // writer execute concurrently, the second writer can only writes only when the first one is\n+ // finished.\n+ final InOrder inOrder = inOrder(getStdOutMock());\n+ inOrder.verify(getStdOutMock()).println(\"Writer 1 begin\");\n+ inOrder.verify(getStdOutMock()).println(\"Writer 1 finish\");\n+ inOrder.verify(getStdOutMock()).println(\"Writer 2 begin\");\n+ inOrder.verify(getStdOutMock()).println(\"Writer 2 finish\");\n }\n }",
"filename": "reader-writer-lock/src/test/java/com/iluwatar/reader/writer/lock/WriterTest.java",
"status": "modified"
}
]
} |
{
"body": "The documentation for [JarOutputStream](https://developer.android.com/reference/java/util/jar/JarOutputStream) lists two constructors : \r\n\r\n- `public JarOutputStream (OutputStream out)`\r\n- `public JarOutputStream (OutputStream out, Manifest man)`\r\n\r\nIn the `writeSelfReferencingJarFile` test file, the test creates a manifest but forget to write it because it is calling the wrong version of the constructor.\r\n\r\nThis PR fixes that.",
"comments": [
{
"body": "Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).\n\nView this [failed invocation](https://github.com/google/guava/pull/7185/checks?check_run_id=24283765056) of the CLA check for more information.\n\nFor the most up to date status, view the checks section at the bottom of the pull request.",
"created_at": "2024-04-26T05:16:14Z"
}
],
"number": 7185,
"title": "Add missing param in `JarOutputStream`"
} | {
"body": "Actually write the manifest we generate to the jar.\n\nFixes #7185\n\nRELNOTES=n/a\n",
"number": 7186,
"review_comments": [],
"title": "Actually write the manifest we generate to the jar."
} | {
"commits": [],
"files": []
} |
{
"body": "### Description\n\nUsing latest LTS JVM (21):\r\n\r\n1. `git clone git@github.com:google/guava.git`\r\n2. `cd guava && mvn clean package`\r\n3. Build fails\n\n### Example\n\n```java\nSee above\n```\n\n\n### Expected Behavior\n\nThe build should not fail\n\n### Actual Behavior\n\n```\r\n[INFO] \r\n[INFO] --- bundle:5.1.8:bundle (default-bundle) @ guava ---\r\n[INFO] Building bundle: /Volumes/VAULTROOM/guava/guava/target/guava-HEAD-jre-SNAPSHOT.jar\r\n[INFO] Writing manifest: /Volumes/VAULTROOM/guava/guava/target/classes/META-INF/MANIFEST.MF\r\n[INFO] \r\n[INFO] --- source:3.3.0:jar-no-fork (attach-sources) @ guava ---\r\n[INFO] Building jar: /Volumes/VAULTROOM/guava/guava/target/guava-HEAD-jre-SNAPSHOT-sources.jar\r\n[INFO] \r\n[INFO] --- javadoc:3.5.0:jar (attach-docs) @ guava ---\r\n[INFO] No previous run data found, generating javadoc.\r\n[INFO] ------------------------------------------------------------------------\r\n[INFO] Reactor Summary for Guava Maven Parent HEAD-jre-SNAPSHOT:\r\n[INFO] \r\n[INFO] Guava Maven Parent ................................. SUCCESS [ 3.488 s]\r\n[INFO] Guava: Google Core Libraries for Java .............. FAILURE [ 48.658 s]\r\n[INFO] Guava BOM .......................................... SKIPPED\r\n[INFO] Guava Testing Library .............................. SKIPPED\r\n[INFO] Guava Unit Tests ................................... SKIPPED\r\n[INFO] Guava GWT compatible libs .......................... SKIPPED\r\n[INFO] ------------------------------------------------------------------------\r\n[INFO] BUILD FAILURE\r\n[INFO] ------------------------------------------------------------------------\r\n[INFO] Total time: 53.890 s\r\n[INFO] Finished at: 2024-03-01T13:22:02-08:00\r\n[INFO] ------------------------------------------------------------------------\r\n[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.5.0:jar (attach-docs) on project guava: MavenReportException: Error while generating Javadoc: \r\n[ERROR] Exit code: 1\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/vm/ScopedValueContainer.java:28: error: StructureViolationException is a preview API and is disabled by default.\r\n[ERROR] import java.util.concurrent.StructureViolationException;\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/access/JavaNioAccess.java:31: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] import java.lang.foreign.MemorySegment;\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/access/JavaTemplateAccess.java:49: error: StringTemplate is a preview API and is disabled by default.\r\n[ERROR] StringTemplate of(List<String> fragments, List<?> values);\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/access/JavaTemplateAccess.java:75: error: StringTemplate is a preview API and is disabled by default.\r\n[ERROR] StringTemplate combine(StringTemplate... sts);\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/access/JavaTemplateAccess.java:75: error: StringTemplate is a preview API and is disabled by default.\r\n[ERROR] StringTemplate combine(StringTemplate... sts);\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/access/JavaNioAccess.java:50: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] ByteBuffer newDirectByteBuffer(long addr, int cap, Object obj, MemorySegment segment);\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/access/JavaNioAccess.java:60: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] ByteBuffer newMappedByteBuffer(UnmapperProxy unmapperProxy, long addr, int cap, Object obj, MemorySegment segment);\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/access/JavaNioAccess.java:66: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] ByteBuffer newHeapByteBuffer(byte[] hb, int offset, int capacity, MemorySegment segment);\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/access/JavaNioAccess.java:86: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] MemorySegment bufferSegment(Buffer buffer);\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/sun/nio/ch/FileChannelImpl.java:32: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] import java.lang.foreign.MemorySegment;\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/sun/nio/ch/FileChannelImpl.java:33: error: Arena is a preview API and is disabled by default.\r\n[ERROR] import java.lang.foreign.Arena;\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/sun/nio/ch/FileChannelImpl.java:1206: error: Arena is a preview API and is disabled by default.\r\n[ERROR] Arena arena)\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/sun/nio/ch/FileChannelImpl.java:1205: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public MemorySegment map(MapMode mode, long offset, long size,\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:58: error: ValueLayout is a preview API and is disabled by default.\r\n[ERROR] import static java.lang.foreign.ValueLayout.JAVA_BYTE;\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:70: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] implements MemorySegment, SegmentAllocator, BiFunction<String, List<Number>, RuntimeException>\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:70: error: SegmentAllocator is a preview API and is disabled by default.\r\n[ERROR] implements MemorySegment, SegmentAllocator, BiFunction<String, List<Number>, RuntimeException>\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/HeapMemorySegmentImpl.java:29: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] import java.lang.foreign.MemorySegment;\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/HeapMemorySegmentImpl.java:30: error: ValueLayout is a preview API and is disabled by default.\r\n[ERROR] import java.lang.foreign.ValueLayout;\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/NativeMemorySegmentImpl.java:29: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] import java.lang.foreign.MemorySegment;\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/misc/ScopedMemoryAccess.java:32: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] import java.lang.foreign.MemorySegment;\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/MemorySessionImpl.java:29: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] import java.lang.foreign.MemorySegment;\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/MemorySessionImpl.java:30: error: Arena is a preview API and is disabled by default.\r\n[ERROR] import java.lang.foreign.Arena;\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/MemorySessionImpl.java:31: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] import java.lang.foreign.MemorySegment.Scope;\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/MemorySessionImpl.java:31: error: Scope is a preview API and is disabled by default.\r\n[ERROR] import java.lang.foreign.MemorySegment.Scope;\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/MemorySessionImpl.java:53: error: Scope is a preview API and is disabled by default.\r\n[ERROR] implements Scope\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:115: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public MemorySegment asSlice(long offset, long newSize, long byteAlignment) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:127: error: Arena is a preview API and is disabled by default.\r\n[ERROR] public final MemorySegment reinterpret(long newSize, Arena arena, Consumer<MemorySegment> cleanup) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:127: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public final MemorySegment reinterpret(long newSize, Arena arena, Consumer<MemorySegment> cleanup) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:127: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public final MemorySegment reinterpret(long newSize, Arena arena, Consumer<MemorySegment> cleanup) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:135: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public final MemorySegment reinterpret(long newSize) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:141: error: Arena is a preview API and is disabled by default.\r\n[ERROR] public final MemorySegment reinterpret(Arena arena, Consumer<MemorySegment> cleanup) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:141: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public final MemorySegment reinterpret(Arena arena, Consumer<MemorySegment> cleanup) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:141: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public final MemorySegment reinterpret(Arena arena, Consumer<MemorySegment> cleanup) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:147: error: Scope is a preview API and is disabled by default.\r\n[ERROR] public MemorySegment reinterpretInternal(Class<?> callerClass, long newSize, Scope scope, Consumer<MemorySegment> cleanup) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:147: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public MemorySegment reinterpretInternal(Class<?> callerClass, long newSize, Scope scope, Consumer<MemorySegment> cleanup) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:147: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public MemorySegment reinterpretInternal(Class<?> callerClass, long newSize, Scope scope, Consumer<MemorySegment> cleanup) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:165: error: MemoryLayout is a preview API and is disabled by default.\r\n[ERROR] public Spliterator<MemorySegment> spliterator(MemoryLayout elementLayout) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:165: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public Spliterator<MemorySegment> spliterator(MemoryLayout elementLayout) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:182: error: MemoryLayout is a preview API and is disabled by default.\r\n[ERROR] public Stream<MemorySegment> elements(MemoryLayout elementLayout) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:182: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public Stream<MemorySegment> elements(MemoryLayout elementLayout) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:187: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public final MemorySegment fill(byte value){\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:194: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public MemorySegment allocate(long byteSize, long byteAlignment) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:258: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public final Optional<MemorySegment> asOverlappingSlice(MemorySegment other) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:258: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public final Optional<MemorySegment> asOverlappingSlice(MemorySegment other) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:276: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public final long segmentOffset(MemorySegment other) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:309: error: ValueLayout is a preview API and is disabled by default.\r\n[ERROR] public final byte[] toArray(ValueLayout.OfByte elementLayout) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:309: error: OfByte is a preview API and is disabled by default.\r\n[ERROR] public final byte[] toArray(ValueLayout.OfByte elementLayout) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:314: error: ValueLayout is a preview API and is disabled by default.\r\n[ERROR] public final short[] toArray(ValueLayout.OfShort elementLayout) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:314: error: OfShort is a preview API and is disabled by default.\r\n[ERROR] public final short[] toArray(ValueLayout.OfShort elementLayout) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:319: error: ValueLayout is a preview API and is disabled by default.\r\n[ERROR] public final char[] toArray(ValueLayout.OfChar elementLayout) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:319: error: OfChar is a preview API and is disabled by default.\r\n[ERROR] public final char[] toArray(ValueLayout.OfChar elementLayout) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:324: error: ValueLayout is a preview API and is disabled by default.\r\n[ERROR] public final int[] toArray(ValueLayout.OfInt elementLayout) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:324: error: OfInt is a preview API and is disabled by default.\r\n[ERROR] public final int[] toArray(ValueLayout.OfInt elementLayout) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:329: error: ValueLayout is a preview API and is disabled by default.\r\n[ERROR] public final float[] toArray(ValueLayout.OfFloat elementLayout) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:329: error: OfFloat is a preview API and is disabled by default.\r\n[ERROR] public final float[] toArray(ValueLayout.OfFloat elementLayout) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:334: error: ValueLayout is a preview API and is disabled by default.\r\n[ERROR] public final long[] toArray(ValueLayout.OfLong elementLayout) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:334: error: OfLong is a preview API and is disabled by default.\r\n[ERROR] public final long[] toArray(ValueLayout.OfLong elementLayout) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:339: error: ValueLayout is a preview API and is disabled by default.\r\n[ERROR] public final double[] toArray(ValueLayout.OfDouble elementLayout) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:339: error: OfDouble is a preview API and is disabled by default.\r\n[ERROR] public final double[] toArray(ValueLayout.OfDouble elementLayout) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:343: error: ValueLayout is a preview API and is disabled by default.\r\n[ERROR] private <Z> Z toArray(Class<Z> arrayClass, ValueLayout elemLayout, IntFunction<Z> arrayFactory, Function<Z, MemorySegment> segmentFactory) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:343: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] private <Z> Z toArray(Class<Z> arrayClass, ValueLayout elemLayout, IntFunction<Z> arrayFactory, Function<Z, MemorySegment> segmentFactory) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:372: error: MemoryLayout is a preview API and is disabled by default.\r\n[ERROR] public final boolean isAlignedForElement(long offset, MemoryLayout layout) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:411: error: Scope is a preview API and is disabled by default.\r\n[ERROR] public Scope scope() {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:594: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public static void copy(MemorySegment srcSegment, ValueLayout srcElementLayout, long srcOffset,\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:594: error: ValueLayout is a preview API and is disabled by default.\r\n[ERROR] public static void copy(MemorySegment srcSegment, ValueLayout srcElementLayout, long srcOffset,\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:595: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] MemorySegment dstSegment, ValueLayout dstElementLayout, long dstOffset,\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:595: error: ValueLayout is a preview API and is disabled by default.\r\n[ERROR] MemorySegment dstSegment, ValueLayout dstElementLayout, long dstOffset,\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:626: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public static void copy(MemorySegment srcSegment, ValueLayout srcLayout, long srcOffset,\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:626: error: ValueLayout is a preview API and is disabled by default.\r\n[ERROR] public static void copy(MemorySegment srcSegment, ValueLayout srcLayout, long srcOffset,\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:656: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] MemorySegment dstSegment, ValueLayout dstLayout, long dstOffset,\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:656: error: ValueLayout is a preview API and is disabled by default.\r\n[ERROR] MemorySegment dstSegment, ValueLayout dstLayout, long dstOffset,\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:683: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public static long mismatch(MemorySegment srcSegment, long srcFromOffset, long srcToOffset,\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:684: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] MemorySegment dstSegment, long dstFromOffset, long dstToOffset) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/MemorySessionImpl.java:79: error: Arena is a preview API and is disabled by default.\r\n[ERROR] public Arena asArena() {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/MemorySessionImpl.java:94: error: Arena is a preview API and is disabled by default.\r\n[ERROR] public static final MemorySessionImpl toMemorySession(Arena arena) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/MemorySessionImpl.java:156: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public MemorySegment allocate(long byteSize, long byteAlignment) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/MemorySessionImpl.java:223: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public static final void checkValidState(MemorySegment segment) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/NativeMemorySegmentImpl.java:118: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public static MemorySegment makeNativeSegment(long byteSize, long byteAlignment, MemorySessionImpl sessionImpl) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/NativeMemorySegmentImpl.java:154: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public static MemorySegment makeNativeSegmentUnchecked(long min, long byteSize, MemorySessionImpl sessionImpl, Runnable action) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/NativeMemorySegmentImpl.java:164: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public static MemorySegment makeNativeSegmentUnchecked(long min, long byteSize, MemorySessionImpl sessionImpl) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/NativeMemorySegmentImpl.java:170: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public static MemorySegment makeNativeSegmentUnchecked(long min, long byteSize) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:430: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] static class SegmentSplitter implements Spliterator<MemorySegment> {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:459: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public boolean tryAdvance(Consumer<? super MemorySegment> action) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/AbstractMemorySegmentImpl.java:478: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public void forEachRemaining(Consumer<? super MemorySegment> action) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/HeapMemorySegmentImpl.java:113: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public static MemorySegment fromArray(byte[] arr) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/HeapMemorySegmentImpl.java:147: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public static MemorySegment fromArray(char[] arr) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/HeapMemorySegmentImpl.java:181: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public static MemorySegment fromArray(short[] arr) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/HeapMemorySegmentImpl.java:215: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public static MemorySegment fromArray(int[] arr) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/HeapMemorySegmentImpl.java:249: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public static MemorySegment fromArray(long[] arr) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/HeapMemorySegmentImpl.java:283: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public static MemorySegment fromArray(float[] arr) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] /Volumes/VAULTROOM/guava/guava/target/jdk-sources/java.base/jdk/internal/foreign/HeapMemorySegmentImpl.java:317: error: MemorySegment is a preview API and is disabled by default.\r\n[ERROR] public static MemorySegment fromArray(double[] arr) {\r\n[ERROR] ^\r\n[ERROR] (use --enable-preview to enable preview APIs)\r\n[ERROR] 91 errors\r\n[ERROR] Command line was: /Library/Java/JavaVirtualMachines/gvm-ce.jdk21/Contents/Home/bin/javadoc @options @argfile\r\n[ERROR] \r\n[ERROR] Refer to the generated Javadoc files in '/Volumes/VAULTROOM/guava/guava/target/apidocs' dir.\r\n[ERROR] \r\n[ERROR] -> [Help 1]\r\n[ERROR] \r\n[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.\r\n[ERROR] Re-run Maven using the -X switch to enable full debug logging.\r\n[ERROR] \r\n[ERROR] For more information about the errors and possible solutions, please read the following articles:\r\n[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException\r\n[ERROR] \r\n[ERROR] After correcting the problems, you can resume the build with the command\r\n[ERROR] mvn <args> -rf :guava\r\n```\n\n### Packages\n\n_No response_\n\n### Platforms\n\n_No response_\n\n### Checklist\n\n- [X] I agree to follow the [code of conduct](https://github.com/google/.github/blob/master/CODE_OF_CONDUCT.md).\n",
"comments": [
{
"body": "It appears this happens because of the build against JDK sources, which includes preview types.",
"created_at": "2024-03-01T21:46:39Z"
},
{
"body": "Thanks, I knew that the build was broken at one point under 21 (https://github.com/google/guava/issues/6830, maybe since fixed, but we should set up CI, as the issue says) but didn't know about this specific reason. It's probably about time for me to do something about that.\r\n\r\nThe use of JDK sources hasn't been working for a while, anyway (https://github.com/google/guava/issues/6790). I should probably rip that out.",
"created_at": "2024-03-02T00:15:46Z"
},
{
"body": "Would you guys be open to PRs @cpovirk? I have a reasonable suite of changes locally and I could break that out into something reviewable.",
"created_at": "2024-03-02T05:42:06Z"
},
{
"body": "For this sort of thing, probably yes, thanks.\r\n\r\nThe main thing to be aware of is the need to sign the CLA: https://github.com/google/guava/blob/master/CONTRIBUTING.md#contributor-license-agreement\r\n\r\nIf you want me to peek at anything before you go to the trouble of breaking it up, let me know.",
"created_at": "2024-03-02T13:57:01Z"
}
],
"number": 7065,
"title": "Guava build fails on `master` with JDK 21"
} | {
"body": "## Summary\r\n\r\nAmends the build to be compatible with JDKs newer than 18. Adds JDK21 to the CI matrix.\r\n\r\n### Related issues\r\n\r\n- Fixes and closes #7065 \r\n- Fixes testsuite up to JVM21 w.r.t. #6245 \r\n\r\n## Changelog\r\n\r\n- fix: build against embedded jdk sources needs `--enable-preview` when built against jvm21\r\n- fix: add `-Djava.security.manager=allow` to fix security manager tests under modern java\r\n- fix: upgrade asm → latest\r\n- chore: add jvm21 to ci\r\n",
"number": 7087,
"review_comments": [
{
"body": "New `test.add.args` prop; does what it says on the tin.",
"created_at": "2024-03-08T07:28:44Z"
},
{
"body": "On JDK19+, the `--enable-preview` flag is now passed during Javadoc build. This fixes the preview compile failure cited in google/guava#7065. This change was performed for both Android and JRE.",
"created_at": "2024-03-08T07:29:02Z"
},
{
"body": "On JDK18+, the [SecurityManager](https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/SecurityManager.html) needs extra urging to work with the testsuite, as described in google/guava#6245. This change was performed for both Android and JRE.",
"created_at": "2024-03-08T07:29:21Z"
},
{
"body": "Small fix: was included for Android, but not for JRE. Did not appear to be intentional",
"created_at": "2024-03-08T07:29:38Z"
},
{
"body": "ASM will need to be upgraded to `9.6` transitively for `animal-sniffer`, in order to support Java 21 class bytecode. This change is inert for now, but avoids issues if Guava classes are built at higher bytecode levels.",
"created_at": "2024-03-08T07:29:48Z"
},
{
"body": "I went ahead and added JVM21 to the build.",
"created_at": "2024-03-08T07:30:46Z"
},
{
"body": "I think I see it in both \"top-level\" `pom.xml` files...\r\n\r\n- https://github.com/google/guava/blob/0b1c477311b2c7a0a89f5e0ac785084e3ab15d34/pom.xml#L214\r\n- https://github.com/google/guava/blob/0b1c477311b2c7a0a89f5e0ac785084e3ab15d34/android/pom.xml#L219\r\n\r\n...and in neither `guava/pom.xml` file...\r\n\r\n- https://github.com/google/guava/blob/0b1c477311b2c7a0a89f5e0ac785084e3ab15d34/guava/pom.xml\r\n- https://github.com/google/guava/blob/0b1c477311b2c7a0a89f5e0ac785084e3ab15d34/android/guava/pom.xml\r\n\r\nThat probably makes sense? Or if we need it here, we probably need it in `android/guava/pom.xml`.",
"created_at": "2024-03-08T15:05:16Z"
},
{
"body": "Oh, I guess that I skimmed past this, too. My guess is that fail-fast is useful here because `verify` doesn't necessarily work right without `install` first: https://github.com/google/guava/issues/2193#issuecomment-148682832. The main thing that _not_ failing fast may help with is running certain tests that would otherwise be skipped (e.g., running the main tests if the GWT compile fails). My guess is that failing fast is actually more often valuable, given that we run tests internally as part of the submit process: If something fails, it's usually that we're missing a Maven tweak, so we'd rather find out quickly so that we can fix things. Do you think that disabling fail-fast could still be worthwhile in our somewhat unusual circumstances?",
"created_at": "2024-03-11T15:48:02Z"
},
{
"body": "I had been a little scared to see what would happen when using a newer JDK for _docs_. But it's looking like an improvement: https://github.com/google/guava/issues/6790#issuecomment-1988762401\r\n\r\n\\[update later: [nope](https://github.com/google/guava/issues/6790#issuecomment-1995230826) :(\\]",
"created_at": "2024-03-11T15:48:48Z"
},
{
"body": "This can be removed now that #7092 has been merged",
"created_at": "2024-03-11T19:03:48Z"
},
{
"body": "@cpovirk Huh, that's an interesting take; I think this one is a matter of taste, actually, given what you've shared here. I usually disable `fail-fast` in multi-JVM builds, because maybe there is a failure on a JVM build that isn't caught because it is cancelled before it can surface.\r\n\r\nI'm usually staring at the build screen while it runs, so I will cancel runs that are obviously going to fail. `fail-fast` would usually catch these.\r\n\r\nOn balance, I suppose it helps to have it on while the PR is under development, but I have no opinion after that. Would you rather I remove it or keep it?\r\n\r\nRe/ #2193 each of these jobs runs on a separate runner machine, so the `mvn install` step should be running within the scope of a job-specific `.m2` local repository. The `mvn install` step is necessary because Maven has trouble resolving dependencies from projects inside the build. But that shouldn't interfere with the test matrix here, unless I'm missing something.",
"created_at": "2024-03-11T19:14:28Z"
},
{
"body": "For Windows, I think I'll just switch us to 21 (i.e., remove 17), updating the branch-protection rules around the same time.\r\n\r\n(Even with performance improvements possibly on the horizon, I worry about having more CI jobs. My hope would be that one Windows job is enough: The main thing is to avoid embarrassing \"Windows does not work\" bugs like the one I introduced not so long ago.)",
"created_at": "2024-03-12T19:23:10Z"
},
{
"body": "Oops, thanks, I was mixing up `fail-fast` and `continue-on-error`. So my point about \"running the main tests if the GWT compile fails\" is not actually what we're talking about.\r\n\r\nI do see more value in continuing with, e.g., JDK 11 if the JDK 8 build fails because of an annoying problem with old versions of javac :) But then it's also sad to have to wait for JDK 11 to run all the tests before you get a notification about the JDK 8 build failure, and that's how it would often go for our internal workflow. Or maybe not? I'm not actually 100% sure whether Copybara fails the submit (and notifies the user) as soon as it sees a failure or not. (How could I know, given that we have `fail-fast` on? :))\r\n\r\nI guess my other fear would be that we're burning resources. I thought maybe I'd once heard that the `google` org's various projects may be competing with each other for resources? If so, then I wouldn't want to spend more on a build that is likely to fail. At this point, that's probably the main thing keeping me from giving it a try to see how Copybara behaves.\r\n\r\n(For that matter, we could consider dropping one of the older Java releases to prevent our resource usage from growing on that account. Presumably we'd drop either 11 or 17, since that would keep coverage of the \"endpoints.\" Our internal tests run under 21 nowadays—but obviously with the `SecurityManager` deprecation dialed back by default at the moment :))\r\n\r\nI could probably go back and forth on this all day. I'll just leave this out in the internal change for now for the sake of getting the build working under newer JDKs. If you want to queue up `fail-fast` as a separate PR with a link back here, then... we'll probably let it sit forever unless something changes, but if we ever do merge it, your name will get attached :)",
"created_at": "2024-03-12T19:28:46Z"
},
{
"body": "Roger that",
"created_at": "2024-03-12T19:55:48Z"
}
],
"title": "Fix: Java 18+ Builds"
} | {
"commits": [
{
"message": "fix: build against jvm21\n\n- fix: build against embedded jdk sources needs `--enable-preview`\n when built against jvm21\n\n- fix: add `-Djava.security.manager=allow` to fix security manager\n tests under modern java\n\nFixes and closes google/guava#7065\n\nSigned-off-by: Sam Gammon <sam@elide.ventures>"
},
{
"message": "chore(ci): bump ci jdk → jdk21\n\nSigned-off-by: Sam Gammon <sam@elide.ventures>"
}
],
"files": [
{
"diff": "@@ -20,11 +20,11 @@ jobs:\n strategy:\n matrix:\n os: [ ubuntu-latest ]\n- java: [ 8, 11, 17 ]\n+ java: [ 8, 11, 17, 21 ]\n root-pom: [ 'pom.xml', 'android/pom.xml' ]\n include:\n - os: windows-latest\n- java: 17\n+ java: 21\n root-pom: pom.xml\n runs-on: ${{ matrix.os }}\n env:\n@@ -68,11 +68,10 @@ jobs:\n steps:\n - name: 'Check out repository'\n uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 # v4.1.2\n- - name: 'Set up JDK 11'\n+ - name: 'Set up JDK 21'\n uses: actions/setup-java@9704b39bf258b59bc04b50fa2dd55e9ed76b47a8 # v4.1.0\n-\n with:\n- java-version: 11\n+ java-version: 21\n distribution: 'zulu'\n server-id: sonatype-nexus-snapshots\n server-username: CI_DEPLOY_USERNAME\n@@ -94,11 +93,10 @@ jobs:\n steps:\n - name: 'Check out repository'\n uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 # v4.1.2\n- - name: 'Set up JDK 11'\n+ - name: 'Set up JDK 21'\n uses: actions/setup-java@9704b39bf258b59bc04b50fa2dd55e9ed76b47a8 # v4.1.0\n-\n with:\n- java-version: 11\n+ java-version: 21\n distribution: 'zulu'\n cache: 'maven'\n - name: 'Generate latest docs'",
"filename": ".github/workflows/ci.yml",
"status": "modified"
},
{
"diff": "@@ -25,6 +25,7 @@\n <project.build.outputTimestamp>2024-01-02T00:00:00Z</project.build.outputTimestamp>\n <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>\n <test.add.opens></test.add.opens>\n+ <test.add.args></test.add.args>\n <module.status>integration</module.status>\n <variant.jvmEnvironment>android</variant.jvmEnvironment>\n <variant.jvmEnvironmentVariantName>android</variant.jvmEnvironmentVariantName>\n@@ -253,7 +254,7 @@\n <runOrder>alphabetical</runOrder>\n <!-- Set max heap for tests. -->\n <!-- Catch dependencies on the default locale by setting it to hi-IN. -->\n- <argLine>-Xmx1536M -Duser.language=hi -Duser.country=IN ${test.add.opens}</argLine>\n+ <argLine>-Xmx1536M -Duser.language=hi -Duser.country=IN ${test.add.args} ${test.add.opens}</argLine>\n </configuration>\n </plugin>\n <plugin>\n@@ -462,5 +463,18 @@\n </plugins>\n </build>\n </profile>\n+ <profile>\n+ <id>javac-for-jvm18plus</id>\n+ <activation>\n+ <!--\n+ To build and run the tests against JDK 18+, we need to pass java.security.manager=allow, to allow use of\n+ the deprecated 'java.lang.SecurityManager' class.\n+ -->\n+ <jdk>[18,]</jdk>\n+ </activation>\n+ <properties>\n+ <test.add.args>-Djava.security.manager=allow</test.add.args>\n+ </properties>\n+ </profile>\n </profiles>\n </project>",
"filename": "android/pom.xml",
"status": "modified"
},
{
"diff": "@@ -25,6 +25,7 @@\n <project.build.outputTimestamp>2024-01-02T00:00:00Z</project.build.outputTimestamp>\n <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>\n <test.add.opens></test.add.opens>\n+ <test.add.args></test.add.args>\n <module.status>integration</module.status>\n <variant.jvmEnvironment>standard-jvm</variant.jvmEnvironment>\n <variant.jvmEnvironmentVariantName>jre</variant.jvmEnvironmentVariantName>\n@@ -177,6 +178,13 @@\n <groupId>org.codehaus.mojo</groupId>\n <artifactId>animal-sniffer-maven-plugin</artifactId>\n <version>1.23</version>\n+ <dependencies>\n+ <dependency>\n+ <groupId>org.ow2.asm</groupId>\n+ <artifactId>asm</artifactId>\n+ <version>9.6</version>\n+ </dependency>\n+ </dependencies>\n <configuration>\n <annotations>com.google.common.base.IgnoreJRERequirement,com.google.common.collect.IgnoreJRERequirement,com.google.common.hash.IgnoreJRERequirement,com.google.common.io.IgnoreJRERequirement,com.google.common.reflect.IgnoreJRERequirement,com.google.common.testing.IgnoreJRERequirement</annotations>\n <checkTestClasses>true</checkTestClasses>\n@@ -248,7 +256,7 @@\n <runOrder>alphabetical</runOrder>\n <!-- Set max heap for tests. -->\n <!-- Catch dependencies on the default locale by setting it to hi-IN. -->\n- <argLine>-Xmx1536M -Duser.language=hi -Duser.country=IN ${test.add.opens}</argLine>\n+ <argLine>-Xmx1536M -Duser.language=hi -Duser.country=IN ${test.add.args} ${test.add.opens}</argLine>\n </configuration>\n </plugin>\n <plugin>\n@@ -457,5 +465,18 @@\n </plugins>\n </build>\n </profile>\n+ <profile>\n+ <id>javac-for-jvm18plus</id>\n+ <activation>\n+ <!--\n+ To build and run the tests against JDK 18+, we need to pass java.security.manager=allow, to allow use of\n+ the deprecated 'java.lang.SecurityManager' class.\n+ -->\n+ <jdk>[18,]</jdk>\n+ </activation>\n+ <properties>\n+ <test.add.args>-Djava.security.manager=allow</test.add.args>\n+ </properties>\n+ </profile>\n </profiles>\n </project>",
"filename": "pom.xml",
"status": "modified"
}
]
} |
{
"body": "See https://github.com/google/guava/pull/6243.",
"comments": [
{
"body": "Also, [JDK20 will make `Thread.suspend` throw](https://bugs.openjdk.org/browse/JDK-8249627), breaking `AbstractFutureTest.testToString_delayedTimeout`.",
"created_at": "2022-12-05T15:13:03Z"
},
{
"body": "I just happened to see a reminder that we have some tests that we automatically skip under JDK9 and JDK10:\r\n\r\nhttps://github.com/google/guava/blob/f4c02a1f30d3f86879ef892736da4031362a1895/guava-tests/test/com/google/common/base/FinalizableReferenceQueueClassLoaderUnloadingTest.java#L293\r\n\r\nApparently they work fine under JDK11+, unless I'm missing something.",
"created_at": "2022-12-05T15:21:44Z"
}
],
"number": 6245,
"title": "Fix JDK18+ `SecurityManager` build failures (and maybe other failures on some older JDKs)"
} | {
"body": "## Summary\r\n\r\nAmends the build to be compatible with JDKs newer than 18. Adds JDK21 to the CI matrix.\r\n\r\n### Related issues\r\n\r\n- Fixes and closes #7065 \r\n- Fixes testsuite up to JVM21 w.r.t. #6245 \r\n\r\n## Changelog\r\n\r\n- fix: build against embedded jdk sources needs `--enable-preview` when built against jvm21\r\n- fix: add `-Djava.security.manager=allow` to fix security manager tests under modern java\r\n- fix: upgrade asm → latest\r\n- chore: add jvm21 to ci\r\n",
"number": 7087,
"review_comments": [
{
"body": "New `test.add.args` prop; does what it says on the tin.",
"created_at": "2024-03-08T07:28:44Z"
},
{
"body": "On JDK19+, the `--enable-preview` flag is now passed during Javadoc build. This fixes the preview compile failure cited in google/guava#7065. This change was performed for both Android and JRE.",
"created_at": "2024-03-08T07:29:02Z"
},
{
"body": "On JDK18+, the [SecurityManager](https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/SecurityManager.html) needs extra urging to work with the testsuite, as described in google/guava#6245. This change was performed for both Android and JRE.",
"created_at": "2024-03-08T07:29:21Z"
},
{
"body": "Small fix: was included for Android, but not for JRE. Did not appear to be intentional",
"created_at": "2024-03-08T07:29:38Z"
},
{
"body": "ASM will need to be upgraded to `9.6` transitively for `animal-sniffer`, in order to support Java 21 class bytecode. This change is inert for now, but avoids issues if Guava classes are built at higher bytecode levels.",
"created_at": "2024-03-08T07:29:48Z"
},
{
"body": "I went ahead and added JVM21 to the build.",
"created_at": "2024-03-08T07:30:46Z"
},
{
"body": "I think I see it in both \"top-level\" `pom.xml` files...\r\n\r\n- https://github.com/google/guava/blob/0b1c477311b2c7a0a89f5e0ac785084e3ab15d34/pom.xml#L214\r\n- https://github.com/google/guava/blob/0b1c477311b2c7a0a89f5e0ac785084e3ab15d34/android/pom.xml#L219\r\n\r\n...and in neither `guava/pom.xml` file...\r\n\r\n- https://github.com/google/guava/blob/0b1c477311b2c7a0a89f5e0ac785084e3ab15d34/guava/pom.xml\r\n- https://github.com/google/guava/blob/0b1c477311b2c7a0a89f5e0ac785084e3ab15d34/android/guava/pom.xml\r\n\r\nThat probably makes sense? Or if we need it here, we probably need it in `android/guava/pom.xml`.",
"created_at": "2024-03-08T15:05:16Z"
},
{
"body": "Oh, I guess that I skimmed past this, too. My guess is that fail-fast is useful here because `verify` doesn't necessarily work right without `install` first: https://github.com/google/guava/issues/2193#issuecomment-148682832. The main thing that _not_ failing fast may help with is running certain tests that would otherwise be skipped (e.g., running the main tests if the GWT compile fails). My guess is that failing fast is actually more often valuable, given that we run tests internally as part of the submit process: If something fails, it's usually that we're missing a Maven tweak, so we'd rather find out quickly so that we can fix things. Do you think that disabling fail-fast could still be worthwhile in our somewhat unusual circumstances?",
"created_at": "2024-03-11T15:48:02Z"
},
{
"body": "I had been a little scared to see what would happen when using a newer JDK for _docs_. But it's looking like an improvement: https://github.com/google/guava/issues/6790#issuecomment-1988762401\r\n\r\n\\[update later: [nope](https://github.com/google/guava/issues/6790#issuecomment-1995230826) :(\\]",
"created_at": "2024-03-11T15:48:48Z"
},
{
"body": "This can be removed now that #7092 has been merged",
"created_at": "2024-03-11T19:03:48Z"
},
{
"body": "@cpovirk Huh, that's an interesting take; I think this one is a matter of taste, actually, given what you've shared here. I usually disable `fail-fast` in multi-JVM builds, because maybe there is a failure on a JVM build that isn't caught because it is cancelled before it can surface.\r\n\r\nI'm usually staring at the build screen while it runs, so I will cancel runs that are obviously going to fail. `fail-fast` would usually catch these.\r\n\r\nOn balance, I suppose it helps to have it on while the PR is under development, but I have no opinion after that. Would you rather I remove it or keep it?\r\n\r\nRe/ #2193 each of these jobs runs on a separate runner machine, so the `mvn install` step should be running within the scope of a job-specific `.m2` local repository. The `mvn install` step is necessary because Maven has trouble resolving dependencies from projects inside the build. But that shouldn't interfere with the test matrix here, unless I'm missing something.",
"created_at": "2024-03-11T19:14:28Z"
},
{
"body": "For Windows, I think I'll just switch us to 21 (i.e., remove 17), updating the branch-protection rules around the same time.\r\n\r\n(Even with performance improvements possibly on the horizon, I worry about having more CI jobs. My hope would be that one Windows job is enough: The main thing is to avoid embarrassing \"Windows does not work\" bugs like the one I introduced not so long ago.)",
"created_at": "2024-03-12T19:23:10Z"
},
{
"body": "Oops, thanks, I was mixing up `fail-fast` and `continue-on-error`. So my point about \"running the main tests if the GWT compile fails\" is not actually what we're talking about.\r\n\r\nI do see more value in continuing with, e.g., JDK 11 if the JDK 8 build fails because of an annoying problem with old versions of javac :) But then it's also sad to have to wait for JDK 11 to run all the tests before you get a notification about the JDK 8 build failure, and that's how it would often go for our internal workflow. Or maybe not? I'm not actually 100% sure whether Copybara fails the submit (and notifies the user) as soon as it sees a failure or not. (How could I know, given that we have `fail-fast` on? :))\r\n\r\nI guess my other fear would be that we're burning resources. I thought maybe I'd once heard that the `google` org's various projects may be competing with each other for resources? If so, then I wouldn't want to spend more on a build that is likely to fail. At this point, that's probably the main thing keeping me from giving it a try to see how Copybara behaves.\r\n\r\n(For that matter, we could consider dropping one of the older Java releases to prevent our resource usage from growing on that account. Presumably we'd drop either 11 or 17, since that would keep coverage of the \"endpoints.\" Our internal tests run under 21 nowadays—but obviously with the `SecurityManager` deprecation dialed back by default at the moment :))\r\n\r\nI could probably go back and forth on this all day. I'll just leave this out in the internal change for now for the sake of getting the build working under newer JDKs. If you want to queue up `fail-fast` as a separate PR with a link back here, then... we'll probably let it sit forever unless something changes, but if we ever do merge it, your name will get attached :)",
"created_at": "2024-03-12T19:28:46Z"
},
{
"body": "Roger that",
"created_at": "2024-03-12T19:55:48Z"
}
],
"title": "Fix: Java 18+ Builds"
} | {
"commits": [
{
"message": "fix: build against jvm21\n\n- fix: build against embedded jdk sources needs `--enable-preview`\n when built against jvm21\n\n- fix: add `-Djava.security.manager=allow` to fix security manager\n tests under modern java\n\nFixes and closes google/guava#7065\n\nSigned-off-by: Sam Gammon <sam@elide.ventures>"
},
{
"message": "chore(ci): bump ci jdk → jdk21\n\nSigned-off-by: Sam Gammon <sam@elide.ventures>"
}
],
"files": [
{
"diff": "@@ -20,11 +20,11 @@ jobs:\n strategy:\n matrix:\n os: [ ubuntu-latest ]\n- java: [ 8, 11, 17 ]\n+ java: [ 8, 11, 17, 21 ]\n root-pom: [ 'pom.xml', 'android/pom.xml' ]\n include:\n - os: windows-latest\n- java: 17\n+ java: 21\n root-pom: pom.xml\n runs-on: ${{ matrix.os }}\n env:\n@@ -68,11 +68,10 @@ jobs:\n steps:\n - name: 'Check out repository'\n uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 # v4.1.2\n- - name: 'Set up JDK 11'\n+ - name: 'Set up JDK 21'\n uses: actions/setup-java@9704b39bf258b59bc04b50fa2dd55e9ed76b47a8 # v4.1.0\n-\n with:\n- java-version: 11\n+ java-version: 21\n distribution: 'zulu'\n server-id: sonatype-nexus-snapshots\n server-username: CI_DEPLOY_USERNAME\n@@ -94,11 +93,10 @@ jobs:\n steps:\n - name: 'Check out repository'\n uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 # v4.1.2\n- - name: 'Set up JDK 11'\n+ - name: 'Set up JDK 21'\n uses: actions/setup-java@9704b39bf258b59bc04b50fa2dd55e9ed76b47a8 # v4.1.0\n-\n with:\n- java-version: 11\n+ java-version: 21\n distribution: 'zulu'\n cache: 'maven'\n - name: 'Generate latest docs'",
"filename": ".github/workflows/ci.yml",
"status": "modified"
},
{
"diff": "@@ -25,6 +25,7 @@\n <project.build.outputTimestamp>2024-01-02T00:00:00Z</project.build.outputTimestamp>\n <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>\n <test.add.opens></test.add.opens>\n+ <test.add.args></test.add.args>\n <module.status>integration</module.status>\n <variant.jvmEnvironment>android</variant.jvmEnvironment>\n <variant.jvmEnvironmentVariantName>android</variant.jvmEnvironmentVariantName>\n@@ -253,7 +254,7 @@\n <runOrder>alphabetical</runOrder>\n <!-- Set max heap for tests. -->\n <!-- Catch dependencies on the default locale by setting it to hi-IN. -->\n- <argLine>-Xmx1536M -Duser.language=hi -Duser.country=IN ${test.add.opens}</argLine>\n+ <argLine>-Xmx1536M -Duser.language=hi -Duser.country=IN ${test.add.args} ${test.add.opens}</argLine>\n </configuration>\n </plugin>\n <plugin>\n@@ -462,5 +463,18 @@\n </plugins>\n </build>\n </profile>\n+ <profile>\n+ <id>javac-for-jvm18plus</id>\n+ <activation>\n+ <!--\n+ To build and run the tests against JDK 18+, we need to pass java.security.manager=allow, to allow use of\n+ the deprecated 'java.lang.SecurityManager' class.\n+ -->\n+ <jdk>[18,]</jdk>\n+ </activation>\n+ <properties>\n+ <test.add.args>-Djava.security.manager=allow</test.add.args>\n+ </properties>\n+ </profile>\n </profiles>\n </project>",
"filename": "android/pom.xml",
"status": "modified"
},
{
"diff": "@@ -25,6 +25,7 @@\n <project.build.outputTimestamp>2024-01-02T00:00:00Z</project.build.outputTimestamp>\n <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>\n <test.add.opens></test.add.opens>\n+ <test.add.args></test.add.args>\n <module.status>integration</module.status>\n <variant.jvmEnvironment>standard-jvm</variant.jvmEnvironment>\n <variant.jvmEnvironmentVariantName>jre</variant.jvmEnvironmentVariantName>\n@@ -177,6 +178,13 @@\n <groupId>org.codehaus.mojo</groupId>\n <artifactId>animal-sniffer-maven-plugin</artifactId>\n <version>1.23</version>\n+ <dependencies>\n+ <dependency>\n+ <groupId>org.ow2.asm</groupId>\n+ <artifactId>asm</artifactId>\n+ <version>9.6</version>\n+ </dependency>\n+ </dependencies>\n <configuration>\n <annotations>com.google.common.base.IgnoreJRERequirement,com.google.common.collect.IgnoreJRERequirement,com.google.common.hash.IgnoreJRERequirement,com.google.common.io.IgnoreJRERequirement,com.google.common.reflect.IgnoreJRERequirement,com.google.common.testing.IgnoreJRERequirement</annotations>\n <checkTestClasses>true</checkTestClasses>\n@@ -248,7 +256,7 @@\n <runOrder>alphabetical</runOrder>\n <!-- Set max heap for tests. -->\n <!-- Catch dependencies on the default locale by setting it to hi-IN. -->\n- <argLine>-Xmx1536M -Duser.language=hi -Duser.country=IN ${test.add.opens}</argLine>\n+ <argLine>-Xmx1536M -Duser.language=hi -Duser.country=IN ${test.add.args} ${test.add.opens}</argLine>\n </configuration>\n </plugin>\n <plugin>\n@@ -457,5 +465,18 @@\n </plugins>\n </build>\n </profile>\n+ <profile>\n+ <id>javac-for-jvm18plus</id>\n+ <activation>\n+ <!--\n+ To build and run the tests against JDK 18+, we need to pass java.security.manager=allow, to allow use of\n+ the deprecated 'java.lang.SecurityManager' class.\n+ -->\n+ <jdk>[18,]</jdk>\n+ </activation>\n+ <properties>\n+ <test.add.args>-Djava.security.manager=allow</test.add.args>\n+ </properties>\n+ </profile>\n </profiles>\n </project>",
"filename": "pom.xml",
"status": "modified"
}
]
} |
{
"body": "Let `p` be an `EndpointPair<Integer>`. The method [AbstractBaseGraph#edges](https://github.com/google/guava/blob/master/guava/src/com/google/common/graph/AbstractBaseGraph.java) can return a `Set<EndpointPair<Integer>> edges` for which `edges.contains(p)` is `true`, but `e.equals(p)` is `false` for each element `e`. This violates the contract of [java.util.Collection#contains](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html):\r\n\r\n> Returns true if this collection contains the specified element. More formally, returns true if and only if this collection contains at least one element e such that Objects.equals(o, e).\r\n\r\nNote the failing assertion in the following test:\r\n\r\n```java\r\n@Test\r\npublic void contains_contract_violated() {\r\n MutableGraph<Integer> undirectedGraph = GraphBuilder.undirected().build();\r\n undirectedGraph.putEdge(1, 2);\r\n Set<EndpointPair<Integer>> edges = undirectedGraph.edges();\r\n EndpointPair<Integer> ordered = EndpointPair.ordered(1, 2);\r\n Assertions.assertTrue(edges.contains(ordered));\r\n Assertions.assertTrue(edges.stream().anyMatch(ordered::equals)); // fails\r\n}\r\n```\r\n\r\n",
"comments": [
{
"body": "The `Graph` implementation that is returned by [AbstractNetwork#asGraph](https://github.com/google/guava/blob/master/guava/src/com/google/common/graph/AbstractNetwork.java) has a similar problem. Note that this anonymous inner class does not extend `AbstractBaseGraph`.\r\n\r\n```java\r\n@Test\r\npublic void network_asGraph_similar_issue() {\r\n MutableNetwork<Integer, String> network = NetworkBuilder.undirected()\r\n .build();\r\n network.addEdge(1, 2, \"1-2\");\r\n Graph<Integer> graph = network.asGraph();\r\n Set<EndpointPair<Integer>> edges = graph.edges();\r\n EndpointPair<Integer> ordered = EndpointPair.ordered(1, 2);\r\n Assertions.assertTrue(edges.contains(ordered));\r\n Assertions.assertTrue(edges.stream().anyMatch(ordered::equals)); // fails\r\n}\r\n```",
"created_at": "2021-12-22T09:44:38Z"
},
{
"body": "I've investigated this a bit out of interest, and I think the problem is that `AbstractBaseGraph#edges` returns a custom set with an unusual `contains` implementation.\r\n\r\nhttps://github.com/google/guava/blob/448e326ee1ea0b45b81945b57af93198620ada53/guava/src/com/google/common/graph/AbstractBaseGraph.java#L86-L96\r\n\r\nSpecifically, it uses a custom method: `isOrderingCompatible`, which compares the ordering of a given `EndpointPair` differently to `EndpointPair#equals`.\r\n\r\nhttps://github.com/google/guava/blob/448e326ee1ea0b45b81945b57af93198620ada53/guava/src/com/google/common/graph/AbstractBaseGraph.java#L180-L182\r\n\r\nBy comparison, here's the javadoc for `EndpointPair#equals`.\r\n\r\nhttps://github.com/google/guava/blob/448e326ee1ea0b45b81945b57af93198620ada53/guava/src/com/google/common/graph/EndpointPair.java#L131-L137",
"created_at": "2021-12-22T15:43:12Z"
},
{
"body": "For clarity, I've investigated `GraphBuilder.undirected()`, but not `NetworkBuilder.undirected()`.",
"created_at": "2021-12-22T15:45:09Z"
},
{
"body": "I suppose the next question is: is this difference to the `Collection#contains` contract intended?\r\n\r\nI can see an advantage to the current approach. It allows all these assertions to pass:\r\n\r\n```java\r\n @Test\r\n public void test1() {\r\n MutableGraph<Integer> undirectedGraph = GraphBuilder.undirected().build();\r\n undirectedGraph.putEdge(1, 2);\r\n assertThat(undirectedGraph.edges().contains(EndpointPair.ordered(1, 2))).isTrue(); // passes\r\n assertThat(undirectedGraph.edges().contains(EndpointPair.ordered(2, 1))).isTrue(); // passes\r\n assertThat(undirectedGraph.edges().contains(EndpointPair.unordered(1, 2))).isTrue(); // passes\r\n assertThat(undirectedGraph.edges().contains(EndpointPair.unordered(2, 1))).isTrue(); // passes\r\n } \r\n```\r\n\r\nBy comparison, using `EndpointPair#equals`:\r\n\r\n```java\r\n @Test\r\n public void test2() {\r\n MutableGraph<Integer> undirectedGraph = GraphBuilder.undirected().build();\r\n undirectedGraph.putEdge(1, 2);\r\n EndpointPair<Integer> undirectedEdge = undirectedGraph.edges().iterator().next();\r\n assertThat(undirectedEdge.equals(EndpointPair.ordered(1, 2))).isTrue(); // fails\r\n assertThat(undirectedEdge.equals(EndpointPair.ordered(2, 1))).isTrue(); // fails\r\n assertThat(undirectedEdge.equals(EndpointPair.unordered(1, 2))).isTrue(); // passes\r\n assertThat(undirectedEdge.equals(EndpointPair.unordered(2, 1))).isTrue(); // passes\r\n }\r\n```\r\n\r\n@jrtom Do you have any thoughts on this? I hope you don't mind me including you in this discussion.",
"created_at": "2021-12-22T16:06:44Z"
},
{
"body": "I haven't been involved in this, but it was interesting enough that I skimmed through the history.\r\n\r\nIt looks like this used to be \"correct\" but was pretty explicitly \"broken\" by a subsequent change. The change was definitely intended to make different `EndpointPair` instances more easily interchangeable, so it was \"intentional\" in some sense, but I'm not sure that `contains` behavior specifically came up in the discussion, as I think there were many methods involved.\r\n\r\nI would default to saying that this is \"wrong,\" but there have been so many tricky tradeoffs involved in the design of `common.graph` that I can easily imagine that this ends up being a lesser evil.",
"created_at": "2021-12-22T19:48:18Z"
},
{
"body": "I'm able to change `isOrderingCompatible` to `endpoints.isOrdered() == this.isDirected()` without breaking anything in Google's codebase except our own tests. That's still not to say that we should do that, just that _a lot of breakages_ would have been practically prevented us from changing the behavior.",
"created_at": "2021-12-23T14:11:04Z"
},
{
"body": "There's an interesting method in `TestUtil`.\r\nSeems like the original intention was to implement `Set` according to specs:\r\n\r\n```java\r\n/**\r\n * In some cases our graph implementations return custom sets that define their own size() and\r\n * contains(). Verify that these sets are consistent with the elements of their iterator.\r\n */\r\nstatic <T> Set<T> sanityCheckSet(Set<T> set) {\r\n assertThat(set).hasSize(Iterators.size(set.iterator()));\r\n for (Object element : set) {\r\n assertThat(set).contains(element);\r\n }\r\n assertThat(set).doesNotContain(new Object());\r\n assertThat(set).isEqualTo(Util.setOf(set));\r\n return set;\r\n}\r\n```\r\n",
"created_at": "2021-12-25T08:52:50Z"
},
{
"body": "@h908714124 thanks for the catch. This is a bug. It arose from a bug fix, but @cpovirk is correct that the behavior of `contains()` didn't specifically come up in the review (@cpovirk, the API review which led to this change included \"endpoint ordering mismatches\" in the title if you want to look it up).\r\n\r\n@jbduncan thanks for the analysis; you are correct about the cause.\r\n\r\nThe original review was about fixing undefined behavior for mutations involving the case where someone added an unordered `EndpointPair` to a directed graph (the behavior is undefined, because the assignment of “nodeU” and “nodeV” to the endpoints is arbitrary).\r\n\r\nUnfortunately, I think that I got a bit too cute with the solution (and I don't think any of the reviewers noticed the problem). Technically adding an ordered edge `<u, v>` to an undirected graph is...not invalid, because the graph can simply ignore the directionality of the endpoints. Our mistake was that we should not have (implicitly) concluded that you can say that the resultant graph _contains_ a directed edge `<u, v>` if there is an undirected edge connecting `u` and `v`.\r\n\r\nAs @h908714124 pointed out, we should not have defined `contains()` in such a way as to be inconsistent with `equals()` (that's clearly a violation of the `Set` contract as well as being weird) and it is also clear that an unordered `EndpointPair` should never be equal to an ordered `EndpointPair`. Therefore we need to fix the `contains()` behavior.\r\n\r\n@cpovirk, since you've apparently already identified the failing tests (which implies that you have a CL with this change), I'd be happy to review a fix for this. Otherwise I'll try to get to it.",
"created_at": "2022-01-19T03:16:17Z"
},
{
"body": "Sadly, I have a CL that blindly changes how `isOrderingCompatible` works (CL 417851751), not one that targets the behavior in `edges`. Maybe the real fix is as simple as changing the `edges` method's _call_ to `isOrderingCompatible`. But I am happy to leave that to you to maybe get to sometime... :)",
"created_at": "2022-01-20T15:53:25Z"
},
{
"body": "You're right that we can't simply change how `isOrderingCompatible` works because the semantics (as conceived in that API review) are different for mutation and for `edges.contains()`, as noted above.\r\n\r\nThis method is also used for `hasEdgeConnecting()`:\r\n\r\n```java\r\n@Override\r\n public boolean hasEdgeConnecting(EndpointPair<N> endpoints) {\r\n checkNotNull(endpoints);\r\n if (!isOrderingCompatible(endpoints)) {\r\n return false;\r\n }\r\n N nodeU = endpoints.nodeU();\r\n N nodeV = endpoints.nodeV();\r\n return nodes().contains(nodeU) && successors(nodeU).contains(nodeV);\r\n }\r\n```\r\n\r\nwhose contract specifies:\r\n\r\n```java\r\n/**\r\n * Returns true if there is an edge that directly connects {@code endpoints} (in the order, if\r\n * any, specified by {@code endpoints}). This is equivalent to {@code\r\n * edges().contains(endpoints)}.\r\n```\r\n\r\nThis implies that the semantic change needed for `edges().contains()` would also need to apply to `hasEdgeConnecting()`. This would leave `Mutable*.{add,put}Edge()` as the only place where one can supply an ordered edge to an undirected graph and have it \"work\".\r\n\r\nAt that point, I'm not 100% sure whether it makes sense to continue special-casing mutations in that way. Would be interested in hearing other opinions on this.",
"created_at": "2022-01-20T16:42:06Z"
},
{
"body": "Do Google's internal search tools allow queries like the following?\r\n\r\n> How much code do we have like `graph.edges().contains(endpointPair)` or `graph.putEdge(endpointPair)`, where `graph` is an instance of `Graph`, `ValueGraph` or `Network`, and `graph.isDirected() != endpointPair.isOrdered()`?\r\n\r\nIf so, I think this would allow the potential disruption of any change to be measured.\r\n\r\nOtherwise, my gut feeling is for `directedGraph.edges().contains(undirectedEndpointPair)` to always be `false`, and for `directedGraph.putEdge(undirectedEndpointPair)` to never \"work\".",
"created_at": "2022-01-20T17:45:11Z"
},
{
"body": "Thanks, @jbduncan.\r\n\r\n> How much code do we have like graph.edges().contains(endpointPair) or graph.putEdge(endpointPair), where graph is an instance of Graph, ValueGraph or Network, and graph.isDirected() != endpointPair.isOrdered()?\r\n\r\nAs far as I can tell, neither of these cases exist in Google's code base. However, that doesn't tell us whether they exist in the rest of the world. :)\r\n\r\n> Otherwise, my gut feeling is for `directedGraph.edges().contains(undirectedEndpointPair)` to always be false\r\n\r\nI think we've settled on this change: that was the original subject of this issue, and I agree that we need to not violate the `Set.contains()` contract. Since we have an existing contract for `hasEdgeConnecting()` that requires that it be consistent with `edges().contains()`, that means that behavior needs to change as well.\r\n\r\n> and for directedGraph.putEdge(undirectedEndpointPair) to never \"work\".\r\n\r\nThis is the remaining question, yes. :)",
"created_at": "2022-01-21T02:18:18Z"
},
{
"body": "Fix applied above per https://github.com/google/guava/pull/6058. \r\n\r\nThe practical results:\r\n* It is no longer legal to add directed edges to undirected graphs (they will now not be silently interpreted as undirected, but will instead throw an IllegalArgumentException). \r\n* Undirected graphs will no longer (improperly) report that they contain any directed edges.\r\n\r\nAs a result, all ordering/directionality mismatches are handled identically, rather than allowing undirected graphs to be more permissive than directed graphs.\r\n",
"created_at": "2022-05-25T03:13:36Z"
}
],
"number": 5843,
"title": "Contract of Collection.contains violated in AbstractBaseGraph.edges "
} | {
"body": "Fix issue #5843\n\nRELNOTES=Fix issue #5843\n",
"number": 6058,
"review_comments": [],
"title": "Fix issue #5843"
} | {
"commits": [
{
"message": "Fix issue #5843\n\nRELNOTES=Fix issue #5843\nPiperOrigin-RevId: 449127443"
}
],
"files": [
{
"diff": "@@ -166,8 +166,8 @@ public void hasEdgeConnecting_correct() {\n @Test\n public void hasEdgeConnecting_mismatch() {\n putEdge(N1, N2);\n- assertThat(graph.hasEdgeConnecting(EndpointPair.ordered(N1, N2))).isTrue();\n- assertThat(graph.hasEdgeConnecting(EndpointPair.ordered(N2, N1))).isTrue();\n+ assertThat(graph.hasEdgeConnecting(EndpointPair.ordered(N1, N2))).isFalse();\n+ assertThat(graph.hasEdgeConnecting(EndpointPair.ordered(N2, N1))).isFalse();\n }\n \n @Test",
"filename": "android/guava-tests/test/com/google/common/graph/AbstractStandardUndirectedGraphTest.java",
"status": "modified"
},
{
"diff": "@@ -16,6 +16,7 @@\n \n package com.google.common.graph;\n \n+import static com.google.common.graph.GraphConstants.ENDPOINTS_MISMATCH;\n import static com.google.common.truth.Truth.assertThat;\n import static com.google.common.truth.TruthJUnit.assume;\n import static org.junit.Assert.assertTrue;\n@@ -195,15 +196,30 @@ public void successors_checkReturnedSetMutability() {\n @Test\n public void edges_containsOrderMismatch() {\n addEdge(N1, N2, E12);\n- assertThat(network.asGraph().edges()).contains(ENDPOINTS_N2N1);\n- assertThat(network.asGraph().edges()).contains(ENDPOINTS_N1N2);\n+ assertThat(network.asGraph().edges()).doesNotContain(ENDPOINTS_N2N1);\n+ assertThat(network.asGraph().edges()).doesNotContain(ENDPOINTS_N1N2);\n+ }\n+\n+ @Test\n+ public void edgesConnecting_orderMismatch() {\n+ addEdge(N1, N2, E12);\n+ try {\n+ Set<String> unused = network.edgesConnecting(ENDPOINTS_N1N2);\n+ fail(\"Expected IllegalArgumentException: \" + ENDPOINTS_MISMATCH);\n+ } catch (IllegalArgumentException e) {\n+ assertThat(e).hasMessageThat().contains(ENDPOINTS_MISMATCH);\n+ }\n }\n \n @Test\n public void edgeConnectingOrNull_orderMismatch() {\n addEdge(N1, N2, E12);\n- assertThat(network.edgeConnectingOrNull(ENDPOINTS_N2N1)).isEqualTo(E12);\n- assertThat(network.edgeConnectingOrNull(ENDPOINTS_N1N2)).isEqualTo(E12);\n+ try {\n+ String unused = network.edgeConnectingOrNull(ENDPOINTS_N1N2);\n+ fail(\"Expected IllegalArgumentException: \" + ENDPOINTS_MISMATCH);\n+ } catch (IllegalArgumentException e) {\n+ assertThat(e).hasMessageThat().contains(ENDPOINTS_MISMATCH);\n+ }\n }\n \n @Test\n@@ -418,7 +434,7 @@ public void addEdge_existingEdgeBetweenDifferentNodes() {\n networkAsMutableNetwork.addEdge(N4, N5, E12);\n fail(ERROR_ADDED_EXISTING_EDGE);\n } catch (IllegalArgumentException e) {\n- assertThat(e.getMessage()).contains(ERROR_REUSE_EDGE);\n+ assertThat(e).hasMessageThat().contains(ERROR_REUSE_EDGE);\n }\n }\n \n@@ -432,13 +448,13 @@ public void addEdge_parallelEdge_notAllowed() {\n networkAsMutableNetwork.addEdge(N1, N2, EDGE_NOT_IN_GRAPH);\n fail(ERROR_ADDED_PARALLEL_EDGE);\n } catch (IllegalArgumentException e) {\n- assertThat(e.getMessage()).contains(ERROR_PARALLEL_EDGE);\n+ assertThat(e).hasMessageThat().contains(ERROR_PARALLEL_EDGE);\n }\n try {\n networkAsMutableNetwork.addEdge(N2, N1, EDGE_NOT_IN_GRAPH);\n fail(ERROR_ADDED_PARALLEL_EDGE);\n } catch (IllegalArgumentException e) {\n- assertThat(e.getMessage()).contains(ERROR_PARALLEL_EDGE);\n+ assertThat(e).hasMessageThat().contains(ERROR_PARALLEL_EDGE);\n }\n }\n \n@@ -458,7 +474,12 @@ public void addEdge_orderMismatch() {\n assume().that(graphIsMutable()).isTrue();\n \n EndpointPair<Integer> endpoints = EndpointPair.ordered(N1, N2);\n- assertThat(networkAsMutableNetwork.addEdge(endpoints, E12)).isTrue();\n+ try {\n+ networkAsMutableNetwork.addEdge(endpoints, E12);\n+ fail(\"Expected IllegalArgumentException: \" + ENDPOINTS_MISMATCH);\n+ } catch (IllegalArgumentException e) {\n+ assertThat(e).hasMessageThat().contains(ENDPOINTS_MISMATCH);\n+ }\n }\n \n @Test\n@@ -527,20 +548,20 @@ public void addEdge_existingEdgeBetweenDifferentNodes_selfLoops() {\n networkAsMutableNetwork.addEdge(N1, N2, E11);\n fail(\"Reusing an existing self-loop edge to connect different nodes succeeded\");\n } catch (IllegalArgumentException e) {\n- assertThat(e.getMessage()).contains(ERROR_REUSE_EDGE);\n+ assertThat(e).hasMessageThat().contains(ERROR_REUSE_EDGE);\n }\n try {\n networkAsMutableNetwork.addEdge(N2, N2, E11);\n fail(\"Reusing an existing self-loop edge to make a different self-loop edge succeeded\");\n } catch (IllegalArgumentException e) {\n- assertThat(e.getMessage()).contains(ERROR_REUSE_EDGE);\n+ assertThat(e).hasMessageThat().contains(ERROR_REUSE_EDGE);\n }\n addEdge(N1, N2, E12);\n try {\n networkAsMutableNetwork.addEdge(N1, N1, E12);\n fail(\"Reusing an existing edge to add a self-loop edge between different nodes succeeded\");\n } catch (IllegalArgumentException e) {\n- assertThat(e.getMessage()).contains(ERROR_REUSE_EDGE);\n+ assertThat(e).hasMessageThat().contains(ERROR_REUSE_EDGE);\n }\n }\n \n@@ -555,7 +576,7 @@ public void addEdge_parallelSelfLoopEdge_notAllowed() {\n networkAsMutableNetwork.addEdge(N1, N1, EDGE_NOT_IN_GRAPH);\n fail(\"Adding a parallel self-loop edge succeeded\");\n } catch (IllegalArgumentException e) {\n- assertThat(e.getMessage()).contains(ERROR_PARALLEL_EDGE);\n+ assertThat(e).hasMessageThat().contains(ERROR_PARALLEL_EDGE);\n }\n }\n ",
"filename": "android/guava-tests/test/com/google/common/graph/AbstractStandardUndirectedNetworkTest.java",
"status": "modified"
},
{
"diff": "@@ -214,8 +214,8 @@ public void endpointPair_undirected_contains() {\n assertThat(edges).contains(EndpointPair.unordered(N1, N2));\n assertThat(edges).contains(EndpointPair.unordered(N2, N1)); // equal to unordered(N1, N2)\n \n- // ordered endpoints OK for undirected graph (because ordering is irrelevant)\n- assertThat(edges).contains(EndpointPair.ordered(N1, N2));\n+ // ordered endpoints not compatible with undirected graph\n+ assertThat(edges).doesNotContain(EndpointPair.ordered(N1, N2));\n \n assertThat(edges).doesNotContain(EndpointPair.unordered(N2, N2)); // edge not present\n assertThat(edges).doesNotContain(EndpointPair.unordered(N3, N4)); // nodes not in graph",
"filename": "android/guava-tests/test/com/google/common/graph/EndpointPairTest.java",
"status": "modified"
},
{
"diff": "@@ -173,8 +173,8 @@ public void hasEdgeConnecting_undirected_backwards() {\n public void hasEdgeConnecting_undirected_mismatch() {\n graph = ValueGraphBuilder.undirected().build();\n graph.putEdgeValue(1, 2, \"A\");\n- assertThat(graph.hasEdgeConnecting(EndpointPair.ordered(1, 2))).isTrue();\n- assertThat(graph.hasEdgeConnecting(EndpointPair.ordered(2, 1))).isTrue();\n+ assertThat(graph.hasEdgeConnecting(EndpointPair.ordered(1, 2))).isFalse();\n+ assertThat(graph.hasEdgeConnecting(EndpointPair.ordered(2, 1))).isFalse();\n }\n \n @Test\n@@ -223,8 +223,19 @@ public void edgeValueOrDefault_undirected_backwards() {\n public void edgeValueOrDefault_undirected_mismatch() {\n graph = ValueGraphBuilder.undirected().build();\n graph.putEdgeValue(1, 2, \"A\");\n- assertThat(graph.edgeValueOrDefault(EndpointPair.ordered(2, 1), \"default\")).isEqualTo(\"A\");\n- assertThat(graph.edgeValueOrDefault(EndpointPair.ordered(2, 1), \"default\")).isEqualTo(\"A\");\n+ // Check that edgeValueOrDefault() throws on each possible ordering of an ordered EndpointPair\n+ try {\n+ String unused = graph.edgeValueOrDefault(EndpointPair.ordered(1, 2), \"default\");\n+ fail(\"Expected IllegalArgumentException: \" + ENDPOINTS_MISMATCH);\n+ } catch (IllegalArgumentException e) {\n+ assertThat(e).hasMessageThat().contains(ENDPOINTS_MISMATCH);\n+ }\n+ try {\n+ String unused = graph.edgeValueOrDefault(EndpointPair.ordered(2, 1), \"default\");\n+ fail(\"Expected IllegalArgumentException: \" + ENDPOINTS_MISMATCH);\n+ } catch (IllegalArgumentException e) {\n+ assertThat(e).hasMessageThat().contains(ENDPOINTS_MISMATCH);\n+ }\n }\n \n @Test\n@@ -251,7 +262,12 @@ public void putEdgeValue_directed_orderMismatch() {\n @Test\n public void putEdgeValue_undirected_orderMismatch() {\n graph = ValueGraphBuilder.undirected().build();\n- assertThat(graph.putEdgeValue(EndpointPair.ordered(1, 2), \"irrelevant\")).isNull();\n+ try {\n+ graph.putEdgeValue(EndpointPair.ordered(1, 2), \"irrelevant\");\n+ fail(\"Expected IllegalArgumentException: \" + ENDPOINTS_MISMATCH);\n+ } catch (IllegalArgumentException e) {\n+ assertThat(e).hasMessageThat().contains(ENDPOINTS_MISMATCH);\n+ }\n }\n \n @Test\n@@ -311,7 +327,19 @@ public void removeEdge_directed_orderMismatch() {\n public void removeEdge_undirected_orderMismatch() {\n graph = ValueGraphBuilder.undirected().build();\n graph.putEdgeValue(1, 2, \"1-2\");\n- assertThat(graph.removeEdge(EndpointPair.ordered(1, 2))).isEqualTo(\"1-2\");\n+ // Check that removeEdge() throws on each possible ordering of an ordered EndpointPair\n+ try {\n+ graph.removeEdge(EndpointPair.ordered(1, 2));\n+ fail(\"Expected IllegalArgumentException: \" + ENDPOINTS_MISMATCH);\n+ } catch (IllegalArgumentException e) {\n+ assertThat(e).hasMessageThat().contains(ENDPOINTS_MISMATCH);\n+ }\n+ try {\n+ graph.removeEdge(EndpointPair.ordered(2, 1));\n+ fail(\"Expected IllegalArgumentException: \" + ENDPOINTS_MISMATCH);\n+ } catch (IllegalArgumentException e) {\n+ assertThat(e).hasMessageThat().contains(ENDPOINTS_MISMATCH);\n+ }\n }\n \n @Test",
"filename": "android/guava-tests/test/com/google/common/graph/ValueGraphTest.java",
"status": "modified"
},
{
"diff": "@@ -177,7 +177,11 @@ protected final void validateEndpoints(EndpointPair<?> endpoints) {\n checkArgument(isOrderingCompatible(endpoints), ENDPOINTS_MISMATCH);\n }\n \n+ /**\n+ * Returns {@code true} iff {@code endpoints}' ordering is compatible with the directionality of\n+ * this graph.\n+ */\n protected final boolean isOrderingCompatible(EndpointPair<?> endpoints) {\n- return endpoints.isOrdered() || !this.isDirected();\n+ return endpoints.isOrdered() == this.isDirected();\n }\n }",
"filename": "android/guava/src/com/google/common/graph/AbstractBaseGraph.java",
"status": "modified"
},
{
"diff": "@@ -241,7 +241,7 @@ protected final void validateEndpoints(EndpointPair<?> endpoints) {\n }\n \n protected final boolean isOrderingCompatible(EndpointPair<?> endpoints) {\n- return endpoints.isOrdered() || !this.isDirected();\n+ return endpoints.isOrdered() == this.isDirected();\n }\n \n @Override",
"filename": "android/guava/src/com/google/common/graph/AbstractNetwork.java",
"status": "modified"
},
{
"diff": "@@ -52,7 +52,7 @@ private GraphConstants() {}\n + \"adjacentNode(node) if you already have a node, or nodeU()/nodeV() if you don't.\";\n static final String EDGE_ALREADY_EXISTS = \"Edge %s already exists in the graph.\";\n static final String ENDPOINTS_MISMATCH =\n- \"Mismatch: unordered endpoints cannot be used with directed graphs\";\n+ \"Mismatch: endpoints' ordering is not compatible with directionality of the graph\";\n \n /** Singleton edge value for {@link Graph} implementations backed by {@link ValueGraph}s. */\n enum Presence {",
"filename": "android/guava/src/com/google/common/graph/GraphConstants.java",
"status": "modified"
},
{
"diff": "@@ -166,8 +166,8 @@ public void hasEdgeConnecting_correct() {\n @Test\n public void hasEdgeConnecting_mismatch() {\n putEdge(N1, N2);\n- assertThat(graph.hasEdgeConnecting(EndpointPair.ordered(N1, N2))).isTrue();\n- assertThat(graph.hasEdgeConnecting(EndpointPair.ordered(N2, N1))).isTrue();\n+ assertThat(graph.hasEdgeConnecting(EndpointPair.ordered(N1, N2))).isFalse();\n+ assertThat(graph.hasEdgeConnecting(EndpointPair.ordered(N2, N1))).isFalse();\n }\n \n @Test",
"filename": "guava-tests/test/com/google/common/graph/AbstractStandardUndirectedGraphTest.java",
"status": "modified"
},
{
"diff": "@@ -16,14 +16,15 @@\n \n package com.google.common.graph;\n \n+import static com.google.common.graph.GraphConstants.ENDPOINTS_MISMATCH;\n import static com.google.common.truth.Truth.assertThat;\n-import static com.google.common.truth.Truth8.assertThat;\n import static com.google.common.truth.TruthJUnit.assume;\n import static org.junit.Assert.assertTrue;\n import static org.junit.Assert.fail;\n \n import com.google.common.collect.ImmutableSet;\n import com.google.common.testing.EqualsTester;\n+import java.util.Optional;\n import java.util.Set;\n import org.junit.After;\n import org.junit.Test;\n@@ -196,29 +197,41 @@ public void successors_checkReturnedSetMutability() {\n @Test\n public void edges_containsOrderMismatch() {\n addEdge(N1, N2, E12);\n- assertThat(network.asGraph().edges()).contains(ENDPOINTS_N2N1);\n- assertThat(network.asGraph().edges()).contains(ENDPOINTS_N1N2);\n+ assertThat(network.asGraph().edges()).doesNotContain(ENDPOINTS_N2N1);\n+ assertThat(network.asGraph().edges()).doesNotContain(ENDPOINTS_N1N2);\n }\n \n @Test\n public void edgesConnecting_orderMismatch() {\n addEdge(N1, N2, E12);\n- assertThat(network.edgesConnecting(ENDPOINTS_N2N1)).containsExactly(E12);\n- assertThat(network.edgesConnecting(ENDPOINTS_N1N2)).containsExactly(E12);\n+ try {\n+ Set<String> unused = network.edgesConnecting(ENDPOINTS_N1N2);\n+ fail(\"Expected IllegalArgumentException: \" + ENDPOINTS_MISMATCH);\n+ } catch (IllegalArgumentException e) {\n+ assertThat(e).hasMessageThat().contains(ENDPOINTS_MISMATCH);\n+ }\n }\n \n @Test\n public void edgeConnecting_orderMismatch() {\n addEdge(N1, N2, E12);\n- assertThat(network.edgeConnecting(ENDPOINTS_N2N1)).hasValue(E12);\n- assertThat(network.edgeConnecting(ENDPOINTS_N1N2)).hasValue(E12);\n+ try {\n+ Optional<String> unused = network.edgeConnecting(ENDPOINTS_N1N2);\n+ fail(\"Expected IllegalArgumentException: \" + ENDPOINTS_MISMATCH);\n+ } catch (IllegalArgumentException e) {\n+ assertThat(e).hasMessageThat().contains(ENDPOINTS_MISMATCH);\n+ }\n }\n \n @Test\n public void edgeConnectingOrNull_orderMismatch() {\n addEdge(N1, N2, E12);\n- assertThat(network.edgeConnectingOrNull(ENDPOINTS_N2N1)).isEqualTo(E12);\n- assertThat(network.edgeConnectingOrNull(ENDPOINTS_N1N2)).isEqualTo(E12);\n+ try {\n+ String unused = network.edgeConnectingOrNull(ENDPOINTS_N1N2);\n+ fail(\"Expected IllegalArgumentException: \" + ENDPOINTS_MISMATCH);\n+ } catch (IllegalArgumentException e) {\n+ assertThat(e).hasMessageThat().contains(ENDPOINTS_MISMATCH);\n+ }\n }\n \n @Test\n@@ -433,7 +446,7 @@ public void addEdge_existingEdgeBetweenDifferentNodes() {\n networkAsMutableNetwork.addEdge(N4, N5, E12);\n fail(ERROR_ADDED_EXISTING_EDGE);\n } catch (IllegalArgumentException e) {\n- assertThat(e.getMessage()).contains(ERROR_REUSE_EDGE);\n+ assertThat(e).hasMessageThat().contains(ERROR_REUSE_EDGE);\n }\n }\n \n@@ -447,13 +460,13 @@ public void addEdge_parallelEdge_notAllowed() {\n networkAsMutableNetwork.addEdge(N1, N2, EDGE_NOT_IN_GRAPH);\n fail(ERROR_ADDED_PARALLEL_EDGE);\n } catch (IllegalArgumentException e) {\n- assertThat(e.getMessage()).contains(ERROR_PARALLEL_EDGE);\n+ assertThat(e).hasMessageThat().contains(ERROR_PARALLEL_EDGE);\n }\n try {\n networkAsMutableNetwork.addEdge(N2, N1, EDGE_NOT_IN_GRAPH);\n fail(ERROR_ADDED_PARALLEL_EDGE);\n } catch (IllegalArgumentException e) {\n- assertThat(e.getMessage()).contains(ERROR_PARALLEL_EDGE);\n+ assertThat(e).hasMessageThat().contains(ERROR_PARALLEL_EDGE);\n }\n }\n \n@@ -473,7 +486,12 @@ public void addEdge_orderMismatch() {\n assume().that(graphIsMutable()).isTrue();\n \n EndpointPair<Integer> endpoints = EndpointPair.ordered(N1, N2);\n- assertThat(networkAsMutableNetwork.addEdge(endpoints, E12)).isTrue();\n+ try {\n+ networkAsMutableNetwork.addEdge(endpoints, E12);\n+ fail(\"Expected IllegalArgumentException: \" + ENDPOINTS_MISMATCH);\n+ } catch (IllegalArgumentException e) {\n+ assertThat(e).hasMessageThat().contains(ENDPOINTS_MISMATCH);\n+ }\n }\n \n @Test\n@@ -542,20 +560,20 @@ public void addEdge_existingEdgeBetweenDifferentNodes_selfLoops() {\n networkAsMutableNetwork.addEdge(N1, N2, E11);\n fail(\"Reusing an existing self-loop edge to connect different nodes succeeded\");\n } catch (IllegalArgumentException e) {\n- assertThat(e.getMessage()).contains(ERROR_REUSE_EDGE);\n+ assertThat(e).hasMessageThat().contains(ERROR_REUSE_EDGE);\n }\n try {\n networkAsMutableNetwork.addEdge(N2, N2, E11);\n fail(\"Reusing an existing self-loop edge to make a different self-loop edge succeeded\");\n } catch (IllegalArgumentException e) {\n- assertThat(e.getMessage()).contains(ERROR_REUSE_EDGE);\n+ assertThat(e).hasMessageThat().contains(ERROR_REUSE_EDGE);\n }\n addEdge(N1, N2, E12);\n try {\n networkAsMutableNetwork.addEdge(N1, N1, E12);\n fail(\"Reusing an existing edge to add a self-loop edge between different nodes succeeded\");\n } catch (IllegalArgumentException e) {\n- assertThat(e.getMessage()).contains(ERROR_REUSE_EDGE);\n+ assertThat(e).hasMessageThat().contains(ERROR_REUSE_EDGE);\n }\n }\n \n@@ -570,7 +588,7 @@ public void addEdge_parallelSelfLoopEdge_notAllowed() {\n networkAsMutableNetwork.addEdge(N1, N1, EDGE_NOT_IN_GRAPH);\n fail(\"Adding a parallel self-loop edge succeeded\");\n } catch (IllegalArgumentException e) {\n- assertThat(e.getMessage()).contains(ERROR_PARALLEL_EDGE);\n+ assertThat(e).hasMessageThat().contains(ERROR_PARALLEL_EDGE);\n }\n }\n ",
"filename": "guava-tests/test/com/google/common/graph/AbstractStandardUndirectedNetworkTest.java",
"status": "modified"
},
{
"diff": "@@ -214,8 +214,8 @@ public void endpointPair_undirected_contains() {\n assertThat(edges).contains(EndpointPair.unordered(N1, N2));\n assertThat(edges).contains(EndpointPair.unordered(N2, N1)); // equal to unordered(N1, N2)\n \n- // ordered endpoints OK for undirected graph (because ordering is irrelevant)\n- assertThat(edges).contains(EndpointPair.ordered(N1, N2));\n+ // ordered endpoints not compatible with undirected graph\n+ assertThat(edges).doesNotContain(EndpointPair.ordered(N1, N2));\n \n assertThat(edges).doesNotContain(EndpointPair.unordered(N2, N2)); // edge not present\n assertThat(edges).doesNotContain(EndpointPair.unordered(N3, N4)); // nodes not in graph",
"filename": "guava-tests/test/com/google/common/graph/EndpointPairTest.java",
"status": "modified"
},
{
"diff": "@@ -175,8 +175,8 @@ public void hasEdgeConnecting_undirected_backwards() {\n public void hasEdgeConnecting_undirected_mismatch() {\n graph = ValueGraphBuilder.undirected().build();\n graph.putEdgeValue(1, 2, \"A\");\n- assertThat(graph.hasEdgeConnecting(EndpointPair.ordered(1, 2))).isTrue();\n- assertThat(graph.hasEdgeConnecting(EndpointPair.ordered(2, 1))).isTrue();\n+ assertThat(graph.hasEdgeConnecting(EndpointPair.ordered(1, 2))).isFalse();\n+ assertThat(graph.hasEdgeConnecting(EndpointPair.ordered(2, 1))).isFalse();\n }\n \n @Test\n@@ -224,8 +224,19 @@ public void edgeValue_undirected_backwards() {\n public void edgeValue_undirected_mismatch() {\n graph = ValueGraphBuilder.undirected().build();\n graph.putEdgeValue(1, 2, \"A\");\n- assertThat(graph.edgeValue(EndpointPair.ordered(1, 2))).hasValue(\"A\");\n- assertThat(graph.edgeValue(EndpointPair.ordered(2, 1))).hasValue(\"A\");\n+ // Check that edgeValue() throws on each possible ordering of an ordered EndpointPair\n+ try {\n+ Optional<String> unused = graph.edgeValue(EndpointPair.ordered(1, 2));\n+ fail(\"Expected IllegalArgumentException: \" + ENDPOINTS_MISMATCH);\n+ } catch (IllegalArgumentException e) {\n+ assertThat(e).hasMessageThat().contains(ENDPOINTS_MISMATCH);\n+ }\n+ try {\n+ Optional<String> unused = graph.edgeValue(EndpointPair.ordered(2, 1));\n+ fail(\"Expected IllegalArgumentException: \" + ENDPOINTS_MISMATCH);\n+ } catch (IllegalArgumentException e) {\n+ assertThat(e).hasMessageThat().contains(ENDPOINTS_MISMATCH);\n+ }\n }\n \n @Test\n@@ -274,8 +285,19 @@ public void edgeValueOrDefault_undirected_backwards() {\n public void edgeValueOrDefault_undirected_mismatch() {\n graph = ValueGraphBuilder.undirected().build();\n graph.putEdgeValue(1, 2, \"A\");\n- assertThat(graph.edgeValueOrDefault(EndpointPair.ordered(2, 1), \"default\")).isEqualTo(\"A\");\n- assertThat(graph.edgeValueOrDefault(EndpointPair.ordered(2, 1), \"default\")).isEqualTo(\"A\");\n+ // Check that edgeValueOrDefault() throws on each possible ordering of an ordered EndpointPair\n+ try {\n+ String unused = graph.edgeValueOrDefault(EndpointPair.ordered(1, 2), \"default\");\n+ fail(\"Expected IllegalArgumentException: \" + ENDPOINTS_MISMATCH);\n+ } catch (IllegalArgumentException e) {\n+ assertThat(e).hasMessageThat().contains(ENDPOINTS_MISMATCH);\n+ }\n+ try {\n+ String unused = graph.edgeValueOrDefault(EndpointPair.ordered(2, 1), \"default\");\n+ fail(\"Expected IllegalArgumentException: \" + ENDPOINTS_MISMATCH);\n+ } catch (IllegalArgumentException e) {\n+ assertThat(e).hasMessageThat().contains(ENDPOINTS_MISMATCH);\n+ }\n }\n \n @Test\n@@ -302,7 +324,12 @@ public void putEdgeValue_directed_orderMismatch() {\n @Test\n public void putEdgeValue_undirected_orderMismatch() {\n graph = ValueGraphBuilder.undirected().build();\n- assertThat(graph.putEdgeValue(EndpointPair.ordered(1, 2), \"irrelevant\")).isNull();\n+ try {\n+ graph.putEdgeValue(EndpointPair.ordered(1, 2), \"irrelevant\");\n+ fail(\"Expected IllegalArgumentException: \" + ENDPOINTS_MISMATCH);\n+ } catch (IllegalArgumentException e) {\n+ assertThat(e).hasMessageThat().contains(ENDPOINTS_MISMATCH);\n+ }\n }\n \n @Test\n@@ -362,7 +389,19 @@ public void removeEdge_directed_orderMismatch() {\n public void removeEdge_undirected_orderMismatch() {\n graph = ValueGraphBuilder.undirected().build();\n graph.putEdgeValue(1, 2, \"1-2\");\n- assertThat(graph.removeEdge(EndpointPair.ordered(1, 2))).isEqualTo(\"1-2\");\n+ // Check that removeEdge() throws on each possible ordering of an ordered EndpointPair\n+ try {\n+ graph.removeEdge(EndpointPair.ordered(1, 2));\n+ fail(\"Expected IllegalArgumentException: \" + ENDPOINTS_MISMATCH);\n+ } catch (IllegalArgumentException e) {\n+ assertThat(e).hasMessageThat().contains(ENDPOINTS_MISMATCH);\n+ }\n+ try {\n+ graph.removeEdge(EndpointPair.ordered(2, 1));\n+ fail(\"Expected IllegalArgumentException: \" + ENDPOINTS_MISMATCH);\n+ } catch (IllegalArgumentException e) {\n+ assertThat(e).hasMessageThat().contains(ENDPOINTS_MISMATCH);\n+ }\n }\n \n @Test",
"filename": "guava-tests/test/com/google/common/graph/ValueGraphTest.java",
"status": "modified"
},
{
"diff": "@@ -177,7 +177,11 @@ protected final void validateEndpoints(EndpointPair<?> endpoints) {\n checkArgument(isOrderingCompatible(endpoints), ENDPOINTS_MISMATCH);\n }\n \n+ /**\n+ * Returns {@code true} iff {@code endpoints}' ordering is compatible with the directionality of\n+ * this graph.\n+ */\n protected final boolean isOrderingCompatible(EndpointPair<?> endpoints) {\n- return endpoints.isOrdered() || !this.isDirected();\n+ return endpoints.isOrdered() == this.isDirected();\n }\n }",
"filename": "guava/src/com/google/common/graph/AbstractBaseGraph.java",
"status": "modified"
},
{
"diff": "@@ -253,7 +253,7 @@ protected final void validateEndpoints(EndpointPair<?> endpoints) {\n }\n \n protected final boolean isOrderingCompatible(EndpointPair<?> endpoints) {\n- return endpoints.isOrdered() || !this.isDirected();\n+ return endpoints.isOrdered() == this.isDirected();\n }\n \n @Override",
"filename": "guava/src/com/google/common/graph/AbstractNetwork.java",
"status": "modified"
},
{
"diff": "@@ -52,7 +52,7 @@ private GraphConstants() {}\n + \"adjacentNode(node) if you already have a node, or nodeU()/nodeV() if you don't.\";\n static final String EDGE_ALREADY_EXISTS = \"Edge %s already exists in the graph.\";\n static final String ENDPOINTS_MISMATCH =\n- \"Mismatch: unordered endpoints cannot be used with directed graphs\";\n+ \"Mismatch: endpoints' ordering is not compatible with directionality of the graph\";\n \n /** Singleton edge value for {@link Graph} implementations backed by {@link ValueGraph}s. */\n enum Presence {",
"filename": "guava/src/com/google/common/graph/GraphConstants.java",
"status": "modified"
}
]
} |
{
"body": "I noticed this mistake in Caffeine and my new tests fail for Guava. In both cases the mutable set of keys to load is provided to the user, who might downcast and add or remove an element. By doing so the loop iterating on them will not have the expected behavior. I believe wrapping with `Collections.unmodifiableSet(set)` would be a simple change and it is doubtful anyone did this.\r\n\r\nhttps://github.com/google/guava/blob/3072f4fe6dd57678886ba800efc9da4667abc366/guava/src/com/google/common/cache/LocalCache.java#L4034-L4043",
"comments": [],
"number": 5810,
"title": "CacheLoader.loadAll should not be allowed to modify the keys"
} | {
"body": "Do not allow `CacheLoader.loadAll` to modify the given set of keys.\n\nFixes #5810\n\nRELNOTES=n/a\n",
"number": 5858,
"review_comments": [],
"title": "Do not allow `CacheLoader.loadAll` to modify the given set of keys."
} | {
"commits": [
{
"message": "Do not allow `CacheLoader.loadAll` to modify the given set of keys.\n\nFixes #5810\n\nRELNOTES=n/a\nPiperOrigin-RevId: 414430350"
}
],
"files": [
{
"diff": "@@ -21,6 +21,7 @@\n import static com.google.common.util.concurrent.Futures.transform;\n import static com.google.common.util.concurrent.MoreExecutors.directExecutor;\n import static com.google.common.util.concurrent.Uninterruptibles.getUninterruptibly;\n+import static java.util.Collections.unmodifiableSet;\n import static java.util.concurrent.TimeUnit.NANOSECONDS;\n \n import com.google.common.annotations.GwtCompatible;\n@@ -3921,7 +3922,7 @@ ImmutableMap<K, V> getAll(Iterable<? extends K> keys) throws ExecutionException\n try {\n if (!keysToLoad.isEmpty()) {\n try {\n- Map<K, V> newEntries = loadAll(keysToLoad, defaultLoader);\n+ Map<K, V> newEntries = loadAll(unmodifiableSet(keysToLoad), defaultLoader);\n for (K key : keysToLoad) {\n V value = newEntries.get(key);\n if (value == null) {",
"filename": "android/guava/src/com/google/common/cache/LocalCache.java",
"status": "modified"
},
{
"diff": "@@ -21,6 +21,7 @@\n import static com.google.common.util.concurrent.Futures.transform;\n import static com.google.common.util.concurrent.MoreExecutors.directExecutor;\n import static com.google.common.util.concurrent.Uninterruptibles.getUninterruptibly;\n+import static java.util.Collections.unmodifiableSet;\n import static java.util.concurrent.TimeUnit.NANOSECONDS;\n \n import com.google.common.annotations.GwtCompatible;\n@@ -4032,7 +4033,7 @@ ImmutableMap<K, V> getAll(Iterable<? extends K> keys) throws ExecutionException\n try {\n if (!keysToLoad.isEmpty()) {\n try {\n- Map<K, V> newEntries = loadAll(keysToLoad, defaultLoader);\n+ Map<K, V> newEntries = loadAll(unmodifiableSet(keysToLoad), defaultLoader);\n for (K key : keysToLoad) {\n V value = newEntries.get(key);\n if (value == null) {",
"filename": "guava/src/com/google/common/cache/LocalCache.java",
"status": "modified"
}
]
} |
{
"body": "1. Go to https://guava.dev/releases/30.1.1-jre/api/docs/\r\n2. Search for \"unsignedbytes\"\r\n3. Get redirected to https://guava.dev/releases/30.1.1-jre/api/docs/undefined/com/google/common/primitives/UnsignedBytes.html which returns HTTP 404.",
"comments": [
{
"body": "Thanks. We'll need to do the same thing as https://github.com/google/truth/issues/670 (which might also be what we did for https://github.com/google/error-prone/issues/1825, but I haven't looked).",
"created_at": "2021-03-31T10:28:55Z"
},
{
"body": "(As noted on the Truth issue, you might like an alternative that we added, which is to navigate to [guava.dev/unsignedbytes](http://guava.dev/unsignedbytes). But we'll fix search, too.)",
"created_at": "2021-03-31T10:32:59Z"
},
{
"body": "@cpovirk I looked at the issue you linked to but it sounds like everyone is implementing a workaround instead of fixing the underlying problem. Did anyone file a bug report against the Javadoc tool?",
"created_at": "2021-03-31T15:03:16Z"
},
{
"body": "It looks like it: [JDK-8215291](https://bugs.openjdk.java.net/browse/JDK-8215291).",
"created_at": "2021-03-31T15:17:56Z"
},
{
"body": "@cpovirk Good find. I'll add it to the Stackoverflow discussion.",
"created_at": "2021-03-31T15:44:22Z"
},
{
"body": "Hi, any news about this issue? I use Guava's Javadoc often and this bug is very annoying.\r\n\r\nThanks :)",
"created_at": "2021-07-17T16:53:41Z"
},
{
"body": "@cowwoc Can I take a look ?",
"created_at": "2021-10-13T14:27:26Z"
},
{
"body": "@sumitsawant Yes, go ahead.",
"created_at": "2021-10-13T14:30:18Z"
},
{
"body": "Hey @cowwoc / @cpovirk Can anyone assign this to me ?",
"created_at": "2021-10-13T15:30:13Z"
},
{
"body": "I don't have the necessary permission. I'll let @cpovirk do it.",
"created_at": "2021-10-13T16:12:10Z"
},
{
"body": "An alternative solution might be to use the [`jdkToolchain` property](https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#jdkToolchain) to specify that the Javadoc should be created using a newer JDK version, e.g. by specifying:\r\n```xml\r\n<jdkToolchain>\r\n <version>17</version>\r\n</jdkToolchain>\r\n```\r\nYou would then either have to build with JDK 17, or create a `~/.m2/toolchains.xml` file, see [Maven Toolchains documentation](https://maven.apache.org/ref/3.8.3/maven-core/toolchains.html).",
"created_at": "2021-10-22T12:47:41Z"
},
{
"body": "RE: Maven Toolchains: https://github.com/google/error-prone/issues/3895#issuecomment-1542294317",
"created_at": "2023-05-10T14:18:32Z"
}
],
"number": 5457,
"title": "Broken link in Javadoc"
} | {
"body": "Fix Javadoc search on JDK 11:\n\nFixed Javadoc search feature on JDK 11, which is currently used in our\nscripts updating snapshot Javadocs on guava.dev and building\nGuava releases, by adding `no-module-directories` flag.\n\nThis option is not present in javadoc tool from JDK 8 and 13+,\nhence we use profiles to conditionally pass this flag on 9-12 only.\n\nNote that on JDK 17 javadoc generation does not work,\nas it seems to have changed the warning on LVTI usage in sources\nto an error.\n\nFixes #5457\nFixes #5800\n\nRELNOTES=n/a\n",
"number": 5805,
"review_comments": [],
"title": "Fix Javadoc search on JDK 11:"
} | {
"commits": [
{
"message": "Fix Javadoc search on JDK 11:\n\nFixed Javadoc search feature on JDK 11, which is currently used in our\nscripts updating snapshot Javadocs on guava.dev and building\nGuava releases, by adding `no-module-directories` flag.\n\nThis option is not present in javadoc tool from JDK 8 and 13+,\nhence we use profiles to conditionally pass this flag on 9-12 only.\n\nNote that on JDK 17 javadoc generation does not work,\nas it seems to have changed the warning on LVTI usage in sources\nto an error.\n\nFixes #5457\nFixes #5800\n\nRELNOTES=n/a\nPiperOrigin-RevId: 413922237"
}
],
"files": [
{
"diff": "@@ -18,6 +18,8 @@\n <checker-framework.version>3.12.0</checker-framework.version>\n <animal.sniffer.version>1.20</animal.sniffer.version>\n <maven-javadoc-plugin.version>3.1.0</maven-javadoc-plugin.version>\n+ <!-- Empty for all JDKs but 9-12 -->\n+ <maven-javadoc-plugin.additionalJOptions></maven-javadoc-plugin.additionalJOptions>\n <maven-source-plugin.version>3.2.1</maven-source-plugin.version>\n <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>\n </properties>\n@@ -190,6 +192,7 @@\n </additionalOptions>\n <linksource>true</linksource>\n <source>8</source>\n+ <additionalJOption>${maven-javadoc-plugin.additionalJOptions}</additionalJOption>\n </configuration>\n <executions>\n <execution>\n@@ -383,5 +386,23 @@\n </plugins>\n </build>\n </profile>\n+ <profile>\n+ <!--\n+ Passes JDK 9-12-specific `no-module-directories` flag to Javadoc tool,\n+ which is required to make symbol search work correctly in the generated\n+ pages.\n+\n+ This flag does not exist on 8 and 13+ (https://bugs.openjdk.java.net/browse/JDK-8215582).\n+\n+ Consider removing it once our release and test scripts are migrated to a recent JDK (17+).\n+ -->\n+ <id>javadocs-jdk9-12</id>\n+ <activation>\n+ <jdk>[9,13)</jdk>\n+ </activation>\n+ <properties>\n+ <maven-javadoc-plugin.additionalJOptions>--no-module-directories</maven-javadoc-plugin.additionalJOptions>\n+ </properties>\n+ </profile>\n </profiles>\n </project>",
"filename": "android/pom.xml",
"status": "modified"
},
{
"diff": "@@ -18,6 +18,8 @@\n <checker-framework.version>3.12.0</checker-framework.version>\n <animal.sniffer.version>1.20</animal.sniffer.version>\n <maven-javadoc-plugin.version>3.1.0</maven-javadoc-plugin.version>\n+ <!-- Empty for all JDKs but 9-12 -->\n+ <maven-javadoc-plugin.additionalJOptions></maven-javadoc-plugin.additionalJOptions>\n <maven-source-plugin.version>3.2.1</maven-source-plugin.version>\n <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>\n </properties>\n@@ -184,6 +186,7 @@\n </additionalOptions>\n <linksource>true</linksource>\n <source>8</source>\n+ <additionalJOption>${maven-javadoc-plugin.additionalJOptions}</additionalJOption>\n </configuration>\n <executions>\n <execution>\n@@ -390,5 +393,23 @@\n </plugins>\n </build>\n </profile>\n+ <profile>\n+ <!--\n+ Passes JDK 9-12-specific `no-module-directories` flag to Javadoc tool,\n+ which is required to make symbol search work correctly in the generated\n+ pages.\n+\n+ This flag does not exist on 8 and 13+ (https://bugs.openjdk.java.net/browse/JDK-8215582).\n+\n+ Consider removing it once our release and test scripts are migrated to a recent JDK (17+).\n+ -->\n+ <id>javadocs-jdk9-12</id>\n+ <activation>\n+ <jdk>[9,13)</jdk>\n+ </activation>\n+ <properties>\n+ <maven-javadoc-plugin.additionalJOptions>--no-module-directories</maven-javadoc-plugin.additionalJOptions>\n+ </properties>\n+ </profile>\n </profiles>\n </project>",
"filename": "pom.xml",
"status": "modified"
}
]
} |
{
"body": "1. Go to https://guava.dev/releases/30.1.1-jre/api/docs/\r\n2. Search for \"unsignedbytes\"\r\n3. Get redirected to https://guava.dev/releases/30.1.1-jre/api/docs/undefined/com/google/common/primitives/UnsignedBytes.html which returns HTTP 404.",
"comments": [
{
"body": "Thanks. We'll need to do the same thing as https://github.com/google/truth/issues/670 (which might also be what we did for https://github.com/google/error-prone/issues/1825, but I haven't looked).",
"created_at": "2021-03-31T10:28:55Z"
},
{
"body": "(As noted on the Truth issue, you might like an alternative that we added, which is to navigate to [guava.dev/unsignedbytes](http://guava.dev/unsignedbytes). But we'll fix search, too.)",
"created_at": "2021-03-31T10:32:59Z"
},
{
"body": "@cpovirk I looked at the issue you linked to but it sounds like everyone is implementing a workaround instead of fixing the underlying problem. Did anyone file a bug report against the Javadoc tool?",
"created_at": "2021-03-31T15:03:16Z"
},
{
"body": "It looks like it: [JDK-8215291](https://bugs.openjdk.java.net/browse/JDK-8215291).",
"created_at": "2021-03-31T15:17:56Z"
},
{
"body": "@cpovirk Good find. I'll add it to the Stackoverflow discussion.",
"created_at": "2021-03-31T15:44:22Z"
},
{
"body": "Hi, any news about this issue? I use Guava's Javadoc often and this bug is very annoying.\r\n\r\nThanks :)",
"created_at": "2021-07-17T16:53:41Z"
},
{
"body": "@cowwoc Can I take a look ?",
"created_at": "2021-10-13T14:27:26Z"
},
{
"body": "@sumitsawant Yes, go ahead.",
"created_at": "2021-10-13T14:30:18Z"
},
{
"body": "Hey @cowwoc / @cpovirk Can anyone assign this to me ?",
"created_at": "2021-10-13T15:30:13Z"
},
{
"body": "I don't have the necessary permission. I'll let @cpovirk do it.",
"created_at": "2021-10-13T16:12:10Z"
},
{
"body": "An alternative solution might be to use the [`jdkToolchain` property](https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#jdkToolchain) to specify that the Javadoc should be created using a newer JDK version, e.g. by specifying:\r\n```xml\r\n<jdkToolchain>\r\n <version>17</version>\r\n</jdkToolchain>\r\n```\r\nYou would then either have to build with JDK 17, or create a `~/.m2/toolchains.xml` file, see [Maven Toolchains documentation](https://maven.apache.org/ref/3.8.3/maven-core/toolchains.html).",
"created_at": "2021-10-22T12:47:41Z"
},
{
"body": "RE: Maven Toolchains: https://github.com/google/error-prone/issues/3895#issuecomment-1542294317",
"created_at": "2023-05-10T14:18:32Z"
}
],
"number": 5457,
"title": "Broken link in Javadoc"
} | {
"body": "Fixed Javadoc search feature on JDK 11, which is currently used in our\r\nscripts updating snapshot Javadocs on guava.dev and building\r\nGuava releases, by adding `no-module-directories` flag.\r\n\r\nThis option is not present in javadoc tool from JDK 8 and 13+,\r\nhence we use profiles to conditionally pass this flag on 9-12 only.\r\n\r\nNote that on JDK 17 javadoc generation does not work,\r\nas it seems to have changed the warning on LVTI usage in sources\r\nto an error.\r\n\r\nFixes #5457\r\n\r\nTESTED=Locally with `mvn javadoc:javadoc` for `guava` module and its android flavour on JDK 11",
"number": 5800,
"review_comments": [],
"title": "Fix Javadoc search on JDK 11:"
} | {
"commits": [
{
"message": "Fix Javadoc search on JDK 11:\n\nFixed Javadoc search feature on JDK 11, which is currently used in our\nscripts updating snapshot Javadocs on guava.dev and building\nGuava releases, by adding `no-module-directories` flag.\n\nThis option is not present in javadoc tool from JDK 8 and 13+,\nhence we use profiles to conditionally pass this flag on 9-12 only.\n\nNote that on JDK 17 javadoc generation does not work,\nas it seems to have changed the warning on LVTI usage in sources\nto an error.\n\nFixes #5457\n\nTESTED=Locally with `mvn javadoc:javadoc` for `guava` module and its android flavour"
}
],
"files": [
{
"diff": "@@ -18,6 +18,8 @@\n <checker-framework.version>3.12.0</checker-framework.version>\n <animal.sniffer.version>1.20</animal.sniffer.version>\n <maven-javadoc-plugin.version>3.1.0</maven-javadoc-plugin.version>\n+ <!-- Empty for all JDKs but 9-12 -->\n+ <maven-javadoc-plugin.additionalJOptions></maven-javadoc-plugin.additionalJOptions>\n <maven-source-plugin.version>3.2.1</maven-source-plugin.version>\n <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>\n </properties>\n@@ -190,6 +192,7 @@\n </additionalOptions>\n <linksource>true</linksource>\n <source>8</source>\n+ <additionalJOption>${maven-javadoc-plugin.additionalJOptions}</additionalJOption>\n </configuration>\n <executions>\n <execution>\n@@ -383,5 +386,23 @@\n </plugins>\n </build>\n </profile>\n+ <profile>\n+ <!--\n+ Passes JDK 9-12-specific `no-module-directories` flag to Javadoc tool,\n+ which is required to make symbol search work correctly in the generated\n+ pages.\n+\n+ This flag does not exist on 8 and 13+ (https://bugs.openjdk.java.net/browse/JDK-8215582).\n+\n+ Consider removing it once our release and test scripts are migrated to a recent JDK (17+).\n+ -->\n+ <id>javadocs-jdk9-12</id>\n+ <activation>\n+ <jdk>[9,13)</jdk>\n+ </activation>\n+ <properties>\n+ <maven-javadoc-plugin.additionalJOptions>--no-module-directories</maven-javadoc-plugin.additionalJOptions>\n+ </properties>\n+ </profile>\n </profiles>\n </project>",
"filename": "android/pom.xml",
"status": "modified"
},
{
"diff": "@@ -18,6 +18,8 @@\n <checker-framework.version>3.12.0</checker-framework.version>\n <animal.sniffer.version>1.20</animal.sniffer.version>\n <maven-javadoc-plugin.version>3.1.0</maven-javadoc-plugin.version>\n+ <!-- Empty for all JDKs but 9-12 -->\n+ <maven-javadoc-plugin.additionalJOptions></maven-javadoc-plugin.additionalJOptions>\n <maven-source-plugin.version>3.2.1</maven-source-plugin.version>\n <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>\n </properties>\n@@ -184,6 +186,7 @@\n </additionalOptions>\n <linksource>true</linksource>\n <source>8</source>\n+ <additionalJOption>${maven-javadoc-plugin.additionalJOptions}</additionalJOption>\n </configuration>\n <executions>\n <execution>\n@@ -390,5 +393,23 @@\n </plugins>\n </build>\n </profile>\n+ <profile>\n+ <!--\n+ Passes JDK 9-12-specific `no-module-directories` flag to Javadoc tool,\n+ which is required to make symbol search work correctly in the generated\n+ pages.\n+\n+ This flag does not exist on 8 and 13+ (https://bugs.openjdk.java.net/browse/JDK-8215582).\n+\n+ Consider removing it once our release and test scripts are migrated to a recent JDK (17+).\n+ -->\n+ <id>javadocs-jdk9-12</id>\n+ <activation>\n+ <jdk>[9,13)</jdk>\n+ </activation>\n+ <properties>\n+ <maven-javadoc-plugin.additionalJOptions>--no-module-directories</maven-javadoc-plugin.additionalJOptions>\n+ </properties>\n+ </profile>\n </profiles>\n </project>",
"filename": "pom.xml",
"status": "modified"
}
]
} |
{
"body": "Related PR : #5691\r\nThe result of `TopKSelector` may be wrong when `trim()` is invoked and quiksort fallback to `Arrasys.sort()`. Because `Arrasys.sort()` is been used by mistake there.\r\nFollowing test case can trigger this bug.\r\n```\r\n{\r\n int n = 10000;\r\n int k = 10000;\r\n int testIteration = 10;\r\n Random random = new Random(System.currentTimeMillis());\r\n for (int iter = 0; iter < testIteration; iter ++) {\r\n // target array to be sorted using TopKSelector\r\n List<Integer> target = new ArrayList<>();\r\n for (int i = 0; i < 9; i++) {\r\n List<Integer> sortedArray = new ArrayList();\r\n for (int j = 0; j < n; j++) {\r\n sortedArray.add(random.nextInt());\r\n }\r\n sortedArray.sort(Integer::compareTo);\r\n target.addAll(sortedArray);\r\n }\r\n\r\n TopKSelector<Integer> top = TopKSelector.least(k, Integer::compareTo);\r\n for (int value : target) {\r\n top.offer(value);\r\n }\r\n\r\n target.sort(Integer::compareTo);\r\n assertEquals(top.topK(), target.subList(0, k));\r\n }\r\n }\r\n```",
"comments": [
{
"body": "Hi ! @Liulietong , \r\nI am a new open source contributor and I would love to fix the issue, could you please provide some more reference to help me understand better? Is this issue open for contribution ?",
"created_at": "2021-08-22T17:31:26Z"
},
{
"body": "@shreelakshmijoshi I have submit the PR #5691 to fix the issue",
"created_at": "2021-08-23T12:12:02Z"
},
{
"body": "oh okay",
"created_at": "2021-08-23T12:28:05Z"
}
],
"number": 5692,
"title": "TopKSelector is unstable when quicksort fallback to Arrays.sort."
} | {
"body": "Fix bug in `TopKSelector` call to `Arrays.sort`.\n\nFixes #5691\nFixes #5692\n\nRELNOTES=n/a\n",
"number": 5696,
"review_comments": [
{
"body": "```suggestion\r\n List<Integer> sortedArray = new ArrayList<>();\r\n```",
"created_at": "2021-08-26T17:08:42Z"
},
{
"body": "```suggestion\r\n List<Integer> sortedArray = new ArrayList<>();\r\n```",
"created_at": "2021-08-26T17:09:21Z"
},
{
"body": "Thanks, but the internal submit completed before I could fix it :) I'll clean it up later on.",
"created_at": "2021-08-26T17:12:32Z"
}
],
"title": "Fix bug in `TopKSelector` call to `Arrays.sort`."
} | {
"commits": [
{
"message": "Fix bug in `TopKSelector` call to `Arrays.sort`.\n\nFixes #5691\nFixes #5692\n\nRELNOTES=n/a\nPiperOrigin-RevId: 393150511"
}
],
"files": [
{
"diff": "@@ -17,13 +17,16 @@\n package com.google.common.collect;\n \n import static com.google.common.truth.Truth.assertThat;\n+import static java.util.Collections.sort;\n \n import com.google.common.math.IntMath;\n import com.google.common.primitives.Ints;\n import java.math.RoundingMode;\n+import java.util.ArrayList;\n import java.util.Collections;\n import java.util.Comparator;\n import java.util.List;\n+import java.util.Random;\n import junit.framework.TestCase;\n \n /**\n@@ -119,4 +122,36 @@ public int compare(Integer o1, Integer o2) {\n assertThat(top.topK()).containsExactlyElementsIn(Collections.nCopies(k, 0));\n assertThat(compareCalls[0]).isAtMost(10L * n * IntMath.log2(k, RoundingMode.CEILING));\n }\n+\n+ public void testExceedMaxIteration() {\n+ /*\n+ * Bug #5692 occurred when TopKSelector called Arrays.sort incorrectly. Test data that would\n+ * trigger a problematic call to Arrays.sort is hard to construct by hand, so we searched for\n+ * one among randomly generated inputs. To reach the Arrays.sort call, we need to pass an input\n+ * that requires many iterations of partitioning inside trim(). So, to construct our random\n+ * inputs, we concatenated 10 sorted lists together.\n+ */\n+\n+ int k = 10000;\n+ Random random = new Random(1629833645599L);\n+\n+ // target list to be sorted using TopKSelector\n+ List<Integer> target = new ArrayList<>();\n+ for (int i = 0; i < 9; i++) {\n+ List<Integer> sortedArray = new ArrayList();\n+ for (int j = 0; j < 10000; j++) {\n+ sortedArray.add(random.nextInt());\n+ }\n+ sort(sortedArray, Ordering.natural());\n+ target.addAll(sortedArray);\n+ }\n+\n+ TopKSelector<Integer> top = TopKSelector.least(k, Ordering.natural());\n+ for (int value : target) {\n+ top.offer(value);\n+ }\n+\n+ sort(target, Ordering.natural());\n+ assertEquals(top.topK(), target.subList(0, k));\n+ }\n }",
"filename": "android/guava-tests/test/com/google/common/collect/TopKSelectorTest.java",
"status": "modified"
},
{
"diff": "@@ -185,7 +185,7 @@ private void trim() {\n iterations++;\n if (iterations >= maxIterations) {\n // We've already taken O(k log k), let's make sure we don't take longer than O(k log k).\n- Arrays.sort(buffer, left, right, comparator);\n+ Arrays.sort(buffer, left, right + 1, comparator);\n break;\n }\n }",
"filename": "android/guava/src/com/google/common/collect/TopKSelector.java",
"status": "modified"
},
{
"diff": "@@ -17,13 +17,16 @@\n package com.google.common.collect;\n \n import static com.google.common.truth.Truth.assertThat;\n+import static java.util.Collections.sort;\n \n import com.google.common.math.IntMath;\n import com.google.common.primitives.Ints;\n import java.math.RoundingMode;\n+import java.util.ArrayList;\n import java.util.Collections;\n import java.util.Comparator;\n import java.util.List;\n+import java.util.Random;\n import junit.framework.TestCase;\n \n /**\n@@ -119,4 +122,36 @@ public int compare(Integer o1, Integer o2) {\n assertThat(top.topK()).containsExactlyElementsIn(Collections.nCopies(k, 0));\n assertThat(compareCalls[0]).isAtMost(10L * n * IntMath.log2(k, RoundingMode.CEILING));\n }\n+\n+ public void testExceedMaxIteration() {\n+ /*\n+ * Bug #5692 occurred when TopKSelector called Arrays.sort incorrectly. Test data that would\n+ * trigger a problematic call to Arrays.sort is hard to construct by hand, so we searched for\n+ * one among randomly generated inputs. To reach the Arrays.sort call, we need to pass an input\n+ * that requires many iterations of partitioning inside trim(). So, to construct our random\n+ * inputs, we concatenated 10 sorted lists together.\n+ */\n+\n+ int k = 10000;\n+ Random random = new Random(1629833645599L);\n+\n+ // target list to be sorted using TopKSelector\n+ List<Integer> target = new ArrayList<>();\n+ for (int i = 0; i < 9; i++) {\n+ List<Integer> sortedArray = new ArrayList();\n+ for (int j = 0; j < 10000; j++) {\n+ sortedArray.add(random.nextInt());\n+ }\n+ sort(sortedArray, Ordering.natural());\n+ target.addAll(sortedArray);\n+ }\n+\n+ TopKSelector<Integer> top = TopKSelector.least(k, Ordering.natural());\n+ for (int value : target) {\n+ top.offer(value);\n+ }\n+\n+ sort(target, Ordering.natural());\n+ assertEquals(top.topK(), target.subList(0, k));\n+ }\n }",
"filename": "guava-tests/test/com/google/common/collect/TopKSelectorTest.java",
"status": "modified"
},
{
"diff": "@@ -186,7 +186,7 @@ private void trim() {\n iterations++;\n if (iterations >= maxIterations) {\n // We've already taken O(k log k), let's make sure we don't take longer than O(k log k).\n- Arrays.sort(buffer, left, right, comparator);\n+ Arrays.sort(buffer, left, right + 1, comparator);\n break;\n }\n }",
"filename": "guava/src/com/google/common/collect/TopKSelector.java",
"status": "modified"
}
]
} |
{
"body": "The result of `TopKSelector` may be wrong when `trim()` is invoked and quiksort fallback to `Arrasys.sort()`. Because `Arrasys.sort()` is been used by mistake there.\r\nFollowing test case can trigger this bug.\r\n```\r\n{\r\n int n = 10000;\r\n int k = 10000;\r\n int testIteration = 10;\r\n Random random = new Random(System.currentTimeMillis());\r\n for (int iter = 0; iter < testIteration; iter ++) {\r\n // target array to be sorted using TopKSelector\r\n List<Integer> target = new ArrayList<>();\r\n for (int i = 0; i < 9; i++) {\r\n List<Integer> sortedArray = new ArrayList();\r\n for (int j = 0; j < n; j++) {\r\n sortedArray.add(random.nextInt());\r\n }\r\n sortedArray.sort(Integer::compareTo);\r\n target.addAll(sortedArray);\r\n }\r\n\r\n TopKSelector<Integer> top = TopKSelector.least(k, Integer::compareTo);\r\n for (int value : target) {\r\n top.offer(value);\r\n }\r\n\r\n target.sort(Integer::compareTo);\r\n assertEquals(top.topK(), target.subList(0, k));\r\n }\r\n }\r\n```",
"comments": [
{
"body": "\nThanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).\n\n:memo: **Please visit <https://cla.developers.google.com/> to sign.**\n\nOnce you've signed (or fixed any issues), please reply here with `@googlebot I signed it!` and we'll verify it.\n\n----\n\n#### What to do if you already signed the CLA\n\n##### Individual signers\n\n* It's possible we don't have your GitHub username or you're using a different email address on your commit. Check [your existing CLA data](https://cla.developers.google.com/clas) and verify that your [email is set on your git commits](https://help.github.com/articles/setting-your-email-in-git/).\n\n##### Corporate signers\n\n* Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to [go/cla#troubleshoot](http://go/cla#troubleshoot) ([Public version](https://opensource.google/docs/cla/#troubleshoot)).\n* The email used to register you as an authorized contributor must be the email used for the Git commit. Check [your existing CLA data](https://cla.developers.google.com/clas) and verify that your [email is set on your git commits](https://help.github.com/articles/setting-your-email-in-git/).\n* The email used to register you as an authorized contributor must also be [attached to your GitHub account](https://github.com/settings/emails).\n\t\t\n\nℹ️ **Googlers: [Go here](https://goto.google.com/prinfo/https%3A%2F%2Fgithub.com%2Fgoogle%2Fguava%2Fpull%2F5691) for more info**.\n\n<!-- need_sender_cla -->",
"created_at": "2021-08-19T11:52:21Z"
},
{
"body": "> @googlebot I signed it!\r\n\r\n",
"created_at": "2021-08-19T12:21:54Z"
}
],
"number": 5691,
"title": "Fix bug that result of TopKSelector is unstable when quicksort fallback to Arrays.sort."
} | {
"body": "Fix bug in `TopKSelector` call to `Arrays.sort`.\n\nFixes #5691\nFixes #5692\n\nRELNOTES=n/a\n",
"number": 5696,
"review_comments": [
{
"body": "```suggestion\r\n List<Integer> sortedArray = new ArrayList<>();\r\n```",
"created_at": "2021-08-26T17:08:42Z"
},
{
"body": "```suggestion\r\n List<Integer> sortedArray = new ArrayList<>();\r\n```",
"created_at": "2021-08-26T17:09:21Z"
},
{
"body": "Thanks, but the internal submit completed before I could fix it :) I'll clean it up later on.",
"created_at": "2021-08-26T17:12:32Z"
}
],
"title": "Fix bug in `TopKSelector` call to `Arrays.sort`."
} | {
"commits": [
{
"message": "Fix bug in `TopKSelector` call to `Arrays.sort`.\n\nFixes #5691\nFixes #5692\n\nRELNOTES=n/a\nPiperOrigin-RevId: 393150511"
}
],
"files": [
{
"diff": "@@ -17,13 +17,16 @@\n package com.google.common.collect;\n \n import static com.google.common.truth.Truth.assertThat;\n+import static java.util.Collections.sort;\n \n import com.google.common.math.IntMath;\n import com.google.common.primitives.Ints;\n import java.math.RoundingMode;\n+import java.util.ArrayList;\n import java.util.Collections;\n import java.util.Comparator;\n import java.util.List;\n+import java.util.Random;\n import junit.framework.TestCase;\n \n /**\n@@ -119,4 +122,36 @@ public int compare(Integer o1, Integer o2) {\n assertThat(top.topK()).containsExactlyElementsIn(Collections.nCopies(k, 0));\n assertThat(compareCalls[0]).isAtMost(10L * n * IntMath.log2(k, RoundingMode.CEILING));\n }\n+\n+ public void testExceedMaxIteration() {\n+ /*\n+ * Bug #5692 occurred when TopKSelector called Arrays.sort incorrectly. Test data that would\n+ * trigger a problematic call to Arrays.sort is hard to construct by hand, so we searched for\n+ * one among randomly generated inputs. To reach the Arrays.sort call, we need to pass an input\n+ * that requires many iterations of partitioning inside trim(). So, to construct our random\n+ * inputs, we concatenated 10 sorted lists together.\n+ */\n+\n+ int k = 10000;\n+ Random random = new Random(1629833645599L);\n+\n+ // target list to be sorted using TopKSelector\n+ List<Integer> target = new ArrayList<>();\n+ for (int i = 0; i < 9; i++) {\n+ List<Integer> sortedArray = new ArrayList();\n+ for (int j = 0; j < 10000; j++) {\n+ sortedArray.add(random.nextInt());\n+ }\n+ sort(sortedArray, Ordering.natural());\n+ target.addAll(sortedArray);\n+ }\n+\n+ TopKSelector<Integer> top = TopKSelector.least(k, Ordering.natural());\n+ for (int value : target) {\n+ top.offer(value);\n+ }\n+\n+ sort(target, Ordering.natural());\n+ assertEquals(top.topK(), target.subList(0, k));\n+ }\n }",
"filename": "android/guava-tests/test/com/google/common/collect/TopKSelectorTest.java",
"status": "modified"
},
{
"diff": "@@ -185,7 +185,7 @@ private void trim() {\n iterations++;\n if (iterations >= maxIterations) {\n // We've already taken O(k log k), let's make sure we don't take longer than O(k log k).\n- Arrays.sort(buffer, left, right, comparator);\n+ Arrays.sort(buffer, left, right + 1, comparator);\n break;\n }\n }",
"filename": "android/guava/src/com/google/common/collect/TopKSelector.java",
"status": "modified"
},
{
"diff": "@@ -17,13 +17,16 @@\n package com.google.common.collect;\n \n import static com.google.common.truth.Truth.assertThat;\n+import static java.util.Collections.sort;\n \n import com.google.common.math.IntMath;\n import com.google.common.primitives.Ints;\n import java.math.RoundingMode;\n+import java.util.ArrayList;\n import java.util.Collections;\n import java.util.Comparator;\n import java.util.List;\n+import java.util.Random;\n import junit.framework.TestCase;\n \n /**\n@@ -119,4 +122,36 @@ public int compare(Integer o1, Integer o2) {\n assertThat(top.topK()).containsExactlyElementsIn(Collections.nCopies(k, 0));\n assertThat(compareCalls[0]).isAtMost(10L * n * IntMath.log2(k, RoundingMode.CEILING));\n }\n+\n+ public void testExceedMaxIteration() {\n+ /*\n+ * Bug #5692 occurred when TopKSelector called Arrays.sort incorrectly. Test data that would\n+ * trigger a problematic call to Arrays.sort is hard to construct by hand, so we searched for\n+ * one among randomly generated inputs. To reach the Arrays.sort call, we need to pass an input\n+ * that requires many iterations of partitioning inside trim(). So, to construct our random\n+ * inputs, we concatenated 10 sorted lists together.\n+ */\n+\n+ int k = 10000;\n+ Random random = new Random(1629833645599L);\n+\n+ // target list to be sorted using TopKSelector\n+ List<Integer> target = new ArrayList<>();\n+ for (int i = 0; i < 9; i++) {\n+ List<Integer> sortedArray = new ArrayList();\n+ for (int j = 0; j < 10000; j++) {\n+ sortedArray.add(random.nextInt());\n+ }\n+ sort(sortedArray, Ordering.natural());\n+ target.addAll(sortedArray);\n+ }\n+\n+ TopKSelector<Integer> top = TopKSelector.least(k, Ordering.natural());\n+ for (int value : target) {\n+ top.offer(value);\n+ }\n+\n+ sort(target, Ordering.natural());\n+ assertEquals(top.topK(), target.subList(0, k));\n+ }\n }",
"filename": "guava-tests/test/com/google/common/collect/TopKSelectorTest.java",
"status": "modified"
},
{
"diff": "@@ -186,7 +186,7 @@ private void trim() {\n iterations++;\n if (iterations >= maxIterations) {\n // We've already taken O(k log k), let's make sure we don't take longer than O(k log k).\n- Arrays.sort(buffer, left, right, comparator);\n+ Arrays.sort(buffer, left, right + 1, comparator);\n break;\n }\n }",
"filename": "guava/src/com/google/common/collect/TopKSelector.java",
"status": "modified"
}
]
} |
{
"body": "The `asMap().compute` implementation did not take into account that the present value may be loading. A load does not block other writes to that entry and takes into account that it may be clobbered, causing it to automatically discard itself. This is a known design choice that breaks linearizability assumptions (#1881). The compute should check if a load is in progress and call the appropriate internal removal method.\r\n\r\nBecause a zombie entry remained in the cache and still is marked as loading, the loader could discover entry and try to wait for it to materialize. When the computation is a removal, indicated by a null value, the loader would see this as the zombie's result. Since a cache loader may not return null it would throw an exception to indicate a user bug.\r\n\r\nA new `ComputingValueReference` resolves both issues by indicating that the load has completed. The compute's `removeEntry` will then actually remove this entry and the loader will not wait on the zombie. Instead if it observes the entry, it will neither receive a non-null value or wait for it to load, but rather try to load anew under the lock. This piggybacks on the reference collection support where an entry is present but its value was garbage collected, causing the load to proceed. By the time the lock is obtained the compute method's entry was removed and the load proceeds as normal (so no unnecessary notification is produced).\r\n\r\nfixes #5342\r\nfixes #2827\r\nresolves underlying cause of #2108",
"comments": [],
"number": 5348,
"title": "Fix compatibility between the cache compute methods and a load"
} | {
"body": "Fix compatibility between the cache compute methods and a load.\n\nFixes #5348\nFixes #5342\nFixes #2827\nResolves underlying cause of #2108\n\nRELNOTES=Fix compatibility between the cache compute methods and a load.\n",
"number": 5406,
"review_comments": [],
"title": "Fix compatibility between the cache compute methods and a load."
} | {
"commits": [],
"files": []
} |
{
"body": "Through the `asMap()` interface it is possible in certain situations to partially map NULL values into the `Cache` which results in an unpredictable state. When using `ConcurrentMap.compute` and `ConcurrentMap.computeIfPresent` it possible to remap a previous value to null rather than removing it, which I think would be the expected behaviour here. \r\n\r\nAttached [CacheNullValueTest.java.zip](https://github.com/google/guava/files/5636058/CacheNullValueTest.java.zip) contains test cases that reproduces this problem, tested on 30.0-jre\r\n\r\n\r\n",
"comments": [
{
"body": "The test case is confusing because it passes due to asserting the invalid behavior. I suspect that the Guava team would prefer to have a failing test to iterate against.\r\n\r\nThe compute methods are not a good fit with Guava's design, so the implementation has quirks and performance issues. I don't think those methods are commonly used, so they are likely not fully robust.\r\n\r\nCan you try [Caffeine](https://github.com/ben-manes/caffeine)? I believe my migration of your test passes, but flipping assertions leads me a little unsure. The builder is almost identical but since async is enabled by default, you'd need to specify `Caffeine.executor(Runnable::run)` to mirror Guava.",
"created_at": "2020-12-04T00:53:45Z"
},
{
"body": "I took a quick look and proposed a fix in #5348. I haven't been a contributor in many years and my familiarity with the cache internals is hazy, but I don't think anyone still active on the Guava team is any better off than I am. That PR seems to address the problem, but alas I can't be certain there are not edge cases that I missed.",
"created_at": "2020-12-05T07:00:52Z"
}
],
"number": 5342,
"title": "Cache.asMap() interface makes it possible to map NULL values into the cache"
} | {
"body": "Fix compatibility between the cache compute methods and a load.\n\nFixes #5348\nFixes #5342\nFixes #2827\nResolves underlying cause of #2108\n\nRELNOTES=Fix compatibility between the cache compute methods and a load.\n",
"number": 5406,
"review_comments": [],
"title": "Fix compatibility between the cache compute methods and a load."
} | {
"commits": [],
"files": []
} |
{
"body": "My multithreaded thrashing tests failed with Guava due to `size()` returning a negative value. The size is used for verifying that the `toArray()` methods are threadsafe (this was a common bug until JDK6 rewrote AbstractCollection's to be tolerant to races). The lines in question are,\n\n``` java\n(cache, key) -> cache.asMap().keySet().toArray(new Object[cache.asMap().size()]),\n(cache, key) -> cache.asMap().values().toArray(new Object[cache.asMap().size()]),\n(cache, key) -> cache.asMap().entrySet().toArray(new Entry[cache.asMap().size()]),\n```\n\nThis results in a `NegativeArraySizeException` unless worked around using `Math.max(0, cache.asMap().size())` which is now done in the guava fixture. I'm not sure why this occurs, and only happened after tweaking some JVM args. Regardless this failure was reproducible and is simple to fix.\n\n```\njava.lang.NegativeArraySizeException\nat com.github.benmanes.caffeine.cache.MultiThreadedTest.lambda$new$280(MultiThreadedTest.java:142)\nat com.github.benmanes.caffeine.cache.MultiThreadedTest$$Lambda$29/584234975.accept(Unknown Source)\nat com.github.benmanes.caffeine.testing.Threads$Thrasher.run(Threads.java:149)\nat java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:511)\nat com.github.benmanes.caffeine.testing.ConcurrentTestHarness.lambda$timeTasks$344(ConcurrentTestHarness.java:100)\nat com.github.benmanes.caffeine.testing.ConcurrentTestHarness$$Lambda$61/1027825150.run(Unknown Source)\nat java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142)\nat java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617)\nat java.lang.Thread.run(Thread.java:745)\n```\n",
"comments": [
{
"body": "Are your caches _really_ big? I see we do some summing up of segment sizes in a loop - maybe we are overflowing Integer.MAX_VALUE?\n",
"created_at": "2015-07-15T14:44:52Z"
},
{
"body": "The saturated cast should handle that. Both ConcurrentHashMap\nimplementations do a negative check, so it sounds like an expected race\neven though I don't know why it might occur.\nOn Jul 15, 2015 7:45 AM, \"Kurt Alfred Kluever\" notifications@github.com\nwrote:\n\n> Are your caches _really_ big? I see we do some summing up of segment\n> sizes in a loop - maybe we are overflowing Integer.MAX_VALUE?\n> \n> —\n> Reply to this email directly or view it on GitHub\n> https://github.com/google/guava/issues/2108#issuecomment-121638255.\n",
"created_at": "2015-07-15T14:57:42Z"
},
{
"body": "\"which is now done in the guava fixture\" What does this mean? It's not 100% clear what fix you have in mind. Is it just a simple Math.max in the size method?\n",
"created_at": "2015-07-30T18:23:58Z"
},
{
"body": "Yes, its that simple. In `longSize()` use `return Math.max(0, sum)` which will cover all of the size() methods. This is essentially what I do in my [fixture](https://github.com/ben-manes/caffeine/blob/master/caffeine/src/test/java/com/github/benmanes/caffeine/cache/testing/GuavaCacheFromContext.java#L207), which is used to run all my tests against both Caffeine and Guava implementations to find bugs / check compatibility.\n\nAgain I'm not sure why this occurs from reading the code, but I was able to reproduce the exception (its racy so takes a few tries). The fix is safe and non-invasive, so easier to resolve it there than dig into the race causing it.\n",
"created_at": "2015-07-30T18:38:53Z"
},
{
"body": "Is it enough to max(0, entireSize) or should it be done to each individual segment count?\n",
"created_at": "2015-07-30T19:24:21Z"
},
{
"body": "Either is fine with me. Since the size is an estimate, rather than exact, I'm not overly concerned either way. The `long` avoids overflow so your idea would be for better precision.\n",
"created_at": "2015-07-30T19:26:50Z"
},
{
"body": "Patch submitted internally; that should make it out into the next RC.\n",
"created_at": "2015-07-30T19:49:13Z"
}
],
"number": 2108,
"title": "Cache.asMap().size() may return a negative value"
} | {
"body": "Fix compatibility between the cache compute methods and a load.\n\nFixes #5348\nFixes #5342\nFixes #2827\nResolves underlying cause of #2108\n\nRELNOTES=Fix compatibility between the cache compute methods and a load.\n",
"number": 5406,
"review_comments": [],
"title": "Fix compatibility between the cache compute methods and a load."
} | {
"commits": [],
"files": []
} |
{
"body": "[WARNING] \r\n[WARNING] Some problems were encountered while building the effective model for com.google.guava:guava-bom:pom:HEAD-jre-SNAPSHOT\r\n[WARNING] 'parent.relativePath' of POM com.google.guava:guava-bom:HEAD-jre-SNAPSHOT (/home/elharo/guava/guava-bom/pom.xml) points at com.google.guava:guava-parent instead of org.sonatype.oss:oss-parent, please verify your project structure @ line 14, column 11\r\n[WARNING] \r\n[WARNING] It is highly recommended to fix these problems because they threaten the stability of your build.\r\n[WARNING] \r\n[WARNING] For this reason, future Maven versions might no longer support building such malformed projects.\r\n[WARNING] \r\n",
"comments": [],
"number": 3945,
"title": "parent.relativePath' points at com.google.guava:guava-parent instead of org.sonatype.oss:oss-parent"
} | {
"body": "Fixed : #3945",
"number": 5349,
"review_comments": [],
"title": "#3945 - Fixed parent.relativePath issue in guava-bom"
} | {
"commits": [
{
"message": "#3945 - Fixed parent.relativePath issue in guava-bom"
}
],
"files": [
{
"diff": "@@ -15,6 +15,7 @@\n <groupId>org.sonatype.oss</groupId>\n <artifactId>oss-parent</artifactId>\n <version>9</version>\n+ <relativePath></relativePath>\n </parent>\n \n <name>Guava BOM</name>",
"filename": "guava-bom/pom.xml",
"status": "modified"
}
]
} |
{
"body": "Through the `asMap()` interface it is possible in certain situations to partially map NULL values into the `Cache` which results in an unpredictable state. When using `ConcurrentMap.compute` and `ConcurrentMap.computeIfPresent` it possible to remap a previous value to null rather than removing it, which I think would be the expected behaviour here. \r\n\r\nAttached [CacheNullValueTest.java.zip](https://github.com/google/guava/files/5636058/CacheNullValueTest.java.zip) contains test cases that reproduces this problem, tested on 30.0-jre\r\n\r\n\r\n",
"comments": [
{
"body": "The test case is confusing because it passes due to asserting the invalid behavior. I suspect that the Guava team would prefer to have a failing test to iterate against.\r\n\r\nThe compute methods are not a good fit with Guava's design, so the implementation has quirks and performance issues. I don't think those methods are commonly used, so they are likely not fully robust.\r\n\r\nCan you try [Caffeine](https://github.com/ben-manes/caffeine)? I believe my migration of your test passes, but flipping assertions leads me a little unsure. The builder is almost identical but since async is enabled by default, you'd need to specify `Caffeine.executor(Runnable::run)` to mirror Guava.",
"created_at": "2020-12-04T00:53:45Z"
},
{
"body": "I took a quick look and proposed a fix in #5348. I haven't been a contributor in many years and my familiarity with the cache internals is hazy, but I don't think anyone still active on the Guava team is any better off than I am. That PR seems to address the problem, but alas I can't be certain there are not edge cases that I missed.",
"created_at": "2020-12-05T07:00:52Z"
}
],
"number": 5342,
"title": "Cache.asMap() interface makes it possible to map NULL values into the cache"
} | {
"body": "The `asMap().compute` implementation did not take into account that the present value may be loading. A load does not block other writes to that entry and takes into account that it may be clobbered, causing it to automatically discard itself. This is a known design choice that breaks linearizability assumptions (#1881). The compute should check if a load is in progress and call the appropriate internal removal method.\r\n\r\nBecause a zombie entry remained in the cache and still is marked as loading, the loader could discover entry and try to wait for it to materialize. When the computation is a removal, indicated by a null value, the loader would see this as the zombie's result. Since a cache loader may not return null it would throw an exception to indicate a user bug.\r\n\r\nA new `ComputingValueReference` resolves both issues by indicating that the load has completed. The compute's `removeEntry` will then actually remove this entry and the loader will not wait on the zombie. Instead if it observes the entry, it will neither receive a non-null value or wait for it to load, but rather try to load anew under the lock. This piggybacks on the reference collection support where an entry is present but its value was garbage collected, causing the load to proceed. By the time the lock is obtained the compute method's entry was removed and the load proceeds as normal (so no unnecessary notification is produced).\r\n\r\nfixes #5342\r\nfixes #2827\r\nresolves underlying cause of #2108",
"number": 5348,
"review_comments": [],
"title": "Fix compatibility between the cache compute methods and a load"
} | {
"commits": [
{
"message": "Fix compatibility between the cache compute methods and a load\n\nThe asMap().compute implementation did not take into account that the\npresent value may be loading. A load does not block other writes to\nthat entry and takes into account that it may be clobbered, causing\nit to automatically discard itself. This is a known design choice that\nbreaks linearizability assumptions (#1881). The compute should check\nif a load is in progress and call the appropriate internal removal\nmethod.\n\nBecause a zombie entry remained in the cache and still is marked as\nloading, the loader could discover entry and try to wait for it to\nmaterialize. When the computation is a removal, indicated by a null\nvalue, the loader would see this as the zombie's result. Since a cache\nloader may not return null it would throw an exception to indicate\na user bug.\n\nA new ComputingValueReference resolves both issues by indicating\nthat the load has completed. The compute's removeEntry will then\nactually remove this entry and the loader will not wait on the\nzombie. Instead if it observes the entry, it will neither receive\na non-null value or wait for it to load, but rather try to load\nanew under the lock. This piggybacks on the reference collection\nsupport where an entry is present but its value was garbage\ncollected, causing the load to proceed. By the time the lock is\nobtained the compute method's entry was removed and the load\nproceeds as normal (so no unnecessary notification is produced).\n\nfixes #5342\nfixes #2827\nresolves underlying cause of #2108"
}
],
"files": [
{
"diff": "@@ -18,9 +18,17 @@\n \n import static com.google.common.truth.Truth.assertThat;\n \n+import java.util.ArrayList;\n+import java.util.List;\n+import java.util.Queue;\n+import java.util.concurrent.ConcurrentLinkedQueue;\n+import java.util.concurrent.ExecutionException;\n import java.util.concurrent.TimeUnit;\n import java.util.function.IntConsumer;\n import java.util.stream.IntStream;\n+\n+import com.google.common.util.concurrent.UncheckedExecutionException;\n+\n import junit.framework.TestCase;\n \n /** Test Java8 map.compute in concurrent cache context. */\n@@ -91,6 +99,27 @@ public void testComputeIfPresent() {\n assertThat(cache.getIfPresent(key).split(delimiter)).hasLength(count + 1);\n }\n \n+ public void testComputeIfPresentRemove() {\n+ List<RemovalNotification<Integer, Integer>> notifications = new ArrayList<>();\n+ Cache<Integer, Integer> cache = CacheBuilder.newBuilder()\n+ .removalListener(new RemovalListener<Integer, Integer>() {\n+ @Override public void onRemoval(RemovalNotification<Integer, Integer> notification) {\n+ notifications.add(notification);\n+ }\n+ }).build();\n+ cache.put(1, 2);\n+\n+ // explicitly remove the existing value\n+ cache.asMap().computeIfPresent(1, (key, value) -> null);\n+ assertThat(notifications).hasSize(1);\n+ CacheTesting.checkEmpty(cache);\n+\n+ // ensure no zombie entry remains\n+ cache.asMap().computeIfPresent(1, (key, value) -> null);\n+ assertThat(notifications).hasSize(1);\n+ CacheTesting.checkEmpty(cache);\n+ }\n+\n public void testUpdates() {\n cache.put(key, \"1\");\n // simultaneous update for same key, some null, some non-null\n@@ -113,6 +142,39 @@ public void testCompute() {\n assertEquals(0, cache.size());\n }\n \n+ //\n+ public void testComputeWithLoad() {\n+ Queue<RemovalNotification<String, String>> notifications = new ConcurrentLinkedQueue<>();\n+ cache = CacheBuilder.newBuilder()\n+ .removalListener(new RemovalListener<String, String>() {\n+ @Override public void onRemoval(RemovalNotification<String, String> notification) {\n+ notifications.add(notification);\n+ }\n+ })\n+ .expireAfterAccess(500000, TimeUnit.MILLISECONDS)\n+ .maximumSize(count)\n+ .build();\n+\n+ cache.put(key, \"1\");\n+ // simultaneous load and deletion\n+ doParallelCacheOp(\n+ count,\n+ n -> {\n+ try {\n+ cache.get(key, () -> key);\n+ cache.asMap().compute(key, (k, v) -> null);\n+ } catch (ExecutionException e) {\n+ throw new UncheckedExecutionException(e);\n+ }\n+ });\n+\n+ CacheTesting.checkEmpty(cache);\n+ for (RemovalNotification<String, String> entry : notifications) {\n+ assertThat(entry.getKey()).isNotNull();\n+ assertThat(entry.getValue()).isNotNull();\n+ }\n+ }\n+\n public void testComputeExceptionally() {\n try {\n doParallelCacheOp(",
"filename": "guava-tests/test/com/google/common/cache/LocalCacheMapComputeTest.java",
"status": "modified"
},
{
"diff": "@@ -2188,7 +2188,7 @@ V waitForLoadingValue(ReferenceEntry<K, V> e, K key, ValueReference<K, V> valueR\n V compute(K key, int hash, BiFunction<? super K, ? super V, ? extends V> function) {\n ReferenceEntry<K, V> e;\n ValueReference<K, V> valueReference = null;\n- LoadingValueReference<K, V> loadingValueReference = null;\n+ ComputingValueReference<K, V> loadingValueReference = null;\n boolean createNewEntry = true;\n V newValue;\n \n@@ -2229,7 +2229,7 @@ V compute(K key, int hash, BiFunction<? super K, ? super V, ? extends V> functio\n \n // note valueReference can be an existing value or even itself another loading value if\n // the value for the key is already being computed.\n- loadingValueReference = new LoadingValueReference<>(valueReference);\n+ loadingValueReference = new ComputingValueReference<>(valueReference);\n \n if (e == null) {\n createNewEntry = true;\n@@ -2257,6 +2257,9 @@ V compute(K key, int hash, BiFunction<? super K, ? super V, ? extends V> functio\n } else if (createNewEntry) {\n removeLoadingValue(key, hash, loadingValueReference);\n return null;\n+ } else if (valueReference.isLoading()) {\n+ removeLoadingValue(key, hash, loadingValueReference);\n+ return null;\n } else {\n removeEntry(e, hash, RemovalCause.EXPLICIT);\n return null;\n@@ -3465,6 +3468,18 @@ void runUnlockedCleanup() {\n }\n }\n \n+ static class ComputingValueReference<K, V> extends LoadingValueReference<K, V> {\n+ public ComputingValueReference() {\n+ super();\n+ }\n+ public ComputingValueReference(ValueReference<K, V> oldValue) {\n+ super(oldValue);\n+ }\n+ @Override public boolean isLoading() {\n+ return false;\n+ }\n+ }\n+\n static class LoadingValueReference<K, V> implements ValueReference<K, V> {\n volatile ValueReference<K, V> oldValue;\n \n@@ -3927,7 +3942,7 @@ long longSize() {\n Segment<K, V>[] segments = this.segments;\n long sum = 0;\n for (int i = 0; i < segments.length; ++i) {\n- sum += Math.max(0, segments[i].count); // see https://github.com/google/guava/issues/2108\n+ sum += segments[i].count;\n }\n return sum;\n }",
"filename": "guava/src/com/google/common/cache/LocalCache.java",
"status": "modified"
}
]
} |
{
"body": "My multithreaded thrashing tests failed with Guava due to `size()` returning a negative value. The size is used for verifying that the `toArray()` methods are threadsafe (this was a common bug until JDK6 rewrote AbstractCollection's to be tolerant to races). The lines in question are,\n\n``` java\n(cache, key) -> cache.asMap().keySet().toArray(new Object[cache.asMap().size()]),\n(cache, key) -> cache.asMap().values().toArray(new Object[cache.asMap().size()]),\n(cache, key) -> cache.asMap().entrySet().toArray(new Entry[cache.asMap().size()]),\n```\n\nThis results in a `NegativeArraySizeException` unless worked around using `Math.max(0, cache.asMap().size())` which is now done in the guava fixture. I'm not sure why this occurs, and only happened after tweaking some JVM args. Regardless this failure was reproducible and is simple to fix.\n\n```\njava.lang.NegativeArraySizeException\nat com.github.benmanes.caffeine.cache.MultiThreadedTest.lambda$new$280(MultiThreadedTest.java:142)\nat com.github.benmanes.caffeine.cache.MultiThreadedTest$$Lambda$29/584234975.accept(Unknown Source)\nat com.github.benmanes.caffeine.testing.Threads$Thrasher.run(Threads.java:149)\nat java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:511)\nat com.github.benmanes.caffeine.testing.ConcurrentTestHarness.lambda$timeTasks$344(ConcurrentTestHarness.java:100)\nat com.github.benmanes.caffeine.testing.ConcurrentTestHarness$$Lambda$61/1027825150.run(Unknown Source)\nat java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142)\nat java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617)\nat java.lang.Thread.run(Thread.java:745)\n```\n",
"comments": [
{
"body": "Are your caches _really_ big? I see we do some summing up of segment sizes in a loop - maybe we are overflowing Integer.MAX_VALUE?\n",
"created_at": "2015-07-15T14:44:52Z"
},
{
"body": "The saturated cast should handle that. Both ConcurrentHashMap\nimplementations do a negative check, so it sounds like an expected race\neven though I don't know why it might occur.\nOn Jul 15, 2015 7:45 AM, \"Kurt Alfred Kluever\" notifications@github.com\nwrote:\n\n> Are your caches _really_ big? I see we do some summing up of segment\n> sizes in a loop - maybe we are overflowing Integer.MAX_VALUE?\n> \n> —\n> Reply to this email directly or view it on GitHub\n> https://github.com/google/guava/issues/2108#issuecomment-121638255.\n",
"created_at": "2015-07-15T14:57:42Z"
},
{
"body": "\"which is now done in the guava fixture\" What does this mean? It's not 100% clear what fix you have in mind. Is it just a simple Math.max in the size method?\n",
"created_at": "2015-07-30T18:23:58Z"
},
{
"body": "Yes, its that simple. In `longSize()` use `return Math.max(0, sum)` which will cover all of the size() methods. This is essentially what I do in my [fixture](https://github.com/ben-manes/caffeine/blob/master/caffeine/src/test/java/com/github/benmanes/caffeine/cache/testing/GuavaCacheFromContext.java#L207), which is used to run all my tests against both Caffeine and Guava implementations to find bugs / check compatibility.\n\nAgain I'm not sure why this occurs from reading the code, but I was able to reproduce the exception (its racy so takes a few tries). The fix is safe and non-invasive, so easier to resolve it there than dig into the race causing it.\n",
"created_at": "2015-07-30T18:38:53Z"
},
{
"body": "Is it enough to max(0, entireSize) or should it be done to each individual segment count?\n",
"created_at": "2015-07-30T19:24:21Z"
},
{
"body": "Either is fine with me. Since the size is an estimate, rather than exact, I'm not overly concerned either way. The `long` avoids overflow so your idea would be for better precision.\n",
"created_at": "2015-07-30T19:26:50Z"
},
{
"body": "Patch submitted internally; that should make it out into the next RC.\n",
"created_at": "2015-07-30T19:49:13Z"
}
],
"number": 2108,
"title": "Cache.asMap().size() may return a negative value"
} | {
"body": "The `asMap().compute` implementation did not take into account that the present value may be loading. A load does not block other writes to that entry and takes into account that it may be clobbered, causing it to automatically discard itself. This is a known design choice that breaks linearizability assumptions (#1881). The compute should check if a load is in progress and call the appropriate internal removal method.\r\n\r\nBecause a zombie entry remained in the cache and still is marked as loading, the loader could discover entry and try to wait for it to materialize. When the computation is a removal, indicated by a null value, the loader would see this as the zombie's result. Since a cache loader may not return null it would throw an exception to indicate a user bug.\r\n\r\nA new `ComputingValueReference` resolves both issues by indicating that the load has completed. The compute's `removeEntry` will then actually remove this entry and the loader will not wait on the zombie. Instead if it observes the entry, it will neither receive a non-null value or wait for it to load, but rather try to load anew under the lock. This piggybacks on the reference collection support where an entry is present but its value was garbage collected, causing the load to proceed. By the time the lock is obtained the compute method's entry was removed and the load proceeds as normal (so no unnecessary notification is produced).\r\n\r\nfixes #5342\r\nfixes #2827\r\nresolves underlying cause of #2108",
"number": 5348,
"review_comments": [],
"title": "Fix compatibility between the cache compute methods and a load"
} | {
"commits": [
{
"message": "Fix compatibility between the cache compute methods and a load\n\nThe asMap().compute implementation did not take into account that the\npresent value may be loading. A load does not block other writes to\nthat entry and takes into account that it may be clobbered, causing\nit to automatically discard itself. This is a known design choice that\nbreaks linearizability assumptions (#1881). The compute should check\nif a load is in progress and call the appropriate internal removal\nmethod.\n\nBecause a zombie entry remained in the cache and still is marked as\nloading, the loader could discover entry and try to wait for it to\nmaterialize. When the computation is a removal, indicated by a null\nvalue, the loader would see this as the zombie's result. Since a cache\nloader may not return null it would throw an exception to indicate\na user bug.\n\nA new ComputingValueReference resolves both issues by indicating\nthat the load has completed. The compute's removeEntry will then\nactually remove this entry and the loader will not wait on the\nzombie. Instead if it observes the entry, it will neither receive\na non-null value or wait for it to load, but rather try to load\nanew under the lock. This piggybacks on the reference collection\nsupport where an entry is present but its value was garbage\ncollected, causing the load to proceed. By the time the lock is\nobtained the compute method's entry was removed and the load\nproceeds as normal (so no unnecessary notification is produced).\n\nfixes #5342\nfixes #2827\nresolves underlying cause of #2108"
}
],
"files": [
{
"diff": "@@ -18,9 +18,17 @@\n \n import static com.google.common.truth.Truth.assertThat;\n \n+import java.util.ArrayList;\n+import java.util.List;\n+import java.util.Queue;\n+import java.util.concurrent.ConcurrentLinkedQueue;\n+import java.util.concurrent.ExecutionException;\n import java.util.concurrent.TimeUnit;\n import java.util.function.IntConsumer;\n import java.util.stream.IntStream;\n+\n+import com.google.common.util.concurrent.UncheckedExecutionException;\n+\n import junit.framework.TestCase;\n \n /** Test Java8 map.compute in concurrent cache context. */\n@@ -91,6 +99,27 @@ public void testComputeIfPresent() {\n assertThat(cache.getIfPresent(key).split(delimiter)).hasLength(count + 1);\n }\n \n+ public void testComputeIfPresentRemove() {\n+ List<RemovalNotification<Integer, Integer>> notifications = new ArrayList<>();\n+ Cache<Integer, Integer> cache = CacheBuilder.newBuilder()\n+ .removalListener(new RemovalListener<Integer, Integer>() {\n+ @Override public void onRemoval(RemovalNotification<Integer, Integer> notification) {\n+ notifications.add(notification);\n+ }\n+ }).build();\n+ cache.put(1, 2);\n+\n+ // explicitly remove the existing value\n+ cache.asMap().computeIfPresent(1, (key, value) -> null);\n+ assertThat(notifications).hasSize(1);\n+ CacheTesting.checkEmpty(cache);\n+\n+ // ensure no zombie entry remains\n+ cache.asMap().computeIfPresent(1, (key, value) -> null);\n+ assertThat(notifications).hasSize(1);\n+ CacheTesting.checkEmpty(cache);\n+ }\n+\n public void testUpdates() {\n cache.put(key, \"1\");\n // simultaneous update for same key, some null, some non-null\n@@ -113,6 +142,39 @@ public void testCompute() {\n assertEquals(0, cache.size());\n }\n \n+ //\n+ public void testComputeWithLoad() {\n+ Queue<RemovalNotification<String, String>> notifications = new ConcurrentLinkedQueue<>();\n+ cache = CacheBuilder.newBuilder()\n+ .removalListener(new RemovalListener<String, String>() {\n+ @Override public void onRemoval(RemovalNotification<String, String> notification) {\n+ notifications.add(notification);\n+ }\n+ })\n+ .expireAfterAccess(500000, TimeUnit.MILLISECONDS)\n+ .maximumSize(count)\n+ .build();\n+\n+ cache.put(key, \"1\");\n+ // simultaneous load and deletion\n+ doParallelCacheOp(\n+ count,\n+ n -> {\n+ try {\n+ cache.get(key, () -> key);\n+ cache.asMap().compute(key, (k, v) -> null);\n+ } catch (ExecutionException e) {\n+ throw new UncheckedExecutionException(e);\n+ }\n+ });\n+\n+ CacheTesting.checkEmpty(cache);\n+ for (RemovalNotification<String, String> entry : notifications) {\n+ assertThat(entry.getKey()).isNotNull();\n+ assertThat(entry.getValue()).isNotNull();\n+ }\n+ }\n+\n public void testComputeExceptionally() {\n try {\n doParallelCacheOp(",
"filename": "guava-tests/test/com/google/common/cache/LocalCacheMapComputeTest.java",
"status": "modified"
},
{
"diff": "@@ -2188,7 +2188,7 @@ V waitForLoadingValue(ReferenceEntry<K, V> e, K key, ValueReference<K, V> valueR\n V compute(K key, int hash, BiFunction<? super K, ? super V, ? extends V> function) {\n ReferenceEntry<K, V> e;\n ValueReference<K, V> valueReference = null;\n- LoadingValueReference<K, V> loadingValueReference = null;\n+ ComputingValueReference<K, V> loadingValueReference = null;\n boolean createNewEntry = true;\n V newValue;\n \n@@ -2229,7 +2229,7 @@ V compute(K key, int hash, BiFunction<? super K, ? super V, ? extends V> functio\n \n // note valueReference can be an existing value or even itself another loading value if\n // the value for the key is already being computed.\n- loadingValueReference = new LoadingValueReference<>(valueReference);\n+ loadingValueReference = new ComputingValueReference<>(valueReference);\n \n if (e == null) {\n createNewEntry = true;\n@@ -2257,6 +2257,9 @@ V compute(K key, int hash, BiFunction<? super K, ? super V, ? extends V> functio\n } else if (createNewEntry) {\n removeLoadingValue(key, hash, loadingValueReference);\n return null;\n+ } else if (valueReference.isLoading()) {\n+ removeLoadingValue(key, hash, loadingValueReference);\n+ return null;\n } else {\n removeEntry(e, hash, RemovalCause.EXPLICIT);\n return null;\n@@ -3465,6 +3468,18 @@ void runUnlockedCleanup() {\n }\n }\n \n+ static class ComputingValueReference<K, V> extends LoadingValueReference<K, V> {\n+ public ComputingValueReference() {\n+ super();\n+ }\n+ public ComputingValueReference(ValueReference<K, V> oldValue) {\n+ super(oldValue);\n+ }\n+ @Override public boolean isLoading() {\n+ return false;\n+ }\n+ }\n+\n static class LoadingValueReference<K, V> implements ValueReference<K, V> {\n volatile ValueReference<K, V> oldValue;\n \n@@ -3927,7 +3942,7 @@ long longSize() {\n Segment<K, V>[] segments = this.segments;\n long sum = 0;\n for (int i = 0; i < segments.length; ++i) {\n- sum += Math.max(0, segments[i].count); // see https://github.com/google/guava/issues/2108\n+ sum += segments[i].count;\n }\n return sum;\n }",
"filename": "guava/src/com/google/common/cache/LocalCache.java",
"status": "modified"
}
]
} |
{
"body": "[`Closeable.close`](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Closeable.html#close()) says:\r\n> If the stream is already closed then invoking this method has no effect.\r\n\r\nCode:\r\n```\r\nStringWriter w = new StringWriter();\r\nOutputStream out = BaseEncoding.base64().encodingStream(w);\r\nout.write(0);\r\nout.close();\r\nSystem.out.println(w);\r\nout.close();\r\nSystem.out.println(w);\r\n```\r\nOutput:\r\n```\r\nAA==\r\nAA==A===\r\n```",
"comments": [
{
"body": "Thanks. For our reference, here is [the implementation](https://github.com/google/guava/blob/bc67a44a1676211b2c6859adbc021c3640e66990/guava/src/com/google/common/io/BaseEncoding.java#L618). The simplest thing is probably to mark _all_ methods as `synchronized` and track `isClosed` in a `boolean` field. That may have some performance impact, but I'm not sure we can do better without giving up on thread-safety, which IO streams generally have (though I forget if it's actually guaranteed).",
"created_at": "2020-10-16T13:57:55Z"
},
{
"body": "It looks like the problem is just that `close` doesn't adjust `bitBufferLength`. I don't think thread-safety is required.",
"created_at": "2020-10-16T14:09:04Z"
},
{
"body": "Being idempotent is useful; it's very easy to double-close a stream due to ARM blocks and wrapping streams that close their underlying streams.\r\n\r\nSynchronization is probably unnecessary. Java I/O streams are generally synchronized, but I've never seen anyone use multiple threads to concurrently read or write a shared stream.",
"created_at": "2020-10-16T14:10:16Z"
},
{
"body": "> `close` doesn't adjust `bitBufferLength`\r\n@brettkail-wk I assumed you meant that it should go back to zero after closing, even if I'm not sure that it's descriptive of the stream's state.\r\n\r\n",
"created_at": "2020-10-17T23:54:28Z"
},
{
"body": "And while we're at it, @cpovirk, do you think it is possible to tag this repository with topic `hacktoberfest`? That would make this PR count towards my 4 PR goal - and my shirt! :shirt: :1234: \r\nThanks :)\r\n",
"created_at": "2020-10-19T11:41:25Z"
},
{
"body": "@Saucistophe I have not analyzed the code. I just observed the condition for writing more bytes in `close`, and I noticed the similarity in structure to the `write` method, which does adjust `bitBufferLength`.",
"created_at": "2020-10-19T14:28:13Z"
},
{
"body": "I met the same issue, on guava 31.1-jre, is there any plan to have it fixed?",
"created_at": "2023-03-13T05:54:15Z"
}
],
"number": 5284,
"title": "BaseEncoding.encodingStream().close() is non-idempotent"
} | {
"body": "Fixes #5284",
"number": 5288,
"review_comments": [
{
"body": "I'd move this just after the increment to writtenChars (so, just in case the write of the padding character fails and someone tries to re-close the stream anyway, we get it correctly)",
"created_at": "2020-10-22T16:30:18Z"
},
{
"body": "Done!",
"created_at": "2020-10-24T10:08:53Z"
}
],
"title": "#5284 - Fixed different result when closing encoding stream twice"
} | {
"commits": [
{
"message": "#5284 - reproduced faulty behavior"
},
{
"message": "#5284 - Fixed different result when closing encoding stream twice"
},
{
"message": "#5284 - Handled android flavour"
},
{
"message": "#5284 - PR feedback"
}
],
"files": [
{
"diff": "@@ -518,6 +518,18 @@ private static void testStreamingEncodes(BaseEncoding encoding, String decoded,\n assertThat(writer.toString()).isEqualTo(encoded);\n }\n \n+ public void testStreamingEncodingIdempotency()\n+ throws IOException {\n+ StringWriter writer = new StringWriter();\n+ OutputStream encodingStream = base64().encodingStream(writer);\n+ encodingStream.write(0);\n+ encodingStream.close();\n+ assertThat(writer.toString()).isEqualTo(\"AA==\");\n+ // Close again and ensure nothing happens.\n+ encodingStream.close();\n+ assertThat(writer.toString()).isEqualTo(\"AA==\");\n+ }\n+\n @GwtIncompatible // Reader\n private static void testStreamingDecodes(BaseEncoding encoding, String encoded, String decoded)\n throws IOException {",
"filename": "android/guava-tests/test/com/google/common/io/BaseEncodingTest.java",
"status": "modified"
},
{
"diff": "@@ -620,6 +620,7 @@ public void close() throws IOException {\n int charIndex = (bitBuffer << (alphabet.bitsPerChar - bitBufferLength)) & alphabet.mask;\n out.write(alphabet.encode(charIndex));\n writtenChars++;\n+ bitBufferLength = 0;\n if (paddingChar != null) {\n while (writtenChars % alphabet.charsPerChunk != 0) {\n out.write(paddingChar.charValue());",
"filename": "android/guava/src/com/google/common/io/BaseEncoding.java",
"status": "modified"
},
{
"diff": "@@ -518,6 +518,19 @@ private static void testStreamingEncodes(BaseEncoding encoding, String decoded,\n assertThat(writer.toString()).isEqualTo(encoded);\n }\n \n+ public void testStreamingEncodingIdempotency()\n+ throws IOException {\n+ StringWriter writer = new StringWriter();\n+ OutputStream encodingStream = base64().encodingStream(writer);\n+ encodingStream.write(0);\n+ encodingStream.close();\n+ assertThat(writer.toString()).isEqualTo(\"AA==\");\n+ // Close again and ensure nothing happens.\n+ encodingStream.close();\n+ assertThat(writer.toString()).isEqualTo(\"AA==\");\n+ }\n+\n+\n @GwtIncompatible // Reader\n private static void testStreamingDecodes(BaseEncoding encoding, String encoded, String decoded)\n throws IOException {",
"filename": "guava-tests/test/com/google/common/io/BaseEncodingTest.java",
"status": "modified"
},
{
"diff": "@@ -620,6 +620,7 @@ public void close() throws IOException {\n int charIndex = (bitBuffer << (alphabet.bitsPerChar - bitBufferLength)) & alphabet.mask;\n out.write(alphabet.encode(charIndex));\n writtenChars++;\n+ bitBufferLength = 0;\n if (paddingChar != null) {\n while (writtenChars % alphabet.charsPerChunk != 0) {\n out.write(paddingChar.charValue());",
"filename": "guava/src/com/google/common/io/BaseEncoding.java",
"status": "modified"
}
]
} |
{
"body": "Unable to modify subRangeSet returned by TreeRangeSet.subRangeSet(Range).\r\nIMO, it should be availiable to do so as specified in the document.\r\n\r\n```java\r\nimport com.google.common.collect.Range;\r\nimport com.google.common.collect.TreeRangeSet;\r\nimport org.junit.jupiter.api.Test;\r\n\r\n@SuppressWarnings(\"UnstableApiUsage\")\r\npublic class SubRangeSetTest {\r\n\r\n @Test\r\n public void testAdd() {\r\n TreeRangeSet<Integer> set = TreeRangeSet.create();\r\n Range<Integer> range = Range.closedOpen(0, 5);\r\n set.subRangeSet(range).add(range);\r\n }\r\n\r\n @Test\r\n public void testReplaceAdd() {\r\n TreeRangeSet<Integer> set = TreeRangeSet.create();\r\n Range<Integer> range = Range.closedOpen(0, 5);\r\n set.add(range);\r\n set.subRangeSet(range).add(range);\r\n }\r\n}\r\n```\r\n\r\n```\r\njava.lang.UnsupportedOperationException\r\n\tat java.base/java.util.AbstractMap.put(AbstractMap.java:209)\r\n\tat com.google.common.collect.TreeRangeSet.replaceRangeWithSameLowerBound(TreeRangeSet.java:266)\r\n\tat com.google.common.collect.TreeRangeSet.add(TreeRangeSet.java:216)\r\n\tat com.google.common.collect.TreeRangeSet$SubRangeSet.add(TreeRangeSet.java:894)\r\n\tat SubRangeSetTest.testAdd(SubRangeSetTest.java:12)\r\n```\r\n```\r\njava.lang.UnsupportedOperationException\r\n\tat com.google.common.collect.UnmodifiableIterator.remove(UnmodifiableIterator.java:46)\r\n\tat com.google.common.collect.Iterators.clear(Iterators.java:985)\r\n\tat com.google.common.collect.Maps$IteratorBasedAbstractMap.clear(Maps.java:3562)\r\n\tat com.google.common.collect.TreeRangeSet.add(TreeRangeSet.java:214)\r\n\tat com.google.common.collect.TreeRangeSet$SubRangeSet.add(TreeRangeSet.java:894)\r\n\tat SubRangeSetTest.testReplaceAdd(SubRangeSetTest.java:20)\r\n```",
"comments": [
{
"body": "Thanks, that sounds like a bug to me, too.\r\n\r\nI see a slightly different stack trace (with both guava-29.0-jre.jar and guava-29.0-android.jar), so the exact failure may depend on the Guava version:\r\n\r\n```\r\n# -jre\r\nException in thread \"main\" java.lang.UnsupportedOperationException\r\n at java.base/java.util.AbstractMap.put(AbstractMap.java:209)\r\n at com.google.common.collect.TreeRangeSet.replaceRangeWithSameLowerBound(TreeRangeSet.java:266)\r\n at com.google.common.collect.TreeRangeSet.add(TreeRangeSet.java:216)\r\n at com.google.common.collect.TreeRangeSet$SubRangeSet.add(TreeRangeSet.java:894)\r\n at Issue4002.main(Issue4002.java:8)\r\n\r\n# -android\r\nException in thread \"main\" java.lang.UnsupportedOperationException\r\n at java.base/java.util.AbstractMap.put(AbstractMap.java:209)\r\n at com.google.common.collect.TreeRangeSet.replaceRangeWithSameLowerBound(TreeRangeSet.java:268)\r\n at com.google.common.collect.TreeRangeSet.add(TreeRangeSet.java:218)\r\n at com.google.common.collect.TreeRangeSet$SubRangeSet.add(TreeRangeSet.java:899)\r\n at Issue4002.main(Issue4002.java:8)\r\n```\r\n\r\nSorry for the trouble. We will have a look.",
"created_at": "2020-08-31T13:57:55Z"
},
{
"body": "Presumably because we don't implement `put` in `SubRangeSetRangesByLowerBound`.",
"created_at": "2020-08-31T14:00:24Z"
},
{
"body": "This is a stacktrace of ~~subRangeSet.remove~~ replace existing range. It should meet the same stacktrace(UnsupportedOperationException) ~~over all guava versions~~ since 18.0. And StackOverflowerError from 14.0 to 17.0.",
"created_at": "2020-08-31T14:09:12Z"
},
{
"body": "Oh, thanks, I pasted from the email (which has the original text from your post). It's good to know that both add _and_ remove fail.",
"created_at": "2020-08-31T14:13:20Z"
},
{
"body": "The codes and stacktraces updated.",
"created_at": "2020-08-31T14:20:51Z"
},
{
"body": "`subRangeSet` was part of the initial `RangeSet` in Guava 14.0. Calling `add` against that version, I get a `StackOverflowError`... :) I haven't checked whether `add` worked in some intermediate version.\r\n\r\n`remove` at least is a successful no-op under 14.0. So that's a definite regression.",
"created_at": "2020-08-31T14:47:18Z"
},
{
"body": "Oh, sorry, you're saying that `remove` is OK but that `add` is broken -- both in the case in which `add` has to remove an existing range and in the case in which it doesn't.",
"created_at": "2020-08-31T14:54:25Z"
},
{
"body": "(`add` is broken at least as far back as Guava 20.0.)",
"created_at": "2020-08-31T14:55:00Z"
}
],
"number": 4002,
"title": "UnsupportedOperationException when modify TreeRangeSet.subRangeSet(Range)"
} | {
"body": "This code has been reviewed and submitted internally. Feel free to discuss on\nthe PR, and we can submit follow-up changes as necessary.\n\nCommits:\n=====\n<p> Fix UnsupportedOperationException from TreeRangeSet.subRangeSet(...).add(...).\n\nFixes #4019, #4002\n\n3685507ce36e24f111cabb45c6d5c5dd26565aad\n\n-------\n\n<p> Deal with Class#isInstance checks which are guaranteed to be false.\n\n2fa82f2cb6e1d2f6c29b7986be6e95063b65bf71\n\n-------\n\n<p> Change `ForwardingMap.remove(Object)` parameter name from `object` to `key` to match `Map.remove(Object key)`.\n\nFixes https://github.com/google/guava/issues/4028\n\n204904cbe79852e29aec2e461273f9b6112bd2f9",
"number": 4030,
"review_comments": [],
"title": "MOE Sync 2020-09-18"
} | {
"commits": [
{
"message": "Fix UnsupportedOperationException from TreeRangeSet.subRangeSet(...).add(...).\n\nFixes #4019, #4002\n\nRELNOTES=n/a\n\n-------------\nCreated by MOE: https://github.com/google/moe\nMOE_MIGRATED_REVID=332262870"
},
{
"message": "Deal with Class#isInstance checks which are guaranteed to be false.\n\n-------------\nCreated by MOE: https://github.com/google/moe\nMOE_MIGRATED_REVID=332298366"
},
{
"message": "Change `ForwardingMap.remove(Object)` parameter name from `object` to `key` to match `Map.remove(Object key)`.\n\nFixes https://github.com/google/guava/issues/4028\n\nRELNOTES=n/a\n\n-------------\nCreated by MOE: https://github.com/google/moe\nMOE_MIGRATED_REVID=332443901"
}
],
"files": [
{
"diff": "@@ -285,6 +285,19 @@ public void testSubRangeSet() {\n }\n }\n \n+ public void testSubRangeSetAdd() {\n+ TreeRangeSet<Integer> set = TreeRangeSet.create();\n+ Range<Integer> range = Range.closedOpen(0, 5);\n+ set.subRangeSet(range).add(range);\n+ }\n+\n+ public void testSubRangeSetReplaceAdd() {\n+ TreeRangeSet<Integer> set = TreeRangeSet.create();\n+ Range<Integer> range = Range.closedOpen(0, 5);\n+ set.add(range);\n+ set.subRangeSet(range).add(range);\n+ }\n+\n public void testComplement() {\n for (Range<Integer> range1 : QUERY_RANGES) {\n for (Range<Integer> range2 : QUERY_RANGES) {",
"filename": "android/guava-tests/test/com/google/common/collect/TreeRangeSetTest.java",
"status": "modified"
},
{
"diff": "@@ -233,6 +233,7 @@ public synchronized void run() {\n }\n }\n \n+ @SuppressWarnings(\"IsInstanceIncompatibleType\") // intentional.\n public void testListenInPoolThreadRunsListenerAfterRuntimeException() throws Exception {\n RuntimeExceptionThrowingFuture<String> input = new RuntimeExceptionThrowingFuture<>();\n /*",
"filename": "android/guava-tests/test/com/google/common/util/concurrent/JdkFutureAdaptersTest.java",
"status": "modified"
},
{
"diff": "@@ -76,8 +76,8 @@ public boolean isEmpty() {\n \n @CanIgnoreReturnValue\n @Override\n- public V remove(Object object) {\n- return delegate().remove(object);\n+ public V remove(Object key) {\n+ return delegate().remove(key);\n }\n \n @Override",
"filename": "android/guava/src/com/google/common/collect/ForwardingMap.java",
"status": "modified"
},
{
"diff": "@@ -896,7 +896,7 @@ public void add(Range<C> rangeToAdd) {\n \"Cannot add range %s to subRangeSet(%s)\",\n rangeToAdd,\n restriction);\n- super.add(rangeToAdd);\n+ TreeRangeSet.this.add(rangeToAdd);\n }\n \n @Override",
"filename": "android/guava/src/com/google/common/collect/TreeRangeSet.java",
"status": "modified"
},
{
"diff": "@@ -285,6 +285,19 @@ public void testSubRangeSet() {\n }\n }\n \n+ public void testSubRangeSetAdd() {\n+ TreeRangeSet<Integer> set = TreeRangeSet.create();\n+ Range<Integer> range = Range.closedOpen(0, 5);\n+ set.subRangeSet(range).add(range);\n+ }\n+\n+ public void testSubRangeSetReplaceAdd() {\n+ TreeRangeSet<Integer> set = TreeRangeSet.create();\n+ Range<Integer> range = Range.closedOpen(0, 5);\n+ set.add(range);\n+ set.subRangeSet(range).add(range);\n+ }\n+\n public void testComplement() {\n for (Range<Integer> range1 : QUERY_RANGES) {\n for (Range<Integer> range2 : QUERY_RANGES) {",
"filename": "guava-tests/test/com/google/common/collect/TreeRangeSetTest.java",
"status": "modified"
},
{
"diff": "@@ -233,6 +233,7 @@ public synchronized void run() {\n }\n }\n \n+ @SuppressWarnings(\"IsInstanceIncompatibleType\") // intentional.\n public void testListenInPoolThreadRunsListenerAfterRuntimeException() throws Exception {\n RuntimeExceptionThrowingFuture<String> input = new RuntimeExceptionThrowingFuture<>();\n /*",
"filename": "guava-tests/test/com/google/common/util/concurrent/JdkFutureAdaptersTest.java",
"status": "modified"
},
{
"diff": "@@ -76,8 +76,8 @@ public boolean isEmpty() {\n \n @CanIgnoreReturnValue\n @Override\n- public V remove(Object object) {\n- return delegate().remove(object);\n+ public V remove(Object key) {\n+ return delegate().remove(key);\n }\n \n @Override",
"filename": "guava/src/com/google/common/collect/ForwardingMap.java",
"status": "modified"
},
{
"diff": "@@ -891,7 +891,7 @@ public void add(Range<C> rangeToAdd) {\n \"Cannot add range %s to subRangeSet(%s)\",\n rangeToAdd,\n restriction);\n- super.add(rangeToAdd);\n+ TreeRangeSet.this.add(rangeToAdd);\n }\n \n @Override",
"filename": "guava/src/com/google/common/collect/TreeRangeSet.java",
"status": "modified"
}
]
} |
{
"body": "@zhanhb [reports](https://github.com/google/guava/commit/a9dd7098f741d652fe2daf8193b831737dc36aa0#commitcomment-41940819):\r\n\r\n```java\r\nRange.atLeast(1).gap(Range.atLeast(2));\r\n```\r\n```txt\r\njava.lang.AssertionError\r\n\tat com.google.common.collect.Cut$AboveAll.describeAsLowerBound(Cut.java:259)\r\n\tat com.google.common.collect.Range.toString(Range.java:674)\r\n\tat com.google.common.collect.Range.<init>(Range.java:357)\r\n\tat com.google.common.collect.Range.create(Range.java:155)\r\n\tat com.google.common.collect.Range.gap(Range.java:582)\r\n```",
"comments": [],
"number": 4004,
"title": "AssertionError from Range.gap"
} | {
"body": "This code has been reviewed and submitted internally. Feel free to discuss on\nthe PR, and we can submit follow-up changes as necessary.\n\nCommits:\n=====\n<p> Fix AssertionError from Range.gap.\n\nFixes #4007, #4004\n\n88593a07f3a04163f2c68cf323a54cd8f8efdd03\n\n-------\n\n<p> Fix random typos in Guava.\n\nFixes #4021\n\n1102d11be3bbe534a5a569832aeb0099aa0eaa61\n\n-------\n\n<p> Add back web.app to public suffix list\n\nd12e9833c5232032c8e9a0b51c9ea3b9ce5e2b9d\n\n-------\n\n<p> Externally restore @DoNotMock to ClosingFuture.Combiner, and externally add @DoNotMock to ClosingFuture itself.\n\nThis implements an alternative workaround for https://bugs.openjdk.java.net/browse/JDK-7101822, replacing the one submitted in CL 331770482.\n\n7b4c82f4e436311184cfb61cd6cfd8fb85a3dbe5",
"number": 4029,
"review_comments": [],
"title": "MOE Sync 2020-09-17"
} | {
"commits": [
{
"message": "Fix AssertionError from Range.gap.\n\nFixes #4007, #4004\n\nRELNOTES=n/a\n\n-------------\nCreated by MOE: https://github.com/google/moe\nMOE_MIGRATED_REVID=332057751"
},
{
"message": "Fix random typos in Guava.\n\nFixes #4021\n\nRELNOTES=n/a\n\n-------------\nCreated by MOE: https://github.com/google/moe\nMOE_MIGRATED_REVID=332065668"
},
{
"message": "Add back web.app to public suffix list\n\n-------------\nCreated by MOE: https://github.com/google/moe\nMOE_MIGRATED_REVID=332107904"
},
{
"message": "Externally restore @DoNotMock to ClosingFuture.Combiner, and externally add @DoNotMock to ClosingFuture itself.\n\nThis implements an alternative workaround for https://bugs.openjdk.java.net/browse/JDK-7101822, replacing the one submitted in CL 331770482.\n\nRELNOTES=n/a\n\n-------------\nCreated by MOE: https://github.com/google/moe\nMOE_MIGRATED_REVID=332225001"
}
],
"files": [
{
"diff": "@@ -472,6 +472,32 @@ public void testGap_overlapping() {\n }\n }\n \n+ public void testGap_invalidRangesWithInfinity() {\n+ try {\n+ Range.atLeast(1).gap(Range.atLeast(2));\n+ fail();\n+ } catch (IllegalArgumentException expected) {\n+ }\n+\n+ try {\n+ Range.atLeast(2).gap(Range.atLeast(1));\n+ fail();\n+ } catch (IllegalArgumentException expected) {\n+ }\n+\n+ try {\n+ Range.atMost(1).gap(Range.atMost(2));\n+ fail();\n+ } catch (IllegalArgumentException expected) {\n+ }\n+\n+ try {\n+ Range.atMost(2).gap(Range.atMost(1));\n+ fail();\n+ } catch (IllegalArgumentException expected) {\n+ }\n+ }\n+\n public void testGap_connectedAdjacentYieldsEmpty() {\n Range<Integer> range = Range.open(3, 4);\n \n@@ -500,6 +526,8 @@ public void testGap_general() {\n assertEquals(Range.open(2, 4), closedRange.gap(Range.atMost(2)));\n }\n \n+ // TODO(cpovirk): More extensive testing of gap().\n+\n public void testSpan_general() {\n Range<Integer> range = Range.closed(4, 8);\n ",
"filename": "android/guava-tests/test/com/google/common/collect/RangeTest.java",
"status": "modified"
},
{
"diff": "@@ -395,7 +395,7 @@ public void testFutureBash() {\n final ExecutorService executor = Executors.newFixedThreadPool(barrier.getParties());\n final AtomicReference<AbstractFuture<String>> currentFuture = Atomics.newReference();\n final AtomicInteger numSuccessfulSetCalls = new AtomicInteger();\n- Callable<Void> completeSucessFullyRunnable =\n+ Callable<Void> completeSuccessfullyRunnable =\n new Callable<Void>() {\n @Override\n public Void call() {\n@@ -430,7 +430,7 @@ public Void call() {\n return null;\n }\n };\n- Callable<Void> setFutureCompleteSucessFullyRunnable =\n+ Callable<Void> setFutureCompleteSuccessfullyRunnable =\n new Callable<Void>() {\n ListenableFuture<String> future = Futures.immediateFuture(\"setFuture\");\n \n@@ -511,10 +511,10 @@ public void run() {\n }\n };\n List<Callable<?>> allTasks = new ArrayList<>();\n- allTasks.add(completeSucessFullyRunnable);\n+ allTasks.add(completeSuccessfullyRunnable);\n allTasks.add(completeExceptionallyRunnable);\n allTasks.add(cancelRunnable);\n- allTasks.add(setFutureCompleteSucessFullyRunnable);\n+ allTasks.add(setFutureCompleteSuccessfullyRunnable);\n allTasks.add(setFutureCompleteExceptionallyRunnable);\n allTasks.add(setFutureCancelRunnable);\n for (int k = 0; k < 50; k++) {\n@@ -577,24 +577,24 @@ public void testSetFutureCancelBash() {\n final ExecutorService executor = Executors.newFixedThreadPool(barrier.getParties());\n final AtomicReference<AbstractFuture<String>> currentFuture = Atomics.newReference();\n final AtomicReference<AbstractFuture<String>> setFutureFuture = Atomics.newReference();\n- final AtomicBoolean setFutureSetSucess = new AtomicBoolean();\n- final AtomicBoolean setFutureCompletionSucess = new AtomicBoolean();\n- final AtomicBoolean cancellationSucess = new AtomicBoolean();\n+ final AtomicBoolean setFutureSetSuccess = new AtomicBoolean();\n+ final AtomicBoolean setFutureCompletionSuccess = new AtomicBoolean();\n+ final AtomicBoolean cancellationSuccess = new AtomicBoolean();\n Runnable cancelRunnable =\n new Runnable() {\n @Override\n public void run() {\n- cancellationSucess.set(currentFuture.get().cancel(true));\n+ cancellationSuccess.set(currentFuture.get().cancel(true));\n awaitUnchecked(barrier);\n }\n };\n- Runnable setFutureCompleteSucessFullyRunnable =\n+ Runnable setFutureCompleteSuccessfullyRunnable =\n new Runnable() {\n @Override\n public void run() {\n AbstractFuture<String> future = setFutureFuture.get();\n- setFutureSetSucess.set(currentFuture.get().setFuture(future));\n- setFutureCompletionSucess.set(future.set(\"hello-async-world\"));\n+ setFutureSetSuccess.set(currentFuture.get().setFuture(future));\n+ setFutureCompletionSuccess.set(future.set(\"hello-async-world\"));\n awaitUnchecked(barrier);\n }\n };\n@@ -640,7 +640,7 @@ public void run() {\n };\n List<Runnable> allTasks = new ArrayList<>();\n allTasks.add(cancelRunnable);\n- allTasks.add(setFutureCompleteSucessFullyRunnable);\n+ allTasks.add(setFutureCompleteSuccessfullyRunnable);\n for (int k = 0; k < size; k++) {\n // For each listener we add a task that submits it to the executor directly for the blocking\n // get usecase and another task that adds it as a listener to the future to exercise both\n@@ -673,27 +673,27 @@ public void run() {\n Object result = Iterables.getOnlyElement(finalResults);\n if (result == CancellationException.class) {\n assertTrue(future.isCancelled());\n- assertTrue(cancellationSucess.get());\n+ assertTrue(cancellationSuccess.get());\n // cancellation can interleave in 3 ways\n // 1. prior to setFuture\n // 2. after setFuture before set() on the future assigned\n // 3. after setFuture and set() are called but before the listener completes.\n- if (!setFutureSetSucess.get() || !setFutureCompletionSucess.get()) {\n+ if (!setFutureSetSuccess.get() || !setFutureCompletionSuccess.get()) {\n // If setFuture fails or set on the future fails then it must be because that future was\n // cancelled\n assertTrue(setFuture.isCancelled());\n assertTrue(setFuture.wasInterrupted()); // we only call cancel(true)\n }\n } else {\n // set on the future completed\n- assertFalse(cancellationSucess.get());\n- assertTrue(setFutureSetSucess.get());\n- assertTrue(setFutureCompletionSucess.get());\n+ assertFalse(cancellationSuccess.get());\n+ assertTrue(setFutureSetSuccess.get());\n+ assertTrue(setFutureCompletionSuccess.get());\n }\n // reset for next iteration\n- setFutureSetSucess.set(false);\n- setFutureCompletionSucess.set(false);\n- cancellationSucess.set(false);\n+ setFutureSetSuccess.set(false);\n+ setFutureCompletionSuccess.set(false);\n+ cancellationSuccess.set(false);\n finalResults.clear();\n }\n executor.shutdown();\n@@ -710,17 +710,17 @@ public void testSetFutureCancelBash_withDoneFuture() {\n final ExecutorService executor = Executors.newFixedThreadPool(barrier.getParties());\n final AtomicReference<AbstractFuture<String>> currentFuture = Atomics.newReference();\n final AtomicBoolean setFutureSuccess = new AtomicBoolean();\n- final AtomicBoolean cancellationSucess = new AtomicBoolean();\n+ final AtomicBoolean cancellationSuccess = new AtomicBoolean();\n Callable<Void> cancelRunnable =\n new Callable<Void>() {\n @Override\n public Void call() {\n- cancellationSucess.set(currentFuture.get().cancel(true));\n+ cancellationSuccess.set(currentFuture.get().cancel(true));\n awaitUnchecked(barrier);\n return null;\n }\n };\n- Callable<Void> setFutureCompleteSucessFullyRunnable =\n+ Callable<Void> setFutureCompleteSuccessfullyRunnable =\n new Callable<Void>() {\n final ListenableFuture<String> future = Futures.immediateFuture(\"hello\");\n \n@@ -750,7 +750,7 @@ public void run() {\n };\n List<Callable<?>> allTasks = new ArrayList<>();\n allTasks.add(cancelRunnable);\n- allTasks.add(setFutureCompleteSucessFullyRunnable);\n+ allTasks.add(setFutureCompleteSuccessfullyRunnable);\n allTasks.add(Executors.callable(collectResultsRunnable));\n assertEquals(allTasks.size() + 1, barrier.getParties()); // sanity check\n for (int i = 0; i < 1000; i++) {\n@@ -768,15 +768,15 @@ public void run() {\n Object result = Iterables.getOnlyElement(finalResults);\n if (result == CancellationException.class) {\n assertTrue(future.isCancelled());\n- assertTrue(cancellationSucess.get());\n+ assertTrue(cancellationSuccess.get());\n assertFalse(setFutureSuccess.get());\n } else {\n assertTrue(setFutureSuccess.get());\n- assertFalse(cancellationSucess.get());\n+ assertFalse(cancellationSuccess.get());\n }\n // reset for next iteration\n setFutureSuccess.set(false);\n- cancellationSucess.set(false);\n+ cancellationSuccess.set(false);\n finalResults.clear();\n }\n executor.shutdown();",
"filename": "android/guava-tests/test/com/google/common/util/concurrent/AbstractFutureTest.java",
"status": "modified"
},
{
"diff": "@@ -140,7 +140,7 @@ private ArrayTable(Iterable<? extends R> rowKeys, Iterable<? extends C> columnKe\n * TODO(jlevy): Support only one of rowKey / columnKey being empty? If we\n * do, when columnKeys is empty but rowKeys isn't, rowKeyList() can contain\n * elements but rowKeySet() will be empty and containsRow() won't\n- * acknolwedge them.\n+ * acknowledge them.\n */\n rowKeyToIndex = Maps.indexMap(rowList);\n columnKeyToIndex = Maps.indexMap(columnList);",
"filename": "android/guava/src/com/google/common/collect/ArrayTable.java",
"status": "modified"
},
{
"diff": "@@ -577,6 +577,22 @@ public Range<C> intersection(Range<C> connectedRange) {\n * @since 27.0\n */\n public Range<C> gap(Range<C> otherRange) {\n+ /*\n+ * For an explanation of the basic principle behind this check, see\n+ * https://stackoverflow.com/a/35754308/28465\n+ *\n+ * In that explanation's notation, our `overlap` check would be `x1 < y2 && y1 < x2`. We've\n+ * flipped one part of the check so that we're using \"less than\" in both cases (rather than a\n+ * mix of \"less than\" and \"greater than\"). We've also switched to \"strictly less than\" rather\n+ * than \"less than or equal to\" because of *handwave* the difference between \"endpoints of\n+ * inclusive ranges\" and \"Cuts.\"\n+ */\n+ if (lowerBound.compareTo(otherRange.upperBound) < 0\n+ && otherRange.lowerBound.compareTo(upperBound) < 0) {\n+ throw new IllegalArgumentException(\n+ \"Ranges have a nonempty intersection: \" + this + \", \" + otherRange);\n+ }\n+\n boolean isThisFirst = this.lowerBound.compareTo(otherRange.lowerBound) < 0;\n Range<C> firstRange = isThisFirst ? this : otherRange;\n Range<C> secondRange = isThisFirst ? otherRange : this;",
"filename": "android/guava/src/com/google/common/collect/Range.java",
"status": "modified"
},
{
"diff": "@@ -1053,12 +1053,12 @@ public Appendable append(@NullableDecl CharSequence chars) throws IOException {\n @GwtIncompatible // Writer\n static Writer separatingWriter(\n final Writer delegate, final String separator, final int afterEveryChars) {\n- final Appendable seperatingAppendable =\n+ final Appendable separatingAppendable =\n separatingAppendable(delegate, separator, afterEveryChars);\n return new Writer() {\n @Override\n public void write(int c) throws IOException {\n- seperatingAppendable.append((char) c);\n+ separatingAppendable.append((char) c);\n }\n \n @Override",
"filename": "android/guava/src/com/google/common/io/BaseEncoding.java",
"status": "modified"
},
{
"diff": "@@ -167,7 +167,7 @@ public static long copy(ReadableByteChannel from, WritableByteChannel to) throws\n */\n private static byte[] toByteArrayInternal(InputStream in, Queue<byte[]> bufs, int totalLen)\n throws IOException {\n- // Starting with an 8k buffer, double the size of each sucessive buffer. Buffers are retained\n+ // Starting with an 8k buffer, double the size of each successive buffer. Buffers are retained\n // in a deque so that there's no copying between buffers while reading and so all of the bytes\n // in each new allocated buffer are available for reading from the stream.\n for (int bufSize = BUFFER_SIZE;",
"filename": "android/guava/src/com/google/common/io/ByteStreams.java",
"status": "modified"
},
{
"diff": "@@ -45,6 +45,7 @@\n import com.google.common.util.concurrent.ClosingFuture.Combiner.CombiningCallable;\n import com.google.common.util.concurrent.Futures.FutureCombiner;\n import com.google.errorprone.annotations.CanIgnoreReturnValue;\n+import com.google.errorprone.annotations.DoNotMock;\n import com.google.j2objc.annotations.RetainedWith;\n import java.io.Closeable;\n import java.io.IOException;\n@@ -189,6 +190,7 @@\n */\n // TODO(dpb): Consider reusing one CloseableList for the entire pipeline, modulo combinations.\n @Beta // @Beta for one release.\n+@DoNotMock(\"Use ClosingFuture.from(Futures.immediate*Future)\")\n // TODO(dpb): GWT compatibility.\n public final class ClosingFuture<V> {\n \n@@ -1147,6 +1149,9 @@ private <V extends Object> FluentFuture<V> callAsync(\n * .closing(executor);\n * }</pre>\n */\n+ // TODO(cpovirk): Use simple name instead of fully qualified after we stop building with JDK 8.\n+ @com.google.errorprone.annotations.DoNotMock(\n+ \"Use ClosingFuture.whenAllSucceed() or .whenAllComplete() instead.\")\n public static class Combiner {\n \n private final CloseableList closeables = new CloseableList();",
"filename": "android/guava/src/com/google/common/util/concurrent/ClosingFuture.java",
"status": "modified"
},
{
"diff": "",
"filename": "android/guava/src/com/google/thirdparty/publicsuffix/PublicSuffixPatterns.java",
"status": "modified"
},
{
"diff": "@@ -123,6 +123,11 @@ public void testGap_general() throws Exception {\n testCase.testGap_general();\n }\n \n+public void testGap_invalidRangesWithInfinity() throws Exception {\n+ com.google.common.collect.RangeTest testCase = new com.google.common.collect.RangeTest();\n+ testCase.testGap_invalidRangesWithInfinity();\n+}\n+\n public void testGap_overlapping() throws Exception {\n com.google.common.collect.RangeTest testCase = new com.google.common.collect.RangeTest();\n testCase.testGap_overlapping();",
"filename": "guava-gwt/test/com/google/common/collect/RangeTest_gwt.java",
"status": "modified"
},
{
"diff": "@@ -472,6 +472,32 @@ public void testGap_overlapping() {\n }\n }\n \n+ public void testGap_invalidRangesWithInfinity() {\n+ try {\n+ Range.atLeast(1).gap(Range.atLeast(2));\n+ fail();\n+ } catch (IllegalArgumentException expected) {\n+ }\n+\n+ try {\n+ Range.atLeast(2).gap(Range.atLeast(1));\n+ fail();\n+ } catch (IllegalArgumentException expected) {\n+ }\n+\n+ try {\n+ Range.atMost(1).gap(Range.atMost(2));\n+ fail();\n+ } catch (IllegalArgumentException expected) {\n+ }\n+\n+ try {\n+ Range.atMost(2).gap(Range.atMost(1));\n+ fail();\n+ } catch (IllegalArgumentException expected) {\n+ }\n+ }\n+\n public void testGap_connectedAdjacentYieldsEmpty() {\n Range<Integer> range = Range.open(3, 4);\n \n@@ -500,6 +526,8 @@ public void testGap_general() {\n assertEquals(Range.open(2, 4), closedRange.gap(Range.atMost(2)));\n }\n \n+ // TODO(cpovirk): More extensive testing of gap().\n+\n public void testSpan_general() {\n Range<Integer> range = Range.closed(4, 8);\n ",
"filename": "guava-tests/test/com/google/common/collect/RangeTest.java",
"status": "modified"
},
{
"diff": "@@ -395,7 +395,7 @@ public void testFutureBash() {\n final ExecutorService executor = Executors.newFixedThreadPool(barrier.getParties());\n final AtomicReference<AbstractFuture<String>> currentFuture = Atomics.newReference();\n final AtomicInteger numSuccessfulSetCalls = new AtomicInteger();\n- Callable<Void> completeSucessFullyRunnable =\n+ Callable<Void> completeSuccessfullyRunnable =\n new Callable<Void>() {\n @Override\n public Void call() {\n@@ -430,7 +430,7 @@ public Void call() {\n return null;\n }\n };\n- Callable<Void> setFutureCompleteSucessFullyRunnable =\n+ Callable<Void> setFutureCompleteSuccessfullyRunnable =\n new Callable<Void>() {\n ListenableFuture<String> future = Futures.immediateFuture(\"setFuture\");\n \n@@ -511,10 +511,10 @@ public void run() {\n }\n };\n List<Callable<?>> allTasks = new ArrayList<>();\n- allTasks.add(completeSucessFullyRunnable);\n+ allTasks.add(completeSuccessfullyRunnable);\n allTasks.add(completeExceptionallyRunnable);\n allTasks.add(cancelRunnable);\n- allTasks.add(setFutureCompleteSucessFullyRunnable);\n+ allTasks.add(setFutureCompleteSuccessfullyRunnable);\n allTasks.add(setFutureCompleteExceptionallyRunnable);\n allTasks.add(setFutureCancelRunnable);\n for (int k = 0; k < 50; k++) {\n@@ -577,24 +577,24 @@ public void testSetFutureCancelBash() {\n final ExecutorService executor = Executors.newFixedThreadPool(barrier.getParties());\n final AtomicReference<AbstractFuture<String>> currentFuture = Atomics.newReference();\n final AtomicReference<AbstractFuture<String>> setFutureFuture = Atomics.newReference();\n- final AtomicBoolean setFutureSetSucess = new AtomicBoolean();\n- final AtomicBoolean setFutureCompletionSucess = new AtomicBoolean();\n- final AtomicBoolean cancellationSucess = new AtomicBoolean();\n+ final AtomicBoolean setFutureSetSuccess = new AtomicBoolean();\n+ final AtomicBoolean setFutureCompletionSuccess = new AtomicBoolean();\n+ final AtomicBoolean cancellationSuccess = new AtomicBoolean();\n Runnable cancelRunnable =\n new Runnable() {\n @Override\n public void run() {\n- cancellationSucess.set(currentFuture.get().cancel(true));\n+ cancellationSuccess.set(currentFuture.get().cancel(true));\n awaitUnchecked(barrier);\n }\n };\n- Runnable setFutureCompleteSucessFullyRunnable =\n+ Runnable setFutureCompleteSuccessfullyRunnable =\n new Runnable() {\n @Override\n public void run() {\n AbstractFuture<String> future = setFutureFuture.get();\n- setFutureSetSucess.set(currentFuture.get().setFuture(future));\n- setFutureCompletionSucess.set(future.set(\"hello-async-world\"));\n+ setFutureSetSuccess.set(currentFuture.get().setFuture(future));\n+ setFutureCompletionSuccess.set(future.set(\"hello-async-world\"));\n awaitUnchecked(barrier);\n }\n };\n@@ -640,7 +640,7 @@ public void run() {\n };\n List<Runnable> allTasks = new ArrayList<>();\n allTasks.add(cancelRunnable);\n- allTasks.add(setFutureCompleteSucessFullyRunnable);\n+ allTasks.add(setFutureCompleteSuccessfullyRunnable);\n for (int k = 0; k < size; k++) {\n // For each listener we add a task that submits it to the executor directly for the blocking\n // get usecase and another task that adds it as a listener to the future to exercise both\n@@ -673,27 +673,27 @@ public void run() {\n Object result = Iterables.getOnlyElement(finalResults);\n if (result == CancellationException.class) {\n assertTrue(future.isCancelled());\n- assertTrue(cancellationSucess.get());\n+ assertTrue(cancellationSuccess.get());\n // cancellation can interleave in 3 ways\n // 1. prior to setFuture\n // 2. after setFuture before set() on the future assigned\n // 3. after setFuture and set() are called but before the listener completes.\n- if (!setFutureSetSucess.get() || !setFutureCompletionSucess.get()) {\n+ if (!setFutureSetSuccess.get() || !setFutureCompletionSuccess.get()) {\n // If setFuture fails or set on the future fails then it must be because that future was\n // cancelled\n assertTrue(setFuture.isCancelled());\n assertTrue(setFuture.wasInterrupted()); // we only call cancel(true)\n }\n } else {\n // set on the future completed\n- assertFalse(cancellationSucess.get());\n- assertTrue(setFutureSetSucess.get());\n- assertTrue(setFutureCompletionSucess.get());\n+ assertFalse(cancellationSuccess.get());\n+ assertTrue(setFutureSetSuccess.get());\n+ assertTrue(setFutureCompletionSuccess.get());\n }\n // reset for next iteration\n- setFutureSetSucess.set(false);\n- setFutureCompletionSucess.set(false);\n- cancellationSucess.set(false);\n+ setFutureSetSuccess.set(false);\n+ setFutureCompletionSuccess.set(false);\n+ cancellationSuccess.set(false);\n finalResults.clear();\n }\n executor.shutdown();\n@@ -710,17 +710,17 @@ public void testSetFutureCancelBash_withDoneFuture() {\n final ExecutorService executor = Executors.newFixedThreadPool(barrier.getParties());\n final AtomicReference<AbstractFuture<String>> currentFuture = Atomics.newReference();\n final AtomicBoolean setFutureSuccess = new AtomicBoolean();\n- final AtomicBoolean cancellationSucess = new AtomicBoolean();\n+ final AtomicBoolean cancellationSuccess = new AtomicBoolean();\n Callable<Void> cancelRunnable =\n new Callable<Void>() {\n @Override\n public Void call() {\n- cancellationSucess.set(currentFuture.get().cancel(true));\n+ cancellationSuccess.set(currentFuture.get().cancel(true));\n awaitUnchecked(barrier);\n return null;\n }\n };\n- Callable<Void> setFutureCompleteSucessFullyRunnable =\n+ Callable<Void> setFutureCompleteSuccessfullyRunnable =\n new Callable<Void>() {\n final ListenableFuture<String> future = Futures.immediateFuture(\"hello\");\n \n@@ -750,7 +750,7 @@ public void run() {\n };\n List<Callable<?>> allTasks = new ArrayList<>();\n allTasks.add(cancelRunnable);\n- allTasks.add(setFutureCompleteSucessFullyRunnable);\n+ allTasks.add(setFutureCompleteSuccessfullyRunnable);\n allTasks.add(Executors.callable(collectResultsRunnable));\n assertEquals(allTasks.size() + 1, barrier.getParties()); // sanity check\n for (int i = 0; i < 1000; i++) {\n@@ -768,15 +768,15 @@ public void run() {\n Object result = Iterables.getOnlyElement(finalResults);\n if (result == CancellationException.class) {\n assertTrue(future.isCancelled());\n- assertTrue(cancellationSucess.get());\n+ assertTrue(cancellationSuccess.get());\n assertFalse(setFutureSuccess.get());\n } else {\n assertTrue(setFutureSuccess.get());\n- assertFalse(cancellationSucess.get());\n+ assertFalse(cancellationSuccess.get());\n }\n // reset for next iteration\n setFutureSuccess.set(false);\n- cancellationSucess.set(false);\n+ cancellationSuccess.set(false);\n finalResults.clear();\n }\n executor.shutdown();",
"filename": "guava-tests/test/com/google/common/util/concurrent/AbstractFutureTest.java",
"status": "modified"
},
{
"diff": "@@ -141,7 +141,7 @@ private ArrayTable(Iterable<? extends R> rowKeys, Iterable<? extends C> columnKe\n * TODO(jlevy): Support only one of rowKey / columnKey being empty? If we\n * do, when columnKeys is empty but rowKeys isn't, rowKeyList() can contain\n * elements but rowKeySet() will be empty and containsRow() won't\n- * acknolwedge them.\n+ * acknowledge them.\n */\n rowKeyToIndex = Maps.indexMap(rowList);\n columnKeyToIndex = Maps.indexMap(columnList);",
"filename": "guava/src/com/google/common/collect/ArrayTable.java",
"status": "modified"
},
{
"diff": "@@ -577,6 +577,22 @@ public Range<C> intersection(Range<C> connectedRange) {\n * @since 27.0\n */\n public Range<C> gap(Range<C> otherRange) {\n+ /*\n+ * For an explanation of the basic principle behind this check, see\n+ * https://stackoverflow.com/a/35754308/28465\n+ *\n+ * In that explanation's notation, our `overlap` check would be `x1 < y2 && y1 < x2`. We've\n+ * flipped one part of the check so that we're using \"less than\" in both cases (rather than a\n+ * mix of \"less than\" and \"greater than\"). We've also switched to \"strictly less than\" rather\n+ * than \"less than or equal to\" because of *handwave* the difference between \"endpoints of\n+ * inclusive ranges\" and \"Cuts.\"\n+ */\n+ if (lowerBound.compareTo(otherRange.upperBound) < 0\n+ && otherRange.lowerBound.compareTo(upperBound) < 0) {\n+ throw new IllegalArgumentException(\n+ \"Ranges have a nonempty intersection: \" + this + \", \" + otherRange);\n+ }\n+\n boolean isThisFirst = this.lowerBound.compareTo(otherRange.lowerBound) < 0;\n Range<C> firstRange = isThisFirst ? this : otherRange;\n Range<C> secondRange = isThisFirst ? otherRange : this;",
"filename": "guava/src/com/google/common/collect/Range.java",
"status": "modified"
},
{
"diff": "@@ -1052,12 +1052,12 @@ public Appendable append(@Nullable CharSequence chars) throws IOException {\n @GwtIncompatible // Writer\n static Writer separatingWriter(\n final Writer delegate, final String separator, final int afterEveryChars) {\n- final Appendable seperatingAppendable =\n+ final Appendable separatingAppendable =\n separatingAppendable(delegate, separator, afterEveryChars);\n return new Writer() {\n @Override\n public void write(int c) throws IOException {\n- seperatingAppendable.append((char) c);\n+ separatingAppendable.append((char) c);\n }\n \n @Override",
"filename": "guava/src/com/google/common/io/BaseEncoding.java",
"status": "modified"
},
{
"diff": "@@ -167,7 +167,7 @@ public static long copy(ReadableByteChannel from, WritableByteChannel to) throws\n */\n private static byte[] toByteArrayInternal(InputStream in, Queue<byte[]> bufs, int totalLen)\n throws IOException {\n- // Starting with an 8k buffer, double the size of each sucessive buffer. Buffers are retained\n+ // Starting with an 8k buffer, double the size of each successive buffer. Buffers are retained\n // in a deque so that there's no copying between buffers while reading and so all of the bytes\n // in each new allocated buffer are available for reading from the stream.\n for (int bufSize = BUFFER_SIZE;",
"filename": "guava/src/com/google/common/io/ByteStreams.java",
"status": "modified"
},
{
"diff": "@@ -45,6 +45,7 @@\n import com.google.common.util.concurrent.ClosingFuture.Combiner.CombiningCallable;\n import com.google.common.util.concurrent.Futures.FutureCombiner;\n import com.google.errorprone.annotations.CanIgnoreReturnValue;\n+import com.google.errorprone.annotations.DoNotMock;\n import com.google.j2objc.annotations.RetainedWith;\n import java.io.Closeable;\n import java.util.IdentityHashMap;\n@@ -188,6 +189,7 @@\n */\n // TODO(dpb): Consider reusing one CloseableList for the entire pipeline, modulo combinations.\n @Beta // @Beta for one release.\n+@DoNotMock(\"Use ClosingFuture.from(Futures.immediate*Future)\")\n // TODO(dpb): GWT compatibility.\n public final class ClosingFuture<V> {\n \n@@ -1144,6 +1146,9 @@ private Peeker(ImmutableList<ClosingFuture<?>> futures) {\n * .closing(executor);\n * }</pre>\n */\n+ // TODO(cpovirk): Use simple name instead of fully qualified after we stop building with JDK 8.\n+ @com.google.errorprone.annotations.DoNotMock(\n+ \"Use ClosingFuture.whenAllSucceed() or .whenAllComplete() instead.\")\n public static class Combiner {\n \n private final CloseableList closeables = new CloseableList();",
"filename": "guava/src/com/google/common/util/concurrent/ClosingFuture.java",
"status": "modified"
},
{
"diff": "",
"filename": "guava/src/com/google/thirdparty/publicsuffix/PublicSuffixPatterns.java",
"status": "modified"
}
]
} |
{
"body": "The following piece of code throws an undocumented `IllegalArgumentException`:\r\n\r\n final Set<String> products = Sets.newHashSet(\"coffee\", \"tea\");\r\n final List<Set<String>> productOf = Collections.nCopies(31, products); \r\n assert Sets.cartesianProduct(productOf).size() == Integer.MAX_VALUE;\r\n\r\nThe fact that `Sets::cartesianProduct` will throw an `IllegalArgumentException` when there would be more than 2^31-1 elements in the resulting set is not documented as far as I can see.\r\n\r\nI would like to see one of two solutions:\r\n\r\n1. Document why this Exception is thrown (there may be an implementation detail that prevents *even defining* such large sets).\r\n2. Fix it, because `java.util.Set::size()` specifies that if the size would be more than `Integer.MAX_VALUE` it would simply be `Integer.MAX_VALUE`.\r\n\r\nI like to see this fixed (solution 2), because now I can't even define such a Cartesian product. Iterating over so many elements is of course a different issue, but I have a piece of code that may very quickly find an `element` in the product, because I know it is in there and due to some ordering on `element`.\r\n",
"comments": [
{
"body": "@Meijuh @kluever I think we should fix this(solution 2). I will have a look at it.",
"created_at": "2020-04-14T14:18:06Z"
}
],
"number": 3742,
"title": "Sets.cartesianProduct gives undocumented IllegalArgumentException due to its size"
} | {
"body": "#3742 said that they would like to be able to create a `Sets::cartesianProduct` object that would have more than 2^31-1 elements in the resulting set. Currently, it throws an `IllegalArgumentException` when this happens. @Meijuh said that since \"java.util.Set::size() specifies that if the size would be more than Integer.MAX_VALUE it would simply be Integer.MAX_VALUE\" this should be fixed.\r\nSo the code change is that instead of throwing an exception, the remaining lower parts of the axesSizeProduct integer array are set to Integer.MAX_VALUE so the size function (which returns axesSizeProduct[0]) will now return Integer.MAX_VALUE.",
"number": 3871,
"review_comments": [],
"title": "Issue #3742 Changing the axesSizeProduct entries to Integer.MAX_VALUE instead of throwing exception"
} | {
"commits": [
{
"message": "Changing the axesSizeProduct entries to Integer.MAX_VALUE instead of throwing exception"
},
{
"message": "Ran google-java-format formatting to follow code style guidlines"
},
{
"message": "Ran google-java-format on file"
},
{
"message": "Delete newFile.java"
},
{
"message": "Modify test to no longer throw IAE"
},
{
"message": ":Merge branch 'new_branch2' of https://github.com/HelenaGregg/Guava into new_branch2"
}
],
"files": [
{
"diff": "@@ -772,12 +772,9 @@ public void testCartesianProduct_unrelatedTypes() {\n \n @SuppressWarnings(\"unchecked\") // varargs!\n public void testCartesianProductTooBig() {\n+ // No longer fails with IAE\n Set<Integer> set = ContiguousSet.create(Range.closed(0, 10000), DiscreteDomain.integers());\n- try {\n- Sets.cartesianProduct(set, set, set, set, set);\n- fail(\"Expected IAE\");\n- } catch (IllegalArgumentException expected) {\n- }\n+ Sets.cartesianProduct(set, set, set, set, set);\n }\n \n @SuppressWarnings(\"unchecked\") // varargs!",
"filename": "guava-tests/test/com/google/common/collect/SetsTest.java",
"status": "modified"
},
{
"diff": "@@ -51,13 +51,16 @@ static <E> List<List<E>> create(List<? extends List<? extends E>> lists) {\n this.axes = axes;\n int[] axesSizeProduct = new int[axes.size() + 1];\n axesSizeProduct[axes.size()] = 1;\n+ int i = axes.size() - 1;\n try {\n- for (int i = axes.size() - 1; i >= 0; i--) {\n+ for (; i >= 0; i--) {\n axesSizeProduct[i] = IntMath.checkedMultiply(axesSizeProduct[i + 1], axes.get(i).size());\n }\n } catch (ArithmeticException e) {\n- throw new IllegalArgumentException(\n- \"Cartesian product too large; must have size at most Integer.MAX_VALUE\");\n+ // size which returns axesSizeProduct[0] will now return Integer.MAX_VALUE\n+ for (; i >= 0; i--) {\n+ axesSizeProduct[i] = Integer.MAX_VALUE;\n+ }\n }\n this.axesSizeProduct = axesSizeProduct;\n }",
"filename": "guava/src/com/google/common/collect/CartesianList.java",
"status": "modified"
},
{
"diff": "@@ -51,7 +51,8 @@\n *\n * @author Louis Wasserman\n */\n-@GwtCompatible final class TopKSelector<T> {\n+@GwtCompatible\n+final class TopKSelector<T> {\n \n /**\n * Returns a {@code TopKSelector} that collects the lowest {@code k} elements added to it,",
"filename": "guava/src/com/google/common/collect/TopKSelector.java",
"status": "modified"
}
]
} |
{
"body": "The following piece of code throws an undocumented `IllegalArgumentException`:\r\n\r\n final Set<String> products = Sets.newHashSet(\"coffee\", \"tea\");\r\n final List<Set<String>> productOf = Collections.nCopies(31, products); \r\n assert Sets.cartesianProduct(productOf).size() == Integer.MAX_VALUE;\r\n\r\nThe fact that `Sets::cartesianProduct` will throw an `IllegalArgumentException` when there would be more than 2^31-1 elements in the resulting set is not documented as far as I can see.\r\n\r\nI would like to see one of two solutions:\r\n\r\n1. Document why this Exception is thrown (there may be an implementation detail that prevents *even defining* such large sets).\r\n2. Fix it, because `java.util.Set::size()` specifies that if the size would be more than `Integer.MAX_VALUE` it would simply be `Integer.MAX_VALUE`.\r\n\r\nI like to see this fixed (solution 2), because now I can't even define such a Cartesian product. Iterating over so many elements is of course a different issue, but I have a piece of code that may very quickly find an `element` in the product, because I know it is in there and due to some ordering on `element`.\r\n",
"comments": [
{
"body": "@Meijuh @kluever I think we should fix this(solution 2). I will have a look at it.",
"created_at": "2020-04-14T14:18:06Z"
}
],
"number": 3742,
"title": "Sets.cartesianProduct gives undocumented IllegalArgumentException due to its size"
} | {
"body": "#3742 said that they would like to be able to create a `Sets::cartesianProduct` object that would have more than 2^31-1 elements in the resulting set. Currently, it throws an `IllegalArgumentException` when this happens. @Meijuh said that since \"java.util.Set::size() specifies that if the size would be more than Integer.MAX_VALUE it would simply be Integer.MAX_VALUE\" this should be fixed.\r\nSo the code change is that instead of throwing an exception, the remaining lower parts of the axesSizeProduct integer array are set to Integer.MAX_VALUE so the size function (which returns axesSizeProduct[0]) will now return Integer.MAX_VALUE.",
"number": 3870,
"review_comments": [],
"title": "Issue #3742 Changing the axesSizeProduct entries to Integer.MAX_VALUE instead of throwing exception"
} | {
"commits": [
{
"message": "Changing the axesSizeProduct entries to Integer.MAX_VALUE instead of throwing exception"
},
{
"message": "Ran google-java-format formatting to follow code style guidlines"
},
{
"message": "test"
}
],
"files": [
{
"diff": "@@ -51,13 +51,16 @@ static <E> List<List<E>> create(List<? extends List<? extends E>> lists) {\n this.axes = axes;\n int[] axesSizeProduct = new int[axes.size() + 1];\n axesSizeProduct[axes.size()] = 1;\n+ int i = axes.size() - 1;\n try {\n- for (int i = axes.size() - 1; i >= 0; i--) {\n+ for (; i >= 0; i--) {\n axesSizeProduct[i] = IntMath.checkedMultiply(axesSizeProduct[i + 1], axes.get(i).size());\n }\n } catch (ArithmeticException e) {\n- throw new IllegalArgumentException(\n- \"Cartesian product too large; must have size at most Integer.MAX_VALUE\");\n+ // size which returns axesSizeProduct[0] will now return Integer.MAX_VALUE\n+ for (; i >= 0; i--) {\n+ axesSizeProduct[i] = Integer.MAX_VALUE;\n+ } // test\n }\n this.axesSizeProduct = axesSizeProduct;\n }",
"filename": "guava/src/com/google/common/collect/CartesianList.java",
"status": "modified"
}
]
} |
{
"body": "`getDeclaredMethods()` requires \"accessDeclaredMembers\" runtime permission that may not be granted to the library. As `@Subscribe` methods are expected to be public, it is possible to fallback to `getMethods()` when `getDeclaredMethods()` causes `SecurityException`.",
"comments": [
{
"body": "`getMethods()` is also subject to security management, no?",
"created_at": "2020-04-21T19:20:02Z"
},
{
"body": "It is still subject to security management but with fewer restrictions (does not require \"accessDeclaredMembers\" permission).",
"created_at": "2020-04-22T18:29:03Z"
}
],
"number": 3859,
"title": "Fallback to getMethods() if getDeclaredMethods() causes SecurityException in SubscriberRegister"
} | {
"body": "fixes #3858 and #3859 ",
"number": 3860,
"review_comments": [
{
"body": "using `getMethods` will call anothor bug I think.\r\n`getMehods` will get all the methods from subclass, include its superclass. so when code like that:\r\n```\r\nclass ListenerA {\r\n @Subscribe void listenA(Event event) {}\r\n} \r\n\r\nclass ListenerB extends ListenerA {\r\n @Subscribe void listenB(Event event) {}\r\n}\r\n```\r\n\r\nif we use `ListenerB.class.getMethods`，we will get `ListenerA.listenA` as well. it will be a bug, in this code, we will get 2 method obj of `ListenersA.listenA`, one froms ListenerA it self, another froms ListenerB",
"created_at": "2020-04-13T07:58:53Z"
},
{
"body": "Please explain why that will be a bug?",
"created_at": "2020-04-13T14:25:11Z"
},
{
"body": "sorry, I ignored the `MethodIdentifier filter` you writed at last, I had make a test for my comment! : )\r\n```\r\nidentifiers = HashSet();\r\n.filter(method -> identifiers.add(new MethodIdentifier(method)))\r\n```\r\nand here is my test code.\r\n```java\r\n public void testSuperAnsSubSubscribe() {\r\n SubClass subClass = new SubClass();\r\n registry.register(subClass);\r\n assertEquals(2, Iterators.size(registry.getSubscribers(Integer.valueOf(1))));\r\n }\r\n\r\n private static class SuperClass {\r\n @Subscribe\r\n public void superHandle(Integer i) {}\r\n }\r\n\r\n private static class SubClass extends SuperClass {\r\n @Subscribe\r\n public void subHandle(Integer i) {}\r\n }\r\n```",
"created_at": "2020-04-14T00:09:55Z"
}
],
"title": "Filter out java.lang.Object from checked types and fallback to getMethods() if getDeclaredMethods() causes SecurityException."
} | {
"commits": [
{
"message": "Filter out java.lang.Object from checked types and fallback to getMethods() if getDeclaredMethods() causes SecurityException."
},
{
"message": "code review"
}
],
"files": [
{
"diff": "@@ -37,9 +37,9 @@\n import java.lang.reflect.Method;\n import java.util.Arrays;\n import java.util.Collection;\n+import java.util.HashSet;\n import java.util.Iterator;\n import java.util.List;\n-import java.util.Map;\n import java.util.Map.Entry;\n import java.util.Set;\n import java.util.concurrent.ConcurrentMap;\n@@ -175,27 +175,34 @@ private static ImmutableList<Method> getAnnotatedMethods(Class<?> clazz) {\n \n private static ImmutableList<Method> getAnnotatedMethodsNotCached(Class<?> clazz) {\n Set<? extends Class<?>> supertypes = TypeToken.of(clazz).getTypes().rawTypes();\n- Map<MethodIdentifier, Method> identifiers = Maps.newHashMap();\n- for (Class<?> supertype : supertypes) {\n- for (Method method : supertype.getDeclaredMethods()) {\n- if (method.isAnnotationPresent(Subscribe.class) && !method.isSynthetic()) {\n- // TODO(cgdecker): Should check for a generic parameter type and error out\n- Class<?>[] parameterTypes = method.getParameterTypes();\n- checkArgument(\n- parameterTypes.length == 1,\n- \"Method %s has @Subscribe annotation but has %s parameters.\"\n- + \"Subscriber methods must have exactly 1 parameter.\",\n- method,\n- parameterTypes.length);\n-\n- MethodIdentifier ident = new MethodIdentifier(method);\n- if (!identifiers.containsKey(ident)) {\n- identifiers.put(ident, method);\n+ Set<MethodIdentifier> identifiers = new HashSet<>();\n+ return supertypes\n+ .stream()\n+ .filter(cls -> !Objects.equal(cls, Object.class))\n+ .flatMap(supertype -> {\n+ Method[] methods;\n+ try {\n+ methods = supertype.getDeclaredMethods();\n+ } catch (SecurityException e) {\n+ methods = supertype.getMethods();\n+ }\n+ return Arrays.stream(methods)\n+ .filter(method -> method.isAnnotationPresent(Subscribe.class))\n+ .filter(method -> !method.isSynthetic())\n+ .peek(method -> {\n+ Class<?>[] parameterTypes = method.getParameterTypes();\n+ checkArgument(\n+ parameterTypes.length == 1,\n+ \"Method %s has @Subscribe annotation but has %s parameters.\"\n+ + \"Subscriber methods must have exactly 1 parameter.\",\n+ method,\n+ parameterTypes.length);\n }\n+ );\n }\n- }\n- }\n- return ImmutableList.copyOf(identifiers.values());\n+ )\n+ .filter(method -> identifiers.add(new MethodIdentifier(method)))\n+ .collect(ImmutableList.toImmutableList());\n }\n \n /** Global cache of classes to their flattened hierarchy of supertypes. */",
"filename": "guava/src/com/google/common/eventbus/SubscriberRegistry.java",
"status": "modified"
}
]
} |
{
"body": "Hi, following is in Kotlin, I hope you don't mind.\r\n\r\n**My Service**\r\n```kotlin\r\nclass TestService : AbstractExecutionThreadService() {\r\n\r\n // ~ Properties -------------------------------------------------------------------------------\r\n \r\n private val L = logger() /* slf4j logger */\r\n val inputQueue = SynchronousQueue<String>()\r\n\r\n // ~ Initializers -----------------------------------------------------------------------------\r\n \r\n init {\r\n addListener(\r\n object : Service.Listener() {\r\n override fun starting() {\r\n L.info(\"starting\")\r\n }\r\n\r\n override fun running() {\r\n L.info(\"running\")\r\n }\r\n\r\n override fun failed(from: Service.State, failure: Throwable) {\r\n L.info(\"failed: ${failure}\")\r\n }\r\n\r\n override fun stopping(from: Service.State) {\r\n L.info(\"stopping\")\r\n }\r\n\r\n override fun terminated(from: Service.State) {\r\n L.info(\"terminated\")\r\n }\r\n },\r\n Executors.newSingleThreadExecutor()\r\n )\r\n }\r\n\r\n // ~ Methods ----------------------------------------------------------------------------------\r\n\r\n override fun run() {\r\n while (true) {\r\n val event = inputQueue.take()\r\n if (event == \"CRASH\") {\r\n throw IllegalStateException()\r\n \r\n } else if (event == \"SHUTDOWN\") {\r\n break\r\n }\r\n }\r\n }\r\n\r\n override fun triggerShutdown() {\r\n while (state() == Service.State.STOPPING) {\r\n if (inputQueue.offer(\"SHUTDOWN\", 500, TimeUnit.MILLISECONDS)) {\r\n break\r\n }\r\n }\r\n }\r\n}\r\n```\r\n\r\n**My Tests**\r\n```\r\nclass GuavaStateExceptionTest {\r\n\r\n @Test\r\n fun startAndShutdown() {\r\n val app = TestService()\r\n\r\n val sm = ServiceManager(listOf(app))\r\n sm.startAsync().awaitHealthy()\r\n sm.stopAsync().awaitStopped()\r\n }\r\n\r\n @Test\r\n fun startAndShutdown() {\r\n val app = TestService()\r\n\r\n val sm = ServiceManager(listOf(app))\r\n sm.startAsync().awaitHealthy()\r\n app.inputQueue.put(\"CRASH\")\r\n sm.stopAsync().awaitStopped()\r\n }\r\n```\r\n\r\n**Problems** \r\nThe first test, starting and stopping works fine and gives the following output:\r\n```\r\n[pool-1-thread-1] a.f.m.TestService* INFO starting\r\n[main] a.f.m.TestService* INFO triggerShutdown\r\n[pool-1-thread-1] a.f.m.TestService* INFO running\r\n[main] a.f.m.TestService* INFO offer\r\n[pool-1-thread-1] a.f.m.TestService* INFO stopping\r\n[pool-1-thread-1] a.f.m.TestService* INFO terminated\r\n```\r\n\r\nThe second test, where I post an event that is supposed to crash the run-loop sometimes works with this output:\r\n```\r\n[pool-1-thread-1] a.f.m.TestService* INFO starting\r\n[pool-1-thread-1] a.f.m.TestService* INFO running\r\n[pool-1-thread-1] a.f.m.TestService* INFO failed: java.lang.IllegalStateException\r\n```\r\n\r\n And sometimes the `triggerShutdown` method hangs, because it posts to `inputQueue` and nobody `takes` from there:\r\n```\r\n[pool-1-thread-1] a.f.m.TestService* INFO starting\r\n[pool-1-thread-1] a.f.m.TestService* INFO running\r\n[main] a.f.m.TestService* INFO triggerShutdown\r\n[main] a.f.m.TestService* INFO offer\r\n[main] a.f.m.TestService* INFO offer\r\n[main] a.f.m.TestService* INFO ...\r\n```\r\n\r\nWhy is the logging listener not called all the time? Sometimes the stopping event is logged, sometimes it's not there. When `main` hangs in `triggerShutdown`, the `Failure` event is never logged.\r\n\r\n```\r\n[pool-1-thread-1] a.f.m.TestService* INFO starting\r\n[main] a.f.m.TestService* INFO triggerShutdown\r\n[pool-1-thread-1] a.f.m.TestService* INFO running\r\n[main] a.f.m.TestService* INFO offer\r\n[pool-1-thread-1] a.f.m.TestService* INFO stopping\r\n[main] a.f.m.TestService* INFO offer\r\n[main] a.f.m.TestService* INFO offer\r\n[main] a.f.m.TestService* INFO offer\r\n[main] a.f.m.TestService* INFO offer\r\n```\r\n\r\nIs there another way in my scenario to access `state()` in `triggerShutdown` to see whether the service has exited while we tried to shut it down?",
"comments": [
{
"body": "Interesting report, thanks. I think the short answer is that we call `triggerShutdown` under a lock, and we call `notifyFailed` under that same lock. So, if the `run` throws but `triggerShutdown` starts before the state changes to `FAILED`, the thread that's running `run` will never get the lock and thus _never_ change the state.\r\n\r\nAs for what to do about it... hmm. I don't think I've seen `AbstractExecutionThreadService` used with `SynchronousQueue` before. In principle, this is the kind of situation in which thread interruption could help, but we don't currently expose that, and given that we don't necessarily _really_ own the threads from the `Executor`, we technically probably shouldn't interrupt them, anyway.\r\n\r\nIt's presumably possible to build something directly atop `AbstractService`, using `AbstractExecutionThreadService` as a starting point, but that's naturally not very appealing.\r\n\r\nMaybe your `triggerShutdown` method could set a `volatile boolean` in addition to adding to the queue, and the `run` method could consult that, too? That way, `triggerShutdown` could ensure that its notification would be delivered, even if `run` isn't ready to receive it at that moment and `triggerShutdown` doesn't want to wait around. The `SHUTDOWN` poison pill would still be important for cases cases in which the `run` method has nothing to do and is thus blocked in `take`. But the `boolean` could handle the simple cases in which it's already doing work. But I would want to think harder about this.\r\n\r\nMaybe @lukesandberg has ideas.",
"created_at": "2017-10-11T16:35:34Z"
},
{
"body": "Wbat I'm doing now is `while(isRunning())` instead of `true` and just `offer` the shutdown message once, without any waiting. If `run()` is blocked, it take the message and abort, if it is busy it will check `isRunning()` on the next loop-iteration. ",
"created_at": "2017-10-11T16:59:09Z"
},
{
"body": "Ah, yes, that's nicer than a separate variable.",
"created_at": "2017-10-11T17:01:14Z"
},
{
"body": "Thanks. In any case I would add to the description of `triggerShutdown` that it should be fast and that it's not supposed to block, similarly do how `doStart()` is described in the docs.\r\nI believe that every blocking action there could be replaced with some smarter construct.",
"created_at": "2017-10-12T06:33:48Z"
},
{
"body": "Thinking about this more, I'm a little worried that there will still be a race.\r\n\r\n override fun run() {\r\n while (isRunning()) {\r\n val event = inputQueue.take()\r\n\r\nIf the shutdown request happens between the two first lines of the method, does the thread hang in `take`? In practice, it might not hang forever, since some other thread may insert something into the queue.\r\n\r\nStill, we might have solved the exception race but introduced a new one. Maybe a better fix is for the runner thread to set some kind of flag if it exits with an exception? Then `triggerShutdown` can consult that in its `offer` loop.",
"created_at": "2017-10-12T16:42:08Z"
},
{
"body": "(In any case, I will update the docs.)",
"created_at": "2017-10-12T16:42:14Z"
},
{
"body": "Ah, good find. If you happen to find a solution to the issue above, please tell.\r\n\r\nA `ClosableQueue` would be a nice addition to guava.",
"created_at": "2017-10-18T06:12:53Z"
},
{
"body": "Any news on this?",
"created_at": "2017-11-06T21:24:38Z"
},
{
"body": "I'm not sure there's much we'll be able to do other than warn about `triggerShutdown` in its docs, possibly recommending that `shutDown` set a flag for `triggerShutdown` implementations to read. I suppose that `AbstractExecutionThreadService` could do something like that automatically, but I haven't seen anyone recreating that in our internal implementations, so I'd worry that it would be more confusing than helpful to most people.",
"created_at": "2017-11-06T21:38:32Z"
},
{
"body": "Ok, my usage of this construct is UI-input, I have a single-threaded controller that dispatches all actions, but I want events that arrive too fast when the controller is busy to be simply discarded instead of queuing up in.\r\n\r\nSo the events are just offered for 50ms or so to the SynchronousQueue.",
"created_at": "2017-12-30T06:21:24Z"
},
{
"body": "We much belatedly got to talking about this again as part of #3418. You might have some luck moving the code from `triggerShutdown` into the `stopping` method of your listener. That should make it happen outside the lock, after which things might work?\r\n\r\nWe're still not sure if we'll find a great way to make it easier than that.",
"created_at": "2020-03-25T19:06:55Z"
}
],
"number": 2966,
"title": "RaceCondition with AbstractExecutionThreadService?"
} | {
"body": "This code has been reviewed and submitted internally. Feel free to discuss on\nthe PR, and we can submit follow-up changes as necessary.\n\nCommits:\n=====\n<p> Remove `@Beta` from `Service` and `ServiceManager`.\n\nThis leaves `AbstractListeningExecutorService` as `@Beta`.\n\nFixes #3806, #3418\nRelevant to #2966\n\n(I have tweaked Jesse's initial PR to leave `AbstractExecutionThreadService.triggerShutdown` and `AbstractService.doCancelStart` as `@Beta`, since we aren't sure we like the locking behavior of the former, and we've realized that `Listener.stopping` _might_ be a reasonable substitute for both.)\n\nRELNOTES=`util.concurrent`: Removed `@Beta` from `Service` and related classes.\n\n33574d771b099991822ed78a726df0eea4646eea",
"number": 3856,
"review_comments": [],
"title": "MOE Sync 2020-04-10"
} | {
"commits": [
{
"message": "Remove `@Beta` from `Service` and `ServiceManager`.\n\nThis leaves `AbstractListeningExecutorService` as `@Beta`.\n\nFixes #3806, #3418\nRelevant to #2966\n\n(I have tweaked Jesse's initial PR to leave `AbstractExecutionThreadService.triggerShutdown` and `AbstractService.doCancelStart` as `@Beta`, since we aren't sure we like the locking behavior of the former, and we've realized that `Listener.stopping` _might_ be a reasonable substitute for both.)\n\nRELNOTES=`util.concurrent`: Removed `@Beta` from `Service` and related classes.\n\n-------------\nCreated by MOE: https://github.com/google/moe\nMOE_MIGRATED_REVID=305878924"
}
],
"files": [
{
"diff": "@@ -32,7 +32,6 @@\n * @author Jesse Wilson\n * @since 1.0\n */\n-@Beta\n @GwtIncompatible\n public abstract class AbstractExecutionThreadService implements Service {\n private static final Logger logger =\n@@ -140,7 +139,14 @@ protected void shutDown() throws Exception {}\n * Invoked to request the service to stop.\n *\n * <p>By default this method does nothing.\n+ *\n+ * <p>Currently, this method is invoked while holding a lock. If an implementation of this method\n+ * blocks, it can prevent this service from changing state. If you need to performing a blocking\n+ * operation in order to trigger shutdown, consider instead registering a listener and\n+ * implementing {@code stopping}. Note, however, that {@code stopping} does not run at exactly the\n+ * same times as {@code triggerShutdown}.\n */\n+ @Beta\n protected void triggerShutdown() {}\n \n /**",
"filename": "android/guava/src/com/google/common/util/concurrent/AbstractExecutionThreadService.java",
"status": "modified"
},
{
"diff": "@@ -14,7 +14,6 @@\n \n package com.google.common.util.concurrent;\n \n-import com.google.common.annotations.Beta;\n import com.google.common.annotations.GwtIncompatible;\n import com.google.common.base.Supplier;\n import com.google.errorprone.annotations.CanIgnoreReturnValue;\n@@ -31,7 +30,6 @@\n * @author Chris Nokleberg\n * @since 1.0\n */\n-@Beta\n @GwtIncompatible\n public abstract class AbstractIdleService implements Service {\n ",
"filename": "android/guava/src/com/google/common/util/concurrent/AbstractIdleService.java",
"status": "modified"
},
{
"diff": "@@ -18,7 +18,6 @@\n import static com.google.common.base.Preconditions.checkNotNull;\n import static com.google.common.util.concurrent.MoreExecutors.directExecutor;\n \n-import com.google.common.annotations.Beta;\n import com.google.common.annotations.GwtIncompatible;\n import com.google.common.base.Supplier;\n import com.google.errorprone.annotations.CanIgnoreReturnValue;\n@@ -94,7 +93,6 @@\n * @author Luke Sandberg\n * @since 11.0\n */\n-@Beta\n @GwtIncompatible\n public abstract class AbstractScheduledService implements Service {\n private static final Logger logger = Logger.getLogger(AbstractScheduledService.class.getName());\n@@ -440,7 +438,6 @@ public final void awaitTerminated(long timeout, TimeUnit unit) throws TimeoutExc\n * @author Luke Sandberg\n * @since 11.0\n */\n- @Beta\n public abstract static class CustomScheduler extends Scheduler {\n \n /** A callable class that can reschedule itself using a {@link CustomScheduler}. */\n@@ -567,7 +564,6 @@ final Future<?> schedule(\n * @author Luke Sandberg\n * @since 11.0\n */\n- @Beta\n protected static final class Schedule {\n \n private final long delay;",
"filename": "android/guava/src/com/google/common/util/concurrent/AbstractScheduledService.java",
"status": "modified"
},
{
"diff": "@@ -47,7 +47,6 @@\n * @author Luke Sandberg\n * @since 1.0\n */\n-@Beta\n @GwtIncompatible\n public abstract class AbstractService implements Service {\n private static final ListenerCallQueue.Event<Listener> STARTING_EVENT =\n@@ -235,6 +234,7 @@ protected AbstractService() {}\n *\n * @since 27.0\n */\n+ @Beta\n @ForOverride\n protected void doCancelStart() {}\n ",
"filename": "android/guava/src/com/google/common/util/concurrent/AbstractService.java",
"status": "modified"
},
{
"diff": "@@ -14,10 +14,9 @@\n \n package com.google.common.util.concurrent;\n \n-import com.google.common.annotations.Beta;\n-import com.google.errorprone.annotations.DoNotMock;\n import com.google.common.annotations.GwtIncompatible;\n import com.google.errorprone.annotations.CanIgnoreReturnValue;\n+import com.google.errorprone.annotations.DoNotMock;\n import java.util.concurrent.Executor;\n import java.util.concurrent.TimeUnit;\n import java.util.concurrent.TimeoutException;\n@@ -52,7 +51,6 @@\n * @author Luke Sandberg\n * @since 9.0 (in 1.0 as {@code com.google.common.base.Service})\n */\n-@Beta\n @DoNotMock(\"Create an AbstractIdleService\")\n @GwtIncompatible\n public interface Service {\n@@ -175,7 +173,6 @@ public interface Service {\n *\n * @since 9.0 (in 1.0 as {@code com.google.common.base.Service.State})\n */\n- @Beta // should come out of Beta when Service does\n enum State {\n /** A service in this state is inactive. It does minimal work and consumes minimal resources. */\n NEW {\n@@ -243,7 +240,6 @@ boolean isTerminal() {\n * @author Luke Sandberg\n * @since 15.0 (present as an interface in 13.0)\n */\n- @Beta // should come out of Beta when Service does\n abstract class Listener {\n /**\n * Called when the service transitions from {@linkplain State#NEW NEW} to {@linkplain",
"filename": "android/guava/src/com/google/common/util/concurrent/Service.java",
"status": "modified"
},
{
"diff": "@@ -118,7 +118,6 @@\n * @author Luke Sandberg\n * @since 14.0\n */\n-@Beta\n @GwtIncompatible\n public final class ServiceManager implements ServiceManagerBridge {\n private static final Logger logger = Logger.getLogger(ServiceManager.class.getName());\n@@ -156,7 +155,6 @@ public String toString() {\n * @author Luke Sandberg\n * @since 15.0 (present as an interface in 14.0)\n */\n- @Beta // Should come out of Beta when ServiceManager does\n public abstract static class Listener {\n /**\n * Called when the service initially becomes healthy.\n@@ -275,7 +273,7 @@ public void addListener(Listener listener, Executor executor) {\n * {@link ListenableFuture#addListener ListenableFuture.addListener}. This method is scheduled\n * for deletion in October 2020.\n */\n- @Beta // currently redundant, but ensures we keep this @Beta when we gradate the class!\n+ @Beta\n @Deprecated\n public void addListener(Listener listener) {\n state.addListener(listener, directExecutor());",
"filename": "android/guava/src/com/google/common/util/concurrent/ServiceManager.java",
"status": "modified"
},
{
"diff": "@@ -33,7 +33,6 @@\n * @author Jesse Wilson\n * @since 1.0\n */\n-@Beta\n @GwtIncompatible\n public abstract class AbstractExecutionThreadService implements Service {\n private static final Logger logger =\n@@ -141,7 +140,14 @@ protected void shutDown() throws Exception {}\n * Invoked to request the service to stop.\n *\n * <p>By default this method does nothing.\n+ *\n+ * <p>Currently, this method is invoked while holding a lock. If an implementation of this method\n+ * blocks, it can prevent this service from changing state. If you need to performing a blocking\n+ * operation in order to trigger shutdown, consider instead registering a listener and\n+ * implementing {@code stopping}. Note, however, that {@code stopping} does not run at exactly the\n+ * same times as {@code triggerShutdown}.\n */\n+ @Beta\n protected void triggerShutdown() {}\n \n /**",
"filename": "guava/src/com/google/common/util/concurrent/AbstractExecutionThreadService.java",
"status": "modified"
},
{
"diff": "@@ -14,7 +14,6 @@\n \n package com.google.common.util.concurrent;\n \n-import com.google.common.annotations.Beta;\n import com.google.common.annotations.GwtIncompatible;\n import com.google.common.base.Supplier;\n import com.google.errorprone.annotations.CanIgnoreReturnValue;\n@@ -32,7 +31,6 @@\n * @author Chris Nokleberg\n * @since 1.0\n */\n-@Beta\n @GwtIncompatible\n public abstract class AbstractIdleService implements Service {\n ",
"filename": "guava/src/com/google/common/util/concurrent/AbstractIdleService.java",
"status": "modified"
},
{
"diff": "@@ -19,7 +19,6 @@\n import static com.google.common.util.concurrent.Internal.toNanosSaturated;\n import static com.google.common.util.concurrent.MoreExecutors.directExecutor;\n \n-import com.google.common.annotations.Beta;\n import com.google.common.annotations.GwtIncompatible;\n import com.google.common.base.Supplier;\n import com.google.errorprone.annotations.CanIgnoreReturnValue;\n@@ -96,7 +95,6 @@\n * @author Luke Sandberg\n * @since 11.0\n */\n-@Beta\n @GwtIncompatible\n public abstract class AbstractScheduledService implements Service {\n private static final Logger logger = Logger.getLogger(AbstractScheduledService.class.getName());\n@@ -481,7 +479,6 @@ public final void awaitTerminated(long timeout, TimeUnit unit) throws TimeoutExc\n * @author Luke Sandberg\n * @since 11.0\n */\n- @Beta\n public abstract static class CustomScheduler extends Scheduler {\n \n /** A callable class that can reschedule itself using a {@link CustomScheduler}. */\n@@ -607,7 +604,6 @@ final Future<?> schedule(\n * @author Luke Sandberg\n * @since 11.0\n */\n- @Beta\n protected static final class Schedule {\n \n private final long delay;",
"filename": "guava/src/com/google/common/util/concurrent/AbstractScheduledService.java",
"status": "modified"
},
{
"diff": "@@ -48,7 +48,6 @@\n * @author Luke Sandberg\n * @since 1.0\n */\n-@Beta\n @GwtIncompatible\n public abstract class AbstractService implements Service {\n private static final ListenerCallQueue.Event<Listener> STARTING_EVENT =\n@@ -236,6 +235,7 @@ protected AbstractService() {}\n *\n * @since 27.0\n */\n+ @Beta\n @ForOverride\n protected void doCancelStart() {}\n ",
"filename": "guava/src/com/google/common/util/concurrent/AbstractService.java",
"status": "modified"
},
{
"diff": "@@ -16,10 +16,9 @@\n \n import static com.google.common.util.concurrent.Internal.toNanosSaturated;\n \n-import com.google.common.annotations.Beta;\n-import com.google.errorprone.annotations.DoNotMock;\n import com.google.common.annotations.GwtIncompatible;\n import com.google.errorprone.annotations.CanIgnoreReturnValue;\n+import com.google.errorprone.annotations.DoNotMock;\n import java.time.Duration;\n import java.util.concurrent.Executor;\n import java.util.concurrent.TimeUnit;\n@@ -55,7 +54,6 @@\n * @author Luke Sandberg\n * @since 9.0 (in 1.0 as {@code com.google.common.base.Service})\n */\n-@Beta\n @DoNotMock(\"Create an AbstractIdleService\")\n @GwtIncompatible\n public interface Service {\n@@ -206,7 +204,6 @@ default void awaitTerminated(Duration timeout) throws TimeoutException {\n *\n * @since 9.0 (in 1.0 as {@code com.google.common.base.Service.State})\n */\n- @Beta // should come out of Beta when Service does\n enum State {\n /** A service in this state is inactive. It does minimal work and consumes minimal resources. */\n NEW {\n@@ -274,7 +271,6 @@ boolean isTerminal() {\n * @author Luke Sandberg\n * @since 15.0 (present as an interface in 13.0)\n */\n- @Beta // should come out of Beta when Service does\n abstract class Listener {\n /**\n * Called when the service transitions from {@linkplain State#NEW NEW} to {@linkplain",
"filename": "guava/src/com/google/common/util/concurrent/Service.java",
"status": "modified"
},
{
"diff": "@@ -120,7 +120,6 @@\n * @author Luke Sandberg\n * @since 14.0\n */\n-@Beta\n @GwtIncompatible\n public final class ServiceManager implements ServiceManagerBridge {\n private static final Logger logger = Logger.getLogger(ServiceManager.class.getName());\n@@ -158,7 +157,6 @@ public String toString() {\n * @author Luke Sandberg\n * @since 15.0 (present as an interface in 14.0)\n */\n- @Beta // Should come out of Beta when ServiceManager does\n public abstract static class Listener {\n /**\n * Called when the service initially becomes healthy.\n@@ -277,7 +275,7 @@ public void addListener(Listener listener, Executor executor) {\n * {@link ListenableFuture#addListener ListenableFuture.addListener}. This method is scheduled\n * for deletion in October 2020.\n */\n- @Beta // currently redundant, but ensures we keep this @Beta when we gradate the class!\n+ @Beta\n @Deprecated\n public void addListener(Listener listener) {\n state.addListener(listener, directExecutor());",
"filename": "guava/src/com/google/common/util/concurrent/ServiceManager.java",
"status": "modified"
}
]
} |
{
"body": "Currently, trying to slice a `ByteSource` twice throws an unexpected `IllegalArgumentException` if the `ByteSource` returned after the first slice has a length smaller than the offset of the subsequent slice. For example, this code throws an `IllegalArgumentException`:\r\n\r\n```\r\nimport com.google.common.io.ByteSource;\r\n\r\npublic class GuavaTest {\r\n public static void main(String[] args) {\r\n ByteSource.concat().slice(0, 3).slice(4, 3);\r\n }\r\n}\r\n```\r\n\r\nThat is against the documentation, where it is specified that it should return an empty `ByteSource`.",
"comments": [
{
"body": "@cpovirk Should this issue be closed? It looks like it was fixed in #3830.",
"created_at": "2020-10-13T00:01:08Z"
}
],
"number": 3501,
"title": "Slicing a ByteSource twice throws an unexpected IllegalArgumentException"
} | {
"body": "Fixes #3501\r\n\r\nadd maxLength < 0 to check whether the offset is greater than the source size. If so, return an empty source according to the API description.",
"number": 3826,
"review_comments": [],
"title": "Fixed double slicing ByteSource #3501"
} | {
"commits": [
{
"message": "Fixed double slicing ByteSource #3501"
},
{
"message": "Fixed NoSuchElementException when using Lists.partition and remove #3790"
}
],
"files": [
{
"diff": "@@ -664,12 +664,15 @@ public static <T> List<List<T>> partition(List<T> list, int size) {\n private static class Partition<T> extends AbstractList<List<T>> {\n final List<T> list;\n final int size;\n+ final int listSize;\n \n Partition(List<T> list, int size) {\n this.list = list;\n+ this.listSize = IntMath.divide(list.size(), size, RoundingMode.CEILING);\n this.size = size;\n }\n \n+\n @Override\n public List<T> get(int index) {\n checkElementIndex(index, size());\n@@ -680,7 +683,7 @@ public List<T> get(int index) {\n \n @Override\n public int size() {\n- return IntMath.divide(list.size(), size, RoundingMode.CEILING);\n+ return this.listSize;\n }\n \n @Override",
"filename": "guava/src/com/google/common/collect/Lists.java",
"status": "modified"
},
{
"diff": "@@ -530,7 +530,7 @@ public ByteSource slice(long offset, long length) {\n checkArgument(offset >= 0, \"offset (%s) may not be negative\", offset);\n checkArgument(length >= 0, \"length (%s) may not be negative\", length);\n long maxLength = this.length - offset;\n- return ByteSource.this.slice(this.offset + offset, Math.min(length, maxLength));\n+ return maxLength < 0 ? ByteSource.empty() : ByteSource.this.slice(this.offset + offset, Math.min(length, maxLength));\n }\n \n @Override",
"filename": "guava/src/com/google/common/io/ByteSource.java",
"status": "modified"
}
]
} |
{
"body": "I was bitten by the issue described in https://stackoverflow.com/a/31052486/6253347 \\[cpovirk adds (for searchability): might https://stackoverflow.com/q/55333290/28465 also be similar?\\] when trying to use Arrow Flight with Java's SecurityManager, since `AbstractFuture` tries to check a property as part of initialization and hence can't be created from an `InnocuousThread` that doesn't have any privileges. The exception looks like this:\r\n\r\n```\r\nCaused by: java.security.AccessControlException: access denied (\"java.util.PropertyPermission\" \"guava.concurrent.generate_cancellation_cause\" \"read\")\r\n\tat java.base/java.security.AccessControlContext.checkPermission(AccessControlContext.java:472)\r\n\tat java.base/java.security.AccessController.checkPermission(AccessController.java:1044)\r\n\tat java.base/java.lang.SecurityManager.checkPermission(SecurityManager.java:408)\r\n\tat java.base/java.lang.SecurityManager.checkPropertyAccess(SecurityManager.java:1152)\r\n\tat java.base/java.lang.System.getProperty(System.java:880)\r\n\tat com.google.common.util.concurrent.AbstractFuture.<clinit>(AbstractFuture.java:64)\r\n```\r\n\r\nI can try to put together a small repro if it's useful, but the TL;DR is that I'd like to wrap the call at https://github.com/google/guava/blob/master/guava/src/com/google/common/util/concurrent/AbstractFuture.java#L74 in a try/catch, since it will throw if access to system properties is not permitted by the SecurityManager.",
"comments": [
{
"body": "Thanks, that sounds great. If you'd like to put together a pull request, you're welcome to (though note that it will require [you or your company to sign the CLA](https://github.com/google/guava/blob/master/CONTRIBUTING.md#contributor-license-agreement)).",
"created_at": "2020-01-28T15:03:08Z"
},
{
"body": "Sorry, accidentally submitted early. The other thing I wanted to do was link to [a test that loads its own copy of `AbstractFuture`](https://github.com/google/guava/blob/66c2f795f2cbc90e104dde9d73ceb484b184b34b/guava-tests/test/com/google/common/util/concurrent/AbstractFutureCancellationCauseTest.java#L45). That would be the ideal test here, since it easily can run in the same VM as the rest of our tests. Alternatively, we could probably get away with a separate test class that we configure to run in a separate VM.",
"created_at": "2020-01-28T15:04:47Z"
},
{
"body": "Thanks for the pointer! Do you think it would be okay to configure `AbstractFutureCancellationCauseTest` to use `SecurityManager` by default, or should I create a separate test file? Which directory does it make sense to put the policy file in?\r\n\r\nI'm working on something more polished and looking into the CLA, but I was able to reproduce the failure by creating a hacky test like this:\r\n\r\n```\r\n public void testInnocuousThreadWithAbstractFuture() throws Exception {\r\n AtomicBoolean success = new AtomicBoolean(false);\r\n Thread thread = jdk.internal.misc.InnocuousThread.newThread(\r\n () -> {\r\n try {\r\n Future<?> future = newFutureInstance();\r\n assertTrue(future.cancel(false));\r\n assertTrue(future.isCancelled());\r\n success.set(true);\r\n } catch (Exception e) {\r\n fail(\"Unexpected exception: \" + e.toString());\r\n }\r\n });\r\n thread.start();\r\n thread.join();\r\n assertTrue(success.get());\r\n }\r\n```\r\n\r\nThe cumbersome part, though, is that you have to set up a SecurityManager profile and pass some additional command-line arguments. I made a permissive policy like this:\r\n\r\n```\r\ngrant {\r\n permission java.io.FilePermission \"/-\", \"read\";\r\n permission java.util.PropertyPermission \"*\", \"read,write\";\r\n permission java.lang.reflect.ReflectPermission \"*\";\r\n permission java.lang.RuntimePermission \"*\";\r\n};\r\n```\r\n\r\nAnd then used these command-line arguments to Java:\r\n```\r\n-Djava.security.manager -Djava.security.policy=/path/to/java.policy -Djava.security.debug=access,failure --add-opens java.base/jdk.internal.misc=ALL-UNNAMED\r\n```\r\n\r\nThe test fails since `success.set(true);` is never reached, and the test output has:\r\n\r\n```\r\naccess: access denied (\"java.util.PropertyPermission\" \"guava.concurrent.generate_cancellation_cause\" \"read\")\r\njava.lang.Exception: Stack trace\r\n\tat java.base/java.lang.Thread.dumpStack(Thread.java:1383)\r\n\tat java.base/java.security.AccessControlContext.checkPermission(AccessControlContext.java:462)\r\n\tat java.base/java.security.AccessController.checkPermission(AccessController.java:1044)\r\n\tat java.base/java.lang.SecurityManager.checkPermission(SecurityManager.java:408)\r\n\tat java.base/java.lang.SecurityManager.checkPropertyAccess(SecurityManager.java:1152)\r\n\tat java.base/java.lang.System.getProperty(System.java:880)\r\n\tat com.google.common.util.concurrent.AbstractFuture.<clinit>(AbstractFuture.java:74)\r\n\tat java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\r\n\tat java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)\r\n\tat java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)\r\n\tat java.base/java.lang.reflect.Method.invoke(Method.java:567)\r\n\tat com.google.common.util.concurrent.AbstractFutureCancellationCauseTest.newFutureInstance(AbstractFutureCancellationCauseTest.java:187)\r\n\tat com.google.common.util.concurrent.AbstractFutureCancellationCauseTest.lambda$testInnocuousThreadWithAbstractFuture$0(AbstractFutureCancellationCauseTest.java:171)\r\n\tat java.base/java.lang.Thread.run(Thread.java:835)\r\n\tat java.base/jdk.internal.misc.InnocuousThread.run(InnocuousThread.java:134)\r\n```\r\n\r\nIt should be possible to have the test use `java.util.concurrent.ForkJoinPool` rather than relying on the internal `InnocuousThread` class, but at least I was able to get a PoC working.",
"created_at": "2020-01-28T17:57:43Z"
},
{
"body": "I was thinking more along the lines of a separate test class (though using the same classloading trick). I'm hoping that we don't need a separate policy file, given our ability to implement our own `SecurityManager`, as in [this test](https://github.com/google/guava/blob/66c2f795f2cbc90e104dde9d73ceb484b184b34b/guava-tests/test/com/google/common/reflect/ClassPathTest.java#L501).",
"created_at": "2020-01-28T19:43:55Z"
},
{
"body": "Sent https://github.com/google/guava/pull/3788; comments welcome!",
"created_at": "2020-01-29T17:56:08Z"
}
],
"number": 3784,
"title": "AbstractFuture and ForkJoinPool are incompatible with SecurityManager"
} | {
"body": "This code has been reviewed and submitted internally. Feel free to discuss on\nthe PR, and we can submit follow-up changes as necessary.\n\nCommits:\n=====\n<p> Make AbstractFuture compatible with ForkJoinPool by catching exceptions from property retrieval.\n\nFixes #3788, #3784\n\nRELNOTES=Made it safe to load the `AbstractFuture` class from a `ForkJoinPool` thread under a security manager.\n\ne589b5c884a5996f7040ae38bdf02709f9e300da",
"number": 3796,
"review_comments": [],
"title": "MOE Sync 2020-02-06"
} | {
"commits": [
{
"message": "Make AbstractFuture compatible with ForkJoinPool by catching exceptions from property retrieval.\n\nFixes #3788, #3784\n\nRELNOTES=Made it safe to load the `AbstractFuture` class from a `ForkJoinPool` thread under a security manager.\n\n-------------\nCreated by MOE: https://github.com/google/moe\nMOE_MIGRATED_REVID=293696683"
}
],
"files": [
{
"diff": "@@ -69,9 +69,20 @@ public abstract class AbstractFuture<V> extends InternalFutureFailureAccess\n implements ListenableFuture<V> {\n // NOTE: Whenever both tests are cheap and functional, it's faster to use &, | instead of &&, ||\n \n- private static final boolean GENERATE_CANCELLATION_CAUSES =\n- Boolean.parseBoolean(\n- System.getProperty(\"guava.concurrent.generate_cancellation_cause\", \"false\"));\n+ private static final boolean GENERATE_CANCELLATION_CAUSES;\n+\n+ static {\n+ // System.getProperty may throw if the security policy does not permit access.\n+ boolean generateCancellationCauses;\n+ try {\n+ generateCancellationCauses =\n+ Boolean.parseBoolean(\n+ System.getProperty(\"guava.concurrent.generate_cancellation_cause\", \"false\"));\n+ } catch (SecurityException e) {\n+ generateCancellationCauses = false;\n+ }\n+ GENERATE_CANCELLATION_CAUSES = generateCancellationCauses;\n+ }\n \n /**\n * Tag interface marking trusted subclasses. This enables some optimizations. The implementation",
"filename": "android/guava/src/com/google/common/util/concurrent/AbstractFuture.java",
"status": "modified"
},
{
"diff": "@@ -0,0 +1,128 @@\n+/*\n+ * Copyright (C) 2020 The Guava Authors\n+ *\n+ * Licensed under the Apache License, Version 2.0 (the \"License\");\n+ * you may not use this file except in compliance with the License.\n+ * You may obtain a copy of the License at\n+ *\n+ * http://www.apache.org/licenses/LICENSE-2.0\n+ *\n+ * Unless required by applicable law or agreed to in writing, software\n+ * distributed under the License is distributed on an \"AS IS\" BASIS,\n+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+ * See the License for the specific language governing permissions and\n+ * limitations under the License.\n+ */\n+\n+package com.google.common.util.concurrent;\n+\n+import java.net.URLClassLoader;\n+import java.security.Permission;\n+import java.util.HashMap;\n+import java.util.Map;\n+import java.util.PropertyPermission;\n+import java.util.concurrent.CountDownLatch;\n+import java.util.concurrent.ForkJoinPool;\n+import java.util.concurrent.TimeUnit;\n+import javax.annotation.concurrent.GuardedBy;\n+import junit.framework.TestCase;\n+\n+/** Tests for {@link AbstractFuture} using an innocuous thread. */\n+\n+public class AbstractFutureInnocuousThreadTest extends TestCase {\n+ private ClassLoader oldClassLoader;\n+ private URLClassLoader classReloader;\n+ private Class<?> settableFutureClass;\n+ private SecurityManager oldSecurityManager;\n+\n+ @Override\n+ protected void setUp() throws Exception {\n+ // Load the \"normal\" copy of SettableFuture and related classes.\n+ SettableFuture<?> unused = SettableFuture.create();\n+ // Hack to load AbstractFuture et. al. in a new classloader so that it tries to re-read the\n+ // cancellation-cause system property. This allows us to test what happens if reading the\n+ // property is forbidden and then continue running tests normally in one jvm without resorting\n+ // to even crazier hacks to reset static final boolean fields.\n+ final String concurrentPackage = SettableFuture.class.getPackage().getName();\n+ classReloader =\n+ new URLClassLoader(ClassPathUtil.getClassPathUrls()) {\n+ @GuardedBy(\"loadedClasses\")\n+ final Map<String, Class<?>> loadedClasses = new HashMap<>();\n+\n+ @Override\n+ public Class<?> loadClass(String name) throws ClassNotFoundException {\n+ if (name.startsWith(concurrentPackage)\n+ // Use other classloader for ListenableFuture, so that the objects can interact\n+ && !ListenableFuture.class.getName().equals(name)) {\n+ synchronized (loadedClasses) {\n+ Class<?> toReturn = loadedClasses.get(name);\n+ if (toReturn == null) {\n+ toReturn = super.findClass(name);\n+ loadedClasses.put(name, toReturn);\n+ }\n+ return toReturn;\n+ }\n+ }\n+ return super.loadClass(name);\n+ }\n+ };\n+ oldClassLoader = Thread.currentThread().getContextClassLoader();\n+ Thread.currentThread().setContextClassLoader(classReloader);\n+\n+ oldSecurityManager = System.getSecurityManager();\n+ /*\n+ * TODO(cpovirk): Why couldn't I get this to work with PermissionCollection and implies(), as\n+ * used by ClassPathTest?\n+ */\n+ final PropertyPermission readSystemProperty =\n+ new PropertyPermission(\"guava.concurrent.generate_cancellation_cause\", \"read\");\n+ SecurityManager disallowPropertySecurityManager =\n+ new SecurityManager() {\n+ @Override\n+ public void checkPermission(Permission p) {\n+ if (readSystemProperty.equals(p)) {\n+ throw new SecurityException(\"Disallowed: \" + p);\n+ }\n+ }\n+ };\n+ System.setSecurityManager(disallowPropertySecurityManager);\n+\n+ settableFutureClass = classReloader.loadClass(SettableFuture.class.getName());\n+\n+ /*\n+ * We must keep the SecurityManager installed during the test body: It affects what kind of\n+ * threads ForkJoinPool.commonPool() creates.\n+ */\n+ }\n+\n+ @Override\n+ protected void tearDown() throws Exception {\n+ System.setSecurityManager(oldSecurityManager);\n+ classReloader.close();\n+ Thread.currentThread().setContextClassLoader(oldClassLoader);\n+ }\n+\n+ public void testAbstractFutureInitializationWithInnocuousThread_doesNotThrow() throws Exception {\n+ CountDownLatch latch = new CountDownLatch(1);\n+ // Setting a security manager causes the common ForkJoinPool to use InnocuousThreads with no\n+ // permissions.\n+ // submit()/join() causes this thread to execute the task instead, so we use a CountDownLatch as\n+ // a barrier to synchronize.\n+ // TODO(cpovirk): If some other test already initialized commonPool(), this won't work :(\n+ // Maybe we should just run this test in its own VM.\n+ ForkJoinPool.commonPool()\n+ .execute(\n+ () -> {\n+ try {\n+ settableFutureClass.getMethod(\"create\").invoke(null);\n+ latch.countDown();\n+ } catch (Exception e) {\n+ throw new RuntimeException(e);\n+ }\n+ });\n+ // In the failure case, await() will timeout.\n+ assertTrue(latch.await(2, TimeUnit.SECONDS));\n+ }\n+\n+ // TODO(cpovirk): Write a similar test that doesn't use ForkJoinPool (to run under Android)?\n+}",
"filename": "guava-tests/test/com/google/common/util/concurrent/AbstractFutureInnocuousThreadTest.java",
"status": "added"
},
{
"diff": "@@ -69,9 +69,20 @@ public abstract class AbstractFuture<V> extends InternalFutureFailureAccess\n implements ListenableFuture<V> {\n // NOTE: Whenever both tests are cheap and functional, it's faster to use &, | instead of &&, ||\n \n- private static final boolean GENERATE_CANCELLATION_CAUSES =\n- Boolean.parseBoolean(\n- System.getProperty(\"guava.concurrent.generate_cancellation_cause\", \"false\"));\n+ private static final boolean GENERATE_CANCELLATION_CAUSES;\n+\n+ static {\n+ // System.getProperty may throw if the security policy does not permit access.\n+ boolean generateCancellationCauses;\n+ try {\n+ generateCancellationCauses =\n+ Boolean.parseBoolean(\n+ System.getProperty(\"guava.concurrent.generate_cancellation_cause\", \"false\"));\n+ } catch (SecurityException e) {\n+ generateCancellationCauses = false;\n+ }\n+ GENERATE_CANCELLATION_CAUSES = generateCancellationCauses;\n+ }\n \n /**\n * Tag interface marking trusted subclasses. This enables some optimizations. The implementation",
"filename": "guava/src/com/google/common/util/concurrent/AbstractFuture.java",
"status": "modified"
}
]
} |
{
"body": "The following piece of code throws an undocumented `IllegalArgumentException`:\r\n\r\n final Set<String> products = Sets.newHashSet(\"coffee\", \"tea\");\r\n final List<Set<String>> productOf = Collections.nCopies(31, products); \r\n assert Sets.cartesianProduct(productOf).size() == Integer.MAX_VALUE;\r\n\r\nThe fact that `Sets::cartesianProduct` will throw an `IllegalArgumentException` when there would be more than 2^31-1 elements in the resulting set is not documented as far as I can see.\r\n\r\nI would like to see one of two solutions:\r\n\r\n1. Document why this Exception is thrown (there may be an implementation detail that prevents *even defining* such large sets).\r\n2. Fix it, because `java.util.Set::size()` specifies that if the size would be more than `Integer.MAX_VALUE` it would simply be `Integer.MAX_VALUE`.\r\n\r\nI like to see this fixed (solution 2), because now I can't even define such a Cartesian product. Iterating over so many elements is of course a different issue, but I have a piece of code that may very quickly find an `element` in the product, because I know it is in there and due to some ordering on `element`.\r\n",
"comments": [
{
"body": "@Meijuh @kluever I think we should fix this(solution 2). I will have a look at it.",
"created_at": "2020-04-14T14:18:06Z"
}
],
"number": 3742,
"title": "Sets.cartesianProduct gives undocumented IllegalArgumentException due to its size"
} | {
"body": "#3742 mentions that there's no documentation for an IllegalArgumentException being thrown.\r\n\r\nIt turns out there's a test case here that covers this case, but it's not mentioned in the JavaDoc: https://github.com/google/guava/blob/d9b73b20964b9d87457c56d1e422a67f45c2c257/guava-tests/test/com/google/common/collect/SetsTest.java#L774\r\n\r\nThe original exception is thrown here in the CartesianList constructor: https://github.com/google/guava/blob/d9b73b20964b9d87457c56d1e422a67f45c2c257/guava/src/com/google/common/collect/CartesianList.java#L59\r\n\r\nI've just added a `throws` line in both of the JavaDocs for `Sets.cartesianProduct()`",
"number": 3756,
"review_comments": [],
"title": "documenting IllegalArgumentException for too-large Cartesian Product in Sets.cartesianProduct"
} | {
"commits": [
{
"message": "documenting IllegalArgumentException for too-large Cartesian Product in Sets.cartesianProduct"
}
],
"files": [
{
"diff": "@@ -1319,6 +1319,7 @@ public NavigableSet<E> tailSet(E fromElement, boolean inclusive) {\n * @return the Cartesian product, as an immutable set containing immutable lists\n * @throws NullPointerException if {@code sets}, any one of the {@code sets}, or any element of a\n * provided set is null\n+ * @throws IllegalArgumentException if cartesian product too large, must have size at most Integer.MAX_VALUE\n * @since 2.0\n */\n public static <B> Set<List<B>> cartesianProduct(List<? extends Set<? extends B>> sets) {\n@@ -1375,6 +1376,7 @@ public static <B> Set<List<B>> cartesianProduct(List<? extends Set<? extends B>>\n * @return the Cartesian product, as an immutable set containing immutable lists\n * @throws NullPointerException if {@code sets}, any one of the {@code sets}, or any element of a\n * provided set is null\n+ * @throws IllegalArgumentException if cartesian product too large, must have size at most Integer.MAX_VALUE\n * @since 2.0\n */\n @SafeVarargs",
"filename": "guava/src/com/google/common/collect/Sets.java",
"status": "modified"
}
]
} |
{
"body": "Currently, trying to slice a `ByteSource` twice throws an unexpected `IllegalArgumentException` if the `ByteSource` returned after the first slice has a length smaller than the offset of the subsequent slice. For example, this code throws an `IllegalArgumentException`:\r\n\r\n```\r\nimport com.google.common.io.ByteSource;\r\n\r\npublic class GuavaTest {\r\n public static void main(String[] args) {\r\n ByteSource.concat().slice(0, 3).slice(4, 3);\r\n }\r\n}\r\n```\r\n\r\nThat is against the documentation, where it is specified that it should return an empty `ByteSource`.",
"comments": [
{
"body": "@cpovirk Should this issue be closed? It looks like it was fixed in #3830.",
"created_at": "2020-10-13T00:01:08Z"
}
],
"number": 3501,
"title": "Slicing a ByteSource twice throws an unexpected IllegalArgumentException"
} | {
"body": "Fixes #3501\r\n\r\nHowever, there is still a problem in this method. If `this.offset + this.length > Long.MAX_VALUE`, it will overflow. These are 4 possible approaches:\r\n\r\n1. Leave is as it is.\r\n2. Disallow offset + length > Long.MAX_VALUE on slices by adding checks.\r\n3. Allow offsets larger than Long.MAX_VALUE.\r\n4. Assume that no ByteSource has that much elements, and if the offset would overflow, return an empty source.",
"number": 3502,
"review_comments": [],
"title": "Fixed double slicing ByteSource"
} | {
"commits": [
{
"message": "Fixed double slicing byte source"
}
],
"files": [
{
"diff": "@@ -220,6 +220,25 @@ public void testSlice() throws IOException {\n assertCorrectSlice(100, 101, 10, 0);\n }\n \n+ /**\n+ * Tests that slice() works correctly when the source is sliced two times, when the second slice\n+ * starts at an offset greater than the length of the previous slice.\n+ */\n+ public void testSlice_slicingAfterSlicing() throws IOException {\n+ // Source of length 10\n+ ByteSource source = new TestByteSource(newPreFilledByteArray(10));\n+\n+ // Slice the source twice\n+ ByteSource doubleSlice = source.slice(0, 3).slice(4,3);\n+\n+ // Open a stream to the slice\n+ InputStream in = doubleSlice.openStream();\n+\n+ // The result should be empty because the second slice starts at an offset greater than\n+ // the length of the first slice.\n+ assertEquals(-1, in.read());\n+ }\n+\n /**\n * Tests that the default slice() behavior is correct when the source is sliced starting at an\n * offset that is greater than the current length of the source, a stream is then opened to that",
"filename": "guava-tests/test/com/google/common/io/ByteSourceTest.java",
"status": "modified"
},
{
"diff": "@@ -527,6 +527,7 @@ private InputStream sliceStream(InputStream in) throws IOException {\n public ByteSource slice(long offset, long length) {\n checkArgument(offset >= 0, \"offset (%s) may not be negative\", offset);\n checkArgument(length >= 0, \"length (%s) may not be negative\", length);\n+ offset = Math.min(offset, this.length);\n long maxLength = this.length - offset;\n return ByteSource.this.slice(this.offset + offset, Math.min(length, maxLength));\n }",
"filename": "guava/src/com/google/common/io/ByteSource.java",
"status": "modified"
}
]
} |
{
"body": "_[Original issue](https://code.google.com/p/guava-libraries/issues/detail?id=1872) created by **manderson23** on 2014-10-27 at 10:59 PM_\n\n---\n\nInternetDomainName.isValid returns false for the parameter \"8server\".\n\nRFC1123 suggests that names should be able to start with a digit. See https://groups.google.com/forum/#!topic/guava-discuss/8Sycya7Fkok on guava-discuss for a discussion of the issue. \n\nI also asked for clarification on Server Fault at http://serverfault.com/questions/638260/is-it-valid-for-a-hostname-to-start-with-a-digit\n\nMy final suggestion on the mailing list for solving this was as follows:\n\n\"What about if the final part starts with a digit actually checking if the complete name is an IP address e.g. calling InetAddreses.isInetAddress? The discussion section in RFC 1123 does suggest a full syntactic check to prevent a dotted decimal number getting through.\"\n\nbut there was no response.\n",
"comments": [
{
"body": "I was directed here in a discussion of https://issues.cloudera.org/browse/DISTRO-638 (\"Cannot install Cloudera Manager Agent if hostname starts with a digit\") where the origin of that issue is that Docker generates hostnames as random hexadecimal strings, which do therefore quite often start with a digit. (And they refuse to change that, insisting that it is totally RFC-compliant to start with a digit, as long as there is also any normal letter in the hostname: https://github.com/docker/docker/issues/7756, https://github.com/docker/docker/pull/8194)\n\nI would therefore very much like to see a change of behavior from \"fail if first character of TLD is a digit\" to \"fail if all characters of TLD are digits\".\n",
"created_at": "2015-02-26T01:36:23Z"
},
{
"body": "tgpfeiffer there is a patch for that you can even patch it easy your self with simply adding a random letter fixed in front of the container name via editing docker src and making a fork\n",
"created_at": "2015-03-08T09:21:13Z"
}
],
"number": 1872,
"title": "InternetDomainName.isValid is not RFC1123 compliant"
} | {
"body": "RFC1123 compliant InternetDomainName test cases\r\n\r\nAdd tests to prove URLs with leading digits are valid and containing only digits are valid.\r\n#1872 was resolved at some point from 2014 to now without the issue getting closed. This PR adds test cases proving this issue can be closed. \r\n\r\nSome sample real domains from related to these tests would be [www.9gag.com](https://www.9gag.com/) and [www.9292.nl](https://www.9292.nl/)",
"number": 3482,
"review_comments": [],
"title": "RFC1123 Compliant InternetDomainName Test Cases"
} | {
"commits": [
{
"message": "RFC1123 InternetDomainName Test Cases\n\nAdd tests to prove URLs with a leading digit is valid and contains only digits is valid"
},
{
"message": "Merge remote-tracking branch 'upstream/master' into RFC1123-InternetDomainName-Test-Cases"
}
],
"files": [
{
"diff": "@@ -63,6 +63,8 @@ public final class InternetDomainNameTest extends TestCase {\n \"f_a\",\n \"foo.net.us\\uFF61ocm\",\n \"woo.com.\",\n+ \"8server.shop\",\n+ \"123.cn\",\n \"a\" + DELTA + \"b.com\",\n ALMOST_TOO_MANY_LEVELS,\n ALMOST_TOO_LONG);",
"filename": "android/guava-tests/test/com/google/common/net/InternetDomainNameTest.java",
"status": "modified"
},
{
"diff": "@@ -63,6 +63,8 @@ public final class InternetDomainNameTest extends TestCase {\n \"f_a\",\n \"foo.net.us\\uFF61ocm\",\n \"woo.com.\",\n+ \"8server.shop\",\n+ \"123.cn\",\n \"a\" + DELTA + \"b.com\",\n ALMOST_TOO_MANY_LEVELS,\n ALMOST_TOO_LONG);",
"filename": "guava-tests/test/com/google/common/net/InternetDomainNameTest.java",
"status": "modified"
}
]
} |
{
"body": "_[Original issue](https://code.google.com/p/guava-libraries/issues/detail?id=7) created by **kuaw26** on 2009-10-06 at 12:38 PM_\n\n---\n\nWhy ImmutableMap check value for null?\nWhat should I do if I want to put null value?\n\nMay by it would be reasonable to introduce:\nImmutableMap.allowNullValues().<all nice methods of ImmutableMap>\n\nOr do not check value for null.\n",
"comments": [
{
"body": "_[Original comment](https://code.google.com/p/guava-libraries/issues/detail?id=7#c1) posted by **kuaw26** on 2009-10-06 at 03:20 PM_\n\n---\n\nSorry, wrong project, please delete this issue\n",
"created_at": "2014-10-31T18:16:36Z"
},
{
"body": "_[Original comment](https://code.google.com/p/guava-libraries/issues/detail?id=7#c2) posted by **kevinb@google.com** on 2010-01-05 at 07:41 PM_\n\n---\n\n_(No comment entered for this change.)_\n\n---\n\n**Status:** `WontFix`\n",
"created_at": "2014-10-31T18:19:19Z"
}
],
"number": 7,
"title": "Provide abilty to put null into immutable map"
} | {
"body": "This *PR* illustrates an approach where explicit *null*-checks are replaced by automatic checks. \r\n\r\nConsider a sample class - [Iterators](https://github.com/denis-zhdanov/guava/commit/71eee2dea89f6827f340e231bc715311120df6ca#diff-d2ea06a03a4988cf54d6d3d923deae88): \r\n\r\n*Original source code* \r\n\r\n```java\r\npublic static <T> Iterator<T> concat(Iterator<? extends T> a, Iterator<? extends T> b) {\r\n checkNotNull(a);\r\n checkNotNull(b);\r\n return concat(consumingForArray(a, b));\r\n}\r\n``` \r\n\r\n*Suggested source code* \r\n\r\n```java\r\npublic static <T> Iterator<T> concat(Iterator<? extends T> a, Iterator<? extends T> b) {\r\n return concat(consumingForArray(a, b));\r\n}\r\n``` \r\n\r\nResulting bytecode looks like if it's compiled from the source below: \r\n\r\n```java\r\npublic static <T> Iterator<T> concat(Iterator<? extends T> a, Iterator<? extends T> b) {\r\n if (a == null) {\r\n throw new NullPointerException(\"a was null\");\r\n }\r\n if (b == null) {\r\n throw new NullPointerException(\"b was null\");\r\n }\r\n return concat(consumingForArray(new Iterator[] { a, b }));\r\n}\r\n``` \r\n\r\n*Raw bytecode* \r\n\r\n```\r\njavap -c ./guava/target/classes/com/google/common/collect/Iterators.class\r\n...\r\n public static <T> java.util.Iterator<T> concat(java.util.Iterator<? extends T>, java.util.Iterator<? extends T>);\r\n Code:\r\n 0: aload_0\r\n 1: ifnonnull 14\r\n 4: new #5 // class java/lang/NullPointerException\r\n 7: dup\r\n 8: ldc #51 // String a was null\r\n 10: invokespecial #7 // Method java/lang/NullPointerException.\"<init>\":(Ljava/lang/String;)V\r\n 13: athrow\r\n 14: aload_1\r\n 15: ifnonnull 28\r\n 18: new #5 // class java/lang/NullPointerException\r\n 21: dup\r\n 22: ldc #52 // String b was null\r\n 24: invokespecial #7 // Method java/lang/NullPointerException.\"<init>\":(Ljava/lang/String;)V\r\n 27: athrow\r\n 28: iconst_2\r\n 29: anewarray #53 // class java/util/Iterator\r\n 32: dup\r\n 33: iconst_0\r\n 34: aload_0\r\n 35: aastore\r\n 36: dup\r\n 37: iconst_1\r\n 38: aload_1\r\n 39: aastore\r\n 40: invokestatic #54 // Method consumingForArray:([Ljava/lang/Object;)Ljava/util/Iterator;\r\n 43: invokestatic #55 // Method concat:(Ljava/util/Iterator;)Ljava/util/Iterator;\r\n 46: areturn\r\n``` \r\n\r\n**Implementation** \r\n\r\nThe checks are generated by the [Traute](http://traute.oss.harmonysoft.tech/) *javac* plugin - it finds [existing package-level *ParametersAreNonnullByDefault*](https://github.com/google/guava/blob/master/guava/src/com/google/common/collect/package-info.java#L215) annotation and adds checks for all method parameters not marked by *Nullable* annotation (*Checker*'s *NullableDecl* is [supported by default](http://traute.oss.harmonysoft.tech/core/javac/#73-nullable-annotations)). \r\n\r\n**Restrictions** \r\n\r\n*Traute* is a *javac* plugin and corresponding *API* is available since *java8*. Do you guys use something like `javac8 -source 1.7 -target 1.7` for generating *javac7* bytecode? \r\n\r\n**Proposal** \r\n\r\nI'd be glad to create a *PR*/modify current *PR* which replaces all explicit *null*-checks if the team likes the approach.",
"number": 3018,
"review_comments": [
{
"body": "What's this for?",
"created_at": "2017-12-24T07:44:45Z"
},
{
"body": "@liach this adds *Traute* *javac* plugin to compiler's classpath",
"created_at": "2017-12-24T08:22:59Z"
}
],
"title": "POC: replace explicit null checks by automatic"
} | {
"commits": [
{
"message": "POC: replace explicit null checks by automatic"
},
{
"message": "Defined @NullableDecl annotations in order to avoid\nconflicts with @ParametersAreNonnullByDefault"
},
{
"message": "Configured Traute through annotationProcessorsPath"
},
{
"message": "More @NullableDecl annotations are defined to avoid\nconflicts with @ParametersAreNonnullByDefault"
},
{
"message": "More @NullableDecl annotations are defined to avoid\nconflicts with @ParametersAreNonnullByDefault"
},
{
"message": "Removed explicit checks from one more class to\ntrigger a CI build"
}
],
"files": [
{
"diff": "@@ -569,7 +569,7 @@ public ImmutableSortedMap<K, V> build() {\n ImmutableSortedMap(\n RegularImmutableSortedSet<K> keySet,\n ImmutableList<V> valueList,\n- ImmutableSortedMap<K, V> descendingMap) {\n+ @NullableDecl ImmutableSortedMap<K, V> descendingMap) {\n this.keySet = keySet;\n this.valueList = valueList;\n this.descendingMap = descendingMap;",
"filename": "guava/src/com/google/common/collect/ImmutableSortedMap.java",
"status": "modified"
},
{
"diff": "@@ -17,7 +17,6 @@\n package com.google.common.collect;\n \n import static com.google.common.base.Preconditions.checkArgument;\n-import static com.google.common.base.Preconditions.checkNotNull;\n import static com.google.common.collect.CollectPreconditions.checkRemove;\n \n import com.google.common.annotations.Beta;\n@@ -69,7 +68,6 @@ private Iterables() {}\n \n /** Returns an unmodifiable view of {@code iterable}. */\n public static <T> Iterable<T> unmodifiableIterable(final Iterable<? extends T> iterable) {\n- checkNotNull(iterable);\n if (iterable instanceof UnmodifiableIterable || iterable instanceof ImmutableCollection) {\n @SuppressWarnings(\"unchecked\") // Since it's unmodifiable, the covariant cast is safe\n Iterable<T> result = (Iterable<T>) iterable;\n@@ -86,7 +84,7 @@ public static <T> Iterable<T> unmodifiableIterable(final Iterable<? extends T> i\n */\n @Deprecated\n public static <E> Iterable<E> unmodifiableIterable(ImmutableCollection<E> iterable) {\n- return checkNotNull(iterable);\n+ return iterable;\n }\n \n private static final class UnmodifiableIterable<T> extends FluentIterable<T> {\n@@ -153,7 +151,7 @@ public static boolean contains(Iterable<?> iterable, @NullableDecl Object elemen\n @CanIgnoreReturnValue\n public static boolean removeAll(Iterable<?> removeFrom, Collection<?> elementsToRemove) {\n return (removeFrom instanceof Collection)\n- ? ((Collection<?>) removeFrom).removeAll(checkNotNull(elementsToRemove))\n+ ? ((Collection<?>) removeFrom).removeAll(elementsToRemove)\n : Iterators.removeAll(removeFrom.iterator(), elementsToRemove);\n }\n \n@@ -170,7 +168,7 @@ public static boolean removeAll(Iterable<?> removeFrom, Collection<?> elementsTo\n @CanIgnoreReturnValue\n public static boolean retainAll(Iterable<?> removeFrom, Collection<?> elementsToRetain) {\n return (removeFrom instanceof Collection)\n- ? ((Collection<?>) removeFrom).retainAll(checkNotNull(elementsToRetain))\n+ ? ((Collection<?>) removeFrom).retainAll(elementsToRetain)\n : Iterators.retainAll(removeFrom.iterator(), elementsToRetain);\n }\n \n@@ -201,7 +199,6 @@ public static <T> boolean removeIf(Iterable<T> removeFrom, Predicate<? super T>\n /** Removes and returns the first matching element, or returns {@code null} if there is none. */\n @NullableDecl\n static <T> T removeFirstMatching(Iterable<T> removeFrom, Predicate<? super T> predicate) {\n- checkNotNull(predicate);\n Iterator<T> iterator = removeFrom.iterator();\n while (iterator.hasNext()) {\n T next = iterator.next();\n@@ -317,7 +314,7 @@ public static <T> boolean addAll(Collection<T> addTo, Iterable<? extends T> elem\n Collection<? extends T> c = Collections2.cast(elementsToAdd);\n return addTo.addAll(c);\n }\n- return Iterators.addAll(addTo, checkNotNull(elementsToAdd).iterator());\n+ return Iterators.addAll(addTo, elementsToAdd.iterator());\n }\n \n /**\n@@ -359,7 +356,6 @@ public static int frequency(Iterable<?> iterable, @NullableDecl Object element)\n * Stream.generate(() -> iterable).flatMap(Streams::stream)}.\n */\n public static <T> Iterable<T> cycle(final Iterable<T> iterable) {\n- checkNotNull(iterable);\n return new FluentIterable<T>() {\n @Override\n public Iterator<T> iterator() {\n@@ -507,7 +503,6 @@ public static <T> Iterable<T> concat(Iterable<? extends Iterable<? extends T>> i\n * @throws IllegalArgumentException if {@code size} is nonpositive\n */\n public static <T> Iterable<List<T>> partition(final Iterable<T> iterable, final int size) {\n- checkNotNull(iterable);\n checkArgument(size > 0);\n return new FluentIterable<List<T>>() {\n @Override\n@@ -533,7 +528,6 @@ public Iterator<List<T>> iterator() {\n * @throws IllegalArgumentException if {@code size} is nonpositive\n */\n public static <T> Iterable<List<T>> paddedPartition(final Iterable<T> iterable, final int size) {\n- checkNotNull(iterable);\n checkArgument(size > 0);\n return new FluentIterable<List<T>>() {\n @Override\n@@ -551,8 +545,6 @@ public Iterator<List<T>> iterator() {\n */\n public static <T> Iterable<T> filter(\n final Iterable<T> unfiltered, final Predicate<? super T> retainIfTrue) {\n- checkNotNull(unfiltered);\n- checkNotNull(retainIfTrue);\n return new FluentIterable<T>() {\n @Override\n public Iterator<T> iterator() {\n@@ -561,7 +553,6 @@ public Iterator<T> iterator() {\n \n @Override\n public void forEach(Consumer<? super T> action) {\n- checkNotNull(action);\n unfiltered.forEach(\n (T a) -> {\n if (retainIfTrue.test(a)) {\n@@ -594,8 +585,6 @@ public Spliterator<T> spliterator() {\n @SuppressWarnings(\"unchecked\")\n @GwtIncompatible // Class.isInstance\n public static <T> Iterable<T> filter(final Iterable<?> unfiltered, final Class<T> desiredType) {\n- checkNotNull(unfiltered);\n- checkNotNull(desiredType);\n return (Iterable<T>) filter(unfiltered, Predicates.instanceOf(desiredType));\n }\n \n@@ -693,8 +682,6 @@ public static <T> int indexOf(Iterable<T> iterable, Predicate<? super T> predica\n */\n public static <F, T> Iterable<T> transform(\n final Iterable<F> fromIterable, final Function<? super F, ? extends T> function) {\n- checkNotNull(fromIterable);\n- checkNotNull(function);\n return new FluentIterable<T>() {\n @Override\n public Iterator<T> iterator() {\n@@ -703,7 +690,6 @@ public Iterator<T> iterator() {\n \n @Override\n public void forEach(Consumer<? super T> action) {\n- checkNotNull(action);\n fromIterable.forEach((F f) -> action.accept(function.apply(f)));\n }\n \n@@ -726,7 +712,6 @@ public Spliterator<T> spliterator() {\n * the size of {@code iterable}\n */\n public static <T> T get(Iterable<T> iterable, int position) {\n- checkNotNull(iterable);\n return (iterable instanceof List)\n ? ((List<T>) iterable).get(position)\n : Iterators.get(iterable.iterator(), position);\n@@ -750,7 +735,6 @@ public static <T> T get(Iterable<T> iterable, int position) {\n @NullableDecl\n public static <T> T get(\n Iterable<? extends T> iterable, int position, @NullableDecl T defaultValue) {\n- checkNotNull(iterable);\n Iterators.checkNonnegative(position);\n if (iterable instanceof List) {\n List<? extends T> list = Lists.cast(iterable);\n@@ -855,7 +839,6 @@ private static <T> T getLastInNonemptyList(List<T> list) {\n * @since 3.0\n */\n public static <T> Iterable<T> skip(final Iterable<T> iterable, final int numberToSkip) {\n- checkNotNull(iterable);\n checkArgument(numberToSkip >= 0, \"number to skip cannot be negative\");\n \n return new FluentIterable<T>() {\n@@ -925,7 +908,6 @@ public Spliterator<T> spliterator() {\n * @since 3.0\n */\n public static <T> Iterable<T> limit(final Iterable<T> iterable, final int limitSize) {\n- checkNotNull(iterable);\n checkArgument(limitSize >= 0, \"limit is negative\");\n return new FluentIterable<T>() {\n @Override\n@@ -957,8 +939,6 @@ public Spliterator<T> spliterator() {\n * @since 2.0\n */\n public static <T> Iterable<T> consumingIterable(final Iterable<T> iterable) {\n- checkNotNull(iterable);\n-\n return new FluentIterable<T>() {\n @Override\n public Iterator<T> iterator() {\n@@ -1010,8 +990,6 @@ public static boolean isEmpty(Iterable<?> iterable) {\n public static <T> Iterable<T> mergeSorted(\n final Iterable<? extends Iterable<? extends T>> iterables,\n final Comparator<? super T> comparator) {\n- checkNotNull(iterables, \"iterables\");\n- checkNotNull(comparator, \"comparator\");\n Iterable<T> iterable =\n new FluentIterable<T>() {\n @Override",
"filename": "guava/src/com/google/common/collect/Iterables.java",
"status": "modified"
},
{
"diff": "@@ -124,7 +124,6 @@ static <T> Iterator<T> emptyModifiableIterator() {\n /** Returns an unmodifiable view of {@code iterator}. */\n public static <T> UnmodifiableIterator<T> unmodifiableIterator(\n final Iterator<? extends T> iterator) {\n- checkNotNull(iterator);\n if (iterator instanceof UnmodifiableIterator) {\n @SuppressWarnings(\"unchecked\") // Since it's unmodifiable, the covariant cast is safe\n UnmodifiableIterator<T> result = (UnmodifiableIterator<T>) iterator;\n@@ -151,7 +150,7 @@ public T next() {\n */\n @Deprecated\n public static <T> UnmodifiableIterator<T> unmodifiableIterator(UnmodifiableIterator<T> iterator) {\n- return checkNotNull(iterator);\n+ return iterator;\n }\n \n /**\n@@ -195,7 +194,6 @@ public static boolean contains(Iterator<?> iterator, @NullableDecl Object elemen\n */\n @CanIgnoreReturnValue\n public static boolean removeAll(Iterator<?> removeFrom, Collection<?> elementsToRemove) {\n- checkNotNull(elementsToRemove);\n boolean result = false;\n while (removeFrom.hasNext()) {\n if (elementsToRemove.contains(removeFrom.next())) {\n@@ -217,7 +215,6 @@ public static boolean removeAll(Iterator<?> removeFrom, Collection<?> elementsTo\n */\n @CanIgnoreReturnValue\n public static <T> boolean removeIf(Iterator<T> removeFrom, Predicate<? super T> predicate) {\n- checkNotNull(predicate);\n boolean modified = false;\n while (removeFrom.hasNext()) {\n if (predicate.apply(removeFrom.next())) {\n@@ -239,7 +236,6 @@ public static <T> boolean removeIf(Iterator<T> removeFrom, Predicate<? super T>\n */\n @CanIgnoreReturnValue\n public static boolean retainAll(Iterator<?> removeFrom, Collection<?> elementsToRetain) {\n- checkNotNull(elementsToRetain);\n boolean result = false;\n while (removeFrom.hasNext()) {\n if (!elementsToRetain.contains(removeFrom.next())) {\n@@ -351,8 +347,6 @@ public static <T> T[] toArray(Iterator<? extends T> iterator, Class<T> type) {\n */\n @CanIgnoreReturnValue\n public static <T> boolean addAll(Collection<T> addTo, Iterator<? extends T> iterator) {\n- checkNotNull(addTo);\n- checkNotNull(iterator);\n boolean wasModified = false;\n while (iterator.hasNext()) {\n wasModified |= addTo.add(iterator.next());\n@@ -389,7 +383,6 @@ public static int frequency(Iterator<?> iterator, @NullableDecl Object element)\n * elements.\n */\n public static <T> Iterator<T> cycle(final Iterable<T> iterable) {\n- checkNotNull(iterable);\n return new Iterator<T>() {\n Iterator<T> iterator = emptyModifiableIterator();\n \n@@ -479,8 +472,6 @@ public T next() {\n * supports it.\n */\n public static <T> Iterator<T> concat(Iterator<? extends T> a, Iterator<? extends T> b) {\n- checkNotNull(a);\n- checkNotNull(b);\n return concat(consumingForArray(a, b));\n }\n \n@@ -494,9 +485,6 @@ public static <T> Iterator<T> concat(Iterator<? extends T> a, Iterator<? extends\n */\n public static <T> Iterator<T> concat(\n Iterator<? extends T> a, Iterator<? extends T> b, Iterator<? extends T> c) {\n- checkNotNull(a);\n- checkNotNull(b);\n- checkNotNull(c);\n return concat(consumingForArray(a, b, c));\n }\n \n@@ -514,10 +502,6 @@ public static <T> Iterator<T> concat(\n Iterator<? extends T> b,\n Iterator<? extends T> c,\n Iterator<? extends T> d) {\n- checkNotNull(a);\n- checkNotNull(b);\n- checkNotNull(c);\n- checkNotNull(d);\n return concat(consumingForArray(a, b, c, d));\n }\n \n@@ -537,7 +521,7 @@ public static <T> Iterator<T> concat(Iterator<? extends T>... inputs) {\n \n /** Concats a varargs array of iterators without making a defensive copy of the array. */\n static <T> Iterator<T> concatNoDefensiveCopy(Iterator<? extends T>... inputs) {\n- for (Iterator<? extends T> input : checkNotNull(inputs)) {\n+ for (Iterator<? extends T> input : inputs) {\n checkNotNull(input);\n }\n return concat(consumingForArray(inputs));\n@@ -594,7 +578,6 @@ public static <T> UnmodifiableIterator<List<T>> paddedPartition(Iterator<T> iter\n \n private static <T> UnmodifiableIterator<List<T>> partitionImpl(\n final Iterator<T> iterator, final int size, final boolean pad) {\n- checkNotNull(iterator);\n checkArgument(size > 0);\n return new UnmodifiableIterator<List<T>>() {\n @Override\n@@ -629,8 +612,6 @@ public List<T> next() {\n */\n public static <T> UnmodifiableIterator<T> filter(\n final Iterator<T> unfiltered, final Predicate<? super T> retainIfTrue) {\n- checkNotNull(unfiltered);\n- checkNotNull(retainIfTrue);\n return new AbstractIterator<T>() {\n @Override\n protected T computeNext() {\n@@ -668,7 +649,6 @@ public static <T> boolean any(Iterator<T> iterator, Predicate<? super T> predica\n * predicate. If {@code iterator} is empty, {@code true} is returned.\n */\n public static <T> boolean all(Iterator<T> iterator, Predicate<? super T> predicate) {\n- checkNotNull(predicate);\n while (iterator.hasNext()) {\n T element = iterator.next();\n if (!predicate.apply(element)) {\n@@ -688,8 +668,6 @@ public static <T> boolean all(Iterator<T> iterator, Predicate<? super T> predica\n * @throws NoSuchElementException if no element in {@code iterator} matches the given predicate\n */\n public static <T> T find(Iterator<T> iterator, Predicate<? super T> predicate) {\n- checkNotNull(iterator);\n- checkNotNull(predicate);\n while (iterator.hasNext()) {\n T t = iterator.next();\n if (predicate.apply(t)) {\n@@ -712,8 +690,6 @@ public static <T> T find(\n Iterator<? extends T> iterator,\n Predicate<? super T> predicate,\n @NullableDecl T defaultValue) {\n- checkNotNull(iterator);\n- checkNotNull(predicate);\n while (iterator.hasNext()) {\n T t = iterator.next();\n if (predicate.apply(t)) {\n@@ -735,8 +711,6 @@ public static <T> T find(\n * @since 11.0\n */\n public static <T> Optional<T> tryFind(Iterator<T> iterator, Predicate<? super T> predicate) {\n- checkNotNull(iterator);\n- checkNotNull(predicate);\n while (iterator.hasNext()) {\n T t = iterator.next();\n if (predicate.apply(t)) {\n@@ -761,7 +735,6 @@ public static <T> Optional<T> tryFind(Iterator<T> iterator, Predicate<? super T>\n * @since 2.0\n */\n public static <T> int indexOf(Iterator<T> iterator, Predicate<? super T> predicate) {\n- checkNotNull(predicate, \"predicate\");\n for (int i = 0; iterator.hasNext(); i++) {\n T current = iterator.next();\n if (predicate.apply(current)) {\n@@ -781,7 +754,6 @@ public static <T> int indexOf(Iterator<T> iterator, Predicate<? super T> predica\n */\n public static <F, T> Iterator<T> transform(\n final Iterator<F> fromIterator, final Function<? super F, ? extends T> function) {\n- checkNotNull(function);\n return new TransformedIterator<F, T>(fromIterator) {\n @Override\n T transform(F from) {\n@@ -889,7 +861,6 @@ public static <T> T getLast(Iterator<? extends T> iterator, @NullableDecl T defa\n */\n @CanIgnoreReturnValue\n public static int advance(Iterator<?> iterator, int numberToAdvance) {\n- checkNotNull(iterator);\n checkArgument(numberToAdvance >= 0, \"numberToAdvance must be nonnegative\");\n \n int i;\n@@ -910,7 +881,6 @@ public static int advance(Iterator<?> iterator, int numberToAdvance) {\n * @since 3.0\n */\n public static <T> Iterator<T> limit(final Iterator<T> iterator, final int limitSize) {\n- checkNotNull(iterator);\n checkArgument(limitSize >= 0, \"limit is negative\");\n return new Iterator<T>() {\n private int count;\n@@ -948,7 +918,6 @@ public void remove() {\n * @since 2.0\n */\n public static <T> Iterator<T> consumingIterator(final Iterator<T> iterator) {\n- checkNotNull(iterator);\n return new UnmodifiableIterator<T>() {\n @Override\n public boolean hasNext() {\n@@ -988,7 +957,6 @@ static <T> T pollNext(Iterator<T> iterator) {\n \n /** Clears the iterator using its remove method. */\n static void clear(Iterator<?> iterator) {\n- checkNotNull(iterator);\n while (iterator.hasNext()) {\n iterator.next();\n iterator.remove();\n@@ -1082,7 +1050,6 @@ public T next() {\n * using {@link Collections#list}.\n */\n public static <T> UnmodifiableIterator<T> forEnumeration(final Enumeration<T> enumeration) {\n- checkNotNull(enumeration);\n return new UnmodifiableIterator<T>() {\n @Override\n public boolean hasNext() {\n@@ -1103,7 +1070,6 @@ public T next() {\n * you have a {@link Collection}), or {@code Iterators.asEnumeration(collection.iterator())}.\n */\n public static <T> Enumeration<T> asEnumeration(final Iterator<T> iterator) {\n- checkNotNull(iterator);\n return new Enumeration<T>() {\n @Override\n public boolean hasMoreElements() {\n@@ -1125,7 +1091,7 @@ private static class PeekingImpl<E> implements PeekingIterator<E> {\n private E peekedElement;\n \n public PeekingImpl(Iterator<? extends E> iterator) {\n- this.iterator = checkNotNull(iterator);\n+ this.iterator = iterator;\n }\n \n @Override\n@@ -1215,7 +1181,7 @@ public static <T> PeekingIterator<T> peekingIterator(Iterator<? extends T> itera\n */\n @Deprecated\n public static <T> PeekingIterator<T> peekingIterator(PeekingIterator<T> iterator) {\n- return checkNotNull(iterator);\n+ return iterator;\n }\n \n /**\n@@ -1233,9 +1199,6 @@ public static <T> PeekingIterator<T> peekingIterator(PeekingIterator<T> iterator\n @Beta\n public static <T> UnmodifiableIterator<T> mergeSorted(\n Iterable<? extends Iterator<? extends T>> iterators, Comparator<? super T> comparator) {\n- checkNotNull(iterators, \"iterators\");\n- checkNotNull(comparator, \"comparator\");\n-\n return new MergingIterator<T>(iterators, comparator);\n }\n \n@@ -1310,7 +1273,7 @@ private static class ConcatenatedIterator<T> implements Iterator<T> {\n \n ConcatenatedIterator(Iterator<? extends Iterator<? extends T>> metaIterator) {\n iterator = emptyIterator();\n- topMetaIterator = checkNotNull(metaIterator);\n+ topMetaIterator = metaIterator;\n }\n \n // Returns a nonempty meta-iterator or, if all meta-iterators are empty, null.",
"filename": "guava/src/com/google/common/collect/Iterators.java",
"status": "modified"
},
{
"diff": "@@ -3660,7 +3660,7 @@ static <K, V> boolean removeEntryImpl(Collection<Entry<K, V>> c, Object o) {\n }\n \n /** An implementation of {@link Map#equals}. */\n- static boolean equalsImpl(Map<?, ?> map, Object object) {\n+ static boolean equalsImpl(Map<?, ?> map, @NullableDecl Object object) {\n if (map == object) {\n return true;\n } else if (object instanceof Map) {",
"filename": "guava/src/com/google/common/collect/Maps.java",
"status": "modified"
},
{
"diff": "@@ -21,6 +21,8 @@\n import com.google.common.annotations.GwtIncompatible;\n import com.google.common.primitives.Primitives;\n import com.google.errorprone.annotations.CanIgnoreReturnValue;\n+import org.checkerframework.checker.nullness.compatqual.NullableDecl;\n+\n import java.io.Serializable;\n import java.util.HashMap;\n import java.util.Iterator;\n@@ -156,7 +158,7 @@ public <T extends B> T getInstance(Class<T> type) {\n }\n \n @CanIgnoreReturnValue\n- private static <B, T extends B> T cast(Class<T> type, B value) {\n+ private static <B, T extends B> T cast(Class<T> type, @NullableDecl B value) {\n return Primitives.wrap(type).cast(value);\n }\n ",
"filename": "guava/src/com/google/common/collect/MutableClassToInstanceMap.java",
"status": "modified"
},
{
"diff": "@@ -220,7 +220,7 @@ static Object[] checkElementsNotNull(Object[] array, int length) {\n // We do this instead of Preconditions.checkNotNull to save boxing and array\n // creation cost.\n @CanIgnoreReturnValue\n- static Object checkElementNotNull(Object element, int index) {\n+ static Object checkElementNotNull(@NullableDecl Object element, int index) {\n if (element == null) {\n throw new NullPointerException(\"at index \" + index);\n }",
"filename": "guava/src/com/google/common/collect/ObjectArrays.java",
"status": "modified"
},
{
"diff": "@@ -111,8 +111,8 @@ static <K, V> RegularImmutableBiMap<K, V> fromEntryArray(int n, Entry<K, V>[] en\n }\n \n private RegularImmutableBiMap(\n- ImmutableMapEntry<K, V>[] keyTable,\n- ImmutableMapEntry<K, V>[] valueTable,\n+ @NullableDecl ImmutableMapEntry<K, V>[] keyTable,\n+ @NullableDecl ImmutableMapEntry<K, V>[] valueTable,\n Entry<K, V>[] entries,\n int mask,\n int hashCode) {",
"filename": "guava/src/com/google/common/collect/RegularImmutableBiMap.java",
"status": "modified"
},
{
"diff": "@@ -97,7 +97,7 @@ static <K, V> RegularImmutableMap<K, V> fromEntryArray(int n, Entry<K, V>[] entr\n return new RegularImmutableMap<>(entries, table, mask);\n }\n \n- private RegularImmutableMap(Entry<K, V>[] entries, ImmutableMapEntry<K, V>[] table, int mask) {\n+ private RegularImmutableMap(Entry<K, V>[] entries, @NullableDecl ImmutableMapEntry<K, V>[] table, int mask) {\n this.entries = entries;\n this.table = table;\n this.mask = mask;",
"filename": "guava/src/com/google/common/collect/RegularImmutableMap.java",
"status": "modified"
},
{
"diff": "@@ -40,7 +40,7 @@ final class RegularImmutableSet<E> extends ImmutableSet<E> {\n private final transient int mask;\n private final transient int hashCode;\n \n- RegularImmutableSet(Object[] elements, int hashCode, Object[] table, int mask) {\n+ RegularImmutableSet(Object[] elements, int hashCode, @NullableDecl Object[] table, int mask) {\n this.elements = elements;\n this.table = table;\n this.mask = mask;",
"filename": "guava/src/com/google/common/collect/RegularImmutableSet.java",
"status": "modified"
},
{
"diff": "@@ -384,7 +384,7 @@ private static final class TypeVariableInvocationHandler implements InvocationHa\n }\n \n @Override\n- public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {\n+ public Object invoke(Object proxy, Method method, @NullableDecl Object[] args) throws Throwable {\n String methodName = method.getName();\n Method typeVariableMethod = typeVariableMethods.get(methodName);\n if (typeVariableMethod == null) {",
"filename": "guava/src/com/google/common/reflect/Types.java",
"status": "modified"
},
{
"diff": "@@ -188,7 +188,7 @@ private static final class Waiter {\n \n // non-volatile write to the next field. Should be made visible by subsequent CAS on waiters\n // field.\n- void setNext(Waiter next) {\n+ void setNext(@NullableDecl Waiter next) {\n ATOMIC_HELPER.putNext(this, next);\n }\n \n@@ -252,7 +252,7 @@ private static final class Listener {\n // writes to next are made visible by subsequent CAS's on the listeners field\n @NullableDecl Listener next;\n \n- Listener(Runnable task, Executor executor) {\n+ Listener(@NullableDecl Runnable task, @NullableDecl Executor executor) {\n this.task = task;\n this.executor = executor;\n }\n@@ -923,7 +923,7 @@ private void releaseWaiters() {\n * Clears the {@link #listeners} list and prepends its contents to {@code onto}, least recently\n * added first.\n */\n- private Listener clearListeners(Listener onto) {\n+ private Listener clearListeners(@NullableDecl Listener onto) {\n // We need to\n // 1. atomically swap the listeners with TOMBSTONE, this is because addListener uses that to\n // to synchronize with us\n@@ -1029,7 +1029,7 @@ private abstract static class AtomicHelper {\n abstract void putThread(Waiter waiter, Thread newValue);\n \n /** Non volatile write of the waiter to the {@link Waiter#next} field. */\n- abstract void putNext(Waiter waiter, Waiter newValue);\n+ abstract void putNext(Waiter waiter, @NullableDecl Waiter newValue);\n \n /** Performs a CAS operation on the {@link #waiters} field. */\n abstract boolean casWaiters(AbstractFuture<?> future, Waiter expect, Waiter update);\n@@ -1101,25 +1101,25 @@ void putThread(Waiter waiter, Thread newValue) {\n }\n \n @Override\n- void putNext(Waiter waiter, Waiter newValue) {\n+ void putNext(Waiter waiter, @NullableDecl Waiter newValue) {\n UNSAFE.putObject(waiter, WAITER_NEXT_OFFSET, newValue);\n }\n \n /** Performs a CAS operation on the {@link #waiters} field. */\n @Override\n- boolean casWaiters(AbstractFuture<?> future, Waiter expect, Waiter update) {\n+ boolean casWaiters(AbstractFuture<?> future, @NullableDecl Waiter expect, @NullableDecl Waiter update) {\n return UNSAFE.compareAndSwapObject(future, WAITERS_OFFSET, expect, update);\n }\n \n /** Performs a CAS operation on the {@link #listeners} field. */\n @Override\n- boolean casListeners(AbstractFuture<?> future, Listener expect, Listener update) {\n+ boolean casListeners(AbstractFuture<?> future, @NullableDecl Listener expect, Listener update) {\n return UNSAFE.compareAndSwapObject(future, LISTENERS_OFFSET, expect, update);\n }\n \n /** Performs a CAS operation on the {@link #value} field. */\n @Override\n- boolean casValue(AbstractFuture<?> future, Object expect, Object update) {\n+ boolean casValue(AbstractFuture<?> future, @NullableDecl Object expect, Object update) {\n return UNSAFE.compareAndSwapObject(future, VALUE_OFFSET, expect, update);\n }\n }\n@@ -1151,7 +1151,7 @@ void putThread(Waiter waiter, Thread newValue) {\n }\n \n @Override\n- void putNext(Waiter waiter, Waiter newValue) {\n+ void putNext(Waiter waiter, @NullableDecl Waiter newValue) {\n waiterNextUpdater.lazySet(waiter, newValue);\n }\n \n@@ -1184,7 +1184,7 @@ void putThread(Waiter waiter, Thread newValue) {\n }\n \n @Override\n- void putNext(Waiter waiter, Waiter newValue) {\n+ void putNext(Waiter waiter, @NullableDecl Waiter newValue) {\n waiter.next = newValue;\n }\n ",
"filename": "guava/src/com/google/common/util/concurrent/AbstractFuture.java",
"status": "modified"
},
{
"diff": "@@ -41,7 +41,7 @@ public abstract class AbstractListeningExecutorService extends AbstractExecutorS\n \n /** @since 19.0 (present with return type {@code ListenableFutureTask} since 14.0) */\n @Override\n- protected final <T> RunnableFuture<T> newTaskFor(Runnable runnable, T value) {\n+ protected final <T> RunnableFuture<T> newTaskFor(Runnable runnable, @NullableDecl T value) {\n return TrustedListenableFutureTask.create(runnable, value);\n }\n ",
"filename": "guava/src/com/google/common/util/concurrent/AbstractListeningExecutorService.java",
"status": "modified"
},
{
"diff": "@@ -126,7 +126,7 @@ V runInterruptibly() throws Exception {\n }\n \n @Override\n- void afterRanInterruptibly(V result, Throwable error) {\n+ void afterRanInterruptibly(@NullableDecl V result, @NullableDecl Throwable error) {\n if (error == null) {\n TrustedListenableFutureTask.this.set(result);\n } else {",
"filename": "guava/src/com/google/common/util/concurrent/TrustedListenableFutureTask.java",
"status": "modified"
},
{
"diff": "@@ -94,6 +94,17 @@\n <configuration>\n <source>1.8</source>\n <target>1.8</target>\n+ <compilerArgs>\n+ <arg>-Xplugin:Traute</arg>\n+ <arg>-Atraute.failure.text.parameter=$${PARAMETER_NAME} was null</arg>\n+ </compilerArgs>\n+ <annotationProcessorPaths>\n+ <path>\n+ <groupId>tech.harmonysoft</groupId>\n+ <artifactId>traute-javac</artifactId>\n+ <version>1.1.5</version>\n+ </path>\n+ </annotationProcessorPaths>\n </configuration>\n </plugin>\n <plugin>",
"filename": "pom.xml",
"status": "modified"
}
]
} |
{
"body": "For example [Javadoc for package `base`](http://google.github.io/guava/releases/19.0/api/docs/com/google/common/base/package-summary.html) link to [`@ParametersAreNonnullByDefault`](http://jsr-305.googlecode.com/svn/trunk/javadoc/javax/annotation/ParametersAreNonnullByDefault.html?is-external=true) results in 404.\n\nAffects all links to JSR 305 annotations.\n\nAs far as I can tell JSR 305 is not maintained anymore. Maybe the easiest solution would be to not link to the JSR 305 annotations in the Javadoc.\n",
"comments": [
{
"body": "Google Code is being turned down, but I'm not sure whether or not JSR 305 has just moved?\n",
"created_at": "2016-05-13T16:29:18Z"
},
{
"body": "There doesn't appear to be a new home. Perhaps you could just update the Guava build to download https://repo1.maven.org/maven2/com/google/code/findbugs/jsr305/3.0.1/jsr305-3.0.1-javadoc.jar, unzip it, and then point javadoc at the dir where it was unzipped.\n",
"created_at": "2016-05-14T01:24:31Z"
},
{
"body": "@ispringer Or point to javadoc.io which does what you describe:\nhttp://www.javadoc.io/doc/com.google.code.findbugs/jsr305/3.0.1\n",
"created_at": "2016-05-14T15:35:12Z"
}
],
"number": 2479,
"title": "Links to JSR 305 in Javadoc are broken"
} | {
"body": "Fixes #2479\r\nLinks must have a /package-list file",
"number": 2628,
"review_comments": [],
"title": "Fix links to javadoc.io for Maven Javadoc Plugin"
} | {
"commits": [
{
"message": "Fix links to javadoc.io for Maven Javadoc Plugin\n\nFixes #2479\r\nLinks must have a /package-list file"
}
],
"files": [
{
"diff": "@@ -109,9 +109,9 @@\n <linksource>true</linksource>\n <links>\n <link>http://docs.oracle.com/javase/8/docs/api/</link>\n- <link>http://javadoc.io/doc/com.google.code.findbugs/jsr305/3.0.1/</link>\n+ <link>http://static.javadoc.io/com.google.code.findbugs/jsr305/3.0.1/</link>\n <link>http://errorprone.info/api/latest/</link>\n- <link>http://javadoc.io/doc/com.google.j2objc/j2objc-annotations/1.1/</link>\n+ <link>http://static.javadoc.io/com.google.j2objc/j2objc-annotations/1.1/</link>\n </links>\n <!-- TODO(cpovirk): can we use includeDependencySources and a local com.oracle.java:jdk-lib:noversion:sources instead of all this unzipping and manual sourcepath modification? -->\n <sourcepath>${project.build.sourceDirectory}:${project.build.directory}/jdk-sources</sourcepath>",
"filename": "guava/pom.xml",
"status": "modified"
}
]
} |
{
"body": "### Problem:\n\nVery small double values break the RateLimiter resulting in it allowing many more permits than it should. The tests below are similar to the ones in com.google.common.util.concurrent.RateLimiterTest but do not use a stopwatch. \n### Test Case 1: Create with limit of Double.MIN_VALUE\n\n```\n RateLimiter r = RateLimiter.create(Double.MIN_VALUE);\n assertTrue(\"Unable to acquire initial permit\", r.tryAcquire());\n assertFalse(\"Capable of acquiring an additional permit\", r.tryAcquire());\n Thread.sleep(5000);\n assertFalse(\"Capable of acquiring an additional permit after sleeping\", r.tryAcquire());\n```\n\n> Fails the second assertion (\"Capable of acquiring an additional permit\")\n### Test Case 2: Create with limit of .0001\n\n```\n RateLimiter r = RateLimiter.create(.0001);\n assertTrue(\"Unable to acquire initial permit\", r.tryAcquire());\n assertFalse(\"Capable of acquiring an additional permit\", r.tryAcquire());\n Thread.sleep(5000);\n assertFalse(\"Capable of acquiring an additional permit after sleeping\", r.tryAcquire());\n```\n\n> Succeeds\n### Test Case 3: Create with limit of 1E-13\n\n```\n RateLimiter r = RateLimiter.create(0.0000000000001);\n assertTrue(\"Unable to acquire initial permit\", r.tryAcquire());\n assertFalse(\"Capable of acquiring an additional permit\", r.tryAcquire());\n Thread.sleep(5000);\n assertFalse(\"Capable of acquiring an additional permit after sleeping\", r.tryAcquire());\n```\n\n> Fails the second assertion (\"Capable of acquiring an additional permit\")\n",
"comments": [
{
"body": "Thanks for the report. This sounds like a bug and something we should look into.\n",
"created_at": "2016-01-14T20:16:26Z"
},
{
"body": "Hi,\n\nI do not know if this is correct way to contribute but I added a test case that shows RateLimiter works even for small values. I also sent a PR for that. \n\nRegards,\nBahadir\n",
"created_at": "2016-10-06T21:07:54Z"
},
{
"body": "We've submitted #2594, which shows that the first test passes rather than fails as suggested in the original post. If you believe there's a bug here, can you clarify what it is?",
"created_at": "2017-01-31T19:41:36Z"
}
],
"number": 2231,
"title": "Very small values breaks com.google.common.util.concurrent.RateLimiter"
} | {
"body": "Added a new tests case that proves RateLimiter\nworks even for very small numbers.\n\nIssue: #2231\n",
"number": 2594,
"review_comments": [],
"title": "Test case added to prove functionality"
} | {
"commits": [
{
"message": "Test case added to prove functionality\n\nAdded a new tests case that proves RateLimiter\nworks even for very small numbers.\n\nIssue: https://github.com/google/guava/issues/2231"
}
],
"files": [
{
"diff": "@@ -500,6 +500,14 @@ public void testNulls() {\n tester.testInstanceMethods(RateLimiter.create(stopwatch, 5.0), Visibility.PACKAGE);\n }\n \n+ public void testVerySmallDoubleValues() throws Exception {\n+ RateLimiter rateLimiter = RateLimiter.create(Double.MIN_VALUE);\n+ assertTrue(\"Should acquire initial permit\", rateLimiter.tryAcquire());\n+ assertFalse(\"Should not acquire additional permit\", rateLimiter.tryAcquire());\n+ Thread.sleep(5000);\n+ assertFalse(\"Should acquire new permit after 5 sec,\", rateLimiter.tryAcquire());\n+ }\n+\n private long measureTotalTimeMillis(RateLimiter rateLimiter, int permits, Random random) {\n long startTime = stopwatch.instant;\n while (permits > 0) {",
"filename": "guava-tests/test/com/google/common/util/concurrent/RateLimiterTest.java",
"status": "modified"
}
]
} |
{
"body": "**Failure cases:**\n_1) Positive_\nValues rounded incorrectly: `0.99999999999999984` to `0.99999999999999994`\nRounding modes: CEILING or UP\nExpected: `1`\nActual: `2`\n\n_2) Negative_\nValues rounded incorrectly:`-0.99999999999999984` to `-0.99999999999999994`\nRounding modes: FLOOR or UP\nExpected: `-1`\nActual: `-2`\n\n**Remarks:**\nThe reason is that values between 0 and 1 have higher fraction precision than values between 1 and 2. The code adds 1.0 to the value x, and double arithmetic uses HALF_EVEN rounding by default. This leads to unexpected results for edge cases when HALF_EVEN triggers rounding UP to 2.\n\n**Proposed FIX:**\nThe FIX is to cast the double value `x` to a long before the addition of `1.0`:\nCurrent:`x + 1.0`\nFixed: `(long)x + 1.0`\n\n**Pull Request:**\nSee pull request [#2511](https://github.com/google/guava/pull/2511)\n",
"comments": [
{
"body": "Fixed the bug; I think we ended up slightly changing the implementation (and doing much more aggressive testing). The fix should be mirrored out shortly.\n",
"created_at": "2016-06-30T19:37:42Z"
}
],
"number": 2509,
"title": "DoubleMath incorrectly rounds 0.99999999999999994 to 2 with rounding mode UP or CEILING"
} | {
"body": "See Issue #2509 \n",
"number": 2511,
"review_comments": [
{
"body": "I think this will do the wrong thing if x is too large to fit in a long.\n",
"created_at": "2016-06-27T14:52:30Z"
},
{
"body": "Problematic values are\n(a) NaN, Infinite --- they are checked at the beginning of the method (exception is thrown)\n(b) Finite, exceeding long range: are mathematical integers, hence will not run through the statement\n\nThis is confirmed by the fact that all DoubleMath unit tests are still passing.\n",
"created_at": "2016-06-27T14:56:04Z"
},
{
"body": "I concur, Eamonn: if x doesn't fit in a long, it's a mathematical integer anyway.\n",
"created_at": "2016-06-29T20:46:43Z"
},
{
"body": "OK.\n",
"created_at": "2016-06-29T20:58:04Z"
}
],
"title": "#2509: Fix for 'DoubleMath incorrectly rounds 0.99999999999999994 to 2 with rounding mode UP or CEILING"
} | {
"commits": [
{
"message": "#2509: Fix for 'DoubleMath incorrectly rounds 0.99999999999999994 to 2 with rounding mode UP or CEILING'"
}
],
"files": [
{
"diff": "@@ -241,6 +241,9 @@ public BigInteger apply(BigInteger x) {\n fractionalBuilder.add(x);\n }\n }\n+ for (double d = 0.99999999999999984; d <= 0.99999999999999994; d = Math.nextUp(d)) {\n+ fractionalBuilder.add(d).add(-d);\n+ }\n FRACTIONAL_DOUBLE_CANDIDATES = fractionalBuilder.build();\n FINITE_DOUBLE_CANDIDATES =\n Iterables.concat(FRACTIONAL_DOUBLE_CANDIDATES, INTEGRAL_DOUBLE_CANDIDATES);",
"filename": "guava-tests/test/com/google/common/math/MathTesting.java",
"status": "modified"
},
{
"diff": "@@ -66,14 +66,14 @@ static double roundIntermediate(double x, RoundingMode mode) {\n if (x >= 0.0 || isMathematicalInteger(x)) {\n return x;\n } else {\n- return x - 1.0;\n+ return (long)x - 1.0;\n }\n \n case CEILING:\n if (x <= 0.0 || isMathematicalInteger(x)) {\n return x;\n } else {\n- return x + 1.0;\n+ return (long)x + 1.0;\n }\n \n case DOWN:\n@@ -83,7 +83,7 @@ static double roundIntermediate(double x, RoundingMode mode) {\n if (isMathematicalInteger(x)) {\n return x;\n } else {\n- return x + Math.copySign(1.0, x);\n+ return (long)x + Math.copySign(1.0, x);\n }\n \n case HALF_EVEN:",
"filename": "guava/src/com/google/common/math/DoubleMath.java",
"status": "modified"
}
]
} |
{
"body": "Not a high priority. I just feel a little bad that users there would get something like \"com.google.common.base.Stopwatch@0xdeadbeef\".\n",
"comments": [
{
"body": "Hello @cpovirk, I was trying to implement a speculative fix for this issue and make a pull request.\n\nThe issue that I am facing is that some classes are not present in this repository, while cloning `https://code.google.com/p/guava-libraries/` as in the [ContributorSetUp](https://github.com/google/guava/wiki/ContributorSetUp) page in the wiki has them.\nThis mismatch is an issue because I can't make a pull request on those files.\n\nIn detail, I was editing:\n- `/guava-gwt/src-super/com/google/common/base/super/com/google/common/base/Stopwatch.java`\n- `/guava-gwt/test-super/com/google/common/base/super/com/google/common/base/StopwatchTest.java`\n- `/guava-gwt/test/com/google/common/base/StopwatchTest_gwt.java`\n\nand the first two of these are missing.\n\nAre these the right classes to edit? Can you help me in any way? \n\nThanks\n",
"created_at": "2016-02-28T10:13:58Z"
},
{
"body": "@mardibiase\n\nFirst, sorry: It looks like `ContributorSetUp` is out of date. I've filed https://github.com/google/guava/issues/2405 for us to update it. For now, just ignore them. The files you're interested in don't exist anymore.\n\nSecond, as a general rule, we try not to maintain parallel copies of our classes for GWT and server. [Sometimes](https://github.com/google/guava/tree/master/guava-gwt/src-super/com/google/common) we have to, but usually we just hide the platform-specific code behind a method in the an aptly named `Platform` class. You would create something like `Platform.stopwatchToString(Stopwatch)` with separate implementations in the [server](https://github.com/google/guava/blob/master/guava/src/com/google/common/base/Platform.java) and [GWT](https://github.com/google/guava/blob/master/guava-gwt/src-super/com/google/common/base/super/com/google/common/base/Platform.java) copies.\n\nAlternatively, you could look for a way to implement `Stopwatch.toString` itself in a GWT-compatible way, maybe with some multiplication and rounding. We _might_ even be to tolerate slightly changes in rounding in the output if it helps.\n",
"created_at": "2016-03-01T18:52:02Z"
}
],
"number": 2365,
"title": "Implement Stopwatch.toString() under GWT"
} | {
"body": "Fix for #2365 \n",
"number": 2437,
"review_comments": [],
"title": "Speculative fix for issue 2365"
} | {
"commits": [
{
"message": "Speculative fix for issue 2365"
}
],
"files": [
{
"diff": "@@ -14,4 +14,7 @@ out/\n .classpath\n .project\n .settings/\n-.metadata/\n\\ No newline at end of file\n+.metadata/\n+\n+#.DS_Store\n+.DS_Store\n\\ No newline at end of file",
"filename": ".gitignore",
"status": "modified"
},
{
"diff": "@@ -17,6 +17,7 @@\n package com.google.common.base;\n \n import java.util.concurrent.TimeUnit;\n+import com.google.gwt.i18n.client.NumberFormat;\n \n /**\n * @author Jesse Wilson\n@@ -43,6 +44,12 @@ static <T extends Enum<T>> Optional<T> getEnumIfPresent(Class<T> enumClass, Stri\n return Optional.absent();\n }\n }\n+ \n+ static String stopwatchToString(double value){\n+ // String.format() is not availabel in GWT, so we use\n+ // NumberFormat.getFormat() from google.gwt.i18n\n+\t return NumberFormat.getFormat(\"0.000\").format(value).substring(0,5);\n+ }\n \n private Platform() {}\n }",
"filename": "guava-gwt/src-super/com/google/common/base/super/com/google/common/base/Platform.java",
"status": "modified"
},
{
"diff": "@@ -92,4 +92,9 @@ public void testStop_new() throws Exception {\n com.google.common.base.StopwatchTest testCase = new com.google.common.base.StopwatchTest();\n testCase.testStop_new();\n }\n+\n+public void testToString() throws Exception {\n+ com.google.common.base.StopwatchTest testCase = new com.google.common.base.StopwatchTest();\n+ testCase.testToString();\n+}\n }",
"filename": "guava-gwt/test/com/google/common/base/StopwatchTest_gwt.java",
"status": "modified"
},
{
"diff": "@@ -21,7 +21,7 @@\n import static java.util.concurrent.TimeUnit.NANOSECONDS;\n \n import com.google.common.annotations.GwtCompatible;\n-import com.google.common.annotations.GwtIncompatible;\n+//import com.google.common.annotations.GwtIncompatible;\n import com.google.common.testing.FakeTicker;\n \n import junit.framework.TestCase;\n@@ -168,7 +168,7 @@ public void testElapsed_millis() {\n assertEquals(1, stopwatch.elapsed(MILLISECONDS));\n }\n \n- @GwtIncompatible // String.format()\n+ //@GwtIncompatible // String.format()\n public void testToString() {\n stopwatch.start();\n assertEquals(\"0.000 ns\", stopwatch.toString());",
"filename": "guava-tests/test/com/google/common/base/StopwatchTest.java",
"status": "modified"
},
{
"diff": "@@ -19,6 +19,7 @@\n import com.google.common.annotations.GwtCompatible;\n \n import java.lang.ref.WeakReference;\n+import java.util.Locale;\n \n /**\n * Methods factored out so that they can be emulated differently in GWT.\n@@ -44,4 +45,8 @@ static <T extends Enum<T>> Optional<T> getEnumIfPresent(Class<T> enumClass, Stri\n ? Optional.<T>absent()\n : Optional.of(enumClass.cast(ref.get()));\n }\n+ \n+ static String stopwatchToString(double value){\n+\t return String.format(Locale.ROOT, \"%.4g\", value);\n+ }\n }",
"filename": "guava/src/com/google/common/base/Platform.java",
"status": "modified"
},
{
"diff": "@@ -27,10 +27,8 @@\n import static java.util.concurrent.TimeUnit.SECONDS;\n \n import com.google.common.annotations.GwtCompatible;\n-import com.google.common.annotations.GwtIncompatible;\n import com.google.errorprone.annotations.CanIgnoreReturnValue;\n \n-import java.util.Locale;\n import java.util.concurrent.TimeUnit;\n \n /**\n@@ -200,7 +198,7 @@ public long elapsed(TimeUnit desiredUnit) {\n /**\n * Returns a string representation of the current elapsed time.\n */\n- @GwtIncompatible // String.format()\n+ //@GwtIncompatible // String.format()\n @Override\n public String toString() {\n long nanos = elapsedNanos();\n@@ -209,7 +207,8 @@ public String toString() {\n double value = (double) nanos / NANOSECONDS.convert(1, unit);\n \n // Too bad this functionality is not exposed as a regular method call\n- return String.format(Locale.ROOT, \"%.4g %s\", value, abbreviate(unit));\n+ //return String.format(Locale.ROOT, \"%.4g %s\", value, abbreviate(unit));\n+ return Platform.stopwatchToString(value) + \" \" + abbreviate(unit);\n }\n \n private static TimeUnit chooseUnit(long nanos) {",
"filename": "guava/src/com/google/common/base/Stopwatch.java",
"status": "modified"
}
]
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.