Skip to content
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

Soft deprecate is_kv_bucket_stream?/1 in favor of kv_bucket_stream?/1 #183

Merged
merged 2 commits into from
Jan 1, 2025
Merged

Soft deprecate is_kv_bucket_stream?/1 in favor of kv_bucket_stream?/1 #183

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f0f8a20
Soft deprecate is_kv_bucket_stream?/1 in favor of kv_bucket_stream?/1
davydog187 Dec 30, 2024
4b7e47c
whoops
davydog187 Dec 30, 2024
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
24 changes: 17 additions & 7 deletions lib/gnat/jetstream/api/kv.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,11 @@ defmodule Gnat.Jetstream.API.KV do
end)
"""
def watch(conn, bucket_name, handler) do
Gnat.Jetstream.API.KV.Watcher.start_link(conn: conn, bucket_name: bucket_name, handler: handler)
Gnat.Jetstream.API.KV.Watcher.start_link(
conn: conn,
bucket_name: bucket_name,
handler: handler
)
end

@doc ~S"""
Expand Down Expand Up @@ -265,14 +269,20 @@ defmodule Gnat.Jetstream.API.KV do
end
end

@spec is_kv_bucket_stream?(stream_name :: binary()) :: boolean()
@deprecated "Use Gnat.Jetstream.API.KV.kv_bucket_stream?/1 instead"
def is_kv_bucket_stream?(stream_name) do
kv_bucket_stream?(stream_name)
end

@doc """
Returns true if the provided stream is a KV bucket, false otherwise

## Parameters
* `stream_name` - the stream name to test
"""
@spec is_kv_bucket_stream?(stream_name :: binary()) :: boolean()
def is_kv_bucket_stream?(stream_name) do
@spec kv_bucket_stream?(stream_name :: binary()) :: boolean()
def kv_bucket_stream?(stream_name) do
String.starts_with?(stream_name, "KV_")
end

Expand All @@ -285,20 +295,20 @@ defmodule Gnat.Jetstream.API.KV do
stream_names =
streams
|> Enum.flat_map(fn bucket ->
if is_kv_bucket_stream?(bucket) do
[bucket |> String.trim_leading(@stream_prefix)]
if kv_bucket_stream?(bucket) do
[bucket |> String.trim_leading(@stream_prefix)]
else
[]
[]
end
end)

{:ok, stream_names}
else
{:error, reason} ->
{:error, reason}
end
end


@doc false
def stream_name(bucket_name) do
"#{@stream_prefix}#{bucket_name}"
Expand Down
Loading