Kuali Rice Development
  1. Kuali Rice Development
  2. KULRICE-6417

License header update causing syntax problems in JS files

    Details

    • Type: Bug Fix Bug Fix
    • Status: Closed Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: Not version specific
    • Security Level: Public (Public: Anyone can view)
    • Labels:
      None
    • Similar issues:
      KULRICE-7183remove kuali license header from JS plugin files
      KULRICE-7357Handle naming of JS files to avoid problems caused by cached JS files
      KULRICE-8754Fix Docbook files affected by License Header Update Issue
      KULRICE-13955CI rice-2.5-license-ecl-header failing with NullPointerException
      KULRICE-3094put tlds and js files in special web/lib dir / update license header generation script to work with svn and ignore the dir with the tlds and js files that we didn't author
      KULRICE-6438Create folder structure for custom, library and modified library js files
      KULRICE-11555Update maven license plugin directories properties
      KULRICE-9291Jenkins license job section of top level pom.xml needs updating to exclude IngesterActionTest resource files and remove bad copyright header.
      KULRICE-8755Automatica License Header Job Incorrectly Added on Some Doc Book Files
      KULRICE-9404fix broken build due to license header update
    • KAI Review Status:
      Not Required
    • KTI Review Status:
      Not Required

      Description

      The license header updating caused a syntax problem in one of the js file (jquery.blockUI.js) that caused the JS not to work and basically broke all of KRAD. This has happened a few times before as well. We need to look into fixing this.

      Here is the output with the problem:

      /*

      • Copyright 2005-2012 The Kuali Foundation
        *
      • Licensed under the Educational Community License, Version 2.0 (the "License");
      • you may not use this file except in compliance with the License.
      • You may obtain a copy of the License at
        *
      • http://www.opensource.org/licenses/ecl2.php
        *
      • Unless required by applicable law or agreed to in writing, software
      • distributed under the License is distributed on an "AS IS" BASIS,
      • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      • See the License for the specific language governing permissions and
      • limitations under the License.
        */
        /*
      • Copyright 2005-2011 The Kuali Foundation
        *
      • Licensed under the Educational Community License, Version 2.0 (the "License");
      • you may not use this file except in compliance with the License.
      • You may obtain a copy of the License at
        *
      • http://www.opensource.org/licenses/ecl2.php
        *
      • Unless required by applicable law or agreed to in writing, software
      • distributed under the License is distributed on an "AS IS" BASIS,
      • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      • See the License for the specific language governing permissions and
      • limitations under the License.
        */
        /*!
      • jQuery blockUI plugin
      • Version 2.38 (29-MAR-2011)
      • @requires jQuery v1.2.3 or later
        *
      • Examples at: http://malsup.com/jquery/block/
      • Copyright (c) 2007-2010 M. Alsup
      • Dual licensed under the MIT and GPL licenses:
      • http://www.opensource.org/licenses/mit-license.php
      • http://www.gnu.org/licenses/gpl.html
        *
      • Thanks to Amir-Hossein Sobhi for some excellent contributions!
        */

      Notice the double license header the weird character between.

        Issue Links

          Activity

          Hide
          Leo Przybylski (Inactive) added a comment -

          Added an exclude for <exclude>*/jquery.js</exclude> to the license plugin in pom.xml

          Show
          Leo Przybylski (Inactive) added a comment - Added an exclude for <exclude>* /jquery .js</exclude> to the license plugin in pom.xml
          Hide
          Jessica Coltrin (Inactive) added a comment -

          According to Jeff, this only hits when there's a big change like the year change.

          Show
          Jessica Coltrin (Inactive) added a comment - According to Jeff, this only hits when there's a big change like the year change.
          Hide
          Jeff Caddel (Inactive) added a comment -

          Will look at this as part of the work related to prolog handling

          Show
          Jeff Caddel (Inactive) added a comment - Will look at this as part of the work related to prolog handling
          Hide
          Jessica Coltrin (Inactive) added a comment -

          Lowering priority and moving to 2.1 since this is not critical for 2.0.

          Show
          Jessica Coltrin (Inactive) added a comment - Lowering priority and moving to 2.1 since this is not critical for 2.0.
          Hide
          Jeff Caddel (Inactive) added a comment - - edited

          This is because that JS file has a Byte Order Mark (aka BOM) as its first character. Normally, a BOM is used to signal the endianness of the encoding, but since UTF-8 doesn't have any encoding issues, the BOM is unnecessary. Also, according to the Unicode standard, the BOM for UTF-8 files is not recommended:

          2.6 Encoding Schemes - Use of a BOM is neither required nor recommended for UTF-8...

          We're going to add a plugin execution to the nightly "license" CI job that will scan the source tree for files containing a BOM. If it finds one, the CI job will fail prior to executing the plugin that updates the license headers.

          This will prevent files containing a BOM from causing issues going forward.

          Show
          Jeff Caddel (Inactive) added a comment - - edited This is because that JS file has a Byte Order Mark (aka BOM) as its first character. Normally, a BOM is used to signal the endianness of the encoding, but since UTF-8 doesn't have any encoding issues, the BOM is unnecessary. Also, according to the Unicode standard , the BOM for UTF-8 files is not recommended: 2.6 Encoding Schemes - Use of a BOM is neither required nor recommended for UTF-8... We're going to add a plugin execution to the nightly "license" CI job that will scan the source tree for files containing a BOM. If it finds one, the CI job will fail prior to executing the plugin that updates the license headers. This will prevent files containing a BOM from causing issues going forward.
          Hide
          Jeff Caddel (Inactive) added a comment -

          If dev's happen to commit a file containing a BOM, the build logic will detect this and fail, instead of attempting to proceed.

          Show
          Jeff Caddel (Inactive) added a comment - If dev's happen to commit a file containing a BOM, the build logic will detect this and fail, instead of attempting to proceed.
          Hide
          Jessica Coltrin (Inactive) added a comment -

          reopening so I can remove the CM 1.1 fix version.

          Show
          Jessica Coltrin (Inactive) added a comment - reopening so I can remove the CM 1.1 fix version.
          Hide
          Jessica Coltrin (Inactive) added a comment -

          re-closing

          Show
          Jessica Coltrin (Inactive) added a comment - re-closing

            People

            • Assignee:
              Jeff Caddel (Inactive)
              Reporter:
              Jerry Neal (Inactive)
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Structure Helper Panel