Skip to content

JAMES-3950 Fix reading jmap.properties disabled.capabilities parsing #2407

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Arsnael merged 1 commit into from
Sep 13, 2024
Merged

JAMES-3950 Fix reading jmap.properties disabled.capabilities parsing #2407

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 99 additions & 0 deletions ...on/src/main/scala/org/apache/james/jmap/rfc8621/contract/DisabledCapabilityContract.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,96 @@ import org.apache.james.jmap.core.ResponseObject.SESSION_STATE
import org.apache.james.jmap.core.{CapabilityIdentifier, JmapRfc8621Configuration}
import org.apache.james.jmap.http.UserCredential
import org.apache.james.jmap.rfc8621.contract.Fixture._
import org.apache.james.jmap.rfc8621.contract.SessionRoutesContract.expected_session_object
import org.apache.james.utils.DataProbeImpl
import org.junit.jupiter.api.{BeforeEach, Test}

object DisabledCapabilityContract {
val configuration: JmapRfc8621Configuration = JmapRfc8621Configuration(urlPrefixString = "http://127.0.0.1",
websocketPrefixString = "ws://127.0.0.1",
disabledCapabilities = Set(CapabilityIdentifier.JMAP_MAIL))
val expected_session_object: String =
"""{
| "capabilities" : {
| "urn:ietf:params:jmap:submission": {
| "maxDelayedSend": 0,
| "submissionExtensions": {}
| },
| "urn:ietf:params:jmap:core" : {
| "maxSizeUpload" : 31457280,
| "maxConcurrentUpload" : 4,
| "maxSizeRequest" : 10000000,
| "maxConcurrentRequests" : 4,
| "maxCallsInRequest" : 16,
| "maxObjectsInGet" : 500,
| "maxObjectsInSet" : 500,
| "collationAlgorithms" : [ "i;unicode-casemap" ]
| },
| "urn:ietf:params:jmap:websocket": {
| "supportsPush": true,
| "url": "ws://127.0.0.1/jmap/ws"
| },
| "urn:apache:james:params:jmap:mail:quota": {},
| "urn:ietf:params:jmap:quota": {},
| "urn:apache:james:params:jmap:mail:identity:sortorder": {},
| "urn:apache:james:params:jmap:delegation": {},
| "urn:apache:james:params:jmap:mail:shares": {},
| "urn:ietf:params:jmap:vacationresponse":{},
| "urn:ietf:params:jmap:mdn":{}
| },
| "accounts" : {
| "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6" : {
| "name" : "bob@domain.tld",
| "isPersonal" : true,
| "isReadOnly" : false,
| "accountCapabilities" : {
| "urn:ietf:params:jmap:submission": {
| "maxDelayedSend": 0,
| "submissionExtensions": {}
| },
| "urn:ietf:params:jmap:websocket": {
| "supportsPush": true,
| "url": "ws://127.0.0.1/jmap/ws"
| },
| "urn:ietf:params:jmap:core" : {
| "maxSizeUpload" : 31457280,
| "maxConcurrentUpload" : 4,
| "maxSizeRequest" : 10000000,
| "maxConcurrentRequests" : 4,
| "maxCallsInRequest" : 16,
| "maxObjectsInGet" : 500,
| "maxObjectsInSet" : 500,
| "collationAlgorithms" : [ "i;unicode-casemap" ]
| },
| "urn:apache:james:params:jmap:mail:quota": {},
| "urn:ietf:params:jmap:quota": {},
| "urn:apache:james:params:jmap:mail:identity:sortorder": {},
| "urn:apache:james:params:jmap:delegation": {},
| "urn:apache:james:params:jmap:mail:shares": {},
| "urn:ietf:params:jmap:vacationresponse":{},
| "urn:ietf:params:jmap:mdn":{}
| }
| }
| },
| "primaryAccounts" : {
| "urn:ietf:params:jmap:submission": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6",
| "urn:ietf:params:jmap:websocket": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6",
| "urn:ietf:params:jmap:core" : "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6",
| "urn:apache:james:params:jmap:mail:quota": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6",
| "urn:ietf:params:jmap:quota": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6",
| "urn:apache:james:params:jmap:mail:identity:sortorder": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6",
| "urn:apache:james:params:jmap:delegation": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6",
| "urn:apache:james:params:jmap:mail:shares": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6",
| "urn:ietf:params:jmap:vacationresponse": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6",
| "urn:ietf:params:jmap:mdn": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6"
| },
| "username" : "bob@domain.tld",
| "apiUrl" : "http://127.0.0.1/jmap",
| "downloadUrl" : "http://127.0.0.1/download/{accountId}/{blobId}?type={type}&name={name}",
| "uploadUrl" : "http://127.0.0.1/upload/{accountId}",
| "eventSourceUrl" : "http://127.0.0.1/eventSource?types={types}&closeAfter={closeafter}&ping={ping}",
| "state" : "2c9f1b12-b35a-43e6-9af2-0106fb53a943"
|}""".stripMargin
}

trait DisabledCapabilityContract {
Expand Down Expand Up @@ -92,4 +175,20 @@ trait DisabledCapabilityContract {
| "c1"]]
|}""".stripMargin)
}

@Test
def getShouldReturnCorrectSession(): Unit = {
val sessionJson: String = `given`()
.when()
.header(ACCEPT.toString, ACCEPT_RFC8621_VERSION_HEADER)
.get("/session")
.`then`
.statusCode(SC_OK)
.contentType(JSON)
.extract()
.body()
.asString()

assertThatJson(sessionJson).isEqualTo(DisabledCapabilityContract.expected_session_object)
}
}
9 changes: 5 additions & 4 deletions ...protocols/jmap-rfc-8621/src/main/scala/org/apache/james/jmap/routes/SessionSupplier.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,14 @@ import cats.instances.list._
import jakarta.inject.Inject
import org.apache.james.core.Username
import org.apache.james.jmap.core.CapabilityIdentifier.CapabilityIdentifier
import org.apache.james.jmap.core.{Account, AccountId, Capabilities, Capability, CapabilityFactory, IsPersonal, IsReadOnly, Session, URL, UrlPrefixes}
import org.apache.james.jmap.core.{Account, AccountId, Capabilities, Capability, CapabilityFactory, IsPersonal, IsReadOnly, JmapRfc8621Configuration, Session, URL, UrlPrefixes}

import scala.jdk.CollectionConverters._

class SessionSupplier(capabilityFactories: Set[CapabilityFactory]) {
class SessionSupplier(capabilityFactories: Set[CapabilityFactory], configuration: JmapRfc8621Configuration) {
@Inject
def this(defaultCapabilities: java.util.Set[CapabilityFactory]) = {
this(defaultCapabilities.asScala.toSet)
def this(defaultCapabilities: java.util.Set[CapabilityFactory], configuration: JmapRfc8621Configuration) = {
this(defaultCapabilities.asScala.toSet, configuration)
}

def validate(username: Username, accountId: AccountId): Boolean = AccountId.from(username)
Expand All @@ -44,6 +44,7 @@ class SessionSupplier(capabilityFactories: Set[CapabilityFactory]) {
val urlEndpointResolver: JmapUrlEndpointResolver = new JmapUrlEndpointResolver(urlPrefixes)
val capabilities: Set[Capability] = capabilityFactories
.map(cf => cf.create(urlPrefixes))
.filter(capability => !configuration.disabledCapabilities.contains(capability.identifier()))

for {
account <- accounts(username, capabilities)
Expand Down
2 changes: 1 addition & 1 deletion ...otocols/jmap-rfc-8621/src/test/scala/org/apache/james/jmap/routes/SessionRoutesTest.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ class SessionRoutesTest extends AnyFlatSpec with BeforeAndAfter with Matchers {
.thenReturn(Mono.empty())

val sessionRoutes = new SessionRoutes(
sessionSupplier = new SessionSupplier(DefaultCapabilities.supported(JmapRfc8621Configuration.LOCALHOST_CONFIGURATION)),
sessionSupplier = new SessionSupplier(DefaultCapabilities.supported(JmapRfc8621Configuration.LOCALHOST_CONFIGURATION), JmapRfc8621Configuration.LOCALHOST_CONFIGURATION),
delegationStore = mockDelegationStore,
authenticator = mockedAuthFilter,
jmapRfc8621Configuration = JmapRfc8621Configuration.LOCALHOST_CONFIGURATION)
Expand Down
4 changes: 2 additions & 2 deletions ...ocols/jmap-rfc-8621/src/test/scala/org/apache/james/jmap/routes/SessionSupplierTest.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ class SessionSupplierTest extends AnyWordSpec with Matchers {

"generate" should {
"return correct username" in {
new SessionSupplier(DefaultCapabilities.supported(JmapRfc8621Configuration.LOCALHOST_CONFIGURATION))
new SessionSupplier(DefaultCapabilities.supported(JmapRfc8621Configuration.LOCALHOST_CONFIGURATION), JmapRfc8621Configuration.LOCALHOST_CONFIGURATION)
.generate(USERNAME, Set(), JmapRfc8621Configuration.LOCALHOST_CONFIGURATION.urlPrefixes()).toOption.get.username should equal(USERNAME)
}

"return correct account" which {
val accounts = new SessionSupplier(DefaultCapabilities.supported(JmapRfc8621Configuration.LOCALHOST_CONFIGURATION))
val accounts = new SessionSupplier(DefaultCapabilities.supported(JmapRfc8621Configuration.LOCALHOST_CONFIGURATION), JmapRfc8621Configuration.LOCALHOST_CONFIGURATION)
.generate(USERNAME, Set(), JmapRfc8621Configuration.LOCALHOST_CONFIGURATION.urlPrefixes()).toOption.get.accounts

"has size" in {
Expand Down