Skip to content

SDK Deprecation message Authentication #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Gawor270 merged 3 commits into from
Jan 28, 2026
Merged

SDK Deprecation message Authentication #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
888cb0f
add deprecation warning field
Gawor270 Jan 26, 2026
d31918a
sdk deprecation structure
Gawor270 Jan 26, 2026
d3a73e9
lint
Gawor270 Jan 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions doc/docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -1190,6 +1192,7 @@ Response sent by FJ, confirming successful authentication
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| room_type | [PeerMessage.RoomType](#fishjam-PeerMessage-RoomType) | | |
| sdk_deprecation | [PeerMessage.SdkDeprecation](#fishjam-PeerMessage-SdkDeprecation) | | |



Expand Down Expand Up @@ -1226,6 +1229,22 @@ https://developer.mozilla.org/en-US/docs/Web/API/RTCStatsReport#the_statistic_ty




<a name="fishjam-PeerMessage-SdkDeprecation"></a>

### PeerMessage.SdkDeprecation
Deprecation status for SDK version


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| status | [PeerMessage.SdkDeprecation.Status](#fishjam-PeerMessage-SdkDeprecation-Status) | | |
| message | [string](#string) | | |








Expand All @@ -1242,6 +1261,20 @@ Defines types of rooms peers may connect to
| ROOM_TYPE_LIVESTREAM | 3 | |



<a name="fishjam-PeerMessage-SdkDeprecation-Status"></a>

### PeerMessage.SdkDeprecation.Status


| Name | Number | Description |
| ---- | ------ | ----------- |
| STATUS_UNSPECIFIED | 0 | |
| STATUS_UP_TO_DATE | 1 | |
| STATUS_DEPRECATED | 2 | |
| STATUS_UNSUPPORTED | 3 | |





Expand Down
14 changes: 14 additions & 0 deletions fishjam/peer_notifications.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,23 @@ message PeerMessage {
ROOM_TYPE_LIVESTREAM = 3;
}

// Deprecation status for SDK version
message SdkDeprecation {
enum Status {
STATUS_UNSPECIFIED = 0;
STATUS_UP_TO_DATE = 1;
STATUS_DEPRECATED = 2;
STATUS_UNSUPPORTED = 3;
}

Status status = 1;
string message = 2;
Comment on lines +26 to +28
Copy link
Collaborator

@Karolk99 Karolk99 Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What will be sent in the message? Which version is supported?

Copy link
Member Author

@Gawor270 Gawor270 Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

message displayed to sdk user

Copy link
Member Author

@Gawor270 Gawor270 Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

support for version is defined in PR to fishtank https://github.com/fishjam-cloud/fishtank/pull/49

}

// Response sent by FJ, confirming successful authentication
message Authenticated {
RoomType room_type = 1;
SdkDeprecation sdk_deprecation = 2;
}

// Request sent by peer, to authenticate to FJ server
Expand Down
28 changes: 28 additions & 0 deletions fishjam_protos/lib/fishjam/peer_notifications.pb.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 :STATUS_UNSPECIFIED, 0
field :STATUS_UP_TO_DATE, 1
field :STATUS_DEPRECATED, 2
field :STATUS_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

Expand All @@ -22,6 +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, 2, type: Fishjam.PeerMessage.SdkDeprecation, json_name: "sdkDeprecation"
end

defmodule Fishjam.PeerMessage.AuthRequest do
Expand Down
Loading