Patchman UI

Patch is one of the applications for console.redhat.com. It allows users to display and manage available patches for their registered systems. This repository containes source code for the frontend part of the application which uses the REST API available from Patchman Engine.

Getting Started

The Patchman UI is a sub application under the Red Hat insights platform with Insights chroming app as a wrapper.

There are 2 technologies used for integration with backend and deployment purposes:

1. Insights Proxy
2. Webpackproxy

Note: the difference is insights proxy has to be reinitialised everytime you want to develop, while webpack proxy is auto initialized when you run the command npm run start:proxy:beta.

There is a comprehensive quick start guide in the Storybook Documentation to setting up an Insights environment complete with:

• Insights Frontend Starter App

• Insights Chroming

• Insights Proxy

Note: You will need to set up the Insights environment if you want to develop with the starter app due to the consumption of the chroming service as well as setting up your global/app navigation through the API.

Run the app for the first time

1. git clone [email protected]:RedHatInsights/patchman-ui.git

   • clone the Patch UI into your machine

2. npm install

3. SPANDX_CONFIG="./config/spandx.config.js" bash $PROXY_PATH/scripts/run.sh

   • If you are using insights proxy, it is time to start it. Otherwise you can skip this step

4. npm run start

   • use this command if you want to develop Patch UI using insights proxy. The command starts webpack bundler and serves the files with webpack dev server

npm run start:proxy:beta - use this command if you wand to develop Patch UI using webpack proxy starts webpack bundler and serves the files with webpack dev server

Testing

• npm run verify will run linters and tests
• Travis is used to test the build for this code.
  • You are always notified on failed builds
  • You are only notified on successful builds if the build before it failed
  • By default, both push events as well as pull_request events send notifications
  • Travis is defaulted to notify #insights-bots
  • npm run test will run only Jest tests
  • npm run test:update is used to update the test snapshots

Deploying

• The Platform team is using Travis to deploy the application
  • The Platform team will help you set up the Travis instance if this is the route you are wanting to take

Release process

• there is a comprehensive guidline on the release procedure

How it works

Any push to the following branches will trigger a build in patchman-ui-build repository which will deploy to corresponding environment.

| Push to branch in this repo | Updated branch in build repo | Environment | Available at | :--------------------------- | :---------------------------- | :---------------- | :----------- | master | stage-beta | stage beta | https://console.stage.redhat.com/preview | stage-stable | stage-stable | stage stable | https://console.stage.redhat.com | prod-beta | prod-beta | production beta | https://console.redhat.com/preview | prod-stable | prod-stable | production stable | https://console.redhat.com

Patternfly

• This project imports Patternfly components:
  • Patternfly React

Insights Components

Insights Platform will deliver components and static assets through npm. ESI tags are used to import the chroming which takes care of the header, sidebar, and footer.

Technologies

Webpack

Webpack.config.js

This file exports an object with the configuration for webpack and webpack dev server.

{
    mode: https://webpack.js.org/concepts/mode/,
    devtool: https://webpack.js.org/configuration/devtool/,

    // different bundle options.
    // allows you to completely separate vendor code from app code and much more.
    // https://webpack.js.org/plugins/split-chunks-plugin/
    optimization: {
        chunks: https://webpack.js.org/plugins/split-chunks-plugin/#optimization-splitchunks-chunks-all,
        runtimeChunk: https://webpack.js.org/plugins/split-chunks-plugin/#optimization-runtimechunk,

        // https://webpack.js.org/plugins/split-chunks-plugin/#configuring-cache-groups
        cacheGroups: {

            // bundles all vendor code needed to run the entry file
            common_initial: {
                test: // file regex: /[\\/]node_modules[\\/]/,
                name: // filename: 'common.initial',
                chunks: // chunk type initial, async, all
            }
        }
    },

    // each property of entry maps to the name of an entry file
    // https://webpack.js.org/concepts/entry-points/
    entry: {

        // example bunde names
        bundle1: 'src/entry1.js',
        bundle2: 'src/entry2.js'
    },

    // bundle output options.
    output: {
            filename: https://webpack.js.org/configuration/output/#output-filename,
            path: https://webpack.js.org/configuration/output/#output-path,
            publicPath: https://webpack.js.org/configuration/output/#output-publicpath,
            chunkFilename: https://webpack.js.org/configuration/output/#output-chunkfilename
    },
     module: {
         rules: https://webpack.js.org/configuration/module/#module-rules
     },

     // An array of webpack plugins look at webpack.plugins.js
     // https://webpack.js.org/plugins/
     plugins: [],

     // webpack dev serve options
     // https://github.com/webpack/webpack-dev-server
     devServer: {}
}

