feat: migrate issues GET APIs to GithubSDK

RocketChat / Apps.Github22

The ultimate AI-powered app extending Rocket.Chat for global developers collaborating on Github (2024 and beyond)

33 stars 37 forks source link

feat: migrate issues GET APIs to GithubSDK #145

Open JeffreytheCoder opened 4 months ago

JeffreytheCoder commented 4 months ago

Issue(s)

Fixes a part of #143

Acceptance Criteria fulfillment

Completed 6 migration tasks related to issues GET APIs

[x] 13. Migrate getIssueTemplates method
[x] 14. Migrate getIssueTemplateCode method
[x] 20. Migrate getUserAssignedIssues method
[x] 21. Migrate getIssueData method
[x] 24. Migrate getIssuesComments method
[x] 27. Migrate getRepositoryIssues method

VipinDevelops commented 4 months ago

Hey @JeffreytheCoder great work with the migration I would suggest you attach a Video to show case that the Features are working as expected with new changes.

JeffreytheCoder commented 4 months ago

Thanks @VipinDevelops! I saw you created a GitHubApi instance for calling getBasicUserInfo in #144 .

https://github.com/RocketChat/Apps.Github22/blob/109aae39cdd45850b3ea12ac885b790251546c5c/github/modals/UserProfileModal.ts#L49-L57

But in this way, everytime we need to call an API, we need to create a instance and fetch properties like access_token and BaseHost.

I'm thinking of creating a GitHubApi singleton on app setup. On creation, the singleton will fetch and store the properties. All app actions can call APIs using the singleton. What do you think?

VipinDevelops commented 4 months ago

Hey @JeffreytheCoder Yesterday, @samad-yar-khan Also shared about this and suggested a new way to improve this with a nice reference,

Your approach is good, but let me first research the method Samad shared and then I can make a new PR that fixes this issue.

samad-yar-khan commented 3 months ago

@JeffreytheCoder @VipinDevelops I was thinking along the same lines as @JeffreytheCoder. We should think about two things while approaching the design for this class

It should be easy to use.
It should be easy to extend/update.
Is there a performance degradation due to fetching of token and URL each time this is used ?
Can the user update the base url/token in setting and is the code able to use the updated configuration.

JeffreytheCoder commented 3 months ago

@samad-yar-khan Thanks for the insights! Like my comment above, I think having token & URL stored in a singleton solves the issue of fetching themevery time. Whenever the user updates token & URL in the settings, we update the singleton too. What do you think?

VipinDevelops commented 3 months ago

I agree with @samad-yar-khan. @JeffreytheCoder, can you please implement it that way in this PR? Then, Samad can review it, and we can move forward from there and also update the few places where this new class is being used.

JeffreytheCoder commented 3 months ago

Implemented the singleton approach and applied to all migrated methods in this PR and in #144.

Behavior same as before: singleton

JeffreytheCoder commented 3 months ago

The singleton gets api host from environment and generates access token when initialized. We'll need to update these when user update settings / login / logout in another PR.