jakartaee / jakartaee/websocket

`Annotated*Client` annotated with `ClientEndpoint` should not be included in the deployment

Open
#578 18 comments 0 reactions 0 assignees View on GitHub
challenge
Dominant language
Java
Stars
78
Forks
47
Avg merge
1h 32m
Merged PRs (30d)
1

Description

**Challenged tests**
* `com.sun.ts.tests.websocket.ee.jakarta.websocket.session11.client.WSCClientIT`

**TCK Version**
Jakarta WebSocket 2.2.0

**Description**
The `com.sun.ts.tests.websocket.ee.jakarta.websocket.session11.client.WSCClientIT` includes 3 client classes that are included in the deployment because they're in the `com.sun.ts.tests.websocket.ee.jakarta.websocket.session11.client` package. These 3 types should not be included as they're not needed in the deployment and only used on the client side.

* `com.sun.ts.tests.websocket.ee.jakarta.websocket.session11.client.AnnotatedBinaryClient`
* `com.sun.ts.tests.websocket.ee.jakarta.websocket.session11.client.AnnotatedTextClient`
* `com.sun.ts.tests.websocket.ee.jakarta.websocket.session11.client.AnnotatedThrowingClient`

The `com.sun.ts.tests.websocket.ee.jakarta.websocket.session11.client.AnnotatedThrowingClient` in the deployment which does not have a no-arg constructor. This causes the deployment to fail and thus the tests do not run. Per the [specification](https://jakarta.ee/specifications/websocket/2.2/jakarta-websocket-spec-2.2#clientendpoint):

> The class must have a public no-args constructor,

The other 2 have requirements on the following two types which are not included in the deploy:

* `com.sun.ts.tests.websocket.ee.jakarta.websocket.session11.common.AlternativeInputStreamDecoder.class`
* `com.sun.ts.tests.websocket.ee.jakarta.websocket.session11.common.AlternativeReaderDecoder.class`

Note I've updated the description here as I thought we needed to add the above two types to the deployment, see #579. However, it makes more sense to not include the clients in the deployment.

**Additional context**
The workaround is to remove the types from the deployment.

Contributor guide

Open the contributing guide

Research direction

Start with com.sun.ts.tests.websocket.ee.jakarta.websocket.session11.client.WSCClientIT and its deployment setup. Check how AnnotatedBinaryClient, AnnotatedTextClient, and AnnotatedThrowingClient are included, then run WSCClientIT to confirm they are excluded from deployment and the test completes without the constructor or decoder failures.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
testing-qa
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.