reg-cli 0.18.16 → 0.19.0-rc1

package/dist/index.js

@@ -1,200 +0,0 @@
-"use strict";
-
-var _glob = _interopRequireDefault(require("glob"));
-var _makeDir = _interopRequireDefault(require("make-dir"));
-var _del = require("del");
-var _fs = _interopRequireDefault(require("fs"));
-var _path = _interopRequireDefault(require("path"));
-var _lodash = require("lodash");
-var _log = _interopRequireDefault(require("./log"));
-var _report = _interopRequireDefault(require("./report"));
-var _bluebird = _interopRequireDefault(require("bluebird"));
-var _events = _interopRequireDefault(require("events"));
-var _processAdaptor = _interopRequireDefault(require("./process-adaptor"));
-var _imageFinder = require("./image-finder");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-// $FlowIgnore
-// $FlowIgnore
-// $FlowIgnore
-// $FlowIgnore
-var copyImages = (actualImages, {
-  expectedDir,
-  actualDir
-}) => {
-  return Promise.all(actualImages.map(image => new Promise((resolve, reject) => {
-    try {
-      _makeDir.default.sync(_path.default.dirname(_path.default.join(expectedDir, image)));
-      var writeStream = _fs.default.createWriteStream(_path.default.join(expectedDir, image));
-      _fs.default.createReadStream(_path.default.join(actualDir, image)).pipe(writeStream);
-      writeStream.on('finish', err => {
-        if (err) reject(err);
-        resolve();
-      });
-    } catch (err) {
-      reject(err);
-    }
-  })));
-};
-var compareImages = (emitter, {
-  expectedImages,
-  actualImages,
-  dirs,
-  matchingThreshold,
-  thresholdPixel,
-  thresholdRate,
-  concurrency,
-  enableAntialias
-}) => {
-  var images = actualImages.filter(actualImage => expectedImages.includes(actualImage));
-  concurrency = images.length < 20 ? 1 : concurrency || 4;
-  var processes = (0, _lodash.range)(concurrency).map(() => new _processAdaptor.default(emitter));
-  return _bluebird.default.map(images, image => {
-    var p = processes.find(p => !p.isRunning());
-    if (p) {
-      return p.run({
-        ...dirs,
-        image,
-        matchingThreshold,
-        thresholdRate,
-        thresholdPixel,
-        enableAntialias
-      });
-    }
-  }, {
-    concurrency
-  }).then(result => {
-    processes.forEach(p => p.close());
-    return result;
-  }).filter(r => !!r);
-};
-var cleanupExpectedDir = (expectedDir, changedFiles) => {
-  var paths = changedFiles.map(image => {
-    var directories = expectedDir.split("\\");
-    return escapeGlob(_path.default.posix.join(...directories, image));
-  });
-  // force: true needed to allow deleting outside working directory
-  return (0, _del.deleteAsync)(paths, {
-    force: true
-  });
-};
-var escapeGlob = fileName => {
-  return fileName.replace(/(\*)/g, '[$1]').replace(/(\*)/g, '[$1]').replace(/(\?)/g, '[$1]').replace(/(\[)/g, '[$1]').replace(/(\])/g, '[$1]').replace(/(\{)/g, '[$1]').replace(/(\})/g, '[$1]').replace(/(\))/g, '[$1]').replace(/(\()/g, '[$1]').replace(/(\!)/g, '[$1]');
-};
-var aggregate = result => {
-  var passed = result.filter(r => r.passed).map(r => r.image);
-  var failed = result.filter(r => !r.passed).map(r => r.image);
-  var diffItems = failed.map(image => image.replace(/\.[^\.]+$/, '.png'));
-  return {
-    passed,
-    failed,
-    diffItems
-  };
-};
-var updateExpected = ({
-  actualDir,
-  expectedDir,
-  diffDir,
-  deletedImages,
-  newImages,
-  diffItems
-}) => {
-  return cleanupExpectedDir(expectedDir, [...deletedImages, ...diffItems]).then(() => copyImages([...newImages, ...diffItems], {
-    actualDir,
-    expectedDir,
-    diffDir
-  })).then(() => {
-    _log.default.success(`\nAll images are updated. `);
-  });
-};
-module.exports = params => {
-  var {
-    actualDir,
-    expectedDir,
-    diffDir,
-    json,
-    concurrency = 4,
-    update,
-    report,
-    junitReport,
-    extendedErrors,
-    urlPrefix,
-    threshold,
-    matchingThreshold = 0,
-    thresholdRate,
-    thresholdPixel,
-    enableAntialias,
-    enableClientAdditionalDetection
-  } = params;
-  var dirs = {
-    actualDir,
-    expectedDir,
-    diffDir
-  };
-  var emitter = new _events.default();
-  var {
-    expectedImages,
-    actualImages,
-    deletedImages,
-    newImages
-  } = (0, _imageFinder.findImages)(expectedDir, actualDir);
-  _makeDir.default.sync(expectedDir);
-  _makeDir.default.sync(diffDir);
-  setImmediate(() => emitter.emit('start'));
-  compareImages(emitter, {
-    expectedImages,
-    actualImages,
-    dirs,
-    matchingThreshold,
-    thresholdRate: thresholdRate || threshold,
-    thresholdPixel,
-    concurrency,
-    enableAntialias: !!enableAntialias
-  }).then(result => aggregate(result)).then(({
-    passed,
-    failed,
-    diffItems
-  }) => {
-    return (0, _report.default)({
-      passedItems: passed,
-      failedItems: failed,
-      newItems: newImages,
-      deletedItems: deletedImages,
-      expectedItems: update ? actualImages : expectedImages,
-      actualItems: actualImages,
-      diffItems,
-      json: json || './reg.json',
-      actualDir,
-      expectedDir,
-      diffDir,
-      report: report || '',
-      junitReport: junitReport || '',
-      extendedErrors: !!extendedErrors,
-      urlPrefix: urlPrefix || '',
-      enableClientAdditionalDetection: !!enableClientAdditionalDetection
-    });
-  }).then(result => {
-    deletedImages.forEach(image => emitter.emit('compare', {
-      type: 'delete',
-      path: image
-    }));
-    newImages.forEach(image => emitter.emit('compare', {
-      type: 'new',
-      path: image
-    }));
-    if (update) {
-      return updateExpected({
-        actualDir,
-        expectedDir,
-        diffDir,
-        deletedImages,
-        newImages,
-        diffItems: result.diffItems
-      }).then(() => {
-        emitter.emit('update');
-        return result;
-      });
-    }
-    return result;
-  }).then(result => emitter.emit('complete', result)).catch(err => emitter.emit('error', err));
-  return emitter;
-};

package/dist/log.js

@@ -1,21 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var chalk = require('chalk');
-var _default = exports.default = {
-  info(text) {
-    console.log(chalk.cyan(text));
-  },
-  warn(text) {
-    console.log(chalk.gray(text));
-  },
-  success(text) {
-    console.log(chalk.green(text));
-  },
-  fail(text) {
-    console.log(chalk.red(text));
-  }
-};

package/dist/process-adaptor.js

@@ -1,40 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _child_process = require("child_process");
-var _path = _interopRequireDefault(require("path"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-// $FlowIgnore
-class ProcessAdaptor {
-  constructor(emitter) {
-    this._process = (0, _child_process.fork)(_path.default.resolve(__dirname, './diff.js'));
-    this._isRunning = false;
-    this._emitter = emitter;
-  }
-  isRunning() {
-    return this._isRunning;
-  }
-  run(params) {
-    return new Promise((resolve, reject) => {
-      this._isRunning = true;
-      if (!this._process || !this._process.send) resolve();
-      this._process.send(params);
-      this._process.once('message', result => {
-        this._isRunning = false;
-        this._emitter.emit('compare', {
-          type: result.passed ? 'pass' : 'fail',
-          path: result.image
-        });
-        resolve(result);
-      });
-    });
-  }
-  close() {
-    if (!this._process || !this._process.kill) return;
-    this._process.kill();
-  }
-}
-exports.default = ProcessAdaptor;

package/dist/report.js

@@ -1,170 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _mustache = _interopRequireDefault(require("mustache"));
-var detectDiff = _interopRequireWildcard(require("x-img-diff-js"));
-var _fs = _interopRequireDefault(require("fs"));
-var _makeDir = _interopRequireDefault(require("make-dir"));
-var _path = _interopRequireDefault(require("path"));
-var xmlBuilder = _interopRequireWildcard(require("xmlbuilder2"));
-function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-// $FlowIgnore
-// $FlowIgnore
-// $FlowIgnore
-var loadFaviconAsDataURL = type => {
-  var fname = _path.default.resolve(__dirname, `../report/assets/favicon_${type}.png`);
-  var buffer = _fs.default.readFileSync(fname);
-  return 'data:image/png;base64,' + buffer.toString('base64');
-};
-var encodeFilePath = filePath => {
-  return filePath.split(_path.default.sep).map(p => encodeURIComponent(p)).join(_path.default.sep);
-};
-var createJSONReport = params => {
-  return {
-    failedItems: params.failedItems,
-    newItems: params.newItems,
-    deletedItems: params.deletedItems,
-    passedItems: params.passedItems,
-    expectedItems: params.expectedItems,
-    actualItems: params.actualItems,
-    diffItems: params.diffItems,
-    actualDir: `${params.urlPrefix}${_path.default.relative(_path.default.dirname(params.json), params.actualDir)}`,
-    expectedDir: `${params.urlPrefix}${_path.default.relative(_path.default.dirname(params.json), params.expectedDir)}`,
-    diffDir: `${params.urlPrefix}${_path.default.relative(_path.default.dirname(params.json), params.diffDir)}`
-  };
-};
-var createHTMLReport = params => {
-  var file = _path.default.join(__dirname, '../template/template.html');
-  var js = _fs.default.readFileSync(_path.default.join(__dirname, '../report/ui/dist/report.js'));
-  var css = _fs.default.readFileSync(_path.default.join(__dirname, '../report/ui/dist/style.css'));
-  var template = _fs.default.readFileSync(file);
-  var json = {
-    type: params.failedItems.length === 0 ? 'success' : 'danger',
-    hasNew: params.newItems.length > 0,
-    newItems: params.newItems.map(item => ({
-      raw: item,
-      encoded: encodeFilePath(item)
-    })),
-    hasDeleted: params.deletedItems.length > 0,
-    deletedItems: params.deletedItems.map(item => ({
-      raw: item,
-      encoded: encodeFilePath(item)
-    })),
-    hasPassed: params.passedItems.length > 0,
-    passedItems: params.passedItems.map(item => ({
-      raw: item,
-      encoded: encodeFilePath(item)
-    })),
-    hasFailed: params.failedItems.length > 0,
-    failedItems: params.failedItems.map(item => ({
-      raw: item,
-      encoded: encodeFilePath(item)
-    })),
-    actualDir: params.fromJSON ? params.actualDir : `${params.urlPrefix}${_path.default.relative(_path.default.dirname(params.report), params.actualDir)}`,
-    expectedDir: params.fromJSON ? params.expectedDir : `${params.urlPrefix}${_path.default.relative(_path.default.dirname(params.report), params.expectedDir)}`,
-    diffDir: params.fromJSON ? params.diffDir : `${params.urlPrefix}${_path.default.relative(_path.default.dirname(params.report), params.diffDir)}`,
-    ximgdiffConfig: {
-      enabled: params.enableClientAdditionalDetection,
-      workerUrl: `${params.urlPrefix}worker.js`
-    }
-  };
-  var faviconType = json.hasFailed || json.hasNew || json.hasDeleted ? 'failure' : 'success';
-  var view = {
-    js,
-    css,
-    report: JSON.stringify(json),
-    faviconData: loadFaviconAsDataURL(faviconType)
-  };
-  return _mustache.default.render(template.toString(), view);
-};
-var createJunitReport = params => {
-  var failedTests = params.failedItems.length + params.newItems.length + params.deletedItems.length;
-  var numberOfTests = failedTests + params.passedItems.length;
-  var doc = xmlBuilder.create({
-    version: '1.0'
-  });
-  var testsuitesElement = doc.ele('testsuites', {
-    name: 'reg-cli tests',
-    tests: numberOfTests,
-    failures: failedTests
-  });
-  var testsuiteElement = testsuitesElement.ele('testsuite', {
-    name: 'reg-cli',
-    tests: numberOfTests,
-    failures: failedTests
-  });
-  params.failedItems.forEach(item => {
-    addFailedJunitTestElement(testsuiteElement, item, 'failed');
-  });
-  params.newItems.forEach(item => {
-    if (params.extendedErrors) {
-      addFailedJunitTestElement(testsuiteElement, item, 'newItem');
-    } else {
-      addPassedJunitTestElement(testsuiteElement, item);
-    }
-  });
-  params.deletedItems.forEach(item => {
-    if (params.extendedErrors) {
-      addFailedJunitTestElement(testsuiteElement, item, 'deletedItem');
-    } else {
-      addPassedJunitTestElement(testsuiteElement, item);
-    }
-  });
-  params.passedItems.forEach(item => {
-    addPassedJunitTestElement(testsuiteElement, item);
-  });
-  return doc.end({
-    prettyPrint: true
-  });
-};
-function addPassedJunitTestElement(testsuiteElement, item) {
-  testsuiteElement.ele('testcase', {
-    name: item
-  });
-}
-function addFailedJunitTestElement(testsuiteElement, item, reason) {
-  testsuiteElement.ele('testcase', {
-    name: item
-  }).ele('failure', {
-    message: reason
-  });
-}
-function createXimdiffWorker(params) {
-  var file = _path.default.join(__dirname, '../template/worker_pre.js');
-  var moduleJs = _fs.default.readFileSync(_path.default.join(__dirname, '../report/ui/dist/worker.js'), 'utf8');
-  var wasmLoaderJs = _fs.default.readFileSync(detectDiff.getBrowserJsPath(), 'utf8');
-  var template = _fs.default.readFileSync(file);
-  var ximgdiffWasmUrl = `${params.urlPrefix}detector.wasm`;
-  return _mustache.default.render(template.toString(), {
-    ximgdiffWasmUrl
-  }) + '\n' + moduleJs + '\n' + wasmLoaderJs;
-}
-var _default = params => {
-  if (!!params.report) {
-    var html = createHTMLReport(params);
-    _makeDir.default.sync(_path.default.dirname(params.report));
-    _fs.default.writeFileSync(params.report, html);
-    if (!!params.enableClientAdditionalDetection) {
-      var workerjs = createXimdiffWorker(params);
-      _fs.default.writeFileSync(_path.default.resolve(_path.default.dirname(params.report), 'worker.js'), workerjs);
-      var wasmBuf = _fs.default.readFileSync(detectDiff.getBrowserWasmPath());
-      _fs.default.writeFileSync(_path.default.resolve(_path.default.dirname(params.report), 'detector.wasm'), wasmBuf);
-    }
-  }
-  if (!!params.junitReport) {
-    var junitXml = createJunitReport(params);
-    _makeDir.default.sync(_path.default.dirname(params.junitReport));
-    _fs.default.writeFileSync(params.junitReport, junitXml);
-  }
-  var json = createJSONReport(params);
-  if (!params.fromJSON) {
-    _makeDir.default.sync(_path.default.dirname(params.json));
-    _fs.default.writeFileSync(params.json, JSON.stringify(json));
-  }
-  return json;
-};
-exports.default = _default;

package/dist/tracing.js

@@ -1,169 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.withSpan = exports.startSpan = exports.startRootSpan = exports.shutdownTracing = exports.isTracingEnabled = exports.initTracing = exports.getTracer = exports.getTraceContext = exports.endRootSpan = void 0;
-var _sdkNode = require("@opentelemetry/sdk-node");
-var _exporterTraceOtlpHttp = require("@opentelemetry/exporter-trace-otlp-http");
-var _api = require("@opentelemetry/api");
-var _resources = require("@opentelemetry/resources");
-var _semanticConventions = require("@opentelemetry/semantic-conventions");
-var sdk = null;
-var isInitialized = false;
-var currentRootSpan = null;
-var currentRootContext = null;
-var isTracingEnabled = () => {
-  return process.env.OTEL_ENABLED === 'true' || process.env.JAEGER_ENABLED === 'true';
-};
-exports.isTracingEnabled = isTracingEnabled;
-var initTracing = () => {
-  if (!isTracingEnabled() || isInitialized) {
-    return;
-  }
-  var endpoint = process.env.OTEL_EXPORTER_OTLP_ENDPOINT || 'http://localhost:4318/v1/traces';
-  var exporter = new _exporterTraceOtlpHttp.OTLPTraceExporter({
-    url: endpoint
-  });
-  sdk = new _sdkNode.NodeSDK({
-    resource: new _resources.Resource({
-      [_semanticConventions.SemanticResourceAttributes.SERVICE_NAME]: 'reg-cli-js',
-      [_semanticConventions.SemanticResourceAttributes.SERVICE_VERSION]: '1.0.0'
-    }),
-    traceExporter: exporter
-  });
-  sdk.start();
-  isInitialized = true;
-  if (process.env.OTEL_DEBUG === 'true') {
-    console.log('[Tracing-JS] OpenTelemetry initialized');
-    console.log(`[Tracing-JS] OTLP endpoint: ${endpoint}`);
-  }
-};
-exports.initTracing = initTracing;
-var shutdownTracing = async () => {
-  if (sdk && isInitialized) {
-    if (process.env.OTEL_DEBUG === 'true') {
-      console.log('[Tracing-JS] Starting SDK shutdown...');
-    }
-    await sdk.shutdown();
-    if (process.env.OTEL_DEBUG === 'true') {
-      console.log('[Tracing-JS] OpenTelemetry SDK shut down');
-    }
-  }
-};
-exports.shutdownTracing = shutdownTracing;
-var getTracer = () => {
-  return _api.trace.getTracer('reg-cli-js', '1.0.0');
-};
-exports.getTracer = getTracer;
-var startRootSpan = name => {
-  if (!isTracingEnabled() || !isInitialized) {
-    return null;
-  }
-  var tracer = getTracer();
-  currentRootSpan = tracer.startSpan(name);
-  currentRootContext = _api.trace.setSpan(_api.ROOT_CONTEXT, currentRootSpan);
-  if (process.env.OTEL_DEBUG === 'true') {
-    var spanContext = currentRootSpan.spanContext();
-    console.log(`[Tracing-JS] Started root span: ${name}`);
-    console.log(`[Tracing-JS] Trace ID: ${spanContext.traceId}`);
-    console.log(`[Tracing-JS] Span ID: ${spanContext.spanId}`);
-  }
-  return {
-    traceId: currentRootSpan.spanContext().traceId,
-    spanId: currentRootSpan.spanContext().spanId
-  };
-};
-exports.startRootSpan = startRootSpan;
-var endRootSpan = (success = true) => {
-  if (currentRootSpan) {
-    if (success) {
-      currentRootSpan.setStatus({
-        code: _api.SpanStatusCode.OK
-      });
-    } else {
-      currentRootSpan.setStatus({
-        code: _api.SpanStatusCode.ERROR
-      });
-    }
-    currentRootSpan.end();
-    if (process.env.OTEL_DEBUG === 'true') {
-      console.log('[Tracing-JS] Ended root span');
-    }
-    currentRootSpan = null;
-    currentRootContext = null;
-  }
-};
-exports.endRootSpan = endRootSpan;
-var startSpan = (name, attributes = {}) => {
-  if (!isTracingEnabled() || !isInitialized) {
-    return {
-      end: () => {},
-      setStatus: () => {},
-      setAttribute: () => {}
-    };
-  }
-  var tracer = getTracer();
-  var parentContext = currentRootContext || _api.ROOT_CONTEXT;
-  var span = tracer.startSpan(name, {
-    attributes
-  }, parentContext);
-  var startTime = Date.now();
-  if (process.env.OTEL_DEBUG === 'true') {
-    console.log(`[Tracing-JS] Started span: ${name}`);
-  }
-
-  // Wrap the end method to log when span ends
-  var originalEnd = span.end.bind(span);
-  span.end = () => {
-    originalEnd();
-    if (process.env.OTEL_DEBUG === 'true') {
-      var duration = Date.now() - startTime;
-      console.log(`[Tracing-JS] Ended span: ${name} (${duration}ms)`);
-    }
-  };
-  return span;
-};
-exports.startSpan = startSpan;
-var withSpan = async (name, attributes, fn) => {
-  if (!isTracingEnabled() || !isInitialized) {
-    return fn();
-  }
-  var tracer = getTracer();
-  var parentContext = currentRootContext || _api.ROOT_CONTEXT;
-  return tracer.startActiveSpan(name, {
-    attributes
-  }, parentContext, async span => {
-    try {
-      var result = await fn();
-      span.setStatus({
-        code: _api.SpanStatusCode.OK
-      });
-      return result;
-    } catch (error) {
-      span.setStatus({
-        code: _api.SpanStatusCode.ERROR,
-        message: error.message
-      });
-      throw error;
-    } finally {
-      span.end();
-      if (process.env.OTEL_DEBUG === 'true') {
-        console.log(`[Tracing-JS] Ended span: ${name}`);
-      }
-    }
-  });
-};
-
-// For child processes - context propagation
-exports.withSpan = withSpan;
-var getTraceContext = () => {
-  if (currentRootSpan) {
-    return {
-      traceId: currentRootSpan.spanContext().traceId,
-      spanId: currentRootSpan.spanContext().spanId
-    };
-  }
-  return null;
-};
-exports.getTraceContext = getTraceContext;