yavin-dev/framework

A framework for rapidly building production quality analytics applications

Yavin Framework

A framework for rapidly building production quality analytics applications

Docs - Demo - Community

Yavin Framework

Note: This repository contains the core code of the Yavin framework. If you want to build an application using Yavin, visit the Yavin App Repository.

Yavin is a framework for rapidly building custom data applications that offers both a UI and an API. Yavin can also be deployed as a standalone business intelligence tool in a few simple steps. Build reports, assemble dashboards, and explore data with ad-hoc queries.

Jump right in with the demo app or run it yourself by following our quick start guide.

Packages

You can install the individual packages via npm

Package	Description
	Library of visualizations and common components
	Collection of components for creating collections of visualization
	Adapters and serializers for connecting to data sources (elide/fili)
	Overview of all saved/favorited reports and dashboards
	Helper library for in app alerts
	Collection of components for building advanced ad-hoc reports

Contributing

Assuming you have git, node (>=10), and ember-cli

• git clone https://github.com/yavin-dev/framework.git
• cd yavin
• CI=true npm install (CI=true makes use of each package's package-lock.json file)
• cd packages/reports (or whichever package)
• ember s to run a local server
• Then npm test to test your changes

See CONTRIBUTING.md

Resources

• Documentation on yavin.dev
• Chat on spectrum.chat
• Feature Roadmap projects
• For more information on using ember-cli, visit https://ember-cli.com/.
• For more information on using lerna, visit https://lerna.js.org

License

This project is licensed under the MIT License.

framework's Issues

Make a number format a reusable component

Remove `ember-tether`

In ember-tooltips 2.9.2, ember-tether has been moved from a peer-dependency to a dependency. We should be able to safely remove it from package.json and the blueprints

Make rebuildConfig() take request object returned by navi-data

The request argument to rebuildConfig() currently needs to be a bard-request/request fragment instance.

If it instead took the serialized request object returned from the navi-data fact service, any visualization would have the information needed to build a default config if none was provided.

Remove `exploreWidget` feature flag

The feature flag no longer has a reason to be turned off. Worse, it's off by default.

Fix scroll behavior in navi-app

There is a css issue with navi-app for list views that needs to allow scrolling when lists are long enough to overflow the body.

Replace pick-single component with ember-power-select

replace all occurences of pick-single with ember-power-select

• navi-collection filter selector
• navi-date-picker

Need to have a consistent dummy-app

The dummy app for all the packages are all very different. We need to make this more consistent.

TOFIX

• Visualizations
  • Pie chart component doesn't render in the dummy app
  • Config Component span half the screen

Cleanup color variables

We have too many different color variables in different packages. Clean them up.

Add error route to /new routes

We need more user friendly error handling in /reports/new, /print/reports/new, /dashboards/1/widgets/new routes.

Single button to toggle filters

Dimension/metric filters are added with one button, and removed through another. It's natural to try and click the "add filter" icon to toggle it off once the filter is already there.

enforce eslint commit convention

enforce eslint commit convention

Get rid of smart-format-number helper

This is a very specific helper should belong to the app that needs it, instead of the addon.

Move startMirage initializer into helper

import { startMirage } from '../../initializers/ember-cli-mirage';

This is used in a lot of our tests. Probably should put this in a test helper.

Table visualization headers can wrap at awkward spots

Long table headers can wrap mid-word, despite the table being capable of expanding horizontally.

Avoid binding `style` attribute in power select trigger

This is throwing a warning in the console:
https://github.com/yahoo/navi/blob/master/packages/reports/addon/templates/components/power-select-bulk-import-trigger.hbs#L32

Navi date picker not intuitive on hourly/all timegrain

Date Picker should always seem inclusive to the user
Irrespective of timegrain being hourly, all, daily, weekly, or monthly

Date Picker should, because of fili naturally being exclusive,
Daily: increment by 1 day when sending the query
E.g. user selects dec 8th - 22nd
User sees 8th -22nd everywhere
Bard query reads 8th -23rd 0th hour

Weekly: determine start of week til end of week, where end is first hour first day of the next week
E.g. user selects dec 8th - 22nd
User sees 8th -22nd everywhere
Bard query reads 8th -23rd 0th hour

Hourly: increment by 1 day before sending the query
E.g. user selects dec 8th - 22nd
User sees 8th -22nd everywhere
Bard query reads 8th -23rd 0th hour

All: increment by 1 day before sending the query
E.g. user select dec 8th - 22nd
User sees 8th -22nd everywhere
Bard query reads 8th -23rd 0th hour

Metric filtering behavior isn't clear

• Is metric filter inclusive or exclusive?
• How did the filter affect the data?

Allow series selector to expand beyond edit panel

The series selector can seem a little cramped. We should let it overflow outside the config pane.

TODO:

• Allow series selector to expand
• Investigate column reorder test utility
• Investigate broken test

Metric and dimension selectors don't have enough space

Finding the values you need can be a bit clumsy due to the limited space given to the selectors.

dimension/metric selector break without categories

dimension-selector and metric-selector components should handle the case when category is undefined.

metadata.getByIds

getByIds would be useful in the metadata service.

Use published version of ember-tooltips once fix is merged

Once this PR sir-dunxalot/ember-tooltips#258 is merged, we should revert any Ember 3.x packages to use the published version of ember-tooltips.

• sir-dunxalot/ember-tooltips#258 merged

Refactor metrics into objects in visualization models' metadata

• Line Chart
• Pie Chart
• Table
• Metric Label
• Goal Gauge
• Tooltips (Not a model, but rather utilize the new metric objects to simplify tooltips)

Entering large numbers in metric filters is difficult

It's hard to read the number once the filter value hits the million/billion range.

Consider renaming checkbox-selector class

In the alerts package, we have a use case for using the checkbox-selector class in a selector that has no checkboxes. It would be nice if the class name was independent of the UI elements used.

Refactor request clone to use copy

model Fragments implement Ember.Copyable, so we should make sure each of the Fragments we have implement copy() correctly, then request.clone() can be replaced with request.copy. and vastly be simplified.

Chart series name is blank for certain dimension values

When charting a dimension value with no description, the series name is blank.

See if we need to cleanup index.js route in navi-app

Make visualization `options` argument optional

Current:

{{navi-visualizations/metric-label
    model=model
    options=options
}}

New:

{{navi-visualizations/metric-label
    model=model
}}

If options is not provided, the visualization will generate a default based on model.request and model.response.

Needs #49.

Remove `Ember.Binding`

Ember.Binding is deprecated. We are most likely using it in situations with two way data bindings preventing us from using computed.readOnly.

Sorting table columns can be confusing

Several users have tried clicking on a specific sort direction icon expecting to automatically sort in that direction.

Upgrade Data to ~3.7+

Update data to the latest ember version

move navi-loader to core package

navi-collection keeps filter state between acceptance tests

The favorite report tests in acceptance/custom-reports-test.js filter the report view to show only favorites. This state is then persisted in any of the following acceptance tests.

We need to make sure state isn't leaked between tests.

Navi WS

• Elide Standalone - in progress
• Navi models own build
• lerna + mvn - investigate

Loader Component

• Need to move navi-loader to navi-core
• Need to rename loading-message to navi-loading-message and move to navi-core

have generic styles for the components so that they aren't overridden everywhere they are used.

Standardize model.clone() methods

The clone method has inconsistent return values across models.

https://github.com/yahoo/navi/blob/master/packages/reports/addon/models/report.js#L96

https://github.com/yahoo/navi/blob/master/packages/dashboards/addon/models/dashboard-widget.js#L72

Split navi-report acceptance test logically into multiple acceptance test files

Currently the navi-report acceptance test file is over 1200 lines. Its difficult to find the presence or absence of tests in that huge file. It would be helpful if that file could be divided logically into multiple acceptance test files.

Replace the pagination logic within `series-selector` component

Update the component to use something like ember-collection.

Wrap table header text to prevent overlap

Visualization Table header text should wrap

This is on a large screen, on a smaller screen, it would be even worse.

Reports breadcrumb disappears when editing report title

See title.

Metric Removal Breaks Report Builder

Problem:
If a metric is removed from the WS metadata, the report builder breaks and there is no way to recover the report.

Proposed Solution:
We should ideally clean up the removed metrics from the report object and notify the owner that a metric from the report has been removed, but still allow the user to view the report or modify it.

hide save report button when report is invalid

Set up demo

We need to have a demo out there on the internet.

Fix all deprecation warnings in tests

There are a ton of deprecation warnings. Since the repo is almost up to date with the latest ember version, we should investigate and fix these deprecation warnings.

Metric/dimension tooltips can be too verbose to read

Part of the problem is too little space to hold large amounts of text. The other is the large amount of text.

We should consider more flexible tooltip sizes, or some type of "Show Full Description" button.

Refactor Index Routes

Refactor report and dashboard index routes
Ideally we would want a single route for reports and sub-routes nested under it for

• report-collections
• favorite reports
• scheduled reports
  etc.

And similarly for dashboards.

The sub routes should be configurable and extendable in the app

add dashboard schedule action

Report View - keep time grain check boxes in sync

If a table does not have the All time grain, it is possible to uncheck the selected time grain. The current time grain stays selected, but the check box is empty.

introduce prettier

TODO

• app
• data
• core
• visualizations
• reports
• dashboards