Commit Graph

4783 Commits

Author SHA1 Message Date
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
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
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
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
2d8b830b87 groupware: add endpoints to patch addressbooks, contacts, calendars, events 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
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
Pascal Bleser
88e81191b2 groupware: clarify the ContactCard situation 2026-07-09 14:15:52 +02:00
Pascal Bleser
87724e21ab groupware: add contact sorting query parameter and fix default sorting (must use updated instead of name) 2026-07-09 14:15:52 +02:00
Pascal Bleser
bab55316b0 groupware: sort contacts in addressbook by name 2026-07-09 14:15:52 +02:00
Pascal Bleser
cdcd959a89 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-07-09 14:15:52 +02:00
Pascal Bleser
24d78dd3f6 groupware: upgrade redocly/cli 2.15.1 -> 2.20.2 2026-07-09 14:15:52 +02:00
Pascal Bleser
ff455670cb groupware: minor logging improvements to the session cache 2026-07-09 14:15:52 +02:00
Pascal Bleser
5b2e8d13eb 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-07-09 14:15:52 +02:00
Pascal Bleser
4fd6912967 groupware: remove remnants of go-swagger documentation, since we are switching to using our own tool instead 2026-07-09 14:15:52 +02:00
Pascal Bleser
1806a61bb2 groupware: add jscontact examples, and move them to jmap/model_examples.go to avoid dependency recursion 2026-07-09 14:15:52 +02:00
Pascal Bleser
bf5882fbad groupware: use the OIDC client ID 'web' instead of 'groupware' 2026-07-09 14:15:52 +02:00
Pascal Bleser
0fd87e7d9b 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-07-09 14:15:52 +02:00
Pascal Bleser
716da112ba groupware: update DEVELOPERS.md based on Jörn's feedback 2026-07-09 14:15:52 +02:00
Pascal Bleser
bfbded45e2 auth-api: deal with errors properly in NewService 2026-07-09 14:15:52 +02:00
Pascal Bleser
1d8303ca6d groupware: bump redocly/cli from 2.14.6 to 2.15.1 2026-07-09 14:15:52 +02:00
Pascal Bleser
a31dd1d4c9 groupware: also update DEVELOPER.md with new OpenAPI documentation generation tooling 2026-07-09 14:15:52 +02:00
Pascal Bleser
f5eafeee10 groupware: update README to new API documentation generation process, and remove defunct files 2026-07-09 14:15:52 +02:00
Pascal Bleser
6df2143b23 groupware: more API examples 2026-07-09 14:15:52 +02:00
Pascal Bleser
1eaed23b25 groupware: change Makefile to use groupware-apidocs instead of go-swagger 2026-07-09 14:15:52 +02:00
Pascal Bleser
c72b9d82a5 update redocly 2.14.5 -> 2.14.6 2026-07-09 14:15:52 +02:00
Pascal Bleser
3423df533f groupware: migrate to cobra instead of urfave 2026-07-09 14:15:52 +02:00
Pascal Bleser
b0a1a60904 groupware: update pnpm 10.28.0 -> 10.28.1 2026-07-09 14:15:52 +02:00
Pascal Bleser
f16df72672 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-07-09 14:15:52 +02:00