Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/fifty-rats-smile.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'sv': patch
---

fix(drizzle): don't cancel if `D1` is selected without `@sveltejs/adapter-cloudflare`, but add info to next steps
5 changes: 5 additions & 0 deletions .changeset/fix-cancel-propagation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'sv': patch
---

fix(sv): skip add-ons when a `dependsOn` dependency cancels
11 changes: 6 additions & 5 deletions packages/sv/src/addons/drizzle.ts
Original file line number Diff line number Diff line change
Expand Up @@ -101,10 +101,6 @@ export default defineAddon({
file,
packageManager
}) => {
if (options.database === 'd1' && !dependencyVersion('@sveltejs/adapter-cloudflare')) {
return cancel('Cloudflare D1 requires @sveltejs/adapter-cloudflare - add the adapter first');
}

const [ts] = createPrinter(language === 'ts');
const baseDBPath = path.resolve(cwd, directory.lib, 'server', 'db');
const paths = {
Expand Down Expand Up @@ -508,9 +504,14 @@ export default defineAddon({
);
},

nextSteps: ({ options, packageManager, cwd }) => {
nextSteps: ({ options, packageManager, cwd, dependencyVersion }) => {
const steps: string[] = [];
if (options.database === 'd1') {
if (!dependencyVersion('@sveltejs/adapter-cloudflare')) {
steps.push(
`Cloudflare D1 requires ${color.addon('@sveltejs/adapter-cloudflare')}. Run ${color.command(resolveCommandArray(packageManager, 'execute', ['sv', 'add', 'sveltekit-adapter=adapter:cloudflare']))} to add it`
);
}
const ext = fileExists(cwd, 'wrangler.toml') ? 'toml' : 'jsonc';
steps.push(
`Add your ${color.env('CLOUDFLARE_ACCOUNT_ID')}, ${color.env('CLOUDFLARE_DATABASE_ID')}, and ${color.env('CLOUDFLARE_D1_TOKEN')} to ${color.path('.env')}`
Expand Down
10 changes: 8 additions & 2 deletions packages/sv/src/cli/add.ts
Original file line number Diff line number Diff line change
Expand Up @@ -697,8 +697,14 @@ export async function runAddonsApply({
const successfulAddons = loadedAddons.filter((a) => !canceledAddonIds.includes(a.addon.id));

if (addonSuccess.length === 0) {
p.cancel('All selected add-ons were canceled.');
process.exit(1);
// `create` already scaffolded the project on disk - exiting here would hide
// the "Project created" success and the next-steps. Just warn instead.
if (fromCommand === 'create') {
p.log.warn('All selected add-ons were canceled.');
} else {
p.cancel('All selected add-ons were canceled.');
process.exit(1);
}
} else {
p.log.success(
`Successfully setup add-ons: ${addonSuccess.map((c) => color.addon(c)).join(', ')}`
Expand Down
12 changes: 12 additions & 0 deletions packages/sv/src/core/engine.ts
Original file line number Diff line number Diff line change
Expand Up @@ -111,13 +111,24 @@ export async function applyAddons({
}> {
const filesToFormat = new Set<string>();
const status: Record<string, string[] | 'success'> = {};
const canceledAddons = new Set<string>();

const addonDefs = loadedAddons.map((l) => l.addon);
const ordered = orderAddons(addonDefs, setupResults);

let hasFormatter = false;

for (const addon of ordered) {
// Skip addons whose `dependsOn` dependency was canceled. Running them would
// fail with misleading errors since they expect state from the canceled addon.
const dependsOn = setupResults[addon.id]?.dependsOn ?? [];
const canceledDeps = dependsOn.filter((dep) => canceledAddons.has(dep));
if (canceledDeps.length > 0) {
canceledAddons.add(addon.id);
status[addon.id] = canceledDeps.map((dep) => `Because dependency '${dep}' was canceled`);
continue;
}

const loaded = loadedAddons.find((l) => l.addon.id === addon.id)!;
const workspaceOptions = options[addon.id] || {};

Expand All @@ -141,6 +152,7 @@ export async function applyAddons({
if (cancels.length === 0) {
status[addon.id] = 'success';
} else {
canceledAddons.add(addon.id);
status[addon.id] = cancels;
}
}
Expand Down
65 changes: 65 additions & 0 deletions packages/sv/src/core/tests/engine.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
import fs from 'node:fs';
import os from 'node:os';
import path from 'node:path';
import { describe, expect, it } from 'vitest';
import { defineAddon, defineAddonOptions, type LoadedAddon } from '../config.ts';
import { applyAddons, setupAddons } from '../engine.ts';
import { createWorkspace } from '../workspace.ts';

function makeWorkspace() {
const cwd = fs.mkdtempSync(path.join(os.tmpdir(), 'sv-engine-'));
fs.writeFileSync(path.join(cwd, 'package.json'), '{"name":"t","private":true}');
return cwd;
}
const loaded = (a: ReturnType<typeof defineAddon<any, any>>): LoadedAddon => ({
reference: { specifier: a.id, options: [], source: { kind: 'official', id: a.id } },
addon: a
});
const dep = defineAddon({
id: 'dep',
options: defineAddonOptions().build(),
run: ({ cancel }) => cancel('nope')
});

describe('applyAddons cancel propagation', () => {
it("skips addons whose 'dependsOn' was canceled", async () => {
const child = defineAddon({
id: 'child',
options: defineAddonOptions().build(),
setup: ({ dependsOn }) => dependsOn('dep' as never),
run: () => expect.fail('child should not have run')
});
const workspace = await createWorkspace({ cwd: makeWorkspace() });
const addons = [loaded(dep), loaded(child)];
const { status } = await applyAddons({
loadedAddons: addons,
workspace,
setupResults: setupAddons(addons, workspace),
options: { dep: {}, child: {} }
});
expect(status.dep).toEqual(['nope']);
expect(status.child).toEqual(["Because dependency 'dep' was canceled"]);
});

it("does not skip addons that only 'runsAfter' a canceled addon", async () => {
let ran = false;
const child = defineAddon({
id: 'child',
options: defineAddonOptions().build(),
setup: ({ runsAfter }) => runsAfter('dep' as never),
run: () => {
ran = true;
}
});
const workspace = await createWorkspace({ cwd: makeWorkspace() });
const addons = [loaded(dep), loaded(child)];
const { status } = await applyAddons({
loadedAddons: addons,
workspace,
setupResults: setupAddons(addons, workspace),
options: { dep: {}, child: {} }
});
expect(status.child).toBe('success');
expect(ran).toBe(true);
});
});
Loading