redhatinsights/insights-advisor-frontend

The Advisor Frontend

Advisor Frontend

First time setup

1. Make sure you have Node.js version >= 16 installed
2. Run script to patch your /etc/hosts
3. Make sure you are using Red Hat proxy

Running locally

1. Install dependencies with npm install
2. Run development server with npm run start:proxy:beta
3. Local version of the app will be available at https://stage.foo.redhat.com:1337/preview/insights/advisor/

In case you want to use the stable environment instead of beta you can run the app with npm run start:proxy and access it from https://stage.foo.redhat.com:1337/insights/advisor/. Usually there is no difference between these two environments unless there is a large feature in progress which is hidden behind isBeta flag.

Testing federated modules with another application

If you want to test Advisor with another application deployed locally, you can utilise LOCAL_APPS environment variable and deploy the needed application on separate ports. To learn more about the variable, see https://github.com/RedHatInsights/frontend-components/tree/master/packages/config#running-multiple-local-frontend-applications.

Example

We'll take for example insights-inventory-frontend.

Open new terminal, navigate to Inventory repository, and run it on a separate port without proxy:

npm run start -- --port=8003

In a separate terminal, run Advisor with proxy enabled and list Inventory:

LOCAL_APPS=inventory:8003~http npm run start:proxy

Testing

Travis is used to test the build for this code.

• npm run test will run tests.
• npm run lint will run all linters.

Before opening a pull request, you can run npm run verify:local to make sure your changes pass automated tests (Jest and Cypress) and linter (both JS and CSS linters).

Deploying

Any push to the following branches will trigger a build in insights-advisor-frontend-build repository which will deploy to corresponding environment. Travis is used to deploy the application.

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
master-stable	stage-stable	stage stable	https://console.stage.redhat.com
prod-beta	prod-beta	production beta	https://console.redhat.com/beta
prod-stable	prod-stable	production stable	https://console.redhat.com

Internationalization

Translation keys

Translation keys are saved in messages.js.

Generating translation keys

Each time you add a new translation keys you need to run npm run translations, which will automatically generate JSON files for every language into locales/ folder based on the entries in the messages.js.

Using translated strings

There are two ways to use translated strings:

1. With intl.formatMessage(messages.messageId)
2. With <FormattedMessage {...messages.messageId}/>

Design System

This project uses Patternfly React.

Insights Components

This app imports components from Insights Front-end Components library. ESI tags are used to import Insights Chrome which takes care of the header, sidebar, and footer.

Release process change in stage env

We are using the new release process in stage environment that uses containers for deplyoment. Containerized Frontends are the new way to to build, package, and deploy the applicaitons.

insights-advisor-frontend's Issues

Update Insights-frontend-components to allow for DOM scanning

This follows up on the #45 PR, but this is on a larger scale for the insights components.

PR: RedHatInsights/insights-frontend-components#109

Update "@patternfly/react-core": "1.11.1", 👉 "@patternfly/react-core": "1.12.0",

but we can't till patternfly/patternfly-react#630 goes away

Bug: Topics overflow the rule details component

"Topics related to the recommendation" can be really long. However, there is no wrapping that could limit the width of that block, and the components to the right side are just thrown away and not visible.

Review list-actions page

Add lint watcher when running development scripts

As of right now, you don't actually hit the npm run lint until travis checks it. I'll add it to the npm run start script as a watcher

Title on ListActions

What do you guys think about converting the rule.description to:

<PageHeader>
    <PageHeaderTitle title={ this.state.rule.description }/>
</PageHeader>

Remove x-rh-auth-identity header

Now that 3scale is up and running, we don't need this header.

@AllenBW @bmclaughlin

Update @patternfly/patternfly-next to @patternfly/patternfly

PF has moved their next package to @patternfly/patternfly

AFAIK they will no longer be publishing to @patternfly/patternfly-next and it is already 5 minor versions behind.

Lint doesn't pick up array inside object and vice versa

Actions 2 table sorting broken

When sorting on the table, it doesn't correctly sort by ascending or descending. Some of the sorting doesn't work at all.

Example: Sorting by the Systems Exposed

add a bookmarkable route without category segment

right now the URL route has the form of
https://access.redhat.com/insightsbeta/platform/advisor/actions//<rule_id>

If I want to link user to a rule page I may only know its rule_id but not its category. It would therefore be handy if this project also supported routes in form of:

https://access.redhat.com/insightsbeta/platform/advisor/actions/<rule_id>

Rules Page Scaffolding

Can't unselect a filter if more than one are selected

How to reproduce:

1. Go into the actions 2
2. Select two of the filters
3. click off the filters
4. uncheck the two filters
5. click on the filters
6. one of the filters is still active and won't actually deselect

Review Rules Page

"Low" filter for Total Risk missing

This was discussed on the mockups in a comment. It wasn't originally shown due to an errors, but you are supposed to filter on it. There is a comment on the Invision mocks.

Bug: kebab is displayed for empty state message

If you have 0 affected systems for a single rec page, the empty message has an extra kebab.

[BUG] Donut hole breaks out of container at larger screen widths

Bug: padding/margin issues in the Recs list page

There are a couple of issues on the recommendations list page caused by incorrect margins or padding params. See screenshots

Add store and framework for async data fetching

As most of the app is just a mock presently, this doesn't have to be THE MOST BULLETPROOF IMPLEMENTATION EVER just something more than nothing which is present state.

Donut disappears with 0 issues

Bug: first rule in the rules table is not selectable

When you open the inventory details page (e.g., I used https://cloud.redhat.com/insights/advisor/recommendations/network_device_unregister_issue|NETWORK_DEVICE_UNREGISTER_ISSUE/{INVENTORY_ID}) and try to select the first item in the rules list, the UI does not react to your click, and the item remains unselected. For the rest of the items, it works OK (see the screenshot).