Feature/1269 add shortcut to tailwarden in inventory table #1306

syedbarimanjan · 2023-12-30T08:15:31Z

Problem

When a service is not supported, there is no interaction with the user, leading to confusion as the user may perceive the tool as broken. #1269

Solution

I created a servicehelper utility that stores all the providers and their services in an object. Two functions were implemented:

1. `checkIfServiceIsSupported(provider: string, service: string): boolean`

Takes a provider and service as parameters.
Returns a boolean indicating whether the service is supported for the given provider.

2. `checkIsSomeServiceUnavailable(receivedServices: string[]): boolean`

Takes an array of services as a parameter.
Returns a boolean indicating whether any service in the array is not supported.

In the useInventory hook, I added a new state to check if some service is unavailable. If there is something in the searchedInventory array, I loop over it and use the first function to check if even one element is not a supported service. If true, I set the state. If the searchedInventory is empty, I fetch all services from the API endpoint and use the second function to check if any service is not available. The result is set to the state.

Finally, the state is returned from the useInventory hook, and in the InventoryPage, it is destructured and passed to the InventoryStatsCard. If the state is true, an error icon is displayed, and clicking on it redirects to the Tailwarden page for more information.

Screenshots

Notes

I have updated the contributing guide to include a reminder for contributors to add any new provider or service to the list in the serviceHelper utility.

Checklist

Code follows the contributing guidelines
Changes have been thoroughly tested
Documentation has been updated, if necessary
Any dependencies have been added to the project, if necessary

Reviewers

@Azanul @jakepage91 @mlabouardy @Traxmaxx @ShubhamPalriwala @AvineshTripathi @greghub

github-actions

Hey, thank you for opening your Pull Request ! 🙂 While a Tailwarden team member takes a look at your PR we would like to invite you to join our official Discord server, where you can interact directly with other contributors and Tailwarden team members. Link here: https://discord.tailwarden.com

…n-inventory-table

…ble' of https://github.com/syedbarimanjan/komiser into feature/1269-Add-shortcut-to-Tailwarden-in-inventory-table

dashboard/utils/serviceHelper.ts

CONTRIBUTING.md

Co-authored-by: Azanul Haque <42029519+Azanul@users.noreply.github.com>

…ble' of https://github.com/syedbarimanjan/komiser into feature/1269-Add-shortcut-to-Tailwarden-in-inventory-table

syedbarimanjan · 2024-01-02T07:42:42Z

@Azanul did the changes.

Azanul · 2024-01-02T09:41:04Z

AvineshTripathi · 2024-01-02T12:08:15Z

I find the position to be odd can we move the icon inside the discovered cost part

AvineshTripathi · 2024-01-02T12:10:38Z

dashboard/utils/serviceHelper.ts

@@ -0,0 +1,229 @@
+// Define a union type for supported cloud providers.
+export type Providers =


Do you think having an api that returns the list of resources would be more better. I find this a bit redundant but open to discuss

there is an api which returns the services/resources which the user has in the database I am utilizing it in the useInventory hook but the problem is how do we identify which one of those services which the user is using are not supported

one thing we could do is that change the /services api to return an object which has the name of the service and then another property which indicates if it is supported or not

@Azanul do you think we can keep the cost field in db as null? if yes will it be a good choice(I feel that would be costly!) the main reason I want to do this is because there is manual work in adding the names in frontend too and I want to keep this as separate. Thoughts?

Indeed, that approach would work if the service/resource is not supported, the cost should be set to null. This way, we can then handle errors accordingly. But it would be hard to check if the service is supported or not and then setting the cost to null, and that might even have some manual work init.

I think that should be a simple, we can convert the cost field of Resource schema to either be null or float value. This way we can have just call for resoources that have null value in it
ref: https://bun.uptrace.dev/guide/models.html#nulls

I think that should be a simple, we can convert the cost field of Resource schema to either be null or float value. This way we can have just call for resoources that have null value in it ref: https://bun.uptrace.dev/guide/models.html#nulls

Ok I will try to do this and can you confirm that are we using bun as an orm here and where should I start.

here https://github.com/tailwarden/komiser/blob/develop/models/resource.go and you can use above link

syedbarimanjan · 2024-01-02T12:27:35Z

I find the position to be odd can we move the icon inside the discovered cost part

It is what the designer designed, and I also like it the alternative would be like this

which doesnt look good

AvineshTripathi · 2024-01-02T13:19:22Z

@AllieMendes whats your take on above

AllieMendes · 2024-01-03T15:05:30Z

Hey everyone!

The positioning is intentional and ties in with the layout we use at Tailwarden, which creates familiarity for similar features/information.
The fact that it's slightly outside the container also helps highlight it, which is important as the information provides transparency.

