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.

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

feat: add component definition list endpoint #396

Merged
merged 3 commits into from
Feb 29, 2024

Conversation

jvallesm
Copy link
Collaborator

@jvallesm jvallesm commented Feb 26, 2024

Because

  • Component page is going to be implemented in the website, requiring unified filtering and pagination.

This commit

  • Implements the component list endpoint, which for now doesn't have filtering capabilities.
  • Moves the component, operator and connector list logic to the domain layer.
    • The number of params passed from the handler to the domain is reduced (>3 params starts to get cumbersome) by using the proto request / response params. We already use proto structs as domain types so it's pointless to create an almost identical type.
    • Integration tests are moved to /pipeline as there's a single API and keeping separated directories by entity will keep increasing the make integration-test command.
  • Leverages the connector and operator list code to build the component list.

notes

⏭️ We'll insert and query the definitions into / from the database in order to have a more sensible pagination strategy and to unlock filtering.
⚠️ Integration tests require instill-ai/api-gateway#139

@jvallesm jvallesm self-assigned this Feb 26, 2024
Copy link

linear bot commented Feb 26, 2024

Copy link

codecov bot commented Feb 26, 2024

Codecov Report

Attention: Patch coverage is 0% with 182 lines in your changes are missing coverage. Please review.

Project coverage is 0.68%. Comparing base (3df9ae8) to head (2163c27).

Files Patch % Lines
pkg/service/service.go 0.00% 173 Missing ⚠️
pkg/service/convert.go 0.00% 9 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff            @@
##            main    #396      +/-   ##
========================================
- Coverage   0.70%   0.68%   -0.03%     
========================================
  Files          8       8              
  Lines       2960    3081     +121     
========================================
  Hits          21      21              
- Misses      2939    3060     +121     
Flag Coverage Δ
unittests 0.68% <0.00%> (-0.03%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jvallesm jvallesm force-pushed the jvalles/ins-3680-create-component-list-endpoint branch 5 times, most recently from da32097 to 75fc444 Compare February 28, 2024 17:13
@jvallesm jvallesm force-pushed the jvalles/ins-3680-create-component-list-endpoint branch 3 times, most recently from 0c704fa to b0efb0f Compare February 29, 2024 12:39
@jvallesm jvallesm force-pushed the jvalles/ins-3680-create-component-list-endpoint branch from b0efb0f to 2163c27 Compare February 29, 2024 12:39
@jvallesm jvallesm marked this pull request as ready for review February 29, 2024 12:41
heiruwu pushed a commit to instill-ai/api-gateway that referenced this pull request Feb 29, 2024
Because

- instill-ai/protobufs#277 modified the
pagination in the component list endpoint
- instill-ai/pipeline-backend#396 implements the
change in the server

This commit

- Adapts the component list params to the new contract.
heiruwu pushed a commit to instill-ai/api-gateway that referenced this pull request Feb 29, 2024
Because

- instill-ai/protobufs#277 modified the
pagination in the component list endpoint
- instill-ai/pipeline-backend#396 implements the
change in the server

This commit

- Adapts the component list params to the new contract.
@donch1989 donch1989 merged commit d565a22 into main Feb 29, 2024
15 checks passed
@donch1989 donch1989 deleted the jvalles/ins-3680-create-component-list-endpoint branch February 29, 2024 14:10
donch1989 pushed a commit that referenced this pull request Feb 29, 2024
Because

- Component page is going to be implemented in the website, requiring
unified filtering and pagination.

This commit

- Implements the component list endpoint, which for now doesn't have
filtering capabilities.
- Moves the component, operator and connector list logic to the domain
layer.
- The number of params passed from the handler to the domain is reduced
(>3 params starts to get cumbersome) by using the proto request /
response params. We already use proto structs as domain types so it's
pointless to create an almost identical type.
- Integration tests are moved to `/pipeline` as there's a single API and
keeping separated directories by entity will keep increasing the `make
integration-test` command.
- Leverages the connector and operator list code to build the component
list.

## notes

⏭️ We'll insert and query the definitions into / from the database in
order to have a more sensible pagination strategy and to unlock
filtering.
⚠️ Integration tests require
instill-ai/api-gateway#139
donch1989 pushed a commit that referenced this pull request Feb 29, 2024
🤖 I have created a release *beep* *boop*
---


##
[0.23.0-beta](v0.22.0-beta...v0.23.0-beta)
(2024-02-29)


### Features

* add component definition list endpoint
([#396](#396))
([b8728c1](b8728c1))
* rename blockchain connector type to application
([#397](#397))
([80aa6a5](80aa6a5))
* support reference with `foo["bar"]` syntax
([#394](#394))
([ed82215](ed82215))
* use `mgmtPB.Owner` to embed the owner information in response
([#392](#392))
([d071461](d071461))


### Miscellaneous Chores

* release v0.23.0-beta
([4d5639b](4d5639b))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
donch1989 pushed a commit that referenced this pull request Mar 1, 2024
🤖 I have created a release *beep* *boop*
---


##
[0.23.0-beta](v0.22.0-beta...v0.23.0-beta)
(2024-03-01)


### Features

* add component definition list endpoint
([#396](#396))
([b8728c1](b8728c1))
* rename blockchain connector type to application
([#397](#397))
([80aa6a5](80aa6a5))
* support reference with `foo["bar"]` syntax
([#394](#394))
([ed82215](ed82215))
* use `mgmtPB.Owner` to embed the owner information in response
([#392](#392))
([d071461](d071461))


### Bug Fixes

* fix component ID with a hyphen cannot be referenced
([#401](#401))
([1958168](1958168))


### Miscellaneous Chores

* release v0.23.0-beta
([e3ab340](e3ab340))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants