feat: instance sharing thru shared-instances service (#6569)

* feat: implement instance share page + search_users backend call

* feat: invite players modal

* feat: use tanstack queries for friends sync across app pages

* feat: base shared instances implementation

* fix: admon style

* feat: impl instance admonitions like server panel

* fix: impl get + del usage

* feat: support modpack links

* feat: invite notif accepting

* fix: lint + fmt

* feat: impl install to play

* feat: impl usage of UpdateToPlayModal

* feat: warnings on deleting/disabling shared-instance version content

* fix: send instance name

* feat: align with backend

* feat: shared instances qa

* feat: wrong account protection

* feat: qa

* fix: smartly apply updates

* fix: install bug

* fix: 401/404 differentiation

* fix: fmt+prepr

* feat: qa

* feat: qa

* fix: signing out messes up revoke/deleted checks

* feat: qa

* fix: fmt + lint

* feat: lock content if part of shared instance

* fix: lint

* [do not merge] feat: rough invite links impl temp (#6666)

* fix: wrong cmd

* feat: invite page

* fix: server-manager DTO mismatch

* fix: drop anonymous invite link acceptance

* refactor: structured shared-instance unavailable errors

* refactor: centralise error presentations

* refactor: dedupe shared instance diff detection

* fix: logging in reqwests

* refactor: move app.vue shared instances into handler

* refactor: break up Share.vue

* refactor: split up shared instances state outside of instance index

* refactor: dedicated shared instances install/update modals + split up page

* refactor: centralized managed content

* refactor: split up install shared to own runner + shared.rs split up

* refactor: dedupe sql for instance metadata enrichmnt

* refactor: friends composable + dedupe friends logic across usages

* chore: reduced unused code

* fix: align with backend

* fix: lint

* fix: file sha changes

* fix: invite links not working due to icon signed

* feat: qa

* feat: reporting frontend dummy

* fix: try use header

* remove: file hash field

* fix: pin box

* feat: malware warning for shared instances

* fix: cache rule

* feat: config files syncing

* feat: disable config sharing

* fix: header

* fix: use mark ready

* fix: dont cause push update for configs

* fix: lint

* feat: sharing page in settings

* feat: move config + change flow

* fix: qa

* fix: lint prepr

* feat: proxy file upload thru shared instances backend

* fix: use collapisible

* fix: push config

* fix: config

* feat: swap out sign in modal for new one

* fix: report flow

* fix: exclude configs.zip from external warnings

* fix: nuxi init

* fix: config bundle downloading

* fix: error notif

* fix: polling

* fix: qa

* fix: lint + prepr

* feat: shared instances moderation frontend + hook up report flow

* fix: report copy

* fix: lint

* fix: lint

* fix: modrinth ids being undefined

* feat: instance quarantining

* fix: prepr + fmt

* fix: quarantined -> locked terminology

* fix: missing endpoint impls + fmt

* fix: missing api in build.rs

* fix: share tab jittery

* fix: fmt

*PT bug

* fix: invites count as users even if pending

* fix: prepr

* fix: invite page owner in users list

* fix: lint

* fix: qa

* fix: lint

* fix: members stale not clearing

* fix: invite use joined_at field

* fix: lint

* fix: qa

---------

Co-authored-by: sychic <47618543+Sychic@users.noreply.github.com>

apps/app-frontend/src/helpers/errors.ts

@@ -0,0 +1,11 @@
+export function toError(error: unknown) {
+	if (error instanceof Error) return error
+	if (typeof error === 'string') return new Error(error)
+	if (error && typeof error === 'object') {
+		const record = error as Record<string, unknown>
+		const message = record.message ?? record.error
+		if (typeof message === 'string') return new Error(message)
+		return new Error(JSON.stringify(error))
+	}
+	return new Error(String(error))
+}

apps/app-frontend/src/helpers/friends.ts

@@ -6,6 +6,8 @@ import dayjs from 'dayjs'
 import { get_user_many } from '@/helpers/cache'
 import type { ModrinthCredentials } from '@/helpers/mr_auth'
 
+export const friendsQueryKey = (userId?: string | null) => ['friends', userId ?? null] as const
+
 export type UserStatus = {
 	user_id: string
 	instance_name: string | null
@@ -46,6 +48,111 @@ export type FriendWithUserData = {
 	online: boolean
 	avatar: string
 }
+
+export type FriendCacheUser = {
+	id: string
+	username: string
+	avatarUrl?: string | null
+}
+
+export async function getFriendsWithUserData(
+	credentials: ModrinthCredentials | null,
+): Promise<FriendWithUserData[]> {
+	if (!credentials) return []
+
+	const friendsList = await friends()
+	return await transformFriends(friendsList, credentials)
+}
+
+export function createPendingFriend(
+	user: FriendCacheUser,
+	currentUserId?: string | null,
+): FriendWithUserData {
+	return {
+		id: user.id,
+		friend_id: currentUserId ?? null,
+		status: null,
+		last_updated: null,
+		created: dayjs(),
+		username: user.username,
+		accepted: false,
+		online: false,
+		avatar: user.avatarUrl ?? '',
+	}
+}
+
+export function getFriendUserId(
+	friend: Pick<FriendWithUserData, 'id' | 'friend_id'>,
+	currentUserId?: string | null,
+) {
+	return friend.id === currentUserId && friend.friend_id ? friend.friend_id : friend.id
+}
+
+export function matchesFriend(
+	friend: FriendWithUserData,
+	id: string,
+	username: string,
+	currentUserId?: string | null,
+) {
+	const friendId = getFriendUserId(friend, currentUserId)
+	return (
+		normalizeFriendKey(friendId) === normalizeFriendKey(id) ||
+		normalizeFriendKey(friend.username) === normalizeFriendKey(username)
+	)
+}
+
+export function upsertCachedFriend(
+	friends: FriendWithUserData[],
+	friend: FriendWithUserData,
+	currentUserId?: string | null,
+) {
+	const existingFriend = friends.find((cachedFriend) =>
+		matchesFriend(cachedFriend, friend.id, friend.username, currentUserId),
+	)
+
+	if (!existingFriend) return [friend, ...friends]
+
+	return friends.map((cachedFriend) =>
+		matchesFriend(cachedFriend, friend.id, friend.username, currentUserId)
+			? {
+					...cachedFriend,
+					...friend,
+					id: cachedFriend.id,
+					friend_id: cachedFriend.friend_id,
+				}
+			: cachedFriend,
+	)
+}
+
+export function acceptCachedFriend(
+	friends: FriendWithUserData[],
+	id: string,
+	username: string,
+	currentUserId?: string | null,
+) {
+	return friends.map((friend) =>
+		matchesFriend(friend, id, username, currentUserId)
+			? {
+					...friend,
+					accepted: true,
+				}
+			: friend,
+	)
+}
+
+export function removeCachedFriend(
+	friends: FriendWithUserData[],
+	id: string,
+	username: string,
+	currentUserId?: string | null,
+) {
+	return friends.filter((friend) => !matchesFriend(friend, id, username, currentUserId))
+}
+
+export function normalizeFriendKey(value: string) {
+	return value.trim().toLowerCase()
+}
+
 export async function transformFriends(
 	friends: UserFriend[],
 	credentials: ModrinthCredentials | null,

apps/app-frontend/src/helpers/install.ts

@@ -45,6 +45,92 @@ export interface InstallPostInstallEdit {
 	link?: InstanceLink | null
 }
 
+export interface SharedInstanceInstallPreview {
+	sharedInstanceId: string
+	version: number
+	name: string
+	iconUrl?: string | null
+	gameVersion: string
+	loader: InstanceLoader
+	modCount: number
+	externalFileCount: number
+	modpackVersionId?: string | null
+	contentVersionIds: string[]
+	externalFiles: SharedInstanceExternalFilePreview[]
+}
+
+export interface SharedInstanceInviteInstallPreview {
+	sharedInstanceId: string
+	managerId?: string | null
+	serverManagerName?: string | null
+	serverManagerIconUrl?: string | null
+	instanceIconUrl?: string | null
+	preview: SharedInstanceInstallPreview
+}
+
+export interface SharedInstanceExternalFilePreview {
+	fileName: string
+	fileType: string
+}
+
+export interface SharedInstanceUpdatePreview {
+	sharedInstanceId: string
+	currentVersion?: number | null
+	latestVersion: number
+	updateAvailable: boolean
+	diffs: SharedInstanceUpdateDiff[]
+}
+
+export interface SharedInstanceUpdateDiff {
+	type:
+		| 'added'
+		| 'removed'
+		| 'updated'
+		| 'modpack_linked'
+		| 'modpack_updated'
+		| 'modpack_unlinked'
+		| 'game_version_updated'
+		| 'loader_updated'
+		| 'config_files_updated'
+	projectId?: string | null
+	projectName?: string | null
+	fileName?: string | null
+	currentVersionName?: string | null
+	newVersionName?: string | null
+	configFileCount?: number | null
+	disabled?: boolean
+}
+
+export const SHARED_INSTANCE_UNAVAILABLE_ERROR_CODE = 'shared_instance_unavailable'
+
+export type SharedInstanceUnavailableReason = 'deleted' | 'access_revoked' | 'quarantined'
+
+function isRecord(value: unknown): value is Record<string, unknown> {
+	return typeof value === 'object' && value !== null
+}
+
+export function isSharedInstanceUnavailableError(error: unknown) {
+	return getSharedInstanceUnavailableReason(error) !== null
+}
+
+export function getSharedInstanceUnavailableReason(
+	error: unknown,
+): SharedInstanceUnavailableReason | null {
+	if (!isRecord(error) || error.code !== SHARED_INSTANCE_UNAVAILABLE_ERROR_CODE) return null
+	return error.reason === 'deleted' ||
+		error.reason === 'access_revoked' ||
+		error.reason === 'quarantined'
+		? error.reason
+		: null
+}
+
+export function getErrorMessage(error: unknown): string {
+	if (typeof error === 'string') return error
+	if (error instanceof Error) return error.message || 'Unknown error'
+	if (isRecord(error) && typeof error.message === 'string') return error.message
+	return 'Unknown error'
+}
+
 export type InstallJobStatus =
 	| 'queued'
 	| 'running'
@@ -90,6 +176,7 @@ export interface InstallErrorView {
 	code: string
 	phase?: InstallPhaseId | null
 	message: string
+	reason?: SharedInstanceUnavailableReason | null
 	api?: {
 		error: string
 		status?: number | null
@@ -122,6 +209,8 @@ export interface InstallJobSnapshot {
 	kind:
 		| 'create_instance'
 		| 'create_modpack_instance'
+		| 'create_shared_instance'
+		| 'update_shared_instance'
 		| 'import_instance'
 		| 'duplicate_instance'
 		| 'install_existing_instance'
@@ -172,6 +261,58 @@ export async function install_create_modpack_instance(
 	})
 }
 
+export async function install_get_shared_instance_preview(sharedInstanceId: string, name: string) {
+	return await invoke<SharedInstanceInstallPreview>(
+		'plugin:install|install_get_shared_instance_preview',
+		{
+			sharedInstanceId,
+			name,
+		},
+	)
+}
+
+export async function install_accept_shared_instance_invite(inviteId: string) {
+	return await invoke<SharedInstanceInviteInstallPreview>(
+		'plugin:install|install_accept_shared_instance_invite',
+		{
+			inviteId,
+		},
+	)
+}
+
+export async function install_get_shared_instance_update_preview(instanceId: string) {
+	return await invoke<SharedInstanceUpdatePreview | null>(
+		'plugin:install|install_get_shared_instance_update_preview',
+		{
+			instanceId,
+		},
+	)
+}
+
+export async function install_shared_instance(
+	sharedInstanceId: string,
+	name: string,
+	managerId?: string | null,
+	serverManagerName?: string | null,
+	serverManagerIconUrl?: string | null,
+	instanceIconUrl?: string | null,
+) {
+	return await invoke<InstallJobSnapshot>('plugin:install|install_shared_instance', {
+		sharedInstanceId,
+		name,
+		managerId,
+		serverManagerName,
+		serverManagerIconUrl,
+		instanceIconUrl,
+	})
+}
+
+export async function install_update_shared_instance(instanceId: string) {
+	return await invoke<InstallJobSnapshot>('plugin:install|install_update_shared_instance', {
+		instanceId,
+	})
+}
+
 export async function install_import_instance(
 	launcherType: string,
 	basePath: string,
@@ -249,7 +390,8 @@ export function isInstallJobFinished(status: InstallJobStatus) {
 function settleInstallJob(job: InstallJobSnapshot) {
 	if (job.status === 'succeeded') return job
 
-	throw new Error(job.error?.message ?? `Install job ${job.job_id} ${job.status}`)
+	if (job.error) throw job.error
+	throw new Error(`Install job ${job.job_id} ${job.status}`)
 }
 
 export async function wait_for_install_job(jobId: string) {

apps/app-frontend/src/helpers/instance.ts

@@ -7,13 +7,14 @@ import type { Labrinth } from '@modrinth/api-client'
 import type { ContentItem, ContentOwner } from '@modrinth/ui'
 import { invoke } from '@tauri-apps/api/core'
 
-import type { InstallJobSnapshot } from './install'
+import type { InstallJobSnapshot, SharedInstanceUpdateDiff } from './install'
 import type {
 	CacheBehaviour,
 	ContentFile,
 	ContentFileProjectType,
 	GameInstance,
 	InstanceLoader,
+	SharedInstanceAttachment,
 } from './types'
 
 export async function remove(instanceId: string): Promise<void> {
@@ -335,3 +336,93 @@ export async function edit(instanceId: string, editInstance: Partial<GameInstanc
 export async function edit_icon(instanceId: string, iconPath: string | null): Promise<void> {
 	return await invoke('plugin:instance|instance_edit_icon', { instanceId, iconPath })
 }
+
+export type SharedInstanceUsers = {
+	user_ids: string[]
+	users: SharedInstanceUser[]
+	tokens: number
+}
+
+export type SharedInstanceJoinType = 'owner' | 'invite' | 'link'
+
+export type SharedInstanceUser = {
+	id: string
+	joined_at?: string | null
+	join_type: SharedInstanceJoinType
+	last_played?: string | null
+}
+
+export interface SharedInstancePublishPreview {
+	sharedInstanceId: string
+	latestVersion: number
+	diffs: SharedInstanceUpdateDiff[]
+	configFiles: string[]
+}
+
+export interface SharedInstanceInviteLink {
+	inviteId: string
+	expiresAt: string
+	maxUses: number
+}
+
+export async function can_current_user_use_shared_instances(): Promise<boolean> {
+	return await invoke('plugin:instance|instance_share_can_current_user_use')
+}
+
+export async function get_shared_instance_users(instanceId: string): Promise<SharedInstanceUsers> {
+	return await invoke('plugin:instance|instance_share_get_users', { instanceId })
+}
+
+export async function invite_shared_instance_users(
+	instanceId: string,
+	userIds: string[],
+): Promise<SharedInstanceUsers> {
+	return await invoke('plugin:instance|instance_share_invite_users', { instanceId, userIds })
+}
+
+export async function create_shared_instance_invite_link(
+	instanceId: string,
+	options: {
+		maxAgeSeconds?: number
+		maxUses?: number
+		replaceInviteId?: string
+	} = {},
+): Promise<SharedInstanceInviteLink> {
+	return await invoke('plugin:instance|instance_share_create_invite_link', {
+		instanceId,
+		...options,
+	})
+}
+
+export async function remove_shared_instance_users(
+	instanceId: string,
+	userIds: string[],
+	hasPendingRecipients: boolean,
+): Promise<SharedInstanceUsers> {
+	return await invoke('plugin:instance|instance_share_remove_users', {
+		instanceId,
+		userIds,
+		hasPendingRecipients,
+	})
+}
+
+export async function get_shared_instance_publish_preview(
+	instanceId: string,
+): Promise<SharedInstancePublishPreview | null> {
+	return await invoke('plugin:instance|instance_share_get_publish_preview', { instanceId })
+}
+
+export async function publish_shared_instance(
+	instanceId: string,
+	configPaths: string[],
+): Promise<SharedInstanceAttachment> {
+	return await invoke('plugin:instance|instance_share_publish', { instanceId, configPaths })
+}
+
+export async function unlink_shared_instance(instanceId: string): Promise<void> {
+	return await invoke('plugin:instance|instance_share_unlink', { instanceId })
+}
+
+export async function unpublish_shared_instance(instanceId: string): Promise<void> {
+	return await invoke('plugin:instance|instance_share_unpublish', { instanceId })
+}

apps/app-frontend/src/helpers/mr_auth.ts

@@ -12,8 +12,10 @@ export type ModrinthCredentials = {
 	active: boolean
 }
 
-export async function login(): Promise<ModrinthCredentials> {
-	return await invoke('plugin:mr-auth|modrinth_login')
+export type ModrinthAuthFlow = 'sign-in' | 'sign-up'
+
+export async function login(flow: ModrinthAuthFlow = 'sign-in'): Promise<ModrinthCredentials> {
+	return await invoke('plugin:mr-auth|modrinth_login', { flow })
 }
 
 export async function logout(): Promise<void> {

apps/app-frontend/src/helpers/reports.ts

@@ -0,0 +1,19 @@
+import { invoke } from '@tauri-apps/api/core'
+
+export type ReportItemType = 'project' | 'version' | 'user' | 'shared-instance'
+
+export interface CreateReportRequest {
+	report_type: string
+	item_id: string
+	item_type: ReportItemType
+	body: string
+	uploaded_images: string[]
+}
+
+export interface CreateReportResponse {
+	id: string
+}
+
+export async function create_report(request: CreateReportRequest) {
+	return await invoke<CreateReportResponse>('plugin:reports|reports_create', { request })
+}

apps/app-frontend/src/helpers/shared-instance-errors.ts

@@ -0,0 +1,98 @@
+import { defineMessages, injectNotificationManager, useVIntl } from '@modrinth/ui'
+
+import { getErrorMessage, type SharedInstanceUnavailableReason } from '@/helpers/install'
+
+export const sharedInstanceErrorMessages = defineMessages({
+	unavailableTitle: {
+		id: 'instance.shared-instance.unavailable.title',
+		defaultMessage: 'Shared instance no longer available',
+	},
+	lockedTitle: {
+		id: 'instance.shared-instance.unavailable.locked-title',
+		defaultMessage: 'Instance locked',
+	},
+	unavailableText: {
+		id: 'instance.shared-instance.unavailable.text',
+		defaultMessage:
+			"Your local instance is still available, but it is no longer linked and won't receive updates.",
+	},
+	deletedText: {
+		id: 'instance.shared-instance.unavailable.deleted-text',
+		defaultMessage:
+			'The primary instance was deleted. This instance is still available, but it is no longer linked and will no longer receive updates.',
+	},
+	accessRevokedText: {
+		id: 'instance.shared-instance.unavailable.access-revoked-text',
+		defaultMessage:
+			'Your access to the shared instance was revoked. This instance is still available, but it is no longer linked and will no longer receive updates.',
+	},
+	lockedText: {
+		id: 'instance.shared-instance.unavailable.locked-text',
+		defaultMessage:
+			'This shared instance was locked by the Content Moderation team. It will no longer receive updates from the primary instance and cannot be played.',
+	},
+	unavailableFallbackManager: {
+		id: 'instance.shared-instance.unavailable.manager-fallback',
+		defaultMessage: 'the instance manager',
+	},
+	errorTitle: {
+		id: 'instance.shared-instance.error.title',
+		defaultMessage: 'Something has gone wrong',
+	},
+})
+
+export function sharedInstanceUnavailableTextMessage(
+	reason: SharedInstanceUnavailableReason | null,
+) {
+	if (reason === 'deleted') return sharedInstanceErrorMessages.deletedText
+	if (reason === 'access_revoked') return sharedInstanceErrorMessages.accessRevokedText
+	if (reason === 'quarantined') return sharedInstanceErrorMessages.lockedText
+	return sharedInstanceErrorMessages.unavailableText
+}
+
+export function sharedInstanceUnavailableTitleMessage(
+	reason: SharedInstanceUnavailableReason | null,
+) {
+	return reason === 'quarantined'
+		? sharedInstanceErrorMessages.lockedTitle
+		: sharedInstanceErrorMessages.unavailableTitle
+}
+
+export function useSharedInstanceErrors() {
+	const { formatMessage } = useVIntl()
+	const { addNotification } = injectNotificationManager()
+
+	function formatSharedInstanceUnavailable(
+		reason: SharedInstanceUnavailableReason | null = null,
+		manager?: string | null,
+	) {
+		return formatMessage(sharedInstanceUnavailableTextMessage(reason), {
+			manager: manager || formatMessage(sharedInstanceErrorMessages.unavailableFallbackManager),
+		})
+	}
+
+	function notifySharedInstanceUnavailable(
+		reason: SharedInstanceUnavailableReason | null = null,
+		manager?: string | null,
+	) {
+		addNotification({
+			type: 'warning',
+			title: formatMessage(sharedInstanceUnavailableTitleMessage(reason)),
+			text: formatSharedInstanceUnavailable(reason, manager),
+		})
+	}
+
+	function notifySharedInstanceError(error: unknown) {
+		addNotification({
+			type: 'error',
+			title: formatMessage(sharedInstanceErrorMessages.errorTitle),
+			text: getErrorMessage(error),
+		})
+	}
+
+	return {
+		formatSharedInstanceUnavailable,
+		notifySharedInstanceError,
+		notifySharedInstanceUnavailable,
+	}
+}

apps/app-frontend/src/helpers/types.d.ts

@@ -17,6 +17,8 @@ export type GameInstance = {
 	groups: string[]
 
 	link?: InstanceLink | null
+	shared_instance?: SharedInstanceAttachment | null
+	quarantined: boolean
 	update_channel: ReleaseChannel
 
 	created: Date
@@ -86,18 +88,47 @@ export type InstanceLink = InstanceLinkIdentity &
 		  }
 		| {
 				type: 'shared_instance'
-				shared_instance_id: string
+				modpack_project_id?: ModrinthId | null
+				modpack_version_id?: ModrinthId | null
 		  }
 	)
 
+export type SharedInstanceAttachment = {
+	id: string
+	role: 'owner' | 'member'
+	manager_id?: string | null
+	server_manager_name?: string | null
+	server_manager_icon_url?: string | null
+	linked_user_id?: string | null
+	status:
+		| 'unknown'
+		| 'up_to_date'
+		| 'update_available'
+		| 'applying'
+		| 'stale'
+		| 'not_ready'
+		| 'error'
+	applied_version?: number | null
+	latest_version?: number | null
+}
+
 export type Instance = GameInstance
 
 type ReleaseChannel = 'release' | 'beta' | 'alpha'
 
 export type InstanceLoader = 'vanilla' | 'forge' | 'fabric' | 'quilt' | 'neoforge'
 
+export type ContentSourceKind =
+	| 'local'
+	| 'modrinth_modpack'
+	| 'server_project'
+	| 'modrinth_hosting'
+	| 'imported_modpack'
+	| 'shared_instance'
+
 type ContentFile = {
 	enabled: boolean
+	source_kind?: ContentSourceKind | null
 	metadata?: {
 		project_id: string
 		version_id: string

apps/app-frontend/src/helpers/users.ts

@@ -0,0 +1,11 @@
+import { invoke } from '@tauri-apps/api/core'
+
+export type SearchUser = {
+	id: string
+	username: string
+	avatar_url: string | null
+}
+
+export async function search_user(query: string): Promise<SearchUser[]> {
+	return await invoke<SearchUser[]>('plugin:users|search_user', { query })
+}