It would be great if we could keep the original layout from the designs.

…n-inventory-table

mlabouardy · 2024-01-16T09:59:28Z

@Azanul could we merge this one?

…n-inventory-table

Azanul · 2024-01-16T10:00:41Z

@Azanul could we merge this one?

Yes, another approval is needed

syedbarimanjan · 2024-01-16T12:03:55Z

@Azanul could we merge this one?

I am working on implementing this the backend way as suggested by Avinesh but if this is all right then maybe I shouldn't?

Azanul · 2024-01-16T12:10:52Z

@Azanul could we merge this one?

I am working on implementing this the backend way as suggested by Avinesh but if this is all right then maybe I shouldn't?

Although I agree with @AvineshTripathi, this PR looks good. We can work on the recommended changes on a different PR.
We can do the changes here as well, depending completely on your availability.

syedbarimanjan · 2024-01-16T13:38:25Z

@Azanul could we merge this one?

I am working on implementing this the backend way as suggested by Avinesh but if this is all right then maybe I shouldn't?

Although I agree with @AvineshTripathi, this PR looks good. We can work on the recommended changes on a different PR. We can do the changes here as well, depending completely on your availability.

I will INSHAALLAH commit the changes in some days.

syedbarimanjan · 2024-01-25T02:18:12Z

@Azanul could we merge this one?

I am working on implementing this the backend way as suggested by Avinesh but if this is all right then maybe I shouldn't?

Although I agree with @AvineshTripathi, this PR looks good. We can work on the recommended changes on a different PR. We can do the changes here as well, depending completely on your availability.

Can you just merge this one when I get time I will raise a new pr for implementing this the backend way. @mlabouardy

…n-inventory-table

syedbarimanjan · 2024-01-27T17:11:10Z

@Azanul could we merge this one?

Yes, another approval is needed

@mlabouardy

* feat: add service check helpers * feat(useInventory): track unsupported services state * feat(ui): enhance ui to reflect unsupported services * docs: update contributing guidelines * docs: update contributing guidelines * Update CONTRIBUTING.md * style: suggested changes Co-authored-by: Azanul Haque <42029519+Azanul@users.noreply.github.com> * fix: type error * style: add border radius --------- Co-authored-by: Azanul Haque <42029519+Azanul@users.noreply.github.com>

syedbarimanjan added 4 commits December 30, 2023 10:53

feat: add service check helpers

2b12fca

feat(useInventory): track unsupported services state

4ce2d98

feat(ui): enhance ui to reflect unsupported services

7915d6f

docs: update contributing guidelines

4f80f9b

syedbarimanjan requested review from jakepage91, mlabouardy, ShubhamPalriwala, AvineshTripathi, greghub, Traxmaxx and Azanul as code owners December 30, 2023 08:15

github-actions bot reviewed Dec 30, 2023

View reviewed changes

syedbarimanjan added 4 commits December 30, 2023 14:36

docs: update contributing guidelines

0a2a221

Update CONTRIBUTING.md

515a3d7

Merge branch 'develop' into feature/1269-Add-shortcut-to-Tailwarden-i…

fde3fd4

…n-inventory-table

Merge branch 'feature/1269-Add-shortcut-to-Tailwarden-in-inventory-ta…

7c5bd7b

…ble' of https://github.com/syedbarimanjan/komiser into feature/1269-Add-shortcut-to-Tailwarden-in-inventory-table

Azanul requested changes Jan 2, 2024

View reviewed changes

dashboard/utils/serviceHelper.ts Outdated Show resolved Hide resolved

dashboard/utils/serviceHelper.ts Outdated Show resolved Hide resolved

CONTRIBUTING.md Show resolved Hide resolved

syedbarimanjan and others added 3 commits January 2, 2024 12:01

style: suggested changes

bcdf968

Co-authored-by: Azanul Haque <42029519+Azanul@users.noreply.github.com>

fix: type error

22b3a79

Merge branch 'feature/1269-Add-shortcut-to-Tailwarden-in-inventory-ta…

cff2af3

…ble' of https://github.com/syedbarimanjan/komiser into feature/1269-Add-shortcut-to-Tailwarden-in-inventory-table

syedbarimanjan requested a review from Azanul January 2, 2024 08:07

Azanul approved these changes Jan 2, 2024

View reviewed changes

AvineshTripathi reviewed Jan 2, 2024

View reviewed changes

syedbarimanjan requested a review from AvineshTripathi January 2, 2024 12:57

style: add border radius

c0c1c7e

Merge branch 'develop' into feature/1269-Add-shortcut-to-Tailwarden-i…

e389cb2

…n-inventory-table

Merge branch 'develop' into feature/1269-Add-shortcut-to-Tailwarden-i…

ae55f49

…n-inventory-table

Merge branch 'develop' into feature/1269-Add-shortcut-to-Tailwarden-i…

9c4f416

…n-inventory-table

Azanul approved these changes Jan 25, 2024

View reviewed changes

AvineshTripathi approved these changes Jan 27, 2024

View reviewed changes

Azanul merged commit 5e2fb7a into tailwarden:develop Jan 28, 2024
3 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/1269 add shortcut to tailwarden in inventory table #1306

Feature/1269 add shortcut to tailwarden in inventory table #1306

syedbarimanjan commented Dec 30, 2023 •

edited

Loading

github-actions bot left a comment

syedbarimanjan commented Jan 2, 2024

Azanul commented Jan 2, 2024

AvineshTripathi commented Jan 2, 2024

AvineshTripathi Jan 2, 2024

syedbarimanjan Jan 2, 2024 •

edited

Loading

syedbarimanjan Jan 2, 2024

AvineshTripathi Jan 3, 2024

syedbarimanjan Jan 3, 2024 •

edited

Loading

AvineshTripathi Jan 4, 2024 •

edited

Loading

syedbarimanjan Jan 4, 2024 •

edited

Loading

AvineshTripathi Jan 10, 2024

syedbarimanjan commented Jan 2, 2024 •

edited

Loading

AvineshTripathi commented Jan 2, 2024

AllieMendes commented Jan 3, 2024

mlabouardy commented Jan 16, 2024

Azanul commented Jan 16, 2024 •

edited

Loading

syedbarimanjan commented Jan 16, 2024

Azanul commented Jan 16, 2024

syedbarimanjan commented Jan 16, 2024

syedbarimanjan commented Jan 25, 2024 •

edited

Loading

syedbarimanjan commented Jan 27, 2024

		@@ -0,0 +1,229 @@
		// Define a union type for supported cloud providers.
		export type Providers =

Feature/1269 add shortcut to tailwarden in inventory table #1306

Feature/1269 add shortcut to tailwarden in inventory table #1306

Conversation

syedbarimanjan commented Dec 30, 2023 • edited Loading

Problem

Solution

1. checkIfServiceIsSupported(provider: string, service: string): boolean

2. checkIsSomeServiceUnavailable(receivedServices: string[]): boolean

Screenshots

Notes

Checklist

Reviewers

github-actions bot left a comment

Choose a reason for hiding this comment

syedbarimanjan commented Jan 2, 2024

Azanul commented Jan 2, 2024

AvineshTripathi commented Jan 2, 2024

AvineshTripathi Jan 2, 2024

Choose a reason for hiding this comment

syedbarimanjan Jan 2, 2024 • edited Loading

Choose a reason for hiding this comment

syedbarimanjan Jan 2, 2024

Choose a reason for hiding this comment

AvineshTripathi Jan 3, 2024

Choose a reason for hiding this comment

syedbarimanjan Jan 3, 2024 • edited Loading

Choose a reason for hiding this comment

AvineshTripathi Jan 4, 2024 • edited Loading

Choose a reason for hiding this comment

syedbarimanjan Jan 4, 2024 • edited Loading

Choose a reason for hiding this comment

AvineshTripathi Jan 10, 2024

Choose a reason for hiding this comment

syedbarimanjan commented Jan 2, 2024 • edited Loading

AvineshTripathi commented Jan 2, 2024

AllieMendes commented Jan 3, 2024

mlabouardy commented Jan 16, 2024

Azanul commented Jan 16, 2024 • edited Loading

syedbarimanjan commented Jan 16, 2024

Azanul commented Jan 16, 2024

syedbarimanjan commented Jan 16, 2024

syedbarimanjan commented Jan 25, 2024 • edited Loading

syedbarimanjan commented Jan 27, 2024

syedbarimanjan commented Dec 30, 2023 •

edited

Loading

1. `checkIfServiceIsSupported(provider: string, service: string): boolean`

2. `checkIsSomeServiceUnavailable(receivedServices: string[]): boolean`

syedbarimanjan Jan 2, 2024 •

edited

Loading

syedbarimanjan Jan 3, 2024 •

edited

Loading

AvineshTripathi Jan 4, 2024 •

edited

Loading

syedbarimanjan Jan 4, 2024 •

edited

Loading

syedbarimanjan commented Jan 2, 2024 •

edited

Loading

Azanul commented Jan 16, 2024 •

edited

Loading

syedbarimanjan commented Jan 25, 2024 •

edited

Loading