Commit Graph

23577 Commits

Author SHA1 Message Date
Pascal Bleser
3306573630 groupware: upgrade Stalwart to 0.16.9 for integration tests 2026-07-09 14:30:14 +02:00
Pascal Bleser
a73f456073 groupware: remove middleware.RealIP, as it has been deprecated and we currently do not have a use for it 2026-07-09 14:30:14 +02:00
Pascal Bleser
53795a0fb0 groupware: downgrade to Go 1.25 since our building images are only available for 1.25 at the moment
* retrofit from using self-referencing generics parameters that were
   introduced with Go 1.26, will re-enable when we upgrade to 1.26

 * re-introduce a 'ptr' func since we don't have the new 'new' func yet
   that comes with 1.26
2026-07-09 14:30:14 +02:00
Pascal Bleser
153631d39f opencloud_full: add healthchecks for traefik, opencloud and stalwart to the docker compose project 2026-07-09 14:30:14 +02:00
Pascal Bleser
709153365a groupware: fix GROUPWARE_JMAP_MASTER_USERNAME to Stalwart 0.16 requirements for using the primary email instead of the username 2026-07-09 14:30:14 +02:00
Pascal Bleser
db84c2d13a groupware: fix building the stalwart:cli container
* fix the inline dockerfile for building the stalwart:cli container,
   cannot be based on scratch since we need a shell and wget, and it
   should thus retain the alpine container as its base

 * remove stdin_open and tty from the container attributes, not needed
2026-07-09 14:30:14 +02:00
Pascal Bleser
88661b4eba groupware: fix the 'opencloud-certs' container to set necessary permissions on the files or the opencloud container can't access them 2026-07-09 14:30:14 +02:00
Pascal Bleser
7326b2e971 groupware: update developer guide
* add instructions and container to create a key and certificate pair
   for the built-in IDM LDAP as we need it to listen on LDAPS for
   Stalwart, which has been disabled by default with
   https://github.com/opencloud-eu/opencloud/pull/2880

 * add environment variables to point to the certificates

 * update services/groupware/DEVELOPERS.md with up-to-date instructions,
   using Stalwart 0.16
2026-07-09 14:30:14 +02:00
Pascal Bleser
0964c94801 groupware: minor fix for the mock addressbook supplier 2026-07-09 14:30:14 +02:00
Pascal Bleser
cce5be261d groupware: VSCode launcher: change GROUPWARE_JMAP_MASTER_USERNAME from 'master' to 'admin@example.org' to make it work with Stalwart >= 0.16 2026-07-09 14:30:14 +02:00
Pascal Bleser
db14aebe21 groupware: move prefixed writer into export_integration_test.go + upgrade integration tests to Stalwart 0.16.8 + update Stalwart configuration to include necessary default roles 2026-07-09 14:30:13 +02:00
Pascal Bleser
878e7b96ea groupware: upgrade opencloud_full to Stalwart 0.16.8 and fix configuration by adding default roles as well as adding the 'impersonate' permission on the admin@example.org user 2026-07-09 14:30:13 +02:00
Pascal Bleser
8fa045b5c0 groupware: jmap: add a test for Invocation seriaization 2026-07-09 14:30:13 +02:00
Pascal Bleser
7533369c63 groupware: port opencloud_full to Stalwart 0.16 (only the built-in IDM LDAP option for now) 2026-07-09 14:30:13 +02:00
Pascal Bleser
3a0139eaa1 groupware: simplify JMAP integration tests with Stalwart 0.16
* don't run the Stalwart container in recovery mode first, just run it
   in "proper" mode, import the configuration and use it like that,
   which only requires skipping the "destroy" steps

 * add code documentation and logging

 * replace the text templating of the Stalwart snapshot by doing the
   same as the formatting script was doing, but directly in Go, removing
   an additional step to perform when modifying a Stalwart
   configuration to use in the integration tests
2026-07-09 14:30:13 +02:00
Pascal Bleser
d81c048582 groupware: port tests to Stalwart 0.16.7 2026-07-09 14:30:13 +02:00
Pascal Bleser
252acf320f groupware: fix unit tests 2026-07-09 14:30:13 +02:00
Pascal Bleser
6cbd695d7f groupware: add tracking of backend call durations
* add new configuration setting GROUPWARE_SEND_DURATIONS_RESPONSE
   (defaults to false)

 * keep track of lists of durations of backend calls

 * when enabled, report them as response headers Durations (human
   readable) and Durations-Nanos (as raw nanosecond values for machine
   consumption)
