Merge pull request #87 from toolsplus/feature/support-host-record-deletion

Add TTL host column

Author: tbinna

.scalafmt.conf

@@ -1,3 +1,3 @@
-style = default
-maxColumn = 80
+version = 3.9.9
+runner.dialect = scala213
 project.git = true

build.sbt

@@ -1,8 +1,9 @@
-import ReleaseTransformations._
+import ReleaseTransformations.*
+import xerial.sbt.Sonatype.sonatypeCentralHost
 
 val commonSettings = Seq(
   organization := "io.toolsplus",
-  scalaVersion := "2.13.14",
+  scalaVersion := "2.13.16",
   versionScheme := Some("early-semver"),
   resolvers ++= Seq(
     Resolver.typesafeRepo("releases"),
@@ -18,19 +19,14 @@ lazy val publishSettings = Seq(
   releasePublishArtifactsAction := PgpKeys.publishSigned.value,
   homepage := Some(url("https://github.com/toolsplus/atlassian-connect-play")),
   licenses := Seq(
-    "Apache 2.0" -> url("http://www.apache.org/licenses/LICENSE-2.0")),
+    "Apache 2.0" -> url("https://www.apache.org/licenses/LICENSE-2.0")),
   publishMavenStyle := true,
   Test / publishArtifact := false,
   pomIncludeRepository := { _ =>
     false
   },
-  publishTo := {
-    val nexus = "https://oss.sonatype.org/"
-    if (isSnapshot.value)
-      Some("snapshots" at nexus + "content/repositories/snapshots")
-    else
-      Some("releases" at nexus + "service/local/staging/deploy/maven2")
-  },
+  ThisBuild / publishTo := sonatypePublishToBundle.value,
+  ThisBuild / sonatypeCredentialHost := sonatypeCentralHost,
   autoAPIMappings := true,
   scmInfo := Some(
     ScmInfo(
@@ -47,6 +43,7 @@ lazy val publishSettings = Seq(
 )
 
 lazy val noPublishSettings = Seq(
+  publish / skip := true,
   publish := {},
   publishLocal := {},
   publishArtifact := false,
@@ -63,9 +60,9 @@ releaseProcess := Seq[ReleaseStep](
   commitReleaseVersion,
   tagRelease,
   releaseStepCommand("publishSigned"),
+  releaseStepCommand("sonatypeBundleRelease"),
   setNextVersion,
   commitNextVersion,
-  releaseStepCommand("sonatypeReleaseAll"),
   pushChanges
 )
 
@@ -82,12 +79,12 @@ lazy val `atlassian-connect-play` = project
     `atlassian-connect-play-api`,
     `atlassian-connect-play-core`
   )
-  .settings(commonSettings: _*)
+  .settings(commonSettings)
   .settings(noPublishSettings)
 
 lazy val `atlassian-connect-play-api` = project
   .in(file("modules/api"))
-  .settings(commonSettings: _*)
+  .settings(commonSettings)
   .settings(publishSettings)
   .settings(moduleSettings(project))
 
@@ -96,8 +93,8 @@ lazy val `atlassian-connect-play-core` = project
   .enablePlugins(PlayScala)
   .settings(libraryDependencies ++= Dependencies.core)
   .settings(libraryDependencies ++= Seq(ws, guice))
-  .settings(commonSettings: _*)
-  .settings(scoverageSettings: _*)
+  .settings(commonSettings)
+  .settings(scoverageSettings)
   .settings(publishSettings)
   .settings(moduleSettings(project))
   .dependsOn(`atlassian-connect-play-api`)

modules/api/src/main/scala/io/toolsplus/atlassian/connect/play/api/models/AtlassianHost.scala

@@ -2,139 +2,161 @@ package io.toolsplus.atlassian.connect.play.api.models
 
 import io.toolsplus.atlassian.connect.play.api.models.Predefined.ClientKey
 
+import java.time.Instant
+
 /** An Atlassian host in which the app is or has been installed. Hosts are
   * stored in AtlassianHostRepository.
   *
   * During processing of a request from an Atlassian host, the details of the
-  * host and of the user at the browser can be obtained from the [[AtlassianHostUser]].
+  * host and of the user at the browser can be obtained from the
+  * [[AtlassianHostUser]].
   *
-  * @see https://developer.atlassian.com/cloud/jira/platform/connect-app-descriptor/#lifecycle-http-request-payload
+  * @see
+  *   https://developer.atlassian.com/cloud/jira/platform/connect-app-descriptor/#lifecycle-http-request-payload
   */
 trait AtlassianHost {
 
-  /** Identifying key for the Atlassian product
-    * instance that the app was installed into.
+  /** Identifying key for the Atlassian product instance that the app was
+    * installed into.
     *
-    * @return Client key for this product instance.
+    * @return
+    *   Client key for this product instance.
     */
   def clientKey: ClientKey
 
-  /** App key that was installed into the
-    * Atlassian product, as it appears in your
-    * app's descriptor.
+  /** App key that was installed into the Atlassian product, as it appears in
+    * your app's descriptor.
     *
-    * @return App key for this app.
+    * @return
+    *   App key for this app.
     */
   def key: String
 
-  /** OAuth 2.0 client ID for the app used
-    * for OAuth 2.0 - JWT Bearer token
+  /** OAuth 2.0 client ID for the app used for OAuth 2.0 - JWT Bearer token
     * authorization grant type.
     *
-    * @return OAuth 2.0 client id.
+    * @return
+    *   OAuth 2.0 client id.
     */
   def oauthClientId: Option[String]
 
-  /**
-    * Identifier for this host's Forge installation, if the host has migrated to Connect on Forge.
+  /** Identifier for this host's Forge installation, if the host has migrated to
+    * Connect on Forge.
     *
     * This is also the ID that any remote storage should be keyed against.
     *
-    * @return Forge installation id.
+    * @return
+    *   Forge installation id.
     */
   def installationId: Option[String]
 
-  /** Secret to sign outgoing JWT tokens and
-    * validate incoming JWT tokens. Only sent
-    * on the installed event.
+  /** Secret to sign outgoing JWT tokens and validate incoming JWT tokens. Only
+    * sent on the installed event.
     *
-    * @return Shared secret for this product instance.
+    * @return
+    *   Shared secret for this product instance.
     */
   def sharedSecret: String
 
-  /** URL prefix for this Atlassian product
-    * instance.
+  /** URL prefix for this Atlassian product instance.
     *
-    * @return Base URL for this product instance.
+    * @return
+    *   Base URL for this product instance.
     */
   def baseUrl: String
 
-  /**
-    * If the Atlassian product instance has an associated custom domain, this is the URL through which users will
-    * access the product. Any links which an app renders server-side should use this as the prefix of the link.
-    * This ensures links are rendered in the same context as the remainder of the user's site. If a custom domain
-    * is not configured, this field will still be present but will be the same as the baseUrl.
+  /** If the Atlassian product instance has an associated custom domain, this is
+    * the URL through which users will access the product. Any links which an
+    * app renders server-side should use this as the prefix of the link. This
+    * ensures links are rendered in the same context as the remainder of the
+    * user's site. If a custom domain is not configured, this field will still
+    * be present but will be the same as the baseUrl.
     *
     * Note that API requests from your app should always use the baseUrl value.
     *
-    * @return Custom domain URL if configured, app's base URL otherwise.
+    * @return
+    *   Custom domain URL if configured, app's base URL otherwise.
     */
   def displayUrl: String
 
-  /**
-    * If the Atlassian product instance has an associated custom domain for Jira Service Desk functionality, this is
-    * the URL for the Jira Service Desk Help Center. Any related links which an app renders server-side should use this
-    * as the prefix of the link.
-    * This ensures links are rendered in the same context as the user's Jira Service Desk. If a custom domain is not
-    * configured, this field will still be present but will be the same as the baseUrl.
+  /** If the Atlassian product instance has an associated custom domain for Jira
+    * Service Desk functionality, this is the URL for the Jira Service Desk Help
+    * Center. Any related links which an app renders server-side should use this
+    * as the prefix of the link. This ensures links are rendered in the same
+    * context as the user's Jira Service Desk. If a custom domain is not
+    * configured, this field will still be present but will be the same as the
+    * baseUrl.
     *
     * Note that API requests from your App should always use the baseUrl value.
     *
-    * @return Custom domain URL for Jira Service Desk if configured, app's base URL otherwise.
+    * @return
+    *   Custom domain URL for Jira Service Desk if configured, app's base URL
+    *   otherwise.
     */
   def displayUrlServicedeskHelpCenter: String
 
-  /** Identifies the category of Atlassian
-    * product, e.g. jira or confluence.
+  /** Identifies the category of Atlassian product, e.g. jira or confluence.
     *
-    * @return Category of this product.
+    * @return
+    *   Category of this product.
     */
   def productType: String
 
   /** Host product description.
     *
-    * @return Description of this product.
+    * @return
+    *   Description of this product.
     */
   def description: String
 
-  /** Service entitlement number (SEN) is the
-    * app license id. Only included during
-    * installation of a paid app.
+  /** Service entitlement number (SEN) is the app license id. Only included
+    * during installation of a paid app.
     *
-    * @return App license id if this is a paid app.
+    * @return
+    *   App license id if this is a paid app.
     */
   @deprecated("No replacement")
   def serviceEntitlementNumber: Option[String]
 
-  /**
-    * License entitlement ID is the app license ID.
+  /** License entitlement ID is the app license ID.
     *
     * This attribute will only be included during installation of a paid app.
     *
-    * @return App entitlement ID if this is a paid app.
+    * @return
+    *   App entitlement ID if this is a paid app.
     */
   def entitlementId: Option[String]
 
-  /**
-    * License entitlement number is the app license number.
+  /** License entitlement number is the app license number.
     *
     * This attribute will only be included during installation of a paid app.
     *
-    * @return App entitlement number if this is a paid app.
+    * @return
+    *   App entitlement number if this is a paid app.
     */
   def entitlementNumber: Option[String]
 
-  /** Indicates if the app is currently
-    * installed on the host. Upon uninstallation,
-    * the value of this flag will be set to false.
+  /** Indicates if the app is currently installed on the host. Upon
+    * uninstallation, the value of this flag will be set to false.
     *
-    * @return Installation status for this app.
+    * @return
+    *   Installation status for this app.
     */
   def installed: Boolean
 
-  /** Uninstalls this host by setting the installed field to false.
+  /** Time to live for this host record.
+    *
+    * This allows marking a host record for deletion in the future.
+    *
+    * @return
+    *   Point in time when this host record should be deleted.
+    */
+  def ttl: Option[Instant]
+
+  /** Uninstalls this host by setting the installed field to false and optionally set a TTL.
     *
-    * @return A new version of this host with the installed field set to false.
+    * @return
+    *   A new version of this host with the installed field set to false.
     */
-  def uninstalled: AtlassianHost
+  def uninstalled(ttl: Option[Instant]): AtlassianHost
 }

modules/api/src/main/scala/io/toolsplus/atlassian/connect/play/api/models/DefaultAtlassianHost.scala

@@ -2,22 +2,28 @@ package io.toolsplus.atlassian.connect.play.api.models
 
 import io.toolsplus.atlassian.connect.play.api.models.Predefined.ClientKey
 
+import java.time.Instant
+
 /** Default case class implementation of [[AtlassianHost]].
   */
-case class DefaultAtlassianHost(clientKey: ClientKey,
-                                key: String,
-                                oauthClientId: Option[String],
-                                installationId: Option[String],
-                                sharedSecret: String,
-                                baseUrl: String,
-                                displayUrl: String,
-                                displayUrlServicedeskHelpCenter: String,
-                                productType: String,
-                                description: String,
-                                serviceEntitlementNumber: Option[String],
-                                entitlementId: Option[String],
-                                entitlementNumber: Option[String],
-                                installed: Boolean) extends AtlassianHost {
+case class DefaultAtlassianHost(
+    clientKey: ClientKey,
+    key: String,
+    oauthClientId: Option[String],
+    installationId: Option[String],
+    sharedSecret: String,
+    baseUrl: String,
+    displayUrl: String,
+    displayUrlServicedeskHelpCenter: String,
+    productType: String,
+    description: String,
+    serviceEntitlementNumber: Option[String],
+    entitlementId: Option[String],
+    entitlementNumber: Option[String],
+    installed: Boolean,
+    ttl: Option[Instant]
+) extends AtlassianHost {
 
-  override def uninstalled: AtlassianHost = copy(installed = false)
+  override def uninstalled(ttl: Option[Instant]): AtlassianHost =
+    copy(installed = false, ttl = ttl)
 }