Problem
The existing documentation on image handling does not clearly state the limitations of the OpenFn platform when dealing with image manipulation, The current documentation accurately covers fetching and re-uploading (moving) images but is misleading for tasks that require actually changing the image file.
Required Documentation Changes
Please update the existing Image Handling documentation to include a prominent warning or note with the following points:
- Limitation on Image Manipulation: State that the OpenFn platform does not natively support advanced image manipulation tasks such as resizing, compression, or writing EXIF metadata to image files.
- Technical Constraint: Explicitly mention that platform jobs cannot currently run the necessary external programs (like
imagemagick) required for these actions, and that technical blockers exist (e.g., writing EXIF metadata in the Node.js job environment).
- Scope Clarification: Clarify that the supported functionality focuses primarily on retrieving images via URL and passing them as is to a downstream system, or embedding them as Base64 strings (which should be avoided for large files).
Context
The need for this update stems from the Plan International project, where the image processing requirements include:
- Validation and Resizing: Validating image orientation and dimensions (must be at least 1200x1600px at a 3:4 ratio) and resizing to exact dimensions.
- Compression: Compressing the image to a specific target file size (400KB–800KB, hard max: 700KB).
- Metadata Embedding: Embedding metadata (e.g., SC Number, Photo Type) into the image's EXIF UserComment field.
The updated documentation should suggest that users who encounter requirements to change an image (beyond simple fetching) should immediately flag this to the product team.
Problem
The existing documentation on image handling does not clearly state the limitations of the OpenFn platform when dealing with image manipulation, The current documentation accurately covers fetching and re-uploading (moving) images but is misleading for tasks that require actually changing the image file.
Required Documentation Changes
Please update the existing Image Handling documentation to include a prominent warning or note with the following points:
imagemagick) required for these actions, and that technical blockers exist (e.g., writing EXIF metadata in the Node.js job environment).Context
The need for this update stems from the Plan International project, where the image processing requirements include:
The updated documentation should suggest that users who encounter requirements to change an image (beyond simple fetching) should immediately flag this to the product team.