mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-26 09:50:40 +00:00
727 lines
72 KiB
HTML
727 lines
72 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/common/procedure/src/procedure.rs`."><title>procedure.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="common_procedure" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../static.files/storage-41dd4d93.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><h1><div class="sub-heading">common_procedure/</div>procedure.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// Copyright 2023 Greptime Team
|
|
<a href=#2 id=2 data-nosnippet>2</a>//
|
|
<a href=#3 id=3 data-nosnippet>3</a>// Licensed under the Apache License, Version 2.0 (the "License");
|
|
<a href=#4 id=4 data-nosnippet>4</a>// you may not use this file except in compliance with the License.
|
|
<a href=#5 id=5 data-nosnippet>5</a>// You may obtain a copy of the License at
|
|
<a href=#6 id=6 data-nosnippet>6</a>//
|
|
<a href=#7 id=7 data-nosnippet>7</a>// http://www.apache.org/licenses/LICENSE-2.0
|
|
<a href=#8 id=8 data-nosnippet>8</a>//
|
|
<a href=#9 id=9 data-nosnippet>9</a>// Unless required by applicable law or agreed to in writing, software
|
|
<a href=#10 id=10 data-nosnippet>10</a>// distributed under the License is distributed on an "AS IS" BASIS,
|
|
<a href=#11 id=11 data-nosnippet>11</a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
<a href=#12 id=12 data-nosnippet>12</a>// See the License for the specific language governing permissions and
|
|
<a href=#13 id=13 data-nosnippet>13</a>// limitations under the License.
|
|
<a href=#14 id=14 data-nosnippet>14</a>
|
|
<a href=#15 id=15 data-nosnippet>15</a></span><span class="kw">use </span>std::any::Any;
|
|
<a href=#16 id=16 data-nosnippet>16</a><span class="kw">use </span>std::fmt;
|
|
<a href=#17 id=17 data-nosnippet>17</a><span class="kw">use </span>std::fmt::Display;
|
|
<a href=#18 id=18 data-nosnippet>18</a><span class="kw">use </span>std::str::FromStr;
|
|
<a href=#19 id=19 data-nosnippet>19</a><span class="kw">use </span>std::sync::Arc;
|
|
<a href=#20 id=20 data-nosnippet>20</a>
|
|
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">use </span>async_trait::async_trait;
|
|
<a href=#22 id=22 data-nosnippet>22</a><span class="kw">use </span>common_event_recorder::{Event, Eventable};
|
|
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">use </span>serde::{Deserialize, Serialize};
|
|
<a href=#24 id=24 data-nosnippet>24</a><span class="kw">use </span>smallvec::{SmallVec, smallvec};
|
|
<a href=#25 id=25 data-nosnippet>25</a><span class="kw">use </span>snafu::{ResultExt, Snafu};
|
|
<a href=#26 id=26 data-nosnippet>26</a><span class="kw">use </span>tokio::sync::watch::Receiver;
|
|
<a href=#27 id=27 data-nosnippet>27</a><span class="kw">use </span>uuid::Uuid;
|
|
<a href=#28 id=28 data-nosnippet>28</a>
|
|
<a href=#29 id=29 data-nosnippet>29</a><span class="kw">use </span><span class="kw">crate</span>::error::{<span class="self">self</span>, Error, <span class="prelude-ty">Result</span>};
|
|
<a href=#30 id=30 data-nosnippet>30</a><span class="kw">use </span><span class="kw">crate</span>::local::DynamicKeyLockGuard;
|
|
<a href=#31 id=31 data-nosnippet>31</a><span class="kw">use </span><span class="kw">crate</span>::watcher::Watcher;
|
|
<a href=#32 id=32 data-nosnippet>32</a>
|
|
<a href=#33 id=33 data-nosnippet>33</a><span class="kw">pub type </span>Output = Arc<<span class="kw">dyn </span>Any + Send + Sync>;
|
|
<a href=#34 id=34 data-nosnippet>34</a>
|
|
<a href=#35 id=35 data-nosnippet>35</a><span class="doccomment">/// Procedure execution status.
|
|
<a href=#36 id=36 data-nosnippet>36</a></span><span class="attr">#[derive(Debug)]
|
|
<a href=#37 id=37 data-nosnippet>37</a></span><span class="kw">pub enum </span>Status {
|
|
<a href=#38 id=38 data-nosnippet>38</a> <span class="doccomment">/// The procedure is still executing.
|
|
<a href=#39 id=39 data-nosnippet>39</a> </span>Executing {
|
|
<a href=#40 id=40 data-nosnippet>40</a> <span class="doccomment">/// Whether the framework needs to persist the procedure.
|
|
<a href=#41 id=41 data-nosnippet>41</a> </span>persist: bool,
|
|
<a href=#42 id=42 data-nosnippet>42</a> <span class="doccomment">/// Whether the framework needs to clean the poisons.
|
|
<a href=#43 id=43 data-nosnippet>43</a> </span>clean_poisons: bool,
|
|
<a href=#44 id=44 data-nosnippet>44</a> },
|
|
<a href=#45 id=45 data-nosnippet>45</a> <span class="doccomment">/// The procedure has suspended itself and is waiting for subprocedures.
|
|
<a href=#46 id=46 data-nosnippet>46</a> </span>Suspended {
|
|
<a href=#47 id=47 data-nosnippet>47</a> subprocedures: Vec<ProcedureWithId>,
|
|
<a href=#48 id=48 data-nosnippet>48</a> <span class="doccomment">/// Whether the framework needs to persist the procedure.
|
|
<a href=#49 id=49 data-nosnippet>49</a> </span>persist: bool,
|
|
<a href=#50 id=50 data-nosnippet>50</a> },
|
|
<a href=#51 id=51 data-nosnippet>51</a> <span class="doccomment">/// The procedure is poisoned.
|
|
<a href=#52 id=52 data-nosnippet>52</a> </span>Poisoned {
|
|
<a href=#53 id=53 data-nosnippet>53</a> <span class="doccomment">/// The keys that cause the procedure to be poisoned.
|
|
<a href=#54 id=54 data-nosnippet>54</a> </span>keys: PoisonKeys,
|
|
<a href=#55 id=55 data-nosnippet>55</a> <span class="doccomment">/// The error that cause the procedure to be poisoned.
|
|
<a href=#56 id=56 data-nosnippet>56</a> </span>error: Error,
|
|
<a href=#57 id=57 data-nosnippet>57</a> },
|
|
<a href=#58 id=58 data-nosnippet>58</a> <span class="doccomment">/// the procedure is done.
|
|
<a href=#59 id=59 data-nosnippet>59</a> </span>Done { output: <span class="prelude-ty">Option</span><Output> },
|
|
<a href=#60 id=60 data-nosnippet>60</a>}
|
|
<a href=#61 id=61 data-nosnippet>61</a>
|
|
<a href=#62 id=62 data-nosnippet>62</a><span class="kw">impl </span>Status {
|
|
<a href=#63 id=63 data-nosnippet>63</a> <span class="doccomment">/// Returns a [Status::Suspended] with given `subprocedures` and `persist` flag.
|
|
<a href=#64 id=64 data-nosnippet>64</a> </span><span class="kw">pub fn </span>suspended(subprocedures: Vec<ProcedureWithId>, persist: bool) -> Status {
|
|
<a href=#65 id=65 data-nosnippet>65</a> Status::Suspended {
|
|
<a href=#66 id=66 data-nosnippet>66</a> subprocedures,
|
|
<a href=#67 id=67 data-nosnippet>67</a> persist,
|
|
<a href=#68 id=68 data-nosnippet>68</a> }
|
|
<a href=#69 id=69 data-nosnippet>69</a> }
|
|
<a href=#70 id=70 data-nosnippet>70</a>
|
|
<a href=#71 id=71 data-nosnippet>71</a> <span class="doccomment">/// Returns a [Status::Poisoned] with given `keys` and `error`.
|
|
<a href=#72 id=72 data-nosnippet>72</a> </span><span class="kw">pub fn </span>poisoned(keys: <span class="kw">impl </span>IntoIterator<Item = PoisonKey>, error: Error) -> Status {
|
|
<a href=#73 id=73 data-nosnippet>73</a> Status::Poisoned {
|
|
<a href=#74 id=74 data-nosnippet>74</a> keys: PoisonKeys::new(keys),
|
|
<a href=#75 id=75 data-nosnippet>75</a> error,
|
|
<a href=#76 id=76 data-nosnippet>76</a> }
|
|
<a href=#77 id=77 data-nosnippet>77</a> }
|
|
<a href=#78 id=78 data-nosnippet>78</a>
|
|
<a href=#79 id=79 data-nosnippet>79</a> <span class="doccomment">/// Returns a [Status::Executing] with given `persist` flag.
|
|
<a href=#80 id=80 data-nosnippet>80</a> </span><span class="kw">pub fn </span>executing(persist: bool) -> Status {
|
|
<a href=#81 id=81 data-nosnippet>81</a> Status::Executing {
|
|
<a href=#82 id=82 data-nosnippet>82</a> persist,
|
|
<a href=#83 id=83 data-nosnippet>83</a> clean_poisons: <span class="bool-val">false</span>,
|
|
<a href=#84 id=84 data-nosnippet>84</a> }
|
|
<a href=#85 id=85 data-nosnippet>85</a> }
|
|
<a href=#86 id=86 data-nosnippet>86</a>
|
|
<a href=#87 id=87 data-nosnippet>87</a> <span class="doccomment">/// Returns a [Status::Executing] with given `persist` flag and clean poisons.
|
|
<a href=#88 id=88 data-nosnippet>88</a> </span><span class="kw">pub fn </span>executing_with_clean_poisons(persist: bool) -> Status {
|
|
<a href=#89 id=89 data-nosnippet>89</a> Status::Executing {
|
|
<a href=#90 id=90 data-nosnippet>90</a> persist,
|
|
<a href=#91 id=91 data-nosnippet>91</a> clean_poisons: <span class="bool-val">true</span>,
|
|
<a href=#92 id=92 data-nosnippet>92</a> }
|
|
<a href=#93 id=93 data-nosnippet>93</a> }
|
|
<a href=#94 id=94 data-nosnippet>94</a>
|
|
<a href=#95 id=95 data-nosnippet>95</a> <span class="doccomment">/// Returns a [Status::Done] without output.
|
|
<a href=#96 id=96 data-nosnippet>96</a> </span><span class="kw">pub fn </span>done() -> Status {
|
|
<a href=#97 id=97 data-nosnippet>97</a> Status::Done { output: <span class="prelude-val">None </span>}
|
|
<a href=#98 id=98 data-nosnippet>98</a> }
|
|
<a href=#99 id=99 data-nosnippet>99</a>
|
|
<a href=#100 id=100 data-nosnippet>100</a> <span class="attr">#[cfg(any(test, feature = <span class="string">"testing"</span>))]
|
|
<a href=#101 id=101 data-nosnippet>101</a> </span><span class="doccomment">/// Downcasts [Status::Done]'s output to &T
|
|
<a href=#102 id=102 data-nosnippet>102</a> /// #Panic:
|
|
<a href=#103 id=103 data-nosnippet>103</a> /// - if [Status] is not the [Status::Done].
|
|
<a href=#104 id=104 data-nosnippet>104</a> /// - if the output is None.
|
|
<a href=#105 id=105 data-nosnippet>105</a> </span><span class="kw">pub fn </span>downcast_output_ref<T: <span class="lifetime">'static</span>>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>T> {
|
|
<a href=#106 id=106 data-nosnippet>106</a> <span class="kw">if let </span>Status::Done { output } = <span class="self">self </span>{
|
|
<a href=#107 id=107 data-nosnippet>107</a> output
|
|
<a href=#108 id=108 data-nosnippet>108</a> .as_ref()
|
|
<a href=#109 id=109 data-nosnippet>109</a> .expect(<span class="string">"Try to downcast the output of Status::Done, but the output is None"</span>)
|
|
<a href=#110 id=110 data-nosnippet>110</a> .downcast_ref()
|
|
<a href=#111 id=111 data-nosnippet>111</a> } <span class="kw">else </span>{
|
|
<a href=#112 id=112 data-nosnippet>112</a> <span class="macro">panic!</span>(<span class="string">"Expected the Status::Done, but got: {:?}"</span>, <span class="self">self</span>)
|
|
<a href=#113 id=113 data-nosnippet>113</a> }
|
|
<a href=#114 id=114 data-nosnippet>114</a> }
|
|
<a href=#115 id=115 data-nosnippet>115</a>
|
|
<a href=#116 id=116 data-nosnippet>116</a> <span class="doccomment">/// Returns a [Status::Done] with output.
|
|
<a href=#117 id=117 data-nosnippet>117</a> </span><span class="kw">pub fn </span>done_with_output<T: Any + Send + Sync>(output: T) -> Status {
|
|
<a href=#118 id=118 data-nosnippet>118</a> Status::Done {
|
|
<a href=#119 id=119 data-nosnippet>119</a> output: <span class="prelude-val">Some</span>(Arc::new(output)),
|
|
<a href=#120 id=120 data-nosnippet>120</a> }
|
|
<a href=#121 id=121 data-nosnippet>121</a> }
|
|
<a href=#122 id=122 data-nosnippet>122</a> <span class="doccomment">/// Returns `true` if the procedure is done.
|
|
<a href=#123 id=123 data-nosnippet>123</a> </span><span class="kw">pub fn </span>is_done(<span class="kw-2">&</span><span class="self">self</span>) -> bool {
|
|
<a href=#124 id=124 data-nosnippet>124</a> <span class="macro">matches!</span>(<span class="self">self</span>, Status::Done { .. })
|
|
<a href=#125 id=125 data-nosnippet>125</a> }
|
|
<a href=#126 id=126 data-nosnippet>126</a>
|
|
<a href=#127 id=127 data-nosnippet>127</a> <span class="doccomment">/// Returns `true` if the procedure needs the framework to persist its intermediate state.
|
|
<a href=#128 id=128 data-nosnippet>128</a> </span><span class="kw">pub fn </span>need_persist(<span class="kw-2">&</span><span class="self">self</span>) -> bool {
|
|
<a href=#129 id=129 data-nosnippet>129</a> <span class="kw">match </span><span class="self">self </span>{
|
|
<a href=#130 id=130 data-nosnippet>130</a> <span class="comment">// If the procedure is done/poisoned, the framework doesn't need to persist the procedure
|
|
<a href=#131 id=131 data-nosnippet>131</a> // anymore. It only needs to mark the procedure as committed.
|
|
<a href=#132 id=132 data-nosnippet>132</a> </span>Status::Executing { persist, .. } | Status::Suspended { persist, .. } => <span class="kw-2">*</span>persist,
|
|
<a href=#133 id=133 data-nosnippet>133</a> Status::Done { .. } | Status::Poisoned { .. } => <span class="bool-val">false</span>,
|
|
<a href=#134 id=134 data-nosnippet>134</a> }
|
|
<a href=#135 id=135 data-nosnippet>135</a> }
|
|
<a href=#136 id=136 data-nosnippet>136</a>
|
|
<a href=#137 id=137 data-nosnippet>137</a> <span class="doccomment">/// Returns `true` if the framework needs to clean the poisons.
|
|
<a href=#138 id=138 data-nosnippet>138</a> </span><span class="kw">pub fn </span>need_clean_poisons(<span class="kw-2">&</span><span class="self">self</span>) -> bool {
|
|
<a href=#139 id=139 data-nosnippet>139</a> <span class="kw">match </span><span class="self">self </span>{
|
|
<a href=#140 id=140 data-nosnippet>140</a> Status::Executing { clean_poisons, .. } => <span class="kw-2">*</span>clean_poisons,
|
|
<a href=#141 id=141 data-nosnippet>141</a> Status::Done { .. } => <span class="bool-val">true</span>,
|
|
<a href=#142 id=142 data-nosnippet>142</a> <span class="kw">_ </span>=> <span class="bool-val">false</span>,
|
|
<a href=#143 id=143 data-nosnippet>143</a> }
|
|
<a href=#144 id=144 data-nosnippet>144</a> }
|
|
<a href=#145 id=145 data-nosnippet>145</a>}
|
|
<a href=#146 id=146 data-nosnippet>146</a>
|
|
<a href=#147 id=147 data-nosnippet>147</a><span class="doccomment">/// [ContextProvider] provides information about procedures in the [ProcedureManager].
|
|
<a href=#148 id=148 data-nosnippet>148</a></span><span class="attr">#[async_trait]
|
|
<a href=#149 id=149 data-nosnippet>149</a></span><span class="kw">pub trait </span>ContextProvider: Send + Sync {
|
|
<a href=#150 id=150 data-nosnippet>150</a> <span class="doccomment">/// Query the procedure state.
|
|
<a href=#151 id=151 data-nosnippet>151</a> </span><span class="kw">async fn </span>procedure_state(<span class="kw-2">&</span><span class="self">self</span>, procedure_id: ProcedureId) -> <span class="prelude-ty">Result</span><<span class="prelude-ty">Option</span><ProcedureState>>;
|
|
<a href=#152 id=152 data-nosnippet>152</a>
|
|
<a href=#153 id=153 data-nosnippet>153</a> <span class="kw">async fn </span>procedure_state_receiver(
|
|
<a href=#154 id=154 data-nosnippet>154</a> <span class="kw-2">&</span><span class="self">self</span>,
|
|
<a href=#155 id=155 data-nosnippet>155</a> procedure_id: ProcedureId,
|
|
<a href=#156 id=156 data-nosnippet>156</a> ) -> <span class="prelude-ty">Result</span><<span class="prelude-ty">Option</span><Receiver<ProcedureState>>>;
|
|
<a href=#157 id=157 data-nosnippet>157</a>
|
|
<a href=#158 id=158 data-nosnippet>158</a> <span class="doccomment">/// Try to put a poison key for a procedure.
|
|
<a href=#159 id=159 data-nosnippet>159</a> ///
|
|
<a href=#160 id=160 data-nosnippet>160</a> /// This method is used to mark a resource as being operated on by a procedure.
|
|
<a href=#161 id=161 data-nosnippet>161</a> /// If the poison key already exists with a different value, the operation will fail.
|
|
<a href=#162 id=162 data-nosnippet>162</a> </span><span class="kw">async fn </span>try_put_poison(<span class="kw-2">&</span><span class="self">self</span>, key: <span class="kw-2">&</span>PoisonKey, procedure_id: ProcedureId) -> <span class="prelude-ty">Result</span><()>;
|
|
<a href=#163 id=163 data-nosnippet>163</a>
|
|
<a href=#164 id=164 data-nosnippet>164</a> <span class="doccomment">/// Acquires a key lock for the procedure.
|
|
<a href=#165 id=165 data-nosnippet>165</a> </span><span class="kw">async fn </span>acquire_lock(<span class="kw-2">&</span><span class="self">self</span>, key: <span class="kw-2">&</span>StringKey) -> DynamicKeyLockGuard;
|
|
<a href=#166 id=166 data-nosnippet>166</a>}
|
|
<a href=#167 id=167 data-nosnippet>167</a>
|
|
<a href=#168 id=168 data-nosnippet>168</a><span class="doccomment">/// Reference-counted pointer to [ContextProvider].
|
|
<a href=#169 id=169 data-nosnippet>169</a></span><span class="kw">pub type </span>ContextProviderRef = Arc<<span class="kw">dyn </span>ContextProvider>;
|
|
<a href=#170 id=170 data-nosnippet>170</a>
|
|
<a href=#171 id=171 data-nosnippet>171</a><span class="doccomment">/// Procedure execution context.
|
|
<a href=#172 id=172 data-nosnippet>172</a></span><span class="attr">#[derive(Clone)]
|
|
<a href=#173 id=173 data-nosnippet>173</a></span><span class="kw">pub struct </span>Context {
|
|
<a href=#174 id=174 data-nosnippet>174</a> <span class="doccomment">/// Id of the procedure.
|
|
<a href=#175 id=175 data-nosnippet>175</a> </span><span class="kw">pub </span>procedure_id: ProcedureId,
|
|
<a href=#176 id=176 data-nosnippet>176</a> <span class="doccomment">/// [ProcedureManager] context provider.
|
|
<a href=#177 id=177 data-nosnippet>177</a> </span><span class="kw">pub </span>provider: ContextProviderRef,
|
|
<a href=#178 id=178 data-nosnippet>178</a>}
|
|
<a href=#179 id=179 data-nosnippet>179</a>
|
|
<a href=#180 id=180 data-nosnippet>180</a><span class="kw">impl </span>Context {
|
|
<a href=#181 id=181 data-nosnippet>181</a> <span class="doccomment">/// Returns true if current procedure state is retrying.
|
|
<a href=#182 id=182 data-nosnippet>182</a> </span><span class="kw">pub async fn </span>is_retrying(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><bool> {
|
|
<a href=#183 id=183 data-nosnippet>183</a> <span class="self">self</span>.provider
|
|
<a href=#184 id=184 data-nosnippet>184</a> .procedure_state(<span class="self">self</span>.procedure_id)
|
|
<a href=#185 id=185 data-nosnippet>185</a> .<span class="kw">await
|
|
<a href=#186 id=186 data-nosnippet>186</a> </span>.ok()
|
|
<a href=#187 id=187 data-nosnippet>187</a> .flatten()
|
|
<a href=#188 id=188 data-nosnippet>188</a> .map(|s| s.is_retrying())
|
|
<a href=#189 id=189 data-nosnippet>189</a> }
|
|
<a href=#190 id=190 data-nosnippet>190</a>}
|
|
<a href=#191 id=191 data-nosnippet>191</a>
|
|
<a href=#192 id=192 data-nosnippet>192</a><span class="doccomment">/// A `Procedure` represents an operation or a set of operations to be performed step-by-step.
|
|
<a href=#193 id=193 data-nosnippet>193</a></span><span class="attr">#[async_trait]
|
|
<a href=#194 id=194 data-nosnippet>194</a></span><span class="kw">pub trait </span>Procedure: Send {
|
|
<a href=#195 id=195 data-nosnippet>195</a> <span class="doccomment">/// Type name of the procedure.
|
|
<a href=#196 id=196 data-nosnippet>196</a> </span><span class="kw">fn </span>type_name(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str;
|
|
<a href=#197 id=197 data-nosnippet>197</a>
|
|
<a href=#198 id=198 data-nosnippet>198</a> <span class="doccomment">/// Execute the procedure.
|
|
<a href=#199 id=199 data-nosnippet>199</a> ///
|
|
<a href=#200 id=200 data-nosnippet>200</a> /// The implementation must be idempotent.
|
|
<a href=#201 id=201 data-nosnippet>201</a> </span><span class="kw">async fn </span>execute(<span class="kw-2">&mut </span><span class="self">self</span>, ctx: <span class="kw-2">&</span>Context) -> <span class="prelude-ty">Result</span><Status>;
|
|
<a href=#202 id=202 data-nosnippet>202</a>
|
|
<a href=#203 id=203 data-nosnippet>203</a> <span class="doccomment">/// Rollback the failed procedure.
|
|
<a href=#204 id=204 data-nosnippet>204</a> ///
|
|
<a href=#205 id=205 data-nosnippet>205</a> /// The implementation must be idempotent.
|
|
<a href=#206 id=206 data-nosnippet>206</a> </span><span class="kw">async fn </span>rollback(<span class="kw-2">&mut </span><span class="self">self</span>, <span class="kw">_</span>: <span class="kw-2">&</span>Context) -> <span class="prelude-ty">Result</span><()> {
|
|
<a href=#207 id=207 data-nosnippet>207</a> error::RollbackNotSupportedSnafu {}.fail()
|
|
<a href=#208 id=208 data-nosnippet>208</a> }
|
|
<a href=#209 id=209 data-nosnippet>209</a>
|
|
<a href=#210 id=210 data-nosnippet>210</a> <span class="doccomment">/// Indicates whether it supports rolling back the procedure.
|
|
<a href=#211 id=211 data-nosnippet>211</a> </span><span class="kw">fn </span>rollback_supported(<span class="kw-2">&</span><span class="self">self</span>) -> bool {
|
|
<a href=#212 id=212 data-nosnippet>212</a> <span class="bool-val">false
|
|
<a href=#213 id=213 data-nosnippet>213</a> </span>}
|
|
<a href=#214 id=214 data-nosnippet>214</a>
|
|
<a href=#215 id=215 data-nosnippet>215</a> <span class="doccomment">/// Dump the state of the procedure to a string.
|
|
<a href=#216 id=216 data-nosnippet>216</a> </span><span class="kw">fn </span>dump(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><String>;
|
|
<a href=#217 id=217 data-nosnippet>217</a>
|
|
<a href=#218 id=218 data-nosnippet>218</a> <span class="doccomment">/// The hook is called after the procedure recovery.
|
|
<a href=#219 id=219 data-nosnippet>219</a> </span><span class="kw">fn </span>recover(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><()> {
|
|
<a href=#220 id=220 data-nosnippet>220</a> <span class="prelude-val">Ok</span>(())
|
|
<a href=#221 id=221 data-nosnippet>221</a> }
|
|
<a href=#222 id=222 data-nosnippet>222</a>
|
|
<a href=#223 id=223 data-nosnippet>223</a> <span class="doccomment">/// Returns the [LockKey] that this procedure needs to acquire.
|
|
<a href=#224 id=224 data-nosnippet>224</a> </span><span class="kw">fn </span>lock_key(<span class="kw-2">&</span><span class="self">self</span>) -> LockKey;
|
|
<a href=#225 id=225 data-nosnippet>225</a>
|
|
<a href=#226 id=226 data-nosnippet>226</a> <span class="doccomment">/// Returns the [PoisonKeys] that may cause this procedure to become poisoned during execution.
|
|
<a href=#227 id=227 data-nosnippet>227</a> </span><span class="kw">fn </span>poison_keys(<span class="kw-2">&</span><span class="self">self</span>) -> PoisonKeys {
|
|
<a href=#228 id=228 data-nosnippet>228</a> PoisonKeys::default()
|
|
<a href=#229 id=229 data-nosnippet>229</a> }
|
|
<a href=#230 id=230 data-nosnippet>230</a>
|
|
<a href=#231 id=231 data-nosnippet>231</a> <span class="doccomment">/// Returns the user metadata of the procedure. If the metadata contains the eventable object, you can use [UserMetadata::to_event] to get the event and emit it to the event recorder.
|
|
<a href=#232 id=232 data-nosnippet>232</a> </span><span class="kw">fn </span>user_metadata(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><UserMetadata> {
|
|
<a href=#233 id=233 data-nosnippet>233</a> <span class="prelude-val">None
|
|
<a href=#234 id=234 data-nosnippet>234</a> </span>}
|
|
<a href=#235 id=235 data-nosnippet>235</a>}
|
|
<a href=#236 id=236 data-nosnippet>236</a>
|
|
<a href=#237 id=237 data-nosnippet>237</a><span class="doccomment">/// The user metadata injected by the procedure caller. It can be used to emit events to the event recorder.
|
|
<a href=#238 id=238 data-nosnippet>238</a></span><span class="attr">#[derive(Clone, Debug)]
|
|
<a href=#239 id=239 data-nosnippet>239</a></span><span class="kw">pub struct </span>UserMetadata {
|
|
<a href=#240 id=240 data-nosnippet>240</a> event_object: Arc<<span class="kw">dyn </span>Eventable>,
|
|
<a href=#241 id=241 data-nosnippet>241</a>}
|
|
<a href=#242 id=242 data-nosnippet>242</a>
|
|
<a href=#243 id=243 data-nosnippet>243</a><span class="kw">impl </span>UserMetadata {
|
|
<a href=#244 id=244 data-nosnippet>244</a> <span class="doccomment">/// Creates a new [UserMetadata] with the given event object.
|
|
<a href=#245 id=245 data-nosnippet>245</a> </span><span class="kw">pub fn </span>new(event_object: Arc<<span class="kw">dyn </span>Eventable>) -> <span class="self">Self </span>{
|
|
<a href=#246 id=246 data-nosnippet>246</a> <span class="self">Self </span>{ event_object }
|
|
<a href=#247 id=247 data-nosnippet>247</a> }
|
|
<a href=#248 id=248 data-nosnippet>248</a>
|
|
<a href=#249 id=249 data-nosnippet>249</a> <span class="doccomment">/// Returns the event of the procedure. It can be None if the procedure does not emit any event.
|
|
<a href=#250 id=250 data-nosnippet>250</a> </span><span class="kw">pub fn </span>to_event(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><Box<<span class="kw">dyn </span>Event>> {
|
|
<a href=#251 id=251 data-nosnippet>251</a> <span class="self">self</span>.event_object.to_event()
|
|
<a href=#252 id=252 data-nosnippet>252</a> }
|
|
<a href=#253 id=253 data-nosnippet>253</a>}
|
|
<a href=#254 id=254 data-nosnippet>254</a>
|
|
<a href=#255 id=255 data-nosnippet>255</a><span class="attr">#[async_trait]
|
|
<a href=#256 id=256 data-nosnippet>256</a></span><span class="kw">impl</span><T: Procedure + <span class="question-mark">?</span>Sized> Procedure <span class="kw">for </span>Box<T> {
|
|
<a href=#257 id=257 data-nosnippet>257</a> <span class="kw">fn </span>type_name(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str {
|
|
<a href=#258 id=258 data-nosnippet>258</a> (<span class="kw-2">**</span><span class="self">self</span>).type_name()
|
|
<a href=#259 id=259 data-nosnippet>259</a> }
|
|
<a href=#260 id=260 data-nosnippet>260</a>
|
|
<a href=#261 id=261 data-nosnippet>261</a> <span class="kw">async fn </span>execute(<span class="kw-2">&mut </span><span class="self">self</span>, ctx: <span class="kw-2">&</span>Context) -> <span class="prelude-ty">Result</span><Status> {
|
|
<a href=#262 id=262 data-nosnippet>262</a> (<span class="kw-2">**</span><span class="self">self</span>).execute(ctx).<span class="kw">await
|
|
<a href=#263 id=263 data-nosnippet>263</a> </span>}
|
|
<a href=#264 id=264 data-nosnippet>264</a>
|
|
<a href=#265 id=265 data-nosnippet>265</a> <span class="kw">async fn </span>rollback(<span class="kw-2">&mut </span><span class="self">self</span>, ctx: <span class="kw-2">&</span>Context) -> <span class="prelude-ty">Result</span><()> {
|
|
<a href=#266 id=266 data-nosnippet>266</a> (<span class="kw-2">**</span><span class="self">self</span>).rollback(ctx).<span class="kw">await
|
|
<a href=#267 id=267 data-nosnippet>267</a> </span>}
|
|
<a href=#268 id=268 data-nosnippet>268</a>
|
|
<a href=#269 id=269 data-nosnippet>269</a> <span class="kw">fn </span>rollback_supported(<span class="kw-2">&</span><span class="self">self</span>) -> bool {
|
|
<a href=#270 id=270 data-nosnippet>270</a> (<span class="kw-2">**</span><span class="self">self</span>).rollback_supported()
|
|
<a href=#271 id=271 data-nosnippet>271</a> }
|
|
<a href=#272 id=272 data-nosnippet>272</a>
|
|
<a href=#273 id=273 data-nosnippet>273</a> <span class="kw">fn </span>dump(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><String> {
|
|
<a href=#274 id=274 data-nosnippet>274</a> (<span class="kw-2">**</span><span class="self">self</span>).dump()
|
|
<a href=#275 id=275 data-nosnippet>275</a> }
|
|
<a href=#276 id=276 data-nosnippet>276</a>
|
|
<a href=#277 id=277 data-nosnippet>277</a> <span class="kw">fn </span>lock_key(<span class="kw-2">&</span><span class="self">self</span>) -> LockKey {
|
|
<a href=#278 id=278 data-nosnippet>278</a> (<span class="kw-2">**</span><span class="self">self</span>).lock_key()
|
|
<a href=#279 id=279 data-nosnippet>279</a> }
|
|
<a href=#280 id=280 data-nosnippet>280</a>
|
|
<a href=#281 id=281 data-nosnippet>281</a> <span class="kw">fn </span>poison_keys(<span class="kw-2">&</span><span class="self">self</span>) -> PoisonKeys {
|
|
<a href=#282 id=282 data-nosnippet>282</a> (<span class="kw-2">**</span><span class="self">self</span>).poison_keys()
|
|
<a href=#283 id=283 data-nosnippet>283</a> }
|
|
<a href=#284 id=284 data-nosnippet>284</a>}
|
|
<a href=#285 id=285 data-nosnippet>285</a>
|
|
<a href=#286 id=286 data-nosnippet>286</a><span class="attr">#[derive(Clone, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
|
<a href=#287 id=287 data-nosnippet>287</a></span><span class="kw">pub struct </span>PoisonKey(String);
|
|
<a href=#288 id=288 data-nosnippet>288</a>
|
|
<a href=#289 id=289 data-nosnippet>289</a><span class="kw">impl </span>Display <span class="kw">for </span>PoisonKey {
|
|
<a href=#290 id=290 data-nosnippet>290</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result {
|
|
<a href=#291 id=291 data-nosnippet>291</a> <span class="macro">write!</span>(f, <span class="string">"{}"</span>, <span class="self">self</span>.<span class="number">0</span>)
|
|
<a href=#292 id=292 data-nosnippet>292</a> }
|
|
<a href=#293 id=293 data-nosnippet>293</a>}
|
|
<a href=#294 id=294 data-nosnippet>294</a>
|
|
<a href=#295 id=295 data-nosnippet>295</a><span class="kw">impl </span>PoisonKey {
|
|
<a href=#296 id=296 data-nosnippet>296</a> <span class="doccomment">/// Creates a new [PoisonKey] from a [String].
|
|
<a href=#297 id=297 data-nosnippet>297</a> </span><span class="kw">pub fn </span>new(key: <span class="kw">impl </span>Into<String>) -> <span class="self">Self </span>{
|
|
<a href=#298 id=298 data-nosnippet>298</a> <span class="self">Self</span>(key.into())
|
|
<a href=#299 id=299 data-nosnippet>299</a> }
|
|
<a href=#300 id=300 data-nosnippet>300</a>}
|
|
<a href=#301 id=301 data-nosnippet>301</a>
|
|
<a href=#302 id=302 data-nosnippet>302</a><span class="doccomment">/// A collection of [PoisonKey]s.
|
|
<a href=#303 id=303 data-nosnippet>303</a>///
|
|
<a href=#304 id=304 data-nosnippet>304</a>/// This type is used to represent the keys that may cause the procedure to become poisoned during execution.
|
|
<a href=#305 id=305 data-nosnippet>305</a></span><span class="attr">#[derive(Clone, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, Default)]
|
|
<a href=#306 id=306 data-nosnippet>306</a></span><span class="kw">pub struct </span>PoisonKeys(SmallVec<[PoisonKey; <span class="number">2</span>]>);
|
|
<a href=#307 id=307 data-nosnippet>307</a>
|
|
<a href=#308 id=308 data-nosnippet>308</a><span class="kw">impl </span>PoisonKeys {
|
|
<a href=#309 id=309 data-nosnippet>309</a> <span class="doccomment">/// Creates a new [PoisonKeys] from a [String].
|
|
<a href=#310 id=310 data-nosnippet>310</a> </span><span class="kw">pub fn </span>single(key: <span class="kw">impl </span>Into<String>) -> <span class="self">Self </span>{
|
|
<a href=#311 id=311 data-nosnippet>311</a> <span class="self">Self</span>(<span class="macro">smallvec!</span>[PoisonKey::new(key)])
|
|
<a href=#312 id=312 data-nosnippet>312</a> }
|
|
<a href=#313 id=313 data-nosnippet>313</a>
|
|
<a href=#314 id=314 data-nosnippet>314</a> <span class="doccomment">/// Creates a new [PoisonKeys] from a [PoisonKey].
|
|
<a href=#315 id=315 data-nosnippet>315</a> </span><span class="kw">pub fn </span>new(keys: <span class="kw">impl </span>IntoIterator<Item = PoisonKey>) -> <span class="self">Self </span>{
|
|
<a href=#316 id=316 data-nosnippet>316</a> <span class="self">Self</span>(keys.into_iter().collect())
|
|
<a href=#317 id=317 data-nosnippet>317</a> }
|
|
<a href=#318 id=318 data-nosnippet>318</a>
|
|
<a href=#319 id=319 data-nosnippet>319</a> <span class="doccomment">/// Returns `true` if the [PoisonKeys] contains the given [PoisonKey].
|
|
<a href=#320 id=320 data-nosnippet>320</a> </span><span class="kw">pub fn </span>contains(<span class="kw-2">&</span><span class="self">self</span>, key: <span class="kw-2">&</span>PoisonKey) -> bool {
|
|
<a href=#321 id=321 data-nosnippet>321</a> <span class="self">self</span>.<span class="number">0</span>.contains(key)
|
|
<a href=#322 id=322 data-nosnippet>322</a> }
|
|
<a href=#323 id=323 data-nosnippet>323</a>
|
|
<a href=#324 id=324 data-nosnippet>324</a> <span class="doccomment">/// Returns an iterator over the [PoisonKey]s.
|
|
<a href=#325 id=325 data-nosnippet>325</a> </span><span class="kw">pub fn </span>iter(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw">impl </span>Iterator<Item = <span class="kw-2">&</span>PoisonKey> {
|
|
<a href=#326 id=326 data-nosnippet>326</a> <span class="self">self</span>.<span class="number">0</span>.iter()
|
|
<a href=#327 id=327 data-nosnippet>327</a> }
|
|
<a href=#328 id=328 data-nosnippet>328</a>}
|
|
<a href=#329 id=329 data-nosnippet>329</a>
|
|
<a href=#330 id=330 data-nosnippet>330</a><span class="attr">#[derive(Clone, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
|
<a href=#331 id=331 data-nosnippet>331</a></span><span class="kw">pub enum </span>StringKey {
|
|
<a href=#332 id=332 data-nosnippet>332</a> Share(String),
|
|
<a href=#333 id=333 data-nosnippet>333</a> Exclusive(String),
|
|
<a href=#334 id=334 data-nosnippet>334</a>}
|
|
<a href=#335 id=335 data-nosnippet>335</a>
|
|
<a href=#336 id=336 data-nosnippet>336</a><span class="doccomment">/// Keys to identify required locks.
|
|
<a href=#337 id=337 data-nosnippet>337</a>///
|
|
<a href=#338 id=338 data-nosnippet>338</a>/// [LockKey] always sorts keys lexicographically so that they can be acquired
|
|
<a href=#339 id=339 data-nosnippet>339</a>/// in the same order.
|
|
<a href=#340 id=340 data-nosnippet>340</a>/// Most procedures should only acquire 1 ~ 2 locks so we use smallvec to hold keys.
|
|
<a href=#341 id=341 data-nosnippet>341</a></span><span class="attr">#[derive(Clone, Debug, Default, PartialEq, Eq)]
|
|
<a href=#342 id=342 data-nosnippet>342</a></span><span class="kw">pub struct </span>LockKey(SmallVec<[StringKey; <span class="number">2</span>]>);
|
|
<a href=#343 id=343 data-nosnippet>343</a>
|
|
<a href=#344 id=344 data-nosnippet>344</a><span class="kw">impl </span>StringKey {
|
|
<a href=#345 id=345 data-nosnippet>345</a> <span class="kw">pub fn </span>into_string(<span class="self">self</span>) -> String {
|
|
<a href=#346 id=346 data-nosnippet>346</a> <span class="kw">match </span><span class="self">self </span>{
|
|
<a href=#347 id=347 data-nosnippet>347</a> StringKey::Share(s) => s,
|
|
<a href=#348 id=348 data-nosnippet>348</a> StringKey::Exclusive(s) => s,
|
|
<a href=#349 id=349 data-nosnippet>349</a> }
|
|
<a href=#350 id=350 data-nosnippet>350</a> }
|
|
<a href=#351 id=351 data-nosnippet>351</a>
|
|
<a href=#352 id=352 data-nosnippet>352</a> <span class="kw">pub fn </span>as_string(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>String {
|
|
<a href=#353 id=353 data-nosnippet>353</a> <span class="kw">match </span><span class="self">self </span>{
|
|
<a href=#354 id=354 data-nosnippet>354</a> StringKey::Share(s) => s,
|
|
<a href=#355 id=355 data-nosnippet>355</a> StringKey::Exclusive(s) => s,
|
|
<a href=#356 id=356 data-nosnippet>356</a> }
|
|
<a href=#357 id=357 data-nosnippet>357</a> }
|
|
<a href=#358 id=358 data-nosnippet>358</a>}
|
|
<a href=#359 id=359 data-nosnippet>359</a>
|
|
<a href=#360 id=360 data-nosnippet>360</a><span class="kw">impl </span>LockKey {
|
|
<a href=#361 id=361 data-nosnippet>361</a> <span class="doccomment">/// Returns a new [LockKey] with only one key.
|
|
<a href=#362 id=362 data-nosnippet>362</a> </span><span class="kw">pub fn </span>single(key: <span class="kw">impl </span>Into<StringKey>) -> LockKey {
|
|
<a href=#363 id=363 data-nosnippet>363</a> LockKey(<span class="macro">smallvec!</span>[key.into()])
|
|
<a href=#364 id=364 data-nosnippet>364</a> }
|
|
<a href=#365 id=365 data-nosnippet>365</a>
|
|
<a href=#366 id=366 data-nosnippet>366</a> <span class="doccomment">/// Returns a new [LockKey] with only one key.
|
|
<a href=#367 id=367 data-nosnippet>367</a> </span><span class="kw">pub fn </span>single_exclusive(key: <span class="kw">impl </span>Into<String>) -> LockKey {
|
|
<a href=#368 id=368 data-nosnippet>368</a> LockKey(<span class="macro">smallvec!</span>[StringKey::Exclusive(key.into())])
|
|
<a href=#369 id=369 data-nosnippet>369</a> }
|
|
<a href=#370 id=370 data-nosnippet>370</a>
|
|
<a href=#371 id=371 data-nosnippet>371</a> <span class="doccomment">/// Returns a new [LockKey] with keys from specific `iter`.
|
|
<a href=#372 id=372 data-nosnippet>372</a> </span><span class="kw">pub fn </span>new(iter: <span class="kw">impl </span>IntoIterator<Item = StringKey>) -> LockKey {
|
|
<a href=#373 id=373 data-nosnippet>373</a> <span class="kw">let </span><span class="kw-2">mut </span>vec: SmallVec<<span class="kw">_</span>> = iter.into_iter().collect();
|
|
<a href=#374 id=374 data-nosnippet>374</a> vec.sort();
|
|
<a href=#375 id=375 data-nosnippet>375</a> <span class="comment">// Dedup keys to avoid acquiring the same key multiple times.
|
|
<a href=#376 id=376 data-nosnippet>376</a> </span>vec.dedup();
|
|
<a href=#377 id=377 data-nosnippet>377</a> LockKey(vec)
|
|
<a href=#378 id=378 data-nosnippet>378</a> }
|
|
<a href=#379 id=379 data-nosnippet>379</a>
|
|
<a href=#380 id=380 data-nosnippet>380</a> <span class="doccomment">/// Returns a new [LockKey] with keys from specific `iter`.
|
|
<a href=#381 id=381 data-nosnippet>381</a> </span><span class="kw">pub fn </span>new_exclusive(iter: <span class="kw">impl </span>IntoIterator<Item = String>) -> LockKey {
|
|
<a href=#382 id=382 data-nosnippet>382</a> <span class="self">Self</span>::new(iter.into_iter().map(StringKey::Exclusive))
|
|
<a href=#383 id=383 data-nosnippet>383</a> }
|
|
<a href=#384 id=384 data-nosnippet>384</a>
|
|
<a href=#385 id=385 data-nosnippet>385</a> <span class="doccomment">/// Returns the keys to lock.
|
|
<a href=#386 id=386 data-nosnippet>386</a> </span><span class="kw">pub fn </span>keys_to_lock(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw">impl </span>Iterator<Item = <span class="kw-2">&</span>StringKey> {
|
|
<a href=#387 id=387 data-nosnippet>387</a> <span class="self">self</span>.<span class="number">0</span>.iter()
|
|
<a href=#388 id=388 data-nosnippet>388</a> }
|
|
<a href=#389 id=389 data-nosnippet>389</a>
|
|
<a href=#390 id=390 data-nosnippet>390</a> <span class="doccomment">/// Returns the keys to lock.
|
|
<a href=#391 id=391 data-nosnippet>391</a> </span><span class="kw">pub fn </span>get_keys(<span class="kw-2">&</span><span class="self">self</span>) -> Vec<String> {
|
|
<a href=#392 id=392 data-nosnippet>392</a> <span class="self">self</span>.<span class="number">0</span>.iter().map(|key| <span class="macro">format!</span>(<span class="string">"{:?}"</span>, key)).collect()
|
|
<a href=#393 id=393 data-nosnippet>393</a> }
|
|
<a href=#394 id=394 data-nosnippet>394</a>}
|
|
<a href=#395 id=395 data-nosnippet>395</a>
|
|
<a href=#396 id=396 data-nosnippet>396</a><span class="doccomment">/// Boxed [Procedure].
|
|
<a href=#397 id=397 data-nosnippet>397</a></span><span class="kw">pub type </span>BoxedProcedure = Box<<span class="kw">dyn </span>Procedure>;
|
|
<a href=#398 id=398 data-nosnippet>398</a>
|
|
<a href=#399 id=399 data-nosnippet>399</a><span class="doccomment">/// A procedure with specific id.
|
|
<a href=#400 id=400 data-nosnippet>400</a></span><span class="kw">pub struct </span>ProcedureWithId {
|
|
<a href=#401 id=401 data-nosnippet>401</a> <span class="doccomment">/// Id of the procedure.
|
|
<a href=#402 id=402 data-nosnippet>402</a> </span><span class="kw">pub </span>id: ProcedureId,
|
|
<a href=#403 id=403 data-nosnippet>403</a> <span class="kw">pub </span>procedure: BoxedProcedure,
|
|
<a href=#404 id=404 data-nosnippet>404</a>}
|
|
<a href=#405 id=405 data-nosnippet>405</a>
|
|
<a href=#406 id=406 data-nosnippet>406</a><span class="kw">impl </span>ProcedureWithId {
|
|
<a href=#407 id=407 data-nosnippet>407</a> <span class="doccomment">/// Returns a new [ProcedureWithId] that holds specific `procedure`
|
|
<a href=#408 id=408 data-nosnippet>408</a> /// and a random [ProcedureId].
|
|
<a href=#409 id=409 data-nosnippet>409</a> </span><span class="kw">pub fn </span>with_random_id(procedure: BoxedProcedure) -> ProcedureWithId {
|
|
<a href=#410 id=410 data-nosnippet>410</a> ProcedureWithId {
|
|
<a href=#411 id=411 data-nosnippet>411</a> id: ProcedureId::random(),
|
|
<a href=#412 id=412 data-nosnippet>412</a> procedure,
|
|
<a href=#413 id=413 data-nosnippet>413</a> }
|
|
<a href=#414 id=414 data-nosnippet>414</a> }
|
|
<a href=#415 id=415 data-nosnippet>415</a>}
|
|
<a href=#416 id=416 data-nosnippet>416</a>
|
|
<a href=#417 id=417 data-nosnippet>417</a><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>ProcedureWithId {
|
|
<a href=#418 id=418 data-nosnippet>418</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result {
|
|
<a href=#419 id=419 data-nosnippet>419</a> <span class="macro">write!</span>(f, <span class="string">"{}-{}"</span>, <span class="self">self</span>.procedure.type_name(), <span class="self">self</span>.id)
|
|
<a href=#420 id=420 data-nosnippet>420</a> }
|
|
<a href=#421 id=421 data-nosnippet>421</a>}
|
|
<a href=#422 id=422 data-nosnippet>422</a>
|
|
<a href=#423 id=423 data-nosnippet>423</a><span class="attr">#[derive(Debug, Snafu)]
|
|
<a href=#424 id=424 data-nosnippet>424</a></span><span class="kw">pub struct </span>ParseIdError {
|
|
<a href=#425 id=425 data-nosnippet>425</a> source: uuid::Error,
|
|
<a href=#426 id=426 data-nosnippet>426</a>}
|
|
<a href=#427 id=427 data-nosnippet>427</a>
|
|
<a href=#428 id=428 data-nosnippet>428</a><span class="doccomment">/// Unique id for [Procedure].
|
|
<a href=#429 id=429 data-nosnippet>429</a></span><span class="attr">#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
|
|
<a href=#430 id=430 data-nosnippet>430</a></span><span class="kw">pub struct </span>ProcedureId(Uuid);
|
|
<a href=#431 id=431 data-nosnippet>431</a>
|
|
<a href=#432 id=432 data-nosnippet>432</a><span class="kw">impl </span>ProcedureId {
|
|
<a href=#433 id=433 data-nosnippet>433</a> <span class="doccomment">/// Returns a new unique [ProcedureId] randomly.
|
|
<a href=#434 id=434 data-nosnippet>434</a> </span><span class="kw">pub fn </span>random() -> ProcedureId {
|
|
<a href=#435 id=435 data-nosnippet>435</a> ProcedureId(Uuid::new_v4())
|
|
<a href=#436 id=436 data-nosnippet>436</a> }
|
|
<a href=#437 id=437 data-nosnippet>437</a>
|
|
<a href=#438 id=438 data-nosnippet>438</a> <span class="doccomment">/// Parses id from string.
|
|
<a href=#439 id=439 data-nosnippet>439</a> </span><span class="kw">pub fn </span>parse_str(input: <span class="kw-2">&</span>str) -> std::result::Result<ProcedureId, ParseIdError> {
|
|
<a href=#440 id=440 data-nosnippet>440</a> Uuid::parse_str(input)
|
|
<a href=#441 id=441 data-nosnippet>441</a> .map(ProcedureId)
|
|
<a href=#442 id=442 data-nosnippet>442</a> .context(ParseIdSnafu)
|
|
<a href=#443 id=443 data-nosnippet>443</a> }
|
|
<a href=#444 id=444 data-nosnippet>444</a>}
|
|
<a href=#445 id=445 data-nosnippet>445</a>
|
|
<a href=#446 id=446 data-nosnippet>446</a><span class="kw">impl </span>fmt::Display <span class="kw">for </span>ProcedureId {
|
|
<a href=#447 id=447 data-nosnippet>447</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result {
|
|
<a href=#448 id=448 data-nosnippet>448</a> <span class="macro">write!</span>(f, <span class="string">"{}"</span>, <span class="self">self</span>.<span class="number">0</span>)
|
|
<a href=#449 id=449 data-nosnippet>449</a> }
|
|
<a href=#450 id=450 data-nosnippet>450</a>}
|
|
<a href=#451 id=451 data-nosnippet>451</a>
|
|
<a href=#452 id=452 data-nosnippet>452</a><span class="kw">impl </span>FromStr <span class="kw">for </span>ProcedureId {
|
|
<a href=#453 id=453 data-nosnippet>453</a> <span class="kw">type </span><span class="prelude-val">Err </span>= ParseIdError;
|
|
<a href=#454 id=454 data-nosnippet>454</a>
|
|
<a href=#455 id=455 data-nosnippet>455</a> <span class="kw">fn </span>from_str(s: <span class="kw-2">&</span>str) -> std::result::Result<ProcedureId, ParseIdError> {
|
|
<a href=#456 id=456 data-nosnippet>456</a> ProcedureId::parse_str(s)
|
|
<a href=#457 id=457 data-nosnippet>457</a> }
|
|
<a href=#458 id=458 data-nosnippet>458</a>}
|
|
<a href=#459 id=459 data-nosnippet>459</a>
|
|
<a href=#460 id=460 data-nosnippet>460</a><span class="doccomment">/// Loader to recover the [Procedure] instance from serialized data.
|
|
<a href=#461 id=461 data-nosnippet>461</a></span><span class="kw">pub type </span>BoxedProcedureLoader = Box<<span class="kw">dyn </span>Fn(<span class="kw-2">&</span>str) -> <span class="prelude-ty">Result</span><BoxedProcedure> + Send>;
|
|
<a href=#462 id=462 data-nosnippet>462</a>
|
|
<a href=#463 id=463 data-nosnippet>463</a><span class="doccomment">/// State of a submitted procedure.
|
|
<a href=#464 id=464 data-nosnippet>464</a></span><span class="attr">#[derive(Debug, Default, Clone)]
|
|
<a href=#465 id=465 data-nosnippet>465</a></span><span class="kw">pub enum </span>ProcedureState {
|
|
<a href=#466 id=466 data-nosnippet>466</a> <span class="doccomment">/// The procedure is running.
|
|
<a href=#467 id=467 data-nosnippet>467</a> </span><span class="attr">#[default]
|
|
<a href=#468 id=468 data-nosnippet>468</a> </span>Running,
|
|
<a href=#469 id=469 data-nosnippet>469</a> <span class="doccomment">/// The procedure is finished.
|
|
<a href=#470 id=470 data-nosnippet>470</a> </span>Done { output: <span class="prelude-ty">Option</span><Output> },
|
|
<a href=#471 id=471 data-nosnippet>471</a> <span class="doccomment">/// The procedure is failed and can be retried.
|
|
<a href=#472 id=472 data-nosnippet>472</a> </span>Retrying { error: Arc<Error> },
|
|
<a href=#473 id=473 data-nosnippet>473</a> <span class="doccomment">/// The procedure is failed and commits state before rolling back the procedure.
|
|
<a href=#474 id=474 data-nosnippet>474</a> </span>PrepareRollback { error: Arc<Error> },
|
|
<a href=#475 id=475 data-nosnippet>475</a> <span class="doccomment">/// The procedure is failed and can be rollback.
|
|
<a href=#476 id=476 data-nosnippet>476</a> </span>RollingBack { error: Arc<Error> },
|
|
<a href=#477 id=477 data-nosnippet>477</a> <span class="doccomment">/// The procedure is failed and cannot proceed anymore.
|
|
<a href=#478 id=478 data-nosnippet>478</a> </span>Failed { error: Arc<Error> },
|
|
<a href=#479 id=479 data-nosnippet>479</a> <span class="doccomment">/// The procedure is poisoned.
|
|
<a href=#480 id=480 data-nosnippet>480</a> </span>Poisoned { keys: PoisonKeys, error: Arc<Error> },
|
|
<a href=#481 id=481 data-nosnippet>481</a>}
|
|
<a href=#482 id=482 data-nosnippet>482</a>
|
|
<a href=#483 id=483 data-nosnippet>483</a><span class="kw">impl </span>ProcedureState {
|
|
<a href=#484 id=484 data-nosnippet>484</a> <span class="doccomment">/// Returns a [ProcedureState] with failed state.
|
|
<a href=#485 id=485 data-nosnippet>485</a> </span><span class="kw">pub fn </span>failed(error: Arc<Error>) -> ProcedureState {
|
|
<a href=#486 id=486 data-nosnippet>486</a> ProcedureState::Failed { error }
|
|
<a href=#487 id=487 data-nosnippet>487</a> }
|
|
<a href=#488 id=488 data-nosnippet>488</a>
|
|
<a href=#489 id=489 data-nosnippet>489</a> <span class="doccomment">/// Returns a [ProcedureState] with prepare rollback state.
|
|
<a href=#490 id=490 data-nosnippet>490</a> </span><span class="kw">pub fn </span>prepare_rollback(error: Arc<Error>) -> ProcedureState {
|
|
<a href=#491 id=491 data-nosnippet>491</a> ProcedureState::PrepareRollback { error }
|
|
<a href=#492 id=492 data-nosnippet>492</a> }
|
|
<a href=#493 id=493 data-nosnippet>493</a>
|
|
<a href=#494 id=494 data-nosnippet>494</a> <span class="doccomment">/// Returns a [ProcedureState] with rolling back state.
|
|
<a href=#495 id=495 data-nosnippet>495</a> </span><span class="kw">pub fn </span>rolling_back(error: Arc<Error>) -> ProcedureState {
|
|
<a href=#496 id=496 data-nosnippet>496</a> ProcedureState::RollingBack { error }
|
|
<a href=#497 id=497 data-nosnippet>497</a> }
|
|
<a href=#498 id=498 data-nosnippet>498</a>
|
|
<a href=#499 id=499 data-nosnippet>499</a> <span class="doccomment">/// Returns a [ProcedureState] with retrying state.
|
|
<a href=#500 id=500 data-nosnippet>500</a> </span><span class="kw">pub fn </span>retrying(error: Arc<Error>) -> ProcedureState {
|
|
<a href=#501 id=501 data-nosnippet>501</a> ProcedureState::Retrying { error }
|
|
<a href=#502 id=502 data-nosnippet>502</a> }
|
|
<a href=#503 id=503 data-nosnippet>503</a>
|
|
<a href=#504 id=504 data-nosnippet>504</a> <span class="doccomment">/// Returns a [ProcedureState] with poisoned state.
|
|
<a href=#505 id=505 data-nosnippet>505</a> </span><span class="kw">pub fn </span>poisoned(keys: PoisonKeys, error: Arc<Error>) -> ProcedureState {
|
|
<a href=#506 id=506 data-nosnippet>506</a> ProcedureState::Poisoned { keys, error }
|
|
<a href=#507 id=507 data-nosnippet>507</a> }
|
|
<a href=#508 id=508 data-nosnippet>508</a>
|
|
<a href=#509 id=509 data-nosnippet>509</a> <span class="doccomment">/// Returns true if the procedure state is running.
|
|
<a href=#510 id=510 data-nosnippet>510</a> </span><span class="kw">pub fn </span>is_running(<span class="kw-2">&</span><span class="self">self</span>) -> bool {
|
|
<a href=#511 id=511 data-nosnippet>511</a> <span class="macro">matches!</span>(<span class="self">self</span>, ProcedureState::Running)
|
|
<a href=#512 id=512 data-nosnippet>512</a> }
|
|
<a href=#513 id=513 data-nosnippet>513</a>
|
|
<a href=#514 id=514 data-nosnippet>514</a> <span class="doccomment">/// Returns true if the procedure state is done.
|
|
<a href=#515 id=515 data-nosnippet>515</a> </span><span class="kw">pub fn </span>is_done(<span class="kw-2">&</span><span class="self">self</span>) -> bool {
|
|
<a href=#516 id=516 data-nosnippet>516</a> <span class="macro">matches!</span>(<span class="self">self</span>, ProcedureState::Done { .. })
|
|
<a href=#517 id=517 data-nosnippet>517</a> }
|
|
<a href=#518 id=518 data-nosnippet>518</a>
|
|
<a href=#519 id=519 data-nosnippet>519</a> <span class="doccomment">/// Returns true if the procedure state is poisoned.
|
|
<a href=#520 id=520 data-nosnippet>520</a> </span><span class="kw">pub fn </span>is_poisoned(<span class="kw-2">&</span><span class="self">self</span>) -> bool {
|
|
<a href=#521 id=521 data-nosnippet>521</a> <span class="macro">matches!</span>(<span class="self">self</span>, ProcedureState::Poisoned { .. })
|
|
<a href=#522 id=522 data-nosnippet>522</a> }
|
|
<a href=#523 id=523 data-nosnippet>523</a>
|
|
<a href=#524 id=524 data-nosnippet>524</a> <span class="doccomment">/// Returns true if the procedure state failed.
|
|
<a href=#525 id=525 data-nosnippet>525</a> </span><span class="kw">pub fn </span>is_failed(<span class="kw-2">&</span><span class="self">self</span>) -> bool {
|
|
<a href=#526 id=526 data-nosnippet>526</a> <span class="macro">matches!</span>(<span class="self">self</span>, ProcedureState::Failed { .. })
|
|
<a href=#527 id=527 data-nosnippet>527</a> }
|
|
<a href=#528 id=528 data-nosnippet>528</a>
|
|
<a href=#529 id=529 data-nosnippet>529</a> <span class="doccomment">/// Returns true if the procedure state is retrying.
|
|
<a href=#530 id=530 data-nosnippet>530</a> </span><span class="kw">pub fn </span>is_retrying(<span class="kw-2">&</span><span class="self">self</span>) -> bool {
|
|
<a href=#531 id=531 data-nosnippet>531</a> <span class="macro">matches!</span>(<span class="self">self</span>, ProcedureState::Retrying { .. })
|
|
<a href=#532 id=532 data-nosnippet>532</a> }
|
|
<a href=#533 id=533 data-nosnippet>533</a>
|
|
<a href=#534 id=534 data-nosnippet>534</a> <span class="doccomment">/// Returns true if the procedure state is rolling back.
|
|
<a href=#535 id=535 data-nosnippet>535</a> </span><span class="kw">pub fn </span>is_rolling_back(<span class="kw-2">&</span><span class="self">self</span>) -> bool {
|
|
<a href=#536 id=536 data-nosnippet>536</a> <span class="macro">matches!</span>(<span class="self">self</span>, ProcedureState::RollingBack { .. })
|
|
<a href=#537 id=537 data-nosnippet>537</a> }
|
|
<a href=#538 id=538 data-nosnippet>538</a>
|
|
<a href=#539 id=539 data-nosnippet>539</a> <span class="doccomment">/// Returns true if the procedure state is prepare rollback.
|
|
<a href=#540 id=540 data-nosnippet>540</a> </span><span class="kw">pub fn </span>is_prepare_rollback(<span class="kw-2">&</span><span class="self">self</span>) -> bool {
|
|
<a href=#541 id=541 data-nosnippet>541</a> <span class="macro">matches!</span>(<span class="self">self</span>, ProcedureState::PrepareRollback { .. })
|
|
<a href=#542 id=542 data-nosnippet>542</a> }
|
|
<a href=#543 id=543 data-nosnippet>543</a>
|
|
<a href=#544 id=544 data-nosnippet>544</a> <span class="doccomment">/// Returns the error.
|
|
<a href=#545 id=545 data-nosnippet>545</a> </span><span class="kw">pub fn </span>error(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>Arc<Error>> {
|
|
<a href=#546 id=546 data-nosnippet>546</a> <span class="kw">match </span><span class="self">self </span>{
|
|
<a href=#547 id=547 data-nosnippet>547</a> ProcedureState::Failed { error } => <span class="prelude-val">Some</span>(error),
|
|
<a href=#548 id=548 data-nosnippet>548</a> ProcedureState::Retrying { error } => <span class="prelude-val">Some</span>(error),
|
|
<a href=#549 id=549 data-nosnippet>549</a> ProcedureState::RollingBack { error } => <span class="prelude-val">Some</span>(error),
|
|
<a href=#550 id=550 data-nosnippet>550</a> ProcedureState::Poisoned { error, .. } => <span class="prelude-val">Some</span>(error),
|
|
<a href=#551 id=551 data-nosnippet>551</a> <span class="kw">_ </span>=> <span class="prelude-val">None</span>,
|
|
<a href=#552 id=552 data-nosnippet>552</a> }
|
|
<a href=#553 id=553 data-nosnippet>553</a> }
|
|
<a href=#554 id=554 data-nosnippet>554</a>
|
|
<a href=#555 id=555 data-nosnippet>555</a> <span class="doccomment">/// Return the string values of the enum field names.
|
|
<a href=#556 id=556 data-nosnippet>556</a> </span><span class="kw">pub fn </span>as_str_name(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str {
|
|
<a href=#557 id=557 data-nosnippet>557</a> <span class="kw">match </span><span class="self">self </span>{
|
|
<a href=#558 id=558 data-nosnippet>558</a> ProcedureState::Running => <span class="string">"Running"</span>,
|
|
<a href=#559 id=559 data-nosnippet>559</a> ProcedureState::Done { .. } => <span class="string">"Done"</span>,
|
|
<a href=#560 id=560 data-nosnippet>560</a> ProcedureState::Retrying { .. } => <span class="string">"Retrying"</span>,
|
|
<a href=#561 id=561 data-nosnippet>561</a> ProcedureState::Failed { .. } => <span class="string">"Failed"</span>,
|
|
<a href=#562 id=562 data-nosnippet>562</a> ProcedureState::PrepareRollback { .. } => <span class="string">"PrepareRollback"</span>,
|
|
<a href=#563 id=563 data-nosnippet>563</a> ProcedureState::RollingBack { .. } => <span class="string">"RollingBack"</span>,
|
|
<a href=#564 id=564 data-nosnippet>564</a> ProcedureState::Poisoned { .. } => <span class="string">"Poisoned"</span>,
|
|
<a href=#565 id=565 data-nosnippet>565</a> }
|
|
<a href=#566 id=566 data-nosnippet>566</a> }
|
|
<a href=#567 id=567 data-nosnippet>567</a>}
|
|
<a href=#568 id=568 data-nosnippet>568</a>
|
|
<a href=#569 id=569 data-nosnippet>569</a><span class="doccomment">/// The initial procedure state.
|
|
<a href=#570 id=570 data-nosnippet>570</a></span><span class="attr">#[derive(Debug, Clone)]
|
|
<a href=#571 id=571 data-nosnippet>571</a></span><span class="kw">pub enum </span>InitProcedureState {
|
|
<a href=#572 id=572 data-nosnippet>572</a> Running,
|
|
<a href=#573 id=573 data-nosnippet>573</a> RollingBack,
|
|
<a href=#574 id=574 data-nosnippet>574</a>}
|
|
<a href=#575 id=575 data-nosnippet>575</a>
|
|
<a href=#576 id=576 data-nosnippet>576</a><span class="comment">// TODO(yingwen): Shutdown
|
|
<a href=#577 id=577 data-nosnippet>577</a></span><span class="doccomment">/// `ProcedureManager` executes [Procedure] submitted to it.
|
|
<a href=#578 id=578 data-nosnippet>578</a></span><span class="attr">#[async_trait]
|
|
<a href=#579 id=579 data-nosnippet>579</a></span><span class="kw">pub trait </span>ProcedureManager: Send + Sync + <span class="lifetime">'static </span>{
|
|
<a href=#580 id=580 data-nosnippet>580</a> <span class="doccomment">/// Registers loader for specific procedure type `name`.
|
|
<a href=#581 id=581 data-nosnippet>581</a> </span><span class="kw">fn </span>register_loader(<span class="kw-2">&</span><span class="self">self</span>, name: <span class="kw-2">&</span>str, loader: BoxedProcedureLoader) -> <span class="prelude-ty">Result</span><()>;
|
|
<a href=#582 id=582 data-nosnippet>582</a>
|
|
<a href=#583 id=583 data-nosnippet>583</a> <span class="doccomment">/// Starts the background GC task.
|
|
<a href=#584 id=584 data-nosnippet>584</a> ///
|
|
<a href=#585 id=585 data-nosnippet>585</a> /// Recovers unfinished procedures and reruns them.
|
|
<a href=#586 id=586 data-nosnippet>586</a> ///
|
|
<a href=#587 id=587 data-nosnippet>587</a> /// Callers should ensure all loaders are registered.
|
|
<a href=#588 id=588 data-nosnippet>588</a> </span><span class="kw">async fn </span>start(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><()>;
|
|
<a href=#589 id=589 data-nosnippet>589</a>
|
|
<a href=#590 id=590 data-nosnippet>590</a> <span class="doccomment">/// Stops the background GC task.
|
|
<a href=#591 id=591 data-nosnippet>591</a> </span><span class="kw">async fn </span>stop(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><()>;
|
|
<a href=#592 id=592 data-nosnippet>592</a>
|
|
<a href=#593 id=593 data-nosnippet>593</a> <span class="doccomment">/// Submits a procedure to execute.
|
|
<a href=#594 id=594 data-nosnippet>594</a> ///
|
|
<a href=#595 id=595 data-nosnippet>595</a> /// Returns a [Watcher] to watch the created procedure.
|
|
<a href=#596 id=596 data-nosnippet>596</a> </span><span class="kw">async fn </span>submit(<span class="kw-2">&</span><span class="self">self</span>, procedure: ProcedureWithId) -> <span class="prelude-ty">Result</span><Watcher>;
|
|
<a href=#597 id=597 data-nosnippet>597</a>
|
|
<a href=#598 id=598 data-nosnippet>598</a> <span class="doccomment">/// Query the procedure state.
|
|
<a href=#599 id=599 data-nosnippet>599</a> ///
|
|
<a href=#600 id=600 data-nosnippet>600</a> /// Returns `Ok(None)` if the procedure doesn't exist.
|
|
<a href=#601 id=601 data-nosnippet>601</a> </span><span class="kw">async fn </span>procedure_state(<span class="kw-2">&</span><span class="self">self</span>, procedure_id: ProcedureId) -> <span class="prelude-ty">Result</span><<span class="prelude-ty">Option</span><ProcedureState>>;
|
|
<a href=#602 id=602 data-nosnippet>602</a>
|
|
<a href=#603 id=603 data-nosnippet>603</a> <span class="doccomment">/// Returns a [Watcher] to watch [ProcedureState] of specific procedure.
|
|
<a href=#604 id=604 data-nosnippet>604</a> </span><span class="kw">fn </span>procedure_watcher(<span class="kw-2">&</span><span class="self">self</span>, procedure_id: ProcedureId) -> <span class="prelude-ty">Option</span><Watcher>;
|
|
<a href=#605 id=605 data-nosnippet>605</a>
|
|
<a href=#606 id=606 data-nosnippet>606</a> <span class="doccomment">/// Returns the details of the procedure.
|
|
<a href=#607 id=607 data-nosnippet>607</a> </span><span class="kw">async fn </span>list_procedures(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><Vec<ProcedureInfo>>;
|
|
<a href=#608 id=608 data-nosnippet>608</a>}
|
|
<a href=#609 id=609 data-nosnippet>609</a>
|
|
<a href=#610 id=610 data-nosnippet>610</a><span class="doccomment">/// Ref-counted pointer to the [ProcedureManager].
|
|
<a href=#611 id=611 data-nosnippet>611</a></span><span class="kw">pub type </span>ProcedureManagerRef = Arc<<span class="kw">dyn </span>ProcedureManager>;
|
|
<a href=#612 id=612 data-nosnippet>612</a>
|
|
<a href=#613 id=613 data-nosnippet>613</a><span class="attr">#[derive(Debug, Clone)]
|
|
<a href=#614 id=614 data-nosnippet>614</a></span><span class="kw">pub struct </span>ProcedureInfo {
|
|
<a href=#615 id=615 data-nosnippet>615</a> <span class="doccomment">/// Id of this procedure.
|
|
<a href=#616 id=616 data-nosnippet>616</a> </span><span class="kw">pub </span>id: ProcedureId,
|
|
<a href=#617 id=617 data-nosnippet>617</a> <span class="doccomment">/// Type name of this procedure.
|
|
<a href=#618 id=618 data-nosnippet>618</a> </span><span class="kw">pub </span>type_name: String,
|
|
<a href=#619 id=619 data-nosnippet>619</a> <span class="doccomment">/// Start execution time of this procedure.
|
|
<a href=#620 id=620 data-nosnippet>620</a> </span><span class="kw">pub </span>start_time_ms: i64,
|
|
<a href=#621 id=621 data-nosnippet>621</a> <span class="doccomment">/// End execution time of this procedure.
|
|
<a href=#622 id=622 data-nosnippet>622</a> </span><span class="kw">pub </span>end_time_ms: i64,
|
|
<a href=#623 id=623 data-nosnippet>623</a> <span class="doccomment">/// status of this procedure.
|
|
<a href=#624 id=624 data-nosnippet>624</a> </span><span class="kw">pub </span>state: ProcedureState,
|
|
<a href=#625 id=625 data-nosnippet>625</a> <span class="doccomment">/// Lock keys of this procedure.
|
|
<a href=#626 id=626 data-nosnippet>626</a> </span><span class="kw">pub </span>lock_keys: Vec<String>,
|
|
<a href=#627 id=627 data-nosnippet>627</a>}
|
|
<a href=#628 id=628 data-nosnippet>628</a>
|
|
<a href=#629 id=629 data-nosnippet>629</a><span class="attr">#[cfg(test)]
|
|
<a href=#630 id=630 data-nosnippet>630</a></span><span class="kw">mod </span>tests {
|
|
<a href=#631 id=631 data-nosnippet>631</a> <span class="kw">use </span>common_error::mock::MockError;
|
|
<a href=#632 id=632 data-nosnippet>632</a> <span class="kw">use </span>common_error::status_code::StatusCode;
|
|
<a href=#633 id=633 data-nosnippet>633</a>
|
|
<a href=#634 id=634 data-nosnippet>634</a> <span class="kw">use </span>super::<span class="kw-2">*</span>;
|
|
<a href=#635 id=635 data-nosnippet>635</a>
|
|
<a href=#636 id=636 data-nosnippet>636</a> <span class="attr">#[test]
|
|
<a href=#637 id=637 data-nosnippet>637</a> </span><span class="kw">fn </span>test_status() {
|
|
<a href=#638 id=638 data-nosnippet>638</a> <span class="kw">let </span>status = Status::executing(<span class="bool-val">false</span>);
|
|
<a href=#639 id=639 data-nosnippet>639</a> <span class="macro">assert!</span>(!status.need_persist());
|
|
<a href=#640 id=640 data-nosnippet>640</a>
|
|
<a href=#641 id=641 data-nosnippet>641</a> <span class="kw">let </span>status = Status::executing(<span class="bool-val">true</span>);
|
|
<a href=#642 id=642 data-nosnippet>642</a> <span class="macro">assert!</span>(status.need_persist());
|
|
<a href=#643 id=643 data-nosnippet>643</a>
|
|
<a href=#644 id=644 data-nosnippet>644</a> <span class="kw">let </span>status = Status::executing_with_clean_poisons(<span class="bool-val">false</span>);
|
|
<a href=#645 id=645 data-nosnippet>645</a> <span class="macro">assert!</span>(status.need_clean_poisons());
|
|
<a href=#646 id=646 data-nosnippet>646</a>
|
|
<a href=#647 id=647 data-nosnippet>647</a> <span class="kw">let </span>status = Status::executing_with_clean_poisons(<span class="bool-val">true</span>);
|
|
<a href=#648 id=648 data-nosnippet>648</a> <span class="macro">assert!</span>(status.need_clean_poisons());
|
|
<a href=#649 id=649 data-nosnippet>649</a>
|
|
<a href=#650 id=650 data-nosnippet>650</a> <span class="kw">let </span>status = Status::Suspended {
|
|
<a href=#651 id=651 data-nosnippet>651</a> subprocedures: Vec::new(),
|
|
<a href=#652 id=652 data-nosnippet>652</a> persist: <span class="bool-val">false</span>,
|
|
<a href=#653 id=653 data-nosnippet>653</a> };
|
|
<a href=#654 id=654 data-nosnippet>654</a> <span class="macro">assert!</span>(!status.need_persist());
|
|
<a href=#655 id=655 data-nosnippet>655</a>
|
|
<a href=#656 id=656 data-nosnippet>656</a> <span class="kw">let </span>status = Status::Suspended {
|
|
<a href=#657 id=657 data-nosnippet>657</a> subprocedures: Vec::new(),
|
|
<a href=#658 id=658 data-nosnippet>658</a> persist: <span class="bool-val">true</span>,
|
|
<a href=#659 id=659 data-nosnippet>659</a> };
|
|
<a href=#660 id=660 data-nosnippet>660</a> <span class="macro">assert!</span>(status.need_persist());
|
|
<a href=#661 id=661 data-nosnippet>661</a>
|
|
<a href=#662 id=662 data-nosnippet>662</a> <span class="kw">let </span>status = Status::done();
|
|
<a href=#663 id=663 data-nosnippet>663</a> <span class="macro">assert!</span>(!status.need_persist());
|
|
<a href=#664 id=664 data-nosnippet>664</a> <span class="macro">assert!</span>(status.need_clean_poisons());
|
|
<a href=#665 id=665 data-nosnippet>665</a> }
|
|
<a href=#666 id=666 data-nosnippet>666</a>
|
|
<a href=#667 id=667 data-nosnippet>667</a> <span class="attr">#[test]
|
|
<a href=#668 id=668 data-nosnippet>668</a> </span><span class="kw">fn </span>test_lock_key() {
|
|
<a href=#669 id=669 data-nosnippet>669</a> <span class="kw">let </span>entity = <span class="string">"catalog.schema.my_table"</span>;
|
|
<a href=#670 id=670 data-nosnippet>670</a> <span class="kw">let </span>key = LockKey::single_exclusive(entity);
|
|
<a href=#671 id=671 data-nosnippet>671</a> <span class="macro">assert_eq!</span>(
|
|
<a href=#672 id=672 data-nosnippet>672</a> <span class="macro">vec!</span>[<span class="kw-2">&</span>StringKey::Exclusive(entity.to_string())],
|
|
<a href=#673 id=673 data-nosnippet>673</a> key.keys_to_lock().collect::<Vec<<span class="kw">_</span>>>()
|
|
<a href=#674 id=674 data-nosnippet>674</a> );
|
|
<a href=#675 id=675 data-nosnippet>675</a>
|
|
<a href=#676 id=676 data-nosnippet>676</a> <span class="kw">let </span>key = LockKey::new_exclusive([
|
|
<a href=#677 id=677 data-nosnippet>677</a> <span class="string">"b"</span>.to_string(),
|
|
<a href=#678 id=678 data-nosnippet>678</a> <span class="string">"c"</span>.to_string(),
|
|
<a href=#679 id=679 data-nosnippet>679</a> <span class="string">"a"</span>.to_string(),
|
|
<a href=#680 id=680 data-nosnippet>680</a> <span class="string">"c"</span>.to_string(),
|
|
<a href=#681 id=681 data-nosnippet>681</a> ]);
|
|
<a href=#682 id=682 data-nosnippet>682</a> <span class="macro">assert_eq!</span>(
|
|
<a href=#683 id=683 data-nosnippet>683</a> <span class="macro">vec!</span>[
|
|
<a href=#684 id=684 data-nosnippet>684</a> <span class="kw-2">&</span>StringKey::Exclusive(<span class="string">"a"</span>.to_string()),
|
|
<a href=#685 id=685 data-nosnippet>685</a> <span class="kw-2">&</span>StringKey::Exclusive(<span class="string">"b"</span>.to_string()),
|
|
<a href=#686 id=686 data-nosnippet>686</a> <span class="kw-2">&</span>StringKey::Exclusive(<span class="string">"c"</span>.to_string())
|
|
<a href=#687 id=687 data-nosnippet>687</a> ],
|
|
<a href=#688 id=688 data-nosnippet>688</a> key.keys_to_lock().collect::<Vec<<span class="kw">_</span>>>()
|
|
<a href=#689 id=689 data-nosnippet>689</a> );
|
|
<a href=#690 id=690 data-nosnippet>690</a> }
|
|
<a href=#691 id=691 data-nosnippet>691</a>
|
|
<a href=#692 id=692 data-nosnippet>692</a> <span class="attr">#[test]
|
|
<a href=#693 id=693 data-nosnippet>693</a> </span><span class="kw">fn </span>test_procedure_id() {
|
|
<a href=#694 id=694 data-nosnippet>694</a> <span class="kw">let </span>id = ProcedureId::random();
|
|
<a href=#695 id=695 data-nosnippet>695</a> <span class="kw">let </span>uuid_str = id.to_string();
|
|
<a href=#696 id=696 data-nosnippet>696</a> <span class="macro">assert_eq!</span>(id.<span class="number">0</span>.to_string(), uuid_str);
|
|
<a href=#697 id=697 data-nosnippet>697</a>
|
|
<a href=#698 id=698 data-nosnippet>698</a> <span class="kw">let </span>parsed = ProcedureId::parse_str(<span class="kw-2">&</span>uuid_str).unwrap();
|
|
<a href=#699 id=699 data-nosnippet>699</a> <span class="macro">assert_eq!</span>(id, parsed);
|
|
<a href=#700 id=700 data-nosnippet>700</a> <span class="kw">let </span>parsed = uuid_str.parse().unwrap();
|
|
<a href=#701 id=701 data-nosnippet>701</a> <span class="macro">assert_eq!</span>(id, parsed);
|
|
<a href=#702 id=702 data-nosnippet>702</a> }
|
|
<a href=#703 id=703 data-nosnippet>703</a>
|
|
<a href=#704 id=704 data-nosnippet>704</a> <span class="attr">#[test]
|
|
<a href=#705 id=705 data-nosnippet>705</a> </span><span class="kw">fn </span>test_procedure_id_serialization() {
|
|
<a href=#706 id=706 data-nosnippet>706</a> <span class="kw">let </span>id = ProcedureId::random();
|
|
<a href=#707 id=707 data-nosnippet>707</a> <span class="kw">let </span>json = serde_json::to_string(<span class="kw-2">&</span>id).unwrap();
|
|
<a href=#708 id=708 data-nosnippet>708</a> <span class="macro">assert_eq!</span>(<span class="macro">format!</span>(<span class="string">"\"{id}\""</span>), json);
|
|
<a href=#709 id=709 data-nosnippet>709</a>
|
|
<a href=#710 id=710 data-nosnippet>710</a> <span class="kw">let </span>parsed = serde_json::from_str(<span class="kw-2">&</span>json).unwrap();
|
|
<a href=#711 id=711 data-nosnippet>711</a> <span class="macro">assert_eq!</span>(id, parsed);
|
|
<a href=#712 id=712 data-nosnippet>712</a> }
|
|
<a href=#713 id=713 data-nosnippet>713</a>
|
|
<a href=#714 id=714 data-nosnippet>714</a> <span class="attr">#[test]
|
|
<a href=#715 id=715 data-nosnippet>715</a> </span><span class="kw">fn </span>test_procedure_state() {
|
|
<a href=#716 id=716 data-nosnippet>716</a> <span class="macro">assert!</span>(ProcedureState::Running.is_running());
|
|
<a href=#717 id=717 data-nosnippet>717</a> <span class="macro">assert!</span>(ProcedureState::Running.error().is_none());
|
|
<a href=#718 id=718 data-nosnippet>718</a> <span class="macro">assert!</span>(ProcedureState::Done { output: <span class="prelude-val">None </span>}.is_done());
|
|
<a href=#719 id=719 data-nosnippet>719</a>
|
|
<a href=#720 id=720 data-nosnippet>720</a> <span class="kw">let </span>state = ProcedureState::failed(Arc::new(Error::external(MockError::new(
|
|
<a href=#721 id=721 data-nosnippet>721</a> StatusCode::Unexpected,
|
|
<a href=#722 id=722 data-nosnippet>722</a> ))));
|
|
<a href=#723 id=723 data-nosnippet>723</a> <span class="macro">assert!</span>(state.is_failed());
|
|
<a href=#724 id=724 data-nosnippet>724</a> <span class="kw">let _ </span>= state.error().unwrap();
|
|
<a href=#725 id=725 data-nosnippet>725</a> }
|
|
<a href=#726 id=726 data-nosnippet>726</a>}
|
|
</code></pre></div></section></main></body></html> |