feat(vue-app): add prefetch prop to <nuxt-link>

[lmichelin]

Type of changes

• Bug fix (a non-breaking change which fixes an issue)
• New feature (a non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Description

Fixes #6135

<nuxt-link> currently allows disabling prefetching with a specific link using a no-prefetch prop, but on the other hand, there is no way to prefetch a specific link when links prefetching is disabled globally via nuxt.config.js with prefetchLinks: false.

This PR adds a prefetch prop to <nuxt-link> which can be used when prefetchLinks is set to false.

Checklist:

• My change requires a change to the documentation.
• I have updated the documentation accordingly. (PR: docs(en): Add prefetch prop to <nuxt-link> docs#1550)
• I have added tests to cover my changes (if not applicable, please state why)
• All new and existing tests are passing.

[codecov-io]

Codecov Report

Merging #6292 into dev will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff          @@
##             dev   #6292   +/-   ##
=====================================
  Coverage   95.6%   95.6%           
=====================================
  Files         79      79           
  Lines       2684    2684           
  Branches     692     692           
=====================================
  Hits        2566    2566           
  Misses       101     101           
  Partials      17      17

Flag	Coverage Δ
#e2e	100% <ø> (ø)	⬆️
#fixtures	50.7% <ø> (ø)	⬆️
#unit	92.28% <ø> (ø)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ac5066c...b65b4ca. Read the comment docs.

[pimlie]

My apologies to have to do this, but I have just added a compileTemplate test helper method I would like you to ask to use to add unit tests (using vue-test-utils) instead of adding new fixtures. Adding new fixtures is not preferred as building each fixtures takes at least 10 seconds to the total test time.

You can have a look at nuxt-loading.test.js for an example of an existing component unit test.

For this pr you could use the compileTemplate function as follows:

// nuxt-link.client.prefetch.test.js
const compiledTemplatePath = await compileTemplate('components/nuxt-link.client.vue', 'nuxt-link.client.prefetch.vue', { router: { prefetch: true } })

// nuxt-link.client.noprefetch.test.js
const compiledTemplatePath = await compileTemplate('components/nuxt-link.client.vue', 'nuxt-link.client.noprefetch.vue', { router: { prefetch: false } })

For quick reference, here is the link to the vtu docs

[atinux]

What about prefetchLinks: “on-demand”?

[lmichelin]

What about prefetchLinks: “on-demand”?

Maybe the best option is to wait for the PR #6287 to be merged?

[pimlie]

Looks good to me.

Thanks for the recurring work you put into this pr!

[lmichelin]

My apologies to have to do this, but I have just added a compileTemplate test helper method I would like you to ask to use to add unit tests (using vue-test-utils) instead of adding new fixtures. Adding new fixtures is not preferred as building each fixtures takes at least 10 seconds to the total test time.

You can have a look at nuxt-loading.test.js for an example of an existing component unit test.

For this pr you could use the compileTemplate function as follows:

// nuxt-link.client.prefetch.test.js
const compiledTemplatePath = await compileTemplate('components/nuxt-link.client.vue', 'nuxt-link.client.prefetch.vue', { router: { prefetch: true } })

// nuxt-link.client.noprefetch.test.js
const compiledTemplatePath = await compileTemplate('components/nuxt-link.client.vue', 'nuxt-link.client.noprefetch.vue', { router: { prefetch: false } })

For quick reference, here is the link to the vtu docs

I tried to do some tests but I faced some issues mounting the <nuxt-link> component with vue-test-utils:

I think it's because nuxt-link extends routerLink but I didn't find a way to stub this component. 😕

So there is no test in this PR at the moment... 😕

[pimlie]

Its probably because extends: Vue.component('RouterLink') fails. Did you add a stub or fake router-link component? See: https://vue-test-utils.vuejs.org/api/components/#routerlinkstub

[lmichelin]

I tried but it has no effect 😕

[pimlie]

What about something like this?

import { createLocalVue } from '@vue/test-utils'

const localVue = createLocalVue()
// register stub component so nuxt-link extends its render fn
localVue.component('RouterLink', {
  render: h => h('a')
})
// load nuxt-link

[pi0]

LGTM

[lmichelin]

What about something like this?

import { createLocalVue } from '@vue/test-utils'

const localVue = createLocalVue()
// register stub component so nuxt-link extends its render fn
localVue.component('RouterLink', {
  render: h => h('a')
})
// load nuxt-link

Still face the issue 😕, I made a WIP commit to show you the code :) (I also needed to fix a bug in the compileTemplate helper)

[pimlie]

Hmm, could you try to explicitly set the router-link component as a stub in the mounting options as described here?

[lmichelin]

Still facing the warning 😕
I tried : stubs: ['router-link'], stubs: ['RouterLink'], stubs: { 'router-link': true }

[pimlie]

@lmichelin Hope you dont mind, but as I didnt knew the correct answer myself I just tried fixing this on your branch. The tests should work now.

Feel free to improve them further if you wish!

[lmichelin]

Nice! Thanks a lot for your help 😃

[lmichelin]

And btw do you agree with the fix in compileTemplate: 374363a ? I needed to do this to avoid file overwriting during tests 😉

[pimlie]

Yes, a bit sily to have destination as fn arg but not use it. Thanks for the fix ;)

I have added one more test condition btw, thought it was a bit disconcerting that VTU only logged an error but didnt seem to return/throw any error about the failed mount. So have added some spies on the console to make sure no errors or warnings are logged.

@lmichelin Let us know btw if you think this PR is now ready or if you wish to make some other changes, thanks :)

[lmichelin]

Do you want me to clean the commit history to squash some commits and remove WIP in messages?

[pimlie]

@lmichelin Thanks but dont think that is necessary. The pr will be squashed when merged already so those commits wont show up on the dev branch anyway.

[atinux]

Great work here @lmichelin 👏

One thing came to my mind when I read prefetch and no-prefetch props, what about deprecating no-prefetch in favour of :prefetch="false"?

[lmichelin]

I asked the question here #6292 (comment) but @pi0 preferred not to deprecate it.

[lmichelin]

@lmichelin Let us know btw if you think this PR is now ready or if you wish to make some other changes, thanks :)

It's ok for me!