Commit Graph

131 Commits

Author SHA1 Message Date
Pascal Bleser
92fbdda1ec groupware: fix unit tests 2026-06-16 16:51:37 +02:00
Pascal Bleser
7d4bce2307 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-06-16 16:51:37 +02:00
Pascal Bleser
7e8caab979 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-06-16 16:51:37 +02:00
Pascal Bleser
3e8c37a13b 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-06-16 16:51:37 +02:00
Pascal Bleser
92aa5fca67 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-06-16 16:51:37 +02:00
Pascal Bleser
e772f46c97 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-06-16 16:51:37 +02:00
Pascal Bleser
ffc0e1f42a 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-06-16 16:51:37 +02:00
Pascal Bleser
ce9b4d59bc 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-06-16 16:51:37 +02:00
Pascal Bleser
92b85b215a groupware: rename 'offset' to 'position' to be consistent with the JMAP specification 2026-06-16 16:51:37 +02:00
Pascal Bleser
dcc5f34990 groupware: fix getall template result type: []T instead of RESP 2026-06-16 16:51:37 +02:00
Pascal Bleser
c710336b22 groupware: documentation changes after API generator updates for the use of template functions 2026-06-16 16:51:37 +02:00
Pascal Bleser
a115679f3d 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-06-16 16:51:37 +02:00
Pascal Bleser
dac4a48719 groupware: add endpoints to patch addressbooks, contacts, calendars, events 2026-06-16 16:51:37 +02:00
Pascal Bleser
2023cdf444 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-06-16 16:51:37 +02:00
Pascal Bleser
83e9953df6 groupware: refactor for conciseness
* introduce jmap.Context to hold multiple parameters and shorten
   function calls

 * introduce SearchResultsTemplate
2026-06-16 16:51:37 +02:00
Pascal Bleser
6e2eea65b2 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-06-16 16:51:37 +02:00
Pascal Bleser
89fee977c8 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-06-16 16:51:37 +02:00
Pascal Bleser
39e9e6d53b groupware: add GetIdentityChanges 2026-06-16 16:51:37 +02:00
Pascal Bleser
6ef5988f30 groupware: add changes support for quotas, identities, submissions 2026-06-16 16:51:37 +02:00
Pascal Bleser
a49b0e239e groupware: framework refactorings + add support for /changes + add /objects 2026-06-16 16:51:37 +02:00
Pascal Bleser
4a2f9463e4 groupware: pollute code with NOSONAR comments, and make a little more use of JMAP API templates 2026-06-16 16:51:37 +02:00
Pascal Bleser
c87cbf0291 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-06-16 16:51:37 +02:00
Pascal Bleser
10747d57f9 groupware: clarify the ContactCard situation 2026-06-16 16:51:37 +02:00
Pascal Bleser
4a8182d45d groupware: add contact sorting query parameter and fix default sorting (must use updated instead of name) 2026-06-16 16:51:37 +02:00
Pascal Bleser
cf29107524 groupware: sort contacts in addressbook by name 2026-06-16 16:51:37 +02:00
Pascal Bleser
0bed356966 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-06-16 16:51:37 +02:00
Pascal Bleser
36931987ec groupware: minor logging improvements to the session cache 2026-06-16 16:51:36 +02:00
Pascal Bleser
6b8f7207d6 groupware: add OIDC authentication support between Groupware backend and Stalwart
* re-implement the auth-api service to authenticate Reva tokens
   following the OIDC Userinfo endpoint specification

 * pass the context where necessary and add an authenticator interface
   to the JMAP HTTP driver, in order to select between master
   authentication (which is used when GROUPWARE_JMAP_MASTER_USERNAME and
   GROUPWARE_JMAP_MASTER_PASSWORD are both set) and OIDC token
   forwarding through bearer auth

 * add Stalwart directory configuration "idmoidc" which uses the
   OpenCloud auth-api service API (/auth/) to validate the token it
   received as bearer auth from the Groupware backend's JMAP client,
   using it as an OIDC Userinfo endpoint

 * implement optional additional shared secret to secure the Userinfo
   service, as an additional path parameter
