Skip to content

Commit

Permalink
fix: respect maxDepth 0
Browse files Browse the repository at this point in the history
  • Loading branch information
DanRibbens committed Jun 22, 2021
1 parent 880dabd commit 95c1650
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/fields/relationship.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ keywords: relationship, fields, config, configuration, documentation, Content Ma
| **`name`** * | To be used as the property name when stored and retrieved from the database. |
| **`*relationTo`** * | Provide one or many collection `slug`s to be able to assign relationships to. |
| **`hasMany`** | Boolean when, if set to `true`, allows this field to have many relations instead of only one. |
| **`maxDepth`** | Sets a number limit on iterations of related documents to populate when queried. |
| **`maxDepth`** | Sets a number limit on iterations of related documents to populate when queried. [Depth](/docs/getting-started/concepts#depth) |
| **`label`** | Used as a field label in the Admin panel and to name the generated GraphQL type. |
| **`unique`** | Enforce that each entry in the Collection has a unique value for this field. |
| **`validate`** | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) |
Expand Down
2 changes: 1 addition & 1 deletion docs/fields/upload.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ keywords: upload, images media, fields, config, configuration, documentation, Co
| ---------------- | ----------- |
| **`name`** * | To be used as the property name when stored and retrieved from the database. |
| **`*relationTo`** * | Provide a single collection `slug` to allow this field to accept a relation to. <strong>Note: the related collection must be configured to support Uploads.</strong> |
| **`maxDepth`** | Sets a number limit on iterations of related documents to populate when queried. |
| **`maxDepth`** | Sets a number limit on iterations of related documents to populate when queried. [Depth](/docs/getting-started/concepts#depth) |
| **`label`** | Used as a field label in the Admin panel and to name the generated GraphQL type. |
| **`unique`** | Enforce that each entry in the Collection has a unique value for this field. |
| **`validate`** | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) |
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ For more, visit the [Access Control documentation](/docs/access-control/overview
</Banner>

You can specify population `depth` via query parameter in the REST API and by an option in the local API. *Depth has no effect in the GraphQL API, because there, depth is based on the shape of your queries.*
It is also possible to limit the depth for a specific field using the `maxDepth` property in your configuration.
It is also possible to limit the depth for specific `relation` and `upload` fields using the `maxDepth` property in your configuration.
**For example, let's look the following Collections:** `departments`, `users`, `posts`

```
Expand Down
2 changes: 1 addition & 1 deletion src/fields/accessPromise.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ const accessPromise = async ({
relationshipPopulations.push(relationshipPopulationPromise({
data,
field,
depth: field.maxDepth || depth,
depth,
currentDepth,
req,
overrideAccess,
Expand Down
8 changes: 8 additions & 0 deletions src/fields/config/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,10 @@ export type FieldWithMany =
SelectField
| RelationshipField

export type FieldWithMaxDepth =
UploadField
| RelationshipField

export function fieldHasSubFields(field: Field): field is FieldWithSubFields {
return (field.type === 'group' || field.type === 'array' || field.type === 'row');
}
Expand Down Expand Up @@ -289,4 +293,8 @@ export function fieldSupportsMany(field: Field): field is FieldWithMany {
return field.type === 'select' || field.type === 'relationship';
}

export function fieldHasMaxDepth(field: Field): field is FieldWithMaxDepth {
return (field.type === 'upload' || field.type === 'relationship') && typeof field.maxDepth === 'number';
}

export type HookName = 'beforeChange' | 'beforeValidate' | 'afterChange' | 'afterRead';
7 changes: 4 additions & 3 deletions src/fields/relationshipPopulationPromise.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { PayloadRequest } from '../express/types';
import executeAccess from '../auth/executeAccess';
import { Field, RelationshipField, fieldSupportsMany } from './config/types';
import { Field, RelationshipField, fieldSupportsMany, fieldHasMaxDepth } from './config/types';
import { Payload } from '..';

type PopulateArgs = {
Expand Down Expand Up @@ -95,6 +95,7 @@ const relationshipPopulationPromise = ({
payload,
}: PromiseArgs) => async (): Promise<void> => {
const resultingData = data;
const populateDepth = fieldHasMaxDepth(field) && field.maxDepth < depth ? field.maxDepth : depth;

if (fieldSupportsMany(field) && field.hasMany && Array.isArray(data[field.name])) {
const rowPromises = [];
Expand All @@ -103,7 +104,7 @@ const relationshipPopulationPromise = ({
const rowPromise = async () => {
if (relatedDoc) {
await populate({
depth,
depth: populateDepth,
currentDepth,
req,
overrideAccess,
Expand All @@ -122,7 +123,7 @@ const relationshipPopulationPromise = ({
await Promise.all(rowPromises);
} else if (data[field.name]) {
await populate({
depth,
depth: populateDepth,
currentDepth,
req,
overrideAccess,
Expand Down

0 comments on commit 95c1650

Please sign in to comment.