React

• High-Order Component

  • a higher-order component is a function that takes a component and returns a new component
    • Ex) asyncComponent.js

• Smart/Presentational Components

  • Smart components have access to the redux state
  • Presentational components do not have access to the redux state
  • Smart Components === insights-frontend/app/js/states
  • Presentational Components === insights-frontend/app/js/components

• State and lifecycle within class components

  • article contains:
    • Adding Lifecycle Methods to a Class
    • Adding Local State to a Class
    • State Updates May Be Asynchronous
    • State Updates are Merged

Redux

Store

A store holds the whole state tree of your application. Redux doesn't have a Dispatcher or support many stores. Instead, there is just a single store with a single root reducing function.

Create Store: createStore(reducer, preloadedState, enhancer)

• methods
  • getState()
  • dispatch(action)
  • subscribe(listener)
  • replaceReducer(nextReducer)

Actions

Actions are payloads of information that send data from your application to your store. They are the only source of information for the store. You send them to the store using store.dispatch(). Redux actions should only have two properties, type and payload, as a best practice.

• Async Actions frameworks

  • redux-promise-middleware
    • Currently using this
      • look at /src/api/System/getSystems.js
  • redux-thunk
    • A function that wraps an expression to delay its evaluation

    // gotSystems(Error) are action creators
    function getSystems() {
          return function (dispatch) {
            return fetchSystems().then(
              systems => dispatch(gotSystems(systems)),
              error => dispatch(gotSystemsError(error))
            );
          };
        }

  • redux-saga
    • Uses generator functions
    • Could be a lot to learn initially.
  • redux-pack

Reducers

Reducers specify how the application's state changes in response to actions sent to the store.

Ex) /src/api/System/getSystems.js

React-redux

• Provider
  • Makes the Redux store available to the connect()
• connect([mapStateToProps], [mapDispatchToProps], [mergeProps], [options])
  • Connects a React component to a Redux store

React-router-dom

When setting up the routes, the page content is wrapped with a .page__{pageName} class, applied to the #root ID that is determined by the rootClass in the Routes.js which lets you easily reference the page in the styling.

• BrowserRouter
  • A <Router> that uses the HTML5 history API (pushState, replaceState and the popstate event) to keep your UI in sync with the URL
• Route
• Switch
  • Renders the first child <Route> or <Redirect> that matches the location.
• Redirect
  • navigate to a new location
• withRouter
  • passes updated match, location, and history props to the wrapped component whenever it renders

Running locally

Have insights-proxy installed under PROXY_PATH

SPANDX_CONFIG="./config/spandx.config.js" bash $PROXY_PATH/scripts/run.sh

Running with inventory

In order to test system detail in inventory application pull inventory UI app, install dependencies and run it

>$ npm install
>$ npm start

With our spandx config, patch and inventory running you should be able to see changes in the system detail of inventory.

Testing - jest

When you want to test your code with unit tests please use jest which is preconfigured in a way to colect codecoverage as well. If you want to see your coverage on server the travis config has been set in a way that it will send data to codecov.io the only thing you have to do is visit their website (register), enable your repository and add CODECOV_TOKEN to your travis web config (do not add it to .travis file, but trough travis-ci.org)

Run SonarQube code analysis

export SONAR_HOST_URL=https://sonar-server
export SONAR_LOGIN=paste-your-generated-token
export SONAR_CERT_URL=https://secret-url-to/ca.crt # optional
podman-compose -f dev/sonar/docker-compose.yml up --build