Feature/adding query md experimental support #923

davidporter-id-au · 2025-06-05T23:46:40Z

This is an experimental feature which allows a query to return preformatted data (in this instance markdown, though if it's useful, presumably other types as well).

This is still being tested, so it's not going to be super discoverable (and I have no idea what I'm doing on the frontend, so also will try and wall off these changes for a bit until we're more certain they'll be of use).

The idea is that a query should be able return a response struct like this:

  "cadenceResponseType": "formattedData",
  "format": "<mime-type format>",
  "data" <formatted data specific to the format>
}

for example:

{
  "cadenceResponseType": "formattedData",
  "format": "text/markdown",
  "data" "### heading 123 \n[lorem ipsum](https://link) **dolor** sit amet, consectetur adipiscing elit. In id auctor dolor, in condimentum diam. Integer non dignissim odio, eget vehicula orci. Morbi id volutpat augue. Cras vel dui et mauris interdum ultricies. Nam euismod"
}

where cadenceResponseType is expected to always be the fixed string formattedData and format refers to the mime-type classification.

If it works, and if the format returned is supported, this can be rendered in the query UI. The react-md package in this instance takes care to sanitize the inputs since this would otherwise be an obvious XSS vector.

Testing:

tested locally, seems like I didn't completely break the existing JSON format (hopefully).

davidporter-id-au · 2025-06-05T23:48:03Z

src/views/workflow-queries/workflow-queries-result/workflow-queries-result.tsx

@@ -33,3 +40,13 @@ export default function WorkflowQueriesResultJson(props: Props) {
    </styled.ViewContainer>
  );
 }
+
+const isContentMarkdown = (content: any): content is Markdown => {


I can't write typescrypt, so feel free to let me know if you want me to learn how to use the type system more properly.

This is correct, but with above type updates we wont need it any more

nit: If we still need this helper, it should be moved to a separate file

Assem-Uber · 2025-06-06T07:48:17Z

src/views/workflow-queries/workflow-queries-result/helpers/get-query-json-content.ts

@@ -1,7 +1,7 @@
 import {
  type QueryJsonContent,
  type Props,
-} from '../workflow-queries-result-json.types';
+} from '../workflow-queries-result.types';

 export default function getQueryJsonContent(props: Props): QueryJsonContent {


Json can be removed from this name also since it is now returning multiple types of contents.

src/views/workflow-queries/workflow-queries-result/helpers/get-query-json-content.ts

Assem-Uber · 2025-06-06T08:49:21Z

src/views/workflow-queries/workflow-queries-result/workflow-queries-result.tsx

@@ -33,3 +40,13 @@ export default function WorkflowQueriesResultJson(props: Props) {
    </styled.ViewContainer>
  );
 }
+
+const isContentMarkdown = (content: any): content is Markdown => {


This is correct, but with above type updates we wont need it any more

src/components/markdown/md.tsx

Assem-Uber · 2025-06-06T08:55:15Z

src/components/markdown/md.styles.ts

+      alignSelf: 'stretch',
+      flexDirection: 'row',
+      alignItems: 'flex-start',
+      padding: '30px',


Since this markdown is in the components directory which is intended for highly reusable components, we usually differ layout styles to the Usage (Pages). This allows components to be placed in different pages with different Styles (padding, background colors etc.).

In this case we can follow the how PrettyJSON component is done. So style for text is done here and surrounding styles are added to WorkflowQueriesResult

Assem-Uber · 2025-06-06T08:57:20Z

...ews/workflow-queries/workflow-queries-result/__tests__/workflow-queries-result-json.test.tsx

@@ -55,6 +59,6 @@ function setup({
  loading?: boolean;


we can update the tests to check if type is markdown we show the Markdown Mock and in case of JSON we show PrettyJson Mock

adhityamamallan · 2025-06-10T09:09:40Z

src/views/workflow-queries/workflow-queries-result/workflow-queries-result.tsx

@@ -33,3 +40,13 @@ export default function WorkflowQueriesResultJson(props: Props) {
    </styled.ViewContainer>
  );
 }
+
+const isContentMarkdown = (content: any): content is Markdown => {


nit: If we still need this helper, it should be moved to a separate file

adhityamamallan · 2025-06-10T09:10:42Z

src/views/workflow-queries/workflow-queries-result/workflow-queries-result.types.ts

@@ -8,7 +8,12 @@ export type Props = {
  loading?: boolean;
 };

+export type Markdown = {


Instead of adding new types of content on a case-by-case basis, we can have a generic "custom content" type and add a configuration that parses it based on what the "type" field is.

Assem-Uber · 2025-06-11T19:38:45Z

Added styles for different use cases and added support to (autolink literals, footnotes, strikethrough, tables, tasklists)

Handled responsiveness

davidporter-id-au added 2 commits June 5, 2025 16:32

adds experimental md support

a3eded4

renamed

06a07ad

davidporter-id-au commented Jun 5, 2025

View reviewed changes

fix test

09e8652

Assem-Uber reviewed Jun 6, 2025

View reviewed changes

Assem-Uber added 2 commits June 6, 2025 08:58

update package-lock with npm registery instead of unpm

aa4691e

fix lint

a843352

adhityamamallan reviewed Jun 10, 2025

View reviewed changes

Assem-Uber and others added 2 commits June 11, 2025 19:30

refactor and fix styling

33a33bd

Merge branch 'master' into feature/adding-query-md-experimental-support

3dd43b8

Assem-Uber added 2 commits June 11, 2025 21:57

fix lint and test

99d61cc

add cadenceResponseType

aeae762

Assem-Uber approved these changes Jun 17, 2025

View reviewed changes

davidporter-id-au merged commit 26e508a into cadence-workflow:master Jun 17, 2025
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Feature/adding query md experimental support #923

Feature/adding query md experimental support #923

Uh oh!

davidporter-id-au commented Jun 5, 2025 •

edited

Loading

Uh oh!

davidporter-id-au Jun 5, 2025

Uh oh!

Assem-Uber Jun 6, 2025

Uh oh!

adhityamamallan Jun 10, 2025

Uh oh!

Assem-Uber Jun 6, 2025

Uh oh!

Uh oh!

Assem-Uber Jun 6, 2025

Uh oh!

Uh oh!

Assem-Uber Jun 6, 2025

Uh oh!

Assem-Uber Jun 6, 2025

Uh oh!

adhityamamallan Jun 10, 2025

Uh oh!

adhityamamallan Jun 10, 2025

Uh oh!

Assem-Uber commented Jun 11, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Feature/adding query md experimental support #923

Feature/adding query md experimental support #923

Uh oh!

Conversation

davidporter-id-au commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Testing:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Assem-Uber commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

davidporter-id-au commented Jun 5, 2025 •

edited

Loading

Assem-Uber commented Jun 11, 2025 •

edited

Loading