feat(event): make cover an attachment

.adonisrc.json

@@ -25,7 +25,8 @@
     "@adonisjs/auth",
     "adonis5-swagger",
     "@adonisjs/shield",
-    "@adonisjs/session"
+    "@adonisjs/session",
+    "@adonisjs/attachment-lite"
   ],
   "aceProviders": [
     "@adonisjs/repl"

app/Models/Event.ts

@@ -1,5 +1,7 @@
 import { DateTime } from 'luxon'
 import { BaseModel, column, HasOne, hasOne } from '@ioc:Adonis/Lucid/Orm'
+import { attachment, AttachmentContract } from '@ioc:Adonis/Addons/AttachmentLite'
+
 import User from './User'
 import Venue from './Venue'
 
@@ -22,8 +24,8 @@ export default class Event extends BaseModel {
   @column()
   public description: string
 
-  @column()
-  public cover: string
+  @attachment({ preComputeUrl: true }) // Generating URLs for the API response
+  public cover: AttachmentContract | null
 
   @column()
   public prePayment: string
@@ -38,7 +40,7 @@ export default class Event extends BaseModel {
   public alternativeAddress: string
 
   @column()
-  public links: string
+  public eventLinks: string
 
   @column()
   public creatorEmail: string

app/Validators/Event/CreateEventValidator.ts

@@ -13,7 +13,7 @@ export default class CreateEventValidator {
     box_office: schema.string.optional(),
     pre_payment: schema.string.optional(),
     alternative_address: schema.string.optional(),
-    cover: schema.string.optional([rules.url()]),
+    cover: schema.file.optional({ size: '2mb', extnames: ['jpg', 'gif', 'png'] }),
     creator_email: schema.string.optional([
       rules.email(),
       rules.exists({ table: 'users', column: 'email' }),
@@ -28,5 +28,7 @@ export default class CreateEventValidator {
     'venue_id.exists': 'Referenced venue does not exist',
     'creator_email.email': 'Please enter a valid email address',
     'creator_email.exists': 'Referenced user does not exist',
+    'file.size': 'The file size must be under {{ options.size }}',
+    'file.extname': 'The file must have one of {{ options.extnames }} extension names',
   }
 }

app/Validators/Event/UpdateEventValidator.ts

@@ -13,7 +13,7 @@ export default class UpdateEventValidator {
     box_office: schema.string.optional(),
     pre_payment: schema.string.optional(),
     alternative_address: schema.string.optional(),
-    cover: schema.string.optional([rules.url()]),
+    cover: schema.file.optional({ size: '2mb', extnames: ['jpg', 'gif', 'png'] }),
     // TODO: only allowed if the create a moderator or admin
     is_public: schema.boolean.optional(),
     venue_id: schema.string.optional([rules.exists({ table: 'venues', column: 'id' })]),
@@ -26,5 +26,7 @@ export default class UpdateEventValidator {
     'venue_id.exists': 'Referenced venue does not exist',
     'creator_email.email': 'Please enter a valid email address',
     'creator_email.exists': 'Referenced user does not exist',
+    'file.size': 'The file size must be under {{ options.size }}',
+    'file.extname': 'The file must have one of {{ options.extnames }} extension names',
   }
 }

database/factories/EventFactory.ts

@@ -1,22 +1,39 @@
-import Event from '../../app/Models/Event'
 import Factory from '@ioc:Adonis/Lucid/Factory'
+import Drive from '@ioc:Adonis/Core/Drive'
+import { file } from '@ioc:Adonis/Core/Helpers'
+import { Attachment } from '@ioc:Adonis/Addons/AttachmentLite'
+
+import Event from '../../app/Models/Event'
 
-export default Factory.define(Event, ({ faker }: any) => {
+export default Factory.define(Event, async ({ faker }: any) => {
   const dateFrom = new Date()
   const dateTo = new Date()
   dateTo.setDate(dateTo.getDate() + Math.round(5))
   const support = new Array(5).fill(null).map(() => faker.random.word())
+
+  // Create an instance of attachment and mark image as persisted
+  const coverImage = new Attachment({
+    extname: 'png',
+    mimeType: 'image/png',
+    size: 10 * 1000,
+    name: `${faker.random.alphaNumeric(10)}.png`,
+  })
+  coverImage.isPersisted = true
+
+  // Persist the file using Drive.
+  await Drive.put(coverImage.name, (await file.generatePng('1mb')).contents)
+
   return {
     title: faker.random.word(),
     date: faker.date.between(dateFrom, dateTo).toISOString(),
     headliner: faker.random.word(),
     support: JSON.stringify(support),
     description: faker.random.word(),
-    cover: faker.random.numeric(),
+    cover: coverImage,
     pre_payment: (faker.random.numeric(5) + faker.random.numeric(3)).toString(),
     box_office: (faker.random.numeric(5) + faker.random.numeric(3)).toString(),
     venue: faker.random.numeric(),
-    links: faker.random.words(),
+    event_links: faker.random.words(),
     creator: faker.random.numeric(),
     is_public: true,
   }

database/migrations/1675154622577_events.ts

@@ -0,0 +1,19 @@
+import BaseSchema from '@ioc:Adonis/Lucid/Schema'
+
+export default class extends BaseSchema {
+  protected tableName = 'events'
+
+  public async up() {
+    this.schema.alterTable(this.tableName, (table) => {
+      table.renameColumn('links', 'event_links')
+      table.json('cover').alter()
+    })
+  }
+
+  public async down() {
+    this.schema.alterTable(this.tableName, (table) => {
+      table.renameColumn('event_links', 'links')
+      table.string('cover').alter()
+    })
+  }
+}

package.json

@@ -56,6 +56,7 @@
     "youch-terminal": "^2.1.5"
   },
   "dependencies": {
+    "@adonisjs/attachment-lite": "^1.0.7",
     "@adonisjs/auth": "^8.2.3",
     "@adonisjs/core": "^5.8.0",
     "@adonisjs/lucid": "^18.3.0",

tests/functional/event.spec.ts

@@ -37,7 +37,7 @@ test.group('Events', (group) => {
       'box_office',
       'venue_id',
       'alternative_address',
-      'links',
+      'event_links',
       'creator_email',
       'is_public',
       'created_at',
@@ -65,7 +65,7 @@ test.group('Events', (group) => {
       'box_office',
       'venue_id',
       'alternative_address',
-      'links',
+      'event_links',
       'creator_email',
       'is_public',
       'created_at',
@@ -96,7 +96,7 @@ test.group('Events', (group) => {
       cover: 'https://link-to-cover.de',
       pre_payment: '33 Euro',
       box_office: '34',
-      links: 'https://www.test-location.de',
+      event_links: 'https://www.test-location.de',
       alternative_address: 'test',
       creator_email: user.email,
       venue_id: venue.id,
@@ -113,7 +113,7 @@ test.group('Events', (group) => {
       'box_office',
       'venue_id',
       'alternative_address',
-      'links',
+      'event_links',
       'is_public',
       'creator_email',
       'created_at',
@@ -240,7 +240,7 @@ test.group('Events', (group) => {
       cover: 'https://link-to-ohter-webseit.de',
       pre_payment: '24 €',
       box_office: '25 Tacken',
-      links: 'https://www.new-test-location.de',
+      event_links: 'https://www.new-test-location.de',
       alternative_address: 'somewhere else',
       is_public: false,
       venue_id: venue.id,

tsconfig.json

@@ -33,7 +33,8 @@
       "@adonisjs/auth",
       "adonis5-swagger",
       "@adonisjs/shield",
-      "@adonisjs/session"
+      "@adonisjs/session",
+      "@adonisjs/attachment-lite"
     ]
   }
 }