Generate mock data lazily and improve API #1537
Merged
Conversation
This file contains 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
d56fba6 to
7d128b3
Compare
axelboc
commented
Jan 5, 2024
76b3e9a to
318f52b
Compare
axelboc
commented
Jan 8, 2024
|
/approve |
loichuder
approved these changes
Jan 8, 2024
apps/storybook/src/Utilities.mdx
Outdated
Comment on lines
418
to
425
| The library also exposes the `makeMockFile` utility function that is used by the [mock demo](https://h5web.panosc.eu/mock) to generate mock metadata and values. | ||
| You can retrieve entities from the generated mock file by their paths using the `findMockEntity` utility function: | ||
|
|
||
| ```ts | ||
| import { findMockEntity, getMockDataArray } from '@h5web/lib'; | ||
| import { findMockEntity, makeMockFile } from '@h5web/lib'; | ||
|
|
||
| const entity = findMockEntity('/nD_datasets/twoD'); | ||
| const dataArray = getMockDataArray('/nD_datasets/twoD'); | ||
| const mockFile = makeMockFile(); | ||
| const entity = findMockEntity(mockFile, '/nD_datasets/twoD'); |
There was a problem hiding this comment.
Yeah, not sure it is actually relevant to document this.
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.
I realised that the
mockValuesandmockMetadataobjects were not properly tree-shaken in consumer applications of@h5web/libor@h5web/app(at least with ones using Vite as their bundler). As a result, those two giant data structures were being created on every page load of myHDF5, just to name one.Tree-shaking works better (only?) with functions, so the idea is to turn
mockValuesandmockMetadatainto functions. This has benefits even in projects that do need these two structures (e.g. in the demo project), since it means that we can generate them lazily, when they are actually needed (e.g. when navigating to the mock demo).I had tried to generate the mock metadata and values lazily before, but never really got to a point that I found satisfactory. The API to access or generate entities and arrays that we use in our Jest test suites and in the Storybook was always quite convoluted.
This time, I had the idea of generating ndarrays instead of plain, nested JS arrays in
mockValues, which unlocked a lot of things, thanks to the simple fact that ndarrays store the shape of their underlying arrays. For instance, this means that we:[20, 41]...) when we generate the mock metadata;Additionally, since the internal array inside an ndarray is already flattened, we no longer need to deal with this in
MockApi.The PR is huge particularly because I took the opportunity to clean the metadata a bit and to shorten the metadata utility functions to make the whole thing a bit more readable.