Skip to content

Commit

Permalink
Merge branch 'DEVEXP-420_Remove-support-for-Phone-Numbers' into Fix-d…
Browse files Browse the repository at this point in the history 
…iscrepancies-from-documentation
  • Loading branch information
@asein-sinch
asein-sinch authored May 6, 2024
2 parents 182d986 + 5d1dae6 commit 53bceb0
Show file tree
Hide file tree
Showing 2 changed files with 282 additions and 19 deletions.
52 changes: 33 additions & 19 deletions packages/sdk-client/src/client/api-client-pagination-helper.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -263,68 +263,82 @@ interface WithPagination_PAGE2 {

const checkIfThereAreMorePages = (
response: WithPagination,
requestedPageSize: number | undefined,
paginationType: PaginationEnum,
requestedPageSize: number,
paginationType: PaginationEnum.PAGE | PaginationEnum.PAGE2,
): boolean => {
const lastPageNumber = calculateLastPageValue(response, requestedPageSize, paginationType);
return response.page! < lastPageNumber;
switch (paginationType) {
case PaginationEnum.PAGE:
return response.page! < lastPageNumber;
case PaginationEnum.PAGE2:
return response.pageNumber! < lastPageNumber;
}
};

const calculateLastPageValue = (
response: WithPagination,
requestedPageSize: number | undefined,
paginationType: PaginationEnum,
pageSize: number,
paginationType: PaginationEnum.PAGE | PaginationEnum.PAGE2,
): number => {
if (invalidatePaginationDataFromResponse(response, paginationType)) {
throw new Error(`Impossible to calculate the last page value with the following parameters: count=${response.count}, page=${response.page}, page_size=${response.page_size}`);
}
if (response.page_size === 0) {
if (response.page_size === 0 || response.pageSize === 0) {
// If there are no elements on the current page, there are no more pages
return response.page!;
}
// The elements in the response are not enough to determine if the current page is the last one
const pageSize: number = requestedPageSize || response.page_size!;
const itemCount: number = response.count!;
return Math.ceil(itemCount / pageSize) - 1;
switch (paginationType) {
case PaginationEnum.PAGE:
return Math.ceil(response.count! / pageSize) - 1;
case PaginationEnum.PAGE2:
return Math.ceil(response.totalItems! / pageSize) - 1;
}
};

const invalidatePaginationDataFromResponse = (response: WithPagination, paginationType: PaginationEnum): boolean => {
const invalidatePaginationDataFromResponse = (
response: WithPagination,
paginationType: PaginationEnum.PAGE | PaginationEnum.PAGE2,
): boolean => {
const currentPage = getCurrentPage(response, paginationType);
const pageSize = getPageSize(response, paginationType);
const itemCount = getItemCount(response, paginationType);
return !isNumber(currentPage) || !isNumber(pageSize) || !isNumber(itemCount);
};

const getCurrentPage = (response: WithPagination, paginationType: PaginationEnum): number | undefined => {
const getCurrentPage = (
response: WithPagination,
paginationType: PaginationEnum.PAGE | PaginationEnum.PAGE2,
): number | undefined => {
switch (paginationType) {
case PaginationEnum.PAGE:
return response.page;
case PaginationEnum.PAGE2:
return response.pageNumber;
default:
return undefined;
}
};

const getPageSize = (response: WithPagination, paginationType: PaginationEnum): number | undefined => {
const getPageSize = (
response: WithPagination,
paginationType: PaginationEnum.PAGE | PaginationEnum.PAGE2,
): number | undefined => {
switch (paginationType) {
case PaginationEnum.PAGE:
return response.page_size;
case PaginationEnum.PAGE2:
return response.pageSize;
default:
return undefined;
}
};

const getItemCount = (response: WithPagination, paginationType: PaginationEnum): number | undefined => {
const getItemCount = (
response: WithPagination,
paginationType: PaginationEnum.PAGE | PaginationEnum.PAGE2,
): number | undefined => {
switch (paginationType) {
case PaginationEnum.PAGE:
return response.count;
case PaginationEnum.PAGE2:
return response.totalItems;
default:
return undefined;
}
};

Expand Down
249 changes: 249 additions & 0 deletions packages/sdk-client/tests/client/api-client-pagination-helpers.test.ts
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,249 @@
import {
calculateNextPage,
hasMore,
PaginationContext,
PaginationEnum,
} from '../../src';
import { Headers } from 'node-fetch';

describe('API Client Pagination Helper', () => {

const paginationTokenProperties = {
apiName: '',
operationId: '',
dataKey: 'elements',
requestOptions: {
headers: new Headers(),
hostname: 'example.com',
},
};
const paginationContextToken: PaginationContext = {
pagination: PaginationEnum.TOKEN,
...paginationTokenProperties,
};
const paginationContextPage: PaginationContext = {
pagination: PaginationEnum.PAGE,
...paginationTokenProperties,
};
const paginationContextPage2: PaginationContext = {
pagination: PaginationEnum.PAGE2,
...paginationTokenProperties,
};
const paginationContextPage3: PaginationContext = {
pagination: PaginationEnum.PAGE3,
...paginationTokenProperties,
};


describe('hasMore', () => {

it('should return "true" when the PaginationContext is "TOKEN" and there are more elements', async () => {
// Given
const response = {
elements: ['H', 'He'],
nextPageToken: 'nextPageToken',
totalSize: 10,
};
const paginationContext = { ...paginationContextToken };

// When
const hasMoreElements = hasMore(response, paginationContext);

// Then
expect(hasMoreElements).toBeTruthy();
});

it('should return "false" when the PaginationContext is "TOKEN" and there are no more elements', async () => {
// Given
const response = {
elements: ['H', 'He'],
nextPageToken: '',
totalSize: 2,
};
const paginationContext = { ...paginationContextToken };

// When
const hasMoreElements = hasMore(response, paginationContext);

// Then
expect(hasMoreElements).toBeFalsy();
});

it('should return "true" when the PaginationContext is "PAGE" and there are more elements', async () => {
// Given
const response = {
elements: ['H', 'He'],
page: 0,
page_size: 2,
count: 10,
};
const paginationContext = { ...paginationContextPage };

// When
const hasMoreElements = hasMore(response, paginationContext);

// Then
expect(hasMoreElements).toBeTruthy();
});

it('should return "false" when the PaginationContext is "PAGE" and there are no more elements', async () => {
// Given
const response = {
elements: ['H', 'He'],
page: 0,
page_size: 2,
count: 2,
};
const paginationContext = { ...paginationContextPage };

// When
const hasMoreElements = hasMore(response, paginationContext);

// Then
expect(hasMoreElements).toBeFalsy();
});

it('should return "true" when the PaginationContext is "PAGE2" and there are more elements', async () => {
// Given
const response = {
elements: ['H', 'He'],
pageNumber: 1,
pageSize: 2,
totalItems: 10,
};
const paginationContext = { ...paginationContextPage2 };

// When
const hasMoreElements = hasMore(response, paginationContext);

// Then
expect(hasMoreElements).toBeTruthy();
});

it('should return "false" when the PaginationContext is "PAGE2" and there are no more elements', async () => {
// Given
const response = {
elements: ['H', 'He'],
pageNumber: 1,
pageSize: 2,
totalItems: 2,
};
const paginationContext = { ...paginationContextPage2 };

// When
const hasMoreElements = hasMore(response, paginationContext);

// Then
expect(hasMoreElements).toBeFalsy();
});

it('should return "true" when the PaginationContext is "PAGE3" and there are more elements', async () => {
// Given
const response = {
elements: ['H', 'He'],
pageNumber: 1,
pageSize: 2,
totalItems: 10,
totalPages: 5,
};
const paginationContext = { ...paginationContextPage3 };

// When
const hasMoreElements = hasMore(response, paginationContext);

// Then
expect(hasMoreElements).toBeTruthy();
});

it('should return "false" when the PaginationContext is "PAGE3" and there are no more elements', async () => {
// Given
const response = {
elements: ['H', 'He'],
pageNumber: 1,
pageSize: 2,
totalItems: 2,
totalPages: 1,
};
const paginationContext = { ...paginationContextPage3 };

// When
const hasMoreElements = hasMore(response, paginationContext);

// Then
expect(hasMoreElements).toBeFalsy();
});

});

describe('calculateNextPage', () => {

it('should return the next page token when the PaginationContext is "TOKEN"', () => {
// Given
const response = {
elements: ['H', 'He'],
nextPageToken: 'nextPageToken',
totalSize: 10,
};
const paginationContext = { ...paginationContextToken };

// When
const nextPage = calculateNextPage(response, paginationContext);

// Then
expect(nextPage).toBe('nextPageToken');
});

it('should return the next page value when the PaginationContext is "PAGE"', () => {
// Given
const response = {
elements: ['H', 'He'],
page: 0,
page_size: 2,
count: 10,
};
const paginationContext = { ...paginationContextPage };

// When
const nextPage = calculateNextPage(response, paginationContext);

// Then
expect(nextPage).toBe('1');
});

it('should return the next page value when the PaginationContext is "PAGE2"', () => {
// Given
const response = {
elements: ['H', 'He'],
pageNumber: 1,
pageSize: 2,
totalItems: 10,
};
const paginationContext = { ...paginationContextPage2 };

// When
const nextPage = calculateNextPage(response, paginationContext);

// Then
expect(nextPage).toBe('2');
});

it('should return the next page value when the PaginationContext is "PAGE3"', () => {
// Given
const response = {
elements: ['H', 'He'],
pageNumber: 1,
pageSize: 2,
totalItems: 2,
totalPages: 1,
};
const paginationContext = { ...paginationContextPage3 };

// When
const nextPage = calculateNextPage(response, paginationContext);

// Then
expect(nextPage).toBe('2');
});
});

});

0 comments on commit 53bceb0

Please sign in to comment.