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
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
/*!
module for creating clients with various authentication methods

Each client has the type `Client<A: Authenticate>`.
You can create a client with the functions provided by this module.

# Examples
```rust
let client_id = String::from("<clientid>");
let client_secret = String::from("<clientsecret>");

let client = Client::with_client_secret_auth(
    "https://instance.crm.dynamics.com/",
    "12345678-1234-1234-1234-123456789012",
    client_id,
    client_secret,
);
```
*/

use std::time::Duration;

use lazy_static::lazy_static;
use regex::Regex;
use serde::Deserialize;
use uuid::Uuid;

use crate::{
    auth::{client_secret::ClientSecretAuth, Authenticate},
    batch::Batch,
    entity::{ReadEntity, WriteEntity},
    error::DataverseError,
    query::Query,
    reference::Reference,
    result::{IntoDataverseResult, Result},
};

lazy_static! {
    static ref UUID_REGEX: Regex =
        Regex::new("[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}")
            .unwrap();
}

/// Microsoft Dataverse Web-API Version this client uses
pub static VERSION: &str = "9.2";

/**
A client capable of connecting to a dataverse environment

A client should be created once and then reused to take advantage of its
connection-pooling.

# Examples
```rust
let client_id = String::from("<clientid>");
let client_secret = String::from("<clientsecret>");

let client = Client::with_client_secret_auth(
    "https://instance.crm.dynamics.com/",
    "12345678-1234-1234-1234-123456789012",
    client_id,
    client_secret,
);
```
*/
pub struct Client<A: Authenticate> {
    pub url: &'static str,
    backend: reqwest::Client,
    auth: A,
}

impl Client<ClientSecretAuth> {
    /**
    Creates a dataverse client that uses client/secret authentication

    Please note that this function will not fail right away even when the
    provided credentials are invalid. This is because the authentication
    is handled lazily and a token is only acquired on the first call or
    when an acquired token is no longer valid and needs to be refreshed

    # Examples
    ```rust
    let client_id = String::from("<clientid>");
    let client_secret = String::from("<clientsecret>");

    let client = Client::with_client_secret_auth(
        "https://instance.crm.dynamics.com/",
        "12345678-1234-1234-1234-123456789012",
        client_id,
        client_secret,
    );
    ```
    */
    pub fn with_client_secret_auth(
        url: &'static str,
        tenant_id: &'static str,
        client_id: String,
        client_secret: String,
    ) -> Self {
        let client = reqwest::Client::builder()
            .https_only(true)
            .connect_timeout(Duration::from_secs(120))
            .timeout(Duration::from_secs(120))
            .build()
            .unwrap();

        let auth = ClientSecretAuth::new(
            client.clone(),
            format!(
                "https://login.microsoftonline.com/{}/oauth2/v2.0/token",
                tenant_id
            ),
            format!("{}.default", url),
            client_id,
            client_secret,
        );

        Client::new(url, client, auth)
    }
}

impl<A: Authenticate> Client<A> {
    /**
    Creates a dataverse client with a custom authentication handler and backend

    This function may not panic so the custom authentication should follow these
    rules:
    - tokens should be acquired lazily
    - tokens should be cached and reused where possible
    - each call to the `get_valid_token()` function should give a token that is valid
    for at least the next 2 minutes

    # Examples
    ```rust
    let client = reqwest::Client::builder()
        .https_only(true)
        .connect_timeout(Duration::from_secs(120))
        .timeout(Duration::from_secs(120))
        .build()
        .unwrap();

    let auth = ClientSecretAuth::new(
        client.clone(),
        format!(
            "https://login.microsoftonline.com/{}/oauth2/v2.0/token",
            tenant_id
        ),
        format!("{}.default", url),
        client_id,
        client_secret,
    );

    Client::new(url, client, auth)
    ```
    */
    pub fn new(url: &'static str, backend: reqwest::Client, auth: A) -> Self {
        Self { url, backend, auth }
    }

    /**
    Writes the given entity into the current dataverse instance and returns its generated Uuid

    This may fail for any of these reasons
    - An authentication failure
    - A serde serialization error
    - Any http client or server error
    - there is already a record with this Uuid in the table

    # Examples
    ```rust
    let contact = Contact {
        contactid: Uuid::parse_str("12345678-1234-1234-1234-123456789012").unwrap(),
        firstname: String::from("Testy"),
        lastname: String::from("McTestface"),
    };

    client.create(&contact).await.unwrap();

    #[derive(Serialize)]
    struct Contact {
        contactid: Uuid,
        firstname: String,
        lastname: String,
    }

    impl WriteEntity for Contact {}

    impl Reference for Contact {
        fn get_reference(&self) -> ReferenceStruct {
            ReferenceStruct::new(
                "contacts",
                self.contactid,
            )
        }
    }
    ```
    */
    pub async fn create(&self, entity: &impl WriteEntity) -> Result<Uuid> {
        let token = self.auth.get_valid_token().await?;
        let reference = entity.get_reference();
        let url_path = self.build_simple_url(reference.entity_name);

        let response = self
            .backend
            .post(url_path)
            .bearer_auth(token)
            .header("OData-MaxVersion", "4.0")
            .header("OData-Version", "4.0")
            .header("Content-Type", "application/json; charset=utf-8")
            .header("Accept", "application/json")
            .body(serde_json::to_vec(entity).into_dataverse_result()?)
            .send()
            .await
            .into_dataverse_result()?;

        if response.status().is_client_error() || response.status().is_server_error() {
            let error_message = response
                .text()
                .await
                .unwrap_or_else(|_| String::from("no error details provided from server"));
            return Err(DataverseError::new(error_message));
        }

        let header_value = response
            .headers()
            .get("OData-EntityId")
            .ok_or_else(|| DataverseError::new("Dataverse provided no Uuid".to_string()))?;

        let uuid_segment = UUID_REGEX
            .find(header_value.to_str().unwrap_or(""))
            .ok_or_else(|| DataverseError::new("Dataverse provided no Uuid".to_string()))?;

        Uuid::parse_str(uuid_segment.as_str()).into_dataverse_result()
    }

    /**
    Updates the attributes of the gven entity in the current dataverse instance

    Please note that only those attributes are updated that are present in the
    serialization payload. Other attributes are untouched

    This may fail for any of these reasons
    - An authentication failure
    - A serde serialization error
    - Any http client or server error
    - there is no record with this Uuid in the table

    # Examples
    ```rust
    let contact = Contact {
        contactid: Uuid::parse_str("12345678-1234-1234-1234-123456789012").unwrap(),
        firstname: String::from("Testy"),
        lastname: String::from("McTestface"),
    };

    client.update(&contact).await.unwrap();

    #[derive(Serialize)]
    struct Contact {
        contactid: Uuid,
        firstname: String,
        lastname: String,
    }

    impl WriteEntity for Contact {}

    impl Reference for Contact {
        fn get_reference(&self) -> ReferenceStruct {
            ReferenceStruct::new(
                "contacts",
                self.contactid,
            )
        }
    }
    */
    pub async fn update(&self, entity: &impl WriteEntity) -> Result<()> {
        let token = self.auth.get_valid_token().await?;
        let reference = entity.get_reference();
        let url_path = self.build_targeted_url(reference.entity_name, reference.entity_id);

        let response = self
            .backend
            .patch(url_path)
            .bearer_auth(token)
            .header("OData-MaxVersion", "4.0")
            .header("OData-Version", "4.0")
            .header("Content-Type", "application/json; charset=utf-8")
            .header("If-Match", "*")
            .body(serde_json::to_vec(entity).into_dataverse_result()?)
            .send()
            .await
            .into_dataverse_result()?;

        if response.status().is_client_error() || response.status().is_server_error() {
            let error_message = response
                .text()
                .await
                .unwrap_or_else(|_| String::from("no error details provided from server"));
            return Err(DataverseError::new(error_message));
        }

        Ok(())
    }

    /**
    Updates or creates the given entity in the current dataverse instance

    Please note that only those attributes are updated that are present in the
    serialization payload. Other attributes are untouched

    This may fail for any of these reasons
    - An authentication failure
    - A serde serialization error
    - Any http client or server error

    # Examples
    ```rust
    let contact = Contact {
        contactid: Uuid::parse_str("12345678-1234-1234-1234-123456789012").unwrap(),
        firstname: String::from("Testy"),
        lastname: String::from("McTestface"),
    };

    client.upsert(&contact).await.unwrap();

    #[derive(Serialize)]
    struct Contact {
        contactid: Uuid,
        firstname: String,
        lastname: String,
    }

    impl WriteEntity for Contact {}

    impl Reference for Contact {
        fn get_reference(&self) -> ReferenceStruct {
            ReferenceStruct::new(
                "contacts",
                self.contactid,
            )
        }
    }
    */
    pub async fn upsert(&self, entity: &impl WriteEntity) -> Result<()> {
        let token = self.auth.get_valid_token().await?;
        let reference = entity.get_reference();
        let url_path = self.build_targeted_url(reference.entity_name, reference.entity_id);

        let response = self
            .backend
            .patch(url_path)
            .bearer_auth(token)
            .header("OData-MaxVersion", "4.0")
            .header("OData-Version", "4.0")
            .header("Content-Type", "application/json; charset=utf-8")
            .body(serde_json::to_vec(entity).into_dataverse_result()?)
            .send()
            .await
            .into_dataverse_result()?;

        if response.status().is_client_error() || response.status().is_server_error() {
            let error_message = response
                .text()
                .await
                .unwrap_or_else(|_| String::from("no error details provided from server"));
            return Err(DataverseError::new(error_message));
        }

        Ok(())
    }

    /**
    Deletes the entity record this reference points to

    Please note that each structs that implements `WriteEntity` also implements
    `Reference` so you can use it as input here, but there is a sensible default implementation
    called `ReferenceStruct` for those cases where you only have access to the raw
    reference data

    This may fail for any of these reasons
    - An authentication failure
    - Any http client or server error
    - The referenced entity record doesn't exist

    # Examples
    ```rust
    let reference = ReferenceStruct::new(
        "contacts",
        Uuid::parse_str("12345678-1234-1234-1234-123456789012").unwrap()
    );

    client.delete(&reference).unwrap();
    ```
    */
    pub async fn delete(&self, reference: &impl Reference) -> Result<()> {
        let token = self.auth.get_valid_token().await?;
        let reference = reference.get_reference();
        let url_path = self.build_targeted_url(reference.entity_name, reference.entity_id);

        let response = self
            .backend
            .delete(url_path)
            .bearer_auth(token)
            .header("OData-MaxVersion", "4.0")
            .header("OData-Version", "4.0")
            .send()
            .await
            .into_dataverse_result()?;

        if response.status().is_client_error() || response.status().is_server_error() {
            let error_message = response
                .text()
                .await
                .unwrap_or_else(|_| String::from("no error details provided from server"));
            return Err(DataverseError::new(error_message));
        }

        Ok(())
    }

    /**
    retrieves the entity record that the reference points to from dataverse

    This function uses the implementation of the `Select` trait to only retrieve
    those attributes relevant to the struct defined. It is an Anti-Pattern to
    retrieve all attributes when they are not needed, so this library does not
    give the option to do that

    This may fail for any of these reasons
    - An authentication failure
    - A serde deserialization error
    - Any http client or server error
    - The entity record referenced doesn't exist

    # Examples
    ```rust
    let contact: Contact = client
        .retrieve(
            &ReferenceStruct::new(
                "contacts",
                Uuid::parse_str("12345678-1234-1234-1234-123456789012").unwrap()
            )
        )
        .await
        .unwrap();

    #[derive(Deserialize)]
    struct Contact {
        contactid: Uuid,
        firstname: String,
        lastname: String,
    }

    impl ReadEntity for Contact {}

    impl Select for Contact {
        fn get_columns() -> &'static [&'static str] {
            &["contactid", "firstname", "lastname"]
        }
    }
    ```
    */
    pub async fn retrieve<E: ReadEntity>(&self, reference: &impl Reference) -> Result<E> {
        let token = self.auth.get_valid_token().await?;
        let reference = reference.get_reference();
        let columns = E::get_columns();
        let url_path = self.build_retrieve_url(reference.entity_name, reference.entity_id, columns);

        let response = self
            .backend
            .get(url_path)
            .bearer_auth(token)
            .header("OData-MaxVersion", "4.0")
            .header("OData-Version", "4.0")
            .header("Accept", "application/json")
            .send()
            .await
            .into_dataverse_result()?;

        if response.status().is_client_error() || response.status().is_server_error() {
            let error_message = response
                .text()
                .await
                .unwrap_or_else(|_| String::from("no error details provided from server"));
            return Err(DataverseError::new(error_message));
        }

        let content = response.bytes().await.into_dataverse_result()?;
        serde_json::from_slice(content.as_ref()).into_dataverse_result()
    }

    /**
    Executes the query and retrieves the entities from dataverse

    This function uses the implementation of the `Select` trait to only retrieve
    those attributes relevant to the struct defined. It is an Anti-Pattern to
    retrieve all attributes when they are not needed, so this library does not
    give the option to do that

    Please note that if you don't specify a limit then the client will try to retrieve
    all matching records. This can take a lot of time.

    This may fail for any of these reasons
    - An authentication failure
    - A serde deserialization error
    - Any http client or server error

    # Examples
    ```rust
    // this query retrieves the first 3 contacts
    let query = Query::new("contacts").limit(3);
    let contacts = client.retrieve_multiple(&query).unwrap();

    #[derive(Deserialize)]
    struct Contact {
        contactid: Uuid,
        firstname: String,
        lastname: String,
    }

    impl ReadEntity for Contact {}

    impl Select for Contact {
        fn get_columns() -> &'static [&'static str] {
            &["contactid", "firstname", "lastname"]
        }
    }
    ```
    */
    pub async fn retrieve_multiple<E: ReadEntity>(&self, query: &Query) -> Result<Vec<E>> {
        let columns = E::get_columns();
        let mut url_path = Some(self.build_query_url(query.logical_name, columns, query));
        let mut entities = Vec::new();

        while url_path.is_some() {
            let response = self
                .backend
                .get(url_path.take().unwrap())
                .bearer_auth(self.auth.get_valid_token().await?.clone())
                .header("OData-MaxVersion", "4.0")
                .header("OData-Version", "4.0")
                .header("Accept", "application/json")
                .send()
                .await
                .into_dataverse_result()?;

            if response.status().is_client_error() || response.status().is_server_error() {
                let error_message = response
                    .text()
                    .await
                    .unwrap_or_else(|_| String::from("no error details provided from server"));
                return Err(DataverseError::new(error_message));
            }

            let content = response.bytes().await.into_dataverse_result()?;
            let mut result_entities: EntityCollection<E> =
                serde_json::from_slice(content.as_ref()).into_dataverse_result()?;
            entities.append(&mut result_entities.value);
            url_path = result_entities.next_link
        }

        Ok(entities)
    }

    /**
    executes the batch against the dataverse environment

    This function will fail if:
    - the batch size exceeds 1000 calls
    - the batch execution time exceeds 2 minutes

    the second restriction is especially tricky to handle because the execution time
    depends on the complexity of the entity in dataverse.
    So it is possible to create 300 records of an entity with low complexity
    but only 50 records of an entity with high complexity in that timeframe.

    Based on experience a batch size of 50 should be safe for all entities though

    # Examples
    ```rust
    let testy_contact = Contact {
        contactid: Uuid::parse_str("12345678-1234-1234-1234-123456789012").unwrap(),
        firstname: String::from("Testy"),
        lastname: String::from("McTestface"),
    };

    let marianne_contact = Contact {
        contactid: Uuid::parse_str("12345678-1234-1234-1234-123456789abc").unwrap(),
        firstname: String::from("Marianne"),
        lastname: String::from("McTestface"),
    };

    // this batch creates both contacts in one call
    let mut batch = Batch::new("https://instance.crm.dynamics.com/");
    batch.create(&testy_contact).unwrap();
    batch.create(&marianne_contact).unwrap();

    client.execute(&batch).unwrap();

    #[derive(Serialize)]
    struct Contact {
        contactid: Uuid,
        firstname: String,
        lastname: String,
    }

    impl WriteEntity for Contact {}

    impl Reference for Contact {
        fn get_reference(&self) -> ReferenceStruct {
            ReferenceStruct::new(
                "contacts",
                self.contactid,
            )
        }
    }
    ```
    */
    pub async fn execute(&self, batch: &Batch) -> Result<()> {
        let token = self.auth.get_valid_token().await?;
        let url_path = self.build_simple_url("$batch");

        let response = self
            .backend
            .post(url_path)
            .bearer_auth(token)
            .header("OData-MaxVersion", "4.0")
            .header("OData-Version", "4.0")
            .header(
                "Content-Type",
                format!("multipart/mixed; boundary=batch_{}", batch.get_batch_id()),
            )
            .header("Accept", "application/json")
            .body(batch.to_string())
            .send()
            .await
            .into_dataverse_result()?;

        if response.status().is_client_error() || response.status().is_server_error() {
            let error_message = response
                .text()
                .await
                .unwrap_or_else(|_| String::from("no error details provided from server"));
            return Err(DataverseError::new(error_message));
        }

        Ok(())
    }

    fn build_simple_url(&self, table_name: &str) -> String {
        format!("{}api/data/v{}/{}", self.url, VERSION, table_name)
    }

    fn build_targeted_url(&self, table_name: &str, target_id: Uuid) -> String {
        format!(
            "{}api/data/v{}/{}({})",
            self.url,
            VERSION,
            table_name,
            target_id.as_hyphenated()
        )
    }

    fn build_retrieve_url(&self, table_name: &str, target_id: Uuid, columns: &[&str]) -> String {
        let mut select = String::new();
        let mut comma_required = false;

        for column in columns {
            if comma_required {
                select.push(',');
            }

            select.push_str(column);
            comma_required = true;
        }

        format!(
            "{}api/data/v{}/{}({})?$select={}",
            self.url,
            VERSION,
            table_name,
            target_id.as_hyphenated(),
            select
        )
    }

    fn build_query_url(&self, table_name: &str, columns: &[&str], query: &Query) -> String {
        let mut select = String::new();
        let mut comma_required = false;

        for column in columns {
            if comma_required {
                select.push(',');
            }

            select.push_str(column);
            comma_required = true;
        }

        format!(
            "{}api/data/v{}/{}{}&$select={}",
            self.url, VERSION, table_name, query, select
        )
    }
}

#[derive(Deserialize)]
struct EntityCollection<E> {
    value: Vec<E>,
    #[serde(rename = "@odata.nextLink")]
    next_link: Option<String>,
}