chore(coder plugin): make template names optional #103

Parkreiner · 2024-04-01T21:21:36Z

Closes #59

Changes made

Updated CoderWorkspacesConfig by adding an isReadingEntityData value
Added two new general-purpose components
- InlineCodeSnippet
- Disclosure
Turned EntityDataReminder into ReminderAccordion (uses Disclosure as its main building block)
- This will let us keep adding more reminder information over time as different accordion entries
- Thought there were too many edge cases around trying to reflect the lack of a template name in the main workspaces list itself, so I pulled it out, and combined it with our existing reminder for entities
- Similarly, I felt like adding support for 100% bespoke messages for reminders like this was too much complexity for a niche feature that might not get used. Admins can choose which reminders they want to always be turned off
- This is also now part of the exported components for the plugin
The main piece: made template names optional, and accounted for everything that entails
- CoderAppConfig now exposes defaultTemplateName and defaultMode (both optional)
- CoderWorkspacesConfig's creationUrl property is now potentially undefined
- Updated the workspace creation links to be disabled when there is no URL
- Updated UI to hide the call-to-action button for making workspaces when there is no usable URL
- Added a new accordion entry that displays when there is no usable workspace creation URL
Added/updated test cases where relevant

Edit: Squeezed in one other change at the last minute, because it seemed like a good idea. Updated CoderWorkspacesCard and CoderWorkspacesCard.Root so that they don't blow up when the value of readEntityData changes between re-renders. We're still dealing with the same technical issues as before, but instead of throwing an error, they will unmount and remount with the new prop

Notes

Just because this PR is so chunky, I'm going to split the doc updates off into a separate PR

plugins/backstage-plugin-coder/src/components/CoderAuthWrapper/CoderAuthWrapper.test.tsx

plugins/backstage-plugin-coder/src/components/CoderWorkspacesCard/SearchBox.test.tsx

plugins/backstage-plugin-coder/src/components/CoderWorkspacesCard/WorkspacesList.tsx

code-asher

The new help accordions are a great idea!

code-asher · 2024-04-03T23:15:56Z

plugins/backstage-plugin-coder/src/hooks/useCoderWorkspacesConfig.ts

+  // Was originally defined in terms of fancy mapped types based on YamlConfig;
+  // ended up being a bad idea, because it increased coupling in a bad way


👍 this does seem nice

code-asher · 2024-04-03T23:21:37Z

plugins/backstage-plugin-coder/src/components/CoderWorkspacesCard/CreateWorkspaceLink.tsx

