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

Allow me to introduce the DevTools plugin! 🧰 #14642

Closed

Conversation

ahhhndre
Copy link
Contributor

Hey, I just made a Pull Request!

Allow me to introduce the DevTools plugin - another handy tool to add to your Backstage 🧰 ! This will close #9737 and hopefully open a world of new features to help Backstage Adopters who run the Ops side of things 😉

The plugin offers the following features:

Lists info about your current Backstage instance - OS, NodeJS version, Backstage version and packages:

devtools-info-tab

Lists the config being used by your current Backstage instance:

devtools-config-tab

There's also an optional tab where you can list connectivity with External Dependencies:

devtools-external-dependencies

The plugin has also been designed so you can customize the tabs - remove them, add them, and/or create your own.

Support for the permissions framework is included in an open way so that you can control this as best fits your needs. There is detailed guidance in the plugin's README.md on this topic.

✔️ Checklist

  • A changeset describing the change and affected packages. (more info)
  • Added or updated documentation
  • Tests for new functionality and regression tests for bug fixes
  • Screenshots attached (for UI changes)
  • All your commits have a Signed-off-by line in the message. (more info)

@ahhhndre
Copy link
Contributor Author

@freben @camilaibs @Rugvip I've submitted this as a Draft PR as I think there will be a lot of back and forth on how to best implement some of the features. Also, I'm submitting this from my personal account as this is something I've been working on in my spare time

@ahhhndre ahhhndre changed the title Allows me to introduce the DevTools plugin! 🧰 Allow me to introduce the DevTools plugin! 🧰 Nov 15, 2022
@ahhhndre ahhhndre force-pushed the topic/introduce-devtools-plugin branch from 4635a33 to fba0278 Compare November 15, 2022 17:18
@github-actions
Copy link
Contributor

github-actions bot commented Nov 15, 2022

Changed Packages

Package Name Package Path Changeset Bump Current Version
example-app packages/app none v0.2.78-next.3
example-backend packages/backend none v0.2.78-next.3
@backstage/plugin-devtools-backend plugins/devtools-backend minor v0.0.0
@backstage/plugin-devtools-common plugins/devtools-common minor v0.0.0
@backstage/plugin-devtools plugins/devtools minor v0.0.0

@freben
Copy link
Member

freben commented Nov 16, 2022

That CI check is new - you can just run yarn dedupe to get it clean again. Soon we will have a precommit hook that does it for you transparently #14663

@Rugvip
Copy link
Member

Rugvip commented Nov 17, 2022

You're not @awanlin's evil twin or anything right?

Copy link
Member

@Rugvip Rugvip left a comment

Choose a reason for hiding this comment

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

Nice 😁

Couple of early thoughts

plugins/devtools-backend/src/api/DevToolsBackendApi.ts Outdated Show resolved Hide resolved
plugins/devtools-backend/src/api/DevToolsBackendApi.ts Outdated Show resolved Hide resolved
plugins/devtools-backend/src/api/DevToolsBackendApi.ts Outdated Show resolved Hide resolved
@ahhhndre ahhhndre force-pushed the topic/introduce-devtools-plugin branch from fba0278 to 5e2ce0c Compare November 20, 2022 19:27
@grantila
Copy link
Contributor

I remember this a while back 😏

Perhaps worth pulling in features from both..

@ahhhndre
Copy link
Contributor Author

I remember this a while back 😏

Perhaps worth pulling in features from both..

Yes, @grantila I'd very much like to see that happen. My intention was this PR would set the ground work and we can slowly add more to this

@ahhhndre ahhhndre force-pushed the topic/introduce-devtools-plugin branch from 6e94431 to 0fdae90 Compare November 22, 2022 22:02
@github-actions
Copy link
Contributor

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

@github-actions github-actions bot added stale and removed stale labels Nov 30, 2022
@ahhhndre ahhhndre force-pushed the topic/introduce-devtools-plugin branch from fb7d97e to 24303fd Compare December 3, 2022 23:37
@awanlin awanlin mentioned this pull request Dec 5, 2022
2 tasks
@github-actions
Copy link
Contributor

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

@github-actions github-actions bot added the stale label Dec 11, 2022
@ahhhndre ahhhndre force-pushed the topic/introduce-devtools-plugin branch from 842d903 to ffc1c9e Compare December 11, 2022 16:53
@github-actions github-actions bot removed the stale label Dec 11, 2022
@github-actions
Copy link
Contributor

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

@github-actions github-actions bot added the stale label Dec 18, 2022
@regicsolutions
Copy link

Very Nice, wondering if this plugin can potentially be extended out to the entity/component level where you can see dependencies for a specific component via a CycloneDX Software Bill of Materials

@github-actions github-actions bot removed the stale label Dec 21, 2022
@ahhhndre ahhhndre force-pushed the topic/introduce-devtools-plugin branch from fa23d18 to 2b16b71 Compare December 23, 2022 19:15
@backstage-goalie
Copy link
Contributor

backstage-goalie bot commented Dec 23, 2022

Changed Packages

Package Name Package Path Changeset Bump Current Version
example-app packages/app none v0.2.82-next.2
example-backend packages/backend none v0.2.82-next.2
@backstage/plugin-devtools-backend plugins/devtools-backend minor v0.0.0
@backstage/plugin-devtools-common plugins/devtools-common minor v0.0.0
@backstage/plugin-devtools plugins/devtools minor v0.0.0

@github-actions
Copy link
Contributor

github-actions bot commented Dec 23, 2022

Uffizzi Ephemeral Environment deployment-13593

☁️ https://app.uffizzi.com/github.com/backstage/backstage/pull/14642

📄 View Application Logs etc.

What is Uffizzi? Learn more!

@github-actions
Copy link
Contributor

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

@webark
Copy link
Contributor

webark commented Mar 17, 2023

just from curiosity, what's the main thing holding up the PR?

@ahhhndre
Copy link
Contributor Author

@adamdmharvey @sennyeya thanks for the reviews, will implement your feedback soon

@webark honestly just life has been busy. Once I rebase the branch, follow up on the feedback, then I'll be able to move this to ready. I just don't want to provide a timeline that I won't be able to keep.

@ahhhndre ahhhndre force-pushed the topic/introduce-devtools-plugin branch from d44b94e to 6f83725 Compare March 18, 2023 21:32
@webark
Copy link
Contributor

webark commented Mar 18, 2023

ohhh.. no worries. Wasn't pushing, just curious if it was more on the development, review, or principle that was being waited on.

@ahhhndre
Copy link
Contributor Author

@adamdmharvey just wanted to follow up on your comments, wish I could have done that directly under your message and quoting you is a little messy.

Regarding the name, it's hard and I feel like to no matter what I use can be misinterpreted. I asked some people I know about the name and they each had some different view. With that in mind I won't be changing the name but I do think adding "Backstage" to the main title would add some clarity. For background I had a different name initially, Debug really didn't work once I had more time to think on it, I settled on DevTools based on Chrome DevTools.

As far as discovery and confusion around the name: ideally this should be behind permissions and only seen by those who have access and need to use it. This is how we have ours setup internally. But I do recognize that not everyone has permissions setup or may want everyone to have access to this for various reasons.

@github-actions
Copy link
Contributor

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

@github-actions github-actions bot added the stale label Mar 25, 2023
@webark
Copy link
Contributor

webark commented Mar 26, 2023

People have lives stale bot!!!

@github-actions github-actions bot removed the stale label Mar 26, 2023
@ahhhndre ahhhndre force-pushed the topic/introduce-devtools-plugin branch from c7f7b6b to 8c83818 Compare March 26, 2023 18:35
@github-actions
Copy link
Contributor

github-actions bot commented Apr 2, 2023

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

@github-actions github-actions bot added the stale label Apr 2, 2023
@freben freben removed the stale label Apr 3, 2023
Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>

Added common

Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>

Added DevTools frontend plugin

Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>

Fixed package.json files

Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>

Updated README with permissions guidance

Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>

Added details about config

Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>

Added API Reports

Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>

Added changeset

Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>

Fixed typo

Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>

Ran yarn dedupe

Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>

Ran prettier

Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>

Fixed lint issues

Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>

Memoize and sanitize config

Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>

Fixes after rebase

Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>

Fixed yarn.lock

Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>

Fixed yarn.lock

Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>

Added DevTools plugin

Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>

Ran yarn dedupe

Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>

Convert span to Typography

Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>

Fixed yarn.lock

Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>

Fixed yarn.lock

Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>
Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>
Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>
Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>
Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>
Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>
Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>
@ahhhndre ahhhndre force-pushed the topic/introduce-devtools-plugin branch from 2c35b9e to 1b5c9cb Compare April 7, 2023 16:47
Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>
Signed-off-by: Andre Wanlin <andrewanlin@gmail.com>
@ahhhndre
Copy link
Contributor Author

ahhhndre commented Apr 8, 2023

Alright, I've got all the current comments resolved. There is one last item I want to handle before flipping this to ready. I want to refactor my usage of the Lockfile.ts in the devtools-backend to use the one in the soon to be merged @backstage/cli-node package in PR #17280 as this will avoid some duplication.

@ahhhndre
Copy link
Contributor Author

Closing in favour of #17393

@ahhhndre ahhhndre closed this Apr 14, 2023
@ahhhndre ahhhndre deleted the topic/introduce-devtools-plugin branch April 14, 2023 19:30
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.

[RFC] Debug Plugin