fix: pre-v0.1 review feedback (#14)

* fix(sdk-android): add @JvmOverloads to Uatu.start

Java callers can now invoke start(application) without supplying a
Configuration, matching the Kotlin default-arg ergonomics.

* feat(agent): add protocol_version to HELLO handshake

ProtocolVersion=1 lives on Message and is set by Hello(). Server.Accept
rejects mismatches with a clear error. SDK upgrades that don't change
the wire format keep the same protocol_version; bump on breaking changes.

* test(agent): assert protocol_version in Hello round-trip

* feat(sdk-android): send protocol_version=1 in HELLO

Mirrors agent.ProtocolVersion on the Go side. Bump in lockstep with
the Go constant when the wire format breaks.

* chore(sample-app): pull @uatu/spec from npm next tag

Replaces the file: dep. Copy-paste users can now npm install against
the registry. The release workflow publishes pre-release tags to
npm dist-tag 'next', so the sample tracks the latest rc without
manual version bumps. Lockfile currently resolves to 0.0.1-rc3.
This commit is contained in:
pj authored and GitHub committed 2026-04-18 18:00:12 +07:00
1 parent d0578dbaaa
commit 00f66ba48d
9 files changed
+67 -20

No files matched your search

+15 -4
View File
@@ -21,13 +21,18 @@ const (
const MaxFrameSize = 16 * 1024 * 1024
// ProtocolVersion is the wire-format version. Bump on any breaking change
// to the message schema or framing. Independent of the SDK release version.
const ProtocolVersion = 1
type Message struct {
Type MessageType `json:"type"`
ID uint64 `json:"id,omitempty"`
Version string `json:"version,omitempty"`
Platform string `json:"platform,omitempty"`
AppPackage string `json:"app_package,omitempty"`
ProtocolVersion int `json:"protocol_version,omitempty"`
Version string `json:"version,omitempty"`
Platform string `json:"platform,omitempty"`
AppPackage string `json:"app_package,omitempty"`
Snapshots map[string]json.RawMessage `json:"snapshots,omitempty"`
@@ -39,7 +44,13 @@ type Message struct {
}
func Hello(version, platform, appPackage string) Message {
return Message{Type: MessageTypeHello, Version: version, Platform: platform, AppPackage: appPackage}
return Message{
Type: MessageTypeHello,
ProtocolVersion: ProtocolVersion,
Version: version,
Platform: platform,
AppPackage: appPackage,
}
}
func Pause(id uint64) Message { return Message{Type: MessageTypePause, ID: id} }
+3
View File
@@ -28,6 +28,9 @@ func TestRoundTrip_Hello(t *testing.T) {
if got.Type != MessageTypeHello || got.Version != "0.0.1" || got.Platform != "android" || got.AppPackage != "in.okcredit.merchant" {
t.Fatalf("hello round-trip failed: %+v", got)
}
if got.ProtocolVersion != ProtocolVersion {
t.Errorf("protocol_version: got %d, want %d", got.ProtocolVersion, ProtocolVersion)
}
}
func TestRoundTrip_PauseResume(t *testing.T) {
+4
View File
@@ -41,6 +41,10 @@ func (s *Server) Accept(ctx context.Context) (*Conn, error) {
rawConn.Close()
return nil, fmt.Errorf("expected HELLO, got %q", hello.Type)
}
if hello.ProtocolVersion != ProtocolVersion {
rawConn.Close()
return nil, fmt.Errorf("protocol version mismatch: host=%d sdk=%d", ProtocolVersion, hello.ProtocolVersion)
}
return &Conn{rawConn: rawConn, hello: hello}, nil
}
+22
View File
@@ -141,6 +141,28 @@ func TestServer_SnapshotAndRelease(t *testing.T) {
wg.Wait()
}
func TestServer_AcceptRejectsProtocolVersionMismatch(t *testing.T) {
server := newLoopbackServer(t)
go func() {
client, err := net.Dial("tcp", server.Addr().String())
if err != nil {
return
}
defer client.Close()
mismatched := Hello("0.0.1", "android", "com.x")
mismatched.ProtocolVersion = ProtocolVersion + 99
_ = WriteMessage(client, mismatched)
}()
ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
defer cancel()
_, err := server.Accept(ctx)
if err == nil || !strings.Contains(err.Error(), "protocol version mismatch") {
t.Fatalf("expected protocol-version-mismatch error, got %v", err)
}
}
func TestServer_AcceptRequiresHello(t *testing.T) {
server := newLoopbackServer(t)