Merge pull request #768 from ossf/remove_yaml_lib

Remove YAML processing library

Author: david-a-wheeler

docs/labs/argument-injection.html

@@ -5,7 +5,6 @@
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <link rel="stylesheet" href="https://best.openssf.org/assets/css/style.css">
 <link rel="stylesheet" href="checker.css">
-<script src="js-yaml.min.js"></script>
 <script src="checker.js"></script>
 <script src="argument-injection.js"></script>
 <link rel="license" href="https://creativecommons.org/licenses/by/4.0/">

docs/labs/assert.html

@@ -5,7 +5,6 @@
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <link rel="stylesheet" href="https://best.openssf.org/assets/css/style.css">
 <link rel="stylesheet" href="checker.css">
-<script src="js-yaml.min.js"></script>
 <script src="checker.js"></script>
 <script src="assert.js"></script>
 <link rel="license" href="https://creativecommons.org/licenses/by/4.0/">

docs/labs/checker.js

@@ -598,30 +598,10 @@ function processHints(requestedHints) {
     return compiledHints;
 }
 
-/** Load and parse YAML data, return result to be placed in "info".
- * @info: String with YAML (including JSON) data to use
- */
-function processYamlToInfo(configurationInfo) {
-    // This would only allow JSON, but then we don't need to load YAML lib:
-    // let parsedJson = JSON.parse(configurationInfo);
-
-    let parsedData; // Parsed data, *if* we manage to parse it.
-    try {
-        parsedData = jsyaml.load(configurationInfo);
-    }
-    catch (e) {
-        showDebugOutput(
-            `Lab Error: Cannot process YAML of info.\n${e}`);
-        throw e; // Rethrow, so containing browser also gets exception
-    }
-
-    return parsedData;
-}
-
 /** Set global values based on other than "correct" and "expected" values.
  * The correct and expected values may come from elsewhere, but we have to set up the
  * info-based values first, because info can change how those are interpreted.
- * @info: String with YAML (including JSON) data to use
+ * @configurationInfo: Data to use
  */
 function processInfo(configurationInfo) {
     const allowedInfoFields = new Set([
@@ -746,17 +726,12 @@ function runSelftest() {
  * The "info" data includes the regex preprocessing steps, hints, etc.
  */
 function setupInfo() {
-    // We must load info *first*, because it can affect how other things
-    // (like pattern preprocessing) is handled.
-
-    // Deprecated approach: Load embedded "info" data in YAML file.
-    // If there is "info" data embedded in the HTML (e.g., hints),
-    // load it & set up global variable hints.
-    let infoElement = document.getElementById('info');
-    if (infoElement) {
-        let configurationYamlText = infoElement.textContent;
-        // Set global variable "info"
-        info = processYamlToInfo(configurationYamlText);
+    // We no longer need a *separate* step to load info, we presume the
+    // HTML loaded it.
+    // As a safety check, let's make sure some data *was* loaded.
+
+    if (Object.keys(info).length == 0) {
+        alert(`ERROR: info has no values set. Load/modify your lab .js file.`);
     };
 
     // If an "info2" exists, report any differences between it and "info".
@@ -768,7 +743,6 @@ function setupInfo() {
         }
     };
 
-
     // Set global values *except* correct and expected arrays
     processInfo(info);
 
@@ -830,8 +804,10 @@ function initPage() {
         attempt.oninput = runCheck;
         current++;
     }
-    for (let hintButton of document.querySelectorAll("button.hintButton")) {
+    for (let hintButton of document.querySelectorAll("button.hintButton")){
         hintButton.addEventListener('click', (e) => { showHint(e); });
+        // Precompute inputIndexes to work around problems that occur
+        // if a user uses a browser's built-in natural language translation.
         // Presumes button's parent is the form
         hintButton.dataset.inputIndexes = findIndexes(hintButton.parentNode);
         if (!hintButton.title) {

docs/labs/conversion.html

@@ -5,7 +5,6 @@
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <link rel="stylesheet" href="https://best.openssf.org/assets/css/style.css">
 <link rel="stylesheet" href="checker.css">
-<script src="js-yaml.min.js"></script>
 <script src="checker.js"></script>
 <script src="conversion.js"></script>
 <link rel="license" href="https://creativecommons.org/licenses/by/4.0/">

docs/labs/csp1.html

@@ -5,7 +5,6 @@
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <link rel="stylesheet" href="https://best.openssf.org/assets/css/style.css">
 <link rel="stylesheet" href="checker.css">
-<script src="js-yaml.min.js"></script>
 <script src="checker.js"></script>
 <script src="csp1.js"></script>
 <link rel="license" href="https://creativecommons.org/licenses/by/4.0/">

docs/labs/deserialization.html

@@ -5,7 +5,6 @@
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <link rel="stylesheet" href="https://best.openssf.org/assets/css/style.css">
 <link rel="stylesheet" href="checker.css">
-<script src="js-yaml.min.js"></script>
 <script src="checker.js"></script>
 <script src="deserialization.js"></script>
 <link rel="license" href="https://creativecommons.org/licenses/by/4.0/">

docs/labs/format-strings.html

@@ -5,7 +5,6 @@
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <link rel="stylesheet" href="https://best.openssf.org/assets/css/style.css">
 <link rel="stylesheet" href="checker.css">
-<script src="js-yaml.min.js"></script>
 <script src="checker.js"></script>
 <script src="format-strings.js"></script>
 <link rel="license" href="https://creativecommons.org/licenses/by/4.0/">

docs/labs/free.html

@@ -5,7 +5,6 @@
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <link rel="stylesheet" href="https://best.openssf.org/assets/css/style.css">
 <link rel="stylesheet" href="checker.css">
-<script src="js-yaml.min.js"></script>
 <script src="checker.js"></script>
 <script src="free.js"></script>
 <link rel="license" href="https://creativecommons.org/licenses/by/4.0/">

docs/labs/handling-errors.html

@@ -5,7 +5,6 @@
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <link rel="stylesheet" href="https://best.openssf.org/assets/css/style.css">
 <link rel="stylesheet" href="checker.css">
-<script src="js-yaml.min.js"></script>
 <script src="checker.js"></script>
 <script src="handling-errors.js"></script>
 <link rel="license" href="https://creativecommons.org/licenses/by/4.0/">

docs/labs/hardcoded.html

@@ -5,7 +5,6 @@
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <link rel="stylesheet" href="https://best.openssf.org/assets/css/style.css">
 <link rel="stylesheet" href="checker.css">
-<script src="js-yaml.min.js"></script>
 <script src="checker.js"></script>
 <script src="hardcoded.js"></script>
 <link rel="license" href="https://creativecommons.org/licenses/by/4.0/">