Author: markt
Date: Fri Dec 11 12:38:32 2015
New Revision: 1719400
URL: http://svn.apache.org/viewvc?rev=1719400&view=rev
Log:
Fix https://bz.apache.org/bugzilla/show_bug.cgi?id=57489
Ensure onClose() is called when a WebSocket connection is closed even if the
sending of the close message fails. Includes test cases by Barry Coughlan.
Added:
tomcat/tc8.0.x/trunk/test/org/apache/tomcat/websocket/server/TestClose.java
- copied, changed from r1717965,
tomcat/trunk/test/org/apache/tomcat/websocket/server/TestClose.java
tomcat/tc8.0.x/trunk/test/org/apache/tomcat/websocket/server/TesterWsCloseClient.java
- copied unchanged from r1717965,
tomcat/trunk/test/org/apache/tomcat/websocket/server/TesterWsCloseClient.java
Modified:
tomcat/tc8.0.x/trunk/ (props changed)
tomcat/tc8.0.x/trunk/java/org/apache/tomcat/websocket/WsRemoteEndpointImplBase.java
tomcat/tc8.0.x/trunk/java/org/apache/tomcat/websocket/WsSession.java
tomcat/tc8.0.x/trunk/java/org/apache/tomcat/websocket/server/WsHttpUpgradeHandler.java
tomcat/tc8.0.x/trunk/webapps/docs/changelog.xml
Propchange: tomcat/tc8.0.x/trunk/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Fri Dec 11 12:38:32 2015
@@ -1 +1 @@
-/tomcat/trunk:1636524,1637156,1637176,1637188,1637331,1637684,1637695,1638720-1638725,1639653,1640010,1640083-1640084,1640088,1640275,1640322,1640347,1640361,1640365,1640403,1640410,1640652,1640655-1640658,1640688,1640700-1640883,1640903,1640976,1640978,1641000,1641026,1641038-1641039,1641051-1641052,1641058,1641064,1641300,1641369,1641374,1641380,1641486,1641634,1641656-1641692,1641704,1641707-1641718,1641720-1641722,1641735,1641981,1642233,1642280,1642554,1642564,1642595,1642606,1642668,1642679,1642697,1642699,1642766,1643002,1643045,1643054-1643055,1643066,1643121,1643128,1643206,1643209-1643210,1643216,1643249,1643270,1643283,1643309-1643310,1643323,1643365-1643366,1643370-1643371,1643465,1643474,1643536,1643570,1643634,1643649,1643651,1643654,1643675,1643731,1643733-1643734,1643761,1643766,1643814,1643937,1643963,1644017,1644169,1644201-1644203,1644321,1644323,1644516,1644523,1644529,1644535,1644730,1644768,1644784-1644785,1644790,1644793,1644815,1644884,1644886,1644890,1644892
,1644910,1644924,1644929-1644930,1644935,1644989,1645011,1645247,1645355,1645357-1645358,1645455,1645465,1645469,1645471,1645473,1645475,1645486-1645488,1645626,1645641,1645685,1645743,1645763,1645951-1645953,1645955,1645993,1646098-1646106,1646178,1646220,1646302,1646304,1646420,1646470-1646471,1646476,1646559,1646717-1646723,1646773,1647026,1647042,1647530,1647655,1648304,1648815,1648907,1649973,1650081,1650365,1651116,1651120,1651280,1651470,1652938,1652970,1653041,1653471,1653550,1653574,1653797,1653815-1653816,1653819,1653840,1653857,1653888,1653972,1654013,1654030,1654050,1654123,1654148,1654159,1654513,1654515,1654517,1654522,1654524,1654725,1654735,1654766,1654785,1654851-1654852,1654978,1655122-1655124,1655126-1655127,1655129-1655130,1655132-1655133,1655312,1655351,1655438,1655441,1655454,1655558,1656087,1656299,1656319,1656331,1656345,1656350,1656590,1656648-1656650,1656657,1657041,1657054,1657374,1657492,1657510,1657565,1657580,1657584,1657586,1657589,1657592,1657607,1657
609,1657682,1657907,1658207,1658734,1658781,1658790,1658799,1658802,1658804,1658833,1658840,1658966,1659043,1659053,1659059,1659174,1659184,1659188-1659189,1659216,1659263,1659293,1659304,1659306-1659307,1659382,1659384,1659428,1659471,1659486,1659505,1659516,1659521,1659524,1659559,1659562,1659803,1659806,1659814,1659833,1659862,1659905,1659919,1659948,1659967,1659983-1659984,1660060,1660074,1660077,1660133,1660168,1660331-1660332,1660353,1660358,1660924,1661386,1661770,1661867,1661972,1661990,1662200,1662308-1662309,1662548,1662614,1662696,1662736,1662985,1662988-1662989,1663264,1663277,1663298,1663534,1663562,1663676,1663715,1663754,1663768,1663772,1663781,1663893,1663995,1664143,1664163,1664174,1664301,1664317,1664347,1664657,1664659,1664710,1664863-1664864,1664866,1665085,1665292,1665559,1665653,1665661,1665672,1665694,1665697,1665736,1665779,1665976-1665977,1665980-1665981,1665985-1665986,1665989,1665998,1666004,1666008,1666013,1666017,1666024,1666116,1666386-1666387,1666494,1
666496,1666552,1666569,1666579,1666637,1666649,1666757,1666966,1666972,1666985,1666995,1666997,1667292,1667402,1667406,1667546,1667615,1667630,1667636,1667688,1667764,1667871,1668026,1668135,1668193,1668593,1668596,1668630,1668639,1668843,1669353,1669370,1669451,1669800,1669838,1669876,1669882,1670394,1670433,1670591,1670598-1670600,1670610,1670631,1670719,1670724,1670726,1670730,1670940,1671112,1672272,1672284,1673754,1674294,1675461,1675486,1675594,1675830,1676231,1676250-1676251,1676364,1676381,1676393,1676479,1676525,1676552,1676615,1676630,1676634,1676721,1676926,1676943,1677140,1677802,1678011,1678162,1678174,1678339,1678426-1678427,1678694,1678701,1679534,1679708,1679710,1679716,1680034,1680246,1681056,1681123,1681138,1681280,1681283,1681286,1681450,1681697,1681701,1681729,1681770,1681779,1681793,1681807,1681837-1681838,1681854,1681862,1681958,1682028,1682033,1682311,1682315,1682317,1682320,1682324,1682330,1682842,1684172,1684366,1684383,1684526-1684527,1684549-1684550,168555
6,1685591,1685739,1685744,1685772,1685816,1685826,1685891,1687242,1687261,1687268,1687340,1687551,1688563,1688841,1688878,1688885,1688896,1688901,1689345-1689346,1689357,1689656,1689675-1689677,1689679,1689687,1689825,1689856,1689918,1690011,1690021,1690054,1690080,1690209,1691134,1691487,1691813,1692744-1692747,1692849,1693088,1693105,1693429,1693461,1694058,1694111,1694290,1694501,1694548,1694658,1694660,1694788,1694872,1694878,1695006,1695354,1695371,1695379,1695459,1695582,1695706,1695778,1696199,1696272,1696280,1696366-1696368,1696378,1696390,1696392,1696467,1698212,1698220,1700607,1700870,1700896,1700977,1701093,1701123,1701213,1701607,1701666,1701673,1701760-1701761,1701765,1701940,1702092,1702183,1702244,1702246,1702250,1702268,1702313,1702531,1702630-1702635,1702637-1702638,1702640,1702647,1702660,1702662,1702665-1702666,1702668,1702671-1702673,1702675-1702676,1702680,1702722,1702778,1702795,1702862,1702881,1702886,1702910,1702923,1702971,1702984,1703024,1703040,1703044,170
3049-1703050,1703143,1703146,1703151,1703160,1703164,1703167,1703174,1703192,1703287,1703290,1703358,1703408,1703486,1703509,1703523,1703542,1703545,1703554,1703584,1703673,1703676,1703678,1703680,1703763,1703784,1703821,1703842,1703849,1703851,1703853,1703856,1703860,1703865,1703890,1703948,1704149,1704151,1704251,1704278,1704289,1704302,1704305,1704307,1704318,1704331,1704647,1704658,1704689,1704702,1704706,1704711,1704730-1704733,1704735,1704739,1704741-1704742,1704744,1704786,1704867,1705231,1705630,1705635,1705639,1705647,1705650-1705652,1705842,1705848,1705865-1705866,1705942,1706017,1706744-1706745,1706853,1706915,1707052,1707088,1708500-1708501,1708504-1708505,1708570,1708649,1708687,1708745,1708957,1709120,1709266,1709295,1709375,1709663,1709895,1709960,1710070,1710134,1710341,1710346,1710441,1710445,1710489,1710517,1710523,1710571,1710577,1710632,1710676,1710689,1710753-1710754,1710779,1710924,1710930,1710933,1710945,1711006,1711016,1711022,1711026,1712163,1712225,1712228,
1712233,1712250,1712254,1712489,1712547-1712548,1712588,1712617,1712645,1712654,1712695,1712765-1712766,1712771,1712775,1712859,1712876,1712898,1712902,1712905,1712912,1712974,1713129,1713168,1713184,1713285,1713362,1713612,1713618,1713871,1713931,1713975,1713987,1713992,1713997,1714002,1714012,1714019,1714054,1714521,1714535,1714537,1715188,1715206,1715413,1715415,1715510-1715512,1715514-1715515,1715517-1715519,1715521,1715633,1715661,1715682,1715965,1716213-1716214,1716258,1716269,1716347,1716354,1716364,1716413,1716420,1716511,1716543,1716640,1716644,1716856,1716858,1716881-1716882,1716886,1716894,1717085,1717225,1717233,1717252,1717264,1717282,1717286,1717290,1717385,1717416,1717418,1717445,1717515,1717520,1717528,1718022,1718308,1718523,1718794,1718796,1718834,1718836-1718838
+/tomcat/trunk:1636524,1637156,1637176,1637188,1637331,1637684,1637695,1638720-1638725,1639653,1640010,1640083-1640084,1640088,1640275,1640322,1640347,1640361,1640365,1640403,1640410,1640652,1640655-1640658,1640688,1640700-1640883,1640903,1640976,1640978,1641000,1641026,1641038-1641039,1641051-1641052,1641058,1641064,1641300,1641369,1641374,1641380,1641486,1641634,1641656-1641692,1641704,1641707-1641718,1641720-1641722,1641735,1641981,1642233,1642280,1642554,1642564,1642595,1642606,1642668,1642679,1642697,1642699,1642766,1643002,1643045,1643054-1643055,1643066,1643121,1643128,1643206,1643209-1643210,1643216,1643249,1643270,1643283,1643309-1643310,1643323,1643365-1643366,1643370-1643371,1643465,1643474,1643536,1643570,1643634,1643649,1643651,1643654,1643675,1643731,1643733-1643734,1643761,1643766,1643814,1643937,1643963,1644017,1644169,1644201-1644203,1644321,1644323,1644516,1644523,1644529,1644535,1644730,1644768,1644784-1644785,1644790,1644793,1644815,1644884,1644886,1644890,1644892
,1644910,1644924,1644929-1644930,1644935,1644989,1645011,1645247,1645355,1645357-1645358,1645455,1645465,1645469,1645471,1645473,1645475,1645486-1645488,1645626,1645641,1645685,1645743,1645763,1645951-1645953,1645955,1645993,1646098-1646106,1646178,1646220,1646302,1646304,1646420,1646470-1646471,1646476,1646559,1646717-1646723,1646773,1647026,1647042,1647530,1647655,1648304,1648815,1648907,1649973,1650081,1650365,1651116,1651120,1651280,1651470,1652938,1652970,1653041,1653471,1653550,1653574,1653797,1653815-1653816,1653819,1653840,1653857,1653888,1653972,1654013,1654030,1654050,1654123,1654148,1654159,1654513,1654515,1654517,1654522,1654524,1654725,1654735,1654766,1654785,1654851-1654852,1654978,1655122-1655124,1655126-1655127,1655129-1655130,1655132-1655133,1655312,1655351,1655438,1655441,1655454,1655558,1656087,1656299,1656319,1656331,1656345,1656350,1656590,1656648-1656650,1656657,1657041,1657054,1657374,1657492,1657510,1657565,1657580,1657584,1657586,1657589,1657592,1657607,1657
609,1657682,1657907,1658207,1658734,1658781,1658790,1658799,1658802,1658804,1658833,1658840,1658966,1659043,1659053,1659059,1659174,1659184,1659188-1659189,1659216,1659263,1659293,1659304,1659306-1659307,1659382,1659384,1659428,1659471,1659486,1659505,1659516,1659521,1659524,1659559,1659562,1659803,1659806,1659814,1659833,1659862,1659905,1659919,1659948,1659967,1659983-1659984,1660060,1660074,1660077,1660133,1660168,1660331-1660332,1660353,1660358,1660924,1661386,1661770,1661867,1661972,1661990,1662200,1662308-1662309,1662548,1662614,1662696,1662736,1662985,1662988-1662989,1663264,1663277,1663298,1663534,1663562,1663676,1663715,1663754,1663768,1663772,1663781,1663893,1663995,1664143,1664163,1664174,1664301,1664317,1664347,1664657,1664659,1664710,1664863-1664864,1664866,1665085,1665292,1665559,1665653,1665661,1665672,1665694,1665697,1665736,1665779,1665976-1665977,1665980-1665981,1665985-1665986,1665989,1665998,1666004,1666008,1666013,1666017,1666024,1666116,1666386-1666387,1666494,1
666496,1666552,1666569,1666579,1666637,1666649,1666757,1666966,1666972,1666985,1666995,1666997,1667292,1667402,1667406,1667546,1667615,1667630,1667636,1667688,1667764,1667871,1668026,1668135,1668193,1668593,1668596,1668630,1668639,1668843,1669353,1669370,1669451,1669800,1669838,1669876,1669882,1670394,1670433,1670591,1670598-1670600,1670610,1670631,1670719,1670724,1670726,1670730,1670940,1671112,1672272,1672284,1673754,1674294,1675461,1675486,1675594,1675830,1676231,1676250-1676251,1676364,1676381,1676393,1676479,1676525,1676552,1676615,1676630,1676634,1676721,1676926,1676943,1677140,1677802,1678011,1678162,1678174,1678339,1678426-1678427,1678694,1678701,1679534,1679708,1679710,1679716,1680034,1680246,1681056,1681123,1681138,1681280,1681283,1681286,1681450,1681697,1681701,1681729,1681770,1681779,1681793,1681807,1681837-1681838,1681854,1681862,1681958,1682028,1682033,1682311,1682315,1682317,1682320,1682324,1682330,1682842,1684172,1684366,1684383,1684526-1684527,1684549-1684550,168555
6,1685591,1685739,1685744,1685772,1685816,1685826,1685891,1687242,1687261,1687268,1687340,1687551,1688563,1688841,1688878,1688885,1688896,1688901,1689345-1689346,1689357,1689656,1689675-1689677,1689679,1689687,1689825,1689856,1689918,1690011,1690021,1690054,1690080,1690209,1691134,1691487,1691813,1692744-1692747,1692849,1693088,1693105,1693429,1693461,1694058,1694111,1694290,1694501,1694548,1694658,1694660,1694788,1694872,1694878,1695006,1695354,1695371,1695379,1695459,1695582,1695706,1695778,1696199,1696272,1696280,1696366-1696368,1696378,1696390,1696392,1696467,1698212,1698220,1700607,1700870,1700896,1700977,1701093,1701123,1701213,1701607,1701666,1701673,1701760-1701761,1701765,1701940,1702092,1702183,1702244,1702246,1702250,1702268,1702313,1702531,1702630-1702635,1702637-1702638,1702640,1702647,1702660,1702662,1702665-1702666,1702668,1702671-1702673,1702675-1702676,1702680,1702722,1702778,1702795,1702862,1702881,1702886,1702910,1702923,1702971,1702984,1703024,1703040,1703044,170
3049-1703050,1703143,1703146,1703151,1703160,1703164,1703167,1703174,1703192,1703287,1703290,1703358,1703408,1703486,1703509,1703523,1703542,1703545,1703554,1703584,1703673,1703676,1703678,1703680,1703763,1703784,1703821,1703842,1703849,1703851,1703853,1703856,1703860,1703865,1703890,1703948,1704149,1704151,1704251,1704278,1704289,1704302,1704305,1704307,1704318,1704331,1704647,1704658,1704689,1704702,1704706,1704711,1704730-1704733,1704735,1704739,1704741-1704742,1704744,1704786,1704867,1705231,1705630,1705635,1705639,1705647,1705650-1705652,1705842,1705848,1705865-1705866,1705942,1706017,1706744-1706745,1706853,1706915,1707052,1707088,1708500-1708501,1708504-1708505,1708570,1708649,1708687,1708745,1708957,1709120,1709266,1709295,1709375,1709663,1709895,1709960,1710070,1710134,1710341,1710346,1710441,1710445,1710489,1710517,1710523,1710571,1710577,1710632,1710676,1710689,1710753-1710754,1710779,1710924,1710930,1710933,1710945,1711006,1711016,1711022,1711026,1712163,1712225,1712228,
1712233,1712250,1712254,1712489,1712547-1712548,1712588,1712617,1712645,1712654,1712695,1712765-1712766,1712771,1712775,1712859,1712876,1712898,1712902,1712905,1712912,1712974,1713129,1713168,1713184,1713285,1713362,1713612,1713618,1713871,1713931,1713975,1713987,1713992,1713997,1714002,1714012,1714019,1714054,1714521,1714535,1714537,1715188,1715206,1715413,1715415,1715510-1715512,1715514-1715515,1715517-1715519,1715521,1715633,1715661,1715682,1715965,1716213-1716214,1716258,1716269,1716347,1716354,1716364,1716413,1716420,1716511,1716543,1716640,1716644,1716856,1716858,1716881-1716882,1716886,1716894,1717085,1717225,1717233,1717252,1717264,1717282,1717286,1717290,1717385,1717416,1717418,1717445,1717515,1717520,1717528,1717965,1717967-1717968,1717979,1718022,1718308,1718523,1718794,1718796,1718834,1718836-1718838,1719291,1719315,1719332,1719334,1719340,1719346
Modified:
tomcat/tc8.0.x/trunk/java/org/apache/tomcat/websocket/WsRemoteEndpointImplBase.java
URL:
http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/tomcat/websocket/WsRemoteEndpointImplBase.java?rev=1719400&r1=1719399&r2=1719400&view=diff
==============================================================================
---
tomcat/tc8.0.x/trunk/java/org/apache/tomcat/websocket/WsRemoteEndpointImplBase.java
(original)
+++
tomcat/tc8.0.x/trunk/java/org/apache/tomcat/websocket/WsRemoteEndpointImplBase.java
Fri Dec 11 12:38:32 2015
@@ -33,6 +33,8 @@ import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import java.util.concurrent.atomic.AtomicBoolean;
+import javax.websocket.CloseReason;
+import javax.websocket.CloseReason.CloseCodes;
import javax.websocket.DeploymentException;
import javax.websocket.EncodeException;
import javax.websocket.Encoder;
@@ -255,7 +257,7 @@ public abstract class WsRemoteEndpointIm
}
} catch (InterruptedException | ExecutionException |
TimeoutException e) {
- throw new IOException(e);
+ handleSendFailure(e);
}
}
@@ -279,7 +281,7 @@ public abstract class WsRemoteEndpointIm
}
} catch (InterruptedException | ExecutionException |
TimeoutException e) {
- throw new IOException(e);
+ handleSendFailure(e);
}
}
@@ -519,20 +521,43 @@ public abstract class WsRemoteEndpointIm
Future<Void> f = sendObjectByFuture(obj);
try {
f.get();
- } catch (InterruptedException e) {
+ } catch (InterruptedException | ExecutionException e) {
+ handleSendFailureWithEncode(e);
+ }
+ }
+
+
+ private void handleSendFailure(Throwable t) throws IOException {
+ try {
+ handleSendFailureWithEncode(t);
+ } catch (EncodeException e) {
+ // Should never happen. But in case it does...
throw new IOException(e);
- } catch (ExecutionException e) {
- Throwable cause = e.getCause();
- if (cause instanceof IOException) {
- throw (IOException) cause;
- } else if (cause instanceof EncodeException) {
- throw (EncodeException) cause;
- } else {
- throw new IOException(e);
- }
}
}
+
+ private void handleSendFailureWithEncode(Throwable t) throws IOException,
EncodeException {
+ // First, unwrap any execution exception
+ if (t instanceof ExecutionException) {
+ t = t.getCause();
+ }
+
+ // Close the session
+ wsSession.doClose(new CloseReason(CloseCodes.GOING_AWAY,
t.getMessage()),
+ new CloseReason(CloseCodes.CLOSED_ABNORMALLY, t.getMessage()));
+
+ // Rethrow the exception
+ if (t instanceof EncodeException) {
+ throw (EncodeException) t;
+ }
+ if (t instanceof IOException) {
+ throw (IOException) t;
+ }
+ throw new IOException(t);
+ }
+
+
public Future<Void> sendObjectByFuture(Object obj) {
FutureToSendHandler f2sh = new FutureToSendHandler(wsSession);
sendObjectByCompletion(obj, f2sh);
Modified: tomcat/tc8.0.x/trunk/java/org/apache/tomcat/websocket/WsSession.java
URL:
http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/tomcat/websocket/WsSession.java?rev=1719400&r1=1719399&r2=1719400&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/java/org/apache/tomcat/websocket/WsSession.java
(original)
+++ tomcat/tc8.0.x/trunk/java/org/apache/tomcat/websocket/WsSession.java Fri
Dec 11 12:38:32 2015
@@ -461,7 +461,7 @@ public class WsSession implements Sessio
* Need internal close method as spec requires that the local endpoint
* receives a 1006 on timeout.
*/
- private void doClose(CloseReason closeReasonMessage,
+ public void doClose(CloseReason closeReasonMessage,
CloseReason closeReasonLocal) {
// Double-checked locking. OK because state is volatile
if (state != State.OPEN) {
@@ -516,9 +516,10 @@ public class WsSession implements Sessio
fireEndpointOnError(e);
}
if (state == State.OPEN) {
+ state = State.OUTPUT_CLOSED;
sendCloseMessage(closeReason);
+ fireEndpointOnClose(closeReason);
}
- fireEndpointOnClose(closeReason);
state = State.CLOSED;
// Close the socket
Modified:
tomcat/tc8.0.x/trunk/java/org/apache/tomcat/websocket/server/WsHttpUpgradeHandler.java
URL:
http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/tomcat/websocket/server/WsHttpUpgradeHandler.java?rev=1719400&r1=1719399&r2=1719400&view=diff
==============================================================================
---
tomcat/tc8.0.x/trunk/java/org/apache/tomcat/websocket/server/WsHttpUpgradeHandler.java
(original)
+++
tomcat/tc8.0.x/trunk/java/org/apache/tomcat/websocket/server/WsHttpUpgradeHandler.java
Fri Dec 11 12:38:32 2015
@@ -147,6 +147,9 @@ public class WsHttpUpgradeHandler implem
private void onError(Throwable throwable) {
+ wsSession.doClose(new CloseReason(CloseCodes.GOING_AWAY,
throwable.getMessage()),
+ new CloseReason(CloseCodes.CLOSED_ABNORMALLY,
throwable.getMessage()));
+
ep.onError(wsSession, throwable);
}
Copied:
tomcat/tc8.0.x/trunk/test/org/apache/tomcat/websocket/server/TestClose.java
(from r1717965,
tomcat/trunk/test/org/apache/tomcat/websocket/server/TestClose.java)
URL:
http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/test/org/apache/tomcat/websocket/server/TestClose.java?p2=tomcat/tc8.0.x/trunk/test/org/apache/tomcat/websocket/server/TestClose.java&p1=tomcat/trunk/test/org/apache/tomcat/websocket/server/TestClose.java&r1=1717965&r2=1719400&rev=1719400&view=diff
==============================================================================
--- tomcat/trunk/test/org/apache/tomcat/websocket/server/TestClose.java
(original)
+++ tomcat/tc8.0.x/trunk/test/org/apache/tomcat/websocket/server/TestClose.java
Fri Dec 11 12:38:32 2015
@@ -35,7 +35,7 @@ import javax.websocket.server.ServerEndp
import org.junit.Assert;
import org.junit.Before;
-import org.junit.Ignore;
+//import org.junit.Ignore;
import org.junit.Test;
import org.apache.catalina.Context;
@@ -43,15 +43,19 @@ import org.apache.catalina.LifecycleExce
import org.apache.catalina.servlets.DefaultServlet;
import org.apache.catalina.startup.Tomcat;
import org.apache.catalina.startup.TomcatBaseTest;
+import org.apache.juli.logging.Log;
+import org.apache.juli.logging.LogFactory;
/**
* Test the behavior of closing websockets under various conditions.
*/
-@Ignore // Only because they don't pass at the moment.
+//@Ignore // Only because they don't pass at the moment.
public class TestClose extends TomcatBaseTest {
- // TODO: These are static because I'm not sure how to inject them to the
- // endpoint
+ private static Log log = LogFactory.getLog(TestClose.class);
+
+ // These are static because it is simpler than trying to inject them into
+ // the endpoint
private static volatile Events events;
@@ -76,7 +80,7 @@ public class TestClose extends TomcatBas
private static void awaitLatch(CountDownLatch latch, String failMessage) {
try {
- if (!latch.await(3000, TimeUnit.MILLISECONDS)) {
+ if (!latch.await(5000, TimeUnit.MILLISECONDS)) {
Assert.fail(failMessage);
}
} catch (InterruptedException e) {
@@ -95,7 +99,8 @@ public class TestClose extends TomcatBas
public static void awaitOnError(Class<? extends Throwable> exceptionClazz)
{
awaitLatch(events.onErrorCalled, "onError not called");
- Assert.assertEquals(exceptionClazz,
events.onErrorThrowable.getClass());
+ Assert.assertTrue(exceptionClazz.getName(),
+
events.onErrorThrowable.getClass().isAssignableFrom(exceptionClazz));
}
@@ -155,7 +160,7 @@ public class TestClose extends TomcatBas
client.sendCloseFrame(CloseCodes.GOING_AWAY);
client.forceCloseSocket();
- //TODO: Why CLOSED_ABNORMALLY when above is GOING_AWAY?
+ // WebSocket 1.1, section 2.1.5 requires this to be CLOSED_ABNORMALLY
awaitOnClose(CloseCodes.CLOSED_ABNORMALLY);
}
@@ -194,7 +199,23 @@ public class TestClose extends TomcatBas
@Test
- public void testWsCloseThenTcpCloseInOnMessage() throws Exception {
+ public void testTcpCloseWhenOnMessageSends() throws Exception {
+ events.onMessageSends = true;
+ testTcpCloseInOnMessage();
+ }
+
+
+ @Test
+ public void testTcpResetWhenOnMessageSends() throws Exception {
+ events.onMessageSends = true;
+ testTcpResetInOnMessage();
+ }
+
+
+ @Test
+ public void testWsCloseThenTcpCloseWhenOnMessageSends() throws Exception {
+ events.onMessageSends = true;
+
startServer(TestEndpointConfig.class);
TesterWsCloseClient client = new TesterWsCloseClient("localhost",
getPort());
@@ -211,7 +232,9 @@ public class TestClose extends TomcatBas
@Test
- public void testWsCloseThenTcpResetInOnMessage() throws Exception {
+ public void testWsCloseThenTcpResetWhenOnMessageSends() throws Exception {
+ events.onMessageSends = true;
+
startServer(TestEndpointConfig.class);
TesterWsCloseClient client = new TesterWsCloseClient("localhost",
getPort());
@@ -227,44 +250,16 @@ public class TestClose extends TomcatBas
}
- @Test
- public void testTcpCloseWhenOnMessageSends() throws Exception {
- events.onMessageSends = true;
- testTcpCloseInOnMessage();
- }
-
-
- @Test
- public void testTcpResetWhenOnMessageSends() throws Exception {
- events.onMessageSends = true;
- testTcpResetInOnMessage();
- }
-
-
- @Test
- public void testWsCloseThenTcpCloseWhenOnMessageSends() throws Exception {
- events.onMessageSends = true;
- testWsCloseThenTcpCloseInOnMessage();
- }
-
-
- @Test
- public void testWsCloseThenTcpResetWhenOnMessageSends() throws Exception {
- events.onMessageSends = true;
- testWsCloseThenTcpResetInOnMessage();
- }
-
-
public static class TestEndpoint {
@OnOpen
public void onOpen() {
- System.out.println("Session opened");
+ log.info("Session opened");
}
@OnMessage
public void onMessage(Session session, String message) {
- System.out.println("Message received: " + message);
+ log.info("Message received: " + message);
events.onMessageCalled.countDown();
awaitLatch(events.onMessageWait, "onMessageWait not triggered");
@@ -279,14 +274,14 @@ public class TestClose extends TomcatBas
@OnError
public void onError(Throwable t) {
- System.out.println("onError: " + t.getMessage());
+ log.info("onError: " + t.getMessage());
events.onErrorThrowable = t;
events.onErrorCalled.countDown();
}
@OnClose
public void onClose(CloseReason cr) {
- System.out.println("onClose: " + cr);
+ log.info("onClose: " + cr);
events.closeReason = cr;
events.onCloseCalled.countDown();
}
Modified: tomcat/tc8.0.x/trunk/webapps/docs/changelog.xml
URL:
http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/webapps/docs/changelog.xml?rev=1719400&r1=1719399&r2=1719400&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/webapps/docs/changelog.xml (original)
+++ tomcat/tc8.0.x/trunk/webapps/docs/changelog.xml Fri Dec 11 12:38:32 2015
@@ -59,6 +59,15 @@
</fix>
</changelog>
</subsection>
+ <subsection name="WebSocket">
+ <changelog>
+ <fix>
+ <bug>57489</bug>: Ensure <code>onClose()</code> is called when a
+ WebSocket connection is closed even if the sending of the close message
+ fails. Includes test cases by Barry Coughlan. (markt)
+ </fix>
+ </changelog>
+ </subsection>
<subsection name="Web Applications">
<changelog>
<add>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