2026-07-09 14:30:13 +02:00
Pascal Bleser
c807c64d1c groupware: add strongly typed aliases for AccountId, PrincipalId and SupplierId
Purpose is to make APIs and parameters easier to understand, since plain
strings are used all over the place for all sorts of identifiers.
2026-07-09 14:30:13 +02:00
Pascal Bleser
d1d613afa0 groupware: remove unneeded jmap.QueryCommand methods
* remove the following methods on the jmap.QueryCommand interface, as
   they ended up not being needed:
   - GetPosition()
   - GetAnchor()
   - GetAnchorOffset()
   - GetLimit()
2026-07-09 14:30:13 +02:00
Pascal Bleser
b26c6cadce groupware: refactoring for pagination and support for multiple query suppliers
* refactor APIs in JMAP and Groupware in order to implement pagination
   across multiple accountIds and multiple suppliers (currently
   implemented using a mock supplier for contacts)

 * requires go 1.26 due to use of self-reflecting generics type
   constraints

 * still missing: query criteria and sorting parameters

 * still missing: multi-accountId support for emails

 * errors are now all just 'error' in the APIs, instead of the
   specialized implementations, and are interpreted dynamically where
   necessary in order to transform them into HTTP responses

 * remove position, anchor, anchorOffset as individual query parameters
   as we now only support a 'next=...' token for subsequent pages
   (except in emails for now), and use jmap.QueryParams instead; those
   tokens have a header character for the format, followed by a JSON
   encoded QueryParams map, all wrapped into base62 to make it clearer
   that it is meant to be an opaque token, and not a parameter clients
   should tinker with or construct themselves

 * introduce QueryParamsSupplier as an interface to provide QueryParams
   for various scenarios (single supplier, multiple supplier, ...) per
   accountId

 * implement multi-supplier template methods slist and squery
2026-07-09 14:30:13 +02:00
Pascal Bleser
6660bd7749 groupware: API documentation updates 2026-07-09 14:30:13 +02:00
Pascal Bleser
2fa8834f39 groupware: refactor responses to a jmap.Response object
* in the JMAP API as well as in several places in the Groupware
   framework, use a single jmap.Response[T] object to return the
   payload, the language, the session state and the etag/state instead
   of individual multi-valued return values
2026-07-09 14:30:13 +02:00
Pascal Bleser
360a46adb3 groupware: fix test logic error in the JMAP ws integration test 2026-07-09 14:30:13 +02:00
Pascal Bleser
4d10756e5e groupware: omit "position" when "anchor" is specified in queries
* the "position" attribute is always set to 0 when using an anchor for
   pagination, but it does not accurately reflect the position and thus
   we decided to remove the attribute from the resulting object for
   clarity

 * omit "canCalculateChanges" attribute when its value is "true", which
   is going to be the case in 100% of calls against Stalwart
2026-07-09 14:30:13 +02:00
Pascal Bleser
c8117a9c42 groupware: add support for anchor and anchor offset pagination
* add query parameters 'anchor' and 'offset':
   - anchor is an object identifier
   - offset is a numeric offset relative to the anchor
2026-07-09 14:30:13 +02:00
Pascal Bleser
a2ef9349b8 groupware: fix use of ?limit=0
* JMAP query limit of 0 is synonymous with "no limit", but we actually
   want to be able to perform queries without any results, for cases
   where we only want to count the total number of objects, and also
   because it makes more sense semantically

 * introduce query parameter validation checks, in order to only allow
   query parameters that are actually supported, which is going to be
   useful during development of clients
2026-07-09 14:30:13 +02:00
Pascal Bleser
d83846f9a7 groupware: add documentation for SearchResultsTemplate + update pnpm 2026-07-09 14:30:13 +02:00
Pascal Bleser
462ee908a3 groupware: rename 'offset' to 'position' to be consistent with the JMAP specification 2026-07-09 14:30:13 +02:00
Pascal Bleser
a79e1fd908 groupware: fix getall template result type: []T instead of RESP 2026-07-09 14:30:13 +02:00
Pascal Bleser
fa23f5a55c groupware: fixes after rebasing and Docker library API changes 2026-07-09 14:30:13 +02:00
Pascal Bleser
04d2745945 groupware: documentation changes after API generator updates for the use of template functions 2026-07-09 14:30:13 +02:00
Pascal Bleser
2d01001093 groupware: refactoring using function templates
* adds creating addressbooks, calendars, mailboxes

 * adds deleting mailbox, event, identity

 * adds modifying an email

 * introduce template functions for the Groupware API in templates.go,
   and use those in route function implementations whenever possible

 * add capability checking for mail, quota, blobs

 * adds Changes interface

 * adds JmapResponse interface
