nautilus_common/generators/
position_id.rs

1// -------------------------------------------------------------------------------------------------
2//  Copyright (C) 2015-2025 Nautech Systems Pty Ltd. All rights reserved.
3//  https://nautechsystems.io
4//
5//  Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
6//  You may not use this file except in compliance with the License.
7//  You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
8//
9//  Unless required by applicable law or agreed to in writing, software
10//  distributed under the License is distributed on an "AS IS" BASIS,
11//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12//  See the License for the specific language governing permissions and
13//  limitations under the License.
14// -------------------------------------------------------------------------------------------------
15
16use std::{cell::RefCell, collections::HashMap, fmt::Debug, rc::Rc};
17
18use nautilus_model::identifiers::{PositionId, StrategyId, TraderId};
19
20use super::get_datetime_tag;
21use crate::clock::Clock;
22
23#[repr(C)]
24pub struct PositionIdGenerator {
25    clock: Rc<RefCell<dyn Clock>>,
26    trader_id: TraderId,
27    counts: HashMap<StrategyId, usize>,
28}
29
30impl Debug for PositionIdGenerator {
31    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
32        f.debug_struct(stringify!(PositionIdGenerator))
33            .field("trader_id", &self.trader_id)
34            .field("counts", &self.counts)
35            .finish()
36    }
37}
38
39impl PositionIdGenerator {
40    /// Creates a new [`PositionIdGenerator`] instance.
41    #[must_use]
42    pub fn new(trader_id: TraderId, clock: Rc<RefCell<dyn Clock>>) -> Self {
43        Self {
44            clock,
45            trader_id,
46            counts: HashMap::new(),
47        }
48    }
49
50    pub fn set_count(&mut self, count: usize, strategy_id: StrategyId) {
51        self.counts.insert(strategy_id, count);
52    }
53
54    pub fn reset(&mut self) {
55        self.counts.clear();
56    }
57
58    #[must_use]
59    pub fn count(&self, strategy_id: StrategyId) -> usize {
60        *self.counts.get(&strategy_id).unwrap_or(&0)
61    }
62
63    pub fn generate(&mut self, strategy_id: StrategyId, flipped: bool) -> PositionId {
64        let strategy = strategy_id;
65        let next_count = self.count(strategy_id) + 1;
66        self.set_count(next_count, strategy_id);
67        let datetime_tag = get_datetime_tag(self.clock.borrow().timestamp_ms());
68        let trader_tag = self.trader_id.get_tag();
69        let strategy_tag = strategy.get_tag();
70        let flipped = if flipped { "F" } else { "" };
71        let value = format!("P-{datetime_tag}-{trader_tag}-{strategy_tag}-{next_count}{flipped}");
72        PositionId::from(value)
73    }
74}
75
76#[cfg(test)]
77mod tests {
78    use std::{cell::RefCell, rc::Rc};
79
80    use nautilus_model::identifiers::{PositionId, StrategyId, TraderId};
81    use rstest::rstest;
82
83    use crate::{clock::TestClock, generators::position_id::PositionIdGenerator};
84
85    fn get_position_id_generator() -> PositionIdGenerator {
86        PositionIdGenerator::new(TraderId::default(), Rc::new(RefCell::new(TestClock::new())))
87    }
88
89    #[rstest]
90    fn test_generate_position_id_one_strategy() {
91        let mut generator = get_position_id_generator();
92        let result1 = generator.generate(StrategyId::from("S-001"), false);
93        let result2 = generator.generate(StrategyId::from("S-001"), false);
94
95        assert_eq!(result1, PositionId::from("P-19700101-000000-001-001-1"));
96        assert_eq!(result2, PositionId::from("P-19700101-000000-001-001-2"));
97    }
98
99    #[rstest]
100    fn test_generate_position_id_multiple_strategies() {
101        let mut generator = get_position_id_generator();
102        let result1 = generator.generate(StrategyId::from("S-001"), false);
103        let result2 = generator.generate(StrategyId::from("S-002"), false);
104        let result3 = generator.generate(StrategyId::from("S-002"), false);
105
106        assert_eq!(result1, PositionId::from("P-19700101-000000-001-001-1"));
107        assert_eq!(result2, PositionId::from("P-19700101-000000-001-002-1"));
108        assert_eq!(result3, PositionId::from("P-19700101-000000-001-002-2"));
109    }
110
111    #[rstest]
112    fn test_generate_position_id_with_flipped_appends_correctly() {
113        let mut generator = get_position_id_generator();
114        let result1 = generator.generate(StrategyId::from("S-001"), false);
115        let result2 = generator.generate(StrategyId::from("S-002"), true);
116        let result3 = generator.generate(StrategyId::from("S-001"), true);
117
118        assert_eq!(result1, PositionId::from("P-19700101-000000-001-001-1"));
119        assert_eq!(result2, PositionId::from("P-19700101-000000-001-002-1F"));
120        assert_eq!(result3, PositionId::from("P-19700101-000000-001-001-2F"));
121    }
122
123    #[rstest]
124    fn test_get_count_when_strategy_id_has_not_been_used() {
125        let generator = get_position_id_generator();
126        let result = generator.count(StrategyId::from("S-001"));
127
128        assert_eq!(result, 0);
129    }
130
131    #[rstest]
132    fn set_count_with_valid_strategy() {
133        let mut generator = get_position_id_generator();
134        generator.set_count(7, StrategyId::from("S-001"));
135        let result = generator.count(StrategyId::from("S-001"));
136
137        assert_eq!(result, 7);
138    }
139
140    #[rstest]
141    fn test_reset() {
142        let mut generator = get_position_id_generator();
143        generator.generate(StrategyId::from("S-001"), false);
144        generator.generate(StrategyId::from("S-001"), false);
145        generator.reset();
146        let result = generator.generate(StrategyId::from("S-001"), false);
147
148        assert_eq!(result, PositionId::from("P-19700101-000000-001-001-1"));
149    }
150}
nautilus_common/generators/position_id.rs

nautilus_common/generators/
position_id.rs
