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.

Sign up for GitHub

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

Jump to bottom

MVP: Refactoring and Improvements #71

Open
7 of 8 tasks
brunocribeiro opened this issue Oct 18, 2023 · 0 comments
Open
7 of 8 tasks

MVP: Refactoring and Improvements #71

brunocribeiro opened this issue Oct 18, 2023 · 0 comments
Labels
epic Top level issue

Comments

@brunocribeiro
Copy link
Contributor

brunocribeiro commented Oct 18, 2023 •
edited by kylejwatson
Loading

Goal: ...

Value: ...

Deliverables:

  • Have test suites for every component of the solution
  • Support other filters in the plugin (time window, team/group)

Tasks
Preview Give feedback
  1. [BE] Add support for time window filtering #62
    kylejwatson
  2. [FE] Add support for time window filtering #63
    enhancement
    duke-b
  3. [FE] Create a test suite for existing frontend plugin components #68
    kylejwatson
  4. [FE] Modify the package README with installation instructions #69
    kylejwatson
  5. [OPS] Add contributor guidelines to the README. #82
    kylejwatson
  6. [OPS] Research preparations for open-sourcing (license, precautions, security) #81
    kylejwatson
  7. [OPS] Publish NPM package for PRs #99
    kylejwatson
  8. [OPS] Add badges and screen shots to README #100
    kylejwatson
@brunocribeiro brunocribeiro added the epic Top level issue label Oct 18, 2023
@brunocribeiro brunocribeiro moved this to Todo in opendora Oct 18, 2023
@kylejwatson kylejwatson moved this from Todo to In Progress in opendora Oct 30, 2023
kylejwatson added a commit that referenced this issue Nov 16, 2023
@kylejwatson
test(backstage-plugin): Add msw and refactor tests
fc958d7 
Add msw to mock backend and avoid mocking the service.
Simplify some test cases by checking for only the needed elements.
Add error handling to the data service.

Addresses #71
kylejwatson added a commit that referenced this issue Nov 16, 2023
@kylejwatson
test(backstage-plugin): Add data service tests
f3de800 
Use msw to add group data service tests and remove the ignore comment.a

Addresses #71
kylejwatson added a commit that referenced this issue Nov 16, 2023
@kylejwatson
test(backstage-plugin): Fix linting test files
86d9981 
Move test setup files out of source folder to avoid needing dependencies instead of dev dependencies
when compiling typescript.

Addresses #71
@kylejwatson kylejwatson mentioned this issue Nov 16, 2023
Merged
8 tasks
kylejwatson added a commit that referenced this issue Nov 16, 2023
@kylejwatson
test(backstage-plugin): Downgrade msw
d0875e3 
Downgrade msw to be inline with backstage setup and make it work with the tsconfig.

Addresses #71
kylejwatson added a commit that referenced this issue Nov 16, 2023
@kylejwatson
test(backstage-plugin): Add consts for urls
3965dca 
Add reusable consts for testing urls to mock with msw and supply in mock config

Addresses #71
kylejwatson added a commit that referenced this issue Nov 16, 2023
@kylejwatson
refactor(backstage-plugin): Extract logic to hooks
22ca0c1 
Extract out error/response logic from component to a reusable hook
to avoid complicated state in the component.
Use a context to provide metric details for the request to avoid prop drilling.
Create a reusable component to reuse logic for switching between a graph, loading bar or error.

Addresses #71
@kylejwatson kylejwatson mentioned this issue Nov 16, 2023
Merged
8 tasks
kylejwatson added a commit that referenced this issue Nov 16, 2023
@kylejwatson
docs: Fix typos in git message and PR templates
c0846f9 
Changes address to Addresses for correct grammar in PR template.
Changes Fixes to Addresses in git message as most commits won't fix the issue but
be part of a bunch of commits that fix the issue.