2026-07-09 14:30:13 +02:00
Pascal Bleser
ee8622dbe7 structs: add tests and documentation 2026-07-09 14:30:13 +02:00
Pascal Bleser
2d8b830b87 groupware: add endpoints to patch addressbooks, contacts, calendars, events 2026-07-09 14:30:13 +02:00
Pascal Bleser
fae384cedc groupware: improve tests
* jmap: add UpdateContactCard and UpdateCalendarEvent funcs
 * use JSON marshalling and unmarshalling into a map for toPatch()
   implementations
 * add updating ContactCards and CalendarEvents to tests
 * add deleting ContactCards and CalendarEvents to tests
 * make query response totals work when the value is 0
 * tests: use CreateContactCard and CreateCalendarEvent funcs to create
   objects in tests instead of using a different JMAP stack that works
   with untyped maps
2026-07-09 14:30:13 +02:00
Pascal Bleser
116d1bce4a groupware: refactoring: pass object type instead of namespaces
* make the JMAP internal API a bit more future-proof by passing
   ObjectType objects instead of the JMAP namespaces

 * remove the new attempt to contain operations even further using the
   Factory objects

 * move CalendarEvent operations to its own file, like everything else

 * fix email tests

 * ignore WS error when closing an already closed connection
2026-07-09 14:30:13 +02:00
Pascal Bleser
b73c317708 groupware: refactor for conciseness
* introduce jmap.Context to hold multiple parameters and shorten
   function calls

 * introduce SearchResultsTemplate
2026-07-09 14:30:13 +02:00
Pascal Bleser
1cafc9e918 groupware: model refactoring, introducing typed interfaces and Foo
* move ContactCard from jscontact to jmap, as it is actually a JMAP
   specification item, but also was causing too many issues with
   circular references from jscontact -> jmap

 * introduce Foo, Idable, GetRequest, GetResponse, etc... types and
   generics

 * first attempt at a Foo factory type for Mailboxes, needs to be
   expanded to further minimize repetition

 * add more specialized template functions to avoid repetition

 * introduce ChangesTemplate[T] for *Changes structs
2026-07-09 14:30:12 +02:00
Pascal Bleser
e887259b43 groupware: significant refactorings of the JMAP framework, adding methods and more intelligence to the various request and response types to improve the use of template functions, reducing the risks of typos and copy/paste mistakes 2026-07-09 14:15:53 +02:00
Pascal Bleser
1e05d91893 groupware: add addressbook and calendar creation APIs
* add Groupware APIs for creating and deleting addressbooks

 * add Groupware APIs for creating and deleting calendars

 * add JMAP APIs for creating and deleting addressbooks, calendars

 * add JMAP APIs to retrieve Principals

 * fix API tagging

 * move addressbook JMAP APIs into its own file

 * move addressbook Groupware APIs into its own file
2026-07-09 14:15:53 +02:00
Pascal Bleser
7a7140d9a8 groupware: add GetIdentityChanges 2026-07-09 14:15:53 +02:00
Pascal Bleser
dc596f7e55 groupware: bump @redocly/cli 2.24.0 -> 2.25.2 2026-07-09 14:15:53 +02:00
Pascal Bleser
e8ada10fdb groupware: add changes support for quotas, identities, submissions 2026-07-09 14:15:53 +02:00
Pascal Bleser
c921133c28 groupware: framework refactorings + add support for /changes + add /objects 2026-07-09 14:15:52 +02:00
Pascal Bleser
3eae25b26a groupware: pollute code with NOSONAR comments, and make a little more use of JMAP API templates 2026-07-09 14:15:52 +02:00
Pascal Bleser
a78c70f785 groupware: docs: add a quick copy-pastable block for running ldapsearch 2026-07-09 14:15:52 +02:00
Pascal Bleser
a5ade45d92 groupware: upgrade redocly to 2.24.0 2026-07-09 14:15:52 +02:00
Pascal Bleser
c84ca32508 groupware: refactor contactcard changes, and Request framework
* implement ContactCard retrieval endpoint for syncing

 * re-implement that endpoint for Email too

 * fix the Mailbox changes endpoint to actually return changes about
   Mailboxes, and not about Emails

 * when querying the diff of Mailboxes without any prior state, return
   an error since the result is not what one would expect

 * introduce the 'changes' API tag and group

 * refactor the successful response functions to consistently return an
   object type and object state whenever possible

 * move the syncing endpoints under /accounts/*/changes/ for better
   clarity, e.g. /changes/emails instead of /emails/mailbox/*/changes
2026-07-09 14:15:52 +02:00
Pascal Bleser
f39d859525 groupware: upgrade redocly/cli 2.20.0 -> 2.24.0 2026-07-09 14:15:52 +02:00