Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
42 changes: 42 additions & 0 deletions foreign/python/apache_iggy.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -1194,6 +1194,48 @@ class IggyClient:
Raises:
RuntimeError: If an identifier is invalid or the request fails.
"""
def create_partitions(
self,
stream_id: builtins.str | builtins.int,
topic_id: builtins.str | builtins.int,
partitions_count: builtins.int,
) -> collections.abc.Awaitable[None]:
r"""
Create partitions for a topic.

Args:
stream_id: Stream identifier as `str | int`.
topic_id: Topic identifier as `str | int`.
partitions_count: Number of partitions to create.

Returns:
An awaitable that resolves to `None` when the partitions are created.

Raises:
ValueError: If an identifier is invalid.
RuntimeError: If the request fails.
"""
def delete_partitions(
self,
stream_id: builtins.str | builtins.int,
topic_id: builtins.str | builtins.int,
partitions_count: builtins.int,
) -> collections.abc.Awaitable[None]:
r"""
Delete the last partitions from a topic, including all messages stored in them.

Args:
stream_id: Stream identifier as `str | int`.
topic_id: Topic identifier as `str | int`.
partitions_count: Number of partitions to delete from the end of the topic.

Returns:
An awaitable that resolves to `None` when the partitions are deleted.

Raises:
ValueError: If an identifier is invalid.
RuntimeError: If the request fails.
"""
def create_consumer_group(
self,
stream_id: builtins.str | builtins.int,
Expand Down
68 changes: 68 additions & 0 deletions foreign/python/src/client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -777,6 +777,74 @@ impl IggyClient {
})
}

/// Create partitions for a topic.
///
/// Args:
/// stream_id: Stream identifier as `str | int`.
/// topic_id: Topic identifier as `str | int`.
/// partitions_count: Number of partitions to create.
Comment thread
Elioooon marked this conversation as resolved.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

warning: partitions_count has no documented range. server takes 1..=1000 (MAX_PARTITIONS_PER_REQUEST) and reports 0 as "Too many partitions", so spell it out here - the stub is the only doc a python caller gets.

also at line 819.

///
/// Returns:
/// An awaitable that resolves to `None` when the partitions are created.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nit: nothing says which ids the new partitions get, and the caller needs them for send_messages. they're 0-based and append above the current max, reused after a delete - don't copy partition_client.rs:26, it claims 1-based and is wrong.

///
/// Raises:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nit: Raises: misses OverflowError, which pyo3 throws for a negative or oversized count and which is neither ValueError nor RuntimeError. test_topic.py:367 already pins that behaviour.

also at line 824.

/// ValueError: If an identifier is invalid.
/// RuntimeError: If the request fails.
#[gen_stub(override_return_type(type_repr="collections.abc.Awaitable[None]", imports=("collections.abc")))]
fn create_partitions<'a>(
&self,
py: Python<'a>,
stream_id: PyIdentifier,
topic_id: PyIdentifier,
partitions_count: u32,
) -> PyResult<Bound<'a, PyAny>> {
let stream_id = Identifier::try_from(stream_id)?;
let topic_id = Identifier::try_from(topic_id)?;
let inner = self.inner.clone();

future_into_py(py, async move {
inner
.create_partitions(&stream_id, &topic_id, partitions_count)
.await
.map_err(|e| PyErr::new::<pyo3::exceptions::PyRuntimeError, _>(e.to_string()))?;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

simplification: this makes 38 copies of the same PyErr::new::<PyRuntimeError, _>(e.to_string()) map_err in this file. a to_runtime_error(e: impl ToString) helper, like to_value_error in send_message.rs:93, cuts each site to .map_err(to_runtime_error)?.

also at line 843.

Ok(())
})
}

/// Delete the last partitions from a topic, including all messages stored in them.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nit: neither docstring mentions the consumer group side effect - delete rebalances members off the removed partitions and drops their stats, create leaves the new ones unassigned until the next rebalance. one line on each.

also at line 780.

///
/// Args:
/// stream_id: Stream identifier as `str | int`.
/// topic_id: Topic identifier as `str | int`.
/// partitions_count: Number of partitions to delete from the end of the topic.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nit: partitions_count drops the "as int" suffix the other args in this same docstring carry. adding it pushes the generated stub line past 88 chars, so rewrap rather than extend.

also at line 785.

///
/// Returns:
/// An awaitable that resolves to `None` when the partitions are deleted.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nit: the awaitable resolves on metadata commit, not after teardown - the unlink runs later in the reconciler and can back off. say "when the deletion is accepted; storage teardown completes asynchronously".

///
/// Raises:
/// ValueError: If an identifier is invalid.
/// RuntimeError: If the request fails.
#[gen_stub(override_return_type(type_repr="collections.abc.Awaitable[None]", imports=("collections.abc")))]
fn delete_partitions<'a>(
&self,
py: Python<'a>,
stream_id: PyIdentifier,
topic_id: PyIdentifier,
partitions_count: u32,
) -> PyResult<Bound<'a, PyAny>> {
let stream_id = Identifier::try_from(stream_id)?;
let topic_id = Identifier::try_from(topic_id)?;
let inner = self.inner.clone();

future_into_py(py, async move {
inner
.delete_partitions(&stream_id, &topic_id, partitions_count)
.await
.map_err(|e| PyErr::new::<pyo3::exceptions::PyRuntimeError, _>(e.to_string()))?;
Ok(())
})
}

/// Create a consumer group for a stream and topic.
///
/// Args:
Expand Down
124 changes: 124 additions & 0 deletions foreign/python/tests/test_partition.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.

import pytest

from apache_iggy import IggyClient


@pytest.mark.asyncio

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nit: module-level test functions - 9 of the 10 other suites group into Test* classes. wrap these in class TestPartitionManagement:.

async def test_create_and_delete_partitions(iggy_client: IggyClient, unique_name):

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nit: no test in this file ever sends a message, so delete is never exercised with data present and the new partitions are never shown to be usable. test_topic.py:1258 is the shape to copy. don't assert topic size_bytes after the delete though - it isn't reclaimed.

stream_name = unique_name()

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

simplification: the same 7-line create_stream + create_topic preamble is copy-pasted in four tests. pull it into a module-level helper like test_consumer_group.py:37 - there is already a TODO there asking for exactly this.

topic_name = unique_name()

await iggy_client.create_stream(stream_name)
await iggy_client.create_topic(
stream=stream_name, name=topic_name, partitions_count=2
)

await iggy_client.create_partitions(stream_name, topic_name, 2)
topic = await iggy_client.get_topic(stream_name, topic_name)
assert topic is not None
assert topic.partitions_count == 4
assert [partition.id for partition in topic.partitions] == [0, 1, 2, 3]

await iggy_client.delete_partitions(stream_name, topic_name, 2)
topic = await iggy_client.get_topic(stream_name, topic_name)
assert topic is not None
assert topic.partitions_count == 2
assert [partition.id for partition in topic.partitions] == [0, 1]


@pytest.mark.asyncio
async def test_partition_management_accepts_numeric_ids(
iggy_client: IggyClient, unique_name
):
stream_name = unique_name()
topic_name = unique_name()

await iggy_client.create_stream(stream_name)
stream = await iggy_client.get_stream(stream_name)
assert stream is not None
await iggy_client.create_topic(
stream=stream.id, name=topic_name, partitions_count=2
)
topic = await iggy_client.get_topic(stream.id, topic_name)
assert topic is not None

await iggy_client.create_partitions(stream.id, topic.id, 1)
await iggy_client.delete_partitions(stream.id, topic.id, 1)

topic = await iggy_client.get_topic(stream.id, topic.id)
assert topic is not None
assert [partition.id for partition in topic.partitions] == [0, 1]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nit: this asserts [0, 1], the same state as before the create and delete, so two no-ops that cancel out would pass. re-read between them: created = await iggy_client.get_topic(stream.id, topic.id), then assert created.partitions_count == 3.



@pytest.mark.asyncio
async def test_partition_management_rejects_zero_count(
iggy_client: IggyClient, unique_name
):
stream_name = unique_name()
topic_name = unique_name()

await iggy_client.create_stream(stream_name)
await iggy_client.create_topic(
stream=stream_name, name=topic_name, partitions_count=2
)

with pytest.raises(RuntimeError):

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

warning: bare pytest.raises(RuntimeError) passes on any failure - every server error maps to RuntimeError here. add match=: "Too many partitions" for zero count, "Invalid partitions count" for over-count, "was not found." for missing stream/topic.

also at lines 84, 100, 117, 119, 121, 123.

await iggy_client.create_partitions(stream_name, topic_name, 0)
with pytest.raises(RuntimeError):
await iggy_client.delete_partitions(stream_name, topic_name, 0)


@pytest.mark.asyncio
async def test_delete_partitions_rejects_count_larger_than_topic(
iggy_client: IggyClient, unique_name
):
stream_name = unique_name()
topic_name = unique_name()

await iggy_client.create_stream(stream_name)
await iggy_client.create_topic(
stream=stream_name, name=topic_name, partitions_count=2
)

with pytest.raises(RuntimeError):
await iggy_client.delete_partitions(stream_name, topic_name, 3)


@pytest.mark.asyncio
async def test_partition_management_rejects_missing_stream_or_topic(

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nit: the documented ValueError for a bad identifier is never exercised here, and there's no delete-all-partitions case. skip an over-cap test though - zero and over-cap return the same code, so it would duplicate the zero-count assertion.

iggy_client: IggyClient, unique_name
):
stream_name = unique_name()
topic_name = unique_name()
missing_name = unique_name()

await iggy_client.create_stream(stream_name)
await iggy_client.create_topic(
stream=stream_name, name=topic_name, partitions_count=2
)

with pytest.raises(RuntimeError):

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

simplification: these four raises blocks only differ in which identifier is missing. one parametrize over (method, missing) collapses them and keeps the test name.

await iggy_client.create_partitions(missing_name, topic_name, 1)
with pytest.raises(RuntimeError):
await iggy_client.create_partitions(stream_name, missing_name, 1)
with pytest.raises(RuntimeError):
await iggy_client.delete_partitions(missing_name, topic_name, 1)
with pytest.raises(RuntimeError):
await iggy_client.delete_partitions(stream_name, missing_name, 1)
Loading