keystonejs/keystone-classic

Keystone deletes keys that have a function as a value when setting options for TinyMCE

Open

#3728 opened on Nov 23, 2016

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (14,656 stars) (2,288 forks)batch import
bughelp wanted

Description

Steps to reproduce the behavior

  1. Install an external plugin like tinyvision
  2. Configure Keystone to use it. The relevant configuration might look like this:
keystone.init({
    // ...
    'wysiwyg additional options': {
        external_plugins: {
            tinyvision: '/admin/js/lib/tinymce/plugins/tinyvision/plugin.min.js'
        },
        tinyvision: {
            source: '/api/assets',
            upload: function() {}
        }
    }
});
  1. Create a route to intercept the request and load the plugin. The approach has been described in this comment.
  2. Inspect the options passed to the plugin

Expected behavior

All the options should be passed

Actual behavior

Options that have a function as a value are deleted. To confirm this, try to set the value of upload to a number or a string and it'll be present.

Contributor guide

Tech stack
javascript
Domain
backendfrontend
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.
mostly clear
Prerequisites
Familiarity with Keystone's configurationBasic knowledge of TinyMCE plugins
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
The issue occurs when Keystone processes the 'wysiwyg additional options' configuration. The code likely strips keys with function values during option merging or serialization. Investigate the initialization code in Keystone's admin UI setup, specifically how external plugin options are handled. Check if there is a JSON.stringify or similar operation that discards functions. Look at the repository's relevant files such as 'lib/core/options.js' or 'admin/server.js'.