platform/packages/api-client/src/rest/rest.ts

//
// Copyright © 2025 Hardcore Engineering Inc.
//
// Licensed under the Eclipse Public 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 https://www.eclipse.org/legal/epl-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 {
  type Account,
  buildModel,
  type Class,
  concatLink,
  type Doc,
  type DocumentQuery,
  type FindOptions,
  type FindResult,
  Hierarchy,
  MeasureMetricsContext,
  ModelDb,
  PersonId,
  PersonUuid,
  type Ref,
  type SearchOptions,
  type SearchQuery,
  type SearchResult,
  SocialIdType,
  type Tx,
  type TxResult,
  type WithLookup
} from '@hcengineering/core'
import { PlatformError, unknownError } from '@hcengineering/platform'

import type { RestClient } from './types'
import { extractJson, withRetry } from './utils'

export function createRestClient (endpoint: string, workspaceId: string, token: string): RestClient {
  return new RestClientImpl(endpoint, workspaceId, token)
}

const rateLimitError = 'rate-limit'

function isRLE (err: any): boolean {
  return err.message === rateLimitError
}

export class RestClientImpl implements RestClient {
  endpoint: string

  slowDownTimer = 0

  remaining: number = 1000
  limit: number = 1000
  constructor (
    endpoint: string,
    readonly workspace: string,
    readonly token: string
  ) {
    this.endpoint = endpoint.replace('ws', 'http')
  }

  jsonHeaders (): Record<string, string> {
    return {
      'Content-Type': 'application/json',
      Authorization: 'Bearer ' + this.token,
      'accept-encoding': 'snappy, gzip'
    }
  }

  requestInit (): RequestInit {
    return {
      method: 'GET',
      keepalive: true,
      headers: this.jsonHeaders()
    }
  }

  async findAll<T extends Doc>(
    _class: Ref<Class<T>>,
    query: DocumentQuery<T>,
    options?: FindOptions<T>
  ): Promise<FindResult<T>> {
    const params = new URLSearchParams()
    params.append('class', _class)
    if (query !== undefined && Object.keys(query).length > 0) {
      params.append('query', JSON.stringify(query))
    }
    if (options !== undefined && Object.keys(options).length > 0) {
      params.append('options', JSON.stringify(options))
    }
    const requestUrl = concatLink(this.endpoint, `/api/v1/find-all/${this.workspace}?${params.toString()}`)
    const result = await withRetry(async () => {
      const response = await fetch(requestUrl, this.requestInit())
      if (!response.ok) {
        await this.checkRateLimits(response)
        throw new PlatformError(unknownError(response.statusText))
      }
      return await extractJson<FindResult<T>>(response)
    }, isRLE)

    if (result.error !== undefined) {
      throw new PlatformError(result.error)
    }

    if (result.lookupMap !== undefined) {
      // We need to extract lookup map to document lookups
      for (const d of result) {
        if (d.$lookup !== undefined) {
          for (const [k, v] of Object.entries(d.$lookup)) {
            if (!Array.isArray(v)) {
              d.$lookup[k] = result.lookupMap[v as any]
            } else {
              d.$lookup[k] = v.map((it) => result.lookupMap?.[it])
            }
          }
        }
      }
      delete result.lookupMap
    }

    // We need to revert deleted query simple values.
    // We need to get rid of simple query parameters matched in documents
    for (const doc of result) {
      if (doc._class == null) {
        doc._class = _class
      }
      for (const [k, v] of Object.entries(query)) {
        if (typeof v === 'string' || typeof v === 'number' || typeof v === 'boolean') {
          if (doc[k] == null) {
            doc[k] = v
          }
        }
      }
    }

    return result
  }

  private async checkRateLimits (response: Response): Promise<void> {
    if (response.status === 429) {
      // Extract rate limit information from headers
      const retryAfter = response.headers.get('Retry-After')
      const rateLimitReset = response.headers.get('X-RateLimit-Reset')
      // const rateLimitLimit: string | null = response.headers.get('X-RateLimit-Limit')
      const waitTime =
        retryAfter != null
          ? parseInt(retryAfter)
          : rateLimitReset != null
            ? new Date(parseInt(rateLimitReset)).getTime() - Date.now()
            : 1000 // Default to 1 seconds if no headers are provided

      console.warn(`Rate limit exceeded. Waiting ${Math.round((10 * waitTime) / 1000) / 10} seconds before retrying...`)
      await new Promise((resolve) => setTimeout(resolve, waitTime))
      throw new Error(rateLimitError)
    }
  }

