Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reindex Check for Selectable Search Parameters #4813

Merged
merged 2 commits into from
Feb 7, 2025
Merged

Reindex Check for Selectable Search Parameters #4813

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b03008
Added in check for reindex job in progress. Added unit test to verify.
PTaladay Feb 5, 2025
05c8e09
Merge remote-tracking branch 'origin/main' into personal/patalada/103503
PTaladay Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/Microsoft.Health.Fhir.Core/Resources.Designer.cs
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions src/Microsoft.Health.Fhir.Core/Resources.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -757,4 +757,7 @@
<data name="OperationFailedForCustomerManagedKey" xml:space="preserve">
<value>Error occurred during an operation that is dependent on the customer-managed key. Use https://go.microsoft.com/fwlink/?linkid=2300268 to troubleshoot the issue.</value>
</data>
<data name="ReindexRunning" xml:space="preserve">
<value>A Reindex job is currenlty active. Search parameters cannot be updated until Reindex is complete.</value>
</data>
</root>
36 changes: 34 additions & 2 deletions ...tTests/Features/Operations/SearchParameterState/SearchParameterStateUpdateHandlerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,12 @@
using Microsoft.Extensions.Logging.Abstractions;
using Microsoft.Extensions.Options;
using Microsoft.Health.Core.Features.Security.Authorization;
using Microsoft.Health.Extensions.DependencyInjection;
using Microsoft.Health.Fhir.Core.Configs;
using Microsoft.Health.Fhir.Core.Extensions;
using Microsoft.Health.Fhir.Core.Features.Audit;
using Microsoft.Health.Fhir.Core.Features.Definition;
using Microsoft.Health.Fhir.Core.Features.Operations;
using Microsoft.Health.Fhir.Core.Features.Operations.SearchParameterState;
using Microsoft.Health.Fhir.Core.Features.Search;
using Microsoft.Health.Fhir.Core.Features.Search.Parameters;
Expand Down Expand Up @@ -60,13 +62,17 @@ public class SearchParameterStateUpdateHandlerTests
private readonly ILogger<SearchParameterStatusManager> _logger = Substitute.For<ILogger<SearchParameterStatusManager>>();
private readonly ILogger<SearchParameterStateUpdateHandler> _logger2 = Substitute.For<ILogger<SearchParameterStateUpdateHandler>>();
private readonly IAuditLogger _auditLogger = Substitute.For<IAuditLogger>();
private readonly Func<IScoped<IFhirOperationDataStore>> _fhirOperationDataStoreFactory;
private readonly IFhirOperationDataStore _fhirOperationDataStore = Substitute.For<IFhirOperationDataStore>();

