Creating an `IndexStore` for Quick Navigation by hqhhuang · Pull Request #889 · swiftlang/swift-docc-render

hqhhuang · 2024-08-19T18:05:44Z

Bug/issue #, if applicable: rdar://134272215

Summary

This PR creates a new IndexStore. The eventual goal is to share this store between the navigator and Quick Navigation.
But for this PR, only Quick Navigation will be getting data from the new store.
Additionally, the index data is fetched from the page view instead.
Moves IncludedArchiveIdentifiers data from AppStore to the new IndexStore.

Testing

Manual testing, verify that Quick Nav still behaves as expected.
I've added some tests. I'm working on adding more.

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

Added tests
Ran npm test, and it succeeded
Updated documentation if necessary

Create `IndexStore`

fetch index data in `view/DocumentationTopic`

Get Quick Nav data from `IndexStore`

update items in `indexStore`

add `technologyUrl` prop

fix issues with accessing null items

move data fetching logic to `indexProvider.js`

add `errorFetching` to store

simplify index data path computation logic

add technology prop to store

add tests for `indexProvider`

hqhhuang · 2024-08-23T21:49:07Z

@swift-ci test

marinaaisa · 2024-08-26T13:48:24Z

I've been checking the code and testing Quick Navigation and it's looking good to me!

The only thing that I don't like in this current state is that we are duplicating the NavigatorDataProvider computed properties into the indexProvider but I don't see any other way of not doing it until we get rid of the NavigatorDataProvider in the next step.

src/mixins/indexProvider.js

resets store before fetching new indexData

src/components/DocumentationLayout.vue

src/components/DocumentationTopic.vue

src/components/Navigator/NavigatorDataProvider.vue

src/mixins/indexProvider.js

src/views/DocumentationTopic.vue

do not set `includedArchiveIdentifiers` in Navigator Provider

rename state to `indexState`

simplify logic to find technology index data

remove url related computed properties

move fetching logic to `view/DocumentationTopic`

display index data for correct language variant

save flattened data for all language variants to store

…nto index-store

…render into index-store" This reverts commit 3dfcb67, reversing changes made to cbb7f50.

update flatChildren default format

make sure data defaults to swift variant & add tests

mportiz08

This seems cleaner to me overall as a first step of moving this data to a shareable store. 👍

Thanks for working through all these complex layers!

src/components/DocumentationLayout.vue

rename and clean up node logic

tests/unit/mixins/__snapshots__/indexProvider.spec.js.snap

tests/unit/mixins/indexProvider.spec.js

tests/unit/stores/IndexStore.spec.js

Improve tests and test description

marinaaisa · 2024-09-13T18:15:35Z

tests/unit/components/DocumentationLayout.spec.js

