Vue console 2.2.0: Legacy parity, build-log search, Cypress gate, Maps removed

.circleci/config.yml

@@ -97,20 +97,21 @@ jobs:
       - run:
           name: Install dependencies and build
           command: |
-            export ENV NODE_OPTIONS=--openssl-legacy-provider
+            export NODE_OPTIONS=--openssl-legacy-provider
             cd vue
             yarn
+            # Node unit suites, no browser (35 WR-07). LC_ALL=C pins
+            # toLocaleString, which log-paging-store.cjs compares against.
+            LC_ALL=C yarn test:unit
+            LC_ALL=C node ../src/test/deploykey.cjs
+            LC_ALL=C node ../src/test/legacy-close-out.cjs
             yarn build:perf
-            yarn test
+            yarn test:ci
 
       - store_test_results:
                 name: Collect test results
-                path: ./vue/coverage
-
-          # The `path` key is an absolute or relative path to your working_directory containing 
-          # subdirectories of JUnit XML or Cucumber JSON test metadata files,
-          # or the path of a single file containing all test results.
-          # Make sure that your path value is not a hidden folder (example: .my_hidden_directory would be an invalid format).
+                # The Cypress JUnit files written by cy:test:ci (one per spec file).
+                path: ./vue/cypress/results
 
       - store_artifacts:
           name: Collect screenshots
@@ -179,9 +180,11 @@ workflows:
       #         only:
       #           - thinx-staging
 
+      # No context (48-REVIEW WR-03): this job runs yarn with no lockfile, so unpinned
+      # dependencies' lifecycle scripts run here, and no step needs a credential. The
+      # Cypress suites stub the API; the parent repo's test-vue-console runs them the same way.
       - test_vue:
           name: Test Vue console
-          context: sonarcloud
 
       # - ggshield/scan:
       #     name: Scan using Gitguardian shield
@@ -212,7 +215,6 @@ workflows:
           context:
             - dockerhub
             - thinx-docker-repo
-            - sonarcloud
             - console
           requires:
             - Test Vue console

.gitignore

@@ -8,6 +8,7 @@ html
 src/.nyc_output
 src/cypress/screenshots
 src/cypress/videos
+src/cypress/.env.test
 yarn.lock
 .dccache
 settings.json

src/app/js/controllers/ChannelController.js

