documents_test.dart

import 'package:test/test.dart';
import 'package:mockito/mockito.dart';

import 'package:typesense/src/documents.dart';
import 'package:typesense/src/services/api_call.dart';
import 'package:typesense/src/exceptions/exceptions.dart';

import 'test_utils.mocks.dart';

void main() {
  late Documents documents;
  late MockApiCall mockApiCall;
  late MockDocumentsApiCall mockDocumentsApiCall;

  setUp(() {
    mockApiCall = MockApiCall();
    mockDocumentsApiCall = MockDocumentsApiCall();
    documents = Documents("companies", mockApiCall, mockDocumentsApiCall);
  });

  group("Documents", () {
    test('has a resourcepath', () {
      expect(Documents.resourcepath, equals('/documents'));
    });
    test("create() calls ApiCall.post()", () async {
      final document = {
        'id': '124',
        'company_name': 'Stark Industries',
        'num_employees': 5215,
        'country': 'USA',
      };
      when(mockApiCall.post("/collections/companies/documents",
              bodyParameters: document, queryParams: {'action': 'create'}))
          .thenAnswer((realInvocation) => Future.value(document));
      expect(await documents.create(document), equals(document));
    });
    test("upsert() calls ApiCall.post()", () async {
      final document = {
        'id': '124',
        'company_name': 'Stark Industries',
        'num_employees': 5215,
        'country': 'USA',
      };
      when(mockApiCall.post("/collections/companies/documents",
              bodyParameters: document, queryParams: {"action": "upsert"}))
          .thenAnswer((realInvocation) => Future.value(document));
      expect(await documents.upsert(document), equals(document));
    });
    test("update() calls ApiCall.post()", () async {
      final document = {
        'company_name': 'Stark Industries',
        'num_employees': 5215,
        'country': 'USA',
      };
      when(mockApiCall.post("/collections/companies/documents",
              bodyParameters: document, queryParams: {"action": "update"}))
          .thenAnswer((realInvocation) => Future.value(document));
      expect(await documents.update(document), equals(document));
    });
    test("delete() calls ApiCall.post()", () async {
      when(mockApiCall.delete("/collections/companies/documents",
              queryParams: {'filter_by': 'num_employees:>100'}))
          .thenAnswer((realInvocation) => Future.value({"num_deleted": 24}));
      expect(await documents.delete({'filter_by': 'num_employees:>100'}),
          equals({"num_deleted": 24}));
    });
    test('importDocuments() calls DocumentsApiCall.post()', () async {
      when(mockDocumentsApiCall.post(
        "/collections/companies/documents/import",
        bodyParameters:
            '{"id":"124","company_name":"Stark Industries","num_employees":5215,"country":"USA"}',
        additionalHeaders: {contentType: 'text/plain'},
      )).thenAnswer((realInvocation) => Future.value('{"success": true}'));
      expect(
          await documents.importDocuments([
            {
              "id": "124",
              "company_name": "Stark Industries",
              "num_employees": 5215,
              "country": "USA"
            }
          ]),
          equals([
            {"success": true}
          ]));
    });
    test("importJsonlDocuments() calls DocumentsApiCall.post()", () async {
      final documentJsonl = '''
{"id": "124", "company_name": "Stark Industries", "num_employees": 5215, "country": "US"}
{"id": "125", "company_name": "Future Technology", "num_employees": 1232, "country": "UK"}
{"id": "126", "company_name": "Random Corp.", "num_employees": 531, "country": "AU"}''',
          result = '''
{"success": true}
{"success": true}
{"success": true}
''';
      when(mockDocumentsApiCall.post(
        "/collections/companies/documents/import",
        bodyParameters: documentJsonl,
        additionalHeaders: {contentType: 'text/plain'},
      )).thenAnswer((realInvocation) => Future.value(result));
      expect(await documents.importJSONL(documentJsonl), equals(result));
    });
    test("exportJsonlDocuments() calls DocumentsApiCall.get()", () async {
      final documentJsonl = '''
{"id": "124", "company_name": "Stark Industries", "num_employees": 5215, "country": "US"}
{"id": "125", "company_name": "Future Technology", "num_employees": 1232, "country": "UK"}
{"id": "126", "company_name": "Random Corp.", "num_employees": 531, "country": "AU"}
''';
      when(mockDocumentsApiCall.get(
        "/collections/companies/documents/export",
        queryParams: {'filter_by': 'num_employees:>100'},
      )).thenAnswer((realInvocation) => Future.value(documentJsonl));
      expect(
          await documents.exportJSONL(
            queryParams: {'filter_by': 'num_employees:>100'},
          ),
          equals(documentJsonl));
    });
    test('search() calls ApiCall.get with shouldCacheResult true', () async {
      final searchResult = {
        "facet_counts": [],
        "found": 1,
        "out_of": 1,
        "page": 1,
        "request_params": {"q": ""},
        "search_time_ms": 1,
        "grouped_hits": [
          {
            "group_key": ["USA"],
            "hits": [
              {
                "highlights": [
                  {
                    "field": "company_name",
                    "snippet": "<mark>Stark</mark> Industries"
                  }
                ],
                "document": {
                  "id": "124",
                  "company_name": "Stark Industries",
                  "num_employees": 5215,
                  "country": "USA"
                }
              }
            ]
          }
        ]
      };

      when(mockApiCall.get(
        "/collections/companies/documents/search",
        queryParams: {
          'q': 'stark',
          'query_by': 'company_name',
          'filter_by': 'num_employees:>100',
          'sort_by': 'num_employees:desc',
          'group_by': 'country',
          'group_limit': '1'
        },
        shouldCacheResult: true,
      )).thenAnswer((realInvocation) => Future.value(searchResult));
      expect(
          await documents.search({
            'q': 'stark',
            'query_by': 'company_name',
            'filter_by': 'num_employees:>100',
            'sort_by': 'num_employees:desc',
            'group_by': 'country',
            'group_limit': '1'
          }),
          equals(searchResult));
    });
  });

  test('Documents.importDocuments throws ImportError if "success" is false',
      () async {
    when(mockDocumentsApiCall.post(
      "/collections/companies/documents/import",
      bodyParameters:
          '''{"id":"124","company_name":"Stark Industries","num_employees":"5215","country":"USA"}
{"id":"125","company_name":"Acme Corp","num_employees":2133,"country":"CA"}''',
      additionalHeaders: {contentType: 'text/plain'},
    )).thenAnswer((realInvocation) => Future.value(
        '''{"code":400,"document":"{\\"id\\": \\"124\\",\\"company_name\\": \\"Stark Industries\\",\\"num_employees\\": \\"5215\\",\\"country\\": \\"USA\\"}","error":"Field `num_employees` must be an int32.","success":false}
{"success":true}'''));
    expect(() async {
      await documents.importDocuments([
        {
          "id": "124",
          "company_name": "Stark Industries",
          "num_employees": "5215",
          "country": "USA"
        },
        {
          "id": "125",
          "company_name": "Acme Corp",
          "num_employees": 2133,
          "country": "CA"
        }
      ]);
    },
        throwsA(isA<ImportError>()
            .having(
          (e) => e.message,
          'message',
          '1 documents imported successfully, 1 documents failed during import. Use `error.importResults` from the raised exception to get a detailed error reason for each document.',
        )
            .having((e) => e.importResults, 'importResults', [
          {
            'code': 400,
            'document':
                '{"id": "124","company_name": "Stark Industries","num_employees": "5215","country": "USA"}',
            'error': 'Field `num_employees` must be an int32.',
            'success': false
          },
          {'success': true}
        ])));
  });
}