1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
use std::collections::HashMap;

use crate::{lower::LoweredConditionalQueryAs, DatabaseType, DATABASE_TYPE};

#[derive(Debug, thiserror::Error)]
pub enum ExpandError {
    #[error("missing compile-time binding: {0}")]
    MissingCompileTimeBinding(String, proc_macro2::Span),
    #[error("missing binding closing brace")]
    MissingBindingClosingBrace(proc_macro2::Span),
    #[error("failed to parse type override in binding reference: {0}")]
    BindingReferenceTypeOverrideParseError(proc_macro2::LexError, proc_macro2::Span),
}

#[derive(Debug)]
pub(crate) struct ExpandedConditionalQueryAs {
    pub(crate) output_type: syn::Ident,
    pub(crate) match_expressions: Vec<syn::Expr>,
    pub(crate) match_arms: Vec<MatchArm>,
}

#[derive(Debug)]
pub(crate) struct MatchArm {
    pub(crate) patterns: Vec<syn::Pat>,
    pub(crate) query_fragments: Vec<syn::LitStr>,
    pub(crate) run_time_bindings: Vec<(syn::Ident, Option<proc_macro2::TokenStream>)>,
}

/// Corresponds to a single run-time binding name.
#[derive(Debug)]
struct RunTimeBinding {
    /// List of all argument index positions at which this binding needs to be bound.
    ///
    /// - For PostgreSQL only contains one element.
    /// - For MySQL and SQLite it contains one index for each time the binding was referenced.
    indices: Vec<usize>,

    /// Type-override fragment to pass on To SQLx
    type_override: Option<proc_macro2::TokenStream>,
}

#[derive(Debug, Default)]
struct RunTimeBindings {
    counter: usize,
    bindings: HashMap<syn::LitStr, RunTimeBinding>,
}
impl RunTimeBindings {
    /// Returns a database-appropriate run-time binding string for the given binding name.
    ///
    /// Database type selection is done based on the features this crate was built with.
    ///
    /// - PostgreSQL uses 1-indexed references such as `$1`, which means that multiple references
    ///   to the same parameter only need to be bound once.
    /// - MySQL and SQLite always use `?` which means that the arguments need to specified in
    ///   order and be duplicated for as many times as they're used.
    fn get_binding_string(
        &mut self,
        binding_name: syn::LitStr,
        type_override: Option<proc_macro2::TokenStream>,
    ) -> syn::LitStr {
        match DATABASE_TYPE {
            DatabaseType::PostgreSql => {
                let span = binding_name.span();
                let binding = self.bindings.entry(binding_name).or_insert_with(|| {
                    self.counter += 1;
                    RunTimeBinding {
                        indices: vec![self.counter],
                        type_override,
                    }
                });
                syn::LitStr::new(&format!("${}", binding.indices.first().unwrap()), span)
            }
            DatabaseType::MySql | DatabaseType::Sqlite => {
                let span = binding_name.span();
                self.counter += 1;

                // For MySQL and SQLite bindings we need to specify the same argument multiple
                // times if it's reused and so generate a unique index every time.  This ensures
                // that `get_run_time_bindings` will generate the arguments in the correct order.
                self.bindings
                    .entry(binding_name)
                    .and_modify(|binding| binding.indices.push(self.counter))
                    .or_insert_with(|| RunTimeBinding {
                        indices: vec![self.counter],
                        type_override,
                    });
                syn::LitStr::new("?", span)
            }
        }
    }

    /// Returns the `query_as!` arguments for all referenced run-time bindings.
    fn get_arguments(self) -> Vec<(syn::Ident, Option<proc_macro2::TokenStream>)> {
        let mut run_time_bindings: Vec<_> = self
            .bindings
            .into_iter()
            .flat_map(|(name, binding)| {
                binding
                    .indices
                    .into_iter()
                    .map(|index| {
                        (
                            syn::Ident::new(&name.value(), name.span()),
                            binding.type_override.clone(),
                            index,
                        )
                    })
                    .collect::<Vec<_>>()
            })
            .collect();

        run_time_bindings.sort_by_key(|(_, _, index)| *index);

        run_time_bindings
            .into_iter()
            .map(|(ident, type_override, _)| (ident, type_override))
            .collect()
    }
}

