Refactor to have the widget layout type be a jsonb and JsValue

maproulette · Oct 14, 2023 · 2ab35a0 · 2ab35a0
1 parent d10f57a
commit 2ab35a0
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 15 deletions.
diff --git a/app/org/maproulette/framework/graphql/schemas/MRSchemaTypes.scala b/app/org/maproulette/framework/graphql/schemas/MRSchemaTypes.scala
@@ -170,7 +170,13 @@ trait MRSchemaTypes {
   implicit val ChallengePriorityType: ObjectType[Unit, ChallengePriority] =
     deriveObjectType[Unit, ChallengePriority](ObjectTypeName("ChallengePriority"))
   implicit val ChallengeExtraType: ObjectType[Unit, ChallengeExtra] =
-    deriveObjectType[Unit, ChallengeExtra](ObjectTypeName("ChallengeExtra"))
+    deriveObjectType[Unit, ChallengeExtra](
+      ObjectTypeName("ChallengeExtra"),
+      ReplaceField(
+        "widgetLayout",
+        Field("widgetLayout", StringType, resolve = _.value.widgetLayout.getOrElse("").toString)
+      )
+    )
   // Comment Types
   implicit val CommentType: ObjectType[Unit, Comment] =
     deriveObjectType[Unit, Comment](ObjectTypeName("Comment"))

diff --git a/app/org/maproulette/framework/model/Challenge.scala b/app/org/maproulette/framework/model/Challenge.scala
@@ -135,7 +135,7 @@ case class ChallengeExtra(
     taskBundleIdProperty: Option[String] = None,
     isArchived: Boolean = false,
     reviewSetting: Int = Challenge.REVIEW_SETTING_NOT_REQUIRED,
-    widgetLayout: Option[String] = None,
+    widgetLayout: Option[JsValue] = None,
     systemArchivedAt: Option[DateTime] = None,
     presets: Option[List[String]] = None
 ) extends DefaultWrites

diff --git a/app/org/maproulette/framework/repository/ChallengeRepository.scala b/app/org/maproulette/framework/repository/ChallengeRepository.scala
@@ -8,14 +8,15 @@ package org.maproulette.framework.repository
 import java.sql.Connection
 import anorm.SqlParser._
 import anorm.{RowParser, SQL, ~}
-
+import anorm.postgresql.jsValueColumn
 import javax.inject.{Inject, Singleton}
 import org.apache.commons.lang3.StringUtils
 import org.joda.time.DateTime
 import org.maproulette.framework.model._
 import org.maproulette.framework.psql.{GroupField, Grouping, OR, Query}
 import org.maproulette.framework.psql.filter._
 import play.api.db.Database
+import play.api.libs.json.JsValue
 
 /**
   * The challenge repository handles all the querying with the databases related to challenge objects
@@ -262,7 +263,7 @@ object ChallengeRepository {
       get[Option[List[Long]]]("virtual_parent_ids") ~
       get[Boolean]("challenges.is_archived") ~
       get[Int]("challenges.review_setting") ~
-      get[Option[String]]("challenges.widget_layout") ~
+      get[Option[JsValue]]("challenges.widget_layout") ~
       get[Option[DateTime]]("challenges.system_archived_at") map {
       case id ~ name ~ created ~ modified ~ description ~ infoLink ~ ownerId ~ parentId ~ instruction ~
             difficulty ~ blurb ~ enabled ~ featured ~ cooperativeType ~ popularity ~ checkin_comment ~
@@ -283,6 +284,7 @@ object ChallengeRepository {
           case Some(c) if StringUtils.isEmpty(c) || StringUtils.equals(c, "{}") => None
           case r                                                                => r
         }
+
         new Challenge(
           id,
           name,

diff --git a/app/org/maproulette/models/dal/ChallengeDAL.scala b/app/org/maproulette/models/dal/ChallengeDAL.scala
@@ -5,9 +5,10 @@
 package org.maproulette.models.dal
 
 import java.sql.Connection
-
 import anorm.SqlParser._
 import anorm._
+import anorm.postgresql.{asJson, jsValueColumn}
+
 import javax.inject.{Inject, Singleton}
 import org.apache.commons.lang3.StringUtils
 import org.joda.time.DateTime
@@ -17,9 +18,9 @@ import org.maproulette.data.{Actions, ChallengeType, ProjectType}
 import org.maproulette.exception.{InvalidException, NotFoundException, UniqueViolationException}
 import org.maproulette.framework.model._
 import org.maproulette.framework.repository.{
+  ChallengeListingRepository,
   ProjectRepository,
-  TaskRepository,
-  ChallengeListingRepository
+  TaskRepository
 }
 import org.maproulette.framework.service.{ServiceManager, TagService}
 import org.maproulette.models.dal.mixin.{OwnerMixin, TagDALMixin}
@@ -121,7 +122,7 @@ class ChallengeDAL @Inject() (
       get[Boolean]("deleted") ~
       get[Boolean]("challenges.is_archived") ~
       get[Int]("challenges.review_setting") ~
-      get[Option[String]]("challenges.widget_layout") ~
+      get[Option[JsValue]]("challenges.widget_layout") ~
       get[Option[Int]]("challenges.completion_percentage") ~
       get[Option[Int]]("challenges.tasks_remaining") map {
       case id ~ name ~ created ~ modified ~ description ~ infoLink ~ ownerId ~ parentId ~ instruction ~
@@ -144,6 +145,7 @@ class ChallengeDAL @Inject() (
           case Some(c) if StringUtils.isEmpty(c) || StringUtils.equals(c, "{}") => None
           case r                                                                => r
         }
+
         new Challenge(
           id,
           name,
@@ -257,7 +259,7 @@ class ChallengeDAL @Inject() (
       get[Option[List[String]]]("presets") ~
       get[Boolean]("challenges.is_archived") ~
       get[Int]("challenges.review_setting") ~
-      get[Option[String]]("challenges.widget_layout") ~
+      get[Option[JsValue]]("challenges.widget_layout") ~
       get[Option[DateTime]]("challenges.system_archived_at") ~
       get[Option[Int]]("challenges.completion_percentage") ~
       get[Option[Int]]("challenges.tasks_remaining") map {
@@ -282,6 +284,7 @@ class ChallengeDAL @Inject() (
           case Some(c) if StringUtils.isEmpty(c) || StringUtils.equals(c, "{}") => None
           case r                                                                => r
         }
+
         new Challenge(
           id,
           name,
@@ -492,7 +495,8 @@ class ChallengeDAL @Inject() (
                       ${challenge.dataOriginDate.getOrElse(DateTime.now()).toString}::timestamptz,
                       ${challenge.extra.preferredTags}, ${challenge.extra.preferredReviewTags}, ${challenge.extra.limitTags},
                       ${challenge.extra.limitReviewTags}, ${challenge.extra.taskStyles}, ${challenge.general.requiresLocal}, ${challenge.extra.isArchived},
-                      ${challenge.extra.reviewSetting}, ${challenge.extra.widgetLayout})
+                      ${challenge.extra.reviewSetting},
+                      ${asJson(challenge.extra.widgetLayout.getOrElse(Json.parse("{}")))}
                       ON CONFLICT(parent_id, LOWER(name)) DO NOTHING RETURNING #${this.retrieveColumns}"""
             .as(this.parser.*)
             .headOption
@@ -680,8 +684,8 @@ class ChallengeDAL @Inject() (
             .getOrElse(cachedItem.extra.reviewSetting)
 
           val widgetLayout = (updates \ "widgetLayout")
-            .asOpt[String]
-            .getOrElse(cachedItem.extra.widgetLayout.getOrElse(""))
+            .asOpt[JsValue]
+            .getOrElse(cachedItem.extra.widgetLayout.getOrElse(Json.parse("{}")))
 
           val presets: List[String] = (updates \ "presets")
             .asOpt[List[String]]
@@ -712,7 +716,9 @@ class ChallengeDAL @Inject() (
                   custom_basemap = $customBasemap, updatetasks = $updateTasks, exportable_properties = $exportableProperties,
                   osm_id_property = $osmIdProperty, task_bundle_id_property = $taskBundleIdProperty, preferred_tags = $preferredTags, preferred_review_tags = $preferredReviewTags,
                   limit_tags = $limitTags, limit_review_tags = $limitReviewTags, task_styles = $taskStyles,
-                  requires_local = $requiresLocal, is_archived = $isArchived, review_setting = $reviewSetting, widget_layout = $widgetLayout
+                  requires_local = $requiresLocal, is_archived = $isArchived, review_setting = $reviewSetting, widget_layout = ${asJson(
+              widgetLayout
+            )}
                 WHERE id = $id RETURNING #${this.retrieveColumns}""".as(parser.*).headOption
 
           updatedChallenge match {

diff --git a/conf/evolutions/default/93.sql b/conf/evolutions/default/93.sql
@@ -1,7 +1,7 @@
 -- --- !Ups
 ALTER TABLE IF EXISTS challenges
-ADD COLUMN widget_layout text DEFAULT '';
+ADD COLUMN widget_layout jsonb NOT NULL DEFAULT '{}'::jsonb;
 
 -- --- !Downs
 ALTER TABLE IF EXISTS challenges
-DROP COLUMN widget_layout;
+DROP COLUMN widget_layout;