[GEN-1729]: add "describe source" to UI #1982
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alonkeyval
reviewed
Dec 15, 2024
alonkeyval
reviewed
Dec 15, 2024
frontend/webapp/containers/main/sources/source-drawer-container/index.tsx
Show resolved
Hide resolved
alonkeyval
reviewed
Dec 15, 2024
alonkeyval
reviewed
Dec 15, 2024
| `; | ||
|
|
||
| export const Code: React.FC<Props> = ({ language, code, flatten }) => { | ||
| const str = flatten && language === 'json' ? safeJsonStringify(flattenObjectKeys(safeJsonParse(code, {}))) : code; |
There was a problem hiding this comment.
we can move this outside of the component o make it more ruseable
There was a problem hiding this comment.
This is the place to make it re-usable, placing it outside would then require copy-pasting of this logic throughout other files.
alonkeyval
reviewed
Dec 15, 2024
frontend/webapp/reuseable-components/data-card/data-card-fields/index.tsx
Show resolved
Hide resolved
alonkeyval
reviewed
Dec 15, 2024
frontend/webapp/utils/functions/formatters/flatten-object-keys/index.ts
Outdated
Show resolved
Hide resolved
alonkeyval
approved these changes
Dec 15, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces a new feature to describe sources in the application, along with several supporting changes across multiple files. The most important changes include adding a new GraphQL query, creating a custom hook to use this query, and updating the UI to display the described source data.
New Feature: Describe Source
GraphQL Query:
DESCRIBE_SOURCEinfrontend/webapp/graphql/queries/describe.tsto fetch detailed information about a source.frontend/webapp/graphql/queries/index.ts.Custom Hook:
useDescribeSourceinfrontend/webapp/hooks/describe/useDescribeSource.tsto use theDESCRIBE_SOURCEquery.frontend/webapp/hooks/describe/index.tsandfrontend/webapp/hooks/index.ts. [1] [2]UI Updates:
frontend/webapp/containers/main/sources/source-drawer-container/index.tsxto use the newuseDescribeSourcehook and display the described source data in a newDataCard. [1] [2] [3]Codeinfrontend/webapp/reuseable-components/code/index.tsxto render code snippets with syntax highlighting.frontend/webapp/reuseable-components/data-card/data-card-fields/index.tsxto support a new field typeCODEfor displaying code snippets. [1] [2]Codecomponent infrontend/webapp/reuseable-components/index.ts.Utility Functions
Flatten Object Keys:
flattenObjectKeysinfrontend/webapp/utils/functions/formatters/flatten-object-keys/index.tsto flatten nested object keys.frontend/webapp/utils/functions/formatters/index.ts.Safe JSON Stringify:
safeJsonStringifyinfrontend/webapp/utils/functions/formatters/safe-json-stringify/index.tsto safely stringify JSON objects.safeJsonStringifyfunction infrontend/webapp/containers/main/sources/source-drawer-container/index.tsx.Additional Changes
Types:
DescribeSourceresponse infrontend/webapp/types/describe.ts.frontend/webapp/types/index.ts.Dependencies:
prism-react-rendererfor syntax highlighting infrontend/webapp/package.json.These changes collectively add the capability to describe sources in the application, enhancing the user experience by providing detailed information about each source.