mirror of
https://github.com/unraid/api.git
synced 2026-01-05 16:09:49 -06:00
5517e7506b
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Introduced full RClone remote management with creation, deletion, listing, and detailed remote info via a multi-step, schema-driven UI. - Added guided configuration forms supporting advanced and provider-specific options for RClone remotes. - Enabled flash backup initiation through API mutations. - Added new Vue components for RClone configuration, overview, remote item cards, and flash backup page. - Integrated new combobox, stepped layout, control wrapper, label renderer, and improved form renderers with enhanced validation and error display. - Added JSON Forms visibility composable and Unraid settings layout for consistent UI rendering. - **Bug Fixes** - Standardized JSON scalar usage in Docker-related types, replacing `JSONObject` with `JSON`. - **Chores** - Added utility scripts and helpers to manage rclone binary installation and versioning. - Updated build scripts and Storybook configuration for CSS handling and improved developer workflow. - Refactored ESLint config for modularity and enhanced code quality enforcement. - Improved component registration with runtime type checks and error handling. - **Documentation** - Added extensive test coverage for RClone API service, JSON Forms schema merging, and provider config slice generation. - **Style** - Improved UI consistency with new layouts, tooltips on select options, password visibility toggles, and error handling components. - Removed deprecated components and consolidated renderer registrations for JSON Forms. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
99 lines
3.1 KiB
TypeScript
99 lines
3.1 KiB
TypeScript
import { ApolloClient, ApolloLink, createHttpLink, from, split } from '@apollo/client/core/index.js';
|
|
import { onError } from '@apollo/client/link/error/index.js';
|
|
import { RetryLink } from '@apollo/client/link/retry/index.js';
|
|
import { GraphQLWsLink } from '@apollo/client/link/subscriptions/index.js';
|
|
import { getMainDefinition } from '@apollo/client/utilities/index.js';
|
|
import { provideApolloClient } from '@vue/apollo-composable';
|
|
import { createClient } from 'graphql-ws';
|
|
import { createApolloCache } from './apollo-cache';
|
|
import { WEBGUI_GRAPHQL } from './urls';
|
|
|
|
const httpEndpoint = WEBGUI_GRAPHQL;
|
|
const wsEndpoint = new URL(WEBGUI_GRAPHQL.toString().replace('http', 'ws'));
|
|
const DEV_MODE = (globalThis as unknown as { __DEV__: boolean }).__DEV__ ?? false;
|
|
|
|
const headers = {
|
|
'x-csrf-token': globalThis.csrf_token ?? '0000000000000000',
|
|
};
|
|
|
|
const httpLink = createHttpLink({
|
|
uri: httpEndpoint.toString(),
|
|
headers,
|
|
credentials: 'include',
|
|
});
|
|
|
|
const wsLink = new GraphQLWsLink(
|
|
createClient({
|
|
url: wsEndpoint.toString(),
|
|
connectionParams: () => headers,
|
|
})
|
|
);
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
const errorLink = onError(({ graphQLErrors, networkError }: any) => {
|
|
if (graphQLErrors) {
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
graphQLErrors.map((error: any) => {
|
|
console.error('[GraphQL error]', error);
|
|
const errorMsg = error.error?.message ?? error.message;
|
|
if (errorMsg?.includes('offline')) {
|
|
// @todo restart the api, but make sure not to trigger infinite loop
|
|
}
|
|
return error.message;
|
|
});
|
|
}
|
|
|
|
if (networkError) {
|
|
console.error(`[Network error]: ${networkError}`);
|
|
const msg = networkError.message ? networkError.message : networkError;
|
|
if (typeof msg === 'string' && msg.includes('Unexpected token < in JSON at position 0')) {
|
|
return 'Unraid API • CORS Error';
|
|
}
|
|
return msg;
|
|
}
|
|
});
|
|
|
|
const retryLink = new RetryLink({
|
|
attempts: {
|
|
max: 20,
|
|
retryIf: (error, _operation) => {
|
|
return Boolean(error);
|
|
},
|
|
},
|
|
delay: {
|
|
initial: 300,
|
|
max: 10000,
|
|
jitter: true,
|
|
},
|
|
});
|
|
|
|
// Disable Apollo Client if not in DEV Mode and server state says unraid-api is not running
|
|
const disableQueryLink = new ApolloLink((operation, forward) => {
|
|
if (!DEV_MODE && operation.getContext().serverState?.unraidApi?.status === 'offline') {
|
|
return null;
|
|
}
|
|
return forward(operation);
|
|
});
|
|
|
|
const splitLinks = split(
|
|
({ query }) => {
|
|
const definition = getMainDefinition(query);
|
|
return definition.kind === 'OperationDefinition' && definition.operation === 'subscription';
|
|
},
|
|
wsLink,
|
|
httpLink
|
|
);
|
|
|
|
/**
|
|
* @todo as we add retries, determine which we'll need
|
|
* https://www.apollographql.com/docs/react/api/link/introduction/#additive-composition
|
|
* https://www.apollographql.com/docs/react/api/link/introduction/#directional-composition
|
|
*/
|
|
const additiveLink = from([errorLink, retryLink, disableQueryLink, splitLinks]);
|
|
|
|
export const client = new ApolloClient({
|
|
link: additiveLink,
|
|
cache: createApolloCache(),
|
|
});
|
|
|
|
provideApolloClient(client); |