Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Реализовать compositionProviderEngine (движок провайдера которы позволит делать композицию) #403

Open
bonkalol opened this issue Apr 4, 2024 · 2 comments

Comments

@bonkalol
Copy link
Member

bonkalol commented Apr 4, 2024

Пример:

export class CompositionProviderTest extends Super {
	static override request: typeof Super.request = Super.request({
		engine: providerCompositionEngine([
			{
				request: (_, params) => new Banners().get(Object.get(params, 'opts.query.bannersQuery')),
				writeResultInto: 'banners'
			},
			{
				request: (_, params) => new Cards().get(Object.get(params, 'opts.query.contentQuery')),
				writeResultInto: 'content'
			}
		])
	});
}

Драфт интерфейса (обсуждаемо)

export interface CompositionProvider {
	/**
	 * Запрос который необходимо выполнить.
	 *
	 * @param options
	 * @param params
	 */
	request(options: RequestOptions, params: MiddlewareParams): Promise<RequestResponseObject>;

	/**
	 * В какие поля результирующего объекта будет записан ответ данного запроса.
	 */
	writeResultInto: string;

	/**
	 * Если функция вернула false, то запрос не будет создан.
	 *
	 * Если функция вернула promise, то будет выполнено ожидание разрешения этого промиса,
	 * и в случае если он разрешится с false, запрос не будет создан.
	 *
	 * @param options
	 * @param params
	 */
	requestFilter?(options: RequestOptions, params: MiddlewareParams): CanPromise<boolean>;

	/**
	 * Если true, то при ошибки данного запроса будет сбой всей композиции.
	 */
	failCompositionOnError?: boolean;
}

Зачем?

У extraProviders есть ряд недостатков, в том числе отсутствует необходимая гибкость при создании композиций. А такой простой функционал, как движок для композиции провайдеров, даёт хорошую гибкость и позволяет реализовать как сложные, так и простые сценарии.

@bonkalol
Copy link
Member Author

bonkalol commented Apr 4, 2024

за базовой имплементацией приходите к @bonkalol , она у меня есть, от нее можно отталкиваться или вообще взять ее и просто перенести в клиент

@bonkalol bonkalol transferred this issue from V4Fire/Client Apr 5, 2024
@bonkalol bonkalol pinned this issue Apr 5, 2024
@bonkalol bonkalol unpinned this issue Apr 5, 2024
@kobezzza
Copy link
Contributor

kobezzza commented Apr 5, 2024

Тут нужно учесть пару нюансов:

  1. У нас в провайдер сейчас приходит объект стейта и ИД. Если просто делать создание дата провайдера, то это сломается. В идеале нужно сделать хэлпер по типу https://github.com/V4Fire/Client/blob/v4-new-init/src/components/super/i-block/providers/index.ts#L299
export class CompositionProviderTest extends Super {
	static override request: typeof Super.request = Super.request({
		engine: providerCompositionEngine([
			{
				request: (_, params, {createDataProviderInstance}) => createDataProviderInstance(Banners).get(Object.get(params, 'opts.query.bannersQuery')),
				writeResultInto: 'banners'
			}
		])
	});
}
  1. Надо поддержать на уровне движка методы dropCache и destroy как вот тут https://github.com/V4Fire/Core/blob/v4/src/core/request/engines/provider/index.ts#L71

  2. writeResultInto предлагаю заменить на as

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants