Automagically connect Thundermail Calendar in FTUE by davinotdavid · Pull Request #1544 · thunderbird/appointment

davinotdavid · 2026-02-26T22:07:20Z

Description of the Change

Updated docker-compose.yml container ports not to clash with thunderbird-accounts when running locally
Added TB_ACCOUNTS_CALDAV_URL env var.
Added POST '/caldav/oidc/auth' route to attempt to connect to the CalDAV through the OIDC token.
Removed the ConnectYourCalendarThundermailStep as we don't need it anymore + related i18n and enum entries.

Here's the flow:

Frontend makes a POST request to /caldav/oidc/auth
Appointment's Backend makes a POST request to Account's Backend /appointment/caldav/setup/ passing the APPOINTMENT_CALDAV_SECRET and the current logged in user's OIDC token
Account's Backend deletes previously existing App Passwords that match a specific label and creates a new App Password in Stalwart. The password is returned in plain text as we will need it in Appointment's backend to connect to it but it is hashed when saved
Appointment's Backend takes the subscriber's email + newly created App Password and connects to the CalDAV server + creates the ExternalConnection entry

Warning

Requires thunderbird/thunderbird-accounts#616 to be merged in first for the best experience on testing this

How to test it

Alright, first of all, this is a joint effort with the thunderbird-accounts repo so make sure you are in the branch appointment-auto-setup-caldav (thunderbird/thunderbird-accounts#469) and you are able to run a docker compose up in both thunderbird-accounts and this branch in Appointment.

Make sure you have the .env var APPOINTMENT_CALDAV_SECRET set in both thunderbird-accounts and this branch to the same values.

Accounts Prerequisites

Navigate to the Django Admin in http://localhost:8087/admin and login with user admin@example.org and password admin.
Create a Subscription Plan manually in http://localhost:8087/admin/subscription/plan/add/. None of the information here actually matter except for the Product which has to be an active product.
Now navigate again to http://localhost:8087/ and you should be redirected to the /subscribe page.
Use Paddle's test cards for the checkout.
After you are redirected to the dashboard, you are all set!

PS: This whole step is required because only then we will have the authenticate.User model created + the actual Stalwart account to create the App Password.

Steps to test, now in Appointment-land

Navigate to http://localhost:8090, if you are redirected to Keycloak, login with the same admin@example.org / admin as before.
Go through the FTUE until the step to select which calendar to connect with and select Thundermail Calendar
Click Next and see that you are now in the Booking Page step with the Stalwart Calendar pre-selected. All that without manually creating an App Password!

Benefits

1 click configuration for Thundermail Calendar!

Applicable Issues

Fixes #1352

…-accounts

MelissaAutumn

Still need to test, but I don't see why this wouldn't work. Thanks!

Needs some code de-duping though 😄

MelissaAutumn · 2026-03-16T22:05:58Z

+            sentry_sdk.set_extra('debug_object', debug_obj)
+            raise UnexpectedBehaviourWarning(message='Cache incorrect', info=debug_obj)
+        except UnexpectedBehaviourWarning as ex:
+            sentry_sdk.capture_exception(ex)


Since this is entirely thunderbird accounts we probably don't need the debug object information. This was just to capture information about failing caldav servers (and I think we've caught all those edge-cases too.)

Hmmm fair but since I've extracted this into a shared _resolve_caldav_url for both cases, perhaps it wouldn't hurt to leave it?

…ferent functions

davinotdavid · 2026-03-23T16:42:24Z

@MelissaAutumn sorry for the ping on the re-review but when you have some time, could take another look on this PR? 🙏

MelissaAutumn

I haven't tested it, but the code looks fine!

MelissaAutumn · 2026-03-18T17:26:23Z


-oauth2_scheme = OAuth2PasswordBearer(tokenUrl='token', auto_error=False)
+
+async def get_bearer_token(request: Request) -> str | None:


Oh thanks, but this was okay to punt to another ticket 😅

MelissaAutumn · 2026-03-18T17:26:50Z

    )

-    return RedirectResponse(f'{os.getenv("FRONTEND_URL", "http://localhost:8080")}/post-login/{one_time_access_token}')
+    return RedirectResponse(f'{os.getenv("FRONTEND_URL", "http://localhost:8090")}/post-login/{one_time_access_token}')


In a future ticket we should move these to a constant value.

MelissaAutumn · 2026-03-23T17:18:14Z

 OIDC_TOKEN_INTROSPECTION_URL=
 OIDC_FALLBACK_MATCH_BY_EMAIL=
+
+# Required for Appointment's CalDAV auto-setup, needs to match the one in thunderbird-accounts


I recommend leaving this blank in the example env.

MelissaAutumn · 2026-03-23T17:18:58Z

 TB_ACCOUNTS_CALLBACK=http://localhost:5000/accounts/callback
 TB_ACCOUNTS_CLIENT_ID
 TB_ACCOUNTS_SECRET
+TB_ACCOUNTS_CALDAV_URL=http://host.docker.internal:8081


Important to note this won't work for all docker setups.

MelissaAutumn · 2026-03-23T17:55:46Z

-    case 'oidc':
-      await ftueStore.moveToStep(FtueStep.ConnectCalendarsThundermail);
+    case 'oidc': {
+      isLoading.value = true;


You know I don't know if this actually works within the same function call. I know we do it in other places but I don't think I've tested this.

It might work since the await might trigger a dom update eventually, but might be worth a test with a really long delay.

You are spot on, it does seem to work because of the await triggering a dom update and Vue batching updates. Tested here with a long delay and it updates the buttons accordingly!

This was referenced Feb 26, 2026

[WIP] Auto-connect Stalwart calendar through OIDC token #1366

Closed

Appointment CalDAV auto-setup thunderbird/thunderbird-accounts#469

Merged

davinotdavid temporarily deployed to staging February 26, 2026 22:54 — with GitHub Actions Inactive

davinotdavid had a problem deploying to staging February 26, 2026 22:54 — with GitHub Actions Failure

davinotdavid temporarily deployed to staging February 26, 2026 22:54 — with GitHub Actions Inactive

davinotdavid temporarily deployed to staging February 26, 2026 23:03 — with GitHub Actions Inactive

davinotdavid changed the title ~~[WIP] Automagically connect Thundermail Calendar in FTUE~~ Automagically connect Thundermail Calendar in FTUE Feb 26, 2026

davinotdavid force-pushed the ftue-automatic-connect-thundermail-calendar branch from 577d577 to f08d7ae Compare February 27, 2026 16:47

davinotdavid temporarily deployed to staging February 27, 2026 16:47 — with GitHub Actions Inactive

davinotdavid had a problem deploying to staging February 27, 2026 16:47 — with GitHub Actions Error

davinotdavid temporarily deployed to staging February 27, 2026 16:47 — with GitHub Actions Inactive

davinotdavid marked this pull request as ready for review March 3, 2026 16:33

davinotdavid temporarily deployed to staging March 3, 2026 16:33 — with GitHub Actions Inactive

davinotdavid requested review from MelissaAutumn and devmount March 3, 2026 16:33

davinotdavid temporarily deployed to staging March 3, 2026 16:36 — with GitHub Actions Inactive

davinotdavid temporarily deployed to staging March 3, 2026 16:37 — with GitHub Actions Inactive

davinotdavid temporarily deployed to staging March 4, 2026 18:08 — with GitHub Actions Inactive

davinotdavid added 2 commits March 16, 2026 15:16

Update docker-compose container ports not to collide with thunderbird…

8412507

…-accounts

Update .env.example and .env.test with new vars

0359125

davinotdavid added 7 commits March 16, 2026 15:16

Add tests for /caldav/oidc/auth

03fa8fd

Loading state and frontend error handling

93e6278

Remove ConnectYourCalendarThundermailStep view and related files

326c928

Fix lint

ce0e5ef

Update docker container ports in README

455713b

Update .env.example vars with new ports

d93d248

Better error handling in FTUE Thundermail CalDAV setup

42d316f

davinotdavid force-pushed the ftue-automatic-connect-thundermail-calendar branch from c547a88 to 42d316f Compare March 16, 2026 21:16

davinotdavid temporarily deployed to staging March 16, 2026 21:17 — with GitHub Actions Inactive

MelissaAutumn requested changes Mar 16, 2026

View reviewed changes

davinotdavid added 3 commits March 17, 2026 10:48

Extract caldav url resolution and upsert external connection into dif…

21c2f9f

…ferent functions

Update frontend default url to be localhost:8090

002c611

Replace OAuth2PasswordBearer with our own getter for bearer token

54d8872

davinotdavid temporarily deployed to staging March 17, 2026 18:58 — with GitHub Actions Inactive

davinotdavid requested a review from MelissaAutumn March 17, 2026 22:42

MelissaAutumn approved these changes Mar 23, 2026

View reviewed changes

Tiny updates to .env.example

885097d

davinotdavid temporarily deployed to staging March 25, 2026 16:50 — with GitHub Actions Inactive

davinotdavid merged commit f9e0402 into main Mar 25, 2026
8 checks passed

davinotdavid deleted the ftue-automatic-connect-thundermail-calendar branch March 25, 2026 16:56


		oauth2_scheme = OAuth2PasswordBearer(tokenUrl='token', auto_error=False)

		async def get_bearer_token(request: Request) -> str \| None:

Conversation

davinotdavid commented Feb 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of the Change

How to test it

Accounts Prerequisites

Steps to test, now in Appointment-land

Benefits

Applicable Issues

Uh oh!

MelissaAutumn left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

davinotdavid commented Mar 23, 2026

Uh oh!

MelissaAutumn left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

davinotdavid commented Feb 26, 2026 •

edited

Loading