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

fix: content panel captures focus #754

Merged
merged 2 commits into from
May 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 packages/console/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@flyteorg/console",
"version": "0.0.27",
"version": "0.0.28",
"description": "Flyteconsole main app module",
"main": "./dist/index.js",
"module": "./lib/index.js",
Expand Down
30 changes: 19 additions & 11 deletions packages/console/src/components/Entities/EntityDescription.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ import { TaskClosure } from 'models/Task/types';
import { executionFilterGenerator } from './generators';
import { Row } from './Row';
import t, { patternKey } from './strings';
import {entityStrings, entitySections} from './constants';
import {useDescriptionEntityList} from "../hooks/useDescription";
import { entityStrings, entitySections } from './constants';
import { useDescriptionEntityList } from '../hooks/useDescription';

const Skeleton = reactLoadingSkeleton;

Expand Down Expand Up @@ -116,7 +116,7 @@ export const EntityDescription: React.FC<{
},
);

const descriptionEntity = descriptionEntities?.value?.[0]
const descriptionEntity = descriptionEntities?.value?.[0];
const hasDescription = descriptionEntity?.longDescription.value.length !== 0;
const hasLink = !!descriptionEntity?.sourceCode?.link;
const sections = entitySections[id.resourceType];
Expand Down Expand Up @@ -150,15 +150,23 @@ export const EntityDescription: React.FC<{
)}
</span>
</Row>
{hasLink && (<Row title={t('githubLink')}>
<span>
{hasLink
?<a href={descriptionEntity?.sourceCode?.link} target="_blank" rel="noreferrer">{descriptionEntity?.sourceCode?.link}</a>
: t(
patternKey('noGithubLink', entityStrings[id.resourceType]),
{hasLink && (
<Row title={t('githubLink')}>
<span>
{hasLink ? (
<a
href={descriptionEntity?.sourceCode?.link}
target="_blank"
rel="noreferrer"
>
{descriptionEntity?.sourceCode?.link}
</a>
) : (
t(patternKey('noGithubLink', entityStrings[id.resourceType]))
)}
</span>
</Row>)}
</span>
</Row>
)}
</WaitForData>
{sections?.descriptionInputsAndOutputs && <InputsAndOuputs id={id} />}
</Typography>
Expand Down
6 changes: 3 additions & 3 deletions packages/console/src/components/Task/SimpleTaskInterface.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ const VariablesList: React.FC<{ variables: Record<string, Variable> }> = ({
export const SimpleTaskInterface: React.FC<{ task: Task }> = ({ task }) => {
const { inputs = emptyVariables, outputs = emptyVariables } =
task.closure.compiledTask.template.interface || {};
const description = task.shortDescription || "No description found.";
const description = task.shortDescription || 'No description found.';
return (
<div>
<DetailsGroup
Expand All @@ -82,8 +82,8 @@ export const SimpleTaskInterface: React.FC<{ task: Task }> = ({ task }) => {
},
{
name: 'description',
content: <span>{description}</span>
}
content: <span>{description}</span>,
},
]}
/>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,11 @@ export const useWorkflowInfoItem = ({
const parsedOutputs = getOutputsForWorkflow(launchPlan);
const outputs =
parsedOutputs.length > 0 ? parsedOutputs.join(', ') : undefined;
const description = workflow?.shortDescription && workflow?.shortDescription.length > 0 ? workflow.shortDescription : undefined
return { id, inputs, outputs, description};
const description =
workflow?.shortDescription && workflow?.shortDescription.length > 0
? workflow.shortDescription
: undefined;
return { id, inputs, outputs, description };
},
{
staleTime: 1000 * 60 * 5,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { WorkflowGraph } from '../WorkflowGraph';
import graphData from './rich.json';

const graphDataClosure = graphData as unknown as CompiledWorkflowClosure;
const shortDescription = ""
const shortDescription = '';

const workflow: Workflow = {
closure: { compiledWorkflow: graphDataClosure },
Expand Down
3 changes: 3 additions & 0 deletions packages/console/src/components/common/DetailsPanel.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ export const DetailsPanel: React.FC<DetailsPanelProps> = ({
ModalProps={{
className: styles.modal,
hideBackdrop: true,
// This is needed to prevent the modal from stealing focus
// from other modals in the app
disableEnforceFocus: true,
// Modal uses inline styling for the zIndex, so we have to
// override it
style: { zIndex: theme.zIndex.appBar - 2 },
Expand Down
4 changes: 2 additions & 2 deletions packages/console/src/components/data/apiContext.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import * as LaunchAPI from 'models/Launch/api';
import * as ProjectAPI from 'models/Project/api';
import * as TaskAPI from 'models/Task/api';
import * as WorkflowAPI from 'models/Workflow/api';
import * as DescriptionEntityAPI from 'models/DescriptionEntity/api'
import * as DescriptionEntityAPI from 'models/DescriptionEntity/api';
import * as React from 'react';

type APIFunctions = typeof CommonAPI &
Expand All @@ -26,7 +26,7 @@ export const defaultAPIContextValue: APIContextValue = {
...ProjectAPI,
...TaskAPI,
...WorkflowAPI,
...DescriptionEntityAPI
...DescriptionEntityAPI,
};

/** Exposes all of the model layer api functions for use by data fetching
Expand Down
26 changes: 15 additions & 11 deletions packages/console/src/components/hooks/useDescription.ts
Original file line number Diff line number Diff line change
@@ -1,28 +1,32 @@
import {Identifier, IdentifierScope, RequestConfig} from "../../models";
import {useFetchableData} from "./useFetchableData";
import {getDescriptionEntity, listDescriptionEntities} from "../../models/DescriptionEntity/api";
import {DescriptionEntity} from "../../models/DescriptionEntity/types";
import {FetchableData} from "./types";
import {useAPIContext} from "../data/apiContext";
import {usePagination} from "./usePagination";

import { Identifier, IdentifierScope, RequestConfig } from '../../models';
import { useFetchableData } from './useFetchableData';
import { DescriptionEntity } from '../../models/DescriptionEntity/types';
import { FetchableData } from './types';
import { useAPIContext } from '../data/apiContext';
import { usePagination } from './usePagination';

/** A hook for fetching a description entity */
export function useDescriptionEntity(id: Identifier): FetchableData<DescriptionEntity> {
export function useDescriptionEntity(
id: Identifier,
): FetchableData<DescriptionEntity> {
const { getDescriptionEntity } = useAPIContext();
return useFetchableData<DescriptionEntity, Identifier>(
{
useCache: true,
debugName: 'DescriptionEntity',
defaultValue: {} as DescriptionEntity,
doFetch: async descriptionEntityId => (await getDescriptionEntity(descriptionEntityId)) as DescriptionEntity,
doFetch: async descriptionEntityId =>
(await getDescriptionEntity(descriptionEntityId)) as DescriptionEntity,
},
id,
);
}

/** A hook for fetching a paginated list of description entities */
export function useDescriptionEntityList(scope: IdentifierScope, config: RequestConfig) {
export function useDescriptionEntityList(
scope: IdentifierScope,
config: RequestConfig,
) {
const { listDescriptionEntities } = useAPIContext();
return usePagination<DescriptionEntity, IdentifierScope>(
{ ...config, cacheItems: true, fetchArg: scope },
Expand Down
9 changes: 5 additions & 4 deletions packages/console/src/models/DescriptionEntity/api.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
import { Admin } from '@flyteorg/flyteidl-types';
import {
getAdminEntity,
} from 'models/AdminEntity/AdminEntity';
import { getAdminEntity } from 'models/AdminEntity/AdminEntity';
import { defaultPaginationConfig } from 'models/AdminEntity/constants';
import { RequestConfig } from 'models/AdminEntity/types';
import { Identifier, IdentifierScope } from 'models/Common/types';
import { DescriptionEntity } from './types';
import { makeDescriptionPath, descriptionEntityListTransformer } from './utils';

/** Fetches a list of `DescriptionEntity` records matching the provided `scope` */
export const listDescriptionEntities = (scope: IdentifierScope, config?: RequestConfig) =>
export const listDescriptionEntities = (
scope: IdentifierScope,
config?: RequestConfig,
) =>
getAdminEntity(
{
path: makeDescriptionPath(scope),
Expand Down
13 changes: 6 additions & 7 deletions packages/console/src/models/DescriptionEntity/types.ts
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
import { Admin } from '@flyteorg/flyteidl-types';
import { Identifier } from 'models/Common/types';


/** Optional link to source code used to define this entity */
export interface SourceCode extends Admin.ISourceCode {
link?: string
link?: string;
}

/** Full user description with formatting preserved */
export interface LongDescription extends Admin.IDescription {
value: string;
uri: string;
format: Admin.DescriptionFormat
iconLink?: string
format: Admin.DescriptionFormat;
iconLink?: string;
}

/*
Expand All @@ -22,7 +21,7 @@ Documentation could provide insight into the algorithms, business use case, etc
export interface DescriptionEntity extends Admin.IDescriptionEntity {
id: Identifier;
shortDescription: string;
longDescription: LongDescription
sourceCode?: SourceCode
tags?: string[]
longDescription: LongDescription;
sourceCode?: SourceCode;
tags?: string[];
}
2 changes: 1 addition & 1 deletion website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
},
"dependencies": {
"@flyteorg/common": "^0.0.4",
"@flyteorg/console": "^0.0.27",
"@flyteorg/console": "^0.0.28",
"long": "^4.0.0",
"protobufjs": "~6.11.3",
"react-ga4": "^1.4.1",
Expand Down
4 changes: 2 additions & 2 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2020,7 +2020,7 @@ __metadata:
resolution: "@flyteconsole/client-app@workspace:website"
dependencies:
"@flyteorg/common": ^0.0.4
"@flyteorg/console": ^0.0.27
"@flyteorg/console": ^0.0.28
"@types/long": ^3.0.32
long: ^4.0.0
protobufjs: ~6.11.3
Expand Down Expand Up @@ -2059,7 +2059,7 @@ __metadata:
languageName: unknown
linkType: soft

"@flyteorg/console@^0.0.27, @flyteorg/console@workspace:packages/console":
"@flyteorg/console@^0.0.28, @flyteorg/console@workspace:packages/console":
version: 0.0.0-use.local
resolution: "@flyteorg/console@workspace:packages/console"
dependencies:
Expand Down