fix: privacy module requests (#841)

* fix: don't stringify null

* fix: remove identifier, which was mutually exclusive with value

* feat: log error bodies for 4xx requests

* feat: warn user when comment/s contained sensitive data

* test: add test for marking sensitive comments as private

* style: remove trailing comma

Author: jkazimierczak

config/config.yml

@@ -172,6 +172,7 @@ arisa:
 
     privacy:
       message: panel-mark-private
+      commentMessage: panel-mark-private-comment
       commentNote: |-
 
         ----

src/main/kotlin/io/github/mojira/arisa/apiclient/JiraClient.kt

@@ -17,6 +17,7 @@ import io.github.mojira.arisa.apiclient.models.IssueLink
 import io.github.mojira.arisa.apiclient.models.User
 import io.github.mojira.arisa.apiclient.models.Visibility
 import io.github.mojira.arisa.apiclient.requestModels.*
+import io.github.mojira.arisa.log
 import kotlinx.serialization.json.Json
 import okhttp3.MediaType.Companion.toMediaType
 import okhttp3.OkHttpClient
@@ -151,6 +152,7 @@ private inline fun <reified T> Call<T>.executeOrThrow(): T {
 
     if (!response.isSuccessful) {
         if (response.code() in 400..499) {
+            response.errorBody()?.let { log.error(it.string()) }
             throw ClientErrorException(
                 response.code(),
                 "Request failed - [${response.code()}] ${originalRequest.method} ${originalRequest.url}",

src/main/kotlin/io/github/mojira/arisa/infrastructure/config/ArisaConfig.kt

@@ -164,6 +164,10 @@ object Arisa : ConfigSpec() {
             val message by required<String>(
                 description = "The key of the message that is posted when this module succeeds."
             )
+            val commentMessage by required<String>(
+                description = "The key of the message that is posted when this module detects sensitive data within" +
+                    "the comment."
+            )
             val commentNote by optional(
                 "",
                 description = "The text which will be appended at the comments that are restricted by this module."

src/main/kotlin/io/github/mojira/arisa/infrastructure/jira/Functions.kt

@@ -437,9 +437,8 @@ fun restrictCommentToGroup(
                     val payload = UpdateCommentBody(
                         body,
                         visibility = Visibility(
-                            identifier = group,
-                            type = Visibility.Type.Group.value,
-                            value = group
+                            value = group,
+                            type = Visibility.Type.Group.value
                         )
                     )
                     context.value.jiraClient.updateComment(

src/main/kotlin/io/github/mojira/arisa/infrastructure/jira/Mappers.kt

@@ -232,7 +232,7 @@ fun MojiraComment.toDomain(
         getUpdateAuthorGroups = { if (updateAuthor == null) emptyList() else getGroups(jiraClient, updateAuthor.accountId).fold({ null }, { it }) },
         created = created!!.toInstant(),
         updated = updated!!.toInstant(),
-        visibilityType = visibility?.type.toString(),
+        visibilityType = visibility?.type,
         visibilityValue = visibility?.value,
         restrict = ::restrictCommentToGroup.partially1(context).partially1(this).partially1("staff"),
         update = ::updateCommentBody.partially1(context).partially1(this),

src/main/kotlin/io/github/mojira/arisa/modules/privacy/PrivacyModule.kt

@@ -24,6 +24,7 @@ private val log = LoggerFactory.getLogger("PrivacyModule")
 
 class PrivacyModule(
     private val message: String,
+    private val commentMessage: String,
     private val commentNote: String,
     private val allowedEmailRegexes: List<Regex>,
     private val sensitiveTextRegexes: List<Regex>,
@@ -58,6 +59,9 @@ class PrivacyModule(
             }
 
             restrictCommentActions.forEach { it.invoke() }
+            if (restrictCommentActions.isNotEmpty()) {
+                addComment(CommentOptions(commentMessage))
+            }
         }
     }
 

src/main/kotlin/io/github/mojira/arisa/registry/InstantModuleRegistry.kt

@@ -28,6 +28,7 @@ class InstantModuleRegistry(config: Config) : ModuleRegistry<CloudIssue>(config)
             Arisa.Modules.Privacy,
             PrivacyModule(
                 config[Arisa.Modules.Privacy.message],
+                config[Arisa.Modules.Privacy.commentMessage],
                 config[Arisa.Modules.Privacy.commentNote],
                 config[Arisa.Modules.Privacy.allowedEmailRegexes].map(String::toRegex),
                 config[Arisa.Modules.Privacy.sensitiveTextRegexes].map(String::toRegex),

src/test/kotlin/io/github/mojira/arisa/modules/privacy/PrivacyModuleTest.kt

@@ -20,6 +20,7 @@ private val TWO_SECONDS_AGO = RIGHT_NOW.minusSeconds(2)
 private val TEN_SECONDS_AGO = RIGHT_NOW.minusSeconds(10)
 
 private const val MADE_PRIVATE_MESSAGE = "made-private"
+private const val MADE_PRIVATE_COMMENTS_MESSAGE = "made-private-comments"
 private const val COMMENT_NOTE = "\n----\nRestricted by PrivacyModule ??[~arisabot]??"
 
 private val NOOP_REDACTOR = object : AttachmentRedactor {
@@ -30,13 +31,15 @@ private val NOOP_REDACTOR = object : AttachmentRedactor {
 
 private fun createModule(
     message: String = MADE_PRIVATE_MESSAGE,
+    commentMessage: String = MADE_PRIVATE_COMMENTS_MESSAGE,
     commentNote: String = COMMENT_NOTE,
     allowedEmailRegexes: List<Regex> = emptyList(),
     sensitiveTextRegexes: List<Regex> = emptyList(),
     attachmentRedactor: AttachmentRedactor = NOOP_REDACTOR,
     sensitiveFileNameRegexes: List<Regex> = emptyList()
 ) = PrivacyModule(
     message,
+    commentMessage,
     commentNote,
     allowedEmailRegexes,
     sensitiveTextRegexes,
@@ -320,6 +323,7 @@ class PrivacyModuleTest : FunSpec({
                 test("should restrict to staff when the comment contains sensitive data") {
                     var hasSetPrivate = false
                     var hasRestrictedComment = false
+                    var addedComment: CommentOptions? = null
 
                     val issue = mockCloudIssue(
                         comments = listOf(
@@ -331,14 +335,16 @@ class PrivacyModuleTest : FunSpec({
                                 }
                             )
                         ),
-                        setPrivate = { hasSetPrivate = true }
+                        setPrivate = { hasSetPrivate = true },
+                        addComment = { addedComment = it }
                     )
 
                     val result = testData.module(issue, TWO_SECONDS_AGO)
 
                     result.shouldBeRight(ModuleResponse)
                     hasSetPrivate shouldBe false
                     hasRestrictedComment shouldBe true
+                    addedComment shouldBe CommentOptions(MADE_PRIVATE_COMMENTS_MESSAGE)
                 }
             }
         }