public SearchParameterStateUpdateHandlerTests()
{
_searchParameterDefinitionManager = Substitute.For<SearchParameterDefinitionManager>(ModelInfoProvider.Instance, _mediator, _searchService.CreateMockScopeProvider(), NullLogger<SearchParameterDefinitionManager>.Instance);
_fhirOperationDataStore.CheckActiveReindexJobsAsync(CancellationToken.None).Returns((false, string.Empty));
_fhirOperationDataStoreFactory = () => _fhirOperationDataStore.CreateMockScope();

_searchParameterStatusManager = new SearchParameterStatusManager(_searchParameterStatusDataStore, _searchParameterDefinitionManager, _searchParameterSupportResolver, _mediator, _logger);
_searchParameterStateUpdateHandler = new SearchParameterStateUpdateHandler(_authorizationService, _searchParameterStatusManager, _logger2, _auditLogger);
_searchParameterStateUpdateHandler = new SearchParameterStateUpdateHandler(_authorizationService, _searchParameterStatusManager, _logger2, _auditLogger, _fhirOperationDataStoreFactory);
_cancellationToken = CancellationToken.None;

_authorizationService.CheckAccess(DataActions.SearchParameter, _cancellationToken).Returns(DataActions.SearchParameter);
Expand Down Expand Up @@ -269,7 +275,7 @@ public async Task GivenARequestToUpdateSearchParameterStatus_WhenRequestIsValied
await _searchParameterDefinitionManager.EnsureInitializedAsync(CancellationToken.None);

var loggers = CreateTestAuditLogger();
var searchParameterStateUpdateHandler = new SearchParameterStateUpdateHandler(_authorizationService, _searchParameterStatusManager, _logger2, loggers.auditLogger);
var searchParameterStateUpdateHandler = new SearchParameterStateUpdateHandler(_authorizationService, _searchParameterStatusManager, _logger2, loggers.auditLogger, _fhirOperationDataStoreFactory);
List<Tuple<Uri, SearchParameterStatus>> updates = new List<Tuple<Uri, SearchParameterStatus>>()
{
new Tuple<Uri, SearchParameterStatus>(new Uri(ResourceId), SearchParameterStatus.Disabled),
Expand All @@ -291,6 +297,32 @@ public async Task GivenARequestToUpdateSearchParameterStatus_WhenRequestIsValied
Assert.Contains("Status=PendingDisable", loggers.logger.LogRecords[0].State.ToString());
}

[Fact]
public async Task GivenARequestToUpdateSearchParameterStatus_WhenAReindexJobIsRunning_ThenAnOperationOutcomeIsReturnedIndicatingUpdatesAreNotAllowed()
{
List<Tuple<Uri, SearchParameterStatus>> updates = new List<Tuple<Uri, SearchParameterStatus>>()
{
new Tuple<Uri, SearchParameterStatus>(new Uri(NotFoundResource), SearchParameterStatus.Supported),
};

IFhirOperationDataStore fhirOperationDataStore = Substitute.For<IFhirOperationDataStore>();
fhirOperationDataStore.CheckActiveReindexJobsAsync(CancellationToken.None).Returns((true, string.Empty));
Func<IScoped<IFhirOperationDataStore>> fhirOperationDataStoreFactory = () => fhirOperationDataStore.CreateMockScope();

SearchParameterStateUpdateHandler searchParameterStateUpdateHandler = new SearchParameterStateUpdateHandler(_authorizationService, _searchParameterStatusManager, _logger2, _auditLogger, fhirOperationDataStoreFactory);
SearchParameterStateUpdateResponse response = await searchParameterStateUpdateHandler.Handle(new SearchParameterStateUpdateRequest(updates), default);

Assert.NotNull(response);
Assert.NotNull(response.UpdateStatus);

var unwrappedResponse = response.UpdateStatus.ToPoco<Hl7.Fhir.Model.Bundle>();
var resourceResponse = (OperationOutcome)unwrappedResponse.Entry[0].Resource;
var issue = resourceResponse.Issue[0];
Assert.True(issue.Details.Text == Fhir.Core.Resources.ReindexRunning);
Assert.True(issue.Severity == OperationOutcome.IssueSeverity.Error);
Assert.True(issue.Code == OperationOutcome.IssueType.Conflict);
}

private (IAuditLogger auditLogger, TestLogger logger) CreateTestAuditLogger()
{
IOptions<SecurityConfiguration> optionsConfig = Substitute.For<IOptions<SecurityConfiguration>>();
Expand Down
59 changes: 54 additions & 5 deletions ...Shared.Core/Features/Operations/SearchParameterState/SearchParameterStateUpdateHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@
using Microsoft.Health.Core;
using Microsoft.Health.Core.Features.Audit;
using Microsoft.Health.Core.Features.Security.Authorization;
using Microsoft.Health.Extensions.DependencyInjection;
using Microsoft.Health.Fhir.Core.Exceptions;
using Microsoft.Health.Fhir.Core.Extensions;
using Microsoft.Health.Fhir.Core.Features.Audit;
using Microsoft.Health.Fhir.Core.Features.Search.Parameters;
using Microsoft.Health.Fhir.Core.Features.Search.Registry;
using Microsoft.Health.Fhir.Core.Features.Security;
using Microsoft.Health.Fhir.Core.Messages.SearchParameterState;
Expand All @@ -34,18 +36,21 @@
private IReadOnlyCollection<ResourceSearchParameterStatus> _resourceSearchParameterStatus = null;
private readonly ILogger<SearchParameterStateUpdateHandler> _logger;
private readonly IAuditLogger _auditLogger;
private readonly Func<IScoped<IFhirOperationDataStore>> _fhirOperationDataStoreFactory;

public SearchParameterStateUpdateHandler(IAuthorizationService<DataActions> authorizationService, SearchParameterStatusManager searchParameterStatusManager, ILogger<SearchParameterStateUpdateHandler> logger, IAuditLogger auditLogger)
public SearchParameterStateUpdateHandler(IAuthorizationService<DataActions> authorizationService, SearchParameterStatusManager searchParameterStatusManager, ILogger<SearchParameterStateUpdateHandler> logger, IAuditLogger auditLogger, Func<IScoped<IFhirOperationDataStore>> fhirOperationDataStoreFactory)
{
EnsureArg.IsNotNull(authorizationService, nameof(authorizationService));
EnsureArg.IsNotNull(searchParameterStatusManager, nameof(searchParameterStatusManager));
EnsureArg.IsNotNull(logger, nameof(logger));
EnsureArg.IsNotNull(auditLogger, nameof(auditLogger));
EnsureArg.IsNotNull(fhirOperationDataStoreFactory, nameof(fhirOperationDataStoreFactory));

_authorizationService = authorizationService;
_searchParameterStatusManager = searchParameterStatusManager;
_logger = logger;
_auditLogger = auditLogger;
_fhirOperationDataStoreFactory = fhirOperationDataStoreFactory;
}

public async Task<SearchParameterStateUpdateResponse> Handle(SearchParameterStateUpdateRequest request, CancellationToken cancellationToken)
Expand All @@ -59,6 +64,12 @@

_resourceSearchParameterStatus = await _searchParameterStatusManager.GetAllSearchParameterStatus(cancellationToken);
Dictionary<SearchParameterStatus, List<string>> searchParametersToUpdate = ParseRequestForUpdate(request, out List<OperationOutcomeIssue> invalidSearchParameters);

if (await IsReindexRunning(cancellationToken))
{
return CreateBundleResponse(new Dictionary<SearchParameterStatus, List<string>>() { }, new List<OperationOutcomeIssue>() { }, true);
}

foreach (var statusGroup in searchParametersToUpdate)
{
await _searchParameterStatusManager.UpdateSearchParameterStatusAsync(statusGroup.Value, statusGroup.Key, cancellationToken);
Expand Down Expand Up @@ -109,13 +120,13 @@
{
searchParametersToUpdate.Add(statusValue, new List<string>() { uri.ToString() });
}
}

Check warning

Code scanning / CodeQL

Dereferenced variable may be null Warning

Variable
invalidSearchParameters
Loading
may be null at this access as suggested by
this
Loading
null check.
}

return searchParametersToUpdate;
}

private SearchParameterStateUpdateResponse CreateBundleResponse(Dictionary<SearchParameterStatus, List<string>> searchParametersToUpdate, List<OperationOutcomeIssue> invalidSearchParameters)
private SearchParameterStateUpdateResponse CreateBundleResponse(Dictionary<SearchParameterStatus, List<string>> searchParametersToUpdate, List<OperationOutcomeIssue> invalidSearchParameters, bool isReindexRunning = false)
{
// Create the bundle from the result.
var bundle = new Bundle();
Expand All @@ -126,7 +137,7 @@
{
Id = FailedSearchParameterUpdates,
Issue = new List<OperationOutcome.IssueComponent>(invalidSearchParameters.Select(x => x.ToPoco()).ToList()),
};

Check warning

Code scanning / CodeQL

Dereferenced variable may be null Warning

Variable
searchParametersToUpdate
Loading
may be null at this access as suggested by
this
Loading
null check.

bundle.Entry.Add(
new Bundle.EntryComponent
Expand Down Expand Up @@ -182,10 +193,33 @@
}

bundle.Entry.Add(
new Bundle.EntryComponent
new Bundle.EntryComponent
{
Resource = succeededResults,
});
}

if (isReindexRunning)
{
bundle.Entry.Add(
new Bundle.EntryComponent
{
Resource = new OperationOutcome
{
Resource = succeededResults,
});
Issue = new List<OperationOutcome.IssueComponent>
{
new OperationOutcome.IssueComponent
{
Severity = OperationOutcome.IssueSeverity.Error,
Code = OperationOutcome.IssueType.Conflict,
Details = new CodeableConcept
{
Text = Core.Resources.ReindexRunning,
},
},
},
},
});
}

