Add "serialVersionUID" for exceptions to avoid InvalidClassException

[quaff]

Which problem is this PR solving?

avoid potential InvalidClassException when perform deserialization.

Short description of the changes

add generated serialVersionUID for exceptions.

[codecov]

Codecov Report

Merging #481 into master will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             master     #481   +/-   ##
=========================================
  Coverage     88.18%   88.18%           
  Complexity      495      495           
=========================================
  Files            64       64           
  Lines          1853     1853           
  Branches        241      241           
=========================================
  Hits           1634     1634           
  Misses          141      141           
  Partials         78       78

Impacted Files	Coverage Δ	Complexity Δ
...exceptions/BaggageRestrictionManagerException.java	100% <ø> (ø)	2 <0> (ø)	⬇️
...al/exceptions/EmptyTracerStateStringException.java	100% <ø> (ø)	1 <0> (ø)	⬇️
...nal/exceptions/SamplingStrategyErrorException.java	100% <ø> (ø)	2 <0> (ø)	⬇️
...xceptions/MalformedTracerStateStringException.java	100% <ø> (ø)	1 <0> (ø)	⬇️
...nternal/exceptions/UnsupportedFormatException.java	0% <ø> (ø)	0 <0> (ø)	⬇️
...rtracing/internal/exceptions/EmptyIpException.java	100% <ø> (ø)	1 <0> (ø)	⬇️
...ng/internal/exceptions/NotFourOctetsException.java	100% <ø> (ø)	1 <0> (ø)	⬇️
...ertracing/internal/exceptions/SenderException.java	57.14% <ø> (ø)	2 <0> (ø)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4253325...aa0c639. Read the comment docs.

[pavolloffay]

@quaff hi, can I ask you about your serialization use case?

[jpkrohling]

LGTM

[quaff]

@pavolloffay please refer to https://stackoverflow.com/questions/285793/what-is-a-serialversionuid-and-why-should-i-use-it

[jpkrohling]

I don't think we'll ever need to serialize the exception (or any other class in this client, for that matter), but, having a serial version UID for Exceptions is indeed a good practice.

[quaff]

@jpkrohling It will used when perform RMI such as spring httpInvoker, exception will be serialized in server and deserialized in client, client rethrow it.

[pavolloffay]

@quaff thanks for the link. I am not asking why we should add serialization id, but how you are using jaeger client so you need the serialization.

[quaff]

@pavolloffay I'm using spring httpinvoker as microservice implementation, It use java serialization by default, exceptions will propagated from server to client.

[jpkrohling]

It will used when perform RMI such as spring httpInvoker

Interesting. I wouldn't expect the client to be remotely called, or that an exception on the client library to propagate way back to a remote caller, but it would certainly make sense.

I'm curious though: is this an actual scenario you faced, or is it theoretical? If you faced this issue, would you mind sharing more details (source code would be even better). We could then derive more tests from it (cc @jkandasa)

[quaff]

The problem is not jaeger specific, but I'm using jaeger for demonstration

public interface EchoService {

	String echo(String message);

}

public class EchoServiceImpl implements EchoService {

	@Override
	public String echo(String message) {
		try (Scope scope = GlobalTracer.get().scopeManager().activate(GlobalTracer.get().buildSpan("echo").start(),
				true)) {
			return message;
		}
	}

}

@Component
public class Test {

	@Autowired
	private EchoService echoService;

	public void test() {
		echoService.echo("something"); // exception from server will be thrown
	}

}

[quaff]

@jpkrohling It's not an actual scenario, I found it because eclipse reports warning, but I have faced same issue caused by missing serialVersionUID.

[jpkrohling]

Thanks @quaff !