-
Notifications
You must be signed in to change notification settings - Fork 90
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
1344: Add faceting index settings methods r=bidoubiwa a=Ugzuzg # Pull Request ## Related issue Fixes #1299 ## PR checklist Please check if your PR fulfills the following requirements: - [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)? - [x] Have you read the contributing guidelines? - [x] Have you made sure that the title is accurate and descriptive of the changes? Co-authored-by: Jarasłaŭ Viktorčyk <[email protected]>
- Loading branch information
Showing
5 changed files
with
283 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,203 @@ | ||
| import { ErrorStatusCode } from '../src/types' | ||
| import { | ||
| clearAllIndexes, | ||
| config, | ||
| BAD_HOST, | ||
| MeiliSearch, | ||
| getClient, | ||
| dataset, | ||
| } from './utils/meilisearch-test-utils' | ||
|
|
||
| const index = { | ||
| uid: 'movies_test', | ||
| } | ||
|
|
||
| jest.setTimeout(100 * 1000) | ||
|
|
||
| afterAll(() => { | ||
| return clearAllIndexes(config) | ||
| }) | ||
|
|
||
| describe.each([{ permission: 'Master' }, { permission: 'Private' }])( | ||
| 'Test on faceting', | ||
| ({ permission }) => { | ||
| beforeEach(async () => { | ||
| await clearAllIndexes(config) | ||
| const client = await getClient('Master') | ||
| const { taskUid } = await client.createIndex(index.uid) | ||
| await client.waitForTask(taskUid) | ||
|
|
||
| const { taskUid: docTask } = await client | ||
| .index(index.uid) | ||
| .addDocuments(dataset) | ||
| await client.waitForTask(docTask) | ||
| }) | ||
|
|
||
| test(`${permission} key: Get default faceting object`, async () => { | ||
| const client = await getClient(permission) | ||
|
|
||
| const response = await client.index(index.uid).getFaceting() | ||
|
|
||
| expect(response).toEqual({ maxValuesPerFacet: 100 }) | ||
| }) | ||
|
|
||
| test(`${permission} key: Update faceting settings`, async () => { | ||
| const client = await getClient(permission) | ||
| const newFaceting = { maxValuesPerFacet: 12 } | ||
| const task = await client.index(index.uid).updateFaceting(newFaceting) | ||
| await client.index(index.uid).waitForTask(task.taskUid) | ||
|
|
||
| const response = await client.index(index.uid).getFaceting() | ||
|
|
||
| expect(response).toEqual(newFaceting) | ||
| }) | ||
|
|
||
| test(`${permission} key: Update faceting at null`, async () => { | ||
| const client = await getClient(permission) | ||
| const task = await client | ||
| .index(index.uid) | ||
| .updateFaceting({ maxValuesPerFacet: null }) | ||
| await client.index(index.uid).waitForTask(task.taskUid) | ||
|
|
||
| const response = await client.index(index.uid).getFaceting() | ||
|
|
||
| expect(response).toEqual({ maxValuesPerFacet: 100 }) | ||
| }) | ||
|
|
||
| test(`${permission} key: Reset faceting`, async () => { | ||
| const client = await getClient(permission) | ||
| await client | ||
| .index(index.uid) | ||
| .waitForTask( | ||
| ( | ||
| await client | ||
| .index(index.uid) | ||
| .updateFaceting({ maxValuesPerFacet: 12 }) | ||
| ).taskUid | ||
| ) | ||
| const task = await client.index(index.uid).resetFaceting() | ||
| await client.index(index.uid).waitForTask(task.taskUid) | ||
|
|
||
| const response = await client.index(index.uid).getFaceting() | ||
|
|
||
| expect(response).toEqual({ maxValuesPerFacet: 100 }) | ||
| }) | ||
| } | ||
| ) | ||
|
|
||
| describe.each([{ permission: 'Public' }])( | ||
| 'Test on faceting', | ||
| ({ permission }) => { | ||
| beforeEach(async () => { | ||
| const client = await getClient('Master') | ||
| const { taskUid } = await client.createIndex(index.uid) | ||
| await client.waitForTask(taskUid) | ||
| }) | ||
|
|
||
| test(`${permission} key: try to get faceting and be denied`, async () => { | ||
| const client = await getClient(permission) | ||
| await expect( | ||
| client.index(index.uid).getFaceting() | ||
| ).rejects.toHaveProperty('code', ErrorStatusCode.INVALID_API_KEY) | ||
| }) | ||
|
|
||
| test(`${permission} key: try to update faceting and be denied`, async () => { | ||
| const client = await getClient(permission) | ||
| await expect( | ||
| client.index(index.uid).updateFaceting({ maxValuesPerFacet: 13 }) | ||
| ).rejects.toHaveProperty('code', ErrorStatusCode.INVALID_API_KEY) | ||
| }) | ||
|
|
||
| test(`${permission} key: try to reset faceting and be denied`, async () => { | ||
| const client = await getClient(permission) | ||
| await expect( | ||
| client.index(index.uid).resetFaceting() | ||
| ).rejects.toHaveProperty('code', ErrorStatusCode.INVALID_API_KEY) | ||
| }) | ||
| } | ||
| ) | ||
|
|
||
| describe.each([{ permission: 'No' }])('Test on faceting', ({ permission }) => { | ||
| beforeAll(async () => { | ||
| const client = await getClient('Master') | ||
| const { taskUid } = await client.createIndex(index.uid) | ||
| await client.waitForTask(taskUid) | ||
| }) | ||
|
|
||
| test(`${permission} key: try to get faceting and be denied`, async () => { | ||
| const client = await getClient(permission) | ||
| await expect(client.index(index.uid).getFaceting()).rejects.toHaveProperty( | ||
| 'code', | ||
| ErrorStatusCode.MISSING_AUTHORIZATION_HEADER | ||
| ) | ||
| }) | ||
|
|
||
| test(`${permission} key: try to update faceting and be denied`, async () => { | ||
| const client = await getClient(permission) | ||
| await expect( | ||
| client.index(index.uid).updateFaceting({ maxValuesPerFacet: 13 }) | ||
| ).rejects.toHaveProperty( | ||
| 'code', | ||
| ErrorStatusCode.MISSING_AUTHORIZATION_HEADER | ||
| ) | ||
| }) | ||
|
|
||
| test(`${permission} key: try to reset faceting and be denied`, async () => { | ||
| const client = await getClient(permission) | ||
| await expect( | ||
| client.index(index.uid).resetFaceting() | ||
| ).rejects.toHaveProperty( | ||
| 'code', | ||
| ErrorStatusCode.MISSING_AUTHORIZATION_HEADER | ||
| ) | ||
| }) | ||
| }) | ||
|
|
||
| describe.each([ | ||
| { host: BAD_HOST, trailing: false }, | ||
| { host: `${BAD_HOST}/api`, trailing: false }, | ||
| { host: `${BAD_HOST}/trailing/`, trailing: true }, | ||
| ])('Tests on url construction', ({ host, trailing }) => { | ||
| test(`Test getFaceting route`, async () => { | ||
| const route = `indexes/${index.uid}/settings/faceting` | ||
| const client = new MeiliSearch({ host }) | ||
| const strippedHost = trailing ? host.slice(0, -1) : host | ||
| await expect(client.index(index.uid).getFaceting()).rejects.toHaveProperty( | ||
| 'message', | ||
| `request to ${strippedHost}/${route} failed, reason: connect ECONNREFUSED ${BAD_HOST.replace( | ||
| 'http://', | ||
| '' | ||
| )}` | ||
| ) | ||
| }) | ||
|
|
||
| test(`Test updateFaceting route`, async () => { | ||
| const route = `indexes/${index.uid}/settings/faceting` | ||
| const client = new MeiliSearch({ host }) | ||
| const strippedHost = trailing ? host.slice(0, -1) : host | ||
| await expect( | ||
| client.index(index.uid).updateFaceting({ maxValuesPerFacet: null }) | ||
| ).rejects.toHaveProperty( | ||
| 'message', | ||
| `request to ${strippedHost}/${route} failed, reason: connect ECONNREFUSED ${BAD_HOST.replace( | ||
| 'http://', | ||
| '' | ||
| )}` | ||
| ) | ||
| }) | ||
|
|
||
| test(`Test resetFaceting route`, async () => { | ||
| const route = `indexes/${index.uid}/settings/faceting` | ||
| const client = new MeiliSearch({ host }) | ||
| const strippedHost = trailing ? host.slice(0, -1) : host | ||
| await expect( | ||
| client.index(index.uid).resetFaceting() | ||
| ).rejects.toHaveProperty( | ||
| 'message', | ||
| `request to ${strippedHost}/${route} failed, reason: connect ECONNREFUSED ${BAD_HOST.replace( | ||
| 'http://', | ||
| '' | ||
| )}` | ||
| ) | ||
| }) | ||
| }) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters