react-version-tracker

React Version Tracker

This module will be used to detect the version change of the application

Version tracking can be done

What?

• React version tracker library is used to track app version and inform the user.
• It has two types of control
  • using hooks
  • using component VersionTracker

Installation

Install react-version-tracker with npm

  npm install react-version-tracker  

Install react-version-tracker with yarn

  yarn add react-version-tracker  

How to use the VersionTracker component

import Component in app level

import { VersionTracker } from 'react-version-tracker';

in app.js add the below code

<VersionTracker 
  currentVersion='v1.0.0'
  versionFileUrl='version.json'  
  onVersionChange={onVersionChange}
  />

PROPTYPES

Prop	Type	Default	Description
currentVersion	String		This will be the current version of the build
versionFileUrl	String	/version.json	this can be file location or any API
displayAlert	Boolean	false	when there is change alert will be displayed
onVersionChange	Function		when the version change method will be called
message	String		user message on the alert box.

Example

versionFileUrl

when we keep the version file in the web server simple pass the file name 
versionFileUrl="version.json". 
or
versionFileUrl="http://text.com/api/get-version"

version.json or api response should be as below.

{ "version":"1.0.0" }

onVersionChange

this funtion will return object {"version":"1.0.0"}

how to use version hooks (useVersionTracker and useVersion)

react-version-tracker has two hooks useVersionTracker and useVersion . we have to do client and server side changes to use hooks

Client side changes

we need to pass response of API to useVersionTracker . it has two params first is the response second one is the key of response header. useVersionTracker hook can be added to the axios response interceptor or in the HTTP service.

Sample 1

import { useVersionTracker } from 'react-version-tracker';

fetch(url, {
      method: method,
      body: JSON.stringify(data),
      headers: headers,
      params: params,
    }).then((response) => {      
      useVersionTracker(response, 'X-Version');     
      return response.json();
    })

Sample 2

import axios from 'axios'
import { useVersionTracker } from 'react-version-tracker';

axios.interceptors.response.use(
  response => {
     useVersionTracker(response, 'x-version') 
    return response
  },function (error) {       
      return Promise.reject(error)
    })

When any version change is detected new version will be returned by useVersion hook

const { version } = useVersion();

  useEffect(() => {
    if (version !== currentVersion) {
      // write your logic here
    }
  }, [version]);

Server side changes

Node JS changes from api response.

let results= {};
response.header('Access-Control-Expose-Headers', 'x-version');
response.set('x-version', '1.0.0');
return response.send(results);

Documentation

Documentation

Roadmap

• Display modal instead of alert

• Give the option to auto-reload in VersionTracker

• Add auto-reload and Display alert option in useVersionTracker

🔗 Links