2019-01-19 06:18:22 -05:00
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
2015-07-20 19:29:16 -04:00
# Contributing
Contributions are welcome and are greatly appreciated! Every
little bit helps, and credit will always be given.
2018-09-19 13:01:51 -04:00
## Table of Contents
2020-02-24 17:31:23 -05:00
- [Contributing ](#contributing )
- [Table of Contents ](#table-of-contents )
- [Orientation ](#orientation )
- [Types of Contributions ](#types-of-contributions )
- [Report Bug ](#report-bug )
- [Submit Ideas or Feature Requests ](#submit-ideas-or-feature-requests )
- [Fix Bugs ](#fix-bugs )
- [Implement Features ](#implement-features )
- [Improve Documentation ](#improve-documentation )
- [Add Translations ](#add-translations )
- [Ask Questions ](#ask-questions )
- [Pull Request Guidelines ](#pull-request-guidelines )
- [Protocol ](#protocol )
- [Authoring ](#authoring )
- [Reviewing ](#reviewing )
2021-03-09 13:19:43 -05:00
- [Test Environments ](#test-environments )
2020-02-24 17:31:23 -05:00
- [Merging ](#merging )
- [Post-merge Responsibility ](#post-merge-responsibility )
2021-01-27 20:25:13 -05:00
- [Design Guidelines ](#design-guidelines )
2021-02-15 14:45:29 -05:00
- [Capitalization guidelines ](#capitalization-guidelines )
- [Sentence case ](#sentence-case )
- [How to refer to UI elements ](#how-to-refer-to-ui-elements )
- [\*\*Exceptions to sentence case: ](#exceptions-to-sentence-case )
2020-02-24 17:31:23 -05:00
- [Managing Issues and PRs ](#managing-issues-and-prs )
2020-09-07 10:51:24 -04:00
- [Reporting a Security Vulnerability ](#reporting-a-security-vulnerability )
2020-02-24 17:31:23 -05:00
- [Revert Guidelines ](#revert-guidelines )
- [Setup Local Environment for Development ](#setup-local-environment-for-development )
- [Documentation ](#documentation )
2023-01-13 11:56:15 -05:00
- [Local Development ](#local-development )
- [Build ](#build )
- [Deployment ](#deployment )
2020-02-24 17:31:23 -05:00
- [Flask server ](#flask-server )
- [OS Dependencies ](#os-dependencies )
2022-05-11 12:07:48 -04:00
- [Dependencies ](#dependencies )
2020-02-24 17:31:23 -05:00
- [Logging to the browser console ](#logging-to-the-browser-console )
2021-01-11 02:36:01 -05:00
- [Frontend ](#frontend )
2020-02-24 17:31:23 -05:00
- [Prerequisite ](#prerequisite )
2021-01-11 02:36:01 -05:00
- [nvm and node ](#nvm-and-node )
- [Install dependencies ](#install-dependencies )
- [Build assets ](#build-assets )
- [Webpack dev server ](#webpack-dev-server )
- [Other npm commands ](#other-npm-commands )
2020-02-24 17:31:23 -05:00
- [Docker (docker-compose) ](#docker-docker-compose )
- [Updating NPM packages ](#updating-npm-packages )
- [Feature flags ](#feature-flags )
- [Git Hooks ](#git-hooks )
2018-09-19 13:01:51 -04:00
- [Linting ](#linting )
2022-05-11 12:07:48 -04:00
- [Python ](#python )
- [TypeScript ](#typescript )
2020-02-24 17:31:23 -05:00
- [Conventions ](#conventions )
2022-05-11 12:07:48 -04:00
- [Python Conventions ](#python-conventions )
2020-02-24 17:31:23 -05:00
- [Typing ](#typing )
2022-05-11 12:07:48 -04:00
- [Python Typing ](#python-typing )
- [TypeScript Typing ](#typescript-typing )
2020-02-24 17:31:23 -05:00
- [Testing ](#testing )
- [Python Testing ](#python-testing )
- [Frontend Testing ](#frontend-testing )
- [Integration Testing ](#integration-testing )
2021-07-01 07:11:03 -04:00
- [Debugging Server App ](#debugging-server-app )
- [Debugging Server App in Kubernetes Environment ](#debugging-server-app-in-kubernetes-environment )
2020-11-10 18:58:54 -05:00
- [Storybook ](#storybook )
2020-02-24 17:31:23 -05:00
- [Translating ](#translating )
- [Enabling language selection ](#enabling-language-selection )
2021-02-15 14:45:29 -05:00
- [Updating language files ](#updating-language-files )
2020-02-24 17:31:23 -05:00
- [Creating a new language dictionary ](#creating-a-new-language-dictionary )
- [Tips ](#tips )
- [Adding a new datasource ](#adding-a-new-datasource )
2020-11-10 18:58:54 -05:00
- [Visualization Plugins ](#visualization-plugins )
2020-02-24 17:31:23 -05:00
- [Adding a DB migration ](#adding-a-db-migration )
- [Merging DB migrations ](#merging-db-migrations )
- [SQL Lab Async ](#sql-lab-async )
2021-01-19 16:57:25 -05:00
- [Async Chart Queries ](#async-chart-queries )
2020-02-24 17:31:23 -05:00
- [Chart Parameters ](#chart-parameters )
2022-05-11 12:07:48 -04:00
- [Datasource \& Chart Type ](#datasource--chart-type )
2020-02-24 17:31:23 -05:00
- [Time ](#time )
- [GROUP BY ](#group-by )
- [NOT GROUPED BY ](#not-grouped-by )
- [Y Axis 1 ](#y-axis-1 )
- [Y Axis 2 ](#y-axis-2 )
- [Query ](#query )
- [Chart Options ](#chart-options )
- [Y Axis ](#y-axis )
- [Other ](#other )
- [Unclassified ](#unclassified )
2015-07-20 19:29:16 -04:00
2019-10-23 00:44:11 -04:00
## Orientation
Here's a list of repositories that contain Superset-related packages:
2021-01-06 06:45:19 -05:00
- [apache/superset ](https://github.com/apache/superset )
2019-10-23 00:44:11 -04:00
is the main repository containing the `apache-superset` Python package
distributed on
[pypi ](https://pypi.org/project/apache-superset/ ). This repository
2020-02-24 17:31:23 -05:00
also includes Superset's main TypeScript/JavaScript bundles and react apps under
2021-01-06 06:45:19 -05:00
the [superset-frontend ](https://github.com/apache/superset/tree/master/superset-frontend )
2019-10-23 00:44:11 -04:00
folder.
- [github.com/apache-superset ](https://github.com/apache-superset ) is the
2022-04-26 12:17:15 -04:00
GitHub organization under which we manage Superset-related
2019-10-23 00:44:11 -04:00
small tools, forks and Superset-related experimental ideas.
2015-07-20 19:29:16 -04:00
## Types of Contributions
2023-01-24 00:05:24 -05:00
### Report a Bug
2015-07-20 19:29:16 -04:00
2019-01-19 06:18:22 -05:00
The best way to report a bug is to file an issue on GitHub. Please include:
2015-07-20 19:29:16 -04:00
2018-09-19 13:01:51 -04:00
- Your operating system name and version.
2019-01-19 06:18:22 -05:00
- Superset version.
2018-09-19 13:01:51 -04:00
- Detailed steps to reproduce the bug.
2019-01-19 06:18:22 -05:00
- Any details about your local setup that might be helpful in troubleshooting.
2015-07-20 19:29:16 -04:00
2018-09-19 13:01:51 -04:00
When posting Python stack traces, please quote them using
[Markdown blocks ](https://help.github.com/articles/creating-and-highlighting-code-blocks/ ).
2017-06-21 13:12:34 -04:00
2023-01-24 00:05:24 -05:00
_Please note that feature requests opened as Github Issues will be moved to Discussions._
2019-01-19 06:18:22 -05:00
### Submit Ideas or Feature Requests
2023-01-24 00:05:24 -05:00
The best way is to start an ["Ideas" Discussion thread ](https://github.com/apache/superset/discussions/categories/ideas ) on GitHub:
2019-01-19 06:18:22 -05:00
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
2023-01-24 00:05:24 -05:00
- Remember that this is a volunteer-driven project, and that your contributions are as welcome as anyone's :)
2019-01-19 06:18:22 -05:00
2023-01-24 00:05:24 -05:00
To propose large features or major changes to codebase, and help usher in those changes, please create a **Superset Improvement Proposal (SIP)** . See template from [SIP-0 ](https://github.com/apache/superset/issues/5602 )
2019-01-19 06:18:22 -05:00
2015-07-20 19:29:16 -04:00
### Fix Bugs
2019-10-28 11:49:40 -04:00
Look through the GitHub issues. Issues tagged with `#bug` are
2019-10-30 19:19:16 -04:00
open to whoever wants to implement them.
2015-07-20 19:29:16 -04:00
### Implement Features
2019-01-19 06:18:22 -05:00
Look through the GitHub issues. Issues tagged with
`#feature` is open to whoever wants to implement it.
2015-07-20 19:29:16 -04:00
2018-09-19 13:01:51 -04:00
### Improve Documentation
2015-07-20 19:29:16 -04:00
2016-11-10 02:08:22 -05:00
Superset could always use better documentation,
whether as part of the official Superset docs,
2022-06-16 17:05:37 -04:00
in docstrings, or even on the web as blog posts or
2018-09-19 13:01:51 -04:00
articles. See [Documentation ](#documentation ) for more details.
2015-07-20 19:29:16 -04:00
2018-09-19 13:01:51 -04:00
### Add Translations
2018-08-25 19:31:03 -04:00
2019-07-04 01:33:14 -04:00
If you are proficient in a non-English language, you can help translate
text strings from Superset's UI. You can jump in to the existing
language dictionaries at
`superset/translations/<language_code>/LC_MESSAGES/messages.po` , or
even create a dictionary for a new language altogether.
See [Translating ](#translating ) for more details.
2015-07-20 19:29:16 -04:00
2018-09-19 13:01:51 -04:00
### Ask Questions
2017-11-02 16:49:47 -04:00
2018-09-19 13:01:51 -04:00
There is a dedicated [`apache-superset` tag ](https://stackoverflow.com/questions/tagged/apache-superset ) on [StackOverflow ](https://stackoverflow.com/ ). Please use it when asking questions.
2015-07-20 19:29:16 -04:00
2017-06-04 21:00:33 -04:00
## Pull Request Guidelines
2019-01-19 06:18:22 -05:00
A philosophy we would like to strongly encourage is
> Before creating a PR, create an issue.
The purpose is to separate problem from possible solutions.
**Bug fixes:** If you’ re only fixing a small bug, it’ s fine to submit a pull request right away but we highly recommend to file an issue detailing what you’ re fixing. This is helpful in case we don’ t accept that specific fix but want to keep track of the issue. Please keep in mind that the project maintainers reserve the rights to accept or reject incoming PRs, so it is better to separate the issue and the code to fix it from each other. In some cases, project maintainers may request you to create a separate issue from PR before proceeding.
**Refactor:** For small refactors, it can be a standalone PR itself detailing what you are refactoring and why. If there are concerns, project maintainers may request you to create a `#SIP` for the PR before proceeding.
2021-05-11 14:15:32 -04:00
**Feature/Large changes:** If you intend to change the public API, or make any non-trivial changes to the implementation, we require you to file a new issue as `#SIP` (Superset Improvement Proposal). This lets us reach an agreement on your proposal before you put significant effort into it. You are welcome to submit a PR along with the SIP (sometimes necessary for demonstration), but we will not review/merge the code until the SIP is approved.
2019-01-19 06:18:22 -05:00
In general, small PRs are always easier to review than large PRs. The best practice is to break your work into smaller independent PRs and refer to the same issue. This will greatly reduce turnaround time.
2021-01-23 02:52:57 -05:00
If you wish to share your work which is not ready to merge yet, create a [Draft PR ](https://github.blog/2019-02-14-introducing-draft-pull-requests/ ). This will enable maintainers and the CI runner to prioritize mature PR's.
2019-01-19 06:18:22 -05:00
Finally, never submit a PR that will put master branch in broken state. If the PR is part of multiple PRs to complete a large feature and cannot work on its own, you can create a feature branch and merge all related PRs into the feature branch before creating a PR from feature branch to master.
### Protocol
#### Authoring
- Fill in all sections of the PR template.
2022-03-18 09:42:14 -04:00
- Title the PR with one of the following semantic prefixes (inspired by [Karma ](http://karma-runner.github.io/0.10/dev/git-commit-msg.html )):
2021-01-11 02:36:01 -05:00
2020-10-22 21:34:41 -04:00
- `feat` (new feature)
- `fix` (bug fix)
- `docs` (changes to the documentation)
- `style` (formatting, missing semi colons, etc; no application logic change)
- `refactor` (refactoring code)
- `test` (adding missing tests, refactoring tests; no application logic change)
- `chore` (updating tasks etc; no application logic change)
- `perf` (performance-related change)
- `build` (build tooling, Docker configuration change)
2022-04-26 12:17:15 -04:00
- `ci` (test runner, GitHub Actions workflow changes)
2020-10-22 21:34:41 -04:00
- `other` (changes that don't correspond to the above -- should be rare!)
- Examples:
- `feat: export charts as ZIP files`
- `perf(api): improve API info performance`
- `fix(chart-api): cached-indicator always shows value is cached`
2019-01-19 06:18:22 -05:00
- Add prefix `[WIP]` to title if not ready for review (WIP = work-in-progress). We recommend creating a PR with `[WIP]` first and remove it once you have passed CI test and read through your code changes at least once.
2021-02-11 15:31:55 -05:00
- If you believe your PR contributes a potentially breaking change, put a `!` after the semantic prefix but before the colon in the PR title, like so: `feat!: Added foo functionality to bar`
2019-01-19 06:18:22 -05:00
- **Screenshots/GIFs:** Changes to user interface require before/after screenshots, or GIF for interactions
- Recommended capture tools ([Kap](https://getkap.co/), [LICEcap ](https://www.cockos.com/licecap/ ), [Skitch ](https://download.cnet.com/Skitch/3000-13455_4-189876.html ))
- If no screenshot is provided, the committers will mark the PR with `need:screenshot` label and will not review until screenshot is provided.
- **Dependencies:** Be careful about adding new dependency and avoid unnecessary dependencies.
- For Python, include it in `setup.py` denoting any specific restrictions and in `requirements.txt` pinned to a specific version which ensures that the application build is deterministic.
2020-02-24 17:31:23 -05:00
- For TypeScript/JavaScript, include new libraries in `package.json`
2019-01-19 06:18:22 -05:00
- **Tests:** The pull request should include tests, either as doctests, unit tests, or both. Make sure to resolve all errors and test failures. See [Testing ](#testing ) for how to run tests.
2020-09-12 01:59:12 -04:00
- **Documentation:** If the pull request adds functionality, the docs should be updated as part of the same PR.
2019-01-19 06:18:22 -05:00
- **CI:** Reviewers will not review the code until all CI tests are passed. Sometimes there can be flaky tests. You can close and open PR to re-run CI test. Please report if the issue persists. After the CI fix has been deployed to `master` , please rebase your PR.
- **Code coverage:** Please ensure that code coverage does not decrease.
- Remove `[WIP]` when ready for review. Please note that it may be merged soon after approved so please make sure the PR is ready to merge and do not expect more time for post-approval edits.
- If the PR was not ready for review and inactive for > 30 days, we will close it due to inactivity. The author is welcome to re-open and update.
#### Reviewing
- Use constructive tone when writing reviews.
- If there are changes required, state clearly what needs to be done before the PR can be approved.
- If you are asked to update your pull request with some changes there's no need to create a new one. Push your changes to the same branch.
- The committers reserve the right to reject any PR and in some cases may request the author to file an issue.
2021-03-09 13:19:43 -05:00
#### Test Environments
2021-04-08 14:05:59 -04:00
- Members of the Apache GitHub org can launch an ephemeral test environment directly on a pull request by creating a comment containing (only) the command `/testenv up` .
- Note that org membership must be public in order for this validation to function properly.
- Feature flags may be set for a test environment by specifying the flag name (prefixed with `FEATURE_` ) and value after the command.
- Format: `/testenv up FEATURE_<feature flag name>=true|false`
- Example: `/testenv up FEATURE_DASHBOARD_NATIVE_FILTERS=true`
- Multiple feature flags may be set in single command, separated by whitespace
2021-03-09 13:19:43 -05:00
- A comment will be created by the workflow script with the address and login information for the ephemeral environment.
- Test environments may be created once the Docker build CI workflow for the PR has completed successfully.
2021-04-08 14:05:59 -04:00
- Test environments do not currently update automatically when new commits are added to a pull request.
- Test environments do not currently support async workers, though this is planned.
2021-03-09 13:19:43 -05:00
- Running test environments will be shutdown upon closing the pull request.
2019-01-19 06:18:22 -05:00
#### Merging
- At least one approval is required for merging a PR.
- PR is usually left open for at least 24 hours before merging.
- After the PR is merged, [close the corresponding issue(s) ](https://help.github.com/articles/closing-issues-using-keywords/ ).
#### Post-merge Responsibility
- Project maintainers may contact the PR author if new issues are introduced by the PR.
- Project maintainers may revert your changes if a critical issue is found, such as breaking master branch CI.
2021-01-27 20:25:13 -05:00
## Design Guidelines
2021-01-22 18:47:55 -05:00
2021-01-27 20:25:13 -05:00
### Capitalization guidelines
2021-01-22 18:47:55 -05:00
2021-01-27 20:25:13 -05:00
#### Sentence case
2021-02-15 14:45:29 -05:00
Use sentence-case capitalization for everything in the UI (except these \*\*).
2021-01-22 18:47:55 -05:00
Sentence case is predominantly lowercase. Capitalize only the initial character of the first word, and other words that require capitalization, like:
2021-02-15 14:45:29 -05:00
2021-01-27 20:25:13 -05:00
- **Proper nouns.** Objects in the product _are not_ considered proper nouns e.g. dashboards, charts, saved queries etc. Proprietary feature names eg. SQL Lab, Preset Manager _are_ considered proper nouns
- **Acronyms** (e.g. CSS, HTML)
2021-01-22 18:47:55 -05:00
- When referring to **UI labels that are themselves capitalized** from sentence case (e.g. page titles - Dashboards page, Charts page, Saved queries page, etc.)
- User input that is reflected in the UI. E.g. a user-named a dashboard tab
2021-01-27 20:25:13 -05:00
**Sentence case vs. Title case:**
2021-01-22 18:47:55 -05:00
Title case: "A Dog Takes a Walk in Paris"
Sentence case: "A dog takes a walk in Paris"
2021-01-27 20:25:13 -05:00
**Why sentence case?**
2021-02-15 14:45:29 -05:00
2021-01-22 18:47:55 -05:00
- It’ s generally accepted as the quickest to read
- It’ s the easiest form to distinguish between common and proper nouns
2021-01-27 20:25:13 -05:00
#### How to refer to UI elements
2021-02-15 14:45:29 -05:00
2021-01-22 18:47:55 -05:00
When writing about a UI element, use the same capitalization as used in the UI.
For example, if an input field is labeled “Name” then you refer to this as the “Name input field”. Similarly, if a button has the label “Save” in it, then it is correct to refer to the “Save button”.
Where a product page is titled “Settings”, you refer to this in writing as follows:
“Edit your personal information on the Settings page”.
Often a product page will have the same title as the objects it contains. In this case, refer to the page as it appears in the UI, and the objects as common nouns:
- Upload a dashboard on the Dashboards page
- Go to Dashboards
- View dashboard
- View all dashboards
- Upload CSS templates on the CSS templates page
- Queries that you save will appear on the Saved queries page
- Create custom queries in SQL Lab then create dashboards
2021-02-15 14:45:29 -05:00
#### \*\*Exceptions to sentence case:
2021-01-29 17:47:57 -05:00
- Input labels, buttons and UI tabs are all caps
- User input values (e.g. column names, SQL Lab tab names) should be in their original case
2021-01-22 18:47:55 -05:00
2019-01-19 06:18:22 -05:00
## Managing Issues and PRs
To handle issues and PRs that are coming in, committers read issues/PRs and flag them with labels to categorize and help contributors spot where to take actions, as contributors usually have different expertises.
Triaging goals
- **For issues:** Categorize, screen issues, flag required actions from authors.
- **For PRs:** Categorize, flag required actions from authors. If PR is ready for review, flag required actions from reviewers.
First, add **Category labels (a.k.a. hash labels)** . Every issue/PR must have one hash label (except spam entry). Labels that begin with `#` defines issue/PR type:
2019-12-18 12:59:42 -05:00
| Label | for Issue | for PR |
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `#bug` | Bug report | Bug fix |
| `#code-quality` | Describe problem with code, architecture or productivity | Refactor, tests, tooling |
| `#feature` | New feature request | New feature implementation |
| `#refine` | Propose improvement that does not provide new features and is also not a bug fix nor refactor, such as adjust padding, refine UI style. | Implementation of improvement that does not provide new features and is also not a bug fix nor refactor, such as adjust padding, refine UI style. |
| `#doc` | Documentation | Documentation |
| `#question` | Troubleshooting: Installation, Running locally, Ask how to do something. Can be changed to `#bug` later. | N/A |
| `#SIP` | Superset Improvement Proposal | N/A |
| `#ASF` | Tasks related to Apache Software Foundation policy | Tasks related to Apache Software Foundation policy |
2019-01-19 06:18:22 -05:00
Then add other types of labels as appropriate.
- **Descriptive labels (a.k.a. dot labels):** These labels that begin with `.` describe the details of the issue/PR, such as `.ui` , `.js` , `.install` , `.backend` , etc. Each issue/PR can have zero or more dot labels.
- **Need labels:** These labels have pattern `need:xxx` , which describe the work required to progress, such as `need:rebase` , `need:update` , `need:screenshot` .
- **Risk labels:** These labels have pattern `risk:xxx` , which describe the potential risk on adopting the work, such as `risk:db-migration` . The intention was to better understand the impact and create awareness for PRs that need more rigorous testing.
- **Status labels:** These labels describe the status (`abandoned`, `wontfix` , `cant-reproduce` , etc.) Issue/PRs that are rejected or closed without completion should have one or more status labels.
- **Version labels:** These have the pattern `vx.x` such as `v0.28` . Version labels on issues describe the version the bug was reported on. Version labels on PR describe the first release that will include the PR.
Committers may also update title to reflect the issue/PR content if the author-provided title is not descriptive enough.
If the PR passes CI tests and does not have any `need:` labels, it is ready for review, add label `review` and/or `design-review` .
If an issue/PR has been inactive for >=30 days, it will be closed. If it does not have any status label, add `inactive` .
2017-06-04 21:00:33 -04:00
2021-03-24 22:23:56 -04:00
When creating a PR, if you're aiming to have it included in a specific release, please tag it with the version label. For example, to have a PR considered for inclusion in Superset 1.1 use the label `v1.1` .
2020-09-07 10:51:24 -04:00
## Reporting a Security Vulnerability
Please report security vulnerabilities to private@superset.apache.org.
In the event a community member discovers a security flaw in Superset, it is important to follow the [Apache Security Guidelines ](https://www.apache.org/security/committers.html ) and release a fix as quickly as possible before public disclosure. Reporting security vulnerabilities through the usual GitHub Issues channel is not ideal as it will publicize the flaw before a fix can be applied.
2020-01-29 20:47:58 -05:00
## Revert Guidelines
Reverting changes that are causing issues in the master branch is a normal and expected part of the development process. In an open source community, the ramifications of a change cannot always be fully understood. With that in mind, here are some considerations to keep in mind when considering a revert:
2022-01-19 15:56:52 -05:00
- **Availability of the PR author:** If the original PR author or the engineer who merged the code is highly available and can provide a fix in a reasonable time frame, this would counter-indicate reverting.
2020-01-29 20:47:58 -05:00
- **Severity of the issue:** How severe is the problem on master? Is it keeping the project from moving forward? Is there user impact? What percentage of users will experience a problem?
- **Size of the change being reverted:** Reverting a single small PR is a much lower-risk proposition than reverting a massive, multi-PR change.
- **Age of the change being reverted:** Reverting a recently-merged PR will be more acceptable than reverting an older PR. A bug discovered in an older PR is unlikely to be causing widespread serious issues.
- **Risk inherent in reverting:** Will the reversion break critical functionality? Is the medicine more dangerous than the disease?
- **Difficulty of crafting a fix:** In the case of issues with a clear solution, it may be preferable to implement and merge a fix rather than a revert.
Should you decide that reverting is desirable, it is the responsibility of the Contributor performing the revert to:
2020-02-24 17:31:23 -05:00
2020-01-29 20:47:58 -05:00
- **Contact the interested parties:** The PR's author and the engineer who merged the work should both be contacted and informed of the revert.
- **Provide concise reproduction steps:** Ensure that the issue can be clearly understood and duplicated by the original author of the PR.
- **Put the revert through code review:** The revert must be approved by another committer.
2018-12-11 16:45:50 -05:00
## Setup Local Environment for Development
2015-07-20 19:29:16 -04:00
2018-12-11 16:45:50 -05:00
First, [fork the repository on GitHub ](https://help.github.com/articles/about-forks/ ), then clone it. You can clone the main repository directly, but you won't be able to send pull requests.
2018-09-19 13:01:51 -04:00
```bash
2021-01-06 06:45:19 -05:00
git clone git@github.com:your-username/superset.git
cd superset
2018-09-19 13:01:51 -04:00
```
### Documentation
2020-09-12 01:59:12 -04:00
The latest documentation and tutorial are available at https://superset.apache.org/.
2017-01-25 14:41:39 -05:00
2022-06-16 17:05:37 -04:00
The documentation site is built using [Docusaurus 2 ](https://docusaurus.io/ ), a modern static website generator, the source for which resides in `./docs` .
2017-01-25 14:41:39 -05:00
2022-06-16 17:05:37 -04:00
#### Local Development
2018-09-19 13:01:51 -04:00
2022-06-16 17:05:37 -04:00
To set up a local development environment with hot reloading for the documentation site:
2017-01-25 14:41:39 -05:00
2022-06-16 17:05:37 -04:00
```shell
cd docs
yarn install # Installs NPM dependencies
yarn start # Starts development server at http://localhost:3000
```
#### Build
To create and serve a production build of the documentation site:
2017-01-25 14:41:39 -05:00
2022-06-16 17:05:37 -04:00
```shell
yarn build
yarn serve
```
#### Deployment
2017-01-25 14:41:39 -05:00
2022-10-18 21:54:49 -04:00
Commits to `master` trigger a rebuild and redeploy of the documentation site. Submit pull requests that modify the documentation with the `docs:` prefix.
2017-01-25 14:41:39 -05:00
2018-09-19 13:01:51 -04:00
### Flask server
2016-01-13 12:03:27 -05:00
2019-05-20 20:06:08 -04:00
#### OS Dependencies
2021-11-12 15:28:17 -05:00
Make sure your machine meets the [OS dependencies ](https://superset.apache.org/docs/installation/installing-superset-from-scratch#os-dependencies ) before following these steps.
2021-07-01 07:11:03 -04:00
You also need to install MySQL or [MariaDB ](https://mariadb.com/downloads ).
2019-05-20 20:06:08 -04:00
2022-12-03 02:25:11 -05:00
Ensure that you are using Python version 3.8, 3.9, 3.10 or 3.11, then proceed with:
2016-01-13 12:03:27 -05:00
2022-03-23 17:20:08 -04:00
```bash
2021-01-25 15:33:57 -05:00
# Create a virtual environment and activate it (recommended)
2020-09-14 11:12:53 -04:00
python3 -m venv venv # setup a python3 virtualenv
2018-09-19 13:01:51 -04:00
source venv/bin/activate
2016-01-13 12:03:27 -05:00
2018-09-19 13:01:51 -04:00
# Install external dependencies
2021-07-01 07:11:03 -04:00
pip install -r requirements/testing.txt
2019-05-20 20:06:08 -04:00
2018-09-19 13:01:51 -04:00
# Install Superset in editable (development) mode
pip install -e .
2015-07-20 19:29:16 -04:00
2018-09-19 13:01:51 -04:00
# Initialize the database
superset db upgrade
2016-01-13 12:03:27 -05:00
2021-11-10 07:46:08 -05:00
# Create an admin user in your metadata database (use `admin` as username to be able to load the examples)
superset fab create-admin
2018-09-19 13:01:51 -04:00
# Create default roles and permissions
superset init
2016-01-13 12:03:27 -05:00
2021-07-01 07:11:03 -04:00
# Load some data to play with.
# Note: you MUST have previously created an admin user with the username `admin` for this command to work.
2021-04-06 03:30:50 -04:00
superset load-examples
2016-01-13 12:03:27 -05:00
2019-05-20 20:06:08 -04:00
# Start the Flask dev web server from inside your virtualenv.
2021-07-01 07:11:03 -04:00
# Note that your page may not have CSS at this point.
2018-12-11 16:45:50 -05:00
# See instructions below how to build the front-end assets.
2019-05-20 20:06:08 -04:00
FLASK_ENV=development superset run -p 8088 --with-threads --reload --debugger
2021-07-13 15:26:29 -04:00
```
2021-04-22 17:54:12 -04:00
Or you can install via our Makefile
```bash
# Create a virtual environment and activate it (recommended)
$ python3 -m venv venv # setup a python3 virtualenv
$ source venv/bin/activate
# install pip packages + pre-commit
$ make install
# Install superset pip packages and setup env only
$ make superset
# Setup pre-commit only
$ make pre-commit
2022-03-23 17:20:08 -04:00
```
2016-02-27 10:47:56 -05:00
2019-12-18 12:59:42 -05:00
**Note: the FLASK_APP env var should not need to be set, as it's currently controlled
via `.flaskenv` , however if needed, it should be set to `superset.app:create_app()` **
2019-12-06 16:15:12 -05:00
2019-06-09 22:13:43 -04:00
If you have made changes to the FAB-managed templates, which are not built the same way as the newer, React-powered front-end assets, you need to start the app without the `--with-threads` argument like so:
`FLASK_ENV=development superset run -p 8088 --reload --debugger`
2021-07-13 15:26:29 -04:00
#### Dependencies
If you add a new requirement or update an existing requirement (per the `install_requires` section in `setup.py` ) you must recompile (freeze) the Python dependencies to ensure that for CI, testing, etc. the build is deterministic. This can be achieved via,
```bash
$ python3 -m venv venv
$ source venv/bin/activate
$ python3 -m pip install -r requirements/integration.txt
$ pip-compile-multi --no-upgrade
```
2022-01-07 08:29:13 -05:00
When upgrading the version number of a single package, you should run `pip-compile-multi` with the `-P` flag:
```bash
$ pip-compile-multi -P my-package
```
To bring all dependencies up to date as per the restrictions defined in `setup.py` and `requirements/*.in` , run pip-compile-multi` without any flags:
```bash
$ pip-compile-multi
```
2022-04-26 12:17:15 -04:00
This should be done periodically, but it is recommended to do thorough manual testing of the application to ensure no breaking changes have been introduced that aren't caught by the unit and integration tests.
2022-01-07 08:29:13 -05:00
2019-05-08 16:05:01 -04:00
#### Logging to the browser console
This feature is only available on Python 3. When debugging your application, you can have the server logs sent directly to the browser console using the [ConsoleLog ](https://github.com/betodealmeida/consolelog ) package. You need to mutate the app, by adding the following to your `config.py` or `superset_config.py` :
```python
from console_log import ConsoleLog
def FLASK_APP_MUTATOR(app):
app.wsgi_app = ConsoleLog(app.wsgi_app, app.logger)
```
Then make sure you run your WSGI server using the right worker type:
```bash
2019-12-06 16:15:12 -05:00
FLASK_ENV=development gunicorn "superset.app:create_app()" -k "geventwebsocket.gunicorn.workers.GeventWebSocketWorker" -b 127.0.0.1:8088 --reload
2019-05-08 16:05:01 -04:00
```
You can log anything to the browser console, including objects:
```python
from superset import app
app.logger.error('An exception occurred!')
app.logger.info(form_data)
```
2021-01-11 02:36:01 -05:00
### Frontend
Frontend assets (TypeScript, JavaScript, CSS, and images) must be compiled in order to properly display the web UI. The `superset-frontend` directory contains all NPM-managed frontend assets. Note that for some legacy pages there are additional frontend assets bundled with Flask-Appbuilder (e.g. jQuery and bootstrap). These are not managed by NPM and may be phased out in the future.
2016-02-27 10:47:56 -05:00
2021-01-11 02:36:01 -05:00
#### Prerequisite
2016-02-27 10:47:56 -05:00
2021-01-11 02:36:01 -05:00
##### nvm and node
2019-05-20 20:06:08 -04:00
2021-09-25 01:26:35 -04:00
First, be sure you are using the following versions of Node.js and npm:
2021-11-12 15:28:17 -05:00
2021-09-25 01:26:35 -04:00
- `Node.js` : Version 16
- `npm` : Version 7
We recommend using [nvm ](https://github.com/nvm-sh/nvm ) to manage your node environment:
2019-05-20 20:06:08 -04:00
```bash
2020-11-10 18:58:54 -05:00
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.37.0/install.sh | bash
2023-04-13 17:48:46 -04:00
incase it shows '-bash: nvm: command not found'
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm
[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion" # This loads nvm bash_completion
2020-11-10 18:58:54 -05:00
cd superset-frontend
2021-05-10 06:28:32 -04:00
nvm install --lts
nvm use --lts
2019-05-20 20:06:08 -04:00
```
2016-02-27 10:47:56 -05:00
2021-03-17 14:57:13 -04:00
Or if you use the default macOS starting with Catalina shell `zsh` , try:
2021-06-14 13:23:51 -04:00
2021-03-17 14:57:13 -04:00
```zsh
sh -c "$(curl -fsSL https://raw.githubusercontent.com/nvm-sh/nvm/v0.37.0/install.sh)"
```
2020-11-10 18:58:54 -05:00
For those interested, you may also try out [avn ](https://github.com/nvm-sh/nvm#deeper-shell-integration ) to automatically switch to the node version that is required to run Superset frontend.
2021-01-11 02:36:01 -05:00
#### Install dependencies
2016-02-27 10:47:56 -05:00
2021-01-11 02:36:01 -05:00
Install third-party dependencies listed in `package.json` via:
2017-02-16 20:28:35 -05:00
2018-12-11 16:45:50 -05:00
```bash
# From the root of the repository
2020-02-09 20:53:56 -05:00
cd superset-frontend
2016-02-27 10:47:56 -05:00
2018-12-21 13:24:49 -05:00
# Install dependencies from `package-lock.json`
npm ci
2016-02-27 10:47:56 -05:00
```
2021-01-11 02:36:01 -05:00
#### Build assets
There are three types of assets you can build:
1. `npm run build` : the production assets, CSS/JSS minified and optimized
2. `npm run dev-server` : local development assets, with sourcemaps and hot refresh support
3. `npm run build-instrumented` : instrumented application code for collecting code coverage from Cypress tests
2023-04-30 13:13:58 -04:00
If this type of error comes while building assets(i.e using above commands):
```bash
Error: You must provide the URL of lib/mappings.wasm by calling SourceMapConsumer.initialize
```
Then put this:
```bash
2023-05-30 11:38:52 -04:00
export NODE_OPTIONS=--no-experimental-fetch
2023-04-30 13:13:58 -04:00
```
2021-01-11 02:36:01 -05:00
#### Webpack dev server
2016-02-27 10:47:56 -05:00
2022-05-11 12:07:48 -04:00
The dev server by default starts at `http://localhost:9000` and proxies the backend requests to `http://localhost:8088` .
So a typical development workflow is the following:
1. [run Superset locally ](#flask-server ) using Flask, on port `8088` — but don't access it directly,< br />
```bash
# Install Superset and dependencies, plus load your virtual environment first, as detailed above.
FLASK_ENV=development superset run -p 8088 --with-threads --reload --debugger
```
2. in parallel, run the Webpack dev server locally on port `9000` ,< br />
```bash
npm run dev-server
```
3. access `http://localhost:9000` (the Webpack server, _not_ Flask) in your web browser. This will use the hot-reloading front-end assets from the Webpack development server while redirecting back-end queries to Flask/Superset: your changes on Superset codebase — either front or back-end — will then be reflected live in the browser.
It's possible to change the Webpack server settings:
2018-09-04 13:39:05 -04:00
```bash
2021-01-11 02:36:01 -05:00
# Start the dev server at http://localhost:9000
2018-09-04 13:39:05 -04:00
npm run dev-server
2018-09-19 13:01:51 -04:00
# Run the dev server on a non-default port
2021-12-16 10:24:41 -05:00
npm run dev-server -- --port=9001
2018-09-04 13:39:05 -04:00
2021-01-11 02:36:01 -05:00
# Proxy backend requests to a Flask server running on a non-default port
2018-09-04 13:39:05 -04:00
npm run dev-server -- --supersetPort=8081
2020-03-17 18:37:07 -04:00
2021-01-11 02:36:01 -05:00
# Proxy to a remote backend but serve local assets
2020-03-17 18:37:07 -04:00
npm run dev-server -- --superset=https://superset-dev.example.com
2018-09-04 13:39:05 -04:00
```
2021-01-11 02:36:01 -05:00
The `--superset=` option is useful in case you want to debug a production issue or have to setup Superset behind a firewall. It allows you to run Flask server in another environment while keep assets building locally for the best developer experience.
2018-12-11 16:45:50 -05:00
2021-01-11 02:36:01 -05:00
#### Other npm commands
2018-12-11 16:45:50 -05:00
2021-01-11 02:36:01 -05:00
Alternatively, there are other NPM commands you may find useful:
2018-12-11 16:45:50 -05:00
2021-01-11 02:36:01 -05:00
1. `npm run build-dev` : build assets in development mode.
2. `npm run dev` : built dev assets in watch mode, will automatically rebuild when a file changes
2019-05-20 20:06:08 -04:00
2019-12-06 16:15:12 -05:00
#### Docker (docker-compose)
2019-12-03 13:37:18 -05:00
See docs [here ](docker/README.md )
2018-12-11 16:45:50 -05:00
#### Updating NPM packages
2018-03-23 18:31:47 -04:00
2018-12-21 13:24:49 -05:00
Use npm in the prescribed way, making sure that
2020-02-09 20:53:56 -05:00
`superset-frontend/package-lock.json` is updated according to `npm` -prescribed
2018-12-21 13:24:49 -05:00
best practices.
2018-03-23 18:31:47 -04:00
2018-10-24 01:33:51 -04:00
#### Feature flags
Superset supports a server-wide feature flag system, which eases the incremental development of features. To add a new feature flag, simply modify `superset_config.py` with something like the following:
2019-12-18 12:59:42 -05:00
2020-02-25 11:44:26 -05:00
```python
2018-10-24 01:33:51 -04:00
FEATURE_FLAGS = {
'SCOPED_FILTER': True,
}
```
2019-12-18 12:59:42 -05:00
2023-04-25 11:18:27 -04:00
If you want to use the same flag in the client code, also add it to the FeatureFlag TypeScript enum in [@superset-ui/core ](https://github.com/apache/superset/blob/master/superset-frontend/packages/superset-ui-core/src/utils/featureFlags.ts ). For example,
2019-12-18 12:59:42 -05:00
2020-02-25 11:44:26 -05:00
```typescript
2018-10-24 01:33:51 -04:00
export enum FeatureFlag {
2021-01-11 02:36:01 -05:00
SCOPED_FILTER = "SCOPED_FILTER",
2018-10-24 01:33:51 -04:00
}
```
2021-06-29 09:52:01 -04:00
`superset/config.py` contains `DEFAULT_FEATURE_FLAGS` which will be overwritten by
those specified under FEATURE_FLAGS in `superset_config.py` . For example, `DEFAULT_FEATURE_FLAGS = { 'FOO': True, 'BAR': False }` in `superset/config.py` and `FEATURE_FLAGS = { 'BAR': True, 'BAZ': True }` in `superset_config.py` will result
in combined feature flags of `{ 'FOO': True, 'BAR': True, 'BAZ': True }` .
2019-01-29 23:23:13 -05:00
2021-03-16 17:11:17 -04:00
The current status of the usability of each flag (stable vs testing, etc) can be found in `RESOURCES/FEATURE_FLAGS.md` .
2019-06-25 16:34:48 -04:00
## Git Hooks
Superset uses Git pre-commit hooks courtesy of [pre-commit ](https://pre-commit.com/ ). To install run the following:
```bash
2020-08-04 22:31:52 -04:00
pip3 install -r requirements/integration.txt
2019-06-25 16:34:48 -04:00
pre-commit install
```
2021-03-08 19:45:37 -05:00
A series of checks will now run when you make a git commit.
2021-02-05 17:32:03 -05:00
Alternatively it is possible to run pre-commit via tox:
2021-01-18 02:14:08 -05:00
```bash
tox -e pre-commit
```
2021-03-08 19:45:37 -05:00
Or by running pre-commit manually:
2021-06-14 13:23:51 -04:00
2021-03-08 19:45:37 -05:00
```bash
pre-commit run --all-files
```
2018-12-11 16:45:50 -05:00
## Linting
2021-10-07 13:38:40 -04:00
### Python
We use [Pylint ](https://pylint.org/ ) for linting which can be invoked via:
2018-12-11 16:45:50 -05:00
```bash
# for python
2021-01-18 02:14:08 -05:00
tox -e pylint
2021-10-07 13:38:40 -04:00
```
2018-12-11 16:45:50 -05:00
2022-04-26 12:17:15 -04:00
In terms of best practices please avoid blanket disablement of Pylint messages globally (via `.pylintrc` ) or top-level within the file header, albeit there being a few exceptions. Disablement should occur inline as it prevents masking issues and provides context as to why said message is disabled.
2021-03-08 19:45:37 -05:00
2022-03-18 09:42:14 -04:00
Additionally, the Python code is auto-formatted using [Black ](https://github.com/python/black ) which
is configured as a pre-commit hook. There are also numerous [editor integrations ](https://black.readthedocs.io/en/stable/integrations/editors.html )
2021-03-08 19:45:37 -05:00
2021-10-07 13:38:40 -04:00
### TypeScript
```bash
2020-02-09 20:53:56 -05:00
cd superset-frontend
2018-12-21 13:24:49 -05:00
npm ci
2018-12-11 16:45:50 -05:00
npm run lint
```
2021-10-11 18:16:43 -04:00
If using the eslint extension with vscode, put the following in your workspace `settings.json` file:
```json
"eslint.workingDirectories": [
"superset-frontend"
]
```
2019-10-18 17:44:27 -04:00
## Conventions
2021-12-17 13:34:20 -05:00
### Python Conventions
2019-10-18 17:44:27 -04:00
2021-06-14 13:23:51 -04:00
Parameters in the `config.py` (which are accessible via the Flask app.config dictionary) are assumed to always be defined and thus should be accessed directly via,
2019-10-18 17:44:27 -04:00
```python
blueprints = app.config["BLUEPRINTS"]
```
rather than,
```python
blueprints = app.config.get("BLUEPRINTS")
```
or similar as the later will cause typing issues. The former is of type `List[Callable]` whereas the later is of type `Optional[List[Callable]]` .
2020-02-24 17:31:23 -05:00
## Typing
2021-12-17 13:34:20 -05:00
### Python Typing
2020-02-24 17:31:23 -05:00
To ensure clarity, consistency, all readability, _all_ new functions should use
[type hints ](https://docs.python.org/3/library/typing.html ) and include a
2020-09-12 01:59:12 -04:00
docstring.
2020-02-24 17:31:23 -05:00
Note per [PEP-484 ](https://www.python.org/dev/peps/pep-0484/#exceptions ) no
syntax for listing explicitly raised exceptions is proposed and thus the
recommendation is to put this information in a docstring, i.e.,
```python
import math
from typing import Union
def sqrt(x: Union[float, int]) -> Union[float, int]:
"""
Return the square root of x.
:param x: A number
:returns: The square root of the given number
:raises ValueError: If the number is negative
"""
return math.sqrt(x)
```
2021-12-17 13:34:20 -05:00
### TypeScript Typing
2020-02-24 17:31:23 -05:00
2021-01-06 06:45:19 -05:00
TypeScript is fully supported and is the recommended language for writing all new frontend components. When modifying existing functions/components, migrating to TypeScript is appreciated, but not required. Examples of migrating functions/components to TypeScript can be found in [#9162 ](https://github.com/apache/superset/pull/9162 ) and [#9180 ](https://github.com/apache/superset/pull/9180 ).
2020-02-24 17:31:23 -05:00
2016-01-13 12:03:27 -05:00
## Testing
2018-09-19 13:01:51 -04:00
2018-12-11 16:45:50 -05:00
### Python Testing
2019-03-18 02:21:32 -04:00
All python tests are carried out in [tox ](https://tox.readthedocs.io/en/latest/index.html )
2018-12-11 16:45:50 -05:00
a standardized testing framework.
2019-03-18 02:21:32 -04:00
All python tests can be run with any of the tox [environments ](https://tox.readthedocs.io/en/latest/example/basic.html#a-simple-tox-ini-default-environments ), via,
2015-07-20 19:29:16 -04:00
2018-09-19 13:01:51 -04:00
```bash
tox -e < environment >
```
2018-04-10 18:59:44 -04:00
2018-12-11 16:45:50 -05:00
For example,
2017-06-21 15:52:04 -04:00
2018-09-19 13:01:51 -04:00
```bash
2021-01-28 02:52:35 -05:00
tox -e py38
2018-09-19 13:01:51 -04:00
```
2015-07-20 19:29:16 -04:00
2018-04-10 18:59:44 -04:00
Alternatively, you can run all tests in a single file via,
2018-03-14 19:50:25 -04:00
2018-09-19 13:01:51 -04:00
```bash
tox -e < environment > -- tests/test_file.py
```
2017-10-12 23:53:37 -04:00
2018-04-10 18:59:44 -04:00
or for a specific test via,
2018-03-14 19:50:25 -04:00
2018-09-19 13:01:51 -04:00
```bash
2020-11-17 14:55:47 -05:00
tox -e < environment > -- tests/test_file.py::TestClassName::test_method_name
2018-09-19 13:01:51 -04:00
```
2018-04-10 18:59:44 -04:00
Note that the test environment uses a temporary directory for defining the
SQLite databases which will be cleared each time before the group of test
commands are invoked.
2015-07-20 19:29:16 -04:00
2021-11-12 15:28:17 -05:00
There is also a utility script included in the Superset codebase to run python integration tests. The [readme can be
2021-03-08 19:45:37 -05:00
found here](https://github.com/apache/superset/tree/master/scripts/tests)
2021-11-12 15:28:17 -05:00
To run all integration tests for example, run this script from the root directory:
2021-06-14 13:23:51 -04:00
2021-03-08 19:45:37 -05:00
```bash
scripts/tests/run.sh
```
2021-11-12 15:28:17 -05:00
You can run unit tests found in './tests/unit_tests' for example with pytest. It is a simple way to run an isolated test that doesn't need any database setup
```bash
pytest ./link_to_test.py
```
2020-02-24 17:31:23 -05:00
### Frontend Testing
2018-09-19 13:01:51 -04:00
2020-02-24 17:31:23 -05:00
We use [Jest ](https://jestjs.io/ ) and [Enzyme ](https://airbnb.io/enzyme/ ) to test TypeScript/JavaScript. Tests can be run with:
2016-07-19 19:14:04 -04:00
2018-09-19 13:01:51 -04:00
```bash
2020-02-09 20:53:56 -05:00
cd superset-frontend
2018-09-19 13:01:51 -04:00
npm run test
```
feat(SIP-39): Async query support for charts (#11499)
* Generate JWT in Flask app
* Refactor chart data API query logic, add JWT validation and async worker
* Add redis stream implementation, refactoring
* Add chart data cache endpoint, refactor QueryContext caching
* Typing, linting, refactoring
* pytest fixes and openapi schema update
* Enforce caching be configured for async query init
* Async query processing for explore_json endpoint
* Add /api/v1/async_event endpoint
* Async frontend for dashboards [WIP]
* Chart async error message support, refactoring
* Abstract asyncEvent middleware
* Async chart loading for Explore
* Pylint fixes
* asyncEvent middleware -> TypeScript, JS linting
* Chart data API: enforce forced_cache, add tests
* Add tests for explore_json endpoints
* Add test for chart data cache enpoint (no login)
* Consolidate set_and_log_cache and add STORE_CACHE_KEYS_IN_METADATA_DB flag
* Add tests for tasks/async_queries and address PR comments
* Bypass non-JSON result formats for async queries
* Add tests for redux middleware
* Remove debug statement
Co-authored-by: Ville Brofeldt <33317356+villebro@users.noreply.github.com>
* Skip force_cached if no queryObj
* SunburstViz: don't modify self.form_data
* Fix failing annotation test
* Resolve merge/lint issues
* Reduce polling delay
* Fix new getClientErrorObject reference
* Fix flakey unit tests
* /api/v1/async_event: increment redis stream ID, add tests
* PR feedback: refactoring, configuration
* Fixup: remove debugging
* Fix typescript errors due to redux upgrade
* Update UPDATING.md
* Fix failing py tests
* asyncEvent_spec.js -> asyncEvent_spec.ts
* Refactor flakey Python 3.7 mock assertions
* Fix another shared state issue in Py tests
* Use 'sub' claim in JWT for user_id
* Refactor async middleware config
* Fixup: restore FeatureFlag boolean type
Co-authored-by: Ville Brofeldt <33317356+villebro@users.noreply.github.com>
2020-12-10 23:21:56 -05:00
To run a single test file:
2021-01-20 13:50:24 -05:00
feat(SIP-39): Async query support for charts (#11499)
* Generate JWT in Flask app
* Refactor chart data API query logic, add JWT validation and async worker
* Add redis stream implementation, refactoring
* Add chart data cache endpoint, refactor QueryContext caching
* Typing, linting, refactoring
* pytest fixes and openapi schema update
* Enforce caching be configured for async query init
* Async query processing for explore_json endpoint
* Add /api/v1/async_event endpoint
* Async frontend for dashboards [WIP]
* Chart async error message support, refactoring
* Abstract asyncEvent middleware
* Async chart loading for Explore
* Pylint fixes
* asyncEvent middleware -> TypeScript, JS linting
* Chart data API: enforce forced_cache, add tests
* Add tests for explore_json endpoints
* Add test for chart data cache enpoint (no login)
* Consolidate set_and_log_cache and add STORE_CACHE_KEYS_IN_METADATA_DB flag
* Add tests for tasks/async_queries and address PR comments
* Bypass non-JSON result formats for async queries
* Add tests for redux middleware
* Remove debug statement
Co-authored-by: Ville Brofeldt <33317356+villebro@users.noreply.github.com>
* Skip force_cached if no queryObj
* SunburstViz: don't modify self.form_data
* Fix failing annotation test
* Resolve merge/lint issues
* Reduce polling delay
* Fix new getClientErrorObject reference
* Fix flakey unit tests
* /api/v1/async_event: increment redis stream ID, add tests
* PR feedback: refactoring, configuration
* Fixup: remove debugging
* Fix typescript errors due to redux upgrade
* Update UPDATING.md
* Fix failing py tests
* asyncEvent_spec.js -> asyncEvent_spec.ts
* Refactor flakey Python 3.7 mock assertions
* Fix another shared state issue in Py tests
* Use 'sub' claim in JWT for user_id
* Refactor async middleware config
* Fixup: restore FeatureFlag boolean type
Co-authored-by: Ville Brofeldt <33317356+villebro@users.noreply.github.com>
2020-12-10 23:21:56 -05:00
```bash
npm run test -- path/to/file.js
```
2018-12-11 16:45:50 -05:00
### Integration Testing
2016-07-19 19:14:04 -04:00
2018-09-07 13:26:51 -04:00
We use [Cypress ](https://www.cypress.io/ ) for integration tests. Tests can be run by `tox -e cypress` . To open Cypress and explore tests first setup and run test server:
2018-09-19 13:01:51 -04:00
```bash
2021-07-01 11:03:07 -04:00
export SUPERSET_CONFIG=tests.integration_tests.superset_test_config
2020-11-10 18:51:47 -05:00
export SUPERSET_TESTENV=true
2020-09-16 15:31:03 -04:00
export CYPRESS_BASE_URL="http://localhost:8081"
2018-09-19 13:01:51 -04:00
superset db upgrade
superset load_test_users
2021-04-06 03:30:50 -04:00
superset load-examples --load-test-data
2020-11-10 18:51:47 -05:00
superset init
2019-05-20 20:06:08 -04:00
superset run --port 8081
2018-09-19 13:01:51 -04:00
```
2018-09-07 13:26:51 -04:00
2018-09-19 13:01:51 -04:00
Run Cypress tests:
2018-09-07 13:26:51 -04:00
2018-09-19 13:01:51 -04:00
```bash
2020-02-09 20:53:56 -05:00
cd superset-frontend
2020-11-10 18:51:47 -05:00
npm run build-instrumented
2019-12-18 12:59:42 -05:00
cd cypress-base
npm install
2020-11-10 18:51:47 -05:00
# run tests via headless Chrome browser (requires Chrome 64+)
npm run cypress-run-chrome
Fix control validation handling (#7231)
Fixes a series of unexpected things around control validation.
* when a chart opens in a state where a control is invalid, it still
runs the query, and sometimes gets stuck in what appears to be a 'running'
state. After this change, no query is run, and a warning is displayed
in the chart panel body, just like any other error would
* validation used to be done in the <Control> component and alter the
redux store as it went. Clearly this is not the right approach, now
validation occurs on loading the initial redux state, as well as in
the reducer when controls are changed
* currently, when going from a invalid control state to a valid one
(user addresses what is needed), it auto-triggers a query which can be
unexpected. After this change, the error message disappears, and the
"Run Query" overlay gets displayed
* when changing viz type, it's common to get new validation
errors, and currently when that occurs it will still go ahead and run
a query with invalid inputs, which often results in errors
that are not well handled, since much of the logic
assumes control-validated input.
* prettier control validation messages
(cherry picked from commit a3212eba5df95bca834d8d6d98c11d522d9172f3)
2019-04-18 14:36:38 -04:00
# run tests from a specific file
2023-04-26 10:17:59 -04:00
npm run cypress-run-chrome -- --spec cypress/e2e/explore/link.test.ts
Fix control validation handling (#7231)
Fixes a series of unexpected things around control validation.
* when a chart opens in a state where a control is invalid, it still
runs the query, and sometimes gets stuck in what appears to be a 'running'
state. After this change, no query is run, and a warning is displayed
in the chart panel body, just like any other error would
* validation used to be done in the <Control> component and alter the
redux store as it went. Clearly this is not the right approach, now
validation occurs on loading the initial redux state, as well as in
the reducer when controls are changed
* currently, when going from a invalid control state to a valid one
(user addresses what is needed), it auto-triggers a query which can be
unexpected. After this change, the error message disappears, and the
"Run Query" overlay gets displayed
* when changing viz type, it's common to get new validation
errors, and currently when that occurs it will still go ahead and run
a query with invalid inputs, which often results in errors
that are not well handled, since much of the logic
assumes control-validated input.
* prettier control validation messages
(cherry picked from commit a3212eba5df95bca834d8d6d98c11d522d9172f3)
2019-04-18 14:36:38 -04:00
# run specific file with video capture
2023-04-26 10:17:59 -04:00
npm run cypress-run-chrome -- --spec cypress/e2e/dashboard/index.test.js --config video=true
2019-12-18 12:59:42 -05:00
# to open the cypress ui
2020-11-10 18:51:47 -05:00
npm run cypress-debug
2020-09-16 15:31:03 -04:00
# to point cypress to a url other than the default (http://localhost:8088) set the environment variable before running the script
# e.g., CYPRESS_BASE_URL="http://localhost:9000"
CYPRESS_BASE_URL=< your url > npm run cypress open
2018-09-19 13:01:51 -04:00
```
2018-09-07 13:26:51 -04:00
2021-01-06 06:45:19 -05:00
See [`superset-frontend/cypress_build.sh` ](https://github.com/apache/superset/blob/master/superset-frontend/cypress_build.sh ).
2019-05-20 20:06:08 -04:00
2020-12-14 11:06:19 -05:00
As an alternative you can use docker-compose environment for testing:
Make sure you have added below line to your /etc/hosts file:
2021-01-20 13:50:24 -05:00
`127.0.0.1 db`
2020-12-14 11:06:19 -05:00
If you already have launched Docker environment please use the following command to assure a fresh database instance:
2021-01-20 13:50:24 -05:00
`docker-compose down -v`
2020-12-14 11:06:19 -05:00
Launch environment:
2021-01-20 13:50:24 -05:00
`CYPRESS_CONFIG=true docker-compose up`
2020-12-14 11:06:19 -05:00
It will serve backend and frontend on port 8088.
2020-12-15 12:07:34 -05:00
Run Cypress tests:
2020-12-14 11:06:19 -05:00
```bash
cd cypress-base
npm install
2020-12-15 12:07:34 -05:00
npm run cypress open
2020-12-14 11:06:19 -05:00
```
2021-03-31 14:12:11 -04:00
### Debugging Server App
2023-04-07 18:19:15 -04:00
#### Local
For debugging locally using VSCode, you can configure a launch configuration file .vscode/launch.json such as
```json
{
"version": "0.2.0",
"configurations": [
{
"name": "Python: Flask",
"type": "python",
"request": "launch",
"module": "flask",
"env": {
"FLASK_APP": "superset",
"FLASK_ENV": "development"
},
"args": [
"run",
"-p 8088",
"--with-threads",
"--reload",
"--debugger"
],
"jinja": true,
"justMyCode": true
}
]
}
```
#### Docker
2021-03-31 14:12:11 -04:00
Follow these instructions to debug the Flask app running inside a docker container.
First add the following to the ./docker-compose.yaml file
```diff
superset:
env_file: docker/.env
image: *superset-image
container_name: superset_app
command: ["/app/docker/docker-bootstrap.sh", "app"]
restart: unless-stopped
+ cap_add:
+ - SYS_PTRACE
ports:
- 8088:8088
+ - 5678:5678
user: "root"
depends_on: *superset-depends-on
volumes: *superset-volumes
environment:
CYPRESS_CONFIG: "${CYPRESS_CONFIG}"
```
Start Superset as usual
2021-06-14 13:23:51 -04:00
2021-03-31 14:12:11 -04:00
```bash
docker-compose up
```
Install the required libraries and packages to the docker container
Enter the superset_app container
2021-06-14 13:23:51 -04:00
2021-03-31 14:12:11 -04:00
```bash
docker exec -it superset_app /bin/bash
root@39ce8cf9d6ab:/app#
```
Run the following commands inside the container
2021-06-14 13:23:51 -04:00
2021-03-31 14:12:11 -04:00
```bash
apt update
apt install -y gdb
apt install -y net-tools
pip install debugpy
```
2021-11-09 10:44:10 -05:00
Find the PID for the Flask process. Make sure to use the first PID. The Flask app will re-spawn a sub-process every time you change any of the python code. So it's important to use the first PID.
2021-03-31 14:12:11 -04:00
```bash
ps -ef
UID PID PPID C STIME TTY TIME CMD
root 1 0 0 14:09 ? 00:00:00 bash /app/docker/docker-bootstrap.sh app
root 6 1 4 14:09 ? 00:00:04 /usr/local/bin/python /usr/bin/flask run -p 8088 --with-threads --reload --debugger --host=0.0.0.0
root 10 6 7 14:09 ? 00:00:07 /usr/local/bin/python /usr/bin/flask run -p 8088 --with-threads --reload --debugger --host=0.0.0.0
```
Inject debugpy into the running Flask process. In this case PID 6.
2021-06-14 13:23:51 -04:00
2021-03-31 14:12:11 -04:00
```bash
python3 -m debugpy --listen 0.0.0.0:5678 --pid 6
```
Verify that debugpy is listening on port 5678
2021-06-14 13:23:51 -04:00
2021-03-31 14:12:11 -04:00
```bash
netstat -tunap
Active Internet connections (servers and established)
Proto Recv-Q Send-Q Local Address Foreign Address State PID/Program name
tcp 0 0 0.0.0.0:5678 0.0.0.0:* LISTEN 462/python
tcp 0 0 0.0.0.0:8088 0.0.0.0:* LISTEN 6/python
```
You are now ready to attach a debugger to the process. Using VSCode you can configure a launch configuration file .vscode/launch.json like so.
2021-06-14 13:23:51 -04:00
2023-04-07 18:19:15 -04:00
```json
2021-03-31 14:12:11 -04:00
{
"version": "0.2.0",
"configurations": [
{
"name": "Attach to Superset App in Docker Container",
"type": "python",
"request": "attach",
"connect": {
"host": "127.0.0.1",
"port": 5678
},
"pathMappings": [
{
"localRoot": "${workspaceFolder}",
"remoteRoot": "/app"
}
]
},
]
}
```
2021-12-16 21:51:06 -05:00
VSCode will not stop on breakpoints right away. We've attached to PID 6 however it does not yet know of any sub-processes. In order to "wake up" the debugger you need to modify a python file. This will trigger Flask to reload the code and create a new sub-process. This new sub-process will be detected by VSCode and breakpoints will be activated.
2021-03-31 14:12:11 -04:00
### Debugging Server App in Kubernetes Environment
To debug Flask running in POD inside kubernetes cluster. You'll need to make sure the pod runs as root and is granted the SYS_TRACE capability.These settings should not be used in production environments.
```
securityContext:
capabilities:
add: ["SYS_PTRACE"]
```
See (set capabilities for a container)[https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-capabilities-for-a-container] for more details.
Once the pod is running as root and has the SYS_PTRACE capability it will be able to debug the Flask app.
You can follow the same instructions as in the docker-compose. Enter the pod and install the required library and packages; gdb, netstat and debugpy.
2021-11-09 10:44:10 -05:00
Often in a Kubernetes environment nodes are not addressable from outside the cluster. VSCode will thus be unable to remotely connect to port 5678 on a Kubernetes node. In order to do this you need to create a tunnel that port forwards 5678 to your local machine.
2021-03-31 14:12:11 -04:00
```
kubectl port-forward pod/superset-< some random id > 5678:5678
```
You can now launch your VSCode debugger with the same config as above. VSCode will connect to to 127.0.0.1:5678 which is forwarded by kubectl to your remote kubernetes POD.
2020-07-22 13:21:25 -04:00
### Storybook
2020-08-02 17:32:17 -04:00
Superset includes a [Storybook ](https://storybook.js.org/ ) to preview the layout/styling of various Superset components, and variations thereof. To open and view the Storybook:
2020-07-22 13:21:25 -04:00
```bash
cd superset-frontend
2020-09-14 11:12:53 -04:00
npm run storybook
2020-07-22 13:21:25 -04:00
```
When contributing new React components to Superset, please try to add a Story alongside the component's `jsx/tsx` file.
2018-09-19 13:01:51 -04:00
## Translating
2016-03-05 15:41:22 -05:00
2022-12-02 16:20:58 -05:00
We use [Flask-Babel ](https://python-babel.github.io/flask-babel/ ) to translate Superset.
2019-07-04 01:33:14 -04:00
In Python files, we import the magic `_` function using:
2015-07-20 19:29:16 -04:00
2018-09-19 13:01:51 -04:00
```python
from flask_babel import lazy_gettext as _
```
2016-05-02 13:50:23 -04:00
2019-07-04 01:33:14 -04:00
then wrap our translatable strings with it, e.g. `_('Translate me')` .
During extraction, string literals passed to `_` will be added to the
generated `.po` file for each language for later translation.
2016-05-02 13:50:23 -04:00
2019-07-04 01:33:14 -04:00
At runtime, the `_` function will return the translation of the given
string for the current language, or the given string itself
if no translation is available.
2020-02-24 17:31:23 -05:00
In TypeScript/JavaScript, the technique is similar:
2019-07-04 01:33:14 -04:00
we import `t` (simple translation), `tn` (translation containing a number).
js translation -- performance improvment (#3390)
* Chinese page
* Using react-intl-universal to improve multi language in react page
* Using react-intl-universal to improve multi language in react page
* react_intl_universal
* change
* change
* change
* change
* change
* change
* change
* merge
* multiple page in js
* merge
* merge
* merge
* merge
* Js Translations
* JS Translation
* JS Translations
* Js translation
* JS translations
* JS translations
* Js translaion
* JS en Translation
* JS Translation
* upgrade document
Fixing the damn build (#3179)
* Fixing the build
* Going deeper
[bugfix] only filterable columns should show up in FilterBox list (#3105)
* [bugfix] only filterable columns should show up in FilterBox list
* Touchups
Datasource cannot be empty (#3035)
add title description to model view (#3045)
* add title description to model view
* add missing import
Add 'show/hide totals' option to pivot table vis (#3101)
[bugfix] numeric value for date fields in table viz (#3036)
Bug was present only when using the NOT GROUPED BY option
fixes https://github.com/ApacheInfra/superset/issues/3027
fix hive.fetch_logs (#2968)
add Zalando to the list of organizations (#3171)
docs: fixup installation examples code indentation (#3169)
[bugfix] fix bar order (#3180)
[bugfix] visualize flow error: 'Metric x is not valid' (#3181)
The metric name in the frontend doesn't match the one generated on the
backend. It turns out the explore view will default to the first
metric so specifying one isn't needed.
Fix the segment interval for pulling metadata (#3174)
The end of the interval would be on the truncated today date, which
means that you will exclude today. If your realtime ingestion job
runs shorter than a day, the metadata cannot be pulled from the
druid cluster.
Bump cryptography to 1.9 (#3065)
As 1.7.2 doesn't compile here with openssl 1.1.0f
Escaping the user's SQL in the explore view (#3186)
* Escaping the user's SQL in the explore view
When executing SQL from SQL Lab, we use a lower level API to the
database which doesn't require escaping the SQL. When going through
the explore view, the stack chain leading to the same method may need
escaping depending on how the DBAPI driver is written, and that is the
case for Presto (and perhaps other drivers).
* Using regex to avoid doubling doubles
[sqllab] improve Hive support (#3187)
* [sqllab] improve Hive support
* Fix "Transport not open" bug
* Getting progress bar to show
* Bump pyhive to 0.4.0
* Getting [Track Job] button to show
* Fix testzz
Add BigQuery engine specifications (#3193)
As contributed by @mxmzdlv on issue #945
[bugfix] fix merge conflict that broke Hive support (#3196)
Adding 'apache' to docs (#3194)
[druid] Allow custom druid postaggregators (#3146)
* [druid] Allow custom druid postaggregators
Also, fix the postaggregation for approxHistogram quantiles so it adds
the dependent field and that can show up in the graphs/tables.
In general, postAggregators add significant power, we should probably
support including custom postAggregators. Plywood has standard
postAggregators here, and a customAggregator escape hatch that allows
you to define custom postAggregators.
This commit adds a similar capability for Superset and a additional
field/fields/fieldName breakdown of the typical naming for dependent
aggregations, which should make it significantly easier to develop
approxHistogram and custom postAggregation-required dashboards.
* [druid] Minor style cleanup in tests file.
* [druid] Apply code review suggestions
* break out CustomPostAggregator into separate class. This just cleans
up the creation of the postaggregator a little bit.
* minor style issues.
* move the function around so the git diff is more readable
add combine config for metrics in pivot table (#3086)
* add combine config for metrics in pivot table
* change method to stack/unstack
* update backendSync
Autofocus search input in VizTypeControl modal onEnter (#2929)
Speed up JS build time (#3203)
Also bumping a few related libs
JS Translation
JS translations
js translation
fix issue 3204 (#3205)
[bugfix] capture Hive job_id pre-url transformation (#3213)
js translation
fix issue 3204 (#3205)
[bugfix] capture Hive job_id pre-url transformation (#3213)
[docs] update url in CONTRIBUTING.md (#3212)
[sqllab/cosmetics] add margin-top for labels in query history (#3222)
[explore] nvd3 sort values in rich tooltip (#3197)
[sqllab] fix UI shows 'The query returned no results' momentarily (#3214)
this is visible when running async queries between the fetching and
success state as the rows are getting cached in the component
[explore] DatasourceControl to pick datasource in modal (#3210)
* [explore] DatasourceControl to pick datasource in modal
Makes it easier to change datasource, also makes it such that the list
of all datasources doesn't need to be loaded upfront.
* Adding more metadata
* Js translation
* js tran
* js trans
* js trans
* js tran
* js trans
* js trans
* js tran
* js translation
* js trans
* js translation
* try load language pack async
* Backend translations things
* create language pack inside common data
* performance improvement for js i18n.
- js bundle should not contain localized content
- we populate translation content from server-side, in boostrap.common.language_pack
- in client-side, use promise to wrap around translation content. text will be translated after translation content arrived/parsed.
- fix linting
* fix Timer unit test
* 1. add global hook for all tests, to make translation pack avaialble before each test starts.
2. fix unit test for Timer component
3. remove noused method get_locale, and modules
4. fix page reload after user change page language
* parse and build i18n dictionary as a module
* fix sync-backend task, which should run without DOM
2017-09-20 15:37:33 -04:00
2018-09-19 13:01:51 -04:00
```javascript
2021-01-11 02:36:01 -05:00
import { t, tn } from "@superset-ui/translation";
2018-09-19 13:01:51 -04:00
```
2016-05-02 13:50:23 -04:00
2018-09-19 13:01:51 -04:00
### Enabling language selection
2016-05-02 13:50:23 -04:00
2018-09-19 13:01:51 -04:00
Add the `LANGUAGES` variable to your `superset_config.py` . Having more than one
option inside will add a language selection dropdown to the UI on the right side
of the navigation bar.
2016-05-02 13:50:23 -04:00
2018-09-19 13:01:51 -04:00
```python
LANGUAGES = {
'en': {'flag': 'us', 'name': 'English'},
'fr': {'flag': 'fr', 'name': 'French'},
'zh': {'flag': 'cn', 'name': 'Chinese'},
}
```
2016-05-02 13:50:23 -04:00
2021-01-20 13:50:24 -05:00
### Updating language files
```bash
2021-12-08 03:36:57 -05:00
./scripts/babel_update.sh
2018-09-19 13:01:51 -04:00
```
2016-05-02 13:50:23 -04:00
2021-12-08 03:36:57 -05:00
This script will
2022-06-16 17:05:37 -04:00
2021-12-08 03:36:57 -05:00
1. update the template file `superset/translations/messages.pot` with current application strings.
2. update language files with the new extracted strings.
2021-01-20 13:50:24 -05:00
2016-05-02 13:50:23 -04:00
You can then translate the strings gathered in files located under
2019-01-19 06:18:22 -05:00
`superset/translation` , where there's one per language. You can use [Poedit ](https://poedit.net/features )
2019-01-14 13:48:12 -05:00
to translate the `po` file more conveniently.
There are some [tutorials in the wiki ](https://wiki.lxde.org/en/Translate_*.po_files_with_Poedit ).
2021-01-20 13:50:24 -05:00
In the case of JS translation, we need to convert the PO file into a JSON file, and we need the global download of the npm package po2json.
2016-05-02 13:50:23 -04:00
2018-09-19 13:01:51 -04:00
```bash
npm install -g po2json
2021-01-20 13:50:24 -05:00
```
To convert all PO files to formatted JSON files you can use the `po2json.sh` script.
```bash
./scripts/po2json.sh
2018-09-19 13:01:51 -04:00
```
2016-09-21 12:52:05 -04:00
2018-09-19 13:01:51 -04:00
If you get errors running `po2json` , you might be running the Ubuntu package with the same
2021-02-15 14:45:29 -05:00
name, rather than the Node.js package (they have a different format for the arguments). If
2018-09-19 13:01:51 -04:00
there is a conflict, you may need to update your `PATH` environment variable or fully qualify
the executable path (e.g. `/usr/local/bin/po2json` instead of `po2json` ).
2019-01-14 13:48:12 -05:00
If you get a lot of `[null,***]` in `messages.json` , just delete all the `null,` .
For example, `"year":["年"]` is correct while `"year":[null,"年"]` is incorrect.
js translation -- performance improvment (#3390)
* Chinese page
* Using react-intl-universal to improve multi language in react page
* Using react-intl-universal to improve multi language in react page
* react_intl_universal
* change
* change
* change
* change
* change
* change
* change
* merge
* multiple page in js
* merge
* merge
* merge
* merge
* Js Translations
* JS Translation
* JS Translations
* Js translation
* JS translations
* JS translations
* Js translaion
* JS en Translation
* JS Translation
* upgrade document
Fixing the damn build (#3179)
* Fixing the build
* Going deeper
[bugfix] only filterable columns should show up in FilterBox list (#3105)
* [bugfix] only filterable columns should show up in FilterBox list
* Touchups
Datasource cannot be empty (#3035)
add title description to model view (#3045)
* add title description to model view
* add missing import
Add 'show/hide totals' option to pivot table vis (#3101)
[bugfix] numeric value for date fields in table viz (#3036)
Bug was present only when using the NOT GROUPED BY option
fixes https://github.com/ApacheInfra/superset/issues/3027
fix hive.fetch_logs (#2968)
add Zalando to the list of organizations (#3171)
docs: fixup installation examples code indentation (#3169)
[bugfix] fix bar order (#3180)
[bugfix] visualize flow error: 'Metric x is not valid' (#3181)
The metric name in the frontend doesn't match the one generated on the
backend. It turns out the explore view will default to the first
metric so specifying one isn't needed.
Fix the segment interval for pulling metadata (#3174)
The end of the interval would be on the truncated today date, which
means that you will exclude today. If your realtime ingestion job
runs shorter than a day, the metadata cannot be pulled from the
druid cluster.
Bump cryptography to 1.9 (#3065)
As 1.7.2 doesn't compile here with openssl 1.1.0f
Escaping the user's SQL in the explore view (#3186)
* Escaping the user's SQL in the explore view
When executing SQL from SQL Lab, we use a lower level API to the
database which doesn't require escaping the SQL. When going through
the explore view, the stack chain leading to the same method may need
escaping depending on how the DBAPI driver is written, and that is the
case for Presto (and perhaps other drivers).
* Using regex to avoid doubling doubles
[sqllab] improve Hive support (#3187)
* [sqllab] improve Hive support
* Fix "Transport not open" bug
* Getting progress bar to show
* Bump pyhive to 0.4.0
* Getting [Track Job] button to show
* Fix testzz
Add BigQuery engine specifications (#3193)
As contributed by @mxmzdlv on issue #945
[bugfix] fix merge conflict that broke Hive support (#3196)
Adding 'apache' to docs (#3194)
[druid] Allow custom druid postaggregators (#3146)
* [druid] Allow custom druid postaggregators
Also, fix the postaggregation for approxHistogram quantiles so it adds
the dependent field and that can show up in the graphs/tables.
In general, postAggregators add significant power, we should probably
support including custom postAggregators. Plywood has standard
postAggregators here, and a customAggregator escape hatch that allows
you to define custom postAggregators.
This commit adds a similar capability for Superset and a additional
field/fields/fieldName breakdown of the typical naming for dependent
aggregations, which should make it significantly easier to develop
approxHistogram and custom postAggregation-required dashboards.
* [druid] Minor style cleanup in tests file.
* [druid] Apply code review suggestions
* break out CustomPostAggregator into separate class. This just cleans
up the creation of the postaggregator a little bit.
* minor style issues.
* move the function around so the git diff is more readable
add combine config for metrics in pivot table (#3086)
* add combine config for metrics in pivot table
* change method to stack/unstack
* update backendSync
Autofocus search input in VizTypeControl modal onEnter (#2929)
Speed up JS build time (#3203)
Also bumping a few related libs
JS Translation
JS translations
js translation
fix issue 3204 (#3205)
[bugfix] capture Hive job_id pre-url transformation (#3213)
js translation
fix issue 3204 (#3205)
[bugfix] capture Hive job_id pre-url transformation (#3213)
[docs] update url in CONTRIBUTING.md (#3212)
[sqllab/cosmetics] add margin-top for labels in query history (#3222)
[explore] nvd3 sort values in rich tooltip (#3197)
[sqllab] fix UI shows 'The query returned no results' momentarily (#3214)
this is visible when running async queries between the fetching and
success state as the rows are getting cached in the component
[explore] DatasourceControl to pick datasource in modal (#3210)
* [explore] DatasourceControl to pick datasource in modal
Makes it easier to change datasource, also makes it such that the list
of all datasources doesn't need to be loaded upfront.
* Adding more metadata
* Js translation
* js tran
* js trans
* js trans
* js tran
* js trans
* js trans
* js tran
* js translation
* js trans
* js translation
* try load language pack async
* Backend translations things
* create language pack inside common data
* performance improvement for js i18n.
- js bundle should not contain localized content
- we populate translation content from server-side, in boostrap.common.language_pack
- in client-side, use promise to wrap around translation content. text will be translated after translation content arrived/parsed.
- fix linting
* fix Timer unit test
* 1. add global hook for all tests, to make translation pack avaialble before each test starts.
2. fix unit test for Timer component
3. remove noused method get_locale, and modules
4. fix page reload after user change page language
* parse and build i18n dictionary as a module
* fix sync-backend task, which should run without DOM
2017-09-20 15:37:33 -04:00
2021-01-20 13:50:24 -05:00
For the translations to take effect we need to compile translation catalogs into binary MO files.
```bash
pybabel compile -d superset/translations
```
2018-09-19 13:01:51 -04:00
### Creating a new language dictionary
js translation -- performance improvment (#3390)
* Chinese page
* Using react-intl-universal to improve multi language in react page
* Using react-intl-universal to improve multi language in react page
* react_intl_universal
* change
* change
* change
* change
* change
* change
* change
* merge
* multiple page in js
* merge
* merge
* merge
* merge
* Js Translations
* JS Translation
* JS Translations
* Js translation
* JS translations
* JS translations
* Js translaion
* JS en Translation
* JS Translation
* upgrade document
Fixing the damn build (#3179)
* Fixing the build
* Going deeper
[bugfix] only filterable columns should show up in FilterBox list (#3105)
* [bugfix] only filterable columns should show up in FilterBox list
* Touchups
Datasource cannot be empty (#3035)
add title description to model view (#3045)
* add title description to model view
* add missing import
Add 'show/hide totals' option to pivot table vis (#3101)
[bugfix] numeric value for date fields in table viz (#3036)
Bug was present only when using the NOT GROUPED BY option
fixes https://github.com/ApacheInfra/superset/issues/3027
fix hive.fetch_logs (#2968)
add Zalando to the list of organizations (#3171)
docs: fixup installation examples code indentation (#3169)
[bugfix] fix bar order (#3180)
[bugfix] visualize flow error: 'Metric x is not valid' (#3181)
The metric name in the frontend doesn't match the one generated on the
backend. It turns out the explore view will default to the first
metric so specifying one isn't needed.
Fix the segment interval for pulling metadata (#3174)
The end of the interval would be on the truncated today date, which
means that you will exclude today. If your realtime ingestion job
runs shorter than a day, the metadata cannot be pulled from the
druid cluster.
Bump cryptography to 1.9 (#3065)
As 1.7.2 doesn't compile here with openssl 1.1.0f
Escaping the user's SQL in the explore view (#3186)
* Escaping the user's SQL in the explore view
When executing SQL from SQL Lab, we use a lower level API to the
database which doesn't require escaping the SQL. When going through
the explore view, the stack chain leading to the same method may need
escaping depending on how the DBAPI driver is written, and that is the
case for Presto (and perhaps other drivers).
* Using regex to avoid doubling doubles
[sqllab] improve Hive support (#3187)
* [sqllab] improve Hive support
* Fix "Transport not open" bug
* Getting progress bar to show
* Bump pyhive to 0.4.0
* Getting [Track Job] button to show
* Fix testzz
Add BigQuery engine specifications (#3193)
As contributed by @mxmzdlv on issue #945
[bugfix] fix merge conflict that broke Hive support (#3196)
Adding 'apache' to docs (#3194)
[druid] Allow custom druid postaggregators (#3146)
* [druid] Allow custom druid postaggregators
Also, fix the postaggregation for approxHistogram quantiles so it adds
the dependent field and that can show up in the graphs/tables.
In general, postAggregators add significant power, we should probably
support including custom postAggregators. Plywood has standard
postAggregators here, and a customAggregator escape hatch that allows
you to define custom postAggregators.
This commit adds a similar capability for Superset and a additional
field/fields/fieldName breakdown of the typical naming for dependent
aggregations, which should make it significantly easier to develop
approxHistogram and custom postAggregation-required dashboards.
* [druid] Minor style cleanup in tests file.
* [druid] Apply code review suggestions
* break out CustomPostAggregator into separate class. This just cleans
up the creation of the postaggregator a little bit.
* minor style issues.
* move the function around so the git diff is more readable
add combine config for metrics in pivot table (#3086)
* add combine config for metrics in pivot table
* change method to stack/unstack
* update backendSync
Autofocus search input in VizTypeControl modal onEnter (#2929)
Speed up JS build time (#3203)
Also bumping a few related libs
JS Translation
JS translations
js translation
fix issue 3204 (#3205)
[bugfix] capture Hive job_id pre-url transformation (#3213)
js translation
fix issue 3204 (#3205)
[bugfix] capture Hive job_id pre-url transformation (#3213)
[docs] update url in CONTRIBUTING.md (#3212)
[sqllab/cosmetics] add margin-top for labels in query history (#3222)
[explore] nvd3 sort values in rich tooltip (#3197)
[sqllab] fix UI shows 'The query returned no results' momentarily (#3214)
this is visible when running async queries between the fetching and
success state as the rows are getting cached in the component
[explore] DatasourceControl to pick datasource in modal (#3210)
* [explore] DatasourceControl to pick datasource in modal
Makes it easier to change datasource, also makes it such that the list
of all datasources doesn't need to be loaded upfront.
* Adding more metadata
* Js translation
* js tran
* js trans
* js trans
* js tran
* js trans
* js trans
* js tran
* js translation
* js trans
* js translation
* try load language pack async
* Backend translations things
* create language pack inside common data
* performance improvement for js i18n.
- js bundle should not contain localized content
- we populate translation content from server-side, in boostrap.common.language_pack
- in client-side, use promise to wrap around translation content. text will be translated after translation content arrived/parsed.
- fix linting
* fix Timer unit test
* 1. add global hook for all tests, to make translation pack avaialble before each test starts.
2. fix unit test for Timer component
3. remove noused method get_locale, and modules
4. fix page reload after user change page language
* parse and build i18n dictionary as a module
* fix sync-backend task, which should run without DOM
2017-09-20 15:37:33 -04:00
2018-09-19 13:01:51 -04:00
To create a dictionary for a new language, run the following, where `LANGUAGE_CODE` is replaced with
the language code for your target language, e.g. `es` (see [Flask AppBuilder i18n documentation ](https://flask-appbuilder.readthedocs.io/en/latest/i18n.html ) for more details):
js translation -- performance improvment (#3390)
* Chinese page
* Using react-intl-universal to improve multi language in react page
* Using react-intl-universal to improve multi language in react page
* react_intl_universal
* change
* change
* change
* change
* change
* change
* change
* merge
* multiple page in js
* merge
* merge
* merge
* merge
* Js Translations
* JS Translation
* JS Translations
* Js translation
* JS translations
* JS translations
* Js translaion
* JS en Translation
* JS Translation
* upgrade document
Fixing the damn build (#3179)
* Fixing the build
* Going deeper
[bugfix] only filterable columns should show up in FilterBox list (#3105)
* [bugfix] only filterable columns should show up in FilterBox list
* Touchups
Datasource cannot be empty (#3035)
add title description to model view (#3045)
* add title description to model view
* add missing import
Add 'show/hide totals' option to pivot table vis (#3101)
[bugfix] numeric value for date fields in table viz (#3036)
Bug was present only when using the NOT GROUPED BY option
fixes https://github.com/ApacheInfra/superset/issues/3027
fix hive.fetch_logs (#2968)
add Zalando to the list of organizations (#3171)
docs: fixup installation examples code indentation (#3169)
[bugfix] fix bar order (#3180)
[bugfix] visualize flow error: 'Metric x is not valid' (#3181)
The metric name in the frontend doesn't match the one generated on the
backend. It turns out the explore view will default to the first
metric so specifying one isn't needed.
Fix the segment interval for pulling metadata (#3174)
The end of the interval would be on the truncated today date, which
means that you will exclude today. If your realtime ingestion job
runs shorter than a day, the metadata cannot be pulled from the
druid cluster.
Bump cryptography to 1.9 (#3065)
As 1.7.2 doesn't compile here with openssl 1.1.0f
Escaping the user's SQL in the explore view (#3186)
* Escaping the user's SQL in the explore view
When executing SQL from SQL Lab, we use a lower level API to the
database which doesn't require escaping the SQL. When going through
the explore view, the stack chain leading to the same method may need
escaping depending on how the DBAPI driver is written, and that is the
case for Presto (and perhaps other drivers).
* Using regex to avoid doubling doubles
[sqllab] improve Hive support (#3187)
* [sqllab] improve Hive support
* Fix "Transport not open" bug
* Getting progress bar to show
* Bump pyhive to 0.4.0
* Getting [Track Job] button to show
* Fix testzz
Add BigQuery engine specifications (#3193)
As contributed by @mxmzdlv on issue #945
[bugfix] fix merge conflict that broke Hive support (#3196)
Adding 'apache' to docs (#3194)
[druid] Allow custom druid postaggregators (#3146)
* [druid] Allow custom druid postaggregators
Also, fix the postaggregation for approxHistogram quantiles so it adds
the dependent field and that can show up in the graphs/tables.
In general, postAggregators add significant power, we should probably
support including custom postAggregators. Plywood has standard
postAggregators here, and a customAggregator escape hatch that allows
you to define custom postAggregators.
This commit adds a similar capability for Superset and a additional
field/fields/fieldName breakdown of the typical naming for dependent
aggregations, which should make it significantly easier to develop
approxHistogram and custom postAggregation-required dashboards.
* [druid] Minor style cleanup in tests file.
* [druid] Apply code review suggestions
* break out CustomPostAggregator into separate class. This just cleans
up the creation of the postaggregator a little bit.
* minor style issues.
* move the function around so the git diff is more readable
add combine config for metrics in pivot table (#3086)
* add combine config for metrics in pivot table
* change method to stack/unstack
* update backendSync
Autofocus search input in VizTypeControl modal onEnter (#2929)
Speed up JS build time (#3203)
Also bumping a few related libs
JS Translation
JS translations
js translation
fix issue 3204 (#3205)
[bugfix] capture Hive job_id pre-url transformation (#3213)
js translation
fix issue 3204 (#3205)
[bugfix] capture Hive job_id pre-url transformation (#3213)
[docs] update url in CONTRIBUTING.md (#3212)
[sqllab/cosmetics] add margin-top for labels in query history (#3222)
[explore] nvd3 sort values in rich tooltip (#3197)
[sqllab] fix UI shows 'The query returned no results' momentarily (#3214)
this is visible when running async queries between the fetching and
success state as the rows are getting cached in the component
[explore] DatasourceControl to pick datasource in modal (#3210)
* [explore] DatasourceControl to pick datasource in modal
Makes it easier to change datasource, also makes it such that the list
of all datasources doesn't need to be loaded upfront.
* Adding more metadata
* Js translation
* js tran
* js trans
* js trans
* js tran
* js trans
* js trans
* js tran
* js translation
* js trans
* js translation
* try load language pack async
* Backend translations things
* create language pack inside common data
* performance improvement for js i18n.
- js bundle should not contain localized content
- we populate translation content from server-side, in boostrap.common.language_pack
- in client-side, use promise to wrap around translation content. text will be translated after translation content arrived/parsed.
- fix linting
* fix Timer unit test
* 1. add global hook for all tests, to make translation pack avaialble before each test starts.
2. fix unit test for Timer component
3. remove noused method get_locale, and modules
4. fix page reload after user change page language
* parse and build i18n dictionary as a module
* fix sync-backend task, which should run without DOM
2017-09-20 15:37:33 -04:00
2018-09-19 13:01:51 -04:00
```bash
pip install -r superset/translations/requirements.txt
pybabel init -i superset/translations/messages.pot -d superset/translations -l LANGUAGE_CODE
```
2016-09-21 12:52:05 -04:00
2021-12-17 13:34:20 -05:00
Then, [Updating language files ](#updating-language-files ).
2017-11-01 23:13:22 -04:00
2018-09-19 13:01:51 -04:00
## Tips
### Adding a new datasource
2016-09-21 12:52:05 -04:00
2016-11-10 02:08:22 -05:00
1. Create Models and Views for the datasource, add them under superset folder, like a new my_models.py
2019-12-18 12:59:42 -05:00
with models for cluster, datasources, columns and metrics and my_views.py with clustermodelview
and datasourcemodelview.
2016-09-21 12:52:05 -04:00
2018-09-19 13:01:51 -04:00
1. Create DB migration files for the new models
2016-09-21 12:52:05 -04:00
2018-09-19 13:01:51 -04:00
1. Specify this variable to add the datasource model and from which module it is from in config.py:
2016-09-21 12:52:05 -04:00
2019-12-18 12:59:42 -05:00
For example:
2016-09-21 12:52:05 -04:00
2019-12-18 12:59:42 -05:00
```python
ADDITIONAL_MODULE_DS_MAP = {'superset.my_models': ['MyDatasource', 'MyOtherDatasource']}
```
2016-09-21 12:52:05 -04:00
2019-12-18 12:59:42 -05:00
This means it'll register MyDatasource and MyOtherDatasource in superset.my_models module in the source registry.
2017-06-22 15:37:22 -04:00
2020-07-28 01:46:37 -04:00
### Visualization Plugins
The topic of authoring new plugins, whether you'd like to contribute
it back or not has been well documented in the
2022-02-14 12:12:52 -05:00
[the documentation ](https://superset.apache.org/docs/contributing/creating-viz-plugins ), and in [this blog post ](https://preset.io/blog/building-custom-viz-plugins-in-superset-v2 ).
2020-07-28 01:46:37 -04:00
2021-12-17 13:34:20 -05:00
To contribute a plugin to Superset, your plugin must meet the following criteria:
2021-01-11 02:36:01 -05:00
- The plugin should be applicable to the community at large, not a particularly specialized use case
- The plugin should be written with TypeScript
- The plugin should contain sufficient unit/e2e tests
- The plugin should use appropriate namespacing, e.g. a folder name of `plugin-chart-whatever` and a package name of `@superset-ui/plugin-chart-whatever`
- The plugin should use them variables via Emotion, as passed in by the ThemeProvider
- The plugin should provide adequate error handling (no data returned, malformatted data, invalid controls, etc.)
- The plugin should contain documentation in the form of a populated `README.md` file
- The plugin should have a meaningful and unique icon
- Above all else, the plugin should come with a _commitment to maintenance_ from the original author(s)
2020-08-03 23:14:25 -04:00
Submissions will be considered for submission (or removal) on a case-by-case basis.
2020-07-28 01:46:37 -04:00
2018-09-19 13:01:51 -04:00
### Adding a DB migration
2017-08-15 19:37:40 -04:00
2018-09-19 13:01:51 -04:00
1. Alter the model you want to change. This example will add a `Column` Annotations model.
2017-08-15 19:37:40 -04:00
2021-01-06 06:45:19 -05:00
[Example commit ](https://github.com/apache/superset/commit/6c25f549384d7c2fc288451222e50493a7b14104 )
2017-08-15 19:37:40 -04:00
2018-09-19 13:01:51 -04:00
1. Generate the migration file
2017-08-15 19:37:40 -04:00
2019-12-18 12:59:42 -05:00
```bash
2021-04-26 00:02:02 -04:00
superset db migrate -m 'add_metadata_column_to_annotation_model'
2019-12-18 12:59:42 -05:00
```
2017-08-15 19:37:40 -04:00
2019-12-18 12:59:42 -05:00
This will generate a file in `migrations/version/{SHA}_this_will_be_in_the_migration_filename.py` .
2018-03-27 18:48:57 -04:00
2021-01-06 06:45:19 -05:00
[Example commit ](https://github.com/apache/superset/commit/d3e83b0fd572c9d6c1297543d415a332858e262 )
2018-03-27 18:48:57 -04:00
2018-09-19 13:01:51 -04:00
1. Upgrade the DB
2018-04-06 19:14:14 -04:00
2019-12-18 12:59:42 -05:00
```bash
superset db upgrade
```
2018-03-27 18:48:57 -04:00
2019-12-18 12:59:42 -05:00
The output should look like this:
2018-03-27 18:48:57 -04:00
2019-12-18 12:59:42 -05:00
```
INFO [alembic.runtime.migration] Context impl SQLiteImpl.
INFO [alembic.runtime.migration] Will assume transactional DDL.
INFO [alembic.runtime.migration] Running upgrade 1a1d627ebd8e -> 40a0a483dd12, add_metadata_column_to_annotation_model.py
```
2018-03-27 18:48:57 -04:00
2018-09-19 13:01:51 -04:00
1. Add column to view
2018-03-27 18:48:57 -04:00
2019-12-18 12:59:42 -05:00
Since there is a new column, we need to add it to the AppBuilder Model view.
2018-07-23 12:43:09 -04:00
2021-01-06 06:45:19 -05:00
[Example commit ](https://github.com/apache/superset/pull/5745/commits/6220966e2a0a0cf3e6d87925491f8920fe8a3458 )
2018-07-23 12:43:09 -04:00
2019-11-05 02:13:21 -05:00
1. Test the migration's `down` method
2019-12-18 12:59:42 -05:00
```bash
superset db downgrade
```
2019-11-05 02:13:21 -05:00
2019-12-18 12:59:42 -05:00
The output should look like this:
2019-11-05 02:13:21 -05:00
2019-12-18 12:59:42 -05:00
```
INFO [alembic.runtime.migration] Context impl SQLiteImpl.
INFO [alembic.runtime.migration] Will assume transactional DDL.
INFO [alembic.runtime.migration] Running downgrade 40a0a483dd12 -> 1a1d627ebd8e, add_metadata_column_to_annotation_model.py
```
2019-11-05 02:13:21 -05:00
2018-09-19 13:01:51 -04:00
### Merging DB migrations
2018-07-23 12:43:09 -04:00
2018-09-19 13:01:51 -04:00
When two DB migrations collide, you'll get an error message like this one:
2018-07-23 12:43:09 -04:00
2021-03-10 19:02:52 -05:00
```text
2018-09-19 13:01:51 -04:00
alembic.util.exc.CommandError: Multiple head revisions are present for
given argument 'head'; please specify a specific target
revision, '< branchname > @head' to narrow to a specific head,
or 'heads' for all heads`
2018-07-23 12:43:09 -04:00
```
2018-09-19 13:01:51 -04:00
To fix it:
2018-09-12 13:16:58 -04:00
2018-09-19 13:01:51 -04:00
1. Get the migration heads
2018-09-12 13:16:58 -04:00
2019-12-18 12:59:42 -05:00
```bash
superset db heads
```
2018-09-12 13:16:58 -04:00
2021-03-10 19:02:52 -05:00
This should list two or more migration hashes. E.g.
```bash
1412ec1e5a7b (head)
67da9ef1ef9c (head)
```
2. Pick one of them as the parent revision, open the script for the other revision
and update `Revises` and `down_revision` to the new parent revision. E.g.:
```diff
--- a/67da9ef1ef9c_add_hide_left_bar_to_tabstate.py
+++ b/67da9ef1ef9c_add_hide_left_bar_to_tabstate.py
@@ -17,14 +17,14 @@
"""add hide_left_bar to tabstate
Revision ID: 67da9ef1ef9c
-Revises: c501b7c653a3
+Revises: 1412ec1e5a7b
Create Date: 2021-02-22 11:22:10.156942
"""
# revision identifiers, used by Alembic.
revision = "67da9ef1ef9c"
-down_revision = "c501b7c653a3"
+down_revision = "1412ec1e5a7b"
import sqlalchemy as sa
from alembic import op
```
2018-09-12 13:16:58 -04:00
2021-03-10 19:02:52 -05:00
Alternatively you may also run `superset db merge` to create a migration script
just for merging the heads.
2018-09-12 13:16:58 -04:00
2019-12-18 12:59:42 -05:00
```bash
superset db merge {HASH1} {HASH2}
```
2018-09-12 13:16:58 -04:00
2021-03-10 19:02:52 -05:00
3. Upgrade the DB to the new checkpoint
2018-09-12 13:16:58 -04:00
2019-12-18 12:59:42 -05:00
```bash
superset db upgrade
```
2019-03-27 01:50:19 -04:00
### SQL Lab Async
It's possible to configure a local database to operate in `async` mode,
to work on `async` related features.
To do this, you'll need to:
2019-12-18 12:59:42 -05:00
- Add an additional database entry. We recommend you copy the connection
2019-06-25 16:34:48 -04:00
string from the database labeled `main` , and then enable `SQL Lab` and the
2019-03-27 01:50:19 -04:00
features you want to use. Don't forget to check the `Async` box
2019-12-18 12:59:42 -05:00
- Configure a results backend, here's a local `FileSystemCache` example,
2019-03-27 01:50:19 -04:00
not recommended for production,
but perfect for testing (stores cache in `/tmp` )
2020-03-26 19:55:22 -04:00
2019-12-18 12:59:42 -05:00
```python
2020-05-13 11:49:34 -04:00
from cachelib.file import FileSystemCache
2019-12-18 12:59:42 -05:00
RESULTS_BACKEND = FileSystemCache('/tmp/sqllab')
```
2020-03-26 19:55:22 -04:00
- Start up a celery worker
2019-12-18 12:59:42 -05:00
```shell script
2023-01-13 11:56:15 -05:00
celery --app=superset.tasks.celery_app:app worker -O fair
2019-12-18 12:59:42 -05:00
```
2019-03-27 01:50:19 -04:00
Note that:
2019-12-18 12:59:42 -05:00
- for changes that affect the worker logic, you'll have to
2019-03-27 01:50:19 -04:00
restart the `celery worker` process for the changes to be reflected.
2019-12-18 12:59:42 -05:00
- The message queue used is a `sqlite` database using the `SQLAlchemy`
2019-03-27 01:50:19 -04:00
experimental broker. Ok for testing, but not recommended in production
2019-12-18 12:59:42 -05:00
- In some cases, you may want to create a context that is more aligned
2019-03-27 01:50:19 -04:00
to your production environment, and use the similar broker as well as
results backend configuration
2019-12-18 12:59:42 -05:00
2021-01-19 16:57:25 -05:00
### Async Chart Queries
It's possible to configure database queries for charts to operate in `async` mode. This is especially useful for dashboards with many charts that may otherwise be affected by browser connection limits. To enable async queries for dashboards and Explore, the following dependencies are required:
- Redis 5.0+ (the feature utilizes [Redis Streams ](https://redis.io/topics/streams-intro ))
- Cache backends enabled via the `CACHE_CONFIG` and `DATA_CACHE_CONFIG` config settings
- Celery workers configured and running to process async tasks
The following configuration settings are available for async queries (see config.py for default values)
- `GLOBAL_ASYNC_QUERIES` (feature flag) - enable or disable async query operation
- `GLOBAL_ASYNC_QUERIES_REDIS_CONFIG` - Redis connection info
- `GLOBAL_ASYNC_QUERIES_REDIS_STREAM_PREFIX` - the prefix used with Redis Streams
- `GLOBAL_ASYNC_QUERIES_REDIS_STREAM_LIMIT` - the maximum number of events for each user-specific event stream (FIFO eviction)
- `GLOBAL_ASYNC_QUERIES_REDIS_STREAM_LIMIT_FIREHOSE` - the maximum number of events for all users (FIFO eviction)
- `GLOBAL_ASYNC_QUERIES_JWT_COOKIE_NAME` - the async query feature uses a [JWT ](https://tools.ietf.org/html/rfc7519 ) cookie for authentication, this setting is the cookie's name
- `GLOBAL_ASYNC_QUERIES_JWT_COOKIE_SECURE` - JWT cookie secure option
2023-01-16 02:52:15 -05:00
- `GLOBAL_ASYNC_QUERIES_JWT_COOKIE_SAMESITE` - JWT cookie same site option
2021-04-11 23:33:33 -04:00
- `GLOBAL_ASYNC_QUERIES_JWT_COOKIE_DOMAIN` - JWT cookie domain option ([see docs for set_cookie](https://tedboy.github.io/flask/interface_api.response_object.html#flask.Response.set_cookie))
2021-01-19 16:57:25 -05:00
- `GLOBAL_ASYNC_QUERIES_JWT_SECRET` - JWT's use a secret key to sign and validate the contents. This value should be at least 32 bytes and have sufficient randomness for proper security
2021-05-18 11:01:43 -04:00
- `GLOBAL_ASYNC_QUERIES_TRANSPORT` - available options: "polling" (HTTP, default), "ws" (WebSocket, requires running superset-websocket server)
2021-01-19 16:57:25 -05:00
- `GLOBAL_ASYNC_QUERIES_POLLING_DELAY` - the time (in ms) between polling requests
More information on the async query feature can be found in [SIP-39 ](https://github.com/apache/superset/issues/9190 ).
2019-11-08 17:19:22 -05:00
## Chart Parameters
Chart parameters are stored as a JSON encoded string the `slices.params` column and are often referenced throughout the code as form-data. Currently the form-data is neither versioned nor typed as thus is somewhat free-formed. Note in the future there may be merit in using something like [JSON Schema ](https://json-schema.org/ ) to both annotate and validate the JSON object in addition to using a Mypy `TypedDict` (introduced in Python 3.8) for typing the form-data in the backend. This section serves as a potential primer for that work.
2021-12-13 18:32:01 -05:00
The following tables provide a non-exhaustive list of the various fields which can be present in the JSON object grouped by the Explorer pane sections. These values were obtained by extracting the distinct fields from a legacy deployment consisting of tens of thousands of charts and thus some fields may be missing whilst others may be deprecated.
2019-11-08 17:19:22 -05:00
2021-12-13 18:14:18 -05:00
Note not all fields are correctly categorized. The fields vary based on visualization type and may appear in different sections depending on the type. Verified deprecated columns may indicate a missing migration and/or prior migrations which were unsuccessful and thus future work may be required to clean up the form-data.
2019-11-08 17:19:22 -05:00
### Datasource & Chart Type
2022-05-11 12:07:48 -04:00
| Field | Type | Notes |
| ----------------- | -------- | ------------------------------------ |
| `database_name` | _string_ | _Deprecated?_ |
2021-12-15 16:01:32 -05:00
| `datasource` | _string_ | `<datasource_id>__<datasource_type>` |
2022-05-11 12:07:48 -04:00
| `datasource_id` | _string_ | _Deprecated?_ See `datasource` |
| `datasource_name` | _string_ | _Deprecated?_ |
| `datasource_type` | _string_ | _Deprecated?_ See `datasource` |
| `viz_type` | _string_ | The **Visualization Type** widget |
2019-11-08 17:19:22 -05:00
### Time
2021-01-11 02:36:01 -05:00
| Field | Type | Notes |
| ------------------- | -------- | ------------------------------------- |
| `druid_time_origin` | _string_ | The Druid **Origin** widget |
| `granularity` | _string_ | The Druid **Time Granularity** widget |
| `granularity_sqla` | _string_ | The SQLA **Time Column** widget |
| `time_grain_sqla` | _string_ | The SQLA **Time Grain** widget |
| `time_range` | _string_ | The **Time range** widget |
2019-11-08 17:19:22 -05:00
### GROUP BY
2021-01-11 02:36:01 -05:00
| Field | Type | Notes |
| ------------------------- | --------------- | ----------------- |
| `metrics` | _array(string)_ | See Query section |
| `order_asc` | - | See Query section |
| `row_limit` | - | See Query section |
| `timeseries_limit_metric` | - | See Query section |
2019-11-08 17:19:22 -05:00
### NOT GROUPED BY
| Field | Type | Notes |
2019-12-18 12:59:42 -05:00
| --------------- | --------------- | ----------------------- |
| `order_by_cols` | _array(string)_ | The **Ordering** widget |
2019-11-08 17:19:22 -05:00
| `row_limit` | - | See Query section |
### Y Axis 1
| Field | Type | Notes |
2019-12-18 12:59:42 -05:00
| --------------- | ---- | -------------------------------------------------- |
2019-11-08 17:19:22 -05:00
| `metric` | - | The **Left Axis Metric** widget. See Query section |
| `y_axis_format` | - | See Y Axis section |
### Y Axis 2
2021-01-11 02:36:01 -05:00
| Field | Type | Notes |
| ---------- | ---- | --------------------------------------------------- |
| `metric_2` | - | The **Right Axis Metric** widget. See Query section |
2019-11-08 17:19:22 -05:00
### Query
2022-05-11 12:07:48 -04:00
| Field | Type | Notes |
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `adhoc_filters` | _array(object)_ | The **Filters** widget |
| `extra_filters` | _array(object)_ | Another pathway to the **Filters** widget.< br /> It is generally used to pass dashboard filter parameters to a chart.< br /> It can be used for appending additional filters to a chart that has been saved with its own filters on an ad-hoc basis if the chart is being used as a standalone widget.< br />< br /> For implementation examples see : [utils test.py ](https://github.com/apache/superset/blob/66a4c94a1ed542e69fe6399bab4c01d4540486cf/tests/utils_tests.py#L181 )< br /> For insight into how superset processes the contents of this parameter see: [exploreUtils/index.js ](https://github.com/apache/superset/blob/93c7f5bb446ec6895d7702835f3157426955d5a9/superset-frontend/src/explore/exploreUtils/index.js#L159 ) |
| `columns` | _array(string)_ | The **Breakdowns** widget |
| `groupby` | _array(string)_ | The **Group by** or **Series** widget |
| `limit` | _number_ | The **Series Limit** widget |
| `metric` < br > `metric_2`< br > `metrics`< br > `percent_metrics`< br > `secondary_metric`< br > `size`< br > `x`< br > `y` | _string_ ,_object_,_array(string)_,_array(object)_ | The metric(s) depending on the visualization type |
| `order_asc` | _boolean_ | The **Sort Descending** widget |
| `row_limit` | _number_ | The **Row limit** widget |
| `timeseries_limit_metric` | _object_ | The **Sort By** widget |
2019-12-18 12:59:42 -05:00
2020-02-24 17:31:23 -05:00
The `metric` (or equivalent) and `timeseries_limit_metric` fields are all composed of either metric names or the JSON representation of the `AdhocMetric` TypeScript type. The `adhoc_filters` is composed of the JSON represent of the `AdhocFilter` TypeScript type (which can comprise of columns or metrics depending on whether it is a WHERE or HAVING clause). The `all_columns` , `all_columns_x` , `columns` , `groupby` , and `order_by_cols` fields all represent column names.
2019-11-08 17:19:22 -05:00
### Chart Options
2021-01-11 02:36:01 -05:00
| Field | Type | Notes |
| -------------- | --------- | --------------------------- |
| `color_picker` | _object_ | The **Fixed Color** widget |
| `label_colors` | _object_ | The **Color Scheme** widget |
| `normalized` | _boolean_ | The **Normalized** widget |
2019-11-08 17:19:22 -05:00
### Y Axis
2021-01-11 02:36:01 -05:00
| Field | Type | Notes |
| ---------------- | -------- | ---------------------------- |
| `y_axis_2_label` | _N/A_ | _Deprecated?_ |
| `y_axis_format` | _string_ | The **Y Axis Format** widget |
| `y_axis_zero` | _N/A_ | _Deprecated?_ |
2019-11-08 17:19:22 -05:00
Note the `y_axis_format` is defined under various section for some charts.
### Other
2021-01-11 02:36:01 -05:00
| Field | Type | Notes |
| -------------- | -------- | ----- |
| `color_scheme` | _string_ | |
2019-11-08 17:19:22 -05:00
### Unclassified
2021-01-11 02:36:01 -05:00
| Field | Type | Notes |
| ----------------------------- | ----- | ----- |
| `add_to_dash` | _N/A_ | |
| `code` | _N/A_ | |
| `collapsed_fieldsets` | _N/A_ | |
| `comparison type` | _N/A_ | |
| `country_fieldtype` | _N/A_ | |
| `default_filters` | _N/A_ | |
| `entity` | _N/A_ | |
| `expanded_slices` | _N/A_ | |
| `filter_immune_slice_fields` | _N/A_ | |
| `filter_immune_slices` | _N/A_ | |
| `flt_col_0` | _N/A_ | |
| `flt_col_1` | _N/A_ | |
| `flt_eq_0` | _N/A_ | |
| `flt_eq_1` | _N/A_ | |
| `flt_op_0` | _N/A_ | |
| `flt_op_1` | _N/A_ | |
| `goto_dash` | _N/A_ | |
| `import_time` | _N/A_ | |
| `label` | _N/A_ | |
| `linear_color_scheme` | _N/A_ | |
| `new_dashboard_name` | _N/A_ | |
| `new_slice_name` | _N/A_ | |
| `num_period_compare` | _N/A_ | |
| `period_ratio_type` | _N/A_ | |
| `perm` | _N/A_ | |
| `rdo_save` | _N/A_ | |
| `refresh_frequency` | _N/A_ | |
| `remote_id` | _N/A_ | |
| `resample_fillmethod` | _N/A_ | |
| `resample_how` | _N/A_ | |
| `rose_area_proportion` | _N/A_ | |
| `save_to_dashboard_id` | _N/A_ | |
| `schema` | _N/A_ | |
| `series` | _N/A_ | |
| `show_bubbles` | _N/A_ | |
| `slice_name` | _N/A_ | |
| `timed_refresh_immune_slices` | _N/A_ | |
| `userid` | _N/A_ | |