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

fix: fixes schema extraction with nested union refs #8096

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

rneatherway
Copy link
Contributor

This was seen in a schema produced by automated tooling. The recursion
guard was too strict in this case as the two occurrences of a
reference ending up having the same guard path name and extraction
would therefore abort before looking inside the second one, instead
returning {} which would fail when attempting to inspect the name
field a little lower down.

Copy link

vercel bot commented Dec 18, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
page-building-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 19, 2024 11:37am
performance-studio ✅ Ready (Inspect) Visit Preview Dec 19, 2024 11:37am
test-next-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 19, 2024 11:37am
test-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 19, 2024 11:37am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
studio-workshop ⬜️ Ignored (Inspect) Visit Preview Dec 19, 2024 11:37am

Copy link
Contributor

No changes to documentation

Copy link
Contributor

github-actions bot commented Dec 18, 2024

Component Testing Report Updated Dec 19, 2024 11:24 AM (UTC)

✅ All Tests Passed -- expand for details
File Status Duration Passed Skipped Failed
comments/CommentInput.spec.tsx ✅ Passed (Inspect) 1m 4s 15 0 0
formBuilder/ArrayInput.spec.tsx ✅ Passed (Inspect) 12s 3 0 0
formBuilder/inputs/PortableText/Annotations.spec.tsx ✅ Passed (Inspect) 38s 6 0 0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx ✅ Passed (Inspect) 51s 11 7 0
formBuilder/inputs/PortableText/copyPaste/CopyPasteFields.spec.tsx ✅ Passed (Inspect) 0s 0 12 0
formBuilder/inputs/PortableText/Decorators.spec.tsx ✅ Passed (Inspect) 26s 6 0 0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx ✅ Passed (Inspect) 14s 3 0 0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx ✅ Passed (Inspect) 26s 6 0 0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx ✅ Passed (Inspect) 1m 6s 15 0 0
formBuilder/inputs/PortableText/Input.spec.tsx ✅ Passed (Inspect) 1m 27s 21 0 0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx ✅ Passed (Inspect) 1m 39s 18 0 0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx ✅ Passed (Inspect) 13s 3 9 0
formBuilder/inputs/PortableText/Styles.spec.tsx ✅ Passed (Inspect) 26s 6 0 0
formBuilder/inputs/PortableText/Toolbar.spec.tsx ✅ Passed (Inspect) 1m 43s 21 0 0
formBuilder/tree-editing/TreeEditing.spec.tsx ✅ Passed (Inspect) 0s 0 3 0
formBuilder/tree-editing/TreeEditingNestedObjects.spec.tsx ✅ Passed (Inspect) 0s 0 3 0

Copy link
Contributor

github-actions bot commented Dec 18, 2024

⚡️ Editor Performance Report

Updated Thu, 19 Dec 2024 11:26:16 GMT

Benchmark reference
latency of sanity@latest
experiment
latency of this branch
Δ (%)
latency difference
article (title) 27.4 efps (37ms) 26.3 efps (38ms) +2ms (+4.1%)
article (body) 67.8 efps (15ms) 73.0 efps (14ms) -1ms (-/-%)
article (string inside object) 27.0 efps (37ms) 27.8 efps (36ms) -1ms (-2.7%)
article (string inside array) 24.4 efps (41ms) 25.6 efps (39ms) -2ms (-4.9%)
recipe (name) 55.6 efps (18ms) 62.5 efps (16ms) -2ms (-11.1%)
recipe (description) 62.5 efps (16ms) 71.4 efps (14ms) -2ms (-12.5%)
recipe (instructions) 99.9+ efps (5ms) 99.9+ efps (5ms) +0ms (-/-%)
synthetic (title) 19.2 efps (52ms) 18.9 efps (53ms) +1ms (+1.9%)
synthetic (string inside object) 19.6 efps (51ms) 19.2 efps (52ms) +1ms (+2.0%)

efps — editor "frames per second". The number of updates assumed to be possible within a second.

Derived from input latency. efps = 1000 / input_latency

Detailed information

🏠 Reference result

The performance result of sanity@latest

Benchmark latency p75 p90 p99 blocking time test duration
article (title) 37ms 40ms 55ms 209ms 157ms 11.0s
article (body) 15ms 17ms 21ms 106ms 89ms 4.9s
article (string inside object) 37ms 39ms 54ms 212ms 235ms 7.0s
article (string inside array) 41ms 43ms 50ms 167ms 135ms 7.0s
recipe (name) 18ms 20ms 23ms 38ms 0ms 7.0s
recipe (description) 16ms 18ms 20ms 34ms 0ms 4.3s
recipe (instructions) 5ms 7ms 8ms 9ms 0ms 3.0s
synthetic (title) 52ms 54ms 58ms 313ms 579ms 13.8s
synthetic (string inside object) 51ms 56ms 100ms 164ms 870ms 8.5s

🧪 Experiment result

The performance result of this branch

Benchmark latency p75 p90 p99 blocking time test duration
article (title) 38ms 43ms 57ms 575ms 861ms 11.3s
article (body) 14ms 15ms 19ms 31ms 185ms 4.7s
article (string inside object) 36ms 39ms 44ms 167ms 136ms 6.5s
article (string inside array) 39ms 40ms 43ms 88ms 138ms 6.7s
recipe (name) 16ms 19ms 23ms 40ms 0ms 6.7s
recipe (description) 14ms 15ms 17ms 24ms 0ms 4.1s
recipe (instructions) 5ms 6ms 7ms 10ms 0ms 3.0s
synthetic (title) 53ms 57ms 64ms 104ms 330ms 12.8s
synthetic (string inside object) 52ms 57ms 66ms 316ms 529ms 8.0s

📚 Glossary

column definitions

  • benchmark — the name of the test, e.g. "article", followed by the label of the field being measured, e.g. "(title)".
  • latency — the time between when a key was pressed and when it was rendered. derived from a set of samples. the median (p50) is shown to show the most common latency.
  • p75 — the 75th percentile of the input latency in the test run. 75% of the sampled inputs in this benchmark were processed faster than this value. this provides insight into the upper range of typical performance.
  • p90 — the 90th percentile of the input latency in the test run. 90% of the sampled inputs were faster than this. this metric helps identify slower interactions that occurred less frequently during the benchmark.
  • p99 — the 99th percentile of the input latency in the test run. only 1% of sampled inputs were slower than this. this represents the worst-case scenarios encountered during the benchmark, useful for identifying potential performance outliers.
  • blocking time — the total time during which the main thread was blocked, preventing user input and UI updates. this metric helps identify performance bottlenecks that may cause the interface to feel unresponsive.
  • test duration — how long the test run took to complete.

This was seen in a schema produced by automated tooling. The recursion
guard was too strict in this case as the two occurrences of a
reference ending up having the same guard path name and extraction
would therefore abort before looking inside the second one, instead
returning `{}` which would fail when attempting to inspect the name
field a little lower down.
@rneatherway
Copy link
Contributor Author

I tried updating the snapshots using pnpm test -- -u but I get a lot of errors e.g.

 FAIL  src/core/studio/components/navbar/search/contexts/search/reducer.test.ts > searchReducer > should not merge results after fetching an additional page when not using `textSearch` strategy
TypeError: Cannot read properties of undefined (reading 'match')
 ❯ src/core/studio/components/navbar/search/contexts/search/reducer.test.ts:294:31
    292|     const [state] = result.current
    293|
    294|     expect(state.result.hits).toMatchInlineSnapshot(`
       |                               ^
    295|       [
    296|         {

I checked and that's the same on next for me. Any advice?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant