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

Fix errors caught by Dialyzer #141

Merged
merged 2 commits into from
Apr 29, 2024
Merged

Fix errors caught by Dialyzer #141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9f09706
Fix errors caught by Dialyzer
Stratus3D Apr 26, 2024
7fc8734
Address PR feedback
Stratus3D Apr 29, 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
16 changes: 11 additions & 5 deletions lib/broadway_kafka/brod_client.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ defmodule BroadwayKafka.BrodClient do
offset_reset_policy: offset_reset_policy,
begin_offset: begin_offset,
group_config: [{:offset_commit_policy, @offset_commit_policy} | group_config],
fetch_config: Map.new(fetch_config || []),
Copy link
Contributor Author

Choose a reason for hiding this comment

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

fetch_config is always going to be a list that passed validation in the validate_fetch_config/1 function, so the || [] will never be used here.

fetch_config: Map.new(fetch_config),
client_config: client_config,
shared_client: shared_client,
shared_client_id: build_shared_client_id(opts)
Expand Down Expand Up @@ -109,10 +109,12 @@ defmodule BroadwayKafka.BrodClient do

@impl true
def ack(group_coordinator, generation_id, topic, partition, offset, config) do
:brod_group_coordinator.ack(group_coordinator, generation_id, topic, partition, offset)
if group_coordinator do
:brod_group_coordinator.ack(group_coordinator, generation_id, topic, partition, offset)

if group_coordinator && config.offset_commit_on_ack do
Copy link
Contributor Author

Choose a reason for hiding this comment

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

According to Dialyzer group_coordinator will always be set. It's a pid so even if the pid dies it won't be a falsey value.

Copy link
Member

Choose a reason for hiding this comment

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

I believe it is getting this information from the callback but the callback is wrong. According to producer.ex the group_coordinator can definitely be nil.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Both :brod_group_coordinator.ack/5 and :brod_group_coordinator.commit_offsets/2 both expect group_coordinator to be a pid, not nil.

I think Dialyzer is complaining about this nil check because :brod_group_coordinator.ack/5 is invoked before it, so Dialyzer assumes that if we get to this line it MUST NOT be nil (and maybe it won't ever be, if :brod_group_coordinator.ack/5 always crashes when nil is passed).

We can solve this by having both calls inside a if group_coordinator do block. For consistency we should also do the same thing for the update_topics/2 function in this module.

It feels a little strange return ok when group_coordinator coordinator is nil however, but this is the only return type allowed by the behaviour:

  @impl true
  def ack(group_coordinator, generation_id, topic, partition, offset, config) do
    if group_coordinator do
      :brod_group_coordinator.ack(group_coordinator, generation_id, topic, partition, offset)

      if config.offset_commit_on_ack do
        :brod_group_coordinator.commit_offsets(group_coordinator, [{{topic, partition}, offset}])
      end
    end

    :ok
  end

Copy link
Member

Choose a reason for hiding this comment

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

Yes, I think that would be better. Although, if this is the case, it seems group_coordinator cannot be nil in this particular branch indeed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

PR updated. I have made the changes I described above.

:brod_group_coordinator.commit_offsets(group_coordinator, [{{topic, partition}, offset}])
if config.offset_commit_on_ack do
:brod_group_coordinator.commit_offsets(group_coordinator, [{{topic, partition}, offset}])
end
end

:ok
Expand Down Expand Up @@ -188,7 +190,11 @@ defmodule BroadwayKafka.BrodClient do

@impl true
def update_topics(group_coordinator, topics) do
:brod_group_coordinator.update_topics(group_coordinator, topics)
if group_coordinator do
:brod_group_coordinator.update_topics(group_coordinator, topics)
end

:ok
end

defp start_link_group_coordinator(stage_pid, client_id, callback_module, config) do
Expand Down
7 changes: 4 additions & 3 deletions lib/broadway_kafka/kafka_client.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ defmodule BroadwayKafka.KafkaClient do
}

@typep offset_reset_policy :: :earliest | :latest
@typep brod_group_coordinator :: pid() | nil

@callback init(opts :: any) :: {:ok, config} | {:error, any}
@callback setup(
Expand All @@ -23,9 +24,9 @@ defmodule BroadwayKafka.KafkaClient do
callback_module :: module,
config
) ::
{:ok, group_coordinator :: pid} | {:error, any}
{:ok, group_coordinator :: brod_group_coordinator()} | {:error, any}
@callback ack(
group_coordinator :: pid,
group_coordinator :: brod_group_coordinator(),
generation_id :: integer,
topic :: binary,
partition :: integer,
Expand All @@ -51,7 +52,7 @@ defmodule BroadwayKafka.KafkaClient do
) ::
offset :: integer | no_return()

@callback update_topics(:brod.group_coordinator(), [:brod.topic()]) :: :ok
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I didn't see this type defined in brod so I defined one in this module.

@callback update_topics(brod_group_coordinator(), [:brod.topic()]) :: :ok
@callback connected?(:brod.client()) :: boolean
@callback disconnect(:brod.client()) :: :ok
end
Loading