Rename object storage API to reflect object nomenclature

Author: lberrymage

console/src/main/kotlin/app/accrescent/parcelo/console/Application.kt

@@ -9,8 +9,8 @@ import app.accrescent.parcelo.console.jobs.configureJobRunr
 import app.accrescent.parcelo.console.publish.PublishService
 import app.accrescent.parcelo.console.publish.S3PublishService
 import app.accrescent.parcelo.console.routes.auth.configureAuthentication
-import app.accrescent.parcelo.console.storage.FileStorageService
-import app.accrescent.parcelo.console.storage.S3FileStorageService
+import app.accrescent.parcelo.console.storage.ObjectStorageService
+import app.accrescent.parcelo.console.storage.S3ObjectStorageService
 import aws.smithy.kotlin.runtime.net.url.Url
 import io.ktor.client.HttpClient
 import io.ktor.client.plugins.HttpTimeout
@@ -96,9 +96,9 @@ fun Application.module() {
 
         val mainModule = module {
             single { config }
-            single<FileStorageService> {
+            single<ObjectStorageService> {
                 when (config.privateStorage) {
-                    is Config.ObjectStorage.S3 -> S3FileStorageService(
+                    is Config.ObjectStorage.S3 -> S3ObjectStorageService(
                         Url.parse(config.privateStorage.endpointUrl),
                         config.privateStorage.region,
                         config.privateStorage.bucket,

console/src/main/kotlin/app/accrescent/parcelo/console/jobs/CleanDeletedFiles.kt

@@ -4,7 +4,7 @@
 
 package app.accrescent.parcelo.console.jobs
 
-import app.accrescent.parcelo.console.storage.FileStorageService
+import app.accrescent.parcelo.console.storage.ObjectStorageService
 import kotlinx.coroutines.runBlocking
 import org.koin.java.KoinJavaComponent.inject
 import kotlin.getValue
@@ -13,9 +13,9 @@ import kotlin.getValue
  * Removes all files marked deleted
  */
 fun cleanDeletedFiles() {
-    val storageService: FileStorageService by inject(FileStorageService::class.java)
+    val storageService: ObjectStorageService by inject(ObjectStorageService::class.java)
 
     runBlocking {
-        storageService.cleanAllFiles()
+        storageService.cleanAllObjects()
     }
 }

console/src/main/kotlin/app/accrescent/parcelo/console/jobs/CleanFile.kt

@@ -4,7 +4,7 @@
 
 package app.accrescent.parcelo.console.jobs
 
-import app.accrescent.parcelo.console.storage.FileStorageService
+import app.accrescent.parcelo.console.storage.ObjectStorageService
 import kotlinx.coroutines.runBlocking
 import org.koin.java.KoinJavaComponent.inject
 import kotlin.getValue
@@ -13,9 +13,9 @@ import kotlin.getValue
  * Removes the file with the given ID if it's marked deleted
  */
 fun cleanFile(fileId: Int) {
-    val storageService: FileStorageService by inject(FileStorageService::class.java)
+    val storageService: ObjectStorageService by inject(ObjectStorageService::class.java)
 
     runBlocking {
-        storageService.cleanFile(fileId)
+        storageService.cleanObject(fileId)
     }
 }

console/src/main/kotlin/app/accrescent/parcelo/console/jobs/Publish.kt

@@ -11,7 +11,7 @@ import app.accrescent.parcelo.console.data.App
 import app.accrescent.parcelo.console.data.Icon
 import app.accrescent.parcelo.console.data.Listing
 import app.accrescent.parcelo.console.publish.PublishService
-import app.accrescent.parcelo.console.storage.FileStorageService
+import app.accrescent.parcelo.console.storage.ObjectStorageService
 import kotlinx.coroutines.runBlocking
 import org.jetbrains.exposed.sql.statements.api.ExposedBlob
 import org.jetbrains.exposed.sql.transactions.transaction
@@ -23,7 +23,7 @@ import java.util.UUID
  * Publishes the draft with the given ID, making it available for download
  */
 fun registerPublishAppJob(draftId: UUID) {
-    val storageService: FileStorageService by inject(FileStorageService::class.java)
+    val storageService: ObjectStorageService by inject(ObjectStorageService::class.java)
     val publishService: PublishService by inject(PublishService::class.java)
 
     val draft = transaction { DraftDao.findById(draftId) } ?: return
@@ -32,8 +32,8 @@ fun registerPublishAppJob(draftId: UUID) {
 
     // Publish to the repository
     val metadata = runBlocking {
-        storageService.loadFile(draft.fileId) { draftStream ->
-            storageService.loadFile(iconFileId) { iconStream ->
+        storageService.loadObject(draft.fileId) { draftStream ->
+            storageService.loadObject(iconFileId) { iconStream ->
                 publishService.publishDraft(draftStream, iconStream, draft.shortDescription)
             }
         }
@@ -69,14 +69,14 @@ fun registerPublishAppJob(draftId: UUID) {
  * Publishes the update with the given ID, making it available for download
  */
 fun registerPublishUpdateJob(updateId: UUID) {
-    val storageService: FileStorageService by inject(FileStorageService::class.java)
+    val storageService: ObjectStorageService by inject(ObjectStorageService::class.java)
     val publishService: PublishService by inject(PublishService::class.java)
 
     val update = transaction { UpdateDao.findById(updateId) } ?: return
 
     // Publish to the repository
     val updatedMetadata = runBlocking {
-        storageService.loadFile(update.fileId!!) {
+        storageService.loadObject(update.fileId!!) {
             runBlocking { publishService.publishUpdate(it, update.appId.value) }
         }
     }

console/src/main/kotlin/app/accrescent/parcelo/console/routes/Drafts.kt

@@ -22,7 +22,7 @@ import app.accrescent.parcelo.console.data.User
 import app.accrescent.parcelo.console.data.net.ApiError
 import app.accrescent.parcelo.console.data.net.toApiError
 import app.accrescent.parcelo.console.jobs.cleanFile
-import app.accrescent.parcelo.console.storage.FileStorageService
+import app.accrescent.parcelo.console.storage.ObjectStorageService
 import app.accrescent.parcelo.console.util.TempFile
 import app.accrescent.parcelo.console.validation.MIN_TARGET_SDK
 import app.accrescent.parcelo.console.validation.REVIEW_ISSUE_BLACKLIST
@@ -95,7 +95,7 @@ fun Route.draftRoutes() {
 
 fun Route.createDraftRoute() {
     val config: Config by inject()
-    val storageService: FileStorageService by inject()
+    val storageService: ObjectStorageService by inject()
 
     post<Drafts> {
         val creatorId = call.principal<Session>()!!.userId
@@ -222,11 +222,13 @@ fun Route.createDraftRoute() {
                         val iconFileId = iconData.inputStream()
                             .use {
                                 runBlocking {
-                                    storageService.saveFile(it, iconData.size.toLong())
+                                    storageService.saveObject(it, iconData.size.toLong())
                                 }
                             }
                         val appFileId = tempApkSet.inputStream()
-                            .use { runBlocking { storageService.saveFile(it, tempApkSet.size()) } }
+                            .use {
+                                runBlocking { storageService.saveObject(it, tempApkSet.size()) }
+                            }
                         val icon = Icon.new { fileId = iconFileId }
                         Draft.new {
                             this.label = label
@@ -257,7 +259,7 @@ fun Route.createDraftRoute() {
 }
 
 fun Route.deleteDraftRoute() {
-    val storageService: FileStorageService by inject()
+    val storageService: ObjectStorageService by inject()
 
     delete<Drafts.Id> { route ->
         val userId = call.principal<Session>()!!.userId
@@ -404,7 +406,7 @@ fun Route.getAssignedDraftsRoute() {
  * See also [getUpdateApkSetRoute].
  */
 fun Route.getDraftApkSetRoute() {
-    val storageService: FileStorageService by inject()
+    val storageService: ObjectStorageService by inject()
 
     get<Drafts.Id.ApkSet> { route ->
         val userId = call.principal<Session>()!!.userId
@@ -437,7 +439,7 @@ fun Route.getDraftApkSetRoute() {
                 ).toString(),
             )
             call.respondOutputStream {
-                storageService.loadFile(draft.fileId) { it.copyTo(this) }
+                storageService.loadObject(draft.fileId) { it.copyTo(this) }
             }
         } else {
             // Check whether the user has read access to this draft. If they do, tell them they're

console/src/main/kotlin/app/accrescent/parcelo/console/routes/Updates.kt

@@ -24,7 +24,7 @@ import app.accrescent.parcelo.console.data.net.ApiError
 import app.accrescent.parcelo.console.data.net.toApiError
 import app.accrescent.parcelo.console.jobs.cleanFile
 import app.accrescent.parcelo.console.jobs.registerPublishUpdateJob
-import app.accrescent.parcelo.console.storage.FileStorageService
+import app.accrescent.parcelo.console.storage.ObjectStorageService
 import app.accrescent.parcelo.console.util.TempFile
 import app.accrescent.parcelo.console.validation.MIN_TARGET_SDK
 import app.accrescent.parcelo.console.validation.REVIEW_ISSUE_BLACKLIST
@@ -90,7 +90,7 @@ fun Route.updateRoutes() {
 
 fun Route.createUpdateRoute() {
     val config: Config by inject()
-    val storageService: FileStorageService by inject()
+    val storageService: ObjectStorageService by inject()
 
     post<Apps.Id.Updates> { route ->
         val userId = call.principal<Session>()!!.userId
@@ -169,8 +169,8 @@ fun Route.createUpdateRoute() {
                     return@post
                 }
 
-                val apkSetFileId =
-                    tempApkSet.inputStream().use { storageService.saveFile(it, tempApkSet.size()) }
+                val apkSetFileId = tempApkSet.inputStream()
+                    .use { storageService.saveObject(it, tempApkSet.size()) }
 
                 // There exists:
                 //
@@ -343,7 +343,7 @@ fun Route.updateUpdateRoute() {
  * the "update" permission for the associated app.
  */
 fun Route.deleteUpdateRoute() {
-    val storageService: FileStorageService by inject()
+    val storageService: ObjectStorageService by inject()
 
     delete<Updates.Id> { route ->
         val userId = call.principal<Session>()!!.userId
@@ -419,7 +419,7 @@ fun Route.getAssignedUpdatesRoute() {
  * See also [getDraftApkSetRoute].
  */
 fun Route.getUpdateApkSetRoute() {
-    val storageService: FileStorageService by inject()
+    val storageService: ObjectStorageService by inject()
 
     get<Updates.Id.ApkSet> { route ->
         val userId = call.principal<Session>()!!.userId
@@ -452,7 +452,7 @@ fun Route.getUpdateApkSetRoute() {
                 ).toString(),
             )
             call.respondOutputStream {
-                storageService.loadFile(update.fileId!!) { it.copyTo(this) }
+                storageService.loadObject(update.fileId!!) { it.copyTo(this) }
             }
         } else {
             // Check whether the user has read access to this update. If they do, tell them they're

console/src/main/kotlin/app/accrescent/parcelo/console/storage/FileStorageService.kt renamed to console/src/main/kotlin/app/accrescent/parcelo/console/storage/ObjectStorageService.kt

@@ -8,21 +8,21 @@ import org.jetbrains.exposed.dao.id.EntityID
 import java.io.InputStream
 
 /**
- * Abstraction of file storage
+ * Abstraction of object storage
  */
-interface FileStorageService {
+interface ObjectStorageService {
     /**
      * Save a file to the file storage service
      *
      * @return the database ID of the new file
      */
-    suspend fun saveFile(inputStream: InputStream, size: Long): EntityID<Int>
+    suspend fun saveObject(inputStream: InputStream, size: Long): EntityID<Int>
 
     /**
      * Marks the given file deleted
      *
      * This method does not guarantee that the file has been deleted from the underlying storage
-     * medium. However, all future calls to [loadFile] for the same file with throw
+     * medium. However, all future calls to [loadObject] for the same file with throw
      * [NoSuchFileException], and the file should be considered deleted for all purposes besides
      * cleaning.
      */
@@ -34,17 +34,17 @@ interface FileStorageService {
      * The file must be previously marked deleted by [markDeleted], otherwise this function does
      * nothing.
      */
-    suspend fun cleanFile(id: Int)
+    suspend fun cleanObject(id: Int)
 
     /**
      * Deletes all files marked deleted from persistent storage
      */
-    suspend fun cleanAllFiles()
+    suspend fun cleanAllObjects()
 
     /**
      * Load the file with the given ID
      *
      * @return the file's data stream
      */
-    suspend fun <T> loadFile(id: EntityID<Int>, block: suspend (InputStream) -> T): T
+    suspend fun <T> loadObject(id: EntityID<Int>, block: suspend (InputStream) -> T): T
 }

console/src/main/kotlin/app/accrescent/parcelo/console/storage/S3FileStorageService.kt renamed to console/src/main/kotlin/app/accrescent/parcelo/console/storage/S3ObjectStorageService.kt

@@ -30,16 +30,16 @@ import java.io.InputStream
 import java.util.UUID
 
 /**
- * Implementation of [FileStorageService] using S3-compatible storage as the backing store
+ * Implementation of [ObjectStorageService] using S3-compatible storage as the backing store
  */
-class S3FileStorageService(
+class S3ObjectStorageService(
     private val s3EndpointUrl: Url,
     private val s3Region: String,
     private val s3Bucket: String,
     private val s3AccessKeyId: String,
     private val s3SecretAccessKey: String,
-) : FileStorageService {
-    override suspend fun saveFile(inputStream: InputStream, size: Long): EntityID<Int> {
+) : ObjectStorageService {
+    override suspend fun saveObject(inputStream: InputStream, size: Long): EntityID<Int> {
         S3Client {
             endpointUrl = s3EndpointUrl
             region = s3Region
@@ -67,7 +67,7 @@ class S3FileStorageService(
         transaction { findFile(id)?.apply { deleted = true } } ?: return
     }
 
-    override suspend fun cleanFile(id: Int) {
+    override suspend fun cleanObject(id: Int) {
         val file = transaction { File.findById(id) } ?: return
         val s3ObjectKey = file.s3ObjectKey
 
@@ -89,7 +89,7 @@ class S3FileStorageService(
         transaction { file.delete() }
     }
 
-    override suspend fun cleanAllFiles() {
+    override suspend fun cleanAllObjects() {
         val files = transaction { File.find { deleted eq true } }
 
         val deleteObjectsRequest = transaction {
@@ -118,7 +118,7 @@ class S3FileStorageService(
         }
     }
 
-    override suspend fun <T> loadFile(id: EntityID<Int>, block: suspend (InputStream) -> T): T {
+    override suspend fun <T> loadObject(id: EntityID<Int>, block: suspend (InputStream) -> T): T {
         val s3ObjectKey =
             transaction { findFile(id.value)?.s3ObjectKey } ?: throw FileNotFoundException()