Error Handling، Transport داخلی، Paging و Lifecycle فرم

44. رفتار خطا در Helper جاری

در نسخه فعلی بررسی‌شده اگر Response JSON دارای:

HasError === true

باشد، Helper:

1. MessageException را برای نمایش آماده می‌کند؛
2. toast.showResult(result) را اجرا می‌کند؛
3. Promise را Reject می‌کند.

الگوی پیشنهادی برای همین Build:

absoluteMethodHelper
    .runProvider(PROVIDER_ID)
    .then(result => {
        // success
    })
    .catch(error => {
        // GraphBPMS error or network error
        console.error(error);
    });

45. تفاوت با نمونه‌های قدیمی Wiki

در بعضی نمونه‌های Wiki الگوی زیر دیده می‌شود:

absoluteMethodHelper
    .runProvider(...)
    .then(result => {
        if (result.HasError) {
            toast.showResult(result);
            return;
        }
    });

اما Helper فعلی ارسالی HasError را Reject می‌کند.

برای پروژه Legacy رفتار Helper همان نسخه کنترل شود؛ برای Build جاری ارسالی، .catch جزو الگوی استاندارد است.

46. چه چیزهایی را runProvider خودش انجام می‌دهد؟

Helper خودش:

• درخواست را به /Provider/RunProvider می‌فرستد؛
• Anti-forgery Token را از صفحه دریافت و در Header قرار می‌دهد؛
• برای Request معمولی JSON می‌فرستد؛
• برای Request دارای File از FormData استفاده می‌کند؛
• Attachment Response را به File تبدیل می‌کند؛
• خطای GraphBPMS را Reject می‌کند.

نتیجه

در Custom JS مستقیماً Endpoint داخلی را با fetch یا $.ajax فراخوانی نکنید، مگر API رسمی دیگری برای همان Build مستند شده باشد. API استانداردتر:

absoluteMethodHelper.runProvider(...)

است.

47. providerDesigner.runProviderPaging

نمونه JavaScript تولیدشده توسط Provider Details برای Providerهای Paging از:

providerDesigner.runProviderPaging(...)

استفاده می‌کند.

امضای مشاهده‌شده:

providerDesigner.runProviderPaging(
    providerId,
    parameters,
    pageIndex,
    pageSize,
    pagingMainFilter,
    pagingFilters,
    pagingOrders
)

نمونه:

providerDesigner
    .runProviderPaging(
        PROVIDER_ID,
        null,
        0,
        10,
        '',
        [
            {
                name: 'UserName',
                value: ''
            }
        ],
        [
            {
                name: 'UserName',
                value: 'asc'
            }
        ]
    )
    .then(result => {
        console.log(result);
    })
    .catch(error => {
        console.warn(error);
    });

نکته مهم

runProviderPaging در فایل absoluteMethodHelper.js فعلی مشاهده نشد.

Non-Paging Provider
    → absoluteMethodHelper.runProvider

Paging Provider
    → providerDesigner.runProviderPaging
       در Sample Generator فعلی محصول

این دو API را یکی نکنید.

48. Mapping پارامترهای Paging

اگر Provider با PagingUseParameters تنظیم شده باشد، UI فعلی پارامترهای Paging را از لیست پارامترهای عادی جدا می‌کند و از آرگومان‌های Paging مقداردهی می‌کند تا Parameter دوبار ارسال نشود.

49. اجرای Provider در onLoad

export const onLoad = function (viewModel) {
    absoluteMethodHelper
        .runProvider(PROVIDER_ID)
        .then(result => {
            const rows =
                JSON.parse(
                    result.Content.providerResult || '[]'
                );

            // Use rows
        })
        .catch(error => {
            console.error(error);
        });
};

کاربرد:

• دریافت داده اولیه؛
• بررسی وضعیت؛
• دریافت تنظیمات؛
• Load یک منبع خارجی.

50. اجرای Provider قبل از Submit

اگر نتیجه Provider باید تعیین کند فرم ارسال شود یا نه:

export const beforeSubmit = function (viewModel) {
    return absoluteMethodHelper
        .runProvider(
            PROVIDER_ID,
            [
                {
                    name: 'Code',
                    value: viewModel.data().Code()
                }
            ]
        )
        .then(result => {
            const rows =
                JSON.parse(
                    result.Content.providerResult || '[]'
                );

            if (
                rows.length > 0 &&
                rows[0].IsExists
            ) {
                toast.show(
                    'error',
                    'این مقدار قبلاً ثبت شده است'
                );

                return false;
            }

            return true;
        })
        .catch(error => {
            console.error(error);
            return false;
        });
};

این الگو با Lifecycle Promise-based فرم سازگار است.

export const onSubmitSuccess = function (viewModel) {
    absoluteMethodHelper
        .runProvider(
            PROVIDER_ID,
            [
                {
                    name: 'RecordId',
                    value: viewModel.data().Id()
                }
            ]
        )
        .then(result => {
            console.log(result);
        })
        .catch(error => {
            console.error(error);
        });
};