bundle.Type = Bundle.BundleType.BatchResponse;
Expand All @@ -197,5 +231,20 @@

return new SearchParameterStateUpdateResponse(bundle.ToResourceElement());
}

private async Task<bool> IsReindexRunning(CancellationToken cancellationToken)
{
// check if reindex job is running
using (IScoped<IFhirOperationDataStore> fhirOperationDataStore = _fhirOperationDataStoreFactory())
{
(var activeReindexJobs, var reindexJobId) = await fhirOperationDataStore.Value.CheckActiveReindexJobsAsync(cancellationToken);

Check warning

Code scanning / CodeQL

Useless assignment to local variable Warning

This assignment to
reindexJobId
Loading
is useless, since its value is never read.

Copilot Autofix AI 21 days ago

To fix the problem, we need to remove the assignment to the reindexJobId variable since it is not used anywhere in the function. This can be done by modifying the tuple deconstruction to only include the activeReindexJobs variable.

  • Remove the assignment to reindexJobId in the tuple deconstruction.
  • Ensure that the functionality of the method remains unchanged.
Suggested changeset 1
src/Microsoft.Health.Fhir.Shared.Core/Features/Operations/SearchParameterState/SearchParameterStateUpdateHandler.cs

Autofix patch

Autofix patch
Run the following command in your local git repository to apply this patch
cat << 'EOF' | git apply
diff --git a/src/Microsoft.Health.Fhir.Shared.Core/Features/Operations/SearchParameterState/SearchParameterStateUpdateHandler.cs b/src/Microsoft.Health.Fhir.Shared.Core/Features/Operations/SearchParameterState/SearchParameterStateUpdateHandler.cs
--- a/src/Microsoft.Health.Fhir.Shared.Core/Features/Operations/SearchParameterState/SearchParameterStateUpdateHandler.cs
+++ b/src/Microsoft.Health.Fhir.Shared.Core/Features/Operations/SearchParameterState/SearchParameterStateUpdateHandler.cs
@@ -239,3 +239,3 @@
             {
-                (var activeReindexJobs, var reindexJobId) = await fhirOperationDataStore.Value.CheckActiveReindexJobsAsync(cancellationToken);
+                var (activeReindexJobs, _) = await fhirOperationDataStore.Value.CheckActiveReindexJobsAsync(cancellationToken);
                 if (activeReindexJobs)
EOF
@@ -239,3 +239,3 @@
{
(var activeReindexJobs, var reindexJobId) = await fhirOperationDataStore.Value.CheckActiveReindexJobsAsync(cancellationToken);
var (activeReindexJobs, _) = await fhirOperationDataStore.Value.CheckActiveReindexJobsAsync(cancellationToken);
if (activeReindexJobs)
Copilot is powered by AI and may make mistakes. Always verify output.
Positive Feedback
Negative Feedback

Provide additional feedback

Please help us improve GitHub Copilot by sharing more details about this comment.

Please select one or more of the options
if (activeReindexJobs)
{
return true;
}
}

return false;
}
}
}
Loading