Skip to content

feat: add programmatic descriptions to feature details page #2115

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Mar 14, 2023
Merged

feat: add programmatic descriptions to feature details page #2115

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3e92d28
feat: add programmatic descriptions to feature details page
allisonsuarez Mar 14, 2023
4337097
feedback and lint
allisonsuarez Mar 14, 2023
c68dd53
fix lint
allisonsuarez Mar 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion frontend/amundsen_application/static/js/ducks/feature/reducer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@ export const initialFeatureState: FeatureMetadata = {
badges: [],
owner_tags: [],
tags: [],
programmatic_descriptions: [],
programmatic_descriptions: {},
watermarks: [],
stats: [],
last_updated_timestamp: 0,
Expand Down
2 changes: 1 addition & 1 deletion frontend/amundsen_application/static/js/fixtures/globalState.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ const globalState: GlobalState = {
badges: [],
owner_tags: [],
tags: [],
programmatic_descriptions: [],
programmatic_descriptions: {},
watermarks: [],
stats: [],
last_updated_timestamp: 0,
Expand Down
2 changes: 1 addition & 1 deletion frontend/amundsen_application/static/js/fixtures/metadata/feature.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export const featureMetadata = {
name: 'test_feature_name',
owners: [],
partition_column: 'ds',
programmatic_descriptions: [],
programmatic_descriptions: {},
status: 'active',
stats: [],
tags: [],
Expand Down
8 changes: 7 additions & 1 deletion frontend/amundsen_application/static/js/interfaces/Feature.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,20 @@ export interface FeatureMetadata {
badges: Badge[];
owner_tags?: Tag[];
tags: Tag[];
programmatic_descriptions: ProgrammaticDescription[];
programmatic_descriptions: ProgrammaticDescriptions;
watermarks: FeatureWatermark[];
stats: FeatureStats[];
last_updated_timestamp: number;
created_timestamp: number;
partition_column?: string;
}

export interface ProgrammaticDescriptions {
left?: ProgrammaticDescription[];
right?: ProgrammaticDescription[];
other?: ProgrammaticDescription[];
}

// TODO - duplicated with FeatureResource in Resources.ts. Might delete this.
export interface FeatureSummary {
key: string;
Expand Down
30 changes: 29 additions & 1 deletion frontend/amundsen_application/static/js/pages/FeaturePage/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ import {
setUrlParam,
} from 'utils/navigationUtils';
import { formatDateTimeShort } from 'utils/dateUtils';

import { ProgrammaticDescription } from 'interfaces';
import EditableText from 'components/EditableText';
import FeatureDescEditableText from './FeatureDescEditableText';
import FeatureOwnerEditor from './FeatureOwnerEditor';
import { GenerationCode } from './GenerationCode';
Expand Down Expand Up @@ -172,6 +173,24 @@ export const FeaturePageLoader: React.FC = () => (
</div>
);

export function renderProgrammaticDesc (descriptions: ProgrammaticDescription[] | undefined) {
if (!descriptions) {
return null;
}

return descriptions.map((d) => (
<EditableSection key={`prog_desc:${d.source}`} title={d.source} readOnly>
<EditableText
maxLength={999999}
value={d.text}
editable={false}
allowDangerousHtml
/>
</EditableSection>
));
};


export function renderTabs(featureCode, featureLineage, preview) {
const defaultTab = getUrlParam(TAB_URL_PARAM) || FEATURE_TAB.PREVIEW_DATA;
const tabInfo: TabInfo[] = [];
Expand Down Expand Up @@ -331,6 +350,9 @@ export const FeaturePage: React.FC<FeaturePageProps> = ({
uriKey={feature.key}
/>
</EditableSection>
{renderProgrammaticDesc(
feature.programmatic_descriptions.left
)}
</section>
<section className="right-column">
<EditableSection title={OWNERS_TITLE}>
Expand All @@ -354,7 +376,13 @@ export const FeaturePage: React.FC<FeaturePageProps> = ({
</h3>
{feature.feature_group}
</section>
{renderProgrammaticDesc(
feature.programmatic_descriptions.right
)}
</section>
{renderProgrammaticDesc(
feature.programmatic_descriptions.other
)}
</section>
</aside>
<main className="main-content-panel">
Expand Down