The variable CLOUDINARY_URL is problematic

[franck-boullier]

The variable CLOUDINARY_URL is necessary to make sure we can upload and transform attachments.

We have several problems with this variable.

The name of the variable we use in our code is misleading:

In the AWS parameter store and in the code in this repo, we use the name CLOUDINARY_URL for a URL that looks like https://api.cloudinary.com/v1_1/[CLOUDINARY_CLOUD_NAME]/image/upload

In the Cloudinary account the variable CLOUDINARY_URL looks like: cloudinary://[API_KEY]:[API_SECRET]@[CLOUD_NAME]

This makes it very confusing as people will likely assume that the value for the variable CLOUDINARY_URL in the AWS parameter store should be the same as the value for the variable CLOUDINARY_URL in the Cloudinary account (which is wrong).

Solution:

Replace the name of the variable CLOUDINARY_URL in the AWS store and in our code with a better name CLOUDINARY_API_ENDPOINT. We need to edit the following files:

Bugzilla-customization repo:

• docker-compose.yml

frontend repo:

• .env.sample
• app.json
• AWS-docker-compose.yml
• aws-env.[STAGE] (DEV, DEMO and PROD)
• env-setup.bash
• imports/state/epics/create-attachment.test.js
• imports/state/epics/base/file-upload-processor.js
• imports/ui/case/case-messages.test.js
• imports/util/matchers.js
• server/main.js

The value is hardcoded in some places in the code:

frontend repo:

• imports/state/epics/create-attachment.test.js
• env-setup.bash
• imports/ui/case/case-messages.test.js

[franck-boullier]

PR #17 fixed some of the issues.

To do before closing this issue:

• Rename the variable CLOUDINARY_URL to CLOUDINARY_API_ENDPOINT in the bugzilla-customization repo too.
• Remove the temporary fix that was included in the files
  • aws-env.dev
  • aws-env.prod
  • aws-env.demo