Unverified Commit 7f79552e authored by Jiwon Choi's avatar Jiwon Choi Committed by GitHub

Nudge humans to adopt Future Defaults (#98874)

Stacked on #98873.

Counter part of agent nudge for auto upgrade. Prompt user when runs
`next dev` or `next build` based on `experimental.agenticAutoUpgrade`
value. This PR covers `future`.
parent 59a5fae3
import type { NextConfigComplete } from '../../server/config-shared'
import semver from 'next/dist/compiled/semver'
import { findDir } from '../find-pages-dir'
export type UpgradeDocument = `docs/${string}.md` | `skills/${string}/SKILL.md`
......@@ -8,6 +10,7 @@ type FutureDefault = {
isAdopted(config: Pick<NextConfigComplete, 'cacheComponents'>): boolean
adoptionDoc: readonly UpgradeDocument[]
optimizationDoc: readonly UpgradeDocument[]
isApplicable(directory: string): boolean
}
export const futureDefaults = [
......@@ -22,7 +25,28 @@ export const futureDefaults = [
'skills/next-cache-components-adoption/SKILL.md',
],
optimizationDoc: ['skills/next-cache-components-optimizer/SKILL.md'],
// TODO: Support Pages -> App migration before offering adoption to Pages-only apps.
isApplicable: (directory) => findDir(directory, 'app') !== null,
},
] as const satisfies readonly FutureDefault[]
export type FutureDefaultEntry = (typeof futureDefaults)[number]
export function getPendingFutureDefaults(
directory: string,
config: Pick<NextConfigComplete, 'cacheComponents'>,
version: string
) {
if (
!semver.valid(version) ||
(semver.prerelease(version) && semver.prerelease(version)?.[0] !== 'canary')
) {
return []
}
return futureDefaults.filter(
(entry) =>
semver.gte(version, entry.availableSince) &&
!entry.isAdopted(config) &&
entry.isApplicable(directory)
)
}
......@@ -10,7 +10,7 @@ import type { NextConfigComplete } from '../../server/config-shared'
import semver from 'next/dist/compiled/semver'
import type { UpgradeAction } from './prompt'
import { getAgentName } from '../../telemetry/agent-name'
import { futureDefaults } from './future-defaults'
import { futureDefaults, getPendingFutureDefaults } from './future-defaults'
import { isCI } from '../../server/ci-info'
type NudgeOptions = {
......@@ -23,7 +23,9 @@ export type NudgeKind = 'security' | 'latest' | 'future'
function getRequestedUpgrade() {
const policy = process.env.__NEXT_AGENTIC_AUTO_UPGRADE
return policy === 'security' || policy === 'latest' ? policy : null
return policy === 'security' || policy === 'latest' || policy === 'future'
? policy
: null
}
const RETRY_TTL = 5 * 60 * 1000
......@@ -126,8 +128,8 @@ type UpgradeReminder = {
targetVersion: string | null
unavailableReason: string | null
}
| { kind: 'latest'; latestVersion: string | null }
| { kind: 'future'; names: string[] }
| { kind: 'latest'; latestVersion: string | null; names: string[] }
| { kind: 'future'; targetVersion: string; names: string[] }
)
export function getUpgradeContext(config: NextConfigComplete): UpgradeContext {
......@@ -142,7 +144,7 @@ export function getUpgradeContext(config: NextConfigComplete): UpgradeContext {
}
export async function assessUpgrade(
_directory: string,
directory: string,
config: UpgradeContext,
installedVersion: string = process.env.__NEXT_VERSION || 'unknown',
stopBefore: NudgeKind | null = null,
......@@ -212,17 +214,21 @@ export async function assessUpgrade(
policy,
installedVersion,
latestVersion: upgrade.targetVersion,
names:
policy === 'future'
? getPendingFutureDefaults(
directory,
config,
upgrade.targetVersion
).map((entry) => entry.name)
: [],
}
}
if (policy !== 'future' || stopBefore === 'future') {
return null
}
const pending = futureDefaults.filter(
(entry) =>
semver.gte(installedVersion, entry.availableSince) &&
!entry.isAdopted(config)
)
const pending = getPendingFutureDefaults(directory, config, installedVersion)
if (pending.length === 0) {
return null
}
......@@ -230,6 +236,7 @@ export async function assessUpgrade(
kind: 'future',
policy,
installedVersion,
targetVersion: upgrade.targetVersion,
names: pending.map((entry) => entry.name),
}
}
......@@ -387,6 +394,19 @@ async function nudgeUpgradeForHuman(
message = `⚠ Installed Next.js version ${reminder.installedVersion} is affected by a known security vulnerability.`
canUpgrade = reminder.unavailableReason === null
message += `\n\n${reminder.unavailableReason ?? `Next.js security version upgrade available: ${reminder.installedVersion} -> ${reminder.targetVersion ?? '[target version]'}`}`
} else if (reminder.policy === 'future') {
const targetVersion =
reminder.kind === 'latest'
? reminder.latestVersion
: reminder.targetVersion
const versions =
targetVersion !== reminder.installedVersion
? ` ${reminder.installedVersion} -> ${targetVersion ?? '[target version]'}`
: ''
message = `Next.js Future Default upgrade available:${versions}`
if (reminder.names.length > 0) {
message += `\n\n${reminder.names.map((name) => `- ${name}`).join('\n')}`
}
} else if (reminder.kind === 'latest') {
message = `Next.js latest version upgrade available: ${reminder.installedVersion} -> ${reminder.latestVersion ?? '[target version]'}`
} else {
......@@ -463,7 +483,6 @@ export async function nudgeUpgrade(
installedVersion,
policy
)
stopBefore ??= 'future'
}
if (signal.aborted) {
return
......@@ -496,6 +515,15 @@ export async function nudgeUpgrade(
...context,
kind: 'latest',
latestVersion: null,
names: [],
}
break
case 'future':
reminder = {
...context,
kind: 'future',
targetVersion: installedVersion,
names: futureDefaults.map((entry) => entry.name),
}
break
}
......
......@@ -5,7 +5,10 @@ import { resetEnv } from '@next/env'
import semver from 'next/dist/compiled/semver'
import loadConfig from '../../server/config'
import { PHASE_INFO } from '../../shared/lib/constants'
import { futureDefaults, type FutureDefaultEntry } from './future-defaults'
import {
getPendingFutureDefaults,
type FutureDefaultEntry,
} from './future-defaults'
type UpgradePreparation =
| { status: 'unaffected'; reason: string }
......@@ -64,10 +67,10 @@ export async function prepareUpgrade(
const config = await loadConfig(PHASE_INFO, directory, {
silent: true,
}).finally(resetEnv)
const pendingFutureDefaults = futureDefaults.filter(
(futureDefault) =>
semver.gte(upgrade.targetVersion, futureDefault.availableSince) &&
!futureDefault.isAdopted(config)
const pendingFutureDefaults = getPendingFutureDefaults(
directory,
config,
upgrade.targetVersion
)
if (
......@@ -76,7 +79,7 @@ export async function prepareUpgrade(
) {
return {
status: 'unaffected',
reason: `Next.js ${installedVersion} is current and all available Future Defaults are enabled.`,
reason: `Next.js ${installedVersion} is current and no applicable Future Defaults are pending.`,
}
}
......
......@@ -597,6 +597,7 @@ describe('agentic upgrade prompts', () => {
'skills/next-cache-components-adoption/SKILL.md',
],
optimizationDoc: ['skills/next-cache-components-optimizer/SKILL.md'],
isApplicable: jest.fn(() => true),
},
],
})
......@@ -683,6 +684,7 @@ describe('agentic upgrade prompts', () => {
'skills/next-cache-components-adoption/SKILL.md',
],
optimizationDoc: ['skills/next-cache-components-optimizer/SKILL.md'],
isApplicable: jest.fn(() => true),
},
],
})
......
......@@ -21,6 +21,7 @@ describe('prepare latest upgrade', () => {
async function createApp(version: string): Promise<string> {
const directory = await mkdtemp(join(tmpdir(), 'next-latest-upgrade-'))
directories.push(directory)
await mkdir(join(directory, 'app'))
await mkdir(join(directory, 'node_modules/next'), { recursive: true })
await writeFile(join(directory, 'package.json'), '{}')
await writeFile(
......@@ -725,7 +726,18 @@ describe('prepare latest upgrade', () => {
await expect(prepareUpgrade(directory, 'future')).resolves.toEqual({
status: 'unaffected',
reason:
'Next.js 16.4.0 is current and all available Future Defaults are enabled.',
'Next.js 16.4.0 is current and no applicable Future Defaults are pending.',
})
})
it('keeps version upgrades but excludes adoption for a Pages-only app', async () => {
const directory = await createApp('16.2.0')
await rm(join(directory, 'app'), { recursive: true })
await mkdir(join(directory, 'pages'))
mockFutureMetadata('<16.3.0')
await expect(prepareUpgrade(directory, 'future')).resolves.toMatchObject({
status: 'ready',
targetVersion: '16.4.0',
futureDefaults: [],
})
})
})
......@@ -541,6 +541,7 @@ describe('composed future nudge', () => {
kind: 'future',
policy: 'future',
installedVersion: '16.4.0-canary.1',
targetVersion: '16.4.0',
names: ['Cache Components'],
})
})
......@@ -584,10 +585,23 @@ describe('composed future nudge', () => {
kind: 'future',
policy: 'future',
installedVersion: '16.4.0',
targetVersion: '16.4.0',
names: ['Cache Components'],
})
})
it('does not offer Cache Components to a Pages-only app', async () => {
await rm(join(directory, 'app'), { recursive: true })
await mkdir(join(directory, 'pages'))
await expect(
assessUpgrade(
directory,
config('future', { cacheComponents: false }),
'16.4.0'
)
).resolves.toBeNull()
})
it('stays silent when all available Future Defaults are adopted', async () => {
await expect(
assessUpgrade(
......@@ -682,6 +696,21 @@ describe('human upgrade nudge', () => {
'17.0.0',
'Next.js latest version upgrade available: 16.4.0 -> 17.0.0',
],
[
'future',
'17.0.0',
'Next.js Future Default upgrade available: 16.4.0 -> 17.0.0\n\n- Cache Components',
],
[
'future',
'16.4.1',
'Next.js Future Default upgrade available: 16.4.0 -> 16.4.1\n\n- Cache Components',
],
[
'future',
'16.4.0',
'Next.js Future Default upgrade available:\n\n- Cache Components',
],
] as const)(
'renders concise %s copy for target %s',
async (policy, targetVersion, message) => {
......@@ -701,6 +730,21 @@ describe('human upgrade nudge', () => {
}
)
it('omits already adopted defaults from a future version upgrade', async () => {
mockUpgrade('17.0.0')
await nudgeUpgrade(
directory,
config('future', { cacheComponents: true }),
'build',
new AbortController().signal
)
expect(promptUpgrade).toHaveBeenCalledWith(
'Next.js Future Default upgrade available: 16.4.0 -> 17.0.0',
expect.any(AbortSignal),
true
)
})
it.each(['update', 'skip', 'interrupt'] as const)(
'returns %s without saving a dismissal',
async (action) => {
......@@ -716,7 +760,7 @@ describe('human upgrade nudge', () => {
}
)
it.each(['security', 'latest'] as const)(
it.each(['security', 'latest', 'future'] as const)(
'forces a %s request without changing installed-version eligibility',
async (policy) => {
process.env.__NEXT_AGENTIC_AUTO_UPGRADE = policy
......@@ -941,6 +985,25 @@ describe('human upgrade nudge', () => {
}
)
it('suppresses dismissed Future Defaults but still offers a newer release', async () => {
mockUpgrade()
jest.mocked(promptUpgrade).mockResolvedValue('dismiss')
await expect(run()).resolves.toBe('dismiss')
jest.clearAllMocks()
await run()
expect(promptUpgrade).toHaveBeenCalledTimes(0)
mockUpgrade('17.0.0')
jest.mocked(promptUpgrade).mockResolvedValue('skip')
await expect(run()).resolves.toBe('skip')
expect(promptUpgrade).toHaveBeenCalledWith(
expect.stringContaining(
'Next.js Future Default upgrade available: 16.4.0 -> 17.0.0'
),
expect.any(AbortSignal),
true
)
})
it.each(['blocked', 'unknown'] as const)(
'omits Update when security target availability is %s',
async (status) => {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment