Add PDF API for schedule

Author: HugoGresse

functions/.env.example

@@ -1,2 +1,3 @@
 BUCKET=aaaaa.appspot.com
-SERVICE_API_KEY=xxxx
+SERVICE_API_KEY=xxxx
+G_FIREBASE_PROJECT_ID=xxx

functions/package-lock.json

@@ -29,6 +29,7 @@
         "firebase-admin": "^11.11.0",
         "firebase-functions": "^4.5.0",
         "luxon": "^3.4.4",
+        "puppeteer": "^24.10.1",
         "ts-custom-error": "^3.3.1",
         "uuid": "^9.0.1"
     },

functions/package.json

@@ -13,7 +13,14 @@ export class EventDao {
         if (!data) {
             throw new Error('Event not found')
         }
-        return data as Event
+        const baseData = data
+        if (data.dates) {
+            baseData.dates = {
+                start: data.dates.start.toDate(),
+                end: data.dates.end.toDate(),
+            }
+        }
+        return baseData as Event
     }
 
     public static async createCategory(

functions/src/api/dao/eventDao.ts

@@ -0,0 +1,9 @@
+import { FastifyInstance } from 'fastify'
+import { exportSchedulePdfRoute } from './exportSchedulePdf'
+import { getEventRoute } from './getEvent'
+
+export const eventRoutes = (fastify: FastifyInstance, options: any, done: () => any) => {
+    getEventRoute(fastify, options, () => {})
+    exportSchedulePdfRoute(fastify, options, () => {})
+    done()
+}

functions/src/api/routes/event/eventRoutes.ts

@@ -0,0 +1,141 @@
+import { Type } from '@sinclair/typebox'
+import { FastifyInstance } from 'fastify'
+import { EventDao } from '../../dao/eventDao'
+import { isDev } from '../../setupFastify'
+import { getFirebaseProjectId } from '../../../utils/getFirebaseProjectId'
+import { getServiceAPIKey } from '../../../serviceApi/serviceApiKeyPreHandler'
+import { getIndividualDays } from '../../../../../src/utils/dates/diffDays'
+import { uploadBufferToStorage } from '../file/utils/uploadBufferToStorage'
+
+const ExportPdfReply = Type.Object({
+    pdf: Type.String(),
+})
+
+export const exportSchedulePdfRoute = (fastify: FastifyInstance, options: any, done: () => any) => {
+    fastify.post<{ Params: { eventId: string }; Body: { apiKey: string } }>(
+        '/v1/:eventId/event/export-pdf',
+        {
+            schema: {
+                tags: ['event'],
+                summary: 'Export event schedule to PDF',
+                description:
+                    'Export event schedule to PDF. The PDF will be generated is the event public website is enabled. Do not forget to set the timezone in the event settings. The PDF will be stored in the event storage, and the public file url will be returned. The file will stay the same and will not be deleted if you disable the public website.',
+                params: Type.Object({
+                    eventId: Type.String(),
+                }),
+                response: {
+                    200: ExportPdfReply,
+                    400: Type.String(),
+                    401: Type.String(),
+                },
+                security: [
+                    {
+                        apiKey: [],
+                    },
+                ],
+            },
+            preHandler: fastify.auth([fastify.verifyApiKey]),
+        },
+        async (request, reply) => {
+            const { eventId } = request.params
+
+            const event = await EventDao.getEvent(fastify.firebase, eventId)
+
+            if (!event.publicEnabled) {
+                reply.status(401).send(
+                    JSON.stringify({
+                        error: 'Event is not public',
+                    })
+                )
+                return
+            }
+
+            if (!event.files?.public) {
+                reply.status(401).send(
+                    JSON.stringify({
+                        error: 'Missing public file, did you forgot to "Update website" once?',
+                    })
+                )
+                return
+            }
+
+            const individualEventDaysAsyearMonthDay = getIndividualDays(event.dates.start, event.dates.end)
+            const scheduleUrls = individualEventDaysAsyearMonthDay.map((day) => {
+                return `https://openplanner.fr/public/event/${eventId}/schedule/${day.start.toFormat(
+                    'yyyy-MM-dd'
+                )}?hideHeader=true`
+            })
+
+            const timezone = event.timezone
+
+            try {
+                const firebaseProjectId = getFirebaseProjectId()
+                const serviceApiKey = getServiceAPIKey()
+                const pdfServiceUrl = isDev()
+                    ? `http://localhost:5001/${firebaseProjectId}/europe-west1/serviceApi`
+                    : `https://service.openplanner.fr/`
+                const response = await fetch(`${pdfServiceUrl}/v1/convert?apiKey=${serviceApiKey}`, {
+                    method: 'POST',
+                    headers: {
+                        'Content-Type': 'application/json',
+                    },
+                    body: JSON.stringify({
+                        urls: scheduleUrls,
+                        settings: {
+                            viewport: {
+                                width: 4200,
+                                height: 8000,
+                                deviceScaleFactor: 4,
+                            },
+                            pdf: {
+                                format: 'A3',
+                                landscape: false,
+                                scale: 0.65,
+                                margin: {
+                                    top: '0px',
+                                    right: '0px',
+                                    bottom: '0px',
+                                    left: '0px',
+                                },
+                            },
+                            timezone: timezone,
+                        },
+                    }),
+                })
+
+                if (!response.ok) {
+                    console.error(await response.text())
+                    throw new Error(`PDF service responded with status: ${response.status}`)
+                }
+
+                const pdfArrayBuffer = await response.arrayBuffer()
+                const pdfBuffer = Buffer.from(pdfArrayBuffer)
+
+                const [success, publicFileUrlOrError] = await uploadBufferToStorage(
+                    fastify.firebase,
+                    pdfBuffer,
+                    eventId,
+                    `schedule`,
+                    false
+                )
+
+                if (!success) {
+                    return reply.status(400).send(publicFileUrlOrError)
+                }
+
+                reply.status(200).send({
+                    pdf: publicFileUrlOrError,
+                })
+            } catch (err) {
+                const error = err as Error
+                reply.status(400).send(
+                    JSON.stringify({
+                        error: 'Failed to generate PDF',
+                        details: error.message,
+                    })
+                )
+            }
+        }
+    )
+    done()
+}

functions/src/api/routes/event/exportSchedulePdf.ts

@@ -12,7 +12,7 @@ const GetEventReply = Type.Union([
 ])
 type GetEventReplyType = Static<typeof GetEventReply>
 
-export const eventRoutes = (fastify: FastifyInstance, options: any, done: () => any) => {
+export const getEventRoute = (fastify: FastifyInstance, options: any, done: () => any) => {
     fastify.get<{ Reply: GetEventReplyType }>(
         '/v1/:eventId/event',
         {

functions/src/api/routes/event/event.ts …nctions/src/api/routes/event/getEvent.tsfunctions/src/api/routes/event/event.ts renamed to functions/src/api/routes/event/getEvent.ts functions/src/api/routes/event/event.ts renamed to functions/src/api/routes/event/getEvent.ts

@@ -7,7 +7,8 @@ export const uploadBufferToStorage = async (
     firebase: firebase.app.App,
     buffer: Buffer,
     eventId: string,
-    fileName: string
+    fileName: string,
+    addUuid: boolean = true
 ): Promise<[boolean, string]> => {
     const storageBucket = getStorageBucketName()
 
@@ -21,7 +22,7 @@ export const uploadBufferToStorage = async (
 
     const bucket = firebase.storage().bucket(storageBucket)
     const fileName50char = fileName.slice(0, 50)
-    const path = `events/${eventId}/${uuidv4()}_${fileName50char}.${extension}`
+    const path = `events/${eventId}/${addUuid ? uuidv4() + '_' : ''}${fileName50char}.${extension}`
     const bucketFile = bucket.file(path)
 
     try {

functions/src/api/routes/file/utils/uploadBufferToStorage.ts

@@ -15,11 +15,11 @@ import { filesRoutes } from './routes/file/files'
 import { sessionsSpeakers } from './routes/sessionsSpeakers/sessionsSpeakers'
 import { helloRoute } from './routes/hello/hello'
 import { fastifyErrorHandler } from './other/fastifyErrorHandler'
-import { eventRoutes } from './routes/event/event'
+import { eventRoutes } from './routes/event/eventRoutes'
 import { bupherRoutes } from './routes/bupher/bupher'
 import { deployFilesRoutes } from './routes/deploy/getDeployFiles'
 import { deployRoutes } from './routes/deploy/deploy'
-import { noCacheHook } from '../fastifyUtils/noCacheHook'
+import { noCacheHook } from '../utils/noCacheHook'
 
 type Firebase = firebaseApp.App
 declare module 'fastify' {
@@ -29,13 +29,16 @@ declare module 'fastify' {
     }
 }
 
+export const isDev = () => {
+    return !!(process.env.FUNCTIONS_EMULATOR && process.env.FUNCTIONS_EMULATOR === 'true')
+}
+
 export const setupFastify = () => {
-    const isDev = !!(process.env.FUNCTIONS_EMULATOR && process.env.FUNCTIONS_EMULATOR === 'true')
     const isNodeEnvDev = process.env.NODE_ENV === 'development'
     const isNodeEnvTest = process.env.NODE_ENV === 'test'
 
     const fastify = Fastify({
-        logger: isDev,
+        logger: isDev() || isNodeEnvDev || isNodeEnvTest,
     }).withTypeProvider<TypeBoxTypeProvider>()
 
     if (!isNodeEnvDev && !isNodeEnvTest) {

functions/src/api/setupFastify.ts

@@ -1,6 +1,8 @@
 import FastifySwaggerUi from '@fastify/swagger-ui'
 import { FastifyInstance } from 'fastify'
 import FastifySwagger from '@fastify/swagger'
+import { isDev } from './setupFastify'
+import { getFirebaseProjectId } from '../utils/getFirebaseProjectId'
 
 export const registerSwagger = (fastify: FastifyInstance) => {
     fastify.register(FastifySwagger, {
@@ -9,8 +11,8 @@ export const registerSwagger = (fastify: FastifyInstance) => {
                 title: 'OpenPlanner API Documentation',
                 version: '1.0.0',
             },
-            host: 'api.openplanner.fr/',
-            schemes: ['https'],
+            host: isDev() ? `localhost:5001/${getFirebaseProjectId()}/europe-west1/api/` : 'api.openplanner.fr/',
+            schemes: isDev() ? ['http'] : ['https'],
             consumes: ['application/json'],
             produces: ['application/json'],
             securityDefinitions: {