keystonejs/keystone-classic

generateFilename not working for cloudinaryimage type

Open

#4568 opened on Feb 7, 2018

View on GitHub
 (1 comment) (0 reactions) (1 assignee)JavaScript (14,656 stars) (2,288 forks)batch import
4.x candidatebughelp wanted

Description

Hi Guys, I'm just here to report a bug. The "generateFilename" function for cloudinaryImage type does not work for me and causes the admin UI to hang for ages until eventually failing to upload to cloudinary. The admin UI then giving me an empty error message as I can only see a red box at top of admin UI (where you usually get error messages such as "invalid crf").

I am using the method described in: https://github.com/keystonejs/keystone/tree/master/fields/types/cloudinaryimage

And this is my code:

image: { type: Types.CloudinaryImage, generateFilename: function(file, attemptNumber, callback) { var originalname = file.originalname; var filenameWithoutExtension = originalname.substring(0, originalname.lastIndexOf('.')); var timestamp = new Date().getTime(); return ${filenameWithoutExtension}-${timestamp}; }, }

My cloudinary setting for upload have auto-create folders ON and i tried with Use file name in "Media Library" ON and OFF. No luck.

Thank you.

Expected behavior

Able to generate cloudinaryimage filename and using this filename as name of image on cloudinary rather than just random string as filename by using the generateFilename method explained here: https://github.com/keystonejs/keystone/tree/master/fields/types/cloudinaryimage

Actual/Current behavior

The admin UI is stuck with "Save" but changed to "saving..." but it hangs there for ages until eventually failing to upload to cloudinary. The admin UI then giving me an empty error message as I can only see a red box at top of admin UI (where you usually get error messages such as "invalid crf"). keystone-bug

Steps to reproduce the actual/current behavior

Try to create a cloudinary image type field in post.js and use generatefilename method describe in readme for cloudinaryimage ongithub, so this code: image: { type: Types.CloudinaryImage, generateFilename: function(file, attemptNumber, callback) { var originalname = file.originalname; var filenameWithoutExtension = originalname.substring(0, originalname.lastIndexOf('.')); var timestamp = new Date().getTime(); return ${filenameWithoutExtension}-${timestamp}; }, }

Environment

Software Version
Keystone 4.0.0-beta.5
Node v8.9.4

Contributor guide

Tech stack
javascriptnodejs
Domain
backend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of KeystoneJSUnderstanding CloudinaryImage fieldJavaScript callbacks
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
The issue is that generateFilename does not work as expected. The user's code returns a string directly, but the function likely expects to call a callback (file, attemptNumber, callback). The correct implementation should call callback(null, filename) within the function. See the CloudinaryImage field source in Keystone classic (fields/types/cloudinaryimage) for the expected signature. The admin UI hangs because the upload process is waiting for the callback that never gets called. To fix, modify the generateFilename implementation to invoke callback(null, filename) with the desired filename.