From c39d65a91f90ac7f0815fbd2ec47968799faf6ea Mon Sep 17 00:00:00 2001
From: Vartan Babayan <v.babayan@picodata.io>
Date: Wed, 16 Oct 2024 18:12:09 +0300
Subject: [PATCH] refactor: rename instance.instance_uuid -> instance.uuid
---
picoplugin/src/internal/types.rs | 8 ++++----
src/config.rs | 6 +++---
src/info.rs | 4 ++--
src/instance.rs | 8 ++++----
src/lib.rs | 2 +-
src/luamod.rs | 16 ++++++++--------
src/plugin/ffi.rs | 2 +-
src/rpc/join.rs | 2 +-
src/tarantool.rs | 4 ++--
src/vshard.rs | 2 +-
test/conftest.py | 2 +-
test/int/test_basics.py | 16 ++++++++--------
test/int/test_joining.py | 12 ++++++------
test/int/test_plugin.py | 2 +-
test/int/test_sql.py | 2 +-
test/testplug/src/lib.rs | 2 +-
16 files changed, 45 insertions(+), 45 deletions(-)
diff --git a/picoplugin/src/internal/types.rs b/picoplugin/src/internal/types.rs
index 76b67e7f75..b079ea51bf 100644
--- a/picoplugin/src/internal/types.rs
+++ b/picoplugin/src/internal/types.rs
@@ -234,7 +234,7 @@ pub struct InstanceInfo {
raft_id: u64,
advertise_address: RString,
name: RString,
- instance_uuid: RString,
+ uuid: RString,
replicaset_id: RString,
replicaset_uuid: RString,
cluster_name: RString,
@@ -261,7 +261,7 @@ impl InstanceInfo {
raft_id,
advertise_address: RString::from(advertise_address),
name: RString::from(name),
- instance_uuid: RString::from(instance_uuid),
+ uuid: RString::from(instance_uuid),
replicaset_id: RString::from(replicaset_id),
replicaset_uuid: RString::from(replicaset_uuid),
cluster_name: RString::from(cluster_name),
@@ -287,8 +287,8 @@ impl InstanceInfo {
}
/// Return current instance UUID.
- pub fn instance_uuid(&self) -> &str {
- self.instance_uuid.as_str()
+ pub fn uuid(&self) -> &str {
+ self.uuid.as_str()
}
/// ID of a replicaset the instance belongs to.
diff --git a/src/config.rs b/src/config.rs
index 82075d0910..ca73690498 100644
--- a/src/config.rs
+++ b/src/config.rs
@@ -464,13 +464,13 @@ Using configuration file '{args_path}'.");
for (param, i) in unknown_parameters.iter().zip(1..) {
_ = write!(&mut buffer, "`{}{}`", param.prefix, param.name);
- if param.name.to_string() == "instance_id".to_string() {
+ if *param.name.to_string() == *"instance_id".to_string() {
_ = write!(&mut buffer, " (did you mean `name`?)");
continue;
- } else if param.name.to_string() == "cluster_id".to_string() {
+ } else if *param.name.to_string() == *"cluster_id".to_string() {
_ = write!(&mut buffer, " (did you mean `cluster_name`?)");
continue;
- } else if param.name.to_string() == "instance_uuid".to_string() {
+ } else if *param.name.to_string() == *"instance_uuid".to_string() {
_ = write!(&mut buffer, " (did you mean `uuid`?)");
continue;
}
diff --git a/src/info.rs b/src/info.rs
index 4629789a04..2f0229dd38 100644
--- a/src/info.rs
+++ b/src/info.rs
@@ -66,7 +66,7 @@ pub struct InstanceInfo {
pub raft_id: RaftId,
pub advertise_address: String,
pub name: InstanceName,
- pub instance_uuid: String,
+ pub uuid: String,
pub replicaset_id: ReplicasetId,
pub replicaset_uuid: String,
pub cluster_name: String,
@@ -104,7 +104,7 @@ impl InstanceInfo {
raft_id: instance.raft_id,
advertise_address: peer_address,
name: instance.name,
- instance_uuid: instance.instance_uuid,
+ uuid: instance.uuid,
replicaset_id: instance.replicaset_id,
replicaset_uuid: instance.replicaset_uuid,
cluster_name,
diff --git a/src/instance.rs b/src/instance.rs
index eca254c961..aa576e2789 100644
--- a/src/instance.rs
+++ b/src/instance.rs
@@ -25,7 +25,7 @@ crate::define_string_newtype! {
pub struct Instance {
/// Instances are identified by name.
pub name: InstanceName,
- pub instance_uuid: String, // TODO turn it into uuid
+ pub uuid: String,
/// Used for identifying raft nodes.
/// Must be unique in the raft group.
@@ -74,7 +74,7 @@ impl Instance {
use tarantool::space::{Field, FieldType};
vec![
Field::from(("name", FieldType::String)),
- Field::from(("instance_uuid", FieldType::String)),
+ Field::from(("uuid", FieldType::String)),
Field::from(("raft_id", FieldType::Unsigned)),
Field::from(("replicaset_id", FieldType::String)),
Field::from(("replicaset_uuid", FieldType::String)),
@@ -155,7 +155,7 @@ mod tests {
let instance = Instance {
raft_id,
name: instance_name.into(),
- instance_uuid: format!("{instance_name}-uuid"),
+ uuid: format!("{instance_name}-uuid"),
replicaset_id: replicaset_id.into(),
replicaset_uuid: format!("{replicaset_id}-uuid"),
current_state: *state,
@@ -278,7 +278,7 @@ mod tests {
assert_eq!(i1a.name, "i1");
assert_eq!(i1b.name, "i1");
// Attention: not equal
- assert_ne!(i1a.instance_uuid, i1b.instance_uuid);
+ assert_ne!(i1a.uuid, i1b.uuid);
}
#[::tarantool::test]
diff --git a/src/lib.rs b/src/lib.rs
index f7522e5937..e8064125b5 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -766,7 +766,7 @@ fn start_boot(config: &PicodataConfig) -> Result<(), Error> {
let instance = Instance {
raft_id,
name: instance_name.clone(),
- instance_uuid: uuid::Uuid::new_v4().to_hyphenated().to_string(),
+ uuid: uuid::Uuid::new_v4().to_hyphenated().to_string(),
replicaset_id,
replicaset_uuid: uuid::Uuid::new_v4().to_hyphenated().to_string(),
current_state: instance::State::new(Offline, 0),
diff --git a/src/luamod.rs b/src/luamod.rs
index 1598edd4d8..44dcfc8035 100644
--- a/src/luamod.rs
+++ b/src/luamod.rs
@@ -210,14 +210,14 @@ pub(crate) fn setup() {
&l,
"instance_info",
indoc! {"
- pico.instance_info([instance_name])
+ pico.instance_info([instance name])
=================================
Provides general information for the given instance.
Params:
- 1. instance_name (optional string), default: id of the current instance
+ 1. instance name (optional string), default: id of the current instance
Returns:
@@ -229,8 +229,8 @@ pub(crate) fn setup() {
- raft_id (number)
- advertise_address (string)
- - instance_name (string)
- - instance_uuid (string)
+ - name (string)
+ - uuid (string)
- replicaset_id (string)
- replicaset_uuid (string)
- current_state (table),
@@ -247,8 +247,8 @@ pub(crate) fn setup() {
---
- raft_id: 1
advertise_address: 127.0.0.1:3301
- instance_name: i1
- instance_uuid: 68d4a766-4144-3248-aeb4-e212356716e4
+ name: i1
+ uuid: 68d4a766-4144-3248-aeb4-e212356716e4
tier: storage
replicaset_id: r1
replicaset_uuid: e0df68c5-e7f9-395f-86b3-30ad9e1b7b07
@@ -267,8 +267,8 @@ pub(crate) fn setup() {
Ok(tlua::AsTable((
("raft_id", info.raft_id),
("advertise_address", info.advertise_address),
- ("instance_name", info.name.0),
- ("instance_uuid", info.instance_uuid),
+ ("name", info.name.0),
+ ("uuid", info.uuid),
("replicaset_id", info.replicaset_id),
("replicaset_uuid", info.replicaset_uuid),
("current_state", info.current_state),
diff --git a/src/plugin/ffi.rs b/src/plugin/ffi.rs
index 891b69e9dc..1d5d04adf3 100644
--- a/src/plugin/ffi.rs
+++ b/src/plugin/ffi.rs
@@ -59,7 +59,7 @@ extern "C" fn pico_ffi_instance_info() -> RResult<types::InstanceInfo, ()> {
info.raft_id,
info.advertise_address,
info.name.0,
- info.instance_uuid,
+ info.uuid,
info.replicaset_id.0,
info.replicaset_uuid,
info.cluster_name,
diff --git a/src/rpc/join.rs b/src/rpc/join.rs
index a08e99be71..be7e898e56 100644
--- a/src/rpc/join.rs
+++ b/src/rpc/join.rs
@@ -215,7 +215,7 @@ pub fn build_instance(
Ok(Instance {
raft_id,
name: instance_name,
- instance_uuid,
+ uuid: instance_uuid,
replicaset_id,
replicaset_uuid,
current_state: State::new(Offline, 0),
diff --git a/src/tarantool.rs b/src/tarantool.rs
index 1dbd36a3a5..ac9dfb36b3 100644
--- a/src/tarantool.rs
+++ b/src/tarantool.rs
@@ -243,7 +243,7 @@ impl Cfg {
let mut res = Self {
// At this point uuids must be valid, it will be impossible to
// change them until the instance is expelled.
- instance_uuid: Some(leader.instance_uuid.clone()),
+ instance_uuid: Some(leader.uuid.clone()),
replicaset_uuid: Some(leader.replicaset_uuid.clone()),
// Listen port will be set after the global raft node is initialized.
@@ -282,7 +282,7 @@ impl Cfg {
let mut res = Self {
// At this point uuids must be valid, it will be impossible to
// change them until the instance is expelled.
- instance_uuid: Some(resp.instance.instance_uuid.clone()),
+ instance_uuid: Some(resp.instance.uuid.clone()),
replicaset_uuid: Some(resp.instance.replicaset_uuid.clone()),
// Needs to be set, because an applier will attempt to connect to
diff --git a/src/vshard.rs b/src/vshard.rs
index 8ea8536dee..efb575d1da 100644
--- a/src/vshard.rs
+++ b/src/vshard.rs
@@ -137,7 +137,7 @@ impl VshardConfig {
});
replicaset.replicas.insert(
- InstanceName(peer.instance_uuid.clone()),
+ InstanceName(peer.uuid.clone()),
ReplicaSpec {
uri: format!("{PICO_SERVICE_USER_NAME}@{address}"),
master: r.current_master_name == peer.name,
diff --git a/test/conftest.py b/test/conftest.py
index ea516020f4..0f961e5ee0 100644
--- a/test/conftest.py
+++ b/test/conftest.py
@@ -611,7 +611,7 @@ class Instance:
def get_tier(self):
return "default" if self.tier is None else self.tier
- def instance_uuid(self):
+ def uuid(self):
return self.eval("return box.info.uuid")
def replicaset_uuid(self):
diff --git a/test/int/test_basics.py b/test/int/test_basics.py
index a104c0b7cf..0739398b05 100644
--- a/test/int/test_basics.py
+++ b/test/int/test_basics.py
@@ -285,7 +285,7 @@ def test_pico_instance_info(instance: Instance):
# Don't compare entire structure, a couple of fields is enough
myself = instance_info("i1")
assert myself["raft_id"] == 1
- assert myself["instance_name"] == "i1"
+ assert myself["name"] == "i1"
assert myself["replicaset_id"] == "r1"
with pytest.raises(ReturnError) as e:
@@ -435,7 +435,7 @@ Insert(_pico_index, [{_pico_index},0,"_pico_index_id","tree",[{{"unique":true}}]
Insert(_pico_index, [{_pico_index},1,"_pico_index_name","tree",[{{"unique":true}}],[["name","string",null,false,null]],true,0]),
Insert(_pico_table, [{_pico_peer_address},"_pico_peer_address",{{"Global":null}},[{{"field_type":"unsigned","is_nullable":false,"name":"raft_id"}},{{"field_type":"string","is_nullable":false,"name":"address"}}],0,true,"memtx",1,""]),
Insert(_pico_index, [{_pico_peer_address},0,"_pico_peer_address_raft_id","tree",[{{"unique":true}}],[["raft_id","unsigned",null,false,null]],true,0]),
-Insert(_pico_table, [{_pico_instance},"_pico_instance",{{"Global":null}},[{{"field_type":"string","is_nullable":false,"name":"name"}},{{"field_type":"string","is_nullable":false,"name":"instance_uuid"}},{{"field_type":"unsigned","is_nullable":false,"name":"raft_id"}},{{"field_type":"string","is_nullable":false,"name":"replicaset_id"}},{{"field_type":"string","is_nullable":false,"name":"replicaset_uuid"}},{{"field_type":"array","is_nullable":false,"name":"current_state"}},{{"field_type":"array","is_nullable":false,"name":"target_state"}},{{"field_type":"map","is_nullable":false,"name":"failure_domain"}},{{"field_type":"string","is_nullable":false,"name":"tier"}}],0,true,"memtx",1,""]),
+Insert(_pico_table, [{_pico_instance},"_pico_instance",{{"Global":null}},[{{"field_type":"string","is_nullable":false,"name":"name"}},{{"field_type":"string","is_nullable":false,"name":"uuid"}},{{"field_type":"unsigned","is_nullable":false,"name":"raft_id"}},{{"field_type":"string","is_nullable":false,"name":"replicaset_id"}},{{"field_type":"string","is_nullable":false,"name":"replicaset_uuid"}},{{"field_type":"array","is_nullable":false,"name":"current_state"}},{{"field_type":"array","is_nullable":false,"name":"target_state"}},{{"field_type":"map","is_nullable":false,"name":"failure_domain"}},{{"field_type":"string","is_nullable":false,"name":"tier"}}],0,true,"memtx",1,""]),
Insert(_pico_index, [{_pico_instance},0,"_pico_instance_name","tree",[{{"unique":true}}],[["name","string",null,false,null]],true,0]),
Insert(_pico_index, [{_pico_instance},1,"_pico_instance_raft_id","tree",[{{"unique":true}}],[["raft_id","unsigned",null,false,null]],true,0]),
Insert(_pico_index, [{_pico_instance},2,"_pico_instance_replicaset_id","tree",[{{"unique":false}}],[["replicaset_id","string",null,false,null]],true,0]),
@@ -484,7 +484,7 @@ Update(_pico_tier, ["default"], [["=","target_vshard_config_version",1]])
""".format( # noqa: E501
p=instance.port,
b="{}",
- i1_uuid=instance.instance_uuid(),
+ i1_uuid=instance.uuid(),
r1_uuid=instance.replicaset_uuid(),
_pico_peer_address=space_id("_pico_peer_address"),
_pico_property=space_id("_pico_property"),
@@ -562,7 +562,7 @@ cluster:
raft_id=1,
advertise_address=f"{i1.host}:{i1.port}",
name="i1",
- instance_uuid=i1.instance_uuid(),
+ uuid=i1.uuid(),
replicaset_id="r1",
replicaset_uuid=i1.replicaset_uuid(),
cluster_name=i1.cluster_name,
@@ -576,7 +576,7 @@ cluster:
raft_id=2,
advertise_address=f"{i2.host}:{i2.port}",
name="i2",
- instance_uuid=i2.instance_uuid(),
+ uuid=i2.uuid(),
replicaset_id="r2",
replicaset_uuid=i2.replicaset_uuid(),
cluster_name=i1.cluster_name,
@@ -627,7 +627,7 @@ cluster:
storage_sharding = {
f"{storage_instance.replicaset_uuid()}": {
"replicas": {
- f"{storage_instance.instance_uuid()}": {
+ f"{storage_instance.uuid()}": {
"master": True,
"name": "i1",
"uri": f"pico_service@{storage_instance.host}:{storage_instance.port}",
@@ -640,12 +640,12 @@ cluster:
router_sharding = {
f"{router_instance_1.replicaset_uuid()}": {
"replicas": {
- f"{router_instance_1.instance_uuid()}": {
+ f"{router_instance_1.uuid()}": {
"master": True,
"name": "i2",
"uri": f"pico_service@{router_instance_1.host}:{router_instance_1.port}",
},
- f"{router_instance_2.instance_uuid()}": {
+ f"{router_instance_2.uuid()}": {
"master": False,
"name": "i3",
"uri": f"pico_service@{router_instance_2.host}:{router_instance_2.port}",
diff --git a/test/int/test_joining.py b/test/int/test_joining.py
index 7695324ed2..1c0fcff993 100644
--- a/test/int/test_joining.py
+++ b/test/int/test_joining.py
@@ -143,7 +143,7 @@ def test_replication(cluster: Cluster):
expected = {
"name": instance.name,
- "instance_uuid": instance.eval("return box.info.uuid"),
+ "uuid": instance.eval("return box.info.uuid"),
"raft_id": instance.raft_id,
"replicaset_id": "r1",
"replicaset_uuid": instance.eval("return box.info.cluster.uuid"),
@@ -155,8 +155,8 @@ def test_replication(cluster: Cluster):
assert {k: v for k, v in raft_instance.items() if k in expected} == expected
assert space_cluster == [
- [1, i1.instance_uuid()],
- [2, i2.instance_uuid()],
+ [1, i1.uuid()],
+ [2, i2.uuid()],
]
Retriable(timeout=10, rps=2).call(check_replicated, instance)
@@ -274,7 +274,7 @@ def test_separate_clusters(cluster: Cluster):
assert i1a_info["name"] == "i1"
assert i1b_info["name"] == "i1"
- assert i1a_info["instance_uuid"] != i1b_info["instance_uuid"]
+ assert i1a_info["uuid"] != i1b_info["uuid"]
assert i1a_info["replicaset_id"] == "r1"
assert i1b_info["replicaset_id"] == "r1"
@@ -285,8 +285,8 @@ def test_join_without_explicit_instance_name(cluster: Cluster):
# Scenario: bootstrap single instance without explicitly given instance name
# Given no instances started
# When two instances starts without instance_name given
- # Then the one of the instances became Leader with instance_name=1
- # And the second one of the became Follower with instance_name 2
+ # Then the one of the instances became Leader with instance name=1
+ # And the second one of the became Follower with instance name 2
# don't generate instance_names so that the Leader
# chooses ones for them when they join
diff --git a/test/int/test_plugin.py b/test/int/test_plugin.py
index 4b81547e1c..4e460b88f0 100644
--- a/test/int/test_plugin.py
+++ b/test/int/test_plugin.py
@@ -2482,7 +2482,7 @@ def test_sdk_internal(cluster: Cluster):
PluginReflection.assert_data_eq(i1, "rpc_version", version_info["rpc_api_version"])
PluginReflection.assert_data_eq(i1, "name", i1.name)
- PluginReflection.assert_data_eq(i1, "instance_uuid", i1.instance_uuid())
+ PluginReflection.assert_data_eq(i1, "uuid", i1.uuid())
PluginReflection.assert_data_eq(i1, "replicaset_id", "r1")
PluginReflection.assert_data_eq(i1, "replicaset_uuid", i1.replicaset_uuid())
PluginReflection.assert_data_eq(i1, "cluster_name", i1.cluster_name)
diff --git a/test/int/test_sql.py b/test/int/test_sql.py
index a25eedf334..2c51a643f5 100644
--- a/test/int/test_sql.py
+++ b/test/int/test_sql.py
@@ -423,7 +423,7 @@ def test_read_from_system_tables(cluster: Cluster):
)
assert data["metadata"] == [
{"name": "name", "type": "string"},
- {"name": "instance_uuid", "type": "string"},
+ {"name": "uuid", "type": "string"},
{"name": "raft_id", "type": "unsigned"},
{"name": "replicaset_id", "type": "string"},
{"name": "replicaset_uuid", "type": "string"},
diff --git a/test/testplug/src/lib.rs b/test/testplug/src/lib.rs
index 280647c0a0..77bb31aa17 100644
--- a/test/testplug/src/lib.rs
+++ b/test/testplug/src/lib.rs
@@ -330,7 +330,7 @@ impl Service for Service3 {
// get some instance info
let i_info = internal::instance_info().unwrap();
save_in_lua("testservice_3", "name", i_info.name());
- save_in_lua("testservice_3", "instance_uuid", i_info.instance_uuid());
+ save_in_lua("testservice_3", "uuid", i_info.uuid());
save_in_lua("testservice_3", "replicaset_id", i_info.replicaset_id());
save_in_lua("testservice_3", "replicaset_uuid", i_info.replicaset_uuid());
save_in_lua("testservice_3", "cluster_name", i_info.cluster_name());
--
GitLab