Skip to content

Commit

Permalink
Limit search result set to 100 and sort by default (#531)
Browse files Browse the repository at this point in the history 
* Limit result set to 100, and sort is by time created ascending. This way we got a clearly defined search and consumer can use "to" and "from" to paginate.

* Swagger update

* Updated to sort by descending because how it used to work. Also re-factored to use simple string interpolation for the query conditions (but still parameterized).
  • Loading branch information
@Ceredron
Ceredron authored Sep 12, 2024
1 parent f7912ef commit 436ff70
Show file tree
Hide file tree
Showing 3 changed files with 72 additions and 62 deletions.
2 changes: 1 addition & 1 deletion altinn-broker-openapi-v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@
"File"
],
"summary": "List files available for the caller",
"description": "This endpoint retrieves a list of files available given for the caller given the query parameters.",
"description": "Get files that can be accessed by the caller according to specified filters. Result set is limited to 100 files. If your query returns more than 100 files, you will only receive the 100 first ordered by time created.",
"operationId": "List files",
"parameters": [
{
Expand Down
2 changes: 1 addition & 1 deletion src/Altinn.Broker.API/Controllers/FileTransferController.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ public async Task<ActionResult<FileTransferStatusDetailsExt>> GetFileTransferDet
}

/// <summary>
/// Get files that can be accessed by the caller according to specified filters. Result set is limited to 100 files.
/// Get files that can be accessed by the caller according to specified filters. Result set is limited to 100 files. If your query returns more than 100 files, you will only receive the 100 last created.
/// </summary>
/// <returns></returns>
[HttpGet]
Expand Down
130 changes: 70 additions & 60 deletions src/Altinn.Broker.Persistence/Repositories/FileTransferRepository.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -294,57 +294,49 @@ public async Task<List<Guid>> LegacyGetFilesForRecipientsWithRecipientStatus(Leg

public async Task<List<Guid>> GetFileTransfersAssociatedWithActor(FileTransferSearchEntity fileTransferSearch, CancellationToken cancellationToken)
{
StringBuilder commandString = new StringBuilder();
commandString.AppendLine("SELECT DISTINCT afs.file_transfer_id_fk, 'Recipient'");
commandString.AppendLine("FROM broker.actor_file_transfer_status afs ");
commandString.AppendLine("INNER JOIN broker.file_transfer f on f.file_transfer_id_pk = afs.file_transfer_id_fk");
commandString.AppendLine("INNER JOIN LATERAL (SELECT fs.file_transfer_status_description_id_fk FROM broker.file_transfer_status fs where fs.file_transfer_id_fk = f.file_transfer_id_pk ORDER BY fs.file_transfer_status_id_pk desc LIMIT 1 ) AS filetransferstatus ON true");
commandString.AppendLine("WHERE afs.actor_id_fk = @actorId AND f.resource_id = @resourceId");
if (fileTransferSearch.Status.HasValue)
{
commandString.AppendLine("AND filetransferstatus.file_transfer_status_Description_id_fk = @fileTransferStatus");
}
if (fileTransferSearch.From.HasValue && fileTransferSearch.To.HasValue)
{
commandString.AppendLine("AND f.created between @from AND @to");
}
else if (fileTransferSearch.From.HasValue)
{
commandString.AppendLine("AND f.created > @from");
}
else if (fileTransferSearch.To.HasValue)
{
commandString.AppendLine("AND f.created < @to");
}

commandString.AppendLine("UNION");

commandString.AppendLine("SELECT f.file_transfer_id_pk, 'Sender' ");
commandString.AppendLine("FROM broker.file_transfer f ");
commandString.AppendLine("INNER JOIN broker.actor a on a.actor_id_pk = f.sender_actor_id_fk ");
commandString.AppendLine("INNER JOIN LATERAL (SELECT fs.file_transfer_status_description_id_fk FROM broker.file_transfer_status fs where fs.file_transfer_id_fk = f.file_transfer_id_pk ORDER BY fs.file_transfer_status_id_pk desc LIMIT 1 ) AS filetransferstatus ON true");
commandString.AppendLine("WHERE a.actor_external_id = @actorExternalId AND resource_id = @resourceId");
if (fileTransferSearch.Status.HasValue)
{
commandString.AppendLine("AND filetransferstatus.file_transfer_status_Description_id_fk = @fileTransferStatus");
}
string commandString = @"
SELECT DISTINCT afs.file_transfer_id_fk, 'Recipient', f.created
FROM broker.actor_file_transfer_status afs
INNER JOIN broker.file_transfer f on f.file_transfer_id_pk = afs.file_transfer_id_fk
INNER JOIN LATERAL (SELECT fs.file_transfer_status_description_id_fk FROM broker.file_transfer_status fs where fs.file_transfer_id_fk = f.file_transfer_id_pk ORDER BY fs.file_transfer_status_id_pk desc LIMIT 1 ) AS filetransferstatus ON true
WHERE afs.actor_id_fk = @actorId AND f.resource_id = @resourceId
{0}
{1}
UNION
SELECT f.file_transfer_id_pk, 'Sender', f.created
FROM broker.file_transfer f
INNER JOIN broker.actor a on a.actor_id_pk = f.sender_actor_id_fk
INNER JOIN LATERAL (SELECT fs.file_transfer_status_description_id_fk FROM broker.file_transfer_status fs where fs.file_transfer_id_fk = f.file_transfer_id_pk ORDER BY fs.file_transfer_status_id_pk desc LIMIT 1 ) AS filetransferstatus ON true
WHERE a.actor_external_id = @actorExternalId AND resource_id = @resourceId
{0}
{1}
ORDER BY created DESC
LIMIT 100;";

string statusCondition = fileTransferSearch.Status.HasValue
? "AND filetransferstatus.file_transfer_status_Description_id_fk = @fileTransferStatus"
: "";

string dateCondition = "";
if (fileTransferSearch.From.HasValue && fileTransferSearch.To.HasValue)
{
commandString.AppendLine("AND f.created between @from AND @to");
dateCondition = "AND f.created between @from AND @to";
}
else if (fileTransferSearch.From.HasValue)
{
commandString.AppendLine("AND f.created > @from");
dateCondition = "AND f.created > @from";
}
else if (fileTransferSearch.To.HasValue)
{
commandString.AppendLine("AND f.created < @to");
dateCondition = "AND f.created < @to";
}

commandString.AppendLine(";");
commandString = string.Format(commandString, statusCondition, dateCondition);

await using (var command = _dataSource.CreateCommand(
commandString.ToString()))
await using (var command = _dataSource.CreateCommand(commandString))
{
command.Parameters.AddWithValue("@actorId", fileTransferSearch.Actor.ActorId);
command.Parameters.AddWithValue("@resourceId", fileTransferSearch.ResourceId);
Expand All @@ -371,42 +363,61 @@ public async Task<List<Guid>> GetFileTransfersAssociatedWithActor(FileTransferSe

public async Task<List<Guid>> GetFileTransfersForRecipientWithRecipientStatus(FileTransferSearchEntity fileTransferSearch, CancellationToken cancellationToken)
{
StringBuilder commandString = new StringBuilder();
commandString.AppendLine("SELECT DISTINCT f.file_transfer_id_pk");
commandString.AppendLine("FROM broker.file_transfer f");
commandString.AppendLine("INNER JOIN LATERAL (SELECT afs.actor_file_transfer_status_description_id_fk FROM broker.actor_file_transfer_status afs WHERE afs.file_transfer_id_fk = f.file_transfer_id_pk AND afs.actor_id_fk = @recipientId ORDER BY afs.actor_file_transfer_status_description_id_fk desc LIMIT 1) AS recipientfilestatus ON true");
commandString.AppendLine("INNER JOIN LATERAL (SELECT fs.file_transfer_status_description_id_fk FROM broker.file_transfer_status fs where fs.file_transfer_id_fk = f.file_transfer_id_pk ORDER BY fs.file_transfer_status_id_pk desc LIMIT 1 ) AS filestatus ON true");
commandString.AppendLine("WHERE actor_file_transfer_status_description_id_fk = @recipientFileStatus AND resource_id = @resourceId");
if (fileTransferSearch.Status.HasValue)
{
commandString.AppendLine("AND file_transfer_status_description_id_fk = @fileStatus");
}
string commandString = @"
SELECT DISTINCT f.file_transfer_id_pk, f.created
FROM broker.file_transfer f
INNER JOIN LATERAL (
SELECT afs.actor_file_transfer_status_description_id_fk
FROM broker.actor_file_transfer_status afs
WHERE afs.file_transfer_id_fk = f.file_transfer_id_pk AND afs.actor_id_fk = @recipientId
ORDER BY afs.actor_file_transfer_status_description_id_fk desc
LIMIT 1
) AS recipientfilestatus ON true
INNER JOIN LATERAL (
SELECT fs.file_transfer_status_description_id_fk
FROM broker.file_transfer_status fs
WHERE fs.file_transfer_id_fk = f.file_transfer_id_pk
ORDER BY fs.file_transfer_status_id_pk desc
LIMIT 1
) AS filestatus ON true
WHERE actor_file_transfer_status_description_id_fk = @recipientFileStatus AND resource_id = @resourceId
{0}
{1}
ORDER BY created DESC
LIMIT 100;";

string statusCondition = fileTransferSearch.Status.HasValue
? "AND file_transfer_status_description_id_fk = @fileStatus"
: "";

string dateCondition = "";
if (fileTransferSearch.From.HasValue && fileTransferSearch.To.HasValue)
{
commandString.AppendLine("AND f.created between @from AND @to");
dateCondition = "AND f.created BETWEEN @from AND @to";
}
else if (fileTransferSearch.From.HasValue)
{
commandString.AppendLine("AND f.created > @from");
dateCondition = "AND f.created > @from";
}
else if (fileTransferSearch.To.HasValue)
{
commandString.AppendLine("AND f.created < @to");
dateCondition = "AND f.created < @to";
}

await using (var command = _dataSource.CreateCommand(
commandString.ToString()))
commandString = string.Format(commandString, statusCondition, dateCondition);

await using (var command = _dataSource.CreateCommand(commandString))
{
command.Parameters.AddWithValue("@recipientId", fileTransferSearch.Actor.ActorId);
command.Parameters.AddWithValue("@resourceId", fileTransferSearch.ResourceId);
command.Parameters.AddWithValue("@recipientFileStatus", (int)fileTransferSearch.RecipientStatus);

Check warning on line 413 in src/Altinn.Broker.Persistence/Repositories/FileTransferRepository.cs

View workflow job for this annotation

GitHub Actions / QA / Test application 

Nullable value type may be null.

if (fileTransferSearch.From.HasValue)
command.Parameters.AddWithValue("@From", fileTransferSearch.From);
command.Parameters.AddWithValue("@from", fileTransferSearch.From);
if (fileTransferSearch.To.HasValue)
command.Parameters.AddWithValue("@To", fileTransferSearch.To);
command.Parameters.AddWithValue("@to", fileTransferSearch.To);
if (fileTransferSearch.Status.HasValue)
command.Parameters.AddWithValue("@fileStatus", (int)fileTransferSearch.Status);
if (fileTransferSearch.RecipientStatus.HasValue)
command.Parameters.AddWithValue("@recipientFileStatus", (int)fileTransferSearch.RecipientStatus);

var files = new List<Guid>();
await using (var reader = await command.ExecuteReaderAsync(cancellationToken))
Expand All @@ -420,7 +431,6 @@ public async Task<List<Guid>> GetFileTransfersForRecipientWithRecipientStatus(Fi
return files;
}
}

public async Task SetStorageDetails(Guid fileTransferId, long storageProviderId, string fileLocation, long filesize, CancellationToken cancellationToken)
{
await using (var command = _dataSource.CreateCommand(
Expand Down

0 comments on commit 436ff70

Please sign in to comment.