fix(plugin-import-export): json preview and downloads preserve nesting and exclude disabled fields #13210
+414
−81
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…eview-nested-fields
…-flag-nested-fields
…-flag-nested-fields
…s/payload into fix/disabled-nested-with-json-preview
…abling to subfields
…d-nested-with-json-preview
📦 esbuild Bundle Analysis for payloadThis analysis was generated by esbuild-bundle-analyzer. 🤖
Largest pathsThese visualization shows top 20 largest paths in the bundle.Meta file: packages/next/meta_index.json, Out file: esbuild/index.js
Meta file: packages/payload/meta_index.json, Out file: esbuild/index.js
Meta file: packages/payload/meta_shared.json, Out file: esbuild/exports/shared.js
Meta file: packages/richtext-lexical/meta_client.json, Out file: esbuild/exports/client_optimized/index.js
Meta file: packages/ui/meta_client.json, Out file: esbuild/exports/client_optimized/index.js
Meta file: packages/ui/meta_shared.json, Out file: esbuild/exports/shared_optimized/index.js
DetailsNext to the size is how much the size has increased or decreased compared with the base branch of this PR.
|
PatrikKozak
changed the title
DanRibbens
reviewed
Jul 22, 2025
DanRibbens
requested changes
Jul 22, 2025
…d-nested-with-json-preview
DanRibbens
requested changes
Jul 22, 2025
There was a problem hiding this comment.
You should be able to write an assertion of the downloaded data. Here is an example from gippity:
describe('GET /api/download', () => {
it('should download a JSON file with correct data', async () => {
const res = await request(app)
.get('/api/download')
.expect(200)
.expect('Content-Type', /application\/json|octet-stream/)
// Optional: assert it's served as a downloadable file
expect(res.headers['content-disposition']).toMatch(/attachment; filename=.*\.json/)
// Parse the file content as JSON
const data = JSON.parse(res.text)
// Write assertions on the JSON structure
expect(data).toHaveProperty('items')
expect(Array.isArray(data.items)).toBe(true)
expect(data.items[0]).toMatchObject({ id: expect.any(Number), name: expect.any(String) })
})
})
DanRibbens
reviewed
Jul 24, 2025
|
|
||
| expect(Array.isArray(data)).toBe(true) | ||
| expect(['string', 'number']).toContain(typeof data[0].id) | ||
| expect(typeof data[0].title).toBe('string') |
There was a problem hiding this comment.
We should include a nested field as another assertion to make sure the json structure isn't being flattened.
DanRibbens
approved these changes
Jul 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Improves both the JSON preview and export functionality in the import-export plugin:
disabledviacustom.plugin-import-exportformatisjson(no CSV-style flattening)Why?
Previously:
format: jsonwere still CSV-style data encoded as.json, rather than real JSON.How?
/preview-dataJSON handling to preserve original document shape.removeDisabledFieldsto clean nested fields using dot-notation paths.createExportto skipflattenObjectfor JSON formats, using a nested JSON filter instead.formatisjson.