feat: delete unprocessed entity from refresh_state table

[kurtaking]

Hey, I just made a Pull Request!

re: https://github.com/backstage/backstage/issues/21858

Add the ability to delete a record from the refresh_state table.

:heavy_check_mark: Checklist

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

Remaining todos

• [x] add support for permissions
• [x] determine - do we need this functionality on both the Failed and Pending tabs?
• [ ] address breaking change concerns

[backstage-goalie[bot]]

Changed Packages

Package Name	Package Path	Changeset Bump	Current Version
example-backend	packages/backend	none	v0.2.93-next.2
@backstage/plugin-catalog-backend-module-unprocessed	plugins/catalog-backend-module-unprocessed	minor	v0.3.11-next.2
@backstage/plugin-catalog-unprocessed-entities-common	plugins/catalog-unprocessed-entities-common	patch	v0.0.0
@backstage/plugin-catalog-unprocessed-entities	plugins/catalog-unprocessed-entities	minor	v0.1.9-next.2

[github-actions[bot]]

Uffizzi Cluster pr-22667 was deleted.

[awanlin]

@kurtaking, this is awesome! I know this is Draft but just want to mention that this should probably have support for being locked down with permissions. 👍

[kurtaking]

I could use feedback on what we want to do with the <PendingEntities /> component (tab).

[benjdlambert]

What's the use case for deleting unprocessed_entities?

I'm might be misunderstanding here, but I think that having many unprocessed_entities is a symptom of a larger issue that the things on the queue are not being processed in a timely manner. They should eventually be moved from there into final_entities I believe. @freben to confirm?

[freben]

Not quite, could also be that they are in a corner case where they never successfully get processed or so, for example.

[kurtaking]

hey @benjdlambert, does the info in this issue provide enough context?

[kurtaking]

I'm pausing this work until I hear back.

[benjdlambert]

@alde think this one is something that you might find interesting

[awanlin]

@kurtaking, please keep going, I think this is a totally valid feature to add and I know it would have helped a few people recently on Discord. 👍

[alde]

I like this, the plugin was meant as a bit of an admin tool to get some insights into why entities don't show up, but it certainly could make sense to be able to remove things too. Worst case scenario if you delete something that's still tracked it'll come back with the same issue, so not really a big problem I believe.

[alde]

I could use feedback on what we want to do with the <PendingEntities /> component (tab).

Pending entities I don't really think should be deleted - they should either get processed or failed. Ideally they shouldn't be pending for very long.

[kurtaking]

hey @awanlin, any recommendation on resolving the failed Preview (build) / Build PR image (pull_request) step?

[awanlin]

Honestly not sure but I triggered it to run again and we'll see how that goes 🤔

[awanlin]

Looks like that did it, builds are green! 🚀

[benjdlambert]

@alde gonna leave this for you and @backstage/catalog-maintainers to review and ship :tada:

[alde]

@kurtaking given a breaking change isn't a deal breaker, is there anything left to do?

[kurtaking]

@kurtaking given a breaking change isn't a deal breaker, is there anything left to do?

@alde, I was out moving last week. I will update the changelog to be a major bump and we should be good to go 👍🏼

[benjdlambert]

@kurtaking think that the changeset should still be minor if it's a breaking change. The package is still 0.x I think, so minor is effectively for breaking changes when the package is less than stable.

[kurtaking]

@kurtaking think that the changeset should still be minor if it's a breaking change. The package is still 0.x I think, so minor is effectively for breaking changes when the package is less than stable.

@benjdlambert - TIL, thank you! I'll get that updated.

[kurtaking]

Looking for another review from the maintainers / codeowners 👋🏼 ❤️

[kurtaking]

@vinzscam, I see you are listed as codeowner under the reviewers. Can you help with the second review?

[kurtaking]

@awanlin, can you help get me traction with the required reviews?

[benjdlambert]

@kurtaking can you rebase the PR? :pray:

[kurtaking]

@kurtaking can you rebase the PR? 🙏

@benjdlambert, doing so is causing some unexpected failures.

[benjdlambert]

@kurtaking I think I might have fixed it 🤞

[kurtaking]

@kurtaking I think I might have fixed it 🤞

@benjdlambert, your update contained a few errors, so I rebased it again. Still running into issues 😢

[kurtaking]

thank you, @benjdlambert!! 🙌🏼

[benjdlambert]

@kurtaking I just want to make the changes to support the new auth system with this before shipping, apologies for the delay, will try and get to this in the next day or so :pray:

[benjdlambert]

@kurtaking I think this should be good to go now. Sorry for the delay - I've also just updated the changeset to reflect a little update in the APIs. Thought it was better to wrap this up in a create static method similar to the .fromConfig statics that we have so that we can evolve the API a little easier rather than using a constructor for this.