  async getAccount (): Promise<Account> {
    const requestUrl = concatLink(this.endpoint, `/api/v1/account/${this.workspace}`)
    const response = await fetch(requestUrl, this.requestInit())
    if (!response.ok) {
      throw new PlatformError(unknownError(response.statusText))
    }
    return await extractJson<Account>(response)
  }

  async getModel (): Promise<{ hierarchy: Hierarchy, model: ModelDb }> {
    const requestUrl = concatLink(this.endpoint, `/api/v1/load-model/${this.workspace}`)
    const response = await fetch(requestUrl, this.requestInit())
    if (!response.ok) {
      throw new PlatformError(unknownError(response.statusText))
    }
    const modelResponse: Tx[] = await extractJson<Tx[]>(response)

    const hierarchy = new Hierarchy()
    const model = new ModelDb(hierarchy)

    const ctx = new MeasureMetricsContext('loadModel', {})
    buildModel(ctx, modelResponse, (txes: Tx[]) => txes, hierarchy, model)

    return { hierarchy, model }
  }

  async findOne<T extends Doc>(
    _class: Ref<Class<T>>,
    query: DocumentQuery<T>,
    options?: FindOptions<T>
  ): Promise<WithLookup<T> | undefined> {
    return (await this.findAll(_class, query, { ...options, limit: 1 })).shift()
  }

  async tx (tx: Tx): Promise<TxResult> {
    const requestUrl = concatLink(this.endpoint, `/api/v1/tx/${this.workspace}`)
    const result = await withRetry(async () => {
      const response = await fetch(requestUrl, {
        method: 'POST',
        headers: this.jsonHeaders(),
        keepalive: true,
        body: JSON.stringify(tx)
      })
      if (!response.ok) {
        await this.checkRateLimits(response)
        throw new PlatformError(unknownError(response.statusText))
      }
      return await extractJson<TxResult>(response)
    }, isRLE)
    if (result.error !== undefined) {
      throw new PlatformError(result.error)
    }
    return result
  }

  async searchFulltext (query: SearchQuery, options: SearchOptions): Promise<SearchResult> {
    const params = new URLSearchParams()
    params.append('query', query.query)
    if (query.classes != null && Object.keys(query.classes).length > 0) {
      params.append('classes', JSON.stringify(query.classes))
    }
    if (query.spaces != null && Object.keys(query.spaces).length > 0) {
      params.append('spaces', JSON.stringify(query.spaces))
    }
    if (options.limit != null) {
      params.append('limit', `${options.limit}`)
    }
    const requestUrl = concatLink(this.endpoint, `/api/v1/search-fulltext/${this.workspace}`)
    const response = await fetch(requestUrl, {
      method: 'GET',
      headers: this.jsonHeaders(),
      keepalive: true
    })
    if (!response.ok) {
      throw new PlatformError(unknownError(response.statusText))
    }
    return await extractJson<TxResult>(response)
  }

  async ensurePerson (
    socialType: SocialIdType,
    socialValue: string,
    firstName: string,
    lastName: string
  ): Promise<{ uuid: PersonUuid, socialId: PersonId, localPerson: string }> {
    const requestUrl = concatLink(this.endpoint, `/api/v1/ensure-person/${this.workspace}`)
    const response = await fetch(requestUrl, {
      method: 'POST',
      headers: this.jsonHeaders(),
      keepalive: true,
      body: JSON.stringify({
        socialType,
        socialValue,
        firstName,
        lastName
      })
    })
    if (!response.ok) {
      throw new PlatformError(unknownError(response.statusText))
    }
    return await extractJson<{ uuid: PersonUuid, socialId: PersonId, localPerson: string }>(response)
  }
}