Mascali
/
raspisms
mirror of https://github.com/RaspbianFrance/raspisms.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add strategy for more efficient pagination in API listing of entries by using before_id and after_id wheres instead of pagination if possible

This commit is contained in:
osaajani 2024-12-20 23:32:56 +01:00
parent 04b0f1267a
commit 0e11bcda17
10 changed files with 156 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
controllers/internals/Queue.php
View File

@ -66,7 +66,7 @@ class Queue extends \descartes\InternalController
*
* @return mixed $message : The oldest message or null if no message found, can be anything
* @param ?string $tag : A tag to associate to the message for routing purposes, if null will read from general queue
* @param mixed : The message to add to the queue, can be anything, the queue will have to treat it by itself
* @param mixed : The message return from the queue, can be anything, null if no message found
*/
public function read(?string $tag = null)
{

2
controllers/internals/Received.php
View File

@ -83,7 +83,7 @@ use Exception;
$this->bdd->beginTransaction();
$id_received = $this->get_model()->insert($received);
if (!$id_received)
if (!$id_received)
{
$this->bdd->rollBack();

6
controllers/internals/StandardController.php
View File

@ -77,12 +77,14 @@ namespace controllers\internals;
* @param int $id_user : User id
* @param ?int $nb_entry : Number of entry to return
* @param ?int $page : Pagination, used to calcul offset, $nb_entry * $page
* @param ?int $after_id : If provided use where id > $after_id instead of offset
* @param ?int $before_id : If provided use where id < $before_id instead of offset
*
* @return array : Entrys list
*/
public function list_for_user(int $id_user, ?int $nb_entry = null, ?int $page = null)
public function list_for_user(int $id_user, ?int $nb_entry = null, ?int $page = null, ?int $after_id = null, ?int $before_id = null)
{
return $this->get_model()->list_for_user($id_user, $nb_entry, $nb_entry * $page);
return $this->get_model()->list_for_user($id_user, $nb_entry, $nb_entry * $page, $after_id, $before_id);
}
/**

17
controllers/publics/Api.php
View File

@ -126,10 +126,13 @@ namespace controllers\publics;
*
* @param string $entry_type : Type of entries we want to list ['sended', 'received', 'scheduled', 'contact', 'group', 'conditional_group', 'phone', 'phone_group', 'media']
* @param int $page : Pagination number, Default = 0. Group of 25 results.
* @param ?int $after_id : If provided use where id > $after_id instead of offset based on page, more performant
* @param ?int $before_id : If provided use where id < $before_id instead of offset based on page, more performant
*
*
* @return : List of entries
*/
public function get_entries(string $entry_type, int $page = 0)
public function get_entries(string $entry_type, int $page = 0, ?int $after_id = null, ?int $before_id = null)
{
$entry_types = ['sended', 'received', 'scheduled', 'contact', 'group', 'conditional_group', 'phone', 'phone_group', 'media'];
@ -148,7 +151,7 @@ namespace controllers\publics;
$page = (int) $page;
$limit = 25;
$entries = $controller->list_for_user($this->user['id'], $limit, $page);
$entries = $controller->list_for_user($this->user['id'], $limit, $page, $after_id, $before_id);
//Special case for scheduled, we must add numbers because its a join
if ('scheduled' === $entry_type)
@ -221,14 +224,16 @@ namespace controllers\publics;
$return = self::DEFAULT_RETURN;
$return['response'] = $entries;
if (\count($entries) === $limit)
if (\count($entries) === $limit || ($entries && $before_id))
{
$return['next'] = \descartes\Router::url('Api', __FUNCTION__, ['entry_type' => $entry_type, 'page' => $page + 1], ['api_key' => $this->user['api_key']]);
$last_entry = end($entries);
$return['next'] = \descartes\Router::url('Api', __FUNCTION__, ['entry_type' => $entry_type, 'after_id' => $last_entry['id']], ['api_key' => $this->user['api_key']]);
}
if ($page > 0)
if ($page > 0 || ($entries && ($after_id || $before_id)))
{
$return['prev'] = \descartes\Router::url('Api', __FUNCTION__, ['entry_type' => $entry_type, 'page' => $page - 1], ['api_key' => $this->user['api_key']]);
$first_entry = $entries[0];
$return['prev'] = \descartes\Router::url('Api', __FUNCTION__, ['entry_type' => $entry_type, 'before_id' => $first_entry['id']], ['api_key' => $this->user['api_key']]);
}
$this->auto_http_code(true);

43
models/Call.php
View File

@ -26,10 +26,13 @@ namespace models;
* @param int $id_user : user id
* @param ?int $limit : Number of entry to return or null
* @param ?int $offset : Number of entry to ignore or null
* @param ?int $after_id : If provided use where id > $after_id instead of offset
* @param ?int $before_id : If provided use where id < $before_id instead of offset
*
*
* @return array
*/
public function list_for_user(int $id_user, $limit, $offset)
public function list_for_user(int $id_user, $limit, $offset, ?int $after_id = null, ?int $before_id = null)
{
$query = '
SELECT `call`.*, contact.name as contact_name, phone.name as phone_name
@ -42,6 +45,37 @@ namespace models;
WHERE `call`.id_user = :id_user
';
$params = [
'id_user' => $id_user,
];
if ($after_id || $before_id)
{
$offset = null;
}
if ($after_id)
{
$query .= '
AND `call`.id > :after_id
ORDER BY `call`.id
';
$params['after_id'] = $after_id;
}
elseif ($before_id)
{
$query .= '
AND `call`.id < :before_id
ORDER BY `call`.id DESC
';
$params['before_id'] = $before_id;
}
else
{
$query .= ' ORDER BY `call`.id';
}
if (null !== $limit)
{
$limit = (int) $limit;
@ -54,9 +88,10 @@ namespace models;
}
}
$params = [
'id_user' => $id_user,
];
if ($before_id)
{
return array_reverse($this->_run_query($query, $params));
}
return $this->_run_query($query, $params);
}

49
models/Group.php
View File

@ -20,10 +20,12 @@ namespace models;
* @param int $id_user : user id
* @param ?int $limit : Number of entry to return or null
* @param ?int $offset : Number of entry to ignore or null
* @param ?int $after_id : If provided use where id > $after_id instead of offset
* @param ?int $before_id : If provided use where id < $before_id instead of offset
*
* @return array
*/
public function list_for_user(int $id_user, $limit, $offset)
public function list_for_user(int $id_user, $limit, $offset, ?int $after_id = null, ?int $before_id = null)
{
$query = '
SELECT g.*, COUNT(gc.id) as nb_contact
@ -31,9 +33,43 @@ namespace models;
LEFT JOIN group_contact as gc
ON g.id = gc.id_group
WHERE id_user = :id_user
GROUP BY g.id
';
$params = [
'id_user' => $id_user,
];
if ($after_id || $before_id)
{
$offset = null;
}
if ($after_id)
{
$query .= '
AND g.id > :after_id
GROUP BY g.id
ORDER BY g.id
';
$params['after_id'] = $after_id;
}
elseif ($before_id)
{
$query .= '
AND g.id < :before_id
GROUP BY g.id
ORDER BY g.id DESC
';
$params['before_id'] = $before_id;
}
else
{
$query .= '
GROUP BY g.id
ORDER BY g.id
';
}
if (null !== $limit)
{
$limit = (int) $limit;
@ -46,10 +82,11 @@ namespace models;
}
}
$params = [
'id_user' => $id_user,
];
if ($before_id)
{
return array_reverse($this->_run_query($query, $params));
}
return $this->_run_query($query, $params);
}

47
models/PhoneGroup.php
View File

@ -20,10 +20,12 @@ namespace models;
* @param int $id_user : user id
* @param ?int $limit : Number of entry to return or null
* @param ?int $offset : Number of entry to ignore or null
* @param ?int $after_id : If provided use where id > $after_id instead of offset
* @param ?int $before_id : If provided use where id < $before_id instead of offset
*
* @return array
*/
public function list_for_user(int $id_user, $limit, $offset)
public function list_for_user(int $id_user, $limit, $offset, ?int $after_id = null, ?int $before_id = null)
{
$query = '
SELECT pg.*, COUNT(pgp.id) as nb_phone
@ -31,9 +33,43 @@ namespace models;
LEFT JOIN phone_group_phone as pgp
ON pg.id = pgp.id_phone_group
WHERE pg.id_user = :id_user
GROUP BY pg.id
';
$params = [
'id_user' => $id_user,
];
if ($after_id || $before_id)
{
$offset = null;
}
if ($after_id)
{
$query .= '
AND pg.id > :after_id
GROUP BY pg.id
ORDER BY g.id
';
$params['after_id'] = $after_id;
}
elseif ($before_id)
{
$query .= '
AND pg.id < :before_id
GROUP BY pg.id
ORDER BY g.id DESC
';
$params['before_'] = $before_id;
}
else
{
$query .= '
GROUP BY pg.id
ORDER BY pg.id
';
}
if (null !== $limit)
{
$limit = (int) $limit;
@ -46,9 +82,10 @@ namespace models;
}
}
$params = [
'id_user' => $id_user,
];
if ($before_id)
{
return array_reverse($this->_run_query($query, $params));
}
return $this->_run_query($query, $params);
}

