chore: add client tests

[eunjae-lee]

🧭 What and Why

🎟 JIRA Ticket: https://algolia.atlassian.net/browse/APIC-252

Suggestion is welcome for schema & namings, ..

Changes included:

This PR adds:

• generator (to generate client tests)
• a few sample tests

[shortcuts]

That's a great POC! I still don't know if this is the path we should take as it might be harder to handle those cases in other languages, but I'd say let's keep going!

[shortcuts]

Maybe one object is enough :D

[shortcuts]

As said in the meeting, object is tied to JavaScript, we could find a wording that is less js-oriented for external contributors

[shortcuts]

(I'm saying that but I have no naming idea actually :D)

[eunjae-lee]

Yeah, so I was about to go for just containing, but again, I remembered other matchers from jest, like stringContaining, arrayContaining, ... object is not a universal term across all the languages, but I don't think there's one. We need to pick something as a spec, and generate tests with properly modified names for the languages.

Anyway, we can still change objectContaining to something else like dictionaryContaining, or whatever. Feedback is welcome!

[eunjae-lee]

only analytics client falls back to us region.

[eunjae-lee]

We promisify the return of the step and expects it to throw.

[eunjae-lee]

The return of the step can be a promise, so we resolve it and then move onto validating the result.

[millotp]

Almost good ! You need to fix some eslint issue in the main.ts file also

[millotp]

You can use // @ts-expect-error above the line to make the compilation work

[millotp]

You can remove some code by removing the async await, for example:

describe('basic', () => {
  test('does not throw when region is not given', () => {
    expect(() => {
      // @ts-expect-error
      // eslint-disable-next-line no-new
      new AnalyticsApi('my-app-id', 'my-api-key', '', {
        requester: new EchoRequester(),
      });
    }).not.toThrow();
  });

  test('getAverageClickPosition throws without index', () => {
    const $client = createClient();
    // @ts-expect-error
    expect(() => $client.getClickPositions({})).toThrow(
      'Parameter `index` is required when calling `getClickPositions`.'
    );
  });
});

[millotp]

Can you format the output file also ?

[eunjae-lee]

Can you format the output file also ?

api-clients-automation/tests/package.json

Line 9 in 575d88c

"generate": "yarn generate:methods:requets ${0:-javascript} ${1:-search} && yarn generate:client ${0:-javascript} ${1:-search} && yarn format ${0:-javascript}",

already doing

[eunjae-lee]

Almost good ! You need to fix some eslint issue in the main.ts file also

yup, fixed here 69e2983

[millotp]

All good !