ktmud commented on code in PR #19942: URL: https://github.com/apache/superset/pull/19942#discussion_r864486705
########## superset-frontend/src/reports/types.ts: ########## @@ -0,0 +1,29 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +/** + * Types mirroring enums in `superset/reports/models.py`: + */ +export type ReportScheduleType = 'Alert' | 'Report'; Review Comment: TODO: update `views/CURD/alert/types.ts` to use these types ########## superset-frontend/src/utils/getClientErrorObject.ts: ########## @@ -68,78 +74,95 @@ export function parseErrorJson(responseObject: JsonObject): ClientErrorObject { } export function getClientErrorObject( - response: SupersetClientResponse | ResponseWithTimeout | string, + response: + | SupersetClientResponse + | TimeoutError + | { response: Response } + | string, ): Promise<ClientErrorObject> { // takes a SupersetClientResponse as input, attempts to read response as Json if possible, // and returns a Promise that resolves to a plain object with error key and text value. return new Promise(resolve => { if (typeof response === 'string') { resolve({ error: response }); - } else { - const responseObject = - response instanceof Response ? response : response.response; - if (responseObject && !responseObject.bodyUsed) { - // attempt to read the body as json, and fallback to text. we must clone the - // response in order to fallback to .text() because Response is single-read - responseObject - .clone() - .json() - .then(errorJson => { - const error = { ...responseObject, ...errorJson }; - resolve(parseErrorJson(error)); - }) - .catch(() => { - // fall back to reading as text - responseObject.text().then((errorText: any) => { - resolve({ ...responseObject, error: errorText }); - }); - }); - } else if ( - 'statusText' in response && - response.statusText === 'timeout' && - 'timeout' in response - ) { - resolve({ - ...responseObject, - error: 'Request timed out', - errors: [ - { - error_type: ErrorTypeEnum.FRONTEND_TIMEOUT_ERROR, - extra: { - timeout: response.timeout / 1000, - issue_codes: [ - { - code: 1000, - message: t( - 'Issue 1000 - The dataset is too large to query.', - ), - }, - { - code: 1001, - message: t( - 'Issue 1001 - The database is under an unusual load.', - ), - }, - ], - }, - level: 'error', - message: 'Request timed out', + return; Review Comment: Early return to reduce indentation. ########## superset/reports/dao.py: ########## @@ -133,23 +134,24 @@ def validate_unique_creation_method( @staticmethod def validate_update_uniqueness( - name: str, report_type: str, report_schedule_id: Optional[int] = None + name: str, report_type: ReportScheduleType, expect_id: Optional[int] = None Review Comment: Just rename the variable to make it easier to understand... ########## superset-frontend/src/utils/getClientErrorObject.ts: ########## @@ -68,78 +74,95 @@ export function parseErrorJson(responseObject: JsonObject): ClientErrorObject { } export function getClientErrorObject( - response: SupersetClientResponse | ResponseWithTimeout | string, + response: + | SupersetClientResponse + | TimeoutError + | { response: Response } + | string, ): Promise<ClientErrorObject> { // takes a SupersetClientResponse as input, attempts to read response as Json if possible, // and returns a Promise that resolves to a plain object with error key and text value. return new Promise(resolve => { if (typeof response === 'string') { resolve({ error: response }); - } else { - const responseObject = - response instanceof Response ? response : response.response; - if (responseObject && !responseObject.bodyUsed) { - // attempt to read the body as json, and fallback to text. we must clone the - // response in order to fallback to .text() because Response is single-read - responseObject - .clone() - .json() - .then(errorJson => { - const error = { ...responseObject, ...errorJson }; - resolve(parseErrorJson(error)); - }) - .catch(() => { - // fall back to reading as text - responseObject.text().then((errorText: any) => { - resolve({ ...responseObject, error: errorText }); - }); - }); - } else if ( - 'statusText' in response && - response.statusText === 'timeout' && - 'timeout' in response - ) { - resolve({ - ...responseObject, - error: 'Request timed out', - errors: [ - { - error_type: ErrorTypeEnum.FRONTEND_TIMEOUT_ERROR, - extra: { - timeout: response.timeout / 1000, - issue_codes: [ - { - code: 1000, - message: t( - 'Issue 1000 - The dataset is too large to query.', - ), - }, - { - code: 1001, - message: t( - 'Issue 1001 - The database is under an unusual load.', - ), - }, - ], - }, - level: 'error', - message: 'Request timed out', + return; + } + + if ( + response instanceof TypeError && + response.message === 'Failed to fetch' + ) { + resolve({ + error: t('Network error'), + }); + return; + } + + if ( + 'timeout' in response && + 'statusText' in response && + response.statusText === 'timeout' + ) { + resolve({ + ...response, + error: t('Request timed out'), + errors: [ + { + error_type: ErrorTypeEnum.FRONTEND_TIMEOUT_ERROR, + extra: { + timeout: response.timeout / 1000, + issue_codes: [ + { + code: 1000, + message: t('Issue 1000 - The dataset is too large to query.'), + }, Review Comment: TODO: timeout can happen in other API endpoints as well. We should probably move these error codes out of this generic helper function. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
