exportDownload.test.ts

/**
 * ObjectUI
 * Copyright (c) 2024-present ObjectStack Inc.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */

import { describe, it, expect, vi } from 'vitest';
import { ObjectStackAdapter } from './index';

/** Build an adapter whose fetch is a spy returning the given Response. */
function makeDS(fetchImpl: any) {
  const ds: any = new ObjectStackAdapter({ baseUrl: 'http://test.local', fetch: fetchImpl });
  ds.connected = true;
  ds.connectionState = 'connected';
  return ds;
}

function csvResponse(body = 'ID,Name\n1,Acme') {
  return new Response(body, { status: 200, headers: { 'Content-Type': 'text/csv' } });
}

describe('ObjectStackAdapter.exportDownload', () => {
  it('GETs the /export route with format, fields, orderby, header and limit', async () => {
    const fetchImpl = vi.fn(async () => csvResponse());
    const ds = makeDS(fetchImpl);

    const blob = await ds.exportDownload('task', {
      format: 'xlsx',
      fields: ['title', 'owner'],
      sort: [{ field: 'title', direction: 'desc' }, { field: 'owner' }],
      includeHeaders: false,
      limit: 5000,
    });

    expect(blob).toBeInstanceOf(Blob);
    expect(fetchImpl).toHaveBeenCalledTimes(1);
    const [url, init] = fetchImpl.mock.calls[0];
    const parsed = new URL(url);
    expect(parsed.pathname).toBe('/api/v1/data/task/export');
    expect(parsed.searchParams.get('format')).toBe('xlsx');
    expect(parsed.searchParams.get('fields')).toBe('title,owner');
    // direction defaults to asc when omitted.
    expect(parsed.searchParams.get('orderby')).toBe('title:desc,owner:asc');
    expect(parsed.searchParams.get('header')).toBe('false');
    expect(parsed.searchParams.get('limit')).toBe('5000');
    expect(init.method).toBe('GET');
    expect(init.credentials).toBe('include');
  });

  it('defaults to csv and omits optional params when not provided', async () => {
    const fetchImpl = vi.fn(async () => csvResponse());
    const ds = makeDS(fetchImpl);

    await ds.exportDownload('task', {});

    const [url] = fetchImpl.mock.calls[0];
    const parsed = new URL(url);
    expect(parsed.searchParams.get('format')).toBe('csv');
    expect(parsed.searchParams.get('fields')).toBeNull();
    expect(parsed.searchParams.get('orderby')).toBeNull();
    expect(parsed.searchParams.get('header')).toBeNull();
    expect(parsed.searchParams.get('limit')).toBeNull();
  });

  it('serializes the filter to a JSON AST query param', async () => {
    const fetchImpl = vi.fn(async () => csvResponse());
    const ds = makeDS(fetchImpl);

    await ds.exportDownload('task', { filter: [['status', '=', 'open']] });

    const [url] = fetchImpl.mock.calls[0];
    const raw = new URL(url).searchParams.get('filter');
    expect(raw).toBeTruthy();
    expect(JSON.parse(raw!)).toEqual([['status', '=', 'open']]);
  });

  it('throws an error carrying the server message and status on failure', async () => {
    const fetchImpl = vi.fn(async () =>
      new Response(JSON.stringify({ error: { message: 'Permission denied' } }), {
        status: 403,
        headers: { 'Content-Type': 'application/json' },
      }),
    );
    const ds = makeDS(fetchImpl);

    await expect(ds.exportDownload('task', { format: 'csv' })).rejects.toMatchObject({
      message: 'Permission denied',
      status: 403,
    });
  });
});