feat(medusa): Retrieve (service + controller) a product category #3004

riqwan · 2023-01-12T07:44:59Z

What:

Introduces a store endpoint to retrieve a product category

Why:

This is part of a greater goal of allowing products to be added to multiple categories.

How:

Creates an endpoint in store routes

RESOLVES CORE-967

changeset-bot · 2023-01-12T07:45:02Z

🦋 Changeset detected

Latest commit: bd5dc41

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@medusajs/medusa	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

packages/medusa/src/api/routes/store/product-categories/get-product-category.ts

riqwan · 2023-01-12T08:50:02Z

packages/medusa/src/api/routes/store/product-categories/get-product-category.ts

+
+  const productCategory = await productCategoryService.retrieve(
+    id,
+    retrieveConfig


hmm, now that i look at this, i do need to add a { where: { is_internal: false, is_active: true } } scope to the store endpoints. How is this typically done? Do i create a new repo method that accepts the extra scope arg? Because ExtendedFindConfig is used exclusively for list endpoints. @adrien2p @pKorsholm

You can create a method in the service retrieveActiveNonInternal or something like that (can't find a good name)

sometimes what I do is the following:

create a protected retrieve method that accept selector, config

create a retrieveById that accept the actual retrieve arguments, call the protected method

create a retrieveInternalActive, call the protected method

you can look at the product service as an example

Would it make sense to add fixed filter params for store endpoint instead of a dedicated method?

E.g. in /store/products we add "published" as a fixed filter in the controllers.

I think we shouldn't create dedicated retrieve methods for what is just a filter. That does not scale super well 🤔

Wdyt?

I think creating a retrieve method that takes a selector (maybe string | selector, where string is just an id) as @adrien2p suggested is a good approach, then you could add the parameters as a where object.

In that way you get all the retrieveByEmail etc. we have elsewhere as well and can create the filter in the controller as Oli suggests 😄

adrien2p

LGTM, few minors

adrien2p · 2023-01-12T08:41:31Z

integration-tests/api/__tests__/store/product-category.ts

+    const [process, connection] = await startServerWithEnvironment({
+      cwd,
+      env: { MEDUSA_FF_PRODUCT_CATEGORIES: true },
+      verbose: true,


packages/medusa/src/api/routes/store/product-categories/get-product-category.ts

fPolic

LGTM 💪
I like the approach with transformTreeNodesWithConfig!

integration-tests/api/__tests__/store/product-category.ts

packages/medusa/src/utils/transformers/tree.ts

pKorsholm

LGTM! Just a reminder to add tests for the additional where 😄

pKorsholm · 2023-01-12T09:07:23Z

packages/medusa/src/api/routes/store/product-categories/get-product-category.ts

+
+  const productCategory = await productCategoryService.retrieve(
+    id,
+    retrieveConfig


I think creating a retrieve method that takes a selector (maybe string | selector, where string is just an id) as @adrien2p suggested is a good approach, then you could add the parameters as a where object.

In that way you get all the retrieveByEmail etc. we have elsewhere as well and can create the filter in the controller as Oli suggests 😄

packages/medusa/src/api/routes/store/product-categories/get-product-category.ts

integration-tests/api/__tests__/store/product-category.ts

packages/medusa/src/services/product-category.ts

packages/medusa/src/api/routes/store/product-categories/get-product-category.ts

adrien2p

It is missing the test on the handler and it is good to go

fPolic

LGTM!

…3023) **What:** Introduces a store endpoint to retrieve a list of product categories **Why:** This is part of a greater goal of allowing products to be added to multiple categories. **How:** - Creates an endpoint in store routes RESOLVES CORE-968

riqwan force-pushed the feat/storefront-retrieve-endpoint branch from 7c5f89d to 8718a6c Compare January 12, 2023 07:47

riqwan commented Jan 12, 2023

View reviewed changes

packages/medusa/src/api/routes/store/product-categories/get-product-category.ts Show resolved Hide resolved

riqwan force-pushed the feat/storefront-retrieve-endpoint branch 2 times, most recently from d3c54ae to e6c91bd Compare January 12, 2023 08:01

chore: added store endpoint to retrieve a product category

b6ecce9

riqwan force-pushed the feat/storefront-retrieve-endpoint branch from e6c91bd to b6ecce9 Compare January 12, 2023 08:02

riqwan marked this pull request as ready for review January 12, 2023 08:02

riqwan requested a review from a team as a code owner January 12, 2023 08:02

riqwan requested review from adrien2p, fPolic, olivermrbl and pKorsholm January 12, 2023 08:02

riqwan commented Jan 12, 2023

View reviewed changes

adrien2p approved these changes Jan 12, 2023

View reviewed changes

Merge branch 'develop' into feat/storefront-retrieve-endpoint

03a84f6

olivermrbl changed the title ~~feat(medusa): added store endpoint to retrieve a product category~~ feat(medusa): Retrieve (service + controller) a product category Jan 12, 2023

chore: remove verbose option

80cd0de

fPolic reviewed Jan 12, 2023

View reviewed changes

integration-tests/api/__tests__/store/product-category.ts Outdated Show resolved Hide resolved

packages/medusa/src/utils/transformers/tree.ts Show resolved Hide resolved

pKorsholm approved these changes Jan 12, 2023

View reviewed changes

chore: added filters to get endpoint

3f27cf9

riqwan force-pushed the feat/storefront-retrieve-endpoint branch from ade8d7f to 3f27cf9 Compare January 12, 2023 10:22

adrien2p reviewed Jan 12, 2023

View reviewed changes

packages/medusa/src/services/product-category.ts Outdated Show resolved Hide resolved

olivermrbl reviewed Jan 12, 2023

View reviewed changes

packages/medusa/src/api/routes/store/product-categories/get-product-category.ts Outdated Show resolved Hide resolved

chore: fix issues with scope names

cfa1532

adrien2p approved these changes Jan 12, 2023

View reviewed changes

fPolic approved these changes Jan 12, 2023

View reviewed changes

pKorsholm approved these changes Jan 12, 2023

View reviewed changes

riqwan added 2 commits January 12, 2023 21:24

chore: added route tests + eslint fixes

2a4e9d8

Merge branch 'develop' into feat/storefront-retrieve-endpoint

bd5dc41

riqwan added the automerge label Jan 12, 2023

kodiakhq bot merged commit b2839e2 into develop Jan 12, 2023

kodiakhq bot deleted the feat/storefront-retrieve-endpoint branch January 12, 2023 16:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(medusa): Retrieve (service + controller) a product category #3004

feat(medusa): Retrieve (service + controller) a product category #3004

riqwan commented Jan 12, 2023

changeset-bot bot commented Jan 12, 2023 •

edited

Loading

riqwan Jan 12, 2023 •

edited

Loading

adrien2p Jan 12, 2023

adrien2p Jan 12, 2023 •

edited

Loading

olivermrbl Jan 12, 2023 •

edited

Loading

olivermrbl Jan 12, 2023 •

edited

Loading

pKorsholm Jan 12, 2023

adrien2p left a comment

adrien2p Jan 12, 2023

fPolic left a comment

pKorsholm left a comment

pKorsholm Jan 12, 2023

adrien2p left a comment •

edited

Loading

fPolic left a comment

feat(medusa): Retrieve (service + controller) a product category #3004

feat(medusa): Retrieve (service + controller) a product category #3004

Conversation

riqwan commented Jan 12, 2023

changeset-bot bot commented Jan 12, 2023 • edited Loading

🦋 Changeset detected

riqwan Jan 12, 2023 • edited Loading

Choose a reason for hiding this comment

adrien2p Jan 12, 2023

Choose a reason for hiding this comment

adrien2p Jan 12, 2023 • edited Loading

Choose a reason for hiding this comment

olivermrbl Jan 12, 2023 • edited Loading

Choose a reason for hiding this comment

olivermrbl Jan 12, 2023 • edited Loading

Choose a reason for hiding this comment

pKorsholm Jan 12, 2023

Choose a reason for hiding this comment

adrien2p left a comment

Choose a reason for hiding this comment

adrien2p Jan 12, 2023

Choose a reason for hiding this comment

fPolic left a comment

Choose a reason for hiding this comment

pKorsholm left a comment

Choose a reason for hiding this comment

pKorsholm Jan 12, 2023

Choose a reason for hiding this comment

adrien2p left a comment • edited Loading

Choose a reason for hiding this comment

fPolic left a comment

Choose a reason for hiding this comment

changeset-bot bot commented Jan 12, 2023 •

edited

Loading

riqwan Jan 12, 2023 •

edited

Loading

adrien2p Jan 12, 2023 •

edited

Loading

olivermrbl Jan 12, 2023 •

edited

Loading

olivermrbl Jan 12, 2023 •

edited

Loading

adrien2p left a comment •

edited

Loading