+    <Tooltip
+      ref={tooltipRef}
+      title={
+        canCreateWorkspace ? tooltipText : 'Please add a template name value'


I at first did not notice the extra help below, should we maybe say "check below for more information"? Alternatively, if we moved the accordion closer to the button that could help. I might just be particularly blind though.

Yeah, good call. I was a little worried about putting too much text in the tooltip (since by default, it's only a single line), but after looking at MUI's docs again, it looks like you can use fully-customizable HTML instead of plain text

Will update things to make the relationship more obvious. Might also see if I can throw in some splashes of color for the accordion to draw the eye better

Updated the UI. Tried to add some subtle color to the make the accordion stand out more, but it either looked super ugly, or started to break from the default Backstage styling

I'm going with a longer tooltip message for now; will reconsider adding color if we get more feedback

plugins/backstage-plugin-coder/src/components/CoderWorkspacesCard/ReminderAccordion.tsx

Parkreiner added 30 commits April 1, 2024 13:44

wip: update type definitions and parsing logic for config values

17fd4d3

refactor: update some code for clarity

a95a44b

fix: update property names in top-level config

18e80f0

wip: commit progress on link update

3cfc7c5

chore: finish updates for CreateWorkspaceLink

ec1e794

chore: add new test case for disabled state

50ad128

fix: cleanup markup and text for EntityDataReminder

bbcdaf7

chore: add readEntityData as context value

730e979

refactor: rename DataEntityReminder to ReminderAcoordionItem

cd804f6

chore: extract core accordion item logic to parent

9e541c2

chore: finish initial version of ReminderAccordion

f445df4

wip: commit test stubs for ReminderAccordion

f841d1a

chore: rename isReadingEntityData prop

98a94c8

chore: update mock context values in tests

d2ac1ac

wip: commit test stub for hiding cta button when there is no repo URL

b415ce5

chore: hide CTA button when there is no repo URL

604c7a4

chore: rename AccordionItem to Disclosure

8635663

chore: update tests for Disclosure

233d255

chore: remove needless hasAssertions calls

badd8ee

fix: update conditional logic for ReminderAccordion

e87e41e

fix: more accordion bug fixes

52a2731

chore: finish another test case

c45e132

chore: add another accordion test case

0680934

refactor: rename props for clarity

7ba9fce

refactor: simplify condition for entity reminder

14c4d86

refactor: update prop for Disclosure

8f5081e

chore: finish all tests for accordion

11b7b81

refactor: update type definition for mock config

cb2664e

refactor: polish up accordion tests

41d6f20

chore: finish up all tests

b3b83f0

Parkreiner added 4 commits April 2, 2024 15:49

fix: add missing property to mock setup to help compiler pass

b6c8dec

refactor: move isReadingEntityData property to workspaces config

ff531b8

fix: add overflow-y and max height behavior to accordion

352352f

chore: polish styling for accordion

53ba23e

Parkreiner commented Apr 2, 2024

View reviewed changes

plugins/backstage-plugin-coder/src/components/CoderAuthWrapper/CoderAuthWrapper.test.tsx Show resolved Hide resolved

Parkreiner commented Apr 2, 2024

View reviewed changes

plugins/backstage-plugin-coder/src/components/CoderWorkspacesCard/SearchBox.test.tsx Show resolved Hide resolved

Parkreiner commented Apr 2, 2024

View reviewed changes

plugins/backstage-plugin-coder/src/components/CoderWorkspacesCard/WorkspacesList.tsx Show resolved Hide resolved

Parkreiner marked this pull request as ready for review April 2, 2024 19:47

Parkreiner requested a review from code-asher April 2, 2024 19:47

fix: add reminder accordion as exported plugin component

90d6f9d

code-asher approved these changes Apr 3, 2024

View reviewed changes

Parkreiner added 7 commits April 4, 2024 14:25

refactor: rename imported component to reduce visual noise when reading

9e07fd5

fix: make no-link message more clear for button

4389f84

fix: update text to account for new tooltip

f8a4576

docs: add page about catalog-info

5677de6

docs: finish all docs updates for coder plugin

b591977

docs: add docs section for ReminderAccordion

cab06c4

fix: update link for documentation in UI

a640738

Parkreiner merged commit ece362a into main Apr 4, 2024
2 checks passed

Parkreiner deleted the mes/template-name-take-2 branch April 4, 2024 17:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(coder plugin): make template names optional #103

chore(coder plugin): make template names optional #103

Parkreiner commented Apr 1, 2024 •

edited

Loading

code-asher left a comment

code-asher Apr 3, 2024

code-asher Apr 3, 2024

Parkreiner Apr 4, 2024 •

edited

Loading

Parkreiner Apr 4, 2024

code-asher Apr 4, 2024

		// Was originally defined in terms of fancy mapped types based on YamlConfig;
		// ended up being a bad idea, because it increased coupling in a bad way

chore(coder plugin): make template names optional #103

chore(coder plugin): make template names optional #103

Conversation

Parkreiner commented Apr 1, 2024 • edited Loading

Changes made

Notes

code-asher left a comment

Choose a reason for hiding this comment

code-asher Apr 3, 2024

Choose a reason for hiding this comment

code-asher Apr 3, 2024

Choose a reason for hiding this comment

Parkreiner Apr 4, 2024 • edited Loading

Choose a reason for hiding this comment

Parkreiner Apr 4, 2024

Choose a reason for hiding this comment

code-asher Apr 4, 2024

Choose a reason for hiding this comment

Parkreiner commented Apr 1, 2024 •

edited

Loading

Parkreiner Apr 4, 2024 •

edited

Loading