all files / src/gatherers/ accessibility.js

100% Statements 18/18
100% Branches 4/4
100% Functions 5/5
100% Lines 18/18
2 statements, 2 functions Ignored     
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72                                                                                                           
/**
 * @license
 * Copyright 2016 Google Inc. All rights reserved.
 *
 * Licensed under the Apache 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.apache.org/licenses/LICENSE-2.0
 *
 * 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.
 */
'use strict';
 
/* global document, __returnResults */
 
const Gather = require('./gather');
const fs = require('fs');
const axe = fs.readFileSync(
  require.resolve('axe-core/axe.min.js')
);
 
// This is run in the page, not Lighthouse itself.
/* istanbul ignore next */
function runA11yChecks() {
  axe.a11yCheck(document, function(results) {
    // __returnResults is magically inserted by driver.evaluateAsync
    __returnResults(results);
  });
}
 
class Accessibility extends Gather {
  get name() {
    return 'accessibility';
  }
 
  static _errorAccessibility(errorString) {
    return {
      raw: undefined,
      value: undefined,
      debugString: errorString
    };
  }
 
  postProfiling(options) {
    const driver = options.driver;
 
    return driver
        .evaluateAsync(`${axe};(${runA11yChecks.toString()}())`)
        .then(returnedValue => {
          if (!returnedValue) {
            this.artifact = Accessibility._errorAccessibility('Unable to parse axe results');
            return;
          }
 
          if (returnedValue.error) {
            this.artifact = Accessibility._errorAccessibility(returnedValue.error);
          } else {
            this.artifact = returnedValue;
          }
        }, _ => {
          this.artifact = Accessibility._errorAccessibility('Axe results timed out');
        });
  }
}
 
module.exports = Accessibility;