Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: show build number value in the About if present in the config #14955

Merged
merged 8 commits into from
Sep 13, 2021
7 changes: 5 additions & 2 deletions superset-frontend/src/components/Menu/Menu.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ const mockedProps = {
locale: 'en',
version_string: '1.0.0',
version_sha: 'randomSHA',
build_number: 'randomBuildNumber',
},
settings: [
{
Expand Down Expand Up @@ -280,10 +281,10 @@ test('should render the Profile link when available', async () => {
expect(profile).toHaveAttribute('href', user_profile_url);
});

test('should render the About section and version_string or sha when available', async () => {
test('should render the About section and version_string, sha or build_number when available', async () => {
const {
data: {
navbar_right: { version_sha, version_string },
navbar_right: { version_sha, version_string, build_number },
},
} = mockedProps;

Expand All @@ -292,9 +293,11 @@ test('should render the About section and version_string or sha when available',
const about = await screen.findByText('About');
const version = await screen.findByText(`Version: ${version_string}`);
const sha = await screen.findByText(`SHA: ${version_sha}`);
const build = await screen.findByText(`Build: ${build_number}`);
expect(about).toBeInTheDocument();
expect(version).toBeInTheDocument();
expect(sha).toBeInTheDocument();
expect(build).toBeInTheDocument();
});

test('should render the Documentation link when available', async () => {
Expand Down
1 change: 1 addition & 0 deletions superset-frontend/src/components/Menu/Menu.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ export interface NavBarProps {
bug_report_url?: string;
version_string?: string;
version_sha?: string;
build_number?: string;
documentation_url?: string;
languages: Languages;
show_language_picker: boolean;
Expand Down
9 changes: 8 additions & 1 deletion superset-frontend/src/components/Menu/MenuRight.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,9 @@ const RightMenu = ({
</Menu.Item>
</Menu.ItemGroup>,
]}
{(navbarRight.version_string || navbarRight.version_sha) && [
{(navbarRight.version_string ||
navbarRight.version_sha ||
navbarRight.build_number) && [
<Menu.Divider key="version-info-divider" />,
<Menu.ItemGroup key="about-section" title={t('About')}>
<div className="about-section">
Expand All @@ -165,6 +167,11 @@ const RightMenu = ({
SHA: {navbarRight.version_sha}
</div>
)}
{navbarRight.build_number && (
<div css={versionInfoStyles}>
Build: {navbarRight.build_number}
</div>
)}
</div>
</Menu.ItemGroup>,
]}
Expand Down
4 changes: 4 additions & 0 deletions superset/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,10 @@ def _try_json_readsha(filepath: str, length: int) -> Optional[str]:
VERSION_SHA_LENGTH = 8
VERSION_SHA = _try_json_readsha(VERSION_INFO_FILE, VERSION_SHA_LENGTH)

# Build number is shown in the About section if available. This
# can be replaced at build time to expose build information.
BUILD_NUMBER = None

# default viz used in chart explorer
DEFAULT_VIZ_TYPE = "table"

Expand Down
2 changes: 2 additions & 0 deletions superset/views/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -309,6 +309,7 @@ def menu_data() -> Dict[str, Any]:
brand_text = appbuilder.app.config["LOGO_RIGHT_TEXT"]
if callable(brand_text):
brand_text = brand_text()
build_number = appbuilder.app.config["BUILD_NUMBER"]
return {
"menu": menu,
"brand": {
Expand All @@ -326,6 +327,7 @@ def menu_data() -> Dict[str, Any]:
"documentation_url": appbuilder.app.config["DOCUMENTATION_URL"],
"version_string": appbuilder.app.config["VERSION_STRING"],
"version_sha": appbuilder.app.config["VERSION_SHA"],
"build_number": build_number,
"languages": languages,
"show_language_picker": len(languages.keys()) > 1,
"user_is_anonymous": g.user.is_anonymous,
Expand Down