Merge pull request #653 from basil/ace-editor

Upgrade ACE Editor from 1.2.2 to 1.15.0

Author: jglick

plugin/package.json

@@ -39,7 +39,7 @@
     "webpack-fix-style-only-entries": "^0.6.1"
   },
   "dependencies": {
-    "jenkins-js-modules": "1.3.0",
+    "ace-builds": "^1.15.0",
     "jquery": "^3.6.1",
     "jquery-ui": "^1.13.2",
     "raf": "^3.4.1"

plugin/pom.xml

@@ -42,8 +42,8 @@
     </licenses>
     <properties>
         <no-test-jar>false</no-test-jar>
-        <node.version>16.17.0</node.version>
-        <npm.version>8.18.0</npm.version>
+        <node.version>18.13.0</node.version>
+        <npm.version>8.19.3</npm.version>
         <yarn.version>1.22.19</yarn.version>
     </properties>
     <dependencyManagement>
@@ -165,16 +165,6 @@
                 </exclusion>
             </exclusions>
         </dependency>
-        <dependency>
-            <groupId>org.jenkins-ci.ui</groupId>
-            <artifactId>ace-editor</artifactId>
-            <exclusions>
-                <exclusion> <!-- TODO remove when ace-editor is refreshed -->
-                    <groupId>javax.servlet</groupId>
-                    <artifactId>servlet-api</artifactId>
-                </exclusion>
-            </exclusions>
-        </dependency>
         <dependency>
             <groupId>com.cloudbees</groupId>
             <artifactId>diff4j</artifactId>

plugin/src/main/webapp/snippets/workflow.js renamed to plugin/src/main/js/snippets/workflow.js

@@ -1,3 +1,4 @@
+import ace from "ace-builds/src-noconflict/ace";
 ace.define("ace/snippets/groovy",["require","exports","module"], function(require, exports, module) {
 "use strict";
 

plugin/src/main/js/workflow-editor.js

@@ -1,19 +1,21 @@
 import $ from 'jquery';
-import jenkinsJSModules from 'jenkins-js-modules';
 // Polyfill for window.requestAnimationFrame
 import 'raf/polyfill';
 // Import the resizable module to allow the textarea to be expanded
 import 'jquery-ui/ui/widgets/resizable';
 import { addSamplesWidget } from './samples';
 
+// Import ACE
+import ace from "ace-builds/src-noconflict/ace";
+import "ace-builds/src-noconflict/ext-language_tools";
+import "ace-builds/src-noconflict/mode-groovy";
+import "ace-builds/src-noconflict/theme-tomorrow";
+
+// Import custom snippets
+import "./snippets/workflow";
+
 var editorIdCounter = 0;
 
-// The Jenkins 'ace-editor:ace-editor-122' plugin doesn't support a synchronous
-// require option. This is because of how the ACE editor is written. So, we need
-// to use lower level jenkins-js-modules async 'import' to get a handle on a
-// specific version of ACE, from which we create an editor instance for workflow.
-jenkinsJSModules.import('ace-editor:ace-editor-122')
-    .onFulfilled(function (acePack) {
         $('.workflow-editor-wrapper').each(function() {
             initEditor($(this));
         });
@@ -30,24 +32,18 @@ jenkinsJSModules.import('ace-editor:ace-editor-122')
             var editorId = 'workflow-editor-' + editorIdCounter;
             aceContainer.attr('id', editorId);
 
-            // The 'ace-editor:ace-editor-122' plugin supplies an "ACEPack" object.
-            // ACEPack understands the hardwired async nature of the ACE impl and so
-            // provides some async ACE script loading functions.
-
-            acePack.edit(editorId, function() {
-                var ace = acePack.ace;
-                var editor = this.editor;
+                var editor = ace.edit(editorId);
 
                 // Attach the ACE editor instance to the element. Useful for testing.
                 var $wfEditor = $('#' + editorId);
                 $wfEditor.get(0).aceEditor = editor;
 
-                acePack.addPackOverride('snippets/groovy.js', '../workflow-cps/snippets/workflow.js');
+                // https://stackoverflow.com/a/66923593
+                var snippetManager = ace.require('ace/snippets').snippetManager;
+                var snippetContent = ace.require('ace/snippets/groovy').snippetText;
+                var snippets = snippetManager.parseSnippetFile(snippetContent);
+                snippetManager.register(snippets, 'groovy');
 
-                acePack.addScript('ext-language_tools.js', function() {
-                    ace.require("ace/ext/language_tools");
-
-                    editor.$blockScrolling = Infinity;
                     editor.session.setMode("ace/mode/groovy");
                     editor.setTheme("ace/theme/tomorrow");
                     editor.setAutoScrollEditorIntoView(true);
@@ -60,7 +56,7 @@ jenkinsJSModules.import('ace-editor:ace-editor-122')
                     });
 
                     editor.setValue(textarea.val(), 1);
-                    editor.getSession().on('change', function() {
+                    editor.getSession().on('change', function(delta) {
                         textarea.val(editor.getValue());
                         showSamplesWidget();
                     });
@@ -108,7 +104,6 @@ jenkinsJSModules.import('ace-editor:ace-editor-122')
                         }
                     }
                     showSamplesWidget();
-                });
 
                 // Make the editor resizable using jQuery UI resizable (http://api.jqueryui.com/resizable).
                 // ACE Editor doesn't have this as a config option.
@@ -129,9 +124,7 @@ jenkinsJSModules.import('ace-editor:ace-editor-122')
                         })
                     },
                 });
-            });
 
             wrapper.show();
             textarea.hide();
         }
-    });

plugin/yarn.lock

@@ -1064,6 +1064,11 @@
   version "4.2.2"
   resolved "https://registry.yarnpkg.com/@xtuc/long/-/long-4.2.2.tgz#d291c6a4e97989b5c61d9acf396ae4fe133a718d"
 
+ace-builds@^1.15.0:
+  version "1.15.0"
+  resolved "https://registry.yarnpkg.com/ace-builds/-/ace-builds-1.15.0.tgz#e4e5eee17a1d3d17fc92c1207bbc30f185f260cc"
+  integrity sha512-L1RXgqxDvzbJ7H8Y2v9lb4kHaZRn5JNTECG+oZTH2EDewMmpQMLDC4GnFKIh3+xb/gk2nVPO7gGwpTYPw91QzA==
+
 acorn-import-assertions@^1.7.6:
   version "1.8.0"
   resolved "https://registry.yarnpkg.com/acorn-import-assertions/-/acorn-import-assertions-1.8.0.tgz#ba2b5939ce62c238db6d93d81c9b111b29b855e9"
@@ -1872,12 +1877,6 @@ isobject@^3.0.1:
   version "3.0.1"
   resolved "https://registry.yarnpkg.com/isobject/-/isobject-3.0.1.tgz#4e431e92b11a9731636aa1f9c8d1ccbcfdab78df"
 
-[email protected]:
-  version "1.3.0"
-  resolved "https://registry.yarnpkg.com/jenkins-js-modules/-/jenkins-js-modules-1.3.0.tgz#d1872a0917a7b4bcae216a598ea7076f874c49be"
-  dependencies:
-    window-handle "0.0.6"
-
 jest-worker@^27.4.5:
   version "27.5.1"
   resolved "https://registry.yarnpkg.com/jest-worker/-/jest-worker-27.5.1.tgz#8d146f0900e8973b106b6f73cc1e9a8cb86f8db0"
@@ -2726,10 +2725,6 @@ wildcard@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/wildcard/-/wildcard-2.0.0.tgz#a77d20e5200c6faaac979e4b3aadc7b3dd7f8fec"
 
-[email protected]:
-  version "0.0.6"
-  resolved "https://registry.yarnpkg.com/window-handle/-/window-handle-0.0.6.tgz#f71cc52f8c21f337ae8785b71c8356e08a263c2e"
-
 word-wrap@^1.2.3:
   version "1.2.3"
   resolved "https://registry.yarnpkg.com/word-wrap/-/word-wrap-1.2.3.tgz#610636f6b1f703891bd34771ccb17fb93b47079c"