From 888cb0fbfc84c82c0cc9c4886c5844cd83888abe Mon Sep 17 00:00:00 2001 From: Bernard Gawor Date: Mon, 26 Jan 2026 12:17:14 +0100 Subject: [PATCH 1/3] add deprecation warning field --- doc/docs.md | 1 + fishjam/peer_notifications.proto | 1 + fishjam_protos/lib/fishjam/peer_notifications.pb.ex | 1 + 3 files changed, 3 insertions(+) diff --git a/doc/docs.md b/doc/docs.md index 4bad46c..d2a7906 100644 --- a/doc/docs.md +++ b/doc/docs.md @@ -1190,6 +1190,7 @@ Response sent by FJ, confirming successful authentication | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | room_type | [PeerMessage.RoomType](#fishjam-PeerMessage-RoomType) | | | +| sdk_deprecation_warning | [string](#string) | | | diff --git a/fishjam/peer_notifications.proto b/fishjam/peer_notifications.proto index d0028ce..216694e 100644 --- a/fishjam/peer_notifications.proto +++ b/fishjam/peer_notifications.proto @@ -18,6 +18,7 @@ message PeerMessage { // Response sent by FJ, confirming successful authentication message Authenticated { RoomType room_type = 1; + string sdk_deprecation_warning = 2; } // Request sent by peer, to authenticate to FJ server diff --git a/fishjam_protos/lib/fishjam/peer_notifications.pb.ex b/fishjam_protos/lib/fishjam/peer_notifications.pb.ex index 5213559..a8ba9d3 100644 --- a/fishjam_protos/lib/fishjam/peer_notifications.pb.ex +++ b/fishjam_protos/lib/fishjam/peer_notifications.pb.ex @@ -22,6 +22,7 @@ defmodule Fishjam.PeerMessage.Authenticated do syntax: :proto3 field :room_type, 1, type: Fishjam.PeerMessage.RoomType, json_name: "roomType", enum: true + field :sdk_deprecation_warning, 2, type: :string, json_name: "sdkDeprecationWarning" end defmodule Fishjam.PeerMessage.AuthRequest do From d31918a1a5cbeb538f7a58eb7dc3295a12e884e2 Mon Sep 17 00:00:00 2001 From: Bernard Gawor Date: Mon, 26 Jan 2026 16:35:47 +0100 Subject: [PATCH 2/3] sdk deprecation structure --- doc/docs.md | 34 ++++++++++++++++++- fishjam/peer_notifications.proto | 15 +++++++- .../lib/fishjam/peer_notifications.pb.ex | 29 +++++++++++++++- 3 files changed, 75 insertions(+), 3 deletions(-) diff --git a/doc/docs.md b/doc/docs.md index d2a7906..3a8321b 100644 --- a/doc/docs.md +++ b/doc/docs.md @@ -80,8 +80,10 @@ - [PeerMessage.Authenticated](#fishjam-PeerMessage-Authenticated) - [PeerMessage.MediaEvent](#fishjam-PeerMessage-MediaEvent) - [PeerMessage.RTCStatsReport](#fishjam-PeerMessage-RTCStatsReport) + - [PeerMessage.SdkDeprecation](#fishjam-PeerMessage-SdkDeprecation) - [PeerMessage.RoomType](#fishjam-PeerMessage-RoomType) + - [PeerMessage.SdkDeprecation.Status](#fishjam-PeerMessage-SdkDeprecation-Status) - [fishjam/server_notifications.proto](#fishjam_server_notifications-proto) - [ServerMessage](#fishjam-ServerMessage) @@ -1190,7 +1192,7 @@ Response sent by FJ, confirming successful authentication | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | room_type | [PeerMessage.RoomType](#fishjam-PeerMessage-RoomType) | | | -| sdk_deprecation_warning | [string](#string) | | | +| sdk_deprecation | [PeerMessage.SdkDeprecation](#fishjam-PeerMessage-SdkDeprecation) | | | @@ -1227,6 +1229,22 @@ https://developer.mozilla.org/en-US/docs/Web/API/RTCStatsReport#the_statistic_ty + + + +### PeerMessage.SdkDeprecation +Deprecation status for SDK version + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| status | [PeerMessage.SdkDeprecation.Status](#fishjam-PeerMessage-SdkDeprecation-Status) | | | +| message | [string](#string) | | | + + + + + @@ -1243,6 +1261,20 @@ Defines types of rooms peers may connect to | ROOM_TYPE_LIVESTREAM | 3 | | + + + +### PeerMessage.SdkDeprecation.Status + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNSPECIFIED | 0 | | +| UP_TO_DATE | 1 | | +| DEPRECATED | 2 | | +| UNSUPPORTED | 3 | | + + diff --git a/fishjam/peer_notifications.proto b/fishjam/peer_notifications.proto index 216694e..4939eef 100644 --- a/fishjam/peer_notifications.proto +++ b/fishjam/peer_notifications.proto @@ -15,10 +15,23 @@ message PeerMessage { ROOM_TYPE_LIVESTREAM = 3; } + // Deprecation status for SDK version + message SdkDeprecation { + enum Status { + UNSPECIFIED = 0; + UP_TO_DATE = 1; + DEPRECATED = 2; + UNSUPPORTED = 3; + } + + Status status = 1; + string message = 2; + } + // Response sent by FJ, confirming successful authentication message Authenticated { RoomType room_type = 1; - string sdk_deprecation_warning = 2; + SdkDeprecation sdk_deprecation = 2; } // Request sent by peer, to authenticate to FJ server diff --git a/fishjam_protos/lib/fishjam/peer_notifications.pb.ex b/fishjam_protos/lib/fishjam/peer_notifications.pb.ex index a8ba9d3..46e7059 100644 --- a/fishjam_protos/lib/fishjam/peer_notifications.pb.ex +++ b/fishjam_protos/lib/fishjam/peer_notifications.pb.ex @@ -13,6 +13,33 @@ defmodule Fishjam.PeerMessage.RoomType do field :ROOM_TYPE_LIVESTREAM, 3 end +defmodule Fishjam.PeerMessage.SdkDeprecation.Status do + @moduledoc false + + use Protobuf, + enum: true, + full_name: "fishjam.PeerMessage.SdkDeprecation.Status", + protoc_gen_elixir_version: "0.16.0", + syntax: :proto3 + + field :UNSPECIFIED, 0 + field :UP_TO_DATE, 1 + field :DEPRECATED, 2 + field :UNSUPPORTED, 3 +end + +defmodule Fishjam.PeerMessage.SdkDeprecation do + @moduledoc false + + use Protobuf, + full_name: "fishjam.PeerMessage.SdkDeprecation", + protoc_gen_elixir_version: "0.16.0", + syntax: :proto3 + + field :status, 1, type: Fishjam.PeerMessage.SdkDeprecation.Status, enum: true + field :message, 2, type: :string +end + defmodule Fishjam.PeerMessage.Authenticated do @moduledoc false @@ -22,7 +49,7 @@ defmodule Fishjam.PeerMessage.Authenticated do syntax: :proto3 field :room_type, 1, type: Fishjam.PeerMessage.RoomType, json_name: "roomType", enum: true - field :sdk_deprecation_warning, 2, type: :string, json_name: "sdkDeprecationWarning" + field :sdk_deprecation, 2, type: Fishjam.PeerMessage.SdkDeprecation, json_name: "sdkDeprecation" end defmodule Fishjam.PeerMessage.AuthRequest do From d3a73e9cb786fb11bf52fceb167689a3a938085d Mon Sep 17 00:00:00 2001 From: Bernard Gawor Date: Mon, 26 Jan 2026 16:39:04 +0100 Subject: [PATCH 3/3] lint --- doc/docs.md | 8 ++++---- fishjam/peer_notifications.proto | 8 ++++---- fishjam_protos/lib/fishjam/peer_notifications.pb.ex | 8 ++++---- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/doc/docs.md b/doc/docs.md index 3a8321b..2cd4ee6 100644 --- a/doc/docs.md +++ b/doc/docs.md @@ -1269,10 +1269,10 @@ Defines types of rooms peers may connect to | Name | Number | Description | | ---- | ------ | ----------- | -| UNSPECIFIED | 0 | | -| UP_TO_DATE | 1 | | -| DEPRECATED | 2 | | -| UNSUPPORTED | 3 | | +| STATUS_UNSPECIFIED | 0 | | +| STATUS_UP_TO_DATE | 1 | | +| STATUS_DEPRECATED | 2 | | +| STATUS_UNSUPPORTED | 3 | | diff --git a/fishjam/peer_notifications.proto b/fishjam/peer_notifications.proto index 4939eef..7bd97f7 100644 --- a/fishjam/peer_notifications.proto +++ b/fishjam/peer_notifications.proto @@ -18,10 +18,10 @@ message PeerMessage { // Deprecation status for SDK version message SdkDeprecation { enum Status { - UNSPECIFIED = 0; - UP_TO_DATE = 1; - DEPRECATED = 2; - UNSUPPORTED = 3; + STATUS_UNSPECIFIED = 0; + STATUS_UP_TO_DATE = 1; + STATUS_DEPRECATED = 2; + STATUS_UNSUPPORTED = 3; } Status status = 1; diff --git a/fishjam_protos/lib/fishjam/peer_notifications.pb.ex b/fishjam_protos/lib/fishjam/peer_notifications.pb.ex index 46e7059..3cfa045 100644 --- a/fishjam_protos/lib/fishjam/peer_notifications.pb.ex +++ b/fishjam_protos/lib/fishjam/peer_notifications.pb.ex @@ -22,10 +22,10 @@ defmodule Fishjam.PeerMessage.SdkDeprecation.Status do protoc_gen_elixir_version: "0.16.0", syntax: :proto3 - field :UNSPECIFIED, 0 - field :UP_TO_DATE, 1 - field :DEPRECATED, 2 - field :UNSUPPORTED, 3 + field :STATUS_UNSPECIFIED, 0 + field :STATUS_UP_TO_DATE, 1 + field :STATUS_DEPRECATED, 2 + field :STATUS_UNSUPPORTED, 3 end defmodule Fishjam.PeerMessage.SdkDeprecation do