Commit Graph
142 Commits
Author SHA1 Message Date
tammi-23 435463af41 fix(groupware): request the JMAP capabilities required by identity, submission and address book calls
Identity/get and EmailSubmission were sent without
urn:ietf:params:jmap:submission, and all address book calls were sent with
the mail instead of the contacts capability. Stalwart rejects such calls
with unknownMethod since 0.16.x, which breaks the account bootstrap
(GET /groupware/accounts) and the address books.

Also use the calendar type for creating, updating and deleting calendars
(same capability, no change in behaviour).
2026-10-31 00:09:52 +01:00
Pascal Bleser 92ca22e910 groupware: upgrade Stalwart to 0.16.12 + fix modifying the VacationResponse
* fix jmap.SetVacationResponse: was using JMAP create instead of update
   with a patch; did so by using the modify template function as with
   most other JMAP APIs

 * better HTTP status code handling for the responses received from
   Stalwart

 * add support for not caching JMAP session retrieval failures in the
   Groupware backend, by setting the error TTL to 0
2026-10-30 23:20:51 +01:00
Pascal Bleser 6c3ebc7f7e groupware: move plain http functions to pkg/http
* introduce a new toplevel package pkg/http for plain HTTP related
   functions

 * move these functions from pkg/jmap to pkg/http, including tests:
   - PeekResponse
   - DumpHttpRequest
   - DumpHttpResponse
2026-10-30 23:20:51 +01:00
Pascal Bleser 72f4d0c6d6 groupware: add test for vacation responses, and fix issue found during testing 2026-10-30 23:20:51 +01:00
Pascal Bleser 4a55d016fe groupware: add response peeking 2026-10-30 23:20:51 +01:00
Pascal Bleser 5d5e246a65 groupware: fix sorting emails in reverse order 2026-10-30 23:20:51 +01:00
Pascal Bleser ee03db134d groupware: add Groupware integration testing
* split off the Stalwart integration test boilerplate into a new
   jmaptest package, in order to be able to use it from the groupware
   package as well

 * remove the JMAP Session patching in tests and, instead, pick random
   free local ports for HTTP and IMAPS manually, and set those
   explicitly in the Stalwart testcontainer, so that we can set the
   PUBLIC_URL environment variable that Stalwart then uses to define the
   URLs that are served as part of the JMAP Sessions (API URL, etc...)
2026-10-30 23:20:51 +01:00
Pascal Bleser e3d635c25c groupware: introduce a new package 'jmaptest' in order to be able to reuse the Stalwart test fixture for Groupware tests 2026-10-30 23:20:51 +01:00
Pascal Bleser a585c1ace8 groupware: add body tracing to WS, fix metrics registrations, add operation identifiers for metrics 2026-10-30 23:20:51 +01:00
Pascal Bleser ad66875349 groupware: add better HTTP logging
* introduce configuration settings for TLS insecurity, tracing requests
   and responses

 * use more secure implementation when replacing JMAP placeholders in
   URL templates, path escaping them to avoid injection

 * add more efficient tracing of HTTP requests and responses between the
   Groupware backend and the JMAP server, with the possibility of
   specifying a maximum body size to trace, to avoid blowing up the logs

 * use more efficient string building for HTTP Authorization headers

 * change internal API to use streams (io.Reader) instead of reading
   JSON responses fully into memory before parsing them
2026-10-30 23:20:51 +01:00
Pascal Bleser 473086531d groupware: slightly improve the implementation of e77250b7c4 2026-10-30 23:20:51 +01:00
Pascal Bleser 56e561bd86 groupware: add workaround when using the master/impersonation account: in that case, don't use impersonation but the impersonation account directly 2026-10-30 23:20:51 +01:00
Pascal Bleser 4af171aff8 groupware: fully implement suppliers for addressbooks and contacts
* implement supplier templating to allow addressbooks and contacts to
   come from various sources ("suppliers", thus) as opposed to solely
   from JMAP

 * add creating, deleting, updating, getting changes

 * add some search filter parameters, currently incomplete
2026-10-30 23:20:51 +01:00
Pascal Bleser 64b03203f1 groupware: fix NPE when flattening durations in slist() 2026-10-30 23:20:51 +01:00
Pascal Bleser 1a909bedb7 groupware: upgrade Stalwart to 0.16.9 for integration tests 2026-10-30 23:20:51 +01:00
Pascal Bleser a210032103 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-10-30 23:20:51 +01:00
Pascal Bleser e6bf657ec9 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-10-30 23:20:51 +01:00
Pascal Bleser 527c6e668c groupware: jmap: add a test for Invocation seriaization 2026-10-30 23:20:51 +01:00
Pascal Bleser b8c0c06efa 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-10-30 23:20:51 +01:00
Pascal Bleser 13b74567ee groupware: port tests to Stalwart 0.16.7 2026-10-30 23:20:51 +01:00
Pascal Bleser 1c0124780a groupware: fix unit tests 2026-10-30 23:20:47 +01:00
Pascal Bleser 140bd899c2 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-10-30 23:20:47 +01:00
Pascal Bleser 492fb3251d 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-10-30 23:20:47 +01:00
Pascal Bleser 2845f2baae 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-10-30 23:20:47 +01:00
Pascal Bleser 69aa24e35c 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-10-30 23:20:47 +01:00
Pascal Bleser 77484a59f8 groupware: API documentation updates 2026-10-30 23:20:47 +01:00
Pascal Bleser 8b145b0b27 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-10-30 23:20:47 +01:00
Pascal Bleser bedf49b7a2 groupware: fix test logic error in the JMAP ws integration test 2026-10-30 23:20:47 +01:00
Pascal Bleser 458af63774 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-10-30 23:20:47 +01:00
Pascal Bleser 99828addb9 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-10-30 23:20:47 +01:00
Pascal Bleser 5dc0064876 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-10-30 23:20:47 +01:00
Pascal Bleser 1b2402143d groupware: add documentation for SearchResultsTemplate + update pnpm 2026-10-30 23:20:47 +01:00
Pascal Bleser dc93134a91 groupware: rename 'offset' to 'position' to be consistent with the JMAP specification 2026-10-30 23:20:47 +01:00
Pascal Bleser cef6e183ed groupware: fixes after rebasing and Docker library API changes 2026-10-30 23:20:47 +01:00
Pascal Bleser bf6da84a98 groupware: documentation changes after API generator updates for the use of template functions 2026-10-30 23:20:47 +01:00
Pascal Bleser e65cd3ca1d 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-10-30 23:20:47 +01:00
Pascal Bleser e5804697e5 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-10-30 23:20:47 +01:00
Pascal Bleser f31c80cb09 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-10-30 23:20:47 +01:00
Pascal Bleser edfdc7c506 groupware: refactor for conciseness
* introduce jmap.Context to hold multiple parameters and shorten
   function calls

 * introduce SearchResultsTemplate
2026-10-30 23:20:47 +01:00
Pascal Bleser 2c39657293 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-10-30 23:20:47 +01:00
Pascal Bleser b7aa8ee257 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-10-30 23:20:46 +01:00
Pascal Bleser e5fb5413ad 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-10-30 23:20:46 +01:00
Pascal Bleser 281a9c67d6 groupware: add changes support for quotas, identities, submissions 2026-10-30 23:20:46 +01:00
Pascal Bleser 43b4984f37 groupware: framework refactorings + add support for /changes + add /objects 2026-10-30 23:20:46 +01:00
Pascal Bleser 473ae82ec9 groupware: pollute code with NOSONAR comments, and make a little more use of JMAP API templates 2026-10-30 23:20:46 +01:00
Pascal Bleser 30695e8df7 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-10-30 23:20:46 +01:00
Pascal Bleser c57259af46 groupware: documentation: more calendar examples 2026-10-30 23:20:46 +01:00
Pascal Bleser c93c69847d groupware: fix typos and minor issues
- fix a bunch of minor issues and typos that were found using GoLand
   and gosec

 - add a gosec Makefile target for Groupware related files, in
   services/groupware/Makefile

 - enable checking JMAP session capabilities for events and contacts,
   and only enable skipping that check for tasks until those are
   implemented in Stalwart as well

 - fix a CWE-190 (integer overflow or wraparound) found by gosec

 - consistently use struct references for methods of Groupware and
   Request, instead of mixing up references and copies

 - always log errors when unable to register a Prometheus metric
2026-10-30 23:20:46 +01:00
Pascal Bleser 78f5912a04 groupware: upgrade Stalwart image in integration tests from 0.15.0 to 0.15.5 2026-10-30 23:20:46 +01:00
Pascal Bleser 2bfa0ec153 groupware: add UI example of a ContactCard to the documented examples 2026-10-30 23:20:46 +01:00