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.

Sign up for GitHub

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: genIndex error for search #1933

Merged
merged 10 commits into from
Jan 3, 2023
Merged

fix: genIndex error for search #1933

Changes from 5 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
306d606
fix search.js
wangliang181230 Jul 23, 2022
30fa174
fix 404
wangliang181230 Dec 6, 2022
86d3c5f
Merge remote-tracking branch 'origin/develop' into patch-1
wangliang181230 Dec 6, 2022
7b974ef
When manually delete docsify.search.index and keep docsify.search.exp…
wangliang181230 Dec 6, 2022
fa12461
optimize fix 404
wangliang181230 Dec 6, 2022
558a8d1
Merge branch 'develop' into bugfix-1
wangliang181230 Dec 13, 2022
70e921b
Merge branch 'develop' into bugfix-1
wangliang181230 Dec 16, 2022
95bfa6d
Merge remote-tracking branch 'upstream/develop' into bugfix-1
wangliang181230 Jan 3, 2023
b1df79d
revert
wangliang181230 Jan 3, 2023
f41ee5a
revert fix 404
wangliang181230 Jan 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions src/plugins/search/search.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,20 @@ export function genIndex(path, content = '', router, depth) {
slug = router.toURL(path, { id: slugify(escapeHtml(text)) });
}

// fix 404
let pathname = location.pathname;
let flag = false;
while (slug.startsWith('#/../') && pathname.lastIndexOf('/') > 1) {
flag = true;
if (pathname.endsWith('/')) {
pathname = pathname.substring(0, pathname.length - 1);
}
pathname = pathname.substring(0, pathname.lastIndexOf('/'));

slug = '#/' + slug.substring(5);
}
slug = pathname + (flag ? '/' : '') + slug;

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does those changes for ? could you plz give a sample and add verify test cases.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When my website has multiple paths, it can prevent 404 error.
For example:
http://xxxxxx/A/
http://xxxxxx/B/
When searching on page A and accessing page B, 404 will appear.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When my website has multiple paths, it can prevent 404 error. For example: http://xxxxxx/A/ http://xxxxxx/B/ When searching on page A and accessing page B, 404 will appear.

I see, maybe u can take a look on this namespace configs here.

Copy link
Contributor Author

@wangliang181230 wangliang181230 Dec 19, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see, maybe u can take a look on this namespace configs here.

Should I configure it like this?

{
    search: [
        '/A',
        '/B'
    ]
}

or

{
    search: {
        paths: [
            '/A',
            '/B'
        ]
    }
}

Copy link
Member

@Koooooo-7 Koooooo-7 Jan 3, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess you need distinguish those namespace for different paths (sites), may could refer to our site with multi langs nav . if you deploy multi sites in same domain, the namespace config should be in each site's index.html search config.

      // Use different indexes for path prefixes (namespaces).
      // NOTE: Only works in 'auto' mode.
      //
      // When initialiazing an index, we look for the first path from the sidebar.
      // If it matches the prefix from the list, we switch to the corresponding index.
      pathNamespaces: ['/zh-cn', '/ru-ru', '/ru-ru/v1'],

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I will try it.

if (str) {
title = removeDocsifyIgnoreTag(str);
}
Expand Down Expand Up @@ -128,9 +142,7 @@ export function genIndex(path, content = '', router, depth) {
token.text = getTableData(token);
token.text = getListData(token);

index[slug].body = index[slug].body
? index[slug].body + token.text
: token.text;
Copy link
Contributor Author

@wangliang181230 wangliang181230 Dec 6, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

index[slug].body is always undefined, see the line 122

120  if (!index[slug]) {
121    index[slug] = { slug, title: '', body: '' };
122  } else if (index[slug].body) {
       ......
127  } else {
       ...... //index[slug].body is always undefined
     }

Copy link
Contributor Author

@wangliang181230 wangliang181230 Dec 14, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When the token.text is undefined, it will make the index[slug].body also undefined.
So I change the token.text to token.text || ''.

Copy link
Contributor Author

@wangliang181230 wangliang181230 Dec 14, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code index[slug].body ? index[slug].body + token.text : is redundant, and it is not the cause of the bug.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice point.

index[slug].body = token.text || '';
}
}
});
Expand Down Expand Up @@ -277,9 +289,9 @@ export function init(config, vm) {

const isExpired = localStorage.getItem(expireKey) < Date.now();

INDEXS = JSON.parse(localStorage.getItem(indexKey));
INDEXS = isExpired ? null : JSON.parse(localStorage.getItem(indexKey));

if (isExpired) {
if (!INDEXS) {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When manually delete docsify.search.index and keep docsify.search.expires, this plugin can still operate normally

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The user should know what he does when he gonna manually delete index.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to reduce a manual operation step during the test, haha.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to reduce a manual operation step during the test, haha.

If user wanna break it, he should break it.

Copy link
Contributor Author

@wangliang181230 wangliang181230 Dec 19, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then this change is not necessary, is it?
If not, I'll revert this code.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then this change is not necessary, is it? If not, I'll revert this code.

yep. personally, I think we do not need handle this case.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

INDEXS = {};
} else if (!isAuto) {
return;
Expand Down