ktmud commented on a change in pull request #13305: URL: https://github.com/apache/superset/pull/13305#discussion_r583100797
########## File path: superset-frontend/src/components/OmniContainer/getDashboards.ts ########## @@ -0,0 +1,55 @@ +/** + * 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. + */ + +import { t, SupersetClient } from '@superset-ui/core'; +import to from 'await-to-js'; + +interface DashboardItem { + changed_by_name: string; + changed_on: string; + creator: string; + dashboard_link: string; + dashboard_title: string; + id: number; + modified: string; + url: string; +} + +interface Dashboards extends DashboardItem { + title: string; +} + +export const getDashboards = async ( + query: string, +): Promise<(Dashboards | { title: string })[]> => { + // todo: Build a dedicated endpoint for dashboard searching + // i.e. superset/v1/api/dashboards?q=${query} + const [error, response] = await to( + SupersetClient.get({ + endpoint: `/dashboardasync/api/read?_oc_DashboardModelViewAsync=changed_on&_od_DashboardModelViewAsync=desc&_flt_2_dashboard_title=${query}`, + }), + ); + if (error) { + return [{ title: t('An error occurred while fetching dashboards') }]; + } Review comment: Let's try not to add a new dependency. Try/catch is universal and easy enough, IMO. It seems all this library does it transforming error handling into another style which not all developers are familiar with. It takes some cognitive load understand what this library does, even it's something dead simple---people would wonder, sure, this seems to handle errors from a promise, but does it do anything extra? In the future, all async API requests and error handling may be abstracted away by the [`useResource`](https://github.com/apache/superset/pull/13218) hook @suddjian is working on so this is probably even more unnecessary. Even right now, [`makeApi`](https://github.com/apache-superset/superset-ui/blob/482da217938bcbd70db8b79117abacf00f8037e2/packages/superset-ui-core/test/query/api/v1/makeApi.test.ts#L170-L187) has already made it easy to handle response errors (it ensures erroring HTTP status code and errors in response body always throw and capturable by `try/catch`). ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
