LP#1076582: Remove Custom Dojo Build Profile and Add Release Note
authorJason Stephenson <jason@sigio.com>
Wed, 3 Mar 2021 14:56:17 +0000 (09:56 -0500)
committerJason Stephenson <jason@sigio.com>
Wed, 3 Mar 2021 15:10:59 +0000 (10:10 -0500)
Signed-off-by: Jason Stephenson <jason@sigio.com>
Open-ILS/examples/openils.profile.js [deleted file]
docs/RELEASE_NOTES_NEXT/Architecture/remove_custom_dojo.adoc [new file with mode: 0644]

diff --git a/Open-ILS/examples/openils.profile.js b/Open-ILS/examples/openils.profile.js
deleted file mode 100644 (file)
index a01d97b..0000000
+++ /dev/null
@@ -1,223 +0,0 @@
-dependencies = {
-    layers: [{
-        name: "openils_all_opac_dojo.js",
-        dependencies: [
-
-                   "dijit._Calendar",
-                   "dijit.Menu",
-                   "dojo.io.script",
-                   "dijit.Dialog",
-                   "dijit.form.Button",
-                   "dijit.form.CheckBox",
-                   "dijit.form.CurrencyTextBox",
-                   "dijit.form.DateTextBox",
-                   "dijit.form.FilteringSelect",
-                   "dijit.form._FormWidget",
-                   "dijit.form.NumberSpinner",
-                   "dijit.form.NumberTextBox",
-                   "dijit.form.TextBox",
-                   "dijit.form.ValidationTextBox",
-                   "dijit.layout.ContentPane",
-                   "dijit.ProgressBar",
-                   "dijit._Templated",
-                   "dijit._Widget",
-                   "dojo.cookie",
-                   "dojo.data.ItemFileReadStore",
-                   "dojo.data.ItemFileWriteStore",
-                   "dojo.date.locale",
-                   "dojo.date.stamp",
-                   "dojo.query",
-                   "dojo.string",
-                   "dojox.grid.compat._data.dijitEditors",
-                   "dojox.grid.compat._data.editors",
-                   "dojox.grid.compat._data.model",
-                   "dojox.grid.DataGrid",
-                   "dojox.grid.Grid",
-                   "dojox.jsonPath",
-                   "dojox.xml.parser"
-        ]
-    },{
-        name: "openils_ui_dojo.js",
-        dependencies: [
-                   "dijit.Dialog",
-                   "dijit.form.Button",
-                   "dijit.form.CheckBox",
-                   "dijit.form.ComboBox",
-                   "dijit.form.CurrencyTextBox",
-                   "dijit.form.DateTextBox",
-                   "dijit.form.DropDownButton",
-                   "dijit.form.FilteringSelect",
-                   "dijit.form.Form",
-                   "dijit.form.NumberSpinner",
-                   "dijit.form.NumberTextBox",
-                   "dijit.form.RadioButton",
-                   "dijit.form.Textarea",
-                   "dijit.form.TextBox",
-                   "dijit.form.TimeTextBox",
-                   "dijit.layout.ContentPane",
-                   "dijit.layout.LayoutContainer",
-                   "dijit.layout.SplitContainer",
-                   "dijit.layout.StackContainer",
-                   "dijit.layout.TabContainer",
-                   "dijit.Menu",
-                   "dijit.MenuItem",
-                   "dijit.ProgressBar",
-                   "dijit.Toolbar",
-                   "dijit.Tooltip",
-                   "dijit.TooltipDialog",
-                   "dojo.cookie",
-                   "dojo.data.ItemFileReadStore",
-                   "dojo.data.ItemFileWriteStore",
-                   "dojo.date",
-                   "dojo.date.locale",
-                   "dojo.date.stamp",
-                   "dojo.dnd.Container",
-                   "dojo.dnd.Source",
-                   "dojo.io.iframe",
-                   "dojo.parser",
-                   "dojo.string",
-                   "dojox.encoding.base64",
-                   "dojox.form.CheckedMultiSelect",
-                   "dojox.grid.cells.dijit",
-                   "dojox.grid.DataGrid",
-                   "dojox.grid.Grid",
-                   "dojox.string.sprintf",
-                   "dojox.widget.PlaceholderMenuItem",
-                   "dojox.xml.parser"
-        ]
-    },{
-        name: "openils_full_dojo.js",
-        dependencies: [
-                   "dijit._Calendar",
-                   "dijit.Dialog",
-                   "dijit.form.Button",
-                   "dijit.form.CheckBox",
-                   "dijit.form.ComboBox",
-                   "dijit.form.CurrencyTextBox",
-                   "dijit.form.DateTextBox",
-                   "dijit.form.DropDownButton",
-                   "dijit.form.FilteringSelect",
-                   "dijit.form.Form",
-                   "dijit.form._FormWidget",
-                   "dijit.form.NumberSpinner",
-                   "dijit.form.NumberTextBox",
-                   "dijit.form.RadioButton",
-                   "dijit.form.Textarea",
-                   "dijit.form.TextBox",
-                   "dijit.form.TimeTextBox",
-                   "dijit.form.ValidationTextBox",
-                   "dijit.layout.BorderContainer",
-                   "dijit.layout.ContentPane",
-                   "dijit.layout.LayoutContainer",
-                   "dijit.layout.SplitContainer",
-                   "dijit.layout.StackContainer",
-                   "dijit.layout.TabContainer",
-                   "dijit.Menu",
-                   "dijit.MenuItem",
-                   "dijit.ProgressBar",
-                   "dijit._Templated",
-                   "dijit.Toolbar",
-                   "dijit.Tooltip",
-                   "dijit.TooltipDialog",
-                   "dijit.Tree",
-                   "dijit._Widget",
-                   "dojo.cookie",
-                   "dojo.data.ItemFileReadStore",
-                   "dojo.data.ItemFileWriteStore",
-                   "dojo.date",
-                   "dojo.date.locale",
-                   "dojo.date.stamp",
-                   "dojo.dnd.Container",
-                   "dojo.dnd.Source",
-                   "dojo.io.iframe",
-                   "dojo.io.script",
-                   "dojo.parser",
-                   "dojo.query",
-                   "dojo.string",
-                   "dojox.encoding.base64",
-                   "dojox.form.CheckedMultiSelect",
-                   "dojox.fx",
-                   "dojox.grid.cells.dijit",
-                   "dojox.grid.compat._data.dijitEditors",
-                   "dojox.grid.compat._data.editors",
-                   "dojox.grid.compat._data.model",
-                   "dojox.grid.DataGrid",
-                   "dojox.grid.Grid",
-                   "dojox.jsonPath",
-                   "dojox.string.sprintf",
-                   "dojox.widget.PlaceholderMenuItem",
-                   "dojox.widget.Toaster",
-                   "dojox.xml.parser"
-        ]
-    },{
-        name: "openils_opac_dojo.js",
-        dependencies: [
-                   "dijit._Calendar",
-                   "dijit.Dialog",
-                   "dijit.form.Button",
-                   "dijit.form.DateTextBox",
-                   "dijit.form.FilteringSelect",
-                   "dijit.form.TextBox",
-                   "dijit.Menu",
-                   "dojo.cookie",
-                   "dojo.date.locale",
-                   "dojo.date.stamp",
-                   "dojo.io.script",
-                   "dojo.parser"
-        ]
-    },{
-        name: "openils_dojo.js",
-        dependencies: [
-                   "dijit._Calendar",
-                   "dijit.Dialog",
-                   "dijit.form.Button",
-                   "dijit.form.DateTextBox",
-                   "dijit.form.FilteringSelect",
-                   "dijit.form.TextBox",
-                   "dijit.Menu",
-                   "dojo.cookie",
-                   "dojo.date.locale",
-                   "dojo.date.stamp",
-                   "dojo.io.script",
-                   "dojo.parser"
-        ]
-    },{
-        name: "openils_dojo_dojo.js",
-        dependencies: [
-                   "dijit.Dialog",
-                   "dijit.form.Button",
-                   "dijit.form.CheckBox",
-                   "dijit.form.CurrencyTextBox",
-                   "dijit.form.DateTextBox",
-                   "dijit.form.FilteringSelect",
-                   "dijit.form._FormWidget",
-                   "dijit.form.NumberSpinner",
-                   "dijit.form.NumberTextBox",
-                   "dijit.form.TextBox",
-                   "dijit.form.ValidationTextBox",
-                   "dijit.layout.ContentPane",
-                   "dijit.ProgressBar",
-                   "dijit._Templated",
-                   "dijit._Widget",
-                   "dojo.cookie",
-                   "dojo.data.ItemFileReadStore",
-                   "dojo.data.ItemFileWriteStore",
-                   "dojo.date.locale",
-                   "dojo.date.stamp",
-                   "dojo.query",
-                   "dojo.string",
-                   "dojox.grid.compat._data.dijitEditors",
-                   "dojox.grid.compat._data.editors",
-                   "dojox.grid.compat._data.model",
-                   "dojox.grid.DataGrid",
-                   "dojox.grid.Grid",
-                   "dojox.jsonPath",
-                   "dojox.xml.parser"
-        ]
-    }],
-    prefixes: [
-        [ "dijit", "../dijit" ],
-        [ "dojox", "../dojox" ]
-    ]
-};
-               
diff --git a/docs/RELEASE_NOTES_NEXT/Architecture/remove_custom_dojo.adoc b/docs/RELEASE_NOTES_NEXT/Architecture/remove_custom_dojo.adoc
new file mode 100644 (file)
index 0000000..fb5215b
--- /dev/null
@@ -0,0 +1,23 @@
+Removal of Custom Dojo Build
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Evergreen had a
+https://wiki.evergreen-ils.org/doku.php?id=scratchpad:random_magic_spells#custom_dojo_build[method
+of making a custom build of the Dojo JavaScript library].  Followiing
+this procedure could improve the load times for the OPAC and other
+interfaces that use Dojo.  However, very few sites took advantage of
+this process or even knew of its existence.
+
+As a part of the process, an `openils_dojo.js` file was built and
+installed along with the other Dojo files.  Evergreen had many
+references to load this optional file.  For the majority of sites that
+did not use this custom Dojo process, this file did not exist.
+Browsers would spend time and resources requesting this nonexistent
+file.  This situation also contributed noise to the Apache logs with
+the 404 errors from these requests.
+
+In keeping with the goal of eliminating Dojo from Evergreen, all
+references to `openils_dojo.js` have been removed from the OPAC and
+other files.  The profile script required to make the custom Dojo
+build has also been removed.
+