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

User Metadata #2423

Merged
merged 34 commits into from
Nov 20, 2024
Merged

User Metadata #2423

merged 34 commits into from
Nov 20, 2024

Conversation

Alex-Tideman
Copy link
Contributor

@Alex-Tideman Alex-Tideman commented Nov 7, 2024

Description & motivation 💭

With the additional of User Metadata and Workflow Metadata, we can show more human-friendly descriptions of workflows and it's current status.

The Summary/Details field is a static field that comes from the WorkflowDescription API.

The Summary/Detailsinfo and the Workflow info (start/end/duration...) will now be above the fold so it will be visible for all tabs.

The Markdown component also will swap out {namespace}, {workflowId} and {runId} strings the the page params to be able to link dynamically.

This also updates the Send Signal modal to use a Select of signal definitions if they exist.

Screenshot 2024-11-18 at 9 28 01 AM Screenshot 2024-11-18 at 9 29 33 AM Screenshot 2024-11-18 at 9 29 48 AM Screenshot 2024-11-18 at 10 11 46 AM Screenshot 2024-11-18 at 9 32 27 AM Screenshot 2024-11-18 at 9 33 42 AM Screenshot 2024-11-18 at 9 43 30 AM

Design Considerations 🎨

Testing 🧪

How was this tested 👻

  • Manual testing
  • E2E tests added
  • Unit tests added

Steps for others to test: 🚶🏽‍♂️🚶🏽‍♀️

Checklists

Draft Checklist

Merge Checklist

  • Do we want the Summary field to be Markdown or a string? - Markdown string. Will not replace workflowId, but will be added to Summary & Details accordion
  • Is it okay to poll on the Workflow Metadata query? - For now, don't poll on this query. We will add support for Current Details in another PR
  • Can we determine if a user can set Summary/Details on the Start Workflow page? - Yes as a long as they have the correct server version, not SDK reliant.
  • If signal definitions exist, should a user still be able to send a signal that isn't in the defintions? - Yes, they need to still have the option to input custom definitions
  • Encode the summary and details payload

Issue(s) closed

Docs

Any docs updates needed?

Copy link

vercel bot commented Nov 7, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
holocene ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 20, 2024 4:06pm

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems like it shouldn't be a component, accordion is already pretty light, what's the difference?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Less padding, no background, no border, different arrow. Probably more what it will be in the future but didn't want to flip them all over

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's ask @tigernaut if we can just flip em all over, I'd rather not have 2 versions of accordion

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not gonna on this PR, but ya I'll chat with them on doing that.

class="min-w-fit"
bind:value={name}
data-testid="signal-select"
placeholder="Select a signal"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i18n

<Option
on:click={handleCustom}
value="custom"
description="Input Signal name">Custom</Option
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i18n

@Alex-Tideman Alex-Tideman merged commit 49063e4 into main Nov 20, 2024
14 checks passed
@Alex-Tideman Alex-Tideman deleted the user-metadata branch November 20, 2024 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants