From 6f54718756f959eba25cff640503cfbf9871dcdf Mon Sep 17 00:00:00 2001 From: Torsten Grote Date: Wed, 3 Oct 2018 13:44:25 -0300 Subject: [PATCH] Use short type labels in JSON API instead of long Java-like namespaces --- briar-headless/README.md | 6 +++--- .../briar/headless/messaging/MessagingControllerImpl.kt | 5 ++--- .../briar/headless/messaging/OutputPrivateMessage.kt | 4 ++-- .../briar/headless/messaging/OutputPrivateRequest.kt | 8 ++++---- .../briar/headless/messaging/OutputPrivateResponse.kt | 8 ++++---- .../briar/headless/event/WebSocketControllerTest.kt | 2 +- .../headless/messaging/MessagingControllerImplTest.kt | 9 +++------ 7 files changed, 19 insertions(+), 23 deletions(-) diff --git a/briar-headless/README.md b/briar-headless/README.md index 733eb40be..ca704a1a7 100644 --- a/briar-headless/README.md +++ b/briar-headless/README.md @@ -89,7 +89,7 @@ It returns a JSON array of private messages: "seen": true, "sent": true, "timestamp": 1537376633850, - "type": "org.briarproject.briar.api.messaging.PrivateMessageHeader" + "type": "PrivateMessage" } ``` @@ -172,9 +172,9 @@ it will send a JSON object to connected websocket clients: "seen": false, "sent": false, "timestamp": 1537389146088, - "type": "org.briarproject.briar.api.messaging.PrivateMessageHeader" + "type": "PrivateMessage" }, - "name": "org.briarproject.briar.api.messaging.event.PrivateMessageReceivedEvent", + "name": "PrivateMessageReceivedEvent", "type": "event" } ``` diff --git a/briar-headless/src/main/java/org/briarproject/briar/headless/messaging/MessagingControllerImpl.kt b/briar-headless/src/main/java/org/briarproject/briar/headless/messaging/MessagingControllerImpl.kt index 1112f3d1f..0d9c546df 100644 --- a/briar-headless/src/main/java/org/briarproject/briar/headless/messaging/MessagingControllerImpl.kt +++ b/briar-headless/src/main/java/org/briarproject/briar/headless/messaging/MessagingControllerImpl.kt @@ -31,8 +31,7 @@ import javax.annotation.concurrent.Immutable import javax.inject.Inject import javax.inject.Singleton -internal const val EVENT_PRIVATE_MESSAGE = - "org.briarproject.briar.api.messaging.event.PrivateMessageReceivedEvent" +internal const val EVENT_PRIVATE_MESSAGE = "PrivateMessageReceivedEvent" @Immutable @Singleton @@ -121,4 +120,4 @@ private class JsonVisitor( override fun visitIntroductionRequest(r: IntroductionRequest) = r.output(contactId) override fun visitIntroductionResponse(r: IntroductionResponse) = r.output(contactId) -} \ No newline at end of file +} diff --git a/briar-headless/src/main/java/org/briarproject/briar/headless/messaging/OutputPrivateMessage.kt b/briar-headless/src/main/java/org/briarproject/briar/headless/messaging/OutputPrivateMessage.kt index 3401afb83..049cb1f3b 100644 --- a/briar-headless/src/main/java/org/briarproject/briar/headless/messaging/OutputPrivateMessage.kt +++ b/briar-headless/src/main/java/org/briarproject/briar/headless/messaging/OutputPrivateMessage.kt @@ -6,7 +6,7 @@ import org.briarproject.briar.api.messaging.PrivateMessageHeader import org.briarproject.briar.headless.json.JsonDict internal fun PrivateMessageHeader.output(contactId: ContactId, body: String?) = JsonDict( - "type" to "org.briarproject.briar.api.messaging.PrivateMessageHeader", + "type" to "PrivateMessage", "contactId" to contactId.int, "timestamp" to timestamp, "read" to isRead, @@ -19,7 +19,7 @@ internal fun PrivateMessageHeader.output(contactId: ContactId, body: String?) = ) internal fun PrivateMessage.output(contactId: ContactId, body: String) = JsonDict( - "type" to "org.briarproject.briar.api.messaging.PrivateMessageHeader", + "type" to "PrivateMessage", "contactId" to contactId.int, "timestamp" to message.timestamp, "read" to true, diff --git a/briar-headless/src/main/java/org/briarproject/briar/headless/messaging/OutputPrivateRequest.kt b/briar-headless/src/main/java/org/briarproject/briar/headless/messaging/OutputPrivateRequest.kt index 92693a2ca..4dbd8dce0 100644 --- a/briar-headless/src/main/java/org/briarproject/briar/headless/messaging/OutputPrivateRequest.kt +++ b/briar-headless/src/main/java/org/briarproject/briar/headless/messaging/OutputPrivateRequest.kt @@ -23,7 +23,7 @@ internal fun PrivateRequest<*>.output(contactId: ContactId): JsonDict { internal fun IntroductionRequest.output(contactId: ContactId): JsonDict { val dict = (this as PrivateRequest<*>).output(contactId) dict.putAll( - "type" to "org.briarproject.briar.api.introduction.IntroductionRequest", + "type" to "IntroductionRequest", "alreadyContact" to isContact ) return dict @@ -37,18 +37,18 @@ internal fun InvitationRequest<*>.output(contactId: ContactId): JsonDict { internal fun BlogInvitationRequest.output(contactId: ContactId): JsonDict { val dict = (this as InvitationRequest<*>).output(contactId) - dict["type"] = "org.briarproject.briar.api.blog.BlogInvitationRequest" + dict["type"] = "BlogInvitationRequest" return dict } internal fun ForumInvitationRequest.output(contactId: ContactId): JsonDict { val dict = (this as InvitationRequest<*>).output(contactId) - dict["type"] = "org.briarproject.briar.api.forum.ForumInvitationRequest" + dict["type"] = "ForumInvitationRequest" return dict } internal fun GroupInvitationRequest.output(contactId: ContactId): JsonDict { val dict = (this as InvitationRequest<*>).output(contactId) - dict["type"] = "org.briarproject.briar.api.privategroup.invitation.GroupInvitationRequest" + dict["type"] = "GroupInvitationRequest" return dict } diff --git a/briar-headless/src/main/java/org/briarproject/briar/headless/messaging/OutputPrivateResponse.kt b/briar-headless/src/main/java/org/briarproject/briar/headless/messaging/OutputPrivateResponse.kt index d50413a50..f4d99516c 100644 --- a/briar-headless/src/main/java/org/briarproject/briar/headless/messaging/OutputPrivateResponse.kt +++ b/briar-headless/src/main/java/org/briarproject/briar/headless/messaging/OutputPrivateResponse.kt @@ -23,7 +23,7 @@ internal fun PrivateResponse.output(contactId: ContactId): JsonDict { internal fun IntroductionResponse.output(contactId: ContactId): JsonDict { val dict = (this as PrivateResponse).output(contactId) dict.putAll( - "type" to "org.briarproject.briar.api.introduction.IntroductionResponse", + "type" to "IntroductionResponse", "introducedAuthor" to introducedAuthor.output(), "introducer" to isIntroducer ) @@ -38,18 +38,18 @@ internal fun InvitationResponse.output(contactId: ContactId): JsonDict { internal fun BlogInvitationResponse.output(contactId: ContactId): JsonDict { val dict = (this as InvitationResponse).output(contactId) - dict["type"] = "org.briarproject.briar.api.blog.BlogInvitationResponse" + dict["type"] = "BlogInvitationResponse" return dict } internal fun ForumInvitationResponse.output(contactId: ContactId): JsonDict { val dict = (this as InvitationResponse).output(contactId) - dict["type"] = "org.briarproject.briar.api.blog.BlogInvitationResponse" + dict["type"] = "BlogInvitationResponse" return dict } internal fun GroupInvitationResponse.output(contactId: ContactId): JsonDict { val dict = (this as InvitationResponse).output(contactId) - dict["type"] = "org.briarproject.briar.api.privategroup.invitation.GroupInvitationResponse" + dict["type"] = "GroupInvitationResponse" return dict } diff --git a/briar-headless/src/test/java/org/briarproject/briar/headless/event/WebSocketControllerTest.kt b/briar-headless/src/test/java/org/briarproject/briar/headless/event/WebSocketControllerTest.kt index 3cbe0d6b4..53f7e5eb9 100644 --- a/briar-headless/src/test/java/org/briarproject/briar/headless/event/WebSocketControllerTest.kt +++ b/briar-headless/src/test/java/org/briarproject/briar/headless/event/WebSocketControllerTest.kt @@ -65,7 +65,7 @@ internal class WebSocketControllerTest : ControllerTest() { val json = """ { "type": "event", - "name": "org.briarproject.briar.api.messaging.event.PrivateMessageReceivedEvent", + "name": "PrivateMessageReceivedEvent", "data": ${toJson(header.output(contact.id, body))} } """ diff --git a/briar-headless/src/test/java/org/briarproject/briar/headless/messaging/MessagingControllerImplTest.kt b/briar-headless/src/test/java/org/briarproject/briar/headless/messaging/MessagingControllerImplTest.kt index 5f05d9e82..7ead89482 100644 --- a/briar-headless/src/test/java/org/briarproject/briar/headless/messaging/MessagingControllerImplTest.kt +++ b/briar-headless/src/test/java/org/briarproject/briar/headless/messaging/MessagingControllerImplTest.kt @@ -115,10 +115,7 @@ internal class MessagingControllerImplTest : ControllerTest() { assertEquals(contact.id.int, output["contactId"]) assertEquals(body, output["body"]) assertEquals(message.id.bytes, output["id"]) - assertEquals( - "org.briarproject.briar.api.messaging.PrivateMessageHeader", - output["type"] - ) + assertEquals("PrivateMessage", output["type"]) } @Test @@ -170,7 +167,7 @@ internal class MessagingControllerImplTest : ControllerTest() { val json = """ { "body": "$body", - "type": "org.briarproject.briar.api.messaging.PrivateMessageHeader", + "type": "PrivateMessage", "timestamp": $timestamp, "groupId": ${toJson(header.groupId.bytes)}, "contactId": ${contact.id.int}, @@ -193,7 +190,7 @@ internal class MessagingControllerImplTest : ControllerTest() { val json = """ { "body": null, - "type": "org.briarproject.briar.api.introduction.IntroductionRequest", + "type": "IntroductionRequest", "timestamp": $timestamp, "groupId": ${toJson(request.groupId.bytes)}, "contactId": ${contact.id.int},