Giter Club home page Giter Club logo

sdk-js's Introduction

Coverage Code Smells

Npm

https://www.npmjs.com/package/@visual-regression-tracker/sdk-js

Install

npm install @visual-regression-tracker/sdk-js

Usage

Import

import {
  VisualRegressionTracker,
  Config,
} from "@visual-regression-tracker/sdk-js";

Configure

Explicit config from code

const config: Config = {
  // URL where backend is running
  // Required
  apiUrl: "http://localhost:4200",

  // Project name or ID
  // Required
  project: "Default project",

  // User apiKey
  // Required
  apiKey: "tXZVHX0EA4YQM1MGDD",

  // Current git branch
  // Required
  branchName: "develop",

  // Log errors instead of throwing exceptions
  // Optional - default false
  enableSoftAssert: true,

  // Unique ID related to one CI build
  // Optional - default null
  ciBuildId: "SOME_UNIQUE_ID",
};

Or, as JSON config file vrt.json

Used only if not explicit config provided Is overriden if ENV variables are present

{
  "apiUrl": "http://localhost:4200",
  "project": "Default project",
  "apiKey": "tXZVHX0EA4YQM1MGDD",
  "ciBuildId": "commit_sha",
  "branchName": "develop",
  "enableSoftAssert": false
}

Or, as environment variables

Used only if not explicit config provided

VRT_APIURL="http://localhost:4200"
VRT_PROJECT="Default project"
VRT_APIKEY="tXZVHX0EA4YQM1MGDD"
VRT_CIBUILDID="commit_sha"
VRT_BRANCHNAME="develop"
VRT_ENABLESOFTASSERT=true

Setup

vrt.start();

Teardown

vrt.stop();

Assert

await vrt.track({
  // Name to be displayed
  // Required
  name: "Image name",

  // Base64 encoded string
  // Required or use imagePath
  imageBase64: image,

  // Path to image (service version api:4.14.0 or higher is required)
  // Required or use imageBase64
  imagePath: image,

  // Allowed mismatch % (mismatched pixels to overal pixels count)
  // Optional
  diffTollerancePercent: 0,

  // Optional
  os: "Mac",

  // Optional
  browser: "Chrome",

  // Optional
  viewport: "800x600",

  // Optional
  device: "PC",

  // Optional
  customTags: "Cloud, DarkTheme, Auth",

  // Array of areas to be ignored
  // Optional
  ignoreAreas: [
    {
      // X-coordinate relative of left upper corner
      // Required
      x: 10;

      // Y-coordinate relative of left upper corner
      // Required
      y: 20;

      // Area width in px
      // Required
      width: 300;

      // Height width in px
      // Required
      height: 400;
    }
  ]

  // Allow additional details
  // Optional
  comment: 'Ignoring region because of animation'
});

sdk-js's People

Contributors

codacy-badger avatar dependabot-preview[bot] avatar dependabot[bot] avatar dimitriharding avatar eduard-ich avatar paazmaya avatar pashidlos avatar wsbaser avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

sdk-js's Issues

Add configuration via config file or env variables

Read file vrt.json from project root with structure:

{
      "apiUrl": "http://162.243.161.172:4200",
      "project": "VRT",
      "apiKey": "SECRET",
      "branchName": "master",
      "enableSoftAssert": false,
      "ciBuildId": "SOME_UNIQUE_ID"
}

env variables example:

VRT_APIURL="http://localhost:4200" 
VRT_PROJECT="Default project" 
VRT_APIKEY="tXZVHX0EA4YQM1MGDD" 
VRT_CIBUILDID="commit_sha" 
VRT_BRANCHNAME="develop" 
VRT_ENABLESOFTASSERT=true

Acceptance criteria:

  • config variables are read from config file
  • can start build with default constructor VisualRegressionTracker (without specific config)
  • validation error is thrown in case required config properties are not set
  • explicit config from code is overriding values from env variables
  • env variables are overriding values from config file

Send "Authorization" header with requests to the backend

The issue

We have a VRT backend deployed. However it requires Authorization header for access in order not to be publicly accessible for anyone.

Proposed solution

Add optional "authHeader" setting / VRT_AUTH_HEADER env variable. If present, its value can be added to the AxiosRequestConfig as Authorization header to ensure it is sent with all requests to the backend.

This allows the backend not to be publicly available. It provides support for any Authorization type since the full value of the header is provided from the config.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.