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

Jump to bottom

fix(module): put query parameters removal under an experimental flag #1757

Merged
merged 2 commits into from
Dec 15, 2022
Merged

fix(module): put query parameters removal under an experimental flag #1757

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9a3c589
fix(module): put query parameters removal under an experimental flag
farnabaz Dec 15, 2022
9fbdbd9
chore: change flag name
farnabaz Dec 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 9 additions & 10 deletions src/module.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,7 @@ export interface ModuleOptions {
},
experimental: {
clientDB: boolean
stripQueryParameters: boolean
}
}

Expand Down Expand Up @@ -274,13 +275,13 @@ export default defineNuxtModule<ModuleOptions>({
},
documentDriven: false,
experimental: {
clientDB: false
clientDB: false,
stripQueryParameters: false
}
},
async setup (options, nuxt) {
const { resolve } = createResolver(import.meta.url)
const resolveRuntimeModule = (path: string) => resolveModule(path, { paths: resolve('./runtime') })

// Ensure default locale alway is the first item of locales
options.locales = Array.from(new Set([options.defaultLocale, ...options.locales].filter(Boolean))) as string[]

Expand Down Expand Up @@ -581,8 +582,9 @@ export default defineNuxtModule<ModuleOptions>({
locales: options.locales,
defaultLocale: contentContext.defaultLocale,
integrity: buildIntegrity,
clientDB: {
isSPA: options.experimental.clientDB && nuxt.options.ssr === false
experimental: {
stripQueryParameters: options.experimental.stripQueryParameters,
clientDB: options.experimental.clientDB && nuxt.options.ssr === false
},
api: {
baseURL: options.api.baseURL
Expand Down Expand Up @@ -687,12 +689,9 @@ export default defineNuxtModule<ModuleOptions>({
})

interface ModulePublicRuntimeConfig {
/**
* @experimental
*/
clientDB: {
isSPA: boolean
integrity: number
experimental: {
stripQueryParameters: boolean
clientDB: boolean
}

defaultLocale: ModuleOptions['defaultLocale']
Expand Down
16 changes: 14 additions & 2 deletions src/runtime/composables/navigation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { hash } from 'ohash'
import { useRuntimeConfig } from '#app'
import type { NavItem, QueryBuilder, QueryBuilderParams } from '../types'
import { encodeQueryParams } from '../utils/query'
import { jsonStringify } from '../utils/json'
import { addPrerenderPath, shouldUseClientDB, withContentBase } from './utils'

export const fetchContentNavigation = async (queryBuilder?: QueryBuilder | QueryBuilderParams): Promise<Array<NavItem>> => {
Expand All @@ -21,7 +22,9 @@ export const fetchContentNavigation = async (queryBuilder?: QueryBuilder | Query
}
}

const apiPath = withContentBase(`/navigation/${process.dev ? '_' : `${hash(params)}.${content.integrity}`}/${encodeQueryParams(params)}.json`)
const apiPath = content.experimental.stripQueryParameters
? withContentBase(`/navigation/${process.dev ? '_' : `${hash(params)}.${content.integrity}`}/${encodeQueryParams(params)}.json`)
: withContentBase(process.dev ? `/navigation/${hash(params)}` : `/navigation/${hash(params)}.${content.integrity}.json`)

// Add `prefetch` to `<head>` in production
if (!process.dev && process.server) {
Expand All @@ -33,7 +36,16 @@ export const fetchContentNavigation = async (queryBuilder?: QueryBuilder | Query
return generateNavigation(params)
}

const data = await $fetch<NavItem[]>(apiPath, { method: 'GET', responseType: 'json' })
const data = await $fetch<NavItem[]>(apiPath as any, {
method: 'GET',
responseType: 'json',
params: content.experimental.stripQueryParameters
? undefined
: {
_params: jsonStringify(params),
previewToken: useCookie('previewToken').value
}
})

// On SSG, all url are redirected to `404.html` when not found, so we need to check the content type
// to know if the response is a valid JSON or not
Expand Down
16 changes: 14 additions & 2 deletions src/runtime/composables/query.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { useRuntimeConfig } from '#app'
import { createQuery } from '../query/query'
import type { ParsedContent, QueryBuilder, QueryBuilderParams } from '../types'
import { encodeQueryParams } from '../utils/query'
import { jsonStringify } from '../utils/json'
import { addPrerenderPath, shouldUseClientDB, withContentBase } from './utils'

/**
Expand Down Expand Up @@ -37,7 +38,9 @@ export const createQueryFetch = <T = ParsedContent>(path?: string) => async (que

const params = query.params()

const apiPath = withContentBase(`/query/${process.dev ? '_' : `${hash(params)}.${content.integrity}`}/${encodeQueryParams(params)}.json`)
const apiPath = content.experimental.stripQueryParameters
? withContentBase(`/query/${process.dev ? '_' : `${hash(params)}.${content.integrity}`}/${encodeQueryParams(params)}.json`)
: withContentBase(process.dev ? '/query' : `/query/${hash(params)}.${content.integrity}.json`)

// Prefetch the query
if (!process.dev && process.server) {
Expand All @@ -49,7 +52,16 @@ export const createQueryFetch = <T = ParsedContent>(path?: string) => async (que
return db.fetch(query as QueryBuilder<ParsedContent>)
}

const data = await $fetch(apiPath as any, { method: 'GET', responseType: 'json' })
const data = await $fetch(apiPath as any, {
method: 'GET',
responseType: 'json',
params: content.experimental.stripQueryParameters
? undefined
: {
_params: jsonStringify(params),
previewToken: useCookie('previewToken').value
}
})

// On SSG, all url are redirected to `404.html` when not found, so we need to check the content type
// to know if the response is a valid JSON or not
Expand Down
4 changes: 2 additions & 2 deletions src/runtime/composables/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ export const addPrerenderPath = (path: string) => {
}

export const shouldUseClientDB = () => {
const { clientDB } = useRuntimeConfig().content
const { experimental } = useRuntimeConfig().content
if (!process.client) { return false }
if (clientDB?.isSPA) { return true }
if (experimental.clientDB) { return true }

const query = useRoute().query
// Disable clientDB when `?preview` is set in query, and it has falsy value
Expand Down
4 changes: 2 additions & 2 deletions src/runtime/plugins/documentDriven.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { defineNuxtPlugin, queryContent, useContentHelpers, useContentState, fet
import layouts from '#build/layouts'

export default defineNuxtPlugin((nuxt: NuxtApp) => {
const { documentDriven: moduleOptions, clientDB } = useRuntimeConfig()?.public?.content
const { documentDriven: moduleOptions, experimental } = useRuntimeConfig()?.public?.content

/**
* Finds a layout value from a cascade of objects.
Expand Down Expand Up @@ -249,7 +249,7 @@ export default defineNuxtPlugin((nuxt: NuxtApp) => {
// TODO: Remove this (https://github.com/nuxt/framework/pull/5274)
if (to.path.includes('favicon.ico')) { return }
// Avoid calling on hash change
if (process.client && !clientDB.isSPA && to.path === from.path) { return }
if (process.client && !experimental.clientDB && to.path === from.path) { return }

const redirect = await refresh(to, false)

Expand Down