Skip to content
Open
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import React from 'react';
import { createContextUtilities } from '@aws-amplify/ui-react-core';
import { DEFAULT_ACTION_CONCURRENCY } from '../useAction/constants';

export interface ConcurrencyConfig {
concurrency: number;
}

const ERROR_MESSAGE =
'`useConcurrencyConfig` must be called from within a `ConcurrencyConfigProvider`.';

export const { useConcurrencyConfig, ConcurrencyConfigContext } =
createContextUtilities<ConcurrencyConfig>({
contextName: 'ConcurrencyConfig',
errorMessage: ERROR_MESSAGE,
});

export interface ConcurrencyConfigProviderProps {
children?: React.ReactNode;
concurrency?: number;
}

export function ConcurrencyConfigProvider({
children,
concurrency,
}: ConcurrencyConfigProviderProps): React.JSX.Element {
const value = React.useMemo(
() => ({ concurrency: concurrency ?? DEFAULT_ACTION_CONCURRENCY }),
[concurrency]
);

return (
<ConcurrencyConfigContext.Provider value={value}>
{children}
</ConcurrencyConfigContext.Provider>
);
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,8 @@ export {
PaginationConfigProvider,
} from './paginationContext';
export type { PaginationConfig } from './paginationContext';
export {
useConcurrencyConfig,
ConcurrencyConfigProvider,
} from './concurrencyContext';
export type { ConcurrencyConfig } from './concurrencyContext';
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import {
import {
createConfigurationProvider,
PaginationConfigProvider,
ConcurrencyConfigProvider,
} from '../configuration';
import { DisplayTextProvider } from '../displayText';
import { defaultValidateFile, FileItemsProvider } from '../fileItems';
Expand Down Expand Up @@ -77,7 +78,7 @@ export default function createProvider<
...components,
};

const { validateFile = defaultValidateFile } = options ?? {};
const { validateFile = defaultValidateFile, concurrency } = options ?? {};

/**
* Provides state, configuration and action values that are shared between
Expand All @@ -94,25 +95,27 @@ export default function createProvider<
<StoreProvider {...props}>
<ConfigurationProvider>
<PaginationConfigProvider pageSize={pageSize}>
<ActionConfigsProvider actionConfigs={actionConfigs}>
<ActionHandlersProvider handlers={handlers}>
<DisplayTextProvider displayText={displayText}>
<ViewsProvider actions={resolvedActions} views={views}>
<ComponentsProvider composables={composables}>
<LocationItemsProvider>
<FileItemsProvider validateFile={validateFile}>
<FilePreviewProvider<TResolver>
filePreview={filePreview}
>
{children}
</FilePreviewProvider>
</FileItemsProvider>
</LocationItemsProvider>
</ComponentsProvider>
</ViewsProvider>
</DisplayTextProvider>
</ActionHandlersProvider>
</ActionConfigsProvider>
<ConcurrencyConfigProvider concurrency={concurrency}>
<ActionConfigsProvider actionConfigs={actionConfigs}>
<ActionHandlersProvider handlers={handlers}>
<DisplayTextProvider displayText={displayText}>
<ViewsProvider actions={resolvedActions} views={views}>
<ComponentsProvider composables={composables}>
<LocationItemsProvider>
<FileItemsProvider validateFile={validateFile}>
<FilePreviewProvider<TResolver>
filePreview={filePreview}
>
{children}
</FilePreviewProvider>
</FileItemsProvider>
</LocationItemsProvider>
</ComponentsProvider>
</ViewsProvider>
</DisplayTextProvider>
</ActionHandlersProvider>
</ActionConfigsProvider>
</ConcurrencyConfigProvider>
</PaginationConfigProvider>
</ConfigurationProvider>
</StoreProvider>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,21 @@ export interface StorageBrowserActions {
}

export interface StorageBrowserOptions {
/**
* @description Number of concurrent tasks to process for batch actions (upload, download, copy, delete)
* @default 4
* @example
* ```tsx
* const { StorageBrowser } = createStorageBrowser({
* config: managedAuthAdapter,
* options: {
* concurrency: 4,
* }
* });
* ```
*/
concurrency?: number;

/**
* @description Overrides default file validation called when selecting files to be uploaded
* @param {File} file — The file to validate
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { renderHook } from '@testing-library/react';

import { useGetActionInput } from '../../configuration';
import { useGetActionInput, useConcurrencyConfig } from '../../configuration';
import { useProcessTasks } from '../../tasks';

import { useHandler } from '../useHandler';
Expand All @@ -10,6 +10,7 @@ jest.mock('../../configuration');
jest.mock('../../tasks');

const useProcessTasksMock = jest.mocked(useProcessTasks);
const useConcurrencyConfigMock = jest.mocked(useConcurrencyConfig);

const config = {
accountId: '123456789012',
Expand All @@ -23,6 +24,10 @@ const useGetActionInputMock = jest
.mocked(useGetActionInput)
.mockReturnValue(getConfig);

useConcurrencyConfigMock.mockReturnValue({
concurrency: DEFAULT_ACTION_CONCURRENCY,
});

const handler = jest.fn();

const reset = jest.fn();
Expand Down Expand Up @@ -156,4 +161,27 @@ describe('useHandler', () => {
onTaskSuccess: input.onTaskSuccess,
});
});

it('uses global concurrency config from useConcurrencyConfig', () => {
const customConcurrency = 8;
useConcurrencyConfigMock.mockReturnValueOnce({
concurrency: customConcurrency,
});

useProcessTasksMock.mockReturnValueOnce([
mockBatchState,
mockUseProcessDispatch,
]);

const { result } = renderHook(() => useHandler(handler, { items: [] }));

const [, dispatch] = result.current;
dispatch();

expect(useConcurrencyConfigMock).toHaveBeenCalledTimes(1);
expect(mockUseProcessDispatch).toHaveBeenCalledWith({
config,
options: { concurrency: customConcurrency },
});
});
});
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import React from 'react';

import { useGetActionInput } from '../configuration';
import { DEFAULT_ACTION_CONCURRENCY } from './constants';
import { useGetActionInput, useConcurrencyConfig } from '../configuration';
import type { ActionHandler } from '../actions';
import type { Task } from '../tasks';
import { useProcessTasks } from '../tasks';
Expand Down Expand Up @@ -48,6 +47,7 @@ export function useHandler<
): HandleTasksState<TTask> | HandleTaskState<TTask> {
const [state, handleProcessing] = useProcessTasks(handler, options);
const getConfig = useGetActionInput();
const { concurrency } = useConcurrencyConfig();

const { reset, isProcessing, tasks, ...rest } = state;

Expand All @@ -64,10 +64,14 @@ export function useHandler<
...(hasData
? { data: input.data, all: [input.data] }
: // if no `data` provided, provide `concurrency` to `options`
{ options: { concurrency: DEFAULT_ACTION_CONCURRENCY } }),
{
options: {
concurrency,
},
}),
});
},
[getConfig, handleProcessing, reset]
[getConfig, handleProcessing, reset, concurrency]
);

if (isOptionsWithItems(options)) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ jest.mock('../../../../configuration', () => ({
// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
...(jest.requireActual('../../../../configuration') as object),
usePaginationConfig: () => ({ pageSize: 10 }),
useConcurrencyConfig: () => ({ concurrency: 4 }),
}));

const rootLocation: LocationData = {
Expand Down