+    expect(wrapper.find(QuickNavigationModal).props('children')).toEqual(swiftChildren);
+  });
+
+  it('QuickNavigation falls back to swift items, if no objc items', async () => {


Why do we fallback to swift items? just curious about this

See this issue, DocC defaults to swift when the archive is article only. If this issue is addressed, we can make the update here as well.

marinaaisa

Reviewed and tested. LGTM! thanks for working on this!

hqhhuang added 7 commits August 12, 2024 16:10

Create IndexStore

d2bd931

Create `IndexStore`

fetch index data in view/DocumentationTopic

6fce256

fetch index data in `view/DocumentationTopic`

Get Quick Nav data from IndexStore

642f741

Get Quick Nav data from `IndexStore`

update items in indexStore

c9899cb

update items in `indexStore`

add technologyUrl prop

00131f7

add `technologyUrl` prop

fix issues with accessing null items

73db182

fix issues with accessing null items

move data fetching logic to indexProvider.js

328591c

move data fetching logic to `indexProvider.js`

hqhhuang requested review from marinaaisa and mportiz08 August 19, 2024 18:05

hqhhuang and others added 5 commits August 19, 2024 11:38

add errorFetching to store

0addf8a

add `errorFetching` to store

simplify index data path computation logic

235fd8e

simplify index data path computation logic

add technology prop to store

caeb397

add technology prop to store

add tests for indexProvider

cf0ba56

add tests for `indexProvider`

Merge branch 'main' into index-store

5e2815a

hqhhuang marked this pull request as ready for review August 23, 2024 21:51

marinaaisa reviewed Aug 26, 2024

View reviewed changes

src/mixins/indexProvider.js Outdated Show resolved Hide resolved

resets store before fetching new indexData

6491aa9

resets store before fetching new indexData

hqhhuang changed the title ~~[WIP] Creating an IndexStore for Quick Navigation~~ Creating an IndexStore for Quick Navigation Aug 29, 2024

mportiz08 reviewed Sep 3, 2024

View reviewed changes

hqhhuang changed the base branch from main to navigator-index-store September 3, 2024 23:00

hqhhuang added 8 commits September 3, 2024 16:13

do not set includedArchiveIdentifiers in Navigator Provider

9942643

do not set `includedArchiveIdentifiers` in Navigator Provider

rename state to indexState

9f7fc45

rename state to `indexState`

simplify logic to find technology index data

801593a

simplify logic to find technology index data

remove url related computed properties

a1fd338

remove url related computed properties

move fetching logic to view/DocumentationTopic

1b8ee36

move fetching logic to `view/DocumentationTopic`

display index data for correct language variant

835ad6b

display index data for correct language variant

save flattened data for all language variants to store

cbb7f50

save flattened data for all language variants to store

Merge branch 'index-store' of github.com:hqhhuang/swift-docc-render i…

3dfcb67

…nto index-store

Revert "Merge branch 'index-store' of github.com:hqhhuang/swift-docc-…

6fa85b6

…render into index-store" This reverts commit 3dfcb67, reversing changes made to cbb7f50.

hqhhuang requested review from marinaaisa and mportiz08 September 9, 2024 22:01

hqhhuang added 2 commits September 9, 2024 15:27

update flatChildren default format

0e92cc1

update flatChildren default format

make sure data defaults to swift variant & add tests

b8cec41

make sure data defaults to swift variant & add tests

mportiz08 reviewed Sep 10, 2024

View reviewed changes

src/components/DocumentationLayout.vue Outdated Show resolved Hide resolved

src/components/DocumentationLayout.vue Outdated Show resolved Hide resolved

rename and clean up node logic

24519c6

rename and clean up node logic

hqhhuang requested a review from mportiz08 September 11, 2024 21:05

mportiz08 approved these changes Sep 11, 2024

View reviewed changes

Merge branch 'main' into index-store

8aa6337

hqhhuang changed the base branch from navigator-index-store to main September 11, 2024 22:48

Improve tests and test description

5026c9e

Improve tests and test description

hqhhuang changed the base branch from main to navigator-index-store September 11, 2024 23:00

marinaaisa reviewed Sep 13, 2024

View reviewed changes

marinaaisa approved these changes Sep 13, 2024

View reviewed changes

hqhhuang merged commit e787f8b into swiftlang:navigator-index-store Sep 16, 2024

hqhhuang deleted the index-store branch September 16, 2024 16:59

This was referenced Sep 17, 2024

Switch Navigator data source to IndexStore #893

Closed

Navigator gets data from IndexStore #896

Merged

hqhhuang mentioned this pull request Oct 18, 2024

Navigator related changes to allow further customization #904

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Creating an `IndexStore` for Quick Navigation#889

Creating an `IndexStore` for Quick Navigation#889
hqhhuang merged 27 commits intoswiftlang:navigator-index-storefrom
hqhhuang:index-store

hqhhuang commented Aug 19, 2024

Uh oh!

hqhhuang commented Aug 23, 2024

Uh oh!

marinaaisa commented Aug 26, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mportiz08 left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

marinaaisa Sep 13, 2024

Uh oh!

hqhhuang Sep 16, 2024 •

edited

Loading

Uh oh!

marinaaisa left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

hqhhuang commented Aug 19, 2024

Summary

Testing

Checklist

Uh oh!

hqhhuang commented Aug 23, 2024

Uh oh!

marinaaisa commented Aug 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mportiz08 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

marinaaisa Sep 13, 2024

Choose a reason for hiding this comment

Uh oh!

hqhhuang Sep 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

marinaaisa left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

marinaaisa commented Aug 26, 2024 •

edited

Loading

hqhhuang Sep 16, 2024 •

edited

Loading