Addresses #71
@kylejwatson kylejwatson mentioned this issue Nov 16, 2023
Merged
8 tasks
kylejwatson added a commit that referenced this issue Nov 20, 2023
@kylejwatson
docs: Fix typos in git message and PR templates (#109)
f69ebb8 
Changes address to Addresses for correct grammar in PR template.
Changes Fixes to Addresses in git message as most commits won't fix the issue but
be part of a bunch of commits that fix the issue.

Addresses #71
kylejwatson added a commit that referenced this issue Nov 20, 2023
@kylejwatson
test(backstage-plugin): Change value used in tests
cdd225c 
So that we can check for the exact decimal used from the response.
Should help make the test a bit clearer.

Addresses #71
kylejwatson added a commit that referenced this issue Nov 20, 2023
@kylejwatson
Chore/#71 refactor tests using msw (#107)
a5e1fb1 
* test(backstage-plugin): Add msw and refactor tests

Add msw to mock backend and avoid mocking the service.
Simplify some test cases by checking for only the needed elements.
Add error handling to the data service.

Addresses #71

* test(backstage-plugin): Add data service tests

Use msw to add group data service tests and remove the ignore comment.a

Addresses #71

* test(backstage-plugin): Fix linting test files

Move test setup files out of source folder to avoid needing dependencies instead of dev dependencies
when compiling typescript.

Addresses #71

* test(backstage-plugin): Downgrade msw

Downgrade msw to be inline with backstage setup and make it work with the tsconfig.

Addresses #71

* test(backstage-plugin): Add consts for urls

Add reusable consts for testing urls to mock with msw and supply in mock config

Addresses #71

* test(backstage-plugin): Change value used in tests

So that we can check for the exact decimal used from the response.
Should help make the test a bit clearer.

Addresses #71
kylejwatson added a commit that referenced this issue Nov 20, 2023
@kylejwatson
Merge branch 'main' into chore/#71-refactor-error-reducer
5d60bae
kylejwatson added a commit that referenced this issue Nov 20, 2023
@kylejwatson
refactor(backstage-plugin): Remove comment for test
fd8081e 
Remove the comment about extracting the test for the hook. Tests should follow user usage.

Addresses #71
kylejwatson added a commit that referenced this issue Nov 27, 2023
@kylejwatson
Merge branch 'main' into chore/#71-refactor-error-reducer
73c6239
kylejwatson added a commit that referenced this issue Nov 27, 2023
@kylejwatson
refactor(backstage-plugin): Extract overview to hook
dfdb676 
Extract logic to download and show progress/error to a hook/separate component.

Remove unused error file.

Addresses #71
kylejwatson added a commit that referenced this issue Nov 27, 2023
@kylejwatson
refactor(backstage-plugin): Move hook to own file
8d429ea 
Move benchmark hook to it's own file.
Rename overview to benchmark for consistency.

Addresses #71
kylejwatson added a commit that referenced this issue Nov 27, 2023
@kylejwatson
Merge branch 'main' into chore/#71-refactor-error-reducer
b7d5175
kylejwatson added a commit that referenced this issue Nov 27, 2023
@kylejwatson
refactor(backstage-plugin): Extract logic to hooks (#108)
ec4f07e 
* refactor(backstage-plugin): Extract logic to hooks

Extract out error/response logic from component to a reusable hook
to avoid complicated state in the component.
Use a context to provide metric details for the request to avoid prop drilling.
Create a reusable component to reuse logic for switching between a graph, loading bar or error.

Addresses #71

* refactor(backstage-plugin): Remove comment for test

Remove the comment about extracting the test for the hook. Tests should follow user usage.

Addresses #71

* refactor(backstage-plugin): Extract overview to hook

Extract logic to download and show progress/error to a hook/separate component.

Remove unused error file.

Addresses #71

* refactor(backstage-plugin): Move hook to own file

Move benchmark hook to it's own file.
Rename overview to benchmark for consistency.

Addresses #71
kylejwatson added a commit that referenced this issue Nov 29, 2023
@kylejwatson
refactor(backstage-plugin): Refactor data service
bb6f4f4 
Reuse request logic in the data service.
Rename data service from GroupDataService to DoraDataService.
Reorganise tests to describe them better.
Rename test to describe what is being tested.

Addresses #71
@kylejwatson kylejwatson mentioned this issue Nov 29, 2023
Merged
8 tasks
@kylejwatson kylejwatson moved this from In Progress to Todo in opendora Dec 1, 2023
kylejwatson added a commit that referenced this issue Dec 4, 2023
@kylejwatson
refactor(backstage-plugin): Refactor data service (#116)
48ec0b7 
Reuse request logic in the data service.
Rename data service from GroupDataService to DoraDataService.
Reorganise tests to describe them better.
Rename test to describe what is being tested.

Addresses #71
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
epic Top level issue
Projects
opendora
Status: Todo
Milestone
No milestone
Development

No branches or pull requests
1 participant
@brunocribeiro