2026-06-16 16:51:35 +02:00
Pascal Bleser
8244e4b22f groupware: remove remnants of go-swagger documentation, since we are switching to using our own tool instead 2026-06-16 16:50:52 +02:00
Pascal Bleser
124ed20e13 groupware: as suggested in the review PR 1994, remove all filename prefixes that match the package (groupware_xyz.go -> xyz.go), for groupware, jmap, jscontact, jscalendar 2026-06-16 16:50:52 +02:00
Pascal Bleser
48b00db7a7 groupware: more API examples 2026-06-16 16:50:52 +02:00
Pascal Bleser
6b396ce90b groupware: migrate to cobra instead of urfave 2026-06-16 16:50:52 +02:00
Pascal Bleser
ef7b1d4a72 API documentation changes for groupware-apidocs
* add example generator infrastructure, with some examples for pkg/jmap
   and pkg/groupware, with more needing to be done

 * alter the apidoc Makefile to stop using go-swagger but, instead, use
   the openapi.yml file that must be dropped into that directory using
   groupware-apidocs (will improve the integration there later)

 * add Makefile target to generate examples

 * bump redocly from 2.4.0 to 2.14.5

 * introduce Request.PathParam() and .PathParamDoc() to improve API
   documentation, as well as future-proofing

 * improve X-Request-ID and Trace-Id header handling in the middleware
   by logging it safely when an error occurs in the middleware
2026-06-16 16:50:11 +02:00
Pascal Bleser
96d8785076 groupware: shift some attributes of the Groupware object around, in defaults and config sub-structures 2026-06-16 16:50:11 +02:00
Pascal Bleser
ad9820d437 groupware: add description and version annotations for env configuration properties 2026-06-16 16:50:11 +02:00
Pascal Bleser
531e913ca4 groupware: add retrieving and adding mailboxIds for drafts and sent if they are missing 2026-06-16 16:50:11 +02:00
Pascal Bleser
27a5b32c8d groupware: refactor response objects to take a list of accountIds 2026-06-16 16:50:11 +02:00
Pascal Bleser
6741263e09 groupware: fix missing casting to jmap.State after changes in pkg/jmap 2026-06-16 16:50:11 +02:00
Pascal Bleser
8130ab97da groupware, auth-api: remove tracing and tracing configuration 2026-06-16 16:50:11 +02:00
Pascal Bleser
135bc066ae groupware: JMAP WS push notifications support 2026-06-16 16:50:11 +02:00
Pascal Bleser
66b86af3c7 groupware: fix email summaries and allow negative offsets
* fix a bug in how email summaries are flattened across multiple
   accounts, which was previous resulting in empty email objects

 * allow negative offset in email pagination

 * make all /emails endpoints return emails without bodies
2026-06-16 16:50:11 +02:00
Pascal Bleser
b79c251c5c groupware: response payload /groupware/accounts/{id}/emails should be without email bodies 2026-06-16 16:50:11 +02:00
Pascal Bleser
b931cb335a groupware: add Object-Type and Account-Id response headers
* implement Request.AllAccountIds() to generalize the fetching (and
   uniqifying) of all account IDs, which will allow us to implement
   things such as "subscribed" accounts, or limiting the number of
   accounts in one request

 * add Account-Id response header

 * add Object-Type response header
2026-06-16 16:50:11 +02:00
Pascal Bleser
6eff50009c groupware: feature test improvements and upgrade to Stalwart 0.14.1
* upgrade Stalwart image for devtools/full to 0.14.1

 * re-assert which features are implemented or not in 0.14.1

 * refactor the integration tests yet again to make it clearer and
   easier to see those "features-or-not"

 * get rid of old tests that are now better covered by integration tests

 * rewrite how we compare expected and actual objects in integration
   tests, finally having found a way to ignore the @type attribute
   properly instead of having to mutate all objects to remove it
2026-06-16 16:50:11 +02:00
Pascal Bleser
941ef9358c groupware: finalize JMAP events integration test, with multiple changes to the model to conform with draft-ietf-calext-jscalendarbis-10 and fields that are currently not implemented in Stalwart 2026-06-16 16:50:11 +02:00
Pascal Bleser
d1d1015d6f groupware: fix recently introduced error with UploadedBlob with and without a sha512 2026-06-16 16:50:11 +02:00
Pascal Bleser
4266a45b4c groupware: fix blob uploading metadata and add 'POST /blobs' route 2026-06-16 16:50:11 +02:00
Pascal Bleser
b4ac0add53 groupware: add getting a contact by ID + add integration tests for contacts 2026-06-16 16:50:11 +02:00
Pascal Bleser
9a03353caf groupware: remove mock calendars and contacts 2026-06-16 16:50:11 +02:00
Pascal Bleser
d559000f95 groupware: some fixes accordingly to the latest JMAP and jscalendarbis RFCs 2026-06-16 16:50:11 +02:00