fix: use body instead of query params (#230)

Author: fenos

src/http/routes/object/getSignedURL.ts

@@ -3,7 +3,8 @@ import { FromSchema } from 'json-schema-to-ts'
 import { createDefaultSchema } from '../../generic-routes'
 import { AuthenticatedRequest } from '../../request'
 import { ImageRenderer } from '../../../storage/renderer'
-import { transformationQueryString } from '../../schemas/transformations'
+import { getConfig } from '../../../config'
+import { transformationOptionsSchema } from '../../schemas/transformations'
 
 const getSignedURLParamsSchema = {
   type: 'object',
@@ -17,15 +18,14 @@ const getSignedURLBodySchema = {
   type: 'object',
   properties: {
     expiresIn: { type: 'integer', minimum: 1, examples: [60000] },
+    transform: {
+      type: 'object',
+      properties: transformationOptionsSchema,
+    },
   },
   required: ['expiresIn'],
 } as const
-const renderImageQuerySchema = {
-  type: 'object',
-  properties: {
-    ...transformationQueryString,
-  },
-} as const
+
 const successResponseSchema = {
   type: 'object',
   properties: {
@@ -41,16 +41,16 @@ const successResponseSchema = {
 interface getSignedURLRequestInterface extends AuthenticatedRequest {
   Params: FromSchema<typeof getSignedURLParamsSchema>
   Body: FromSchema<typeof getSignedURLBodySchema>
-  Querystring: FromSchema<typeof renderImageQuerySchema>
 }
 
+const { enableImageTransformation } = getConfig()
+
 export default async function routes(fastify: FastifyInstance) {
   const summary = 'Generate a presigned url to retrieve an object'
 
   const schema = createDefaultSchema(successResponseSchema, {
     body: getSignedURLBodySchema,
     params: getSignedURLParamsSchema,
-    querystring: renderImageQuerySchema,
     summary,
     tags: ['object'],
   })
@@ -70,7 +70,9 @@ export default async function routes(fastify: FastifyInstance) {
       const signedURL = await request.storage
         .from(bucketName)
         .signObjectUrl(objectName, urlPath as string, expiresIn, {
-          transformations: ImageRenderer.applyTransformation(request.query || {}).join(','),
+          transformations: enableImageTransformation
+            ? ImageRenderer.applyTransformation(request.body.transform || {}).join(',')
+            : '',
         })
 
       return response.status(200).send({ signedURL })

src/http/routes/render/renderAuthenticatedImage.ts

@@ -2,7 +2,7 @@ import { getConfig } from '../../../config'
 import { FromSchema } from 'json-schema-to-ts'
 import { FastifyInstance } from 'fastify'
 import { ImageRenderer } from '../../../storage/renderer'
-import { transformationQueryString } from '../../schemas/transformations'
+import { transformationOptionsSchema } from '../../schemas/transformations'
 
 const { globalS3Bucket } = getConfig()
 
@@ -18,7 +18,7 @@ const renderAuthenticatedImageParamsSchema = {
 const renderImageQuerySchema = {
   type: 'object',
   properties: {
-    ...transformationQueryString,
+    ...transformationOptionsSchema,
     download: { type: 'string' },
   },
 } as const

src/http/routes/render/renderPublicImage.ts

@@ -2,7 +2,7 @@ import { getConfig } from '../../../config'
 import { FromSchema } from 'json-schema-to-ts'
 import { FastifyInstance } from 'fastify'
 import { ImageRenderer } from '../../../storage/renderer'
-import { transformationQueryString } from '../../schemas/transformations'
+import { transformationOptionsSchema } from '../../schemas/transformations'
 
 const { globalS3Bucket } = getConfig()
 
@@ -19,7 +19,7 @@ const renderPublicImageParamsSchema = {
 const renderImageQuerySchema = {
   type: 'object',
   properties: {
-    ...transformationQueryString,
+    ...transformationOptionsSchema,
     download: { type: 'string' },
   },
 } as const

src/http/schemas/transformations.ts

@@ -1,4 +1,4 @@
-export const transformationQueryString = {
+export const transformationOptionsSchema = {
   height: { type: 'integer', examples: [100], minimum: 0 },
   width: { type: 'integer', examples: [100], minimum: 0 },
   resize: { type: 'string', enum: ['fill', 'fit', 'fill-down', 'force', 'auto'] },

src/test/render-routes.test.ts

@@ -69,9 +69,13 @@ describe('image rendering routes', () => {
   it('will render a transformed image providing a signed url', async () => {
     const signURLResponse = await app().inject({
       method: 'POST',
-      url: '/object/sign/bucket2/authenticated/casestudy.png?width=100&height=100',
+      url: '/object/sign/bucket2/authenticated/casestudy.png',
       payload: {
         expiresIn: 60000,
+        transform: {
+          width: 100,
+          height: 100,
+        },
       },
       headers: {
         authorization: `Bearer ${process.env.SERVICE_KEY}`,