Merge pull request #262 from KenEucker/develop

fix(aws): deleteTag now updates the new latest tag information when deleting from the main folder

Author: KenEucker

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "biketag",
-  "version": "3.5.22",
+  "version": "3.5.23",
   "description": "The Javascript client API for BikeTag Games",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

package.json

@@ -2,6 +2,7 @@ import {
   S3Client,
   DeleteObjectCommand,
   DeleteObjectsCommand,
+  CopyObjectCommand,
 } from '@aws-sdk/client-s3'
 import { deleteTagPayload } from '../common/payloads'
 import { BikeTagApiResponse } from '../common/types'
@@ -12,8 +13,14 @@ import {
   listAllS3Objects,
   loadIndex,
   saveIndex,
+  getKeyFromUrl,
+  encodeMetadataValue,
 } from './helpers'
 import { Tag } from '../common/schema'
+import {
+  getImgurMysteryTitleFromBikeTagData,
+  getImgurMysteryDescriptionFromBikeTagData,
+} from '../common/getters'
 
 export async function deleteTag(
   client: S3Client,
@@ -24,9 +31,8 @@ export async function deleteTag(
     payload
   const bucket = `${game}-biketag`
   const deleted: boolean[] = []
-
   let success = true
-  let errors = []
+  let errors: string[] = []
 
   if (!tagnumber) {
     success = false
@@ -43,10 +49,7 @@ export async function deleteTag(
     const deleteOps = list.map(async (obj) => {
       try {
         await client.send(
-          new DeleteObjectCommand({
-            Bucket: bucket,
-            Key: obj.Key,
-          })
+          new DeleteObjectCommand({ Bucket: bucket, Key: obj.Key })
         )
         return true
       } catch (err) {
@@ -71,12 +74,10 @@ export async function deleteTag(
         '',
         folder
       )
-
       const mysteryObjects = await listAllS3Objects(client, {
         Bucket: bucket,
         Prefix: mysteryKey,
       })
-
       keysToDelete.push(...mysteryObjects.map((obj) => ({ Key: obj.Key! })))
     }
 
@@ -89,12 +90,10 @@ export async function deleteTag(
         '',
         folder
       )
-
       const foundObjects = await listAllS3Objects(client, {
         Bucket: bucket,
         Prefix: foundKey,
       })
-
       keysToDelete.push(...foundObjects.map((obj) => ({ Key: obj.Key! })))
     }
 
@@ -106,7 +105,6 @@ export async function deleteTag(
             Delete: { Objects: keysToDelete },
           })
         )
-
         deleted.push(...keysToDelete.map(() => true))
 
         if (result.Errors && result.Errors.length > 0) {
@@ -124,8 +122,60 @@ export async function deleteTag(
   let indexUpdateError = ''
   if (success && tagnumber) {
     try {
-      const index = await loadIndex(client, bucket, folder, region)
+      let index = await loadIndex(client, bucket, folder, region)
       const newIndex = index.filter((t) => t.tagnumber !== tagnumber)
+
+      if (folder === 'main' && newIndex.length > 0) {
+        const idx = newIndex.findIndex((t) => t.tagnumber === tagnumber - 1)
+
+        if (idx === -1) {
+          errors.push(`Previous tag ${tagnumber - 1} not found in index`)
+          success = false
+        } else {
+          const latestTag = { ...newIndex[idx] }
+
+          // Reset fields to mystery state
+          latestTag.gps = { lat: 0, long: 0, alt: 0 }
+          latestTag.foundPlayer = ''
+          latestTag.foundImageUrl = ''
+          latestTag.foundTime = 0
+          latestTag.foundLocation = ''
+
+          // Refresh metadata on mystery image
+          if (latestTag.mysteryImageUrl) {
+            const mysteryKey = getKeyFromUrl(latestTag.mysteryImageUrl)
+            try {
+              await client.send(
+                new CopyObjectCommand({
+                  Bucket: bucket,
+                  CopySource: `${bucket}/${mysteryKey}`,
+                  Key: mysteryKey,
+                  ACL: 'public-read',
+                  MetadataDirective: 'REPLACE',
+                  Metadata: {
+                    title: encodeMetadataValue(
+                      getImgurMysteryTitleFromBikeTagData(latestTag).trim()
+                    ),
+                    description: encodeMetadataValue(
+                      getImgurMysteryDescriptionFromBikeTagData(
+                        latestTag
+                      ).trim()
+                    ),
+                  },
+                })
+              )
+            } catch (err: any) {
+              success = false
+              errors.push(
+                `Failed to refresh metadata for mystery image: ${err.message}`
+              )
+            }
+          }
+
+          newIndex[idx] = latestTag
+        }
+      }
+
       await saveIndex(client, bucket, folder, newIndex)
     } catch (indexErr: any) {
       indexUpdateError = `Index update failed: ${indexErr.message}`
@@ -141,7 +191,7 @@ export async function deleteTag(
   return {
     data: deleted,
     success,
-    error: errors.join(';'),
+    error: errors.join('; '),
     source: AvailableApis[AvailableApis.aws],
     status: success ? HttpStatusCode.Ok : HttpStatusCode.BadRequest,
   }

src/aws/deleteTag.ts

@@ -55,10 +55,15 @@ export async function queueTag(
     const mysteryTagPayload = payload
     const foundTagPayload = payload
     foundTagPayload.tagnumber = payload.tagnumber - 1
+    const isBrowserRequest = typeof window !== 'undefined'
 
     const [mysteryRes, foundRes] = await Promise.all([
-      this.updateTag(client, mysteryTagPayload, cache),
-      this.updateTag(client, foundTagPayload, cache),
+      isBrowserRequest
+        ? this.biketagUpdate(mysteryTagPayload, cache)
+        : this.updateTag(mysteryTagPayload, cache),
+      isBrowserRequest
+        ? this.biketagUpdate(foundTagPayload, cache)
+        : this.updateTag(foundTagPayload, cache),
     ])
 
     success = mysteryRes.success && foundRes.success
@@ -71,7 +76,7 @@ export async function queueTag(
     const image = isMystery ? payload.mysteryImage : payload.foundImage
     payload.contentType = (image as File)?.type ?? 'image/jpeg'
 
-    const uploadResponse = await this.uploadTagImage(client, payload)
+    const uploadResponse = await this.uploadTagImage(payload)
 
     if (uploadResponse.success) {
       const uploaded = uploadResponse.data

src/aws/queueTag.ts

@@ -50,7 +50,7 @@ export async function updateTag(
   const needsFound = !!(payload.foundImageUrl?.length || payload.foundImage)
 
   if (needsMystery || needsFound) {
-    const uploadResponse = await this.uploadTagImage(client, payload)
+    const uploadResponse = await this.uploadTagImage(payload)
 
     if (uploadResponse.success) {
       payload.mysteryImageUrl = uploadResponse.data.mysteryImageUrl

src/aws/updateTag.ts

@@ -7,4 +7,5 @@ export { getQueue } from './getQueue'
 export { getPlayers } from './getPlayers'
 export { getAmbassadors } from './getAmbassadors'
 export { getStats } from './getStats'
+export { updateTag } from './updateTag'
 export { fetchSignedUrl } from './fetchSignedUrl'

src/biketag/index.ts

@@ -1,26 +1,32 @@
-// import { updateTagPayload } from '../common/payloads'
-// import { BikeTagApiResponse } from '../common/types'
-// import { Tag } from '../common/schema'
-// import { BikeTagGunClient } from '../common/types'
-// import { AvailableApis, HttpStatusCode } from '../common/enums'
+import { BikeTagClient } from '../client'
+import { UPDATE_ENDPOINT } from '../common/endpoints'
+import { AvailableApis, HttpStatusCode } from '../common/enums'
+import { updateTagPayload } from '../common/payloads'
+import { Tag } from '../common/schema'
+import { BikeTagApiResponse } from '../common/types'
+import { getApiUrl } from './helpers'
 
-// export async function updateTag(
-//   client: BikeTagGunClient,
-//   payload: updateTagPayload
-// ): Promise<BikeTagApiResponse<Tag>> {
-//   const tag: Tag = await new Promise((r) => {
-//     return client
-//       .get(payload.game)
-//       .get('tags')
-//       .get(payload.tag.slug)
-//       .put(payload.tag)
-//       .once((t) => r(t as unknown as Tag))
-//   })
+export async function updateTag(
+  client: BikeTagClient,
+  payload: updateTagPayload
+): Promise<BikeTagApiResponse<Tag>> {
+  payload.source = undefined
 
-//   return {
-//     data: tag,
-//     status: HttpStatusCode.Ok,
-//     success: true,
-//     source: AvailableApis[AvailableApis.biketag],
-//   }
-// }
+  const opts = {
+    url: getApiUrl(payload.host, UPDATE_ENDPOINT, payload.game),
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json' },
+    data: payload,
+  }
+
+  const response = await client.request(opts)
+  const success = response.status === 200
+
+  return {
+    data: response.data as unknown as Tag,
+    success,
+    error: !success ? response.statusText : undefined,
+    source: AvailableApis[AvailableApis.biketag],
+    status: success ? HttpStatusCode.Ok : response.status,
+  }
+}

src/biketag/updateTag.ts

@@ -406,7 +406,7 @@ export class BikeTagClient {
 
   protected getPassthroughApiMethod(
     method: any,
-    client: ImgurClient | BikeTagClient | SanityClient,
+    client: ImgurClient | BikeTagClient | SanityClient | S3Client,
     dataType: DataTypes = DataTypes.tag,
     binding?: any
   ): any {
@@ -839,20 +839,40 @@ export class BikeTagClient {
     let clientMethod = api.queueTag
 
     switch (options.source) {
-      case AvailableApis.aws:
-        clientMethod = clientMethod.bind({
-          getQueue: this.getPassthroughApiMethod(api.getQueue, client),
-          getTags: this.getPassthroughApiMethod(api.getTags, client),
-          updateTag: this.getPassthroughApiMethod(api.updateTag, client),
-          uploadTagImage: api.uploadTagImage.bind({
+      case AvailableApis.aws: {
+        const getTags = this.getPassthroughApiMethod(api.getTags, client)
+        const uploadTagImage = this.getPassthroughApiMethod(
+          api.uploadTagImage,
+          client,
+          DataTypes.tag,
+          {
             plainFetcher: this.plainFetcher,
             fetchSignedUrl: this.getPassthroughApiMethod(
               biketagApi.fetchSignedUrl,
               this
             ),
-          }),
+          }
+        )
+        clientMethod = clientMethod.bind({
+          getQueue: this.getPassthroughApiMethod(api.getQueue, client),
+          getTags,
+          biketagUpdate: this.getPassthroughApiMethod(
+            biketagApi.updateTag,
+            this
+          ),
+          updateTag: this.getPassthroughApiMethod(
+            api.updateTag,
+            client,
+            DataTypes.tag,
+            {
+              getTags,
+              uploadTagImage,
+            }
+          ),
+          uploadTagImage,
         })
         break
+      }
       case AvailableApis.imgur:
         clientMethod = clientMethod.bind({
           getQueue: this.getPassthroughApiMethod(api.getQueue, client),

src/client.ts

@@ -53,7 +53,7 @@ export type updatePlayerPayload = Partial<Player> & SanityUploadPayload
 export type updateTagPayload = Partial<Tag> &
   SanityUploadPayload & {
     resize?: boolean
-  }
+  } & CommonPayloadData
 
 export type uploadTagImagePayload = {
   tagnumber: number