ShortURL Plugins #1222

avila-m-6 · 2024-09-14T05:35:59Z

Hey, I just made a Pull Request!

This is the set of ShortURL plugins, both frontend and backend sharing workspace.

This plugin will enable the creation of short urls within /shorturl and redirection through /go:id.

Features:

Create a persistent short url
Read/filter existing URLs
Get redirected through backstage to a long url using HOST/go/:id
Auto-copy new url on creation
The DB stores only the random string and destination, making the URLs reusable across deployments
Usage "metrics" (only counts) per link
URL format validation on creation attempt

✔️ 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)

Redirect page has a progress bar for loading, and an error panel for failures:

This is WIP. Next steps:

Actually integrate the frontend with backend
Add route to access the links through backstage.com/go/AAABBB
Auto-copy created url into clipboard
Add error handling
Add tests
Make the redirect page friendlier

This is related to #221 and #1220

Signed-off-by: Marcello Avila <[email protected]>

backstage-goalie · 2024-09-14T05:36:28Z

Unnecessary Changesets

The following package(s) are private and do not need a changeset:

@backstage-community/plugin-shorturl-backend
@backstage-community/plugin-shorturl

Changed Packages

Package Name	Package Path	Changeset Bump	Current Version
@backstage-community/plugin-shorturl-backend	workspaces/shorturl/plugins/shorturl-backend	minor	`v0.1.0`
@backstage-community/plugin-shorturl	workspaces/shorturl/plugins/shorturl	minor	`v0.1.0`

billabongrob · 2024-09-14T21:54:19Z

@avila-m-6 Do you think it would make sense to also support bringing your own short URL? I started a bit of work on this as well since it's an immediate need, but what I'm thinking is tying the route /shorturl to a path /go, then supporting the /go/:id
example. So if your network team is nice enough to do some aliasing for b.c to backstage.corporate.com then you could share URLs such as b.c/go/infosec or b.c/go/support - just spitballing.
Another concern I have is removing the auth requirements on /shorturl/:id but not /shorturl, so as to support a clean redirect. Just random musings when thinking about the functionality.

I really like the simplicity of the creation at the top and the thoughtfulness to automatically copy it into the clipboard!

avila-m-6 · 2024-09-16T14:23:04Z

I like the idea, but how about for a next iteration? So we get the ball rolling and some users validation.

And I would like you to describe better that auth removal intent

billabongrob · 2024-09-17T22:52:42Z

totally fair @avila-m-6
The only reason I mentioned the auth removal was so that if Backstage were handling the redirect, users didn't have to auth into Backstage in order to be redirected, if that makes sense? Makes the redirect process a bit longer.

avila-m-6 · 2024-09-17T23:20:15Z

Ah yes, I like that. It makes sense as shorturl is no auth provider. Just a translator. It shouldn't ever have any sensitive data. I didn't add any authentication on the plugin though. That's on the backend integration step

Signed-off-by: Marcello Avila <[email protected]>

* use discoverApi for api interaction * use configApi for url listing * validate url input format * refresh list on url creation across components * auto-copy to clipboard on creation * implement alertApi for verbosity * implement create and get apis * update backend api for creation values Signed-off-by: Marcello Avila <[email protected]>

Signed-off-by: Marcello Avila <[email protected]>

avila-m-6 · 2024-09-18T07:20:03Z

Only frontend tests are missing. But logic should be good to go

Signed-off-by: Marcello Avila <[email protected]>

avila-m-6 · 2024-09-23T23:16:35Z

@BethGriggs, sorry to tag. I'm unclear on the next steps. Also I was instructed by the automation on #1220 that no changeset was required. But I saw a run that failed for a missing changeset?

https://github.com/backstage/community-plugins/actions/runs/10917413204/job/30371450366#step:6:8

Signed-off-by: Marcello Ávila <[email protected]>

BethGriggs · 2024-10-02T11:33:45Z

API report generation is failing in https://github.com/backstage/community-plugins/actions/runs/11020142480/job/30676982272?pr=1222

I do believe we should add changesets to trigger the release process.

github-actions · 2024-10-16T12:07:36Z

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!

Signed-off-by: Marcello Avila <[email protected]>

…ns into shorturl-front

Signed-off-by: Marcello Avila <[email protected]>

…ns into shorturl-front

avila-m-6 · 2024-10-17T02:48:54Z

@BethGriggs, letting you know in case stale tag does not get removed automatically. I've added the changesets and api-reports :)

awanlin

Thanks for the contribution @avila-m-6, left a few comments, nothing huge but should be looked at before we can merge this in.

Also, cna you please add yourself to the CODEOWNERS file: https://github.com/backstage/community-plugins/blob/main/.github/CODEOWNERS