/// This function takes the original query string that was supplied to the macro and adjusts it for
/// each arm of the previously generated cartesian product of all bindings' match arms.
///
/// The `{#binding_name}` placeholder are then replaced with the string literals from match clauses
/// and  all `{scope_variable} placeholder are replaced with the positional variables of the respective
/// database engine whose feature is enabled. For more info take a look at [RunTimeBindings].
pub(crate) fn expand(
    lowered: LoweredConditionalQueryAs,
) -> Result<ExpandedConditionalQueryAs, ExpandError> {
    let mut match_arms = Vec::new();

    for arm in lowered.match_arms {
        let mut fragments = vec![lowered.query_string.clone()];
        while fragments
            .iter()
            .any(|fragment| fragment.value().contains("{#"))
        {
            fragments = expand_compile_time_bindings(fragments, &arm.compile_time_bindings)?;
        }

        // Substitute
        let mut run_time_bindings = RunTimeBindings::default();
        let expanded = expand_run_time_bindings(fragments, &mut run_time_bindings)?;

        match_arms.push(MatchArm {
            patterns: arm.patterns,
            query_fragments: expanded,
            run_time_bindings: run_time_bindings.get_arguments(),
        });
    }

    Ok(ExpandedConditionalQueryAs {
        output_type: lowered.output_type,
        match_expressions: lowered.match_expressions,
        match_arms,
    })
}

/// This function takes the list of query fragments and substitutes all `{#binding_name}`
/// occurrences with their literal strings from the respective match statements.
///
/// These literal strings however, can once again contain another `{#binding_name}`, which is why
/// this function is called from a while loop.
/// Since this function might get called multiple times, some fragments might already be expanded
/// at this point, despite the variable name.
fn expand_compile_time_bindings(
    unexpanded_fragments: Vec<syn::LitStr>,
    compile_time_bindings: &HashMap<String, syn::LitStr>,
) -> Result<Vec<syn::LitStr>, ExpandError> {
    let mut expanded_fragments = Vec::new();

    for fragment in unexpanded_fragments {
        let fragment_string = fragment.value();
        let mut fragment_str = fragment_string.as_str();

        while let Some(start_of_binding) = fragment_str.find('{') {
            // Otherwise we've hit either a compile-time or a run-time binding, so first we
            // push any prefix before the binding.
            if !fragment_str[..start_of_binding].is_empty() {
                expanded_fragments.push(syn::LitStr::new(
                    &fragment_str[..start_of_binding],
                    fragment.span(),
                ));
                fragment_str = &fragment_str[start_of_binding..];
            }

            // Then we find the matching closing brace.
            let end_of_binding = if let Some(end_of_binding) = fragment_str.find('}') {
                end_of_binding
            } else {
                return Err(ExpandError::MissingBindingClosingBrace(fragment.span()));
            };

            if fragment_str[start_of_binding..].chars().nth(1) == Some('#') {
                // If the binding is a compile-time binding, expand it.
                let binding_name = &fragment_str[2..end_of_binding];
                if let Some(binding) = compile_time_bindings.get(binding_name) {
                    expanded_fragments.push(binding.clone());
                } else {
                    return Err(ExpandError::MissingCompileTimeBinding(
                        binding_name.to_string(),
                        fragment.span(),
                    ));
                }
            } else {
                // Otherwise push it as-is for the next pass.
                expanded_fragments.push(syn::LitStr::new(
                    &fragment_str[..end_of_binding + 1],
                    fragment.span(),
                ));
            }

            fragment_str = &fragment_str[end_of_binding + 1..];
        }

        // Push trailing query fragment.
        if !fragment_str.is_empty() {
            expanded_fragments.push(syn::LitStr::new(fragment_str, fragment.span()));
        }
    }

    Ok(expanded_fragments)
}

/// Take all fragments and substitute any `{name}` occurrences with the respective database
/// binding. Since the parameter syntax is different for various databases, [RunTimeBinding] is
/// used in combination with feature flags to abstract this variance away.
fn expand_run_time_bindings(
    unexpanded_fragments: Vec<syn::LitStr>,
    run_time_bindings: &mut RunTimeBindings,
) -> Result<Vec<syn::LitStr>, ExpandError> {
    let mut expanded_query = Vec::new();

    for fragment in unexpanded_fragments {
        let fragment_string = fragment.value();
        let mut fragment_str = fragment_string.as_str();

        while let Some(start_of_binding) = fragment_str.find('{') {
            // Otherwise we've hit a run-time binding, so first we push any prefix before the
            // binding.
            expanded_query.push(syn::LitStr::new(
                &fragment_str[..start_of_binding],
                fragment.span(),
            ));

            // Then we find the matching closing brace.
            fragment_str = &fragment_str[start_of_binding + 1..];
            let end_of_binding = if let Some(end_of_binding) = fragment_str.find('}') {
                end_of_binding
            } else {
                return Err(ExpandError::MissingBindingClosingBrace(fragment.span()));
            };

            let binding_name = &fragment_str[..end_of_binding];
            let (binding_name, type_override) = if let Some(offset) = binding_name.find(':') {
                let (binding_name, type_override) = binding_name.split_at(offset);
                let type_override =
                    type_override
                        .parse::<proc_macro2::TokenStream>()
                        .map_err(|err| {
                            ExpandError::BindingReferenceTypeOverrideParseError(
                                err,
                                fragment.span(),
                            )
                        })?;
                (binding_name.trim(), Some(type_override))
            } else {
                (binding_name, None)
            };

            // And finally we push a bound parameter argument
            let binding = run_time_bindings.get_binding_string(
                syn::LitStr::new(binding_name, fragment.span()),
                type_override,
            );
            expanded_query.push(binding);

            fragment_str = &fragment_str[end_of_binding + 1..];
        }

        // Push trailing query fragment.
        if !fragment_str.is_empty() {
            expanded_query.push(syn::LitStr::new(fragment_str, fragment.span()));
        }
    }

    Ok(expanded_query)
}

#[cfg(test)]
mod tests {
    use quote::ToTokens;

    use super::*;

    #[test]
    fn expands_compile_time_bindings() {
        let parsed = syn::parse_str::<crate::parse::ParsedConditionalQueryAs>(
            r#"
                SomeType,
                "some {#a} {#b} {#j} query",
                #(a, b) = match c {
                    d => ("e", "f"),
                    g => ("h", "i"),
                },
                #j = match i {
                    k => "l",
                    m => "n",
                },
            "#,
        )
        .unwrap();
        let analyzed = crate::analyze::analyze(parsed.clone()).unwrap();
        let lowered = crate::lower::lower(analyzed);
        let expanded = expand(lowered).unwrap();

        assert_eq!(
            expanded.match_arms[0]
                .query_fragments
                .iter()
                .map(|qs| qs.to_token_stream().to_string())
                .collect::<Vec<_>>(),
            &[
                "\"some \"",
                "\"e\"",
                "\" \"",
                "\"f\"",
                "\" \"",
                "\"l\"",
                "\" query\""
            ],
        );
    }

    #[test]
    fn expands_run_time_bindings() {
        let parsed = syn::parse_str::<crate::parse::ParsedConditionalQueryAs>(
            r#"
                SomeType,
                "some {foo} {bar} {foo} query",
            "#,
        )
        .unwrap();
        let analyzed = crate::analyze::analyze(parsed.clone()).unwrap();
        let lowered = crate::lower::lower(analyzed);
        let expanded = expand(lowered).unwrap();

        assert_eq!(
            expanded.match_arms[0]
                .query_fragments
                .iter()
                .map(|qs| qs.to_token_stream().to_string())
                .collect::<Vec<_>>(),
            match DATABASE_TYPE {
                DatabaseType::PostgreSql => &[
                    "\"some \"",
                    "\"$1\"",
                    "\" \"",
                    "\"$2\"",
                    "\" \"",
                    "\"$1\"",
                    "\" query\""
                ],
                DatabaseType::MySql | DatabaseType::Sqlite => &[
                    "\"some \"",
                    "\"?\"",
                    "\" \"",
                    "\"?\"",
                    "\" \"",
                    "\"?\"",
                    "\" query\""
                ],
            }
        );
    }
}