2
models/RedisQueue.php
View File

@ -70,7 +70,7 @@ class RedisQueue implements Queue
*
* @return mixed $message : The oldest message or null if no message found, can be anything
* @param ?string $tag : A tag to associate to the message for routing purposes, if null will read from general queue
* @param mixed : The message to add to the queue, can be anything, the queue will have to treat it by itself
* @param mixed : The message return from the queue, can be anything, null if no message found
*/
public function read(?string $tag = null)
{

14
models/StandardModel.php
View File

@ -70,12 +70,22 @@ namespace models;
* @param int $id_user : user id
* @param int $limit : Number of entry to return
* @param int $offset : Number of entry to ignore
* @param ?int $after_id : If provided use where id > $after_id instead of offset
* @param ?int $before_id : If provided use where id < $before_id instead of offset
*
* @return array
*/
public function list_for_user(int $id_user, $limit, $offset)
public function list_for_user(int $id_user, $limit, $offset, ?int $after_id = null, ?int $before_id = null)
{
return $this->_select($this->get_table_name(), ['id_user' => $id_user], null, false, $limit, $offset);
if ($after_id !== null) {
return $this->_select($this->get_table_name(), ['id_user' => $id_user, '>id' => $after_id], 'id', false, $limit);
}
if ($before_id !== null) {
return array_reverse($this->_select($this->get_table_name(), ['id_user' => $id_user, '<id' => $before_id], 'id', true, $limit));
}
return $this->_select($this->get_table_name(), ['id_user' => $id_user], 'id', false, $limit, $offset);
}
/**

2
routes.php
View File

@ -214,6 +214,8 @@
'get_entries' => [
'/api/list/{entry_type}/',
'/api/list/{entry_type}/{page}/',
'/api/list/{entry_type}/after/{after_id}/',
'/api/list/{entry_type}/before/{before_id}/',
],
'get_usage' => '/api/usage/',
'get_sms_status_stats' => '/api/stats/sms-status/',