feat: instances v2 (#6431)

* feat: base of instances v2 * feat: use old profiles with compat layer * prototype: instances v2 * fix: install_from using profile * fix: skins migration fix * fix: frontend still using profile path * fix: add update proj multiselect guard * fix: cargo fmt * fix: content missing fields * feat: break up app-lib/api/instance.rs * fix: check_content_updates mismatch * fix: updater modal cleanup w/new structure * feat: better update all handling * fix: remove preview_update_all * fix: feedback on bulk update + lint * fix: rem transitions * fix: change to jsonb * feat: app db backup after update * fix: lint * fix: sqlx prepare + use sqlx macros * fix: lint * fix: bugs * feat: defuck the installing process up * fix: bug of hell * fix: shear * fix: fmt * fix: install progress spacing + change mc/content/overrides to bytes * fix: lint * fix: prepr * fix: navtabs anim not working in app * fix: worlds.vue improvements + browse page fixes * feat: optimise queries + adapter fns * fix: lint * fix: lint * feat: shared modrinth-content-management crate (#6469) * feat: disable warnings setting * feat: add instances shortcuts (#6329) * Add modrinth://launch deep link to start a profile Support external profile launching via modrinth://launch/{profile_path} for integrations such as Stream Deck. * Change route to /launch/profile/{id} for future extensibility * fix: ensure profile path is url decoded * fix: URL-decode profile path from deep link * fix: use urlencoding crate for URL decoding * feat: implement app instance shortcuts * feat: change windows shortcut creation to use windows api instead * feat: implement creating a shortcut launching world/server * format * fmt * fix multiline inline tables * pnpm prepr * feat: move create shortcut to last item * refactor: split up shortcuts.rs for individual platforms * refactor: turn profile launch url into url type * use string literal and add safety comment * pt2 * refactor: rename anything that's profile into instance * update mac shortcut --------- Co-authored-by: DJCheesusReal <134006619+DJCheesusReal@users.noreply.github.com> --------- Co-authored-by: Truman Gao <106889354+tdgao@users.noreply.github.com> Co-authored-by: DJCheesusReal <134006619+DJCheesusReal@users.noreply.github.com>
2026-08-31 12:05:53 +00:00 · 2026-06-25 21:19:29 +00:00
parent ef4044534f
commit 734720e11e
353 changed files with 24745 additions and 9771 deletions
@@ -19,7 +19,8 @@ import { useRouter } from 'vue-router'

 import ConfirmDeleteInstanceModal from '@/components/ui/modal/ConfirmDeleteInstanceModal.vue'
 import { trackEvent } from '@/helpers/analytics'
-import { duplicate, edit, edit_icon, list, remove } from '@/helpers/profile'
+import { install_duplicate_instance } from '@/helpers/install'
+import { edit, edit_icon, list, remove } from '@/helpers/instance'
 import { injectInstanceSettings } from '@/providers/instance-settings'

 import type { GameInstance } from '../../../helpers/types'
@@ -32,14 +33,14 @@ const queryClient = useQueryClient()
 const deleteConfirmModal = ref()

 const { instance } = injectInstanceSettings()
-type ReleaseChannel = GameInstance['preferred_update_channel']
+type ReleaseChannel = GameInstance['update_channel']
 const releaseChannelOptions: ReleaseChannel[] = ['release', 'beta', 'alpha']

 const title = ref(instance.value.name)
 const icon: Ref<string | undefined> = ref(instance.value.icon_path)
 const groups = ref([...instance.value.groups])
 const savingReleaseChannel = ref(false)
-const selectedReleaseChannel = ref<ReleaseChannel>(instance.value.preferred_update_channel)
+const selectedReleaseChannel = ref<ReleaseChannel>(instance.value.update_channel)
 const releaseChannelDisabledItems = computed<ReleaseChannel[]>(() =>
 	savingReleaseChannel.value ? [...releaseChannelOptions] : [],
 )
@@ -48,8 +49,8 @@ const newCategoryInput = ref('')

 const installing = computed(() => instance.value.install_stage !== 'installed')

-async function duplicateProfile() {
-	await duplicate(instance.value.path).catch(handleError)
+async function duplicateInstance() {
+	await install_duplicate_instance(instance.value.id).catch(handleError)
 	trackEvent('InstanceDuplicate', {
 		loader: instance.value.loader,
 		game_version: instance.value.game_version,
@@ -84,22 +85,22 @@ function formatReleaseChannelDescription(channel: ReleaseChannel) {
 }

 watch(
-	() => [instance.value.path, instance.value.preferred_update_channel] as const,
+	() => [instance.value.id, instance.value.update_channel] as const,
 	() => {
 		if (!savingReleaseChannel.value) {
-			selectedReleaseChannel.value = instance.value.preferred_update_channel
+			selectedReleaseChannel.value = instance.value.update_channel
 		}
 	},
 )

 watch(selectedReleaseChannel, async (channel, previousChannel) => {
-	const previousReleaseChannel = previousChannel ?? instance.value.preferred_update_channel
-	if (channel === instance.value.preferred_update_channel) return
+	const previousReleaseChannel = previousChannel ?? instance.value.update_channel
+	if (channel === instance.value.update_channel) return

 	savingReleaseChannel.value = true
-	const profilePath = instance.value.path
-	await edit(profilePath, { preferred_update_channel: channel })
-		.then(() => queryClient.invalidateQueries({ queryKey: ['linkedModpackInfo', profilePath] }))
+	const instanceId = instance.value.id
+	await edit(instanceId, { update_channel: channel })
+		.then(() => queryClient.invalidateQueries({ queryKey: ['linkedModpackInfo', instanceId] }))
 		.catch((error) => {
 			selectedReleaseChannel.value = previousReleaseChannel
 			handleError(error)
@@ -109,7 +110,7 @@ watch(selectedReleaseChannel, async (channel, previousChannel) => {

 async function resetIcon() {
 	icon.value = undefined
-	await edit_icon(instance.value.path, null).catch(handleError)
+	await edit_icon(instance.value.id, null).catch(handleError)
 	trackEvent('InstanceRemoveIcon')
 }

@@ -127,12 +128,12 @@ async function setIcon() {
 	if (!value) return

 	icon.value = value
-	await edit_icon(instance.value.path, icon.value).catch(handleError)
+	await edit_icon(instance.value.id, icon.value).catch(handleError)

 	trackEvent('InstanceSetIcon')
 }

-const editProfileObject = computed(() => ({
+const editInstanceObject = computed(() => ({
 	name: title.value.trim().substring(0, 32) ?? 'Instance',
 	groups: groups.value.map((x) => x.trim().substring(0, 32)).filter((x) => x.length > 0),
 }))
@@ -158,15 +159,15 @@ watch(
 	[title, groups, groups],
 	async () => {
 		if (removing.value) return
-		await edit(instance.value.path, editProfileObject.value).catch(handleError)
+		await edit(instance.value.id, editInstanceObject.value).catch(handleError)
 	},
 	{ deep: true },
 )

 const removing = ref(false)
-async function removeProfile() {
+async function removeInstance() {
 	removing.value = true
-	const path = instance.value.path
+	const path = instance.value.id

 	trackEvent('InstanceRemove', {
 		loader: instance.value.loader,
@@ -284,7 +285,7 @@ const messages = defineMessages({
 </script>

 <template>
-	<ConfirmDeleteInstanceModal ref="deleteConfirmModal" @delete="removeProfile" />
+	<ConfirmDeleteInstanceModal ref="deleteConfirmModal" @delete="removeInstance" />
 	<div class="block">
 		<div class="float-end ml-10 relative group w-fit">
 			<div class="flex flex-col gap-1">
@@ -310,7 +311,7 @@ const messages = defineMessages({
 							:src="icon ? convertFileSrc(icon) : icon"
 							size="108px"
 							class="transition-[filter] group-hover:brightness-75"
-							:tint-by="instance.path"
+							:tint-by="instance.id"
 							no-shadow
 						/>
 						<div
@@ -350,7 +351,7 @@ const messages = defineMessages({
 						aria-labelledby="duplicate-instance-label"
 						:disabled="installing"
 						class="w-max !shadow-none"
-						@click="duplicateProfile"
+						@click="duplicateInstance"
 					>
 						<CopyIcon /> {{ formatMessage(messages.duplicateButton) }}
 					</button>
@@ -8,7 +8,7 @@ import {
 } from '@modrinth/ui'
 import { computed, ref, watch } from 'vue'

-import { edit } from '@/helpers/profile'
+import { edit } from '@/helpers/instance'
 import { get } from '@/helpers/settings.ts'
 import { injectInstanceSettings } from '@/providers/instance-settings'

@@ -28,21 +28,21 @@ const overrideHooks = ref(
 )
 const hooks = ref(instance.value.hooks ?? globalSettings.hooks)

-const editProfileObject = computed(() => {
-	const editProfile: {
+const editInstanceObject = computed(() => {
+	const editInstancePatch: {
 		hooks?: Hooks
 	} = {}

 	// When hooks are not overridden per-instance, we want to clear them
-	editProfile.hooks = overrideHooks.value ? hooks.value : {}
+	editInstancePatch.hooks = overrideHooks.value ? hooks.value : {}

-	return editProfile
+	return editInstancePatch
 })

 watch(
 	[overrideHooks, hooks],
 	async () => {
-		await edit(instance.value.path, editProfileObject.value)
+		await edit(instance.value.id, editInstanceObject.value)
 	},
 	{ deep: true },
 )
@@ -4,6 +4,7 @@ import {
 	commonMessages,
 	defineMessages,
 	formatLoaderLabel,
+	injectFilePicker,
 	injectNotificationManager,
 	InstallationSettingsLayout,
 	provideAppBackup,
@@ -17,30 +18,41 @@ import { computed, ref } from 'vue'

 import { trackEvent } from '@/helpers/analytics'
 import { get_project_versions, get_version } from '@/helpers/cache'
-import { get_loader_versions } from '@/helpers/metadata'
 import {
-	duplicate,
+	install_duplicate_instance,
+	install_existing_instance,
+	install_pack_to_existing_instance,
+	installJobInstanceId,
+	wait_for_install_job,
+} from '@/helpers/install'
+import {
 	edit,
 	get_linked_modpack_info,
-	install,
 	list,
 	update_managed_modrinth_version,
 	update_repair_modrinth,
-} from '@/helpers/profile'
+} from '@/helpers/instance'
+import { get_loader_versions } from '@/helpers/metadata'
 import { get_game_versions, get_loaders } from '@/helpers/tags'
 import { injectInstanceSettings } from '@/providers/instance-settings'
+import { useTheming } from '@/store/state'

 import type { Manifest } from '../../../helpers/types'

 const { handleError } = injectNotificationManager()
+const filePicker = injectFilePicker()
 const { formatMessage } = useVIntl()
 const queryClient = useQueryClient()
 const debug = useDebugLogger('AppInstallationSettings')
+const themeStore = useTheming()

 const { instance, offline, isMinecraftServer, onUnlinked, closeModal } = injectInstanceSettings()
+const skipNonEssentialWarnings = computed(() =>
+	themeStore.getFeatureFlag('skip_non_essential_warnings'),
+)

 debug('metadata load: start', {
-	instancePath: instance.value.path,
+	instanceId: instance.value.id,
 	loader: instance.value.loader,
 	gameVersion: instance.value.game_version,
 	installStage: instance.value.install_stage,
@@ -91,15 +103,22 @@ const metadataLoading = computed(() =>
 )

 debug('metadata queries configured', {
-	instancePath: instance.value.path,
+	instanceId: instance.value.id,
 	loader: instance.value.loader,
 	gameVersion: instance.value.game_version,
 })

+const isModrinthLinkedModpack = computed(
+	() =>
+		instance.value.link?.type === 'modrinth_modpack' ||
+		instance.value.link?.type === 'server_project_modpack',
+)
+const isImportedModpack = computed(() => instance.value.link?.type === 'imported_modpack')
+
 const modpackInfoQuery = useQuery({
-	queryKey: computed(() => ['linkedModpackInfo', instance.value.path]),
-	queryFn: () => get_linked_modpack_info(instance.value.path, 'must_revalidate'),
-	enabled: computed(() => !!instance.value.linked_data?.project_id && !offline),
+	queryKey: computed(() => ['linkedModpackInfo', instance.value.id]),
+	queryFn: () => get_linked_modpack_info(instance.value.id, 'must_revalidate'),
+	enabled: computed(() => isModrinthLinkedModpack.value && !offline),
 })
 const modpackInfo = modpackInfoQuery.data

@@ -129,22 +148,39 @@ function getManifest(loader: string) {
 	return manifest
 }

+async function installLocalModpackFromPicker() {
+	const picked = await filePicker.pickModpackFile({ readFile: false })
+	if (!picked?.path) return false
+
+	const job = await install_pack_to_existing_instance(instance.value.id, {
+		type: 'fromFile',
+		path: picked.path,
+	}).catch(handleError)
+	if (!job) return false
+
+	const completed = await wait_for_install_job(job.job_id).catch(handleError)
+	return !!completed
+}
+
 provideAppBackup({
 	async createBackup() {
 		debug('createBackup: start', {
-			instancePath: instance.value.path,
+			instanceId: instance.value.id,
 			instanceName: instance.value.name,
 		})
-		const allProfiles = await list()
+		const allInstances = await list()
 		const prefix = `${instance.value.name} - Backup #`
-		const existingNums = allProfiles
+		const existingNums = allInstances
 			.filter((p) => p.name.startsWith(prefix))
 			.map((p) => parseInt(p.name.slice(prefix.length), 10))
 			.filter((n) => !isNaN(n))
 		const nextNum = existingNums.length > 0 ? Math.max(...existingNums) + 1 : 1
-		const newPath = await duplicate(instance.value.path)
-		await edit(newPath, { name: `${prefix}${nextNum}` })
-		debug('createBackup: done', { newPath, backupName: `${prefix}${nextNum}` })
+		const job = await install_duplicate_instance(instance.value.id)
+		const newInstanceId = installJobInstanceId(job)
+		if (newInstanceId) {
+			await edit(newInstanceId, { name: `${prefix}${nextNum}` })
+		}
+		debug('createBackup: done', { newInstanceId, backupName: `${prefix}${nextNum}` })
 	},
 })

@@ -172,7 +208,7 @@ provideInstallationSettings({
 		}
 		return rows
 	}),
-	isLinked: computed(() => !!instance.value.linked_data?.locked),
+	isLinked: computed(() => isModrinthLinkedModpack.value || isImportedModpack.value),
 	isBusy: computed(
 		() =>
 			instance.value.install_stage !== 'installed' ||
@@ -180,7 +216,16 @@ provideInstallationSettings({
 			reinstalling.value ||
 			!!offline,
 	),
+	skipNonEssentialWarnings,
 	modpack: computed(() => {
+		if (isImportedModpack.value && instance.value.link?.type === 'imported_modpack') {
+			return {
+				iconUrl: instance.value.icon_path,
+				title: instance.value.link.name ?? instance.value.name,
+				versionNumber: instance.value.link.version_number ?? undefined,
+				filename: instance.value.link.filename ?? undefined,
+			}
+		}
 		if (!modpackInfo.value) return null
 		return {
 			iconUrl: modpackInfo.value.project.icon_url,
@@ -261,25 +306,25 @@ provideInstallationSettings({

 	async save(platform, gameVersion, loaderVersionId) {
 		debug('save: called', {
-			instancePath: instance.value.path,
+			instanceId: instance.value.id,
 			platform,
 			gameVersion,
 			loaderVersionId,
 		})
-		const editProfile: Record<string, string | undefined> = {
+		const editInstancePatch: Record<string, string | undefined> = {
 			loader: platform,
 			game_version: gameVersion,
 		}
 		if (platform !== 'vanilla' && loaderVersionId) {
-			editProfile.loader_version = loaderVersionId
+			editInstancePatch.loader_version = loaderVersionId
 		}
-		await edit(instance.value.path, editProfile).catch(handleError)
-		debug('save: edit complete', { editProfile })
+		await edit(instance.value.id, editInstancePatch).catch(handleError)
+		debug('save: edit complete', { editInstancePatch })
 	},

 	afterSave: async () => {
-		debug('afterSave: installing', { instancePath: instance.value.path })
-		await install(instance.value.path, false).catch(handleError)
+		debug('afterSave: installing', { instanceId: instance.value.id })
+		await install_existing_instance(instance.value.id, false).catch(handleError)
 		trackEvent('InstanceRepair', {
 			loader: instance.value.loader,
 			game_version: instance.value.game_version,
@@ -288,9 +333,9 @@ provideInstallationSettings({
 	},

 	async repair() {
-		debug('repair: called', { instancePath: instance.value.path })
+		debug('repair: called', { instanceId: instance.value.id })
 		repairing.value = true
-		await install(instance.value.path, true).catch(handleError)
+		await install_existing_instance(instance.value.id, true).catch(handleError)
 		repairing.value = false
 		trackEvent('InstanceRepair', {
 			loader: instance.value.loader,
@@ -300,24 +345,52 @@ provideInstallationSettings({
 	},

 	async reinstallModpack() {
-		debug('reinstallModpack: called', { instancePath: instance.value.path })
+		debug('reinstallModpack: called', { instanceId: instance.value.id })
 		reinstalling.value = true
-		await update_repair_modrinth(instance.value.path).catch(handleError)
-		reinstalling.value = false
-		trackEvent('InstanceRepair', {
-			loader: instance.value.loader,
-			game_version: instance.value.game_version,
-		})
+		let shouldTrack = false
+		try {
+			if (isImportedModpack.value) {
+				shouldTrack = await installLocalModpackFromPicker()
+			} else {
+				await update_repair_modrinth(instance.value.id).catch(handleError)
+				shouldTrack = true
+			}
+		} finally {
+			reinstalling.value = false
+		}
+		if (shouldTrack) {
+			trackEvent('InstanceRepair', {
+				loader: instance.value.loader,
+				game_version: instance.value.game_version,
+			})
+		}
 		debug('reinstallModpack: done')
 	},

+	async swapModpack() {
+		debug('swapModpack: called', { instanceId: instance.value.id })
+		reinstalling.value = true
+		try {
+			const installed = await installLocalModpackFromPicker()
+			if (installed) {
+				trackEvent('InstanceRepair', {
+					loader: instance.value.loader,
+					game_version: instance.value.game_version,
+				})
+			}
+		} finally {
+			reinstalling.value = false
+		}
+		debug('swapModpack: done')
+	},
+
 	async unlinkModpack() {
-		debug('unlinkModpack: called', { instancePath: instance.value.path })
-		await edit(instance.value.path, {
-			linked_data: null as unknown as undefined,
+		debug('unlinkModpack: called', { instanceId: instance.value.id })
+		await edit(instance.value.id, {
+			link: null as unknown as undefined,
 		})
 		await queryClient.invalidateQueries({
-			queryKey: ['linkedModpackInfo', instance.value.path],
+			queryKey: ['linkedModpackInfo', instance.value.id],
 		})
 		onUnlinked()
 		debug('unlinkModpack: done')
@@ -326,11 +399,9 @@ provideInstallationSettings({
 	getCachedModpackVersions: () => null,
 	async fetchModpackVersions() {
 		debug('fetchModpackVersions: called', {
-			projectId: instance.value.linked_data?.project_id,
+			projectId: instance.value.link?.project_id,
 		})
-		const versions = await get_project_versions(instance.value.linked_data!.project_id!).catch(
-			handleError,
-		)
+		const versions = await get_project_versions(instance.value.link!.project_id!).catch(handleError)
 		debug('fetchModpackVersions: done', { count: versions?.length ?? 0 })
 		return (versions ?? []) as Labrinth.Versions.v2.Version[]
 	},
@@ -345,19 +416,18 @@ provideInstallationSettings({
 	async onModpackVersionConfirm(version) {
 		debug('onModpackVersionConfirm: called', {
 			versionId: version.id,
-			instancePath: instance.value.path,
+			instanceId: instance.value.id,
 		})
-		await update_managed_modrinth_version(instance.value.path, version.id)
+		await update_managed_modrinth_version(instance.value.id, version.id)
 		await queryClient.invalidateQueries({
-			queryKey: ['linkedModpackInfo', instance.value.path],
+			queryKey: ['linkedModpackInfo', instance.value.id],
 		})
 		debug('onModpackVersionConfirm: done')
 	},

 	updaterModalProps: computed(() => ({
 		isApp: true,
-		currentVersionId:
-			modpackInfo.value?.update_version_id ?? instance.value.linked_data?.version_id ?? '',
+		currentVersionId: modpackInfo.value?.update_version_id ?? instance.value.link?.version_id ?? '',
 		projectIconUrl: modpackInfo.value?.project?.icon_url,
 		projectName: modpackInfo.value?.project?.title ?? 'Modpack',
 		currentGameVersion: instance.value.game_version,
@@ -366,7 +436,10 @@ provideInstallationSettings({

 	isServer: false,
 	isApp: true,
-	showModpackVersionActions: !isMinecraftServer.value,
+	showModpackVersionActions: computed(
+		() => isModrinthLinkedModpack.value && !isMinecraftServer.value,
+	),
+	isLocalFile: isImportedModpack,
 	repairing,
 	reinstalling,
 })
@@ -23,7 +23,7 @@ import { computed, readonly, ref, watch } from 'vue'
 import JavaDetectionModal from '@/components/ui/JavaDetectionModal.vue'
 import useJavaTest from '@/composables/useJavaTest'
 import useMemorySlider from '@/composables/useMemorySlider'
-import { edit, get_optimal_jre_key } from '@/helpers/profile'
+import { edit, get_optimal_jre_key } from '@/helpers/instance'
 import { get } from '@/helpers/settings.ts'
 import { injectInstanceSettings } from '@/providers/instance-settings'

@@ -36,7 +36,7 @@ const { instance } = injectInstanceSettings()

 const globalSettings = (await get().catch(handleError)) as unknown as AppSettings

-const optimalJava = readonly(await get_optimal_jre_key(instance.value.path).catch(handleError))
+const optimalJava = readonly(await get_optimal_jre_key(instance.value.id).catch(handleError))

 const overrideJavaInstall = ref(!!instance.value.java_path)
 const javaPath = ref(instance.value.java_path ?? optimalJava?.path ?? '')
@@ -104,7 +104,7 @@ const { maxMemory, snapPoints } = (await useMemorySlider().catch(handleError)) a
 	snapPoints: number[]
 }

-const editProfileObject = computed(() => {
+const editInstanceObject = computed(() => {
 	return {
 		java_path:
 			overrideJavaInstall.value && javaPath.value
@@ -136,7 +136,7 @@ watch(
 		memory,
 	],
 	async () => {
-		await edit(instance.value.path, editProfileObject.value)
+		await edit(instance.value.id, editInstanceObject.value)
 	},
 	{ deep: true },
 )
@@ -9,7 +9,7 @@ import {
 } from '@modrinth/ui'
 import { computed, type Ref, ref, watch } from 'vue'

-import { edit } from '@/helpers/profile'
+import { edit } from '@/helpers/instance'
 import { get } from '@/helpers/settings.ts'
 import { injectInstanceSettings } from '@/providers/instance-settings'

@@ -32,7 +32,7 @@ const fullscreenSetting: Ref<boolean> = ref(
 	instance.value.force_fullscreen ?? globalSettings.force_fullscreen,
 )

-const editProfileObject = computed(() => {
+const editInstanceObject = computed(() => {
 	if (!overrideWindowSettings.value) {
 		return {
 			force_fullscreen: null,
@@ -48,7 +48,7 @@ const editProfileObject = computed(() => {
 watch(
 	[overrideWindowSettings, resolution, fullscreenSetting],
 	async () => {
-		await edit(instance.value.path, editProfileObject.value)
+		await edit(instance.value.id, editInstanceObject.value)
 	},
 	{ deep: true },
 )