workspaces/shorturl/app-config.yaml

workspaces/shorturl/plugins/.changeset/lovely-games-mix.md

workspaces/shorturl/plugins/shorturl-backend/README.md

awanlin · 2024-10-24T21:41:06Z

workspaces/shorturl/package.json

+  "resolutions": {
+    "@types/react": "^18",
+    "@types/react-dom": "^18",
+    "@microsoft/api-extractor": "7.36.4"


Please remove this resolution, it's no longer needed. You'll also need to do a version bump to use the latest Backstage packages from 1.32.x. Finally, this change will rename the API reports following a new naming convention so make sure to re-generate them.

It's still here 🤔

workspaces/shorturl/plugins/shorturl-backend/migrations/20230629144800_init.js

workspaces/shorturl/plugins/shorturl-backend/src/service/router.ts

workspaces/shorturl/plugins/shorturl/README.md

workspaces/shorturl/plugins/shorturl-backend/README.md

backstage-goalie · 2024-10-25T04:09:19Z

Thanks for the contribution!
All commits need to be DCO signed before they are reviewed. Please refer to the the DCO section in CONTRIBUTING.md or the DCO status for more info.

Signed-off-by: Marcello Avila <[email protected]>

awanlin

Thanks for resolving the comments @avila-m-6, just some simple adjustments to the config.d.ts and getting the build green at which point we will be able to approve and merge this in.

awanlin · 2024-10-25T19:34:04Z

workspaces/shorturl/package.json

+  "resolutions": {
+    "@types/react": "^18",
+    "@types/react-dom": "^18",
+    "@microsoft/api-extractor": "7.36.4"


It's still here 🤔

workspaces/shorturl/plugins/shorturl-backend/config.d.ts

Signed-off-by: Marcello Avila <[email protected]>

avila-m-6 · 2024-10-26T05:21:49Z

I took a good read at the api reports resources but I don't understand why they still came as api-report.md.api.md.

I did the v1.32 bump after removing the resolution.

I read through backstage/backstage#25671 and #886

awanlin

Looks like there's still issues with the API Reports.

awanlin · 2024-10-29T14:39:11Z

workspaces/shorturl/backstage.json

@@ -0,0 +1 @@
+{ "version": "1.30.0" }


This tells me you are still on an older version which is probably why the API Reports are not coming up correctly

You should be able to run yarn backstage-cli versions:bump --release main from the root of your workspace: '/workspaces/shorturl. Then commit those changes. Once that's done then try building the API Reports again with yarn build:api-reports

avila-m-6 added 11 commits September 13, 2024 02:19

add: shorturl workspace

65388c1

Signed-off-by: Marcello Avila <[email protected]>

add: shorturl-backend template

ba6e481

Signed-off-by: Marcello Avila <[email protected]>

add: readme and database mock test

a39dac2

Signed-off-by: Marcello Avila <[email protected]>

add: proper deps

facfbe7

Signed-off-by: Marcello Avila <[email protected]>

add: docs index and nanoid v3 usage

fe04e3c

Signed-off-by: Marcello Avila <[email protected]>

shorturl-backend: add changeset and test cases

764bd78

Signed-off-by: Marcello Avila <[email protected]>

rm: private changeset

d26740b

Signed-off-by: Marcello Avila <[email protected]>

add: yarn new shorturl

e8ba60c

Signed-off-by: Marcello Avila <[email protected]>

add: react missing deps

2e95732

Signed-off-by: Marcello Avila <[email protected]>

add: ShortURL rename and tsconfig jsx

60811e6

Signed-off-by: Marcello Avila <[email protected]>

add: url create panel

8840048

Signed-off-by: Marcello Avila <[email protected]>

avila-m-6 requested review from backstage-service and a team as code owners September 14, 2024 05:35

avila-m-6 requested a review from BethGriggs September 14, 2024 05:36

avila-m-6 marked this pull request as draft September 14, 2024 05:36

avila-m-6 added 2 commits September 17, 2024 20:44

add: table fetch hooks and url alerts

b54946b

Signed-off-by: Marcello Avila <[email protected]>

avila-m-6 changed the title ~~Shorturl frontend~~ ShortURL Plugins Sep 18, 2024

avila-m-6 mentioned this pull request Sep 18, 2024

add: short url backend #1220

Closed

5 tasks

avila-m-6 added 3 commits September 17, 2024 23:24

add: /go redirection component

23677d5

Signed-off-by: Marcello Avila <[email protected]>

add: fix go component api

16a2265

Signed-off-by: Marcello Avila <[email protected]>

add: /go page friendlier

58f597c

Signed-off-by: Marcello Avila <[email protected]>

avila-m-6 marked this pull request as ready for review September 18, 2024 16:42

fix: app-config prettier

1c5de99

Signed-off-by: Marcello Avila <[email protected]>

Merge branch 'main' into shorturl-front

a86deac

Signed-off-by: Marcello Ávila <[email protected]>

github-actions bot added the stale label Oct 16, 2024

avila-m-6 and others added 5 commits October 16, 2024 19:53

add: shorturl changesets

4d23c34

Signed-off-by: Marcello Avila <[email protected]>

Merge branch 'shorturl-front' of github.com:avila-m-6/community-plugi…

475d12c

…ns into shorturl-front

Merge branch 'main' into shorturl-front

c3c0dff

add: api-reports

18081ce

Signed-off-by: Marcello Avila <[email protected]>

Merge branch 'shorturl-front' of github.com:avila-m-6/community-plugi…

6afcb28

…ns into shorturl-front

github-actions bot removed the stale label Oct 17, 2024

awanlin self-requested a review October 21, 2024 18:25

awanlin requested changes Oct 24, 2024

View reviewed changes

avila-m-6 added 3 commits October 25, 2024 08:24

add: small review tweaks

558c9c3

Signed-off-by: Marcello Avila <[email protected]>

config and install instructions

2ee468d

Signed-off-by: Marcello Avila <[email protected]>

bump to 1.32.x

a7ccaed

Signed-off-by: Marcello Avila <[email protected]>

avila-m-6 force-pushed the shorturl-front branch from a69bc21 to a7ccaed Compare October 25, 2024 14:25

avila-m-6 added 2 commits October 25, 2024 08:25

Merge branch 'main' into shorturl-front

c62e18b

Merge branch 'main' into shorturl-front

18d73c6

awanlin requested changes Oct 25, 2024

View reviewed changes

avila-m-6 and others added 2 commits October 25, 2024 22:59

fix reports and config.d.ts

2a6d6dd

Signed-off-by: Marcello Avila <[email protected]>

Merge branch 'main' into shorturl-front

d69ab84

awanlin reviewed Oct 29, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ShortURL Plugins #1222

ShortURL Plugins #1222

avila-m-6 commented Sep 14, 2024 •

edited

Loading

backstage-goalie bot commented Sep 14, 2024 •

edited

Loading

billabongrob commented Sep 14, 2024

avila-m-6 commented Sep 16, 2024

billabongrob commented Sep 17, 2024

avila-m-6 commented Sep 17, 2024

avila-m-6 commented Sep 18, 2024

avila-m-6 commented Sep 23, 2024

BethGriggs commented Oct 2, 2024

github-actions bot commented Oct 16, 2024

avila-m-6 commented Oct 17, 2024

awanlin left a comment

awanlin Oct 24, 2024

avila-m-6 Oct 25, 2024

awanlin Oct 25, 2024

backstage-goalie bot commented Oct 25, 2024

awanlin left a comment

awanlin Oct 25, 2024

avila-m-6 commented Oct 26, 2024

awanlin left a comment

awanlin Oct 29, 2024

awanlin Oct 29, 2024

ShortURL Plugins #1222

Are you sure you want to change the base?

ShortURL Plugins #1222

Conversation

avila-m-6 commented Sep 14, 2024 • edited Loading

Hey, I just made a Pull Request!

✔️ Checklist

backstage-goalie bot commented Sep 14, 2024 • edited Loading

Unnecessary Changesets

Changed Packages

billabongrob commented Sep 14, 2024

avila-m-6 commented Sep 16, 2024

billabongrob commented Sep 17, 2024

avila-m-6 commented Sep 17, 2024

avila-m-6 commented Sep 18, 2024

avila-m-6 commented Sep 23, 2024

BethGriggs commented Oct 2, 2024

github-actions bot commented Oct 16, 2024

avila-m-6 commented Oct 17, 2024

awanlin left a comment

Choose a reason for hiding this comment

awanlin Oct 24, 2024

Choose a reason for hiding this comment

avila-m-6 Oct 25, 2024

Choose a reason for hiding this comment

awanlin Oct 25, 2024

Choose a reason for hiding this comment

backstage-goalie bot commented Oct 25, 2024

awanlin left a comment

Choose a reason for hiding this comment

awanlin Oct 25, 2024

Choose a reason for hiding this comment

avila-m-6 commented Oct 26, 2024

awanlin left a comment

Choose a reason for hiding this comment

awanlin Oct 29, 2024

Choose a reason for hiding this comment

awanlin Oct 29, 2024

Choose a reason for hiding this comment

avila-m-6 commented Sep 14, 2024 •

edited

Loading

backstage-goalie bot commented Sep 14, 2024 •

edited

Loading