@@ -13,7 +13,6 @@ angular.module( "RTM" ).controller( "ChannelController", [ "$rootScope", "$scope
 
     Thinx.channelList()
     .done( function( data ) {
-      console.log( "+++ updateChannels " );
       $scope.$emit( "updateChannels", data );
     } )
     .fail( error => $scope.$emit( "xhrFailed", error ) );
@@ -33,7 +32,6 @@ angular.module( "RTM" ).controller( "ChannelController", [ "$rootScope", "$scope
             console.log( response );
             Thinx.channelList()
               .done( function( data ) {
-                console.log( "+++ updateChannels " );
                 $scope.$emit( "updateChannels", data );
               } )
               .fail( error => $scope.$emit( "xhrFailed", error ) );
@@ -69,7 +67,6 @@ angular.module( "RTM" ).controller( "ChannelController", [ "$rootScope", "$scope
 
         Thinx.channelList()
         .done( function( data ) {
-          console.log( "+++ updateChannels " );
           $scope.$emit( "updateChannels", data );
         } )
         .fail( error => $scope.$emit( "xhrFailed", error ) );

src/app/js/controllers/DeploykeyController.js

@@ -13,7 +13,6 @@ angular.module( "RTM" ).controller( "DeploykeyController", [ "$rootScope", "$sco
 
     Thinx.deploykeyList()
     .done( function( data ) {
-      console.log( "+++ updateDeploykeys " );
       $scope.$emit( "updateDeploykeys", data );
     } )
     .fail( error => $scope.$emit( "xhrFailed", error ) );
@@ -24,45 +23,118 @@ angular.module( "RTM" ).controller( "DeploykeyController", [ "$rootScope", "$sco
 
   $scope.searchText = "";
 
-  $scope.createDeploykey = function() {
-
-    console.log( "--creating deploy key--" );
-
-    Thinx.createDeploykey()
-    .done( function( response ) {
+  // Deploy key names (v1.18 Phase 48, D-09, UI-C18, 35 IN-03/IN-04). The sentences mirror
+  // vue/src/utils/keyNames.js word for word (src/test/deploykey.cjs D10 compares them); the
+  // server (RSAKey.validateKeyName) stays the authority, this check only saves a round trip.
+  var KEY_NAME_MAX = 120;
+  var KEY_NAME_MESSAGES = {
+    empty: "Enter a name for the key.",
+    too_long: "The name is longer than 120 characters.",
+    control_chars: "The name contains a control character, such as a tab or a line break.",
+    line_separator: "The name contains a hidden line or paragraph separator.",
+    bidi: "The name contains a hidden direction-override character.",
+    invisible: "The name contains an invisible character, such as a zero-width space.",
+    reserved: "This name is reserved for the key's default label. Choose a different name."
+  };
+  var KEY_NAME_FALLBACK = "This name is not allowed. Choose a different name.";
+  var CREATE_FAILED = "Could not generate the deploy key. Try again.";
+  // Phase 40 D-03: OpenBao unavailable or key generation switched off (503). The fixed
+  // sentence only; the code and any OpenBao detail are never shown.
+  var KEY_SERVICE_UNAVAILABLE = "Deploy keys can't be created right now, try again later.";
+
+  // The reason the trimmed name is refused before sending, or null.
+  // Code units are compared as numbers on purpose: a regular expression with a
+  // control-character class trips Codacy no-control-regex (quick 261012-r9z).
+  function keyNameProblem( name ) {
+    for ( var i = 0; i < name.length; i++ ) {
+      var c = name.charCodeAt( i );
+      if ( c < 0x20 || c === 0x7F ) {
+        return "control_chars";
+      }
+    }
+    if ( name.length > KEY_NAME_MAX ) {
+      return "too_long";
+    }
+    return null;
+  }
 
-      response = JSON.parse( response );
+  // The fixed sentence for a refusal reason; never the reason code itself.
+  function keyNameSentence( reason ) {
+    if ( typeof reason === "string" && Object.prototype.hasOwnProperty.call( KEY_NAME_MESSAGES, reason ) ) {
+      return KEY_NAME_MESSAGES[ reason ];
+    }
+    return KEY_NAME_FALLBACK;
+  }
 
-      if ( typeof( response ) !== "undefined" ) {
-        if ( response.success ) {
-          console.log( response );
-          toastr.success( "Key created.", "<ENV::loginPageTitle>", { timeOut: 5000 } );
+  // One fixed sentence, written as text (toastr renders HTML, so no reply field goes in).
+  function showCreateError( sentence ) {
+    $( ".msg-warning" ).text( sentence );
+    $( ".msg-warning" ).show();
+    toastr.error( sentence, "<ENV::loginPageTitle>", { timeOut: 5000 } );
+  }
 
-          $scope.deploykeyCreated = response.status.name;
-          $scope.deploykeyValue = response.status.pubkey;
+  $scope.createDeploykey = function() {
 
-          Thinx.deploykeyList()
-          .done( function( data ) {
-            console.log( "+++ updateDeploykeys " );
-            $scope.$emit( "updateDeploykeys", data );
-          } )
-          .fail( error => $scope.$emit( "xhrFailed", error ) );
+    console.log( "--creating deploy key--" );
 
+    if ($scope.creatingDeploykey || !$scope.deploykeyName || !$scope.deploykeyName.trim()) return;
+    var name = $scope.deploykeyName.trim();
+    var problem = keyNameProblem( name );
+    if ( problem !== null ) {
+      showCreateError( keyNameSentence( problem ) );
+      return;
+    }
+    $scope.creatingDeploykey = true;
+    Thinx.createDeploykey( name )
+    .done( function( response ) {
+      // jQuery does not wrap .done callbacks: a throw here would skip .always, so the
+      // reset lives in finally as well (35 IN-03).
+      try {
+        if ( response && response.success ) {
+          var key = response.response || response.status;
+          if ( !key || typeof key !== "object" || !key.pubkey ) {
+            showCreateError( CREATE_FAILED );
+          } else {
+            toastr.success( "Key created.", "<ENV::loginPageTitle>", { timeOut: 5000 } );
+
+            $scope.deploykeyCreated = key.date || key.name;
+            $scope.deploykeyValue = key.pubkey;
+
+            Thinx.deploykeyList()
+            .done( function( data ) {
+              $scope.$emit( "updateDeploykeys", data );
+            } )
+            .fail( error => $scope.$emit( "xhrFailed", error ) );
+          }
+        } else if ( response && response.response === "invalid_key_name" ) {
+          showCreateError( keyNameSentence( response.reason ) );
+        } else if ( response && response.response === "key_service_unavailable" ) {
+          showCreateError( KEY_SERVICE_UNAVAILABLE );
         } else {
-          console.log( response.status );
-          toastr.error( "Error.", "<ENV::loginPageTitle>", { timeOut: 5000 } );
+          showCreateError( CREATE_FAILED );
         }
+      } catch ( e ) {
+        showCreateError( CREATE_FAILED );
+      } finally {
+        $scope.creatingDeploykey = false;
+        $scope.$applyAsync();
+      }
+    } )
+    .fail( function( jqXHR ) {
+      var body = jqXHR && jqXHR.responseJSON;
+      if ( body && body.response === "invalid_key_name" ) {
+        showCreateError( keyNameSentence( body.reason ) );
+      } else if ( body && body.response === "key_service_unavailable" ) {
+        showCreateError( KEY_SERVICE_UNAVAILABLE );
       } else {
-        console.log( "error" );
-        console.log( response );
+        showCreateError( CREATE_FAILED );
       }
+      $scope.$emit( "xhrFailed", jqXHR );
     } )
-    .fail( function( error ) {
-      $( ".msg-warning" ).text( error );
-      $( ".msg-warning" ).show();
-      $scope.$emit( "xhrFailed", error );
-      toastr.error( "Error.", "<ENV::loginPageTitle>", { timeOut: 5000 } );
-    } );
+    .always(function() {
+      $scope.creatingDeploykey = false;
+      $scope.$applyAsync();
+    });
 
   };
 
@@ -80,7 +152,6 @@ angular.module( "RTM" ).controller( "DeploykeyController", [ "$rootScope", "$sco
 
         Thinx.deploykeyList()
         .done( function( data ) {
-          console.log( "+++ updateDeploykeys " );
           $scope.$emit( "updateDeploykeys", data );
         } )
         .fail( error => $scope.$emit( "xhrFailed", error ) );
@@ -116,6 +187,8 @@ angular.module( "RTM" ).controller( "DeploykeyController", [ "$rootScope", "$sco
   };
 
   $scope.resetModal = function() {
+    $scope.deploykeyName = "";
+    $scope.creatingDeploykey = false;
     $scope.deploykeyCreated = null;
     $scope.deploykeyValue = null;
     $scope.selectedItems = [];

src/app/js/controllers/DeviceController.js

@@ -12,21 +12,18 @@ angular.module( "RTM" ).controller( "DeviceController", [ "$rootScope", "$scope"
 
     Thinx.sourceList()
     .done( function( data ) {
-      console.log( "+++ updateSources " );
       $scope.$emit( "updateSources", data );
     } )
     .fail( error => $scope.$emit( "xhrFailed", error ) );
 
     Thinx.apikeyList()
     .done( function( data ) {
-      console.log( "+++ updateApikeys " );
       $scope.$emit( "updateApikeys", data );
     } )
     .fail( error => $scope.$emit( "xhrFailed", error ) );
 
     Thinx.channelList()
     .done( function( data ) {
-      console.log( "+++ updateChannels " );
       $scope.$emit( "updateChannels", data );
     } )
     .fail( error => $scope.$emit( "xhrFailed", error ) );
@@ -722,7 +719,6 @@ angular.module( "RTM" ).controller( "DeviceController", [ "$rootScope", "$scope"
     // refresh latest firmware envelope
     Thinx.getLatestFirmwareEnvelope( $scope.deviceForm.udid )
     .done( function( data ) {
-      console.log( "+++ updateLatestFirmwareEnvelope " );
       $scope.$emit( "updateLatestFirmwareEnvelope", data );
     } )
     .fail( error => $scope.$emit( "xhrFailed", error ) );

src/app/js/controllers/DevicesController.js

@@ -5,14 +5,12 @@ angular.module( "RTM" ).controller( "DevicesController", [ "$rootScope", "$scope
 
     Thinx.sourceList()
     .done( function( data ) {
-      console.log( "+++ updateSources " );
       $scope.$emit( "updateSources", data );
     } )
     .fail( error => $scope.$emit( "xhrFailed", error ) );
 
     Thinx.apikeyList()
     .done( function( data ) {
-      console.log( "+++ updateApikeys " );
       $scope.$emit( "updateApikeys", data );
     } )
     .fail( error => $scope.$emit( "xhrFailed", error ) );
@@ -114,8 +112,10 @@ angular.module( "RTM" ).controller( "DevicesController", [ "$rootScope", "$scope
             }
           }
 
+          // The build reply carries no status field (Phase 43 carry, D-09, UI-C19): fixed copy only,
+          // no reply value reaches toastr (it renders HTML).
           toastr.info(
-            response.status + "<br><br>Click to show build log...",
+            ( response.response === "queued" ? "Build queued." : "Build started." ) + "<br><br>Click to show build log...",
             "THiNX Builder",
             {
               timeOut: 3000,
@@ -132,7 +132,9 @@ angular.module( "RTM" ).controller( "DevicesController", [ "$rootScope", "$scope
           $scope.$apply();
         } else {
           console.log( response );
-          toastr.error( response.status, "<ENV::loginPageTitle>", { timeOut: 5000 } );
+          // A refused build replies { success: false, response: "<reason>" } with no status
+          // field: one fixed sentence, no reply value reaches toastr (48-REVIEW WR-04).
+          toastr.error( "Build failed.", "<ENV::loginPageTitle>", { timeOut: 5000 } );
         }
       } else {
         console.log( "error" );