feat(presto-client): include get query metadata method (#20)

Author: alonsovb

apps/nest-server/README.md

@@ -1,6 +1,6 @@
 # NestJS Application
 
-This application was generated using [Nx](https://nx.dev).
+This is an example application to showcase how to use the Presto JS Client. Look at the app service file (src/app/app.service.ts) to see how to use the client for several different operations, and how to handle the results as well as the errors.
 
 ## Running the Application
 

apps/nest-server/src/app/app.controller.ts

@@ -1,4 +1,4 @@
-import { Controller, Get, Param } from '@nestjs/common'
+import { Controller, Get, Query } from '@nestjs/common'
 
 import { AppService } from './app.service'
 
@@ -7,7 +7,7 @@ export class AppController {
   constructor(private readonly appService: AppService) {}
 
   @Get('get-schemas')
-  async getSchemas(@Param('catalog') catalog: string) {
+  async getSchemas(@Query('catalog') catalog: string) {
     try {
       return await this.appService.getSchemas(catalog)
     } catch (err) {
@@ -33,6 +33,15 @@ export class AppController {
     }
   }
 
+  @Get('get-query-info')
+  async getQueryInfo(@Query('queryId') queryId: string) {
+    try {
+      return await this.appService.getQueryInfo(queryId)
+    } catch (err) {
+      console.error(err)
+    }
+  }
+
   @Get('presto-error')
   async getDataWithError() {
     try {

apps/nest-server/src/app/app.service.ts

@@ -1,5 +1,5 @@
 import { Injectable } from '@nestjs/common'
-import PrestoClient, { PrestoClientConfig, PrestoError } from '@prestodb/presto-js-client'
+import PrestoClient, { PrestoClientConfig, PrestoError, QueryInfo } from '@prestodb/presto-js-client'
 
 @Injectable()
 export class AppService {
@@ -54,6 +54,20 @@ export class AppService {
     }
   }
 
+  async getQueryInfo(queryId: string): Promise<QueryInfo | undefined> {
+    const clientParams: PrestoClientConfig = {
+      host: 'http://localhost',
+      port: 8080,
+      user: 'root',
+    }
+    const client = new PrestoClient(clientParams)
+    try {
+      return await client.getQueryInfo(queryId)
+    } catch (error) {
+      console.error(error.message)
+    }
+  }
+
   async getDataWithError(): Promise<unknown> {
     const clientParams: PrestoClientConfig = {
       catalog: 'tpch',

presto-client/README.md

@@ -103,6 +103,23 @@ Additional notes
 - The `query` method will automatically retry the query if it fails due to a transient error.
 - The `query` method will cancel the query if the client is destroyed.
 
+## Get Query metadata information
+
+### Get Query Information
+
+The `getQueryInfo` method retrieves comprehensive information about a specific query, based on its identifier. It returns metadata including status, execution details, statistics, and more, encapsulated within a `QueryInfo` object or undefined if the query does not exist.
+
+#### Parameters
+
+- `queryId`: The unique identifier string of the query for which information is being retrieved.
+
+#### Example usage
+
+```typescript
+const queryInfo = await prestoClient.getQueryInfo('your_query_id')
+console.log(queryInfo)
+```
+
 ## Query catalog, schema, table and column metadata
 
 ### Get Catalogs

presto-client/src/client.ts

@@ -1,5 +1,13 @@
-import { PrestoClientConfig, PrestoError, PrestoQuery, PrestoResponse } from './client.types'
-import { Column, Table } from './information-schema.types'
+import { QUERY_INFO_URL, STATEMENT_URL } from './constants'
+import {
+  Column,
+  PrestoClientConfig,
+  PrestoError,
+  PrestoQuery,
+  PrestoResponse,
+  QueryInfo,
+  Table,
+} from './types'
 
 export class PrestoClient {
   private baseUrl: string
@@ -42,7 +50,7 @@ export class PrestoClient {
     timezone,
     user,
   }: PrestoClientConfig) {
-    this.baseUrl = `${host || 'http://localhost'}:${port || 8080}/v1/statement`
+    this.baseUrl = `${host || 'http://localhost'}:${port || 8080}`
     this.catalog = catalog
     this.interval = interval
     this.schema = schema
@@ -141,6 +149,25 @@ export class PrestoClient {
     ) as Column[]
   }
 
+  /**
+   * Retrieves all the information for a given query
+   * @param {string} queryId The query identifier string
+   * @returns {Promise<QueryInfo | undefined>} All the query information
+   */
+  async getQueryInfo(queryId: string): Promise<QueryInfo | undefined> {
+    const queryInfoResponse = await this.request({
+      headers: this.headers,
+      method: 'GET',
+      url: `${this.baseUrl}${QUERY_INFO_URL}${queryId}`,
+    })
+
+    if (queryInfoResponse.status !== 200) {
+      throw new Error(`Query failed: ${JSON.stringify(await queryInfoResponse.text())}`)
+    }
+
+    return (await queryInfoResponse.json()) as QueryInfo
+  }
+
   /**
    * Retrieves all schemas within a given catalog.
    * @param {string} catalog - The name of the catalog for which to retrieve schemas.
@@ -209,7 +236,12 @@ export class PrestoClient {
       headers['X-Presto-Schema'] = schema
     }
 
-    const firstResponse = await this.request({ body: query, headers, method: 'POST', url: this.baseUrl })
+    const firstResponse = await this.request({
+      body: query,
+      headers,
+      method: 'POST',
+      url: `${this.baseUrl}${STATEMENT_URL}`,
+    })
 
     if (firstResponse.status !== 200) {
       throw new Error(`Query failed: ${JSON.stringify(await firstResponse.text())}`)

presto-client/src/constants.ts

@@ -0,0 +1,2 @@
+export const STATEMENT_URL = '/v1/statement'
+export const QUERY_INFO_URL = '/v1/query/'

presto-client/src/index.ts

@@ -1,5 +1,5 @@
 export * from './client'
-export * from './client.types'
+export * from './types'
 
 import PrestoClient from './client'
 export default PrestoClient

presto-client/src/client.types.ts renamed to presto-client/src/types/client.types.ts

@@ -1,3 +1,5 @@
+import { PrestoError } from './error.types'
+
 export interface PrestoClientConfig {
   authorizationToken?: string
   basicAuthentication?: {
@@ -39,19 +41,6 @@ export interface PrestoResponse {
   updateType: string
 }
 
-export interface PrestoErrorObject extends Error {
-  errorCode: number
-  errorName: string
-  errorType: string
-  failureInfo: {
-    message: string
-    stack: string[]
-    suppressed: string[]
-    type: string
-  }
-  message: string
-}
-
 export interface PrestoStats {
   state: string
 }
@@ -65,18 +54,3 @@ export interface PrestoQuery {
 export type GetPrestoDataParams = PrestoClientConfig & {
   query: string
 }
-
-export class PrestoError extends Error implements PrestoErrorObject {
-  errorCode: number
-  errorName: string
-  errorType: string
-  failureInfo: PrestoErrorObject['failureInfo']
-
-  constructor({ errorCode, errorName, errorType, failureInfo, message }: PrestoErrorObject) {
-    super(message)
-    this.errorCode = errorCode
-    this.errorName = errorName
-    this.errorType = errorType
-    this.failureInfo = failureInfo
-  }
-}

presto-client/src/types/error.types.ts

@@ -0,0 +1,27 @@
+export interface PrestoErrorObject extends Error {
+  errorCode: number
+  errorName: string
+  errorType: string
+  failureInfo: {
+    message: string
+    stack: string[]
+    suppressed: string[]
+    type: string
+  }
+  message: string
+}
+
+export class PrestoError extends Error implements PrestoErrorObject {
+  errorCode: number
+  errorName: string
+  errorType: string
+  failureInfo: PrestoErrorObject['failureInfo']
+
+  constructor({ errorCode, errorName, errorType, failureInfo, message }: PrestoErrorObject) {
+    super(message)
+    this.errorCode = errorCode
+    this.errorName = errorName
+    this.errorType = errorType
+    this.failureInfo = failureInfo
+  }
+}

presto-client/src/types/index.ts

@@ -0,0 +1,4 @@
+export * from './client.types'
+export * from './error.types'
+export * from './information-schema.types'
+export * from './query-metadata'