Commit Graph

335 Commits

Author SHA1 Message Date
Pascal Bleser
5bae16be63 groupware: API documentation updates 2026-04-30 10:51:45 +02:00
Pascal Bleser
0cbf4b7287 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-04-30 10:51:45 +02:00
Pascal Bleser
ac52a4f967 groupware: fix test logic error in the JMAP ws integration test 2026-04-30 10:51:45 +02:00
Pascal Bleser
91e2705bb1 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-04-30 10:51:45 +02:00
Pascal Bleser
b63b0b3f28 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-04-30 10:51:45 +02:00
Pascal Bleser
d88a68d1cb 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-04-30 10:51:45 +02:00
Pascal Bleser
652b87d350 groupware: add documentation for SearchResultsTemplate + update pnpm 2026-04-30 10:51:45 +02:00
Pascal Bleser
e4c5e6486d groupware: rename 'offset' to 'position' to be consistent with the JMAP specification 2026-04-30 10:51:45 +02:00
Pascal Bleser
47f70283f2 groupware: fixes after rebasing and Docker library API changes 2026-04-30 10:51:45 +02:00
Pascal Bleser
8c41e41c9e groupware: documentation changes after API generator updates for the use of template functions 2026-04-30 10:51:45 +02:00
Pascal Bleser
2883f04488 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-04-30 10:51:45 +02:00
Pascal Bleser
4bee5f01f5 structs: add tests and documentation 2026-04-30 10:51:45 +02:00
Pascal Bleser
c140b19d1e 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-04-30 10:51:45 +02:00
Pascal Bleser
82b308a5cb 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-04-30 10:51:45 +02:00
Pascal Bleser
ba367aa419 groupware: refactor for conciseness
* introduce jmap.Context to hold multiple parameters and shorten
   function calls

 * introduce SearchResultsTemplate
2026-04-30 10:51:45 +02:00
Pascal Bleser
7de3ec05a4 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-04-30 10:51:45 +02:00
Pascal Bleser
67ec7a5547 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-04-30 10:51:45 +02:00
Pascal Bleser
7d8e3ef1e8 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-04-30 10:51:45 +02:00
Pascal Bleser
98e1701c0a groupware: add changes support for quotas, identities, submissions 2026-04-30 10:51:45 +02:00
Pascal Bleser
0b984a8e2f groupware: framework refactorings + add support for /changes + add /objects 2026-04-30 10:51:45 +02:00
Pascal Bleser
4d9e402cfd groupware: pollute code with NOSONAR comments, and make a little more use of JMAP API templates 2026-04-30 10:51:45 +02:00
Pascal Bleser
c1f7bc2261 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-04-30 10:51:45 +02:00
Pascal Bleser
a4dac96fbe groupware: documentation: more calendar examples 2026-04-30 10:51:44 +02:00
Pascal Bleser
549fc4642a 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-04-30 10:51:44 +02:00
Pascal Bleser
7e2e4f4597 groupware: upgrade Stalwart image in integration tests from 0.15.0 to 0.15.5 2026-04-30 10:51:44 +02:00
Pascal Bleser
7b0215e332 groupware: add UI example of a ContactCard to the documented examples 2026-04-30 10:51:44 +02:00
Pascal Bleser
c400949718 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-04-30 10:51:44 +02:00
Pascal Bleser
8ad3652ba2 groupware: remove remnants of go-swagger documentation, since we are switching to using our own tool instead 2026-04-30 10:51:44 +02:00
Pascal Bleser
8ba07def4c groupware: add jscontact examples, and move them to jmap/model_examples.go to avoid dependency recursion 2026-04-30 10:51:44 +02:00
Pascal Bleser
700930c3a9 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-04-30 10:51:44 +02:00
Pascal Bleser
f57507fa98 groupware: convert documentation to proper markdown 2026-04-30 10:51:44 +02:00
Pascal Bleser
8a3a6160f9 groupware: more API examples 2026-04-30 10:51:44 +02:00
Pascal Bleser
504e107e11 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-04-30 10:51:44 +02:00
Pascal Bleser
b5037f89c9 groupware: update to Stalwart 0.15.0 2026-04-30 10:51:44 +02:00
Pascal Bleser
2d89fb381a groupware: fix failing pkg/jscontact unit tests 2026-04-30 10:51:44 +02:00
Pascal Bleser
fb39d46a11 groupware: fix failing pkg/jscalendar unit tests 2026-04-30 10:51:44 +02:00
Pascal Bleser
2dbf2973a6 groupware: improve email submission and testing
* jmap/EmailCreate: add more attributes that were omitted: Headers,
   InReplyTo, References, Sender

 * add jmap GetEmailSubmissionStatus

 * improve email integration tests by adding a thorough test for email
   submission

 * jmap integration tests: provision principals and domains using the
   Stalwart Management API, switching from an in-memory to an internal
   directory
2026-04-30 10:51:44 +02:00
Pascal Bleser
289c9678a9 groupware: add retrieving and adding mailboxIds for drafts and sent if they are missing 2026-04-30 10:51:44 +02:00
Pascal Bleser
c16ba3ac4a groupware: WS push improvements, add getting email changes to WS integration test 2026-04-30 10:51:43 +02:00
Pascal Bleser
97e0be9f45 groupware: JMAP WS push notifications support 2026-04-30 10:51:43 +02:00
Pascal Bleser
0a355304f9 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-04-30 10:51:43 +02:00
Pascal Bleser
d8c06d4db8 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-04-30 10:51:43 +02:00
Pascal Bleser
ba30c1be87 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-04-30 10:51:43 +02:00
Pascal Bleser
9d0619719a groupware: refactor the JMAP integration tests 2026-04-30 10:51:43 +02:00
Pascal Bleser
0eb6dce8fd groupware: improve JMAP ContactCard integration tests 2026-04-30 10:51:43 +02:00
Pascal Bleser
0d52b9a812 groupware: improve JMAP integration tests for ContactCards 2026-04-30 10:51:43 +02:00
Pascal Bleser
0fc6ec9da9 groupware: fix recently introduced error with UploadedBlob with and without a sha512 2026-04-30 10:51:43 +02:00
Pascal Bleser
214860e276 groupware: fix blob uploading metadata and add 'POST /blobs' route 2026-04-30 10:51:43 +02:00
Pascal Bleser
b9bce2fb70 groupware: add getting a contact by ID + add integration tests for contacts 2026-04-30 10:51:43 +02:00
Pascal Bleser
6e5ff678ee groupware: improved integration test for email, fixed two bugs 2026-04-30 10:51:43 +02:00