opencloud/pkg/jmap/jmap_session.go

package jmap

import (
	"errors"
	"fmt"
	"net/url"
)

type SessionEventListener interface {
	OnSessionOutdated(session *Session, newSessionState SessionState)
}

// Cached user related information
//
// This information is typically retrieved once (or at least for a certain period of time) from the
// JMAP well-known endpoint of Stalwart and then kept in cache to avoid the performance cost of
// retrieving it over and over again.
//
// This is really only needed due to the Graph API limitations, since ideally, the account ID should
// be passed as a request parameter by the UI, in order to support a user having multiple accounts.
//
// Keeping track of the JMAP URL might be useful though, in case of Stalwart sharding strategies making
// use of that, by providing different URLs for JMAP on a per-user basis, and that is not something
// we would want to query before every single JMAP request. On the other hand, that then also creates
// a risk of going out-of-sync, e.g. if a node is down and the user is reassigned to a different node.
// There might be webhooks to subscribe to in Stalwart to be notified of such situations, in which case
// the Session needs to be removed from the cache.
//
// The Username is only here for convenience, it could just as well be passed as a separate parameter
// instead of being part of the Session, since the username is always part of the request (typically in
// the authentication token payload.)
type Session struct {
	// The name of the user to use to authenticate against Stalwart
	Username string

	// The base URL to use for JMAP operations towards Stalwart
	JmapUrl url.URL
	// An identifier of the JmapUrl to use in metrics and tracing
	JmapEndpoint string

	// The upload URL template
	UploadUrlTemplate string
	// An identifier of the UploadUrlTemplate to use in metrics and tracing
	UploadEndpoint string

	// The upload URL template
	DownloadUrlTemplate string
	// An identifier of the DownloadUrlTemplate to use in metrics and tracing
	DownloadEndpoint string

	WebsocketUrl          *url.URL
	SupportsWebsocketPush bool
	WebsocketEndpoint     string

	SessionResponse
}

var (
	invalidSessionResponseErrorMissingUsername     = SimpleError{code: JmapErrorInvalidSessionResponse, err: errors.New("JMAP session response does not provide a username")}
	invalidSessionResponseErrorMissingApiUrl       = SimpleError{code: JmapErrorInvalidSessionResponse, err: errors.New("JMAP session response does not provide an API URL")}
	invalidSessionResponseErrorInvalidApiUrl       = SimpleError{code: JmapErrorInvalidSessionResponse, err: errors.New("JMAP session response provides an invalid API URL")}
	invalidSessionResponseErrorMissingUploadUrl    = SimpleError{code: JmapErrorInvalidSessionResponse, err: errors.New("JMAP session response does not provide an upload URL")}
	invalidSessionResponseErrorMissingDownloadUrl  = SimpleError{code: JmapErrorInvalidSessionResponse, err: errors.New("JMAP session response does not provide a download URL")}
	invalidSessionResponseErrorInvalidWebsocketUrl = SimpleError{code: JmapErrorInvalidSessionResponse, err: errors.New("JMAP session response provides an invalid Websocket URL")}
)

// Create a new Session from a SessionResponse.
func newSession(sessionResponse SessionResponse) (Session, Error) {
	username := sessionResponse.Username
	if username == "" {
		return Session{}, invalidSessionResponseErrorMissingUsername
	}
	apiStr := sessionResponse.ApiUrl
	if apiStr == "" {
		return Session{}, invalidSessionResponseErrorMissingApiUrl
	}
	apiUrl, err := url.Parse(apiStr)
	if err != nil {
		return Session{}, invalidSessionResponseErrorInvalidApiUrl
	}
	apiEndpoint := endpointOf(apiUrl)

	uploadUrl := sessionResponse.UploadUrl
	if uploadUrl == "" {
		return Session{}, invalidSessionResponseErrorMissingUploadUrl
	}
	uploadEndpoint := toEndpoint(uploadUrl)

	downloadUrl := sessionResponse.DownloadUrl
	if downloadUrl == "" {
		return Session{}, invalidSessionResponseErrorMissingDownloadUrl
	}
	downloadEndpoint := toEndpoint(downloadUrl)

	var websocketUrl *url.URL = nil
	websocketEndpoint := ""
	supportsWebsocketPush := false
	websocketUrlStr := sessionResponse.Capabilities.Websocket.Url
	if websocketUrlStr != "" {
		websocketUrl, err = url.Parse(websocketUrlStr)
		if err != nil {
			return Session{}, invalidSessionResponseErrorInvalidWebsocketUrl
		}
		supportsWebsocketPush = sessionResponse.Capabilities.Websocket.SupportsPush
		websocketEndpoint = endpointOf(websocketUrl)
	}

	return Session{
		Username:              username,
		JmapUrl:               *apiUrl,
		JmapEndpoint:          apiEndpoint,
		UploadUrlTemplate:     uploadUrl,
		UploadEndpoint:        uploadEndpoint,
		DownloadUrlTemplate:   downloadUrl,
		DownloadEndpoint:      downloadEndpoint,
		WebsocketUrl:          websocketUrl,
		SupportsWebsocketPush: supportsWebsocketPush,
		WebsocketEndpoint:     websocketEndpoint,
		SessionResponse:       sessionResponse,
	}, nil
}

func endpointOf(u *url.URL) string {
	if u != nil {
		return fmt.Sprintf("%s://%s", u.Scheme, u.Host)
	} else {
		return ""
	}
}

func toEndpoint(str string) string {
	u, err := url.Parse(str)
	if err == nil {
		return endpointOf(u)
	} else {
		return str
	}
}