better-auth-api 1.0.0-alpha.5

Plugin implementations for better-auth
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
#![expect(
    clippy::unwrap_used,
    clippy::panic_in_result_fn,
    clippy::indexing_slicing,
    reason = "The paired native property scenarios require exact callback order, original failures, and complete storage assertions."
)]

use super::{SessionIssueError, issue_selected_user_session_optional};
use crate::plugins::{
    email_password::EmailPasswordPlugin,
    password_management::{
        PasswordManagementConfig, handlers::change_password_core, types::ChangePasswordRequest,
    },
    test_helpers,
};
use better_auth_core::{
    AuthError, AuthRequest, AuthResult, FieldArray, FieldDate, FieldFunction, FieldMap,
    FieldObject, FieldValue, FromFieldMap, HttpMethod, RequestMeta,
    field_value::{FieldObjectSource, FieldPropertyDescriptor},
    session::NativeSessionData,
    store::{
        EphemeralStore, StatelessSchema,
        database_hooks::{
            DatabaseHookContext, DatabaseHookControl, DatabaseHookUpdate, DatabaseHooks,
        },
        schema::EntityRole,
    },
    user_fields::{UserFieldConfig, UserFieldFactory, UserFieldType},
    utils::password::PasswordHasher,
    wire::SessionView,
};
use std::sync::{
    Arc, Mutex, OnceLock, Weak,
    atomic::{AtomicUsize, Ordering},
};
use test_helpers::native_observation::NativeObservation;

const NOW: f64 = 2_000_000_000_000.0;
const PASSWORD: &str = "CorrectHorseBattery1!";

#[path = "selected_user_property_tests/fixture_replay.rs"]
mod fixture_replay;

struct Trace {
    events: Mutex<Vec<String>>,
    native: Mutex<NativeObservation>,
    reads: AtomicUsize,
    throws_at: usize,
    changing: bool,
    changed: FieldValue,
    original: FieldValue,
    cancel_create: bool,
}

impl Trace {
    fn new(shape: &str, throws_at: usize, changing: bool, cancel_create: bool) -> Self {
        Self {
            events: Mutex::new(Vec::new()),
            native: Mutex::new(NativeObservation::default()),
            reads: AtomicUsize::new(0),
            throws_at,
            changing,
            changed: FieldMap::from([("marker".into(), "third-read-owner".into())]).into(),
            original: FieldMap::from([
                ("kind".into(), "selected-user-id-error".into()),
                ("shape".into(), shape.into()),
                ("throwsAt".into(), (throws_at as f64).into()),
            ])
            .into(),
            cancel_create,
        }
    }

    fn record(&self, phase: impl Into<String>) {
        self.events.lock().unwrap().push(phase.into());
    }

    fn observe_event(&self, phase: &str, name: &str, value: FieldValue) -> AuthResult<()> {
        let mut native = self.native.lock().unwrap();
        let value = native.observe(&value)?;
        native.record(phase, [(name.into(), value)]);
        Ok(())
    }
}

struct Properties {
    getter: FieldFunction,
}

impl FieldObjectSource for Properties {
    fn own_keys(&self) -> AuthResult<Vec<String>> {
        Ok(vec!["id".into()])
    }
    fn own_property_descriptor(&self, name: &str) -> AuthResult<Option<FieldPropertyDescriptor>> {
        Ok((name == "id").then_some(FieldPropertyDescriptor { enumerable: true }))
    }
    fn get(&self, _: &str) -> AuthResult<Option<FieldValue>> {
        Err(AuthError::internal(
            "The selected User getter requires its native receiver",
        ))
    }
    fn get_with_receiver(
        &self,
        name: &str,
        receiver: &FieldValue,
    ) -> AuthResult<Option<FieldValue>> {
        if name != "id" {
            return Ok(None);
        }
        self.getter.call_with(receiver, &[]).map(Some)
    }
    fn set(&self, _: String, _: FieldValue) -> AuthResult<Option<FieldValue>> {
        Err(AuthError::internal(
            "The route must not overwrite its selected User",
        ))
    }
    fn delete(&self, _: &str) -> AuthResult<Option<FieldValue>> {
        Err(AuthError::internal(
            "The route must not delete selected User properties",
        ))
    }
    fn snapshot_fields(&self) -> AuthResult<FieldMap> {
        Err(AuthError::internal(
            "Session issuance must not snapshot the selected User",
        ))
    }
    fn identity(&self) -> usize {
        std::ptr::from_ref(self) as usize
    }
}

struct SelectedUser {
    value: FieldValue,
    properties: FieldObject,
    getter: FieldFunction,
    _receiver: Arc<OnceLock<FieldValue>>,
}

fn user(shape: &str, trace: &Arc<Trace>) -> SelectedUser {
    let receiver = Arc::new(OnceLock::<FieldValue>::new());
    let expected: Weak<OnceLock<FieldValue>> = Arc::downgrade(&receiver);
    let trace = Arc::downgrade(trace);
    let getter = FieldFunction::contextual(move |receiver, arguments| {
        let trace = trace.upgrade().unwrap();
        assert!(arguments.is_empty());
        let same_receiver = receiver.strict_equals(expected.upgrade().unwrap().get().unwrap());
        assert!(same_receiver);
        let read = trace.reads.fetch_add(1, Ordering::SeqCst) + 1;
        trace.record(format!("user-id-{read}"));
        trace.native.lock().unwrap().record(
            "user-id",
            [
                ("read".into(), read.into()),
                ("sameReceiver".into(), same_receiver.into()),
            ],
        );
        if read == trace.throws_at {
            return Err(AuthError::from_thrown(trace.original.clone()));
        }
        Ok(if trace.changing && read == 3 {
            trace.changed.clone()
        } else {
            7.into()
        })
    });
    let properties = FieldObject::from_source(Arc::new(Properties {
        getter: getter.clone(),
    }));
    let user: FieldValue = match shape {
        "array" => FieldArray::with_length_and_properties(0, properties.clone()).into(),
        "function" => FieldFunction::contextual_with_properties(
            |_, _| Err(AuthError::internal("The User function must not be called")),
            properties.clone(),
        )
        .into(),
        "date" => FieldDate::from_milliseconds_with_properties(NOW, properties.clone()).into(),
        _ => properties.clone().into(),
    };
    receiver.set(user.clone()).unwrap();
    SelectedUser {
        value: user,
        properties,
        getter,
        _receiver: receiver,
    }
}

#[async_trait::async_trait]
impl PasswordHasher for Trace {
    async fn hash(&self, password: &str) -> AuthResult<String> {
        assert_eq!(password, PASSWORD);
        self.record("hash");
        self.observe_event("hash", "value", password.into())?;
        Ok("new-hash".into())
    }
    async fn verify(&self, hash: &str, password: &str) -> AuthResult<bool> {
        assert_eq!((hash, password), ("stored-hash", PASSWORD));
        self.record("verify");
        self.observe_event(
            "verify",
            "arguments",
            FieldMap::from([
                ("hash".into(), hash.into()),
                ("password".into(), password.into()),
            ])
            .into(),
        )?;
        Ok(true)
    }
}

#[better_auth_core::database_hooks()]
impl DatabaseHooks<StatelessSchema> for Trace {
    async fn before_create_session(
        &self,
        fields: &mut FieldMap,
        _: &DatabaseHookContext<'_, StatelessSchema>,
    ) -> AuthResult<DatabaseHookUpdate<FieldMap>> {
        self.record("create");
        let expected = if self.changing {
            self.changed.clone()
        } else {
            7.into()
        };
        let same_owner = fields.get("userId").unwrap().strict_equals(&expected);
        assert!(same_owner);
        {
            let mut native = self.native.lock().unwrap();
            let arguments = native.observe(&vec![FieldValue::from(fields.clone())].into())?;
            native.record(
                if self.cancel_create {
                    "create-cancel"
                } else {
                    "create"
                },
                [
                    ("arguments".into(), arguments),
                    ("sameOwner".into(), same_owner.into()),
                ],
            );
        }
        Ok(if self.cancel_create {
            DatabaseHookUpdate::Cancel
        } else {
            DatabaseHookUpdate::Continue
        })
    }
    async fn before_delete_session(
        &self,
        session: &SessionView,
        _: &DatabaseHookContext<'_, StatelessSchema>,
    ) -> AuthResult<DatabaseHookControl> {
        self.record("delete-before");
        self.observe_event(
            "delete-before",
            "arguments",
            vec![FieldValue::from(FieldMap::from(session.clone()))].into(),
        )?;
        Ok(DatabaseHookControl::Continue)
    }
    async fn after_delete_session(
        &self,
        session: &SessionView,
        _: &DatabaseHookContext<'_, StatelessSchema>,
    ) -> AuthResult<()> {
        self.record("delete-after");
        self.observe_event(
            "delete-after",
            "arguments",
            vec![FieldValue::from(FieldMap::from(session.clone()))].into(),
        )?;
        Ok(())
    }
}

fn session() -> FieldMap {
    FieldMap::from([
        ("id".into(), "current".into()),
        ("token".into(), "current".into()),
        ("userId".into(), 7.into()),
        (
            "expiresAt".into(),
            FieldDate::from_milliseconds(NOW + 3_600_000.0).into(),
        ),
        ("createdAt".into(), FieldDate::from_milliseconds(NOW).into()),
        ("updatedAt".into(), FieldDate::from_milliseconds(NOW).into()),
        ("ipAddress".into(), FieldValue::Null),
        ("userAgent".into(), FieldValue::Null),
    ])
}

fn account() -> FieldMap {
    FieldMap::from([
        ("id".into(), "credential".into()),
        ("userId".into(), 7.into()),
        ("accountId".into(), 7.into()),
        ("providerId".into(), "credential".into()),
        ("password".into(), "stored-hash".into()),
        ("createdAt".into(), FieldDate::from_milliseconds(NOW).into()),
        ("updatedAt".into(), FieldDate::from_milliseconds(NOW).into()),
    ])
}

#[tokio::test]
async fn selected_user_property_reads_reach_password_session_replacement() -> AuthResult<()> {
    for shape in ["object", "array", "function", "date"] {
        for (throws_at, changing) in [(0, false), (1, false), (2, false), (3, false), (0, true)] {
            run_case(shape, throws_at, changing, None).await?;
        }
    }
    Ok(())
}

async fn run_case(
    shape: &str,
    throws_at: usize,
    changing: bool,
    case: Option<&serde_json::Value>,
) -> AuthResult<()> {
    let trace = Arc::new(Trace::new(shape, throws_at, changing, true));
    let user = user(shape, &trace);
    let mut config = test_helpers::create_test_config();
    let _ = config
        .session
        .fields_mut()
        .insert("userId".into(), UserFieldConfig::default());
    let _ = config
        .account
        .additional_fields
        .insert("userId".into(), UserFieldConfig::default());
    let _ = config.account.additional_fields.insert(
        "updatedAt".into(),
        UserFieldConfig {
            field_type: UserFieldType::Date,
            on_update: Some(UserFieldFactory::new(|| {
                Ok(FieldDate::from_milliseconds(NOW).into())
            })),
            ..Default::default()
        },
    );
    if case.is_some() {
        fixture_replay::fixed_creation_fields(&mut config);
    }
    let config = Arc::new(config);
    let store = Arc::new(
        EphemeralStore::from_storage(
            config.clone(),
            [
                ("user".into(), Vec::new()),
                ("session".into(), vec![session()]),
                ("account".into(), vec![account()]),
                ("verification".into(), Vec::new()),
            ],
        )?
        .with_hooks(vec![trace.clone()]),
    );
    let email = EmailPasswordPlugin::new().password_hasher(trace.clone());
    let context = test_helpers::initialize_test_context(config, store.clone(), &[&email]).await?;
    let observed = match case {
        Some(_) => Some(fixture_replay::before(&context, &store, &trace, &user).await?),
        None => None,
    };
    let request = AuthRequest::new(HttpMethod::Post, "/change-password");
    let result = change_password_core(
        &ChangePasswordRequest {
            current_password: PASSWORD.into(),
            new_password: PASSWORD.into(),
            revoke_other_sessions: Some(true),
        },
        &NativeSessionData::new(
            SessionView::from_field_values(session())?,
            user.value.clone(),
        ),
        &PasswordManagementConfig::default(),
        &request,
        &RequestMeta::default(),
        &context,
    )
    .await;
    let error = result.unwrap_err();
    if throws_at == 0 {
        test_helpers::assert_coded_api_error(
            &error,
            "INTERNAL_SERVER_ERROR",
            500,
            "FAILED_TO_GET_SESSION",
            "Failed to get session",
        );
    }
    let thrown = error.into_thrown_value()?;
    if throws_at != 0 {
        assert!(thrown.strict_equals(&trace.original));
    }
    let mut expected_events = vec!["user-id-1"];
    if throws_at != 1 {
        expected_events.extend(["hash", "verify", "user-id-2"]);
    }
    if throws_at == 0 || throws_at == 3 {
        expected_events.extend(["delete-before", "delete-after", "user-id-3"]);
    }
    if throws_at == 0 {
        expected_events.push("create");
    }
    assert_eq!(
        *trace.events.lock().unwrap(),
        expected_events,
        "{shape}/{throws_at}/{changing}"
    );
    let mut expected_account = account();
    if throws_at != 1 {
        let _ = expected_account.insert("password".into(), "new-hash".into());
    }
    assert_eq!(store.storage_rows(EntityRole::Account)?, [expected_account]);
    assert_eq!(
        store.storage_rows(EntityRole::Session)?,
        if throws_at == 0 || throws_at == 3 {
            Vec::new()
        } else {
            vec![session()]
        }
    );
    assert!(store.storage_rows(EntityRole::User)?.is_empty());
    assert!(store.storage_rows(EntityRole::Verification)?.is_empty());
    if let (Some(case), Some(before)) = (case, observed) {
        before.assert_case(case, thrown).await?;
    }
    Ok(())
}

#[tokio::test]
async fn selected_user_property_success_retains_the_user_handle() -> AuthResult<()> {
    for shape in ["object", "array", "function", "date"] {
        let trace = Arc::new(Trace::new(shape, 0, false, false));
        let user = user(shape, &trace);
        let mut config = test_helpers::create_test_config();
        let _ = config
            .session
            .fields_mut()
            .insert("userId".into(), UserFieldConfig::default());
        let config = Arc::new(config);
        let store = Arc::new(EphemeralStore::new(config.clone()).with_hooks(vec![trace.clone()]));
        let context = test_helpers::initialize_test_context(config, store.clone(), &[]).await?;
        let issued = issue_selected_user_session_optional(
            &context,
            user.value.clone(),
            &RequestMeta::default(),
            context.config.session.expires_in(),
        )
        .await
        .map_err(SessionIssueError::into_auth_error)?
        .unwrap();
        assert!(issued.user_value()?.strict_equals(&user.value));
        assert_eq!(*trace.events.lock().unwrap(), ["user-id-1", "create"]);
        let rows = store.storage_rows(EntityRole::Session)?;
        assert_eq!(rows.len(), 1);
        assert_eq!(rows[0].get("id"), Some(&issued.session_property("id")?));
        assert_eq!(
            rows[0].get("token"),
            Some(&issued.session_property("token")?)
        );
        assert_eq!(rows[0].get("userId"), Some(&7.into()));
    }
    Ok(())
}