Compare commits
7
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
50bf08f32a
|
||
|
|
024cda7b08
|
||
|
|
81f9917e10 | ||
|
|
bb556d9b0c | ||
|
|
1a4a29fa2b
|
||
|
|
7bf8f6c804 | ||
|
|
dbaf14a9b5 |
No files matched your search
@@ -1,7 +1,7 @@
|
||||
version: 2.1
|
||||
|
||||
orbs:
|
||||
qqq-orb: kingsrook/qqq-orb@0.6.8
|
||||
qqq-orb: kingsrook/qqq-orb@0.6.9
|
||||
|
||||
commands:
|
||||
configure-package-install:
|
||||
|
||||
@@ -6,6 +6,9 @@ All notable changes to this project are documented here. The format follows Keep
|
||||
|
||||
Requires QQQ 4.1.0-RC.6 or later (the spec-managed UI API extension contract).
|
||||
|
||||
### Fixed
|
||||
- Real-time indexing failures now increase the table's error count by the number of failed events. Successful basepulls and full reindexes reset the count. Counter update failures are logged without failing the source write.
|
||||
|
||||
### Added
|
||||
- Supported host status API (`api.QuickSearchStatusService.get()`), immutable status values, and `QuickSearchApi` home navigation constants (issue #50/F10). Permission-checked, bounded diagnostics refreshes share a short per-runtime cache and reuse saved validation counts. New spec-managed `GET /qqq/v1/qbit/quick-search/status` (`getQuickSearchStatus`) with committed OpenAPI fragment and strict HTTP/contract tests. RC.6 requires the default `/qbit/quick-search` prefix; `/quick-search` is not permitted by core. Existing routes and wire shapes are unchanged.
|
||||
- Record developer panel: `QuickSearchDeveloperPanelProvider` (id `quickSearch`) adds a "Quick Search" panel to the developer view of every record of an indexed table (`/app/{table}/{id}/dev` in the Next UI), for users who may read Quick Search Index. It shows the table's index row (enabled, status, record count, last basepull and full reindex, searchable fields), the latest index run, the record's indexed document compared field by field with the database (Inspect Search Document's comparison; needs `debugPermissionRules`), the record's failed index events, the Inspect Search Document and Reindex in Search actions the user may run, and links to the admin app and the index row. An unreachable OpenSearch shows a warning in the panel. Registered by `QuickSearchDeveloperPanelsMetaDataProducer`.
|
||||
@@ -17,6 +20,8 @@ Requires QQQ 4.1.0-RC.6 or later (the spec-managed UI API extension contract).
|
||||
- Possible-value sources `quick_search_eligible_table`, `quick_search_indexable_field`, `quick_search_timestamp_field`, `quick_search_field_role`, `quick_search_field_analyzer`, `quick_search_documents_choice`, `quick_search_config_source`; the join `quick_search_index_join_quick_search_index_field` and the Searchable Fields widget on the index record. Config tables are audited at field level.
|
||||
|
||||
### Changed
|
||||
- Distinguish protected fields from fields that simply cannot be searched. Boolean, blob and hidden fields no longer trigger result rebuilding or erase record labels. Labels are suppressed only when their source fields are protected; unprotected hidden primary keys and timestamps remain usable.
|
||||
- Exclude PII/PHI-classified fields (including table defaults) and field-security-locked fields everywhere Quick Search indexes or displays values. Configuration rejects protected fields; code defaults drop them with one warning per table. Search and diagnostics omit protected values from older documents. Rebuild existing indexes after upgrading or changing classification metadata. Uses QQQ 4.1.0-RC.6; no dependency changes.
|
||||
- `quick_search_index`: the generic Create and Delete are off (`TABLE_INSERT`, `TABLE_DELETE`); use Add Search Index and Remove Search Index. `quick_search_searchable_table` is now a custom source over the effective tables. `quick_search_index_run` gains `cancelRequested` and `cancelRequestedBy`.
|
||||
- Hidden and `isSensitive` fields are never indexed (previously hidden and password only).
|
||||
- Record screens (record-screen audit): `quick_search_index_run` and `quick_search_failed_event` are written by the QBit only, so Create and Edit are off (Delete stays, for clearing); both get named field sections, record labels and pickers (`quick_search_run_type`, `quick_search_run_status`, `quick_search_failed_event_status`, `quick_search_failed_event_action`, and the table picker for `tableName`). The index record lists its Recent Runs (join `quick_search_index_join_quick_search_index_run`). `quick_search_validation_run.reportJson` uses a JSON code editor. The Basepull, Full Reindex and Reconcile processes run from Quick Search Index's Actions and are no longer app (nav) children; their table input is `searchTableName` (`tableName` still works for API callers, and a Quick Search table name is ignored), so running them from the table no longer limits them to `quick_search_index`. Process input steps now carry `HELP_TEXT` and `EDIT_FORM` components, so the Next UI renders their fields.
|
||||
|
||||
@@ -257,6 +257,8 @@ The panel's status is Indexed, Stale, Not indexed, Disabled (the table is turned
|
||||
- `quick_search_validation_run` (with `enableDiagnosticTools`): `status` (`PASS`, `WARN`, `FAIL`), `triggerType` (`MANUAL`, `SCHEDULED`), `userName`, `tableNames`, `sampleSize`, `tablesChecked`, `failCount`, `warnCount`, `summary`, `reportHtml` (HTML), `reportJson` (text), `startTime`, `endTime`, `createDate`. Purged after `runHistoryRetentionDays`.
|
||||
- `quick_search_failed_event`: real-time events that could not be applied; `status` `PENDING` or `EXHAUSTED` after 10 attempts. Deletes made while a full reindex of all tables runs are also recorded here with status `AWAITING_REINDEX`: the reindex applies them to the new index after the alias swap (basepull does not replay them). While a table is `REBUILDING`, drift detection is suspended for it. Only one full reindex runs at a time: starting one while another is running fails. A full reindex shows it is running through its `FULL_REINDEX` run records, which stay `RUNNING` with `modifyDate` refreshed after every page. If it is killed mid-run (pod restart, OOM, deploy), recovery is automatic once its run records have shown no sign of life for `fullReindexStaleMinutes` (30 by default): the next basepull, or the next full reindex, marks those run records `FAILED`, returns the tables to `ACTIVE` with `lastBasepullTime` moved back to the run's start, and turns the `AWAITING_REINDEX` rows `PENDING` so basepull replays the deletes. No data is lost. A run that was only slow and is judged stopped notices before its alias swap and fails without swapping, or, after its swap, stops applying its captured deletes; basepull skips a replayed delete whose record exists again.
|
||||
|
||||
Real-time error counts on Quick Search Index show failures since the last successful full reindex or basepull. Each failed event increases the count; deferred changes while indexing is paused do not. Counter updates are best effort and serialized across listeners in one JVM; concurrent application nodes can still race because QQQ has no arithmetic update API.
|
||||
|
||||
## Extending
|
||||
|
||||
`IndexEventPublisher` lets a host replace the synchronous publisher with a queue. In 1.0 the SPI is experimental: `IndexEvent` carries the table, record id, action and the record snapshot, but no sequence number, so an asynchronous consumer must order INDEX and DELETE for the same record itself. `OpenSearchTransportCustomizer` customizes the HTTP transport.
|
||||
@@ -344,3 +346,36 @@ configured metadata prefix. `QuickSearchApi.APP_NAME` (`quickSearchAdmin`) and
|
||||
`QuickSearchApi.HOME_HREF` (`/app/quickSearchAdmin`) are available for default-name
|
||||
navigation. Keep detailed runs, failed events, validation and operator tools in the
|
||||
qbit's own home. [kof22 migration mapping](docs/STATUS-API-HOST-MIGRATION.md).
|
||||
|
||||
## Classified data
|
||||
|
||||
Quick Search excludes fields classified as **PII** or **PHI**, including fields
|
||||
that inherit the table's classification. It also excludes hidden, sensitive,
|
||||
password/masked fields and every field with a `FieldSecurityLock`; a shared
|
||||
search index cannot enforce access to individual fields for each user. PUBLIC,
|
||||
CONFIDENTIAL and unclassified fields remain eligible under the usual field rules.
|
||||
|
||||
The same rule applies to annotation and code configuration, admin field choices,
|
||||
real-time writes, basepull, rebuilds, replay, labels, snippets, analyzer copies and
|
||||
result display fields. An admin trying to add a protected field gets an error.
|
||||
Protected fields in existing or explicit code configuration are dropped, with one
|
||||
warning per table metadata lifetime; warnings never contain field values. A
|
||||
protected primary key prevents indexing the record or sending its ID for deletion.
|
||||
|
||||
Protection is separate from search eligibility: boolean, blob, hidden and other
|
||||
unsupported fields alone do not trigger result filtering or remove record labels.
|
||||
Labels are omitted when their source fields are protected; unrelated protected
|
||||
fields do not erase safe labels. Unprotected hidden keys and timestamps can still
|
||||
provide record IDs and document versions.
|
||||
|
||||
After upgrading, or after changing a field's classification or security metadata,
|
||||
run **Full Reindex** across all indexed tables to remove previously indexed values.
|
||||
Until then, tables containing protected fields are searched through allowed field
|
||||
values, and results are rebuilt without old combined labels or highlights.
|
||||
Diagnostic views also omit protected values and the raw response for these tables.
|
||||
This does not purge old OpenSearch backups or retained physical indexes; apply your
|
||||
host's retention policy to those copies.
|
||||
|
||||
This release uses the APIs in QQQ **4.1.0-RC.6**. Support for the host's
|
||||
`AuditValueProtector` classification (`ClassifiedValues`, qqq#1182) and
|
||||
`FieldAccessHelper.getLockTier` (qqq#1172) is deferred until the qbit moves to RC.7.
|
||||
+82
-1
@@ -1,6 +1,15 @@
|
||||
# Session State
|
||||
|
||||
Updated: 2026-10-13
|
||||
Updated: 2026-10-14
|
||||
|
||||
## Real-time error counter fix (2026-10-14)
|
||||
|
||||
- Failed-event recording now increments the table's `realTimeErrorCount` after commit, using QQQ reads and system writes. Null counts start at zero; update failures are logged and cannot fail the source write or prevent replay.
|
||||
- QQQ has no arithmetic update API. The read-modify-write fallback is serialized across listeners in this JVM; separate application nodes can still race.
|
||||
- Successful basepull and full-reindex status updates reset the count, including the single-table reindex path. Investigation found the previous zero assignments only initialized new rows. Field help, README and Unreleased changelog now describe the reset window.
|
||||
- Regression coverage includes event counts, concurrent listeners, counter-update failure, after-commit timing, basepull reset and both full-reindex reset paths.
|
||||
- Final gate: `./mvnw.cmd -o -B verify` passed against released QQQ 4.1.0-RC.6: 476 unit tests, zero failures/errors; 41 integration tests skipped because Docker is unavailable; architecture guardrails and JaCoCo coverage gates passed. No dependency changes or offline artifact gaps. Checkstyle, PMD and SpotBugs are not configured in this Maven build.
|
||||
- No commit, push or branch creation. Second-brain save is blocked by the vault being outside writable roots; this section retains the durable handoff for later vault synchronization.
|
||||
|
||||
## Status API worktree (2026-10-13, issue #50 / F10)
|
||||
|
||||
@@ -39,3 +48,75 @@ Updated: 2026-10-13
|
||||
1. qqq-all and Voyage pin `1.0.0-RC.2` and report back; their feedback decides RC.3 or GA.
|
||||
2. Remaining "Before 1.0.0 GA" items in `docs/TODO.md`: stuck `REBUILDING` after a killed or overlapping full reindex (from the PR #20 review), and the `qbit-build-parent` 2.1.0 re-pin.
|
||||
3. GA: merge `release/1.0` to `main` and tag `v1.0.0`.
|
||||
|
||||
## 2026-10-14 — secured-data section 15
|
||||
|
||||
- Implemented a shared RC.6 classification/security policy in `QuickSearchFieldRules`.
|
||||
- Applied it to config discovery, config writes/choices, document construction,
|
||||
safe query fields, result presentation and diagnostic reads; protected primary
|
||||
keys cannot be used as index IDs.
|
||||
- Added live-listener/basepull/stale-result PHI/PII canaries and config/rule tests.
|
||||
- Final gate: `mvnw.cmd -o -B verify` **BUILD SUCCESS**. 479 unit tests passed
|
||||
(7 new tests); 41 Docker integration tests skipped because Docker is unavailable.
|
||||
Architecture guardrails passed. JaCoCo: 73.84% instruction / 91.61% class coverage,
|
||||
above the 70% / 90% gates. Checkstyle, PMD and SpotBugs are not configured in this
|
||||
build. No missing offline artifacts. `git diff --check` passed.
|
||||
- Reviewed the diff; changes remain uncommitted. Gate log:
|
||||
`target/secured-data-verify.log`.
|
||||
- RC.7 host audit-protector classification and lock-tier APIs remain deferred.
|
||||
|
||||
### Changed files
|
||||
|
||||
- Documentation: `README.md`, `CHANGELOG.md`, `docs/SESSION-STATE.md`, `docs/TODO.md`.
|
||||
- Configuration: `QuickSearchQBitProducer.java`, `config/QuickSearchFieldRules.java`,
|
||||
`config/QuickSearchConfigPrimer.java`, `config/QuickSearchConfigStore.java`.
|
||||
- Indexing: `listeners/QuickSearchRecordChangeListener.java`,
|
||||
`processes/IndexingUtils.java`, `processes/AbstractIndexingStep.java`,
|
||||
`processes/BasepullIndexStep.java`.
|
||||
- Search and diagnostics: `actions/QuickSearchAction.java`,
|
||||
`actions/QuickSearchRecordSearchProvider.java`,
|
||||
`opensearch/QuickSearchOpenSearchClient.java`,
|
||||
`opensearch/QuickSearchDiagnosticsOperations.java`.
|
||||
- Tests: `config/QuickSearchConfigCustomizersTest.java`,
|
||||
`listeners/QuickSearchRecordChangeListenerTest.java`,
|
||||
`processes/IndexingUtilsTest.java`, `publisher/SynchronousIndexEventPublisherTest.java`,
|
||||
new `opensearch/ClassifiedDataCanaryTest.java`.
|
||||
|
||||
Production and test paths above are relative to
|
||||
`src/{main,test}/java/com/kingsrook/qbits/quicksearch/` respectively.
|
||||
|
||||
### Continuity
|
||||
|
||||
Second-brain project/daily writes are unavailable in this session because the
|
||||
vault lies outside the writable roots. This local checkpoint holds the durable
|
||||
outcome for the reviewer. No commit, push, branch creation, dependency version
|
||||
change, or production filesystem IO was introduced.
|
||||
|
||||
|
||||
## 2026-10-14 - protection review follow-up
|
||||
|
||||
- Added isProtected for PII/PHI (including table defaults), field locks, sensitive
|
||||
values and masked types. Unsupported search types and hidden fields alone are
|
||||
not protected. Searchable/snippet/display field lists still use isIndexable.
|
||||
- Labels check their configured/table source fields; unrelated protected fields
|
||||
preserve safe labels. A copied record prevents unsafe preformatted labels from
|
||||
returning through QQQ fallback formatting without changing the input record.
|
||||
- Primary-key guards and timestamp versions now use protection rather than
|
||||
search eligibility. Added four regression tests and extended rule/canary tests.
|
||||
- Follow-up files: config/QuickSearchFieldRules.java, processes/IndexingUtils.java,
|
||||
listeners/QuickSearchRecordChangeListener.java,
|
||||
opensearch/QuickSearchOpenSearchClient.java,
|
||||
opensearch/QuickSearchDiagnosticsOperations.java; test files
|
||||
config/QuickSearchConfigCustomizersTest.java, processes/IndexingUtilsTest.java,
|
||||
opensearch/ClassifiedDataCanaryTest.java; README.md, CHANGELOG.md,
|
||||
docs/TODO.md and this file. Java paths are relative to the existing main/test
|
||||
quicksearch packages. All earlier uncommitted work is preserved.
|
||||
- Second-brain project/daily synchronization remains unavailable because the vault
|
||||
is outside writable roots; this checkpoint is the local handoff. Nothing committed
|
||||
or pushed; no branches or dependency changes.
|
||||
- Final gate: `mvnw.cmd -o -B verify` BUILD SUCCESS; 483 unit tests passed
|
||||
(four additional tests); all three PHI/PII canaries passed. All 41 Docker
|
||||
integration tests skipped because Docker is unavailable. Architecture guards
|
||||
and JaCoCo passed (73.88% instruction / 91.61% class coverage).
|
||||
Checkstyle, PMD and SpotBugs are not configured in this build. No offline
|
||||
artifacts missing. Gate log: `target/protection-review-verify.log`.
|
||||
@@ -1,5 +1,9 @@
|
||||
# TODO
|
||||
|
||||
## Real-time error counter
|
||||
|
||||
- [x] Count failed real-time events after commit, serialize concurrent listeners within a JVM, tolerate counter-write failures, and reset after successful basepull/full reindex; add regression tests and field/documentation help.
|
||||
|
||||
## Architecture status API (#50 / F10)
|
||||
|
||||
- [x] Supported Java status API, bounded cache/rate limiting, administrator authorization, home navigation, spec endpoint and committed fragment.
|
||||
@@ -52,3 +56,12 @@
|
||||
- [x] Status assessment, deep-dive audit (25 blockers), PRD (2026-10-04).
|
||||
- [x] 4.1.0-RC.1 compatibility verified (2026-10-04).
|
||||
- [x] All 25 audit blockers implemented and tested on the release branch (2026-10-04).
|
||||
|
||||
## Secured-data section 15 (2026-10-14)
|
||||
|
||||
- [x] Review fix: separate protection from indexability; preserve safe labels, ordinary results and unprotected hidden keys/timestamps, with regression tests.
|
||||
|
||||
- [x] Exclude PII/PHI, hidden, sensitive, password and field-locked values from indexing and results on RC.6.
|
||||
- [x] Add canary coverage for real-time indexing, basepull and stale results; refuse classified config fields.
|
||||
- [ ] On the QQQ RC.7 upgrade, honour `ClassifiedValues.isClassified(table, field)` (qqq#1182) and `FieldAccessHelper.getLockTier` (qqq#1172).
|
||||
- [ ] Deployment: rebuild existing indexes and apply host retention policy to old physical indexes/backups containing previously indexed values.
|
||||
@@ -29,6 +29,7 @@ import com.kingsrook.qbits.quicksearch.actions.QuickSearchRecordSearchProvider;
|
||||
import com.kingsrook.qbits.quicksearch.annotations.QuickSearchField;
|
||||
import com.kingsrook.qbits.quicksearch.annotations.QuickSearchable;
|
||||
import com.kingsrook.qbits.quicksearch.api.QuickSearchApi;
|
||||
import com.kingsrook.qbits.quicksearch.config.QuickSearchFieldRules;
|
||||
import com.kingsrook.qbits.quicksearch.listeners.QuickSearchRecordChangeListener;
|
||||
import com.kingsrook.qbits.quicksearch.metadata.QuickSearchAdminAppMetaDataProducer;
|
||||
import com.kingsrook.qbits.quicksearch.metadata.QuickSearchDiagnosticsProcessMetaDataHelper;
|
||||
@@ -380,8 +381,8 @@ public class QuickSearchQBitProducer implements QBitMetaDataProducer<QuickSearch
|
||||
for(String fieldName : CollectionUtils.nonNullList(tableConfig.getSearchableFields()))
|
||||
{
|
||||
QFieldMetaData field = table.getFields() == null ? null : table.getFields().get(fieldName);
|
||||
if(field != null && !Boolean.TRUE.equals(field.getIsHidden()) && field.getType() != null
|
||||
&& (field.getType().isStringLike() || field.getType().isIntegral()) && !field.getType().needsMasked() && !field.getIsSensitive()
|
||||
if(QuickSearchFieldRules.isIndexable(table, fieldName)
|
||||
&& (field.getType().isStringLike() || field.getType().isIntegral())
|
||||
&& !searchFields.contains(fieldName))
|
||||
{
|
||||
searchFields.add(fieldName);
|
||||
@@ -466,7 +467,7 @@ public class QuickSearchQBitProducer implements QBitMetaDataProducer<QuickSearch
|
||||
{
|
||||
primaryKeyField = table.getPrimaryKeyField();
|
||||
basepullTimestampField = resolveTimestampField(table, searchableFields, basepullTimestampField);
|
||||
removeHiddenFields(table, searchableFields, fieldWeights, fieldIncludeLabels);
|
||||
removeExcludedFields(table, searchableFields, fieldWeights, fieldIncludeLabels);
|
||||
}
|
||||
|
||||
tables.add(new QuickSearchableTableConfig()
|
||||
@@ -523,7 +524,7 @@ public class QuickSearchQBitProducer implements QBitMetaDataProducer<QuickSearch
|
||||
warnIncrementalBasepullDisabled(table, basepullTimestampField);
|
||||
basepullTimestampField = null;
|
||||
}
|
||||
removeHiddenFields(table, searchableFields, fieldWeights, fieldIncludeLabels);
|
||||
removeExcludedFields(table, searchableFields, fieldWeights, fieldIncludeLabels);
|
||||
}
|
||||
|
||||
Integer basepullInterval = stc.getBasepullIntervalMinutes();
|
||||
@@ -603,23 +604,22 @@ public class QuickSearchQBitProducer implements QBitMetaDataProducer<QuickSearch
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Hidden, isSensitive and password fields are never indexed: their values
|
||||
** Classified, locked, hidden, sensitive and password fields are excluded:
|
||||
** would leak through searchable text and highlights.
|
||||
*******************************************************************************/
|
||||
private static void removeHiddenFields(QTableMetaData table, List<String> searchableFields, Map<String, Integer> fieldWeights, Map<String, Boolean> fieldIncludeLabels)
|
||||
private static void removeExcludedFields(QTableMetaData table, List<String> searchableFields, Map<String, Integer> fieldWeights, Map<String, Boolean> fieldIncludeLabels)
|
||||
{
|
||||
List<String> hidden = new ArrayList<>();
|
||||
for(String fieldName : searchableFields)
|
||||
{
|
||||
QFieldMetaData field = table.getFields().get(fieldName);
|
||||
if(field != null && (Boolean.TRUE.equals(field.getIsHidden()) || field.getIsSensitive() || (field.getType() != null && field.getType().needsMasked())))
|
||||
if(!QuickSearchFieldRules.isIndexable(table, fieldName))
|
||||
{
|
||||
hidden.add(fieldName);
|
||||
}
|
||||
}
|
||||
if(!hidden.isEmpty())
|
||||
{
|
||||
LOG.warn("Hidden, sensitive and password fields are excluded from Quick Search indexing", logPair("tableName", table.getName()), logPair("fields", hidden));
|
||||
QuickSearchFieldRules.warnExcludedFields(table);
|
||||
searchableFields.removeAll(hidden);
|
||||
hidden.forEach(fieldWeights::remove);
|
||||
hidden.forEach(fieldIncludeLabels::remove);
|
||||
|
||||
@@ -46,6 +46,7 @@ import com.kingsrook.qbits.quicksearch.QuickSearchQBitConfig;
|
||||
import com.kingsrook.qbits.quicksearch.QuickSearchQBitContext;
|
||||
import com.kingsrook.qbits.quicksearch.QuickSearchRuntime;
|
||||
import com.kingsrook.qbits.quicksearch.QuickSearchableTableConfig;
|
||||
import com.kingsrook.qbits.quicksearch.config.QuickSearchFieldRules;
|
||||
import com.kingsrook.qbits.quicksearch.diagnostics.DiagnosticsSupport;
|
||||
import com.kingsrook.qbits.quicksearch.model.QuickSearchDiagnosticEvent;
|
||||
import com.kingsrook.qbits.quicksearch.opensearch.OpenSearchDocument;
|
||||
@@ -221,7 +222,7 @@ public class QuickSearchAction
|
||||
if(!applyLocks)
|
||||
{
|
||||
SearchResponse<OpenSearchDocument> response = runSearch(client, term, tables, pageSize, offset, tableConfigs, null);
|
||||
List<QuickSearchResult> results = toResults(response);
|
||||
List<QuickSearchResult> results = toResults(response, tableConfigs);
|
||||
|
||||
long totalHits = response.hits().total() != null ? response.hits().total().value() : results.size();
|
||||
boolean lowerBound = response.hits().total() != null && response.hits().total().relation() == TotalHitsRelation.Gte;
|
||||
@@ -255,7 +256,7 @@ public class QuickSearchAction
|
||||
rawFloor = response.hits().total() != null && response.hits().total().relation() == TotalHitsRelation.Gte;
|
||||
|
||||
List<QuickSearchResult> candidates = new ArrayList<>();
|
||||
for(QuickSearchResult result : toResults(response))
|
||||
for(QuickSearchResult result : toResults(response, tableConfigs))
|
||||
{
|
||||
if(seen.add(result.getTableName() + ":" + result.getRecordId()))
|
||||
{
|
||||
@@ -315,7 +316,7 @@ public class QuickSearchAction
|
||||
List<String> allowed = new ArrayList<>();
|
||||
for(String tableName : new LinkedHashSet<>(requested))
|
||||
{
|
||||
if(!configured.contains(tableName))
|
||||
if(!configured.contains(tableName) || QuickSearchFieldRules.hasProtectedPrimaryKey(tableName))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
@@ -407,7 +408,7 @@ public class QuickSearchAction
|
||||
/*******************************************************************************
|
||||
**
|
||||
*******************************************************************************/
|
||||
private static List<QuickSearchResult> toResults(SearchResponse<OpenSearchDocument> response)
|
||||
private static List<QuickSearchResult> toResults(SearchResponse<OpenSearchDocument> response, List<QuickSearchableTableConfig> tableConfigs)
|
||||
{
|
||||
QInstance qInstance = QContext.getQInstance();
|
||||
List<QuickSearchResult> results = new ArrayList<>();
|
||||
@@ -420,9 +421,16 @@ public class QuickSearchAction
|
||||
continue;
|
||||
}
|
||||
|
||||
String highlightSnippet = null;
|
||||
String sourceTable = source.getSourceTable();
|
||||
boolean filterFields = QuickSearchFieldRules.requiresFieldFiltering(sourceTable);
|
||||
source = IndexingUtils.filterResult(source, tableConfigs.stream().filter(c -> sourceTable.equals(c.getTableName())).findFirst().orElse(null));
|
||||
if(source == null)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
String highlightSnippet = filterFields ? source.getSearchableText() : null;
|
||||
Map<String, List<String>> highlight = hit.highlight();
|
||||
if(highlight != null)
|
||||
if(highlight != null && !filterFields)
|
||||
{
|
||||
List<String> fragments = highlight.get("searchableText");
|
||||
if(fragments != null && !fragments.isEmpty())
|
||||
|
||||
+4
-2
@@ -32,6 +32,7 @@ import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
|
||||
import com.kingsrook.qqq.backend.core.utils.CollectionUtils;
|
||||
import com.kingsrook.qbits.quicksearch.QuickSearchQBitConfig;
|
||||
import com.kingsrook.qbits.quicksearch.QuickSearchRuntime;
|
||||
import com.kingsrook.qbits.quicksearch.config.QuickSearchFieldRules;
|
||||
import com.kingsrook.qbits.quicksearch.diagnostics.DiagnosticsSupport;
|
||||
import com.kingsrook.qbits.quicksearch.model.QuickSearchDiagnosticEvent;
|
||||
import com.kingsrook.qbits.quicksearch.processes.IndexingUtils;
|
||||
@@ -85,7 +86,7 @@ public class QuickSearchRecordSearchProvider implements RecordSearchProviderInte
|
||||
return (false);
|
||||
}
|
||||
|
||||
if(runtime.getTableConfig(table.getName()) == null)
|
||||
if(runtime.getTableConfig(table.getName()) == null || QuickSearchFieldRules.hasProtectedPrimaryKey(table.getName()))
|
||||
{
|
||||
return (false);
|
||||
}
|
||||
@@ -120,7 +121,8 @@ public class QuickSearchRecordSearchProvider implements RecordSearchProviderInte
|
||||
List<String> tableNames = new ArrayList<>();
|
||||
for(String tableName : new LinkedHashSet<>(CollectionUtils.nonNullList(input.getTableNames())))
|
||||
{
|
||||
if(runtime.getTableConfig(tableName) != null)
|
||||
if(runtime.getTableConfig(tableName) != null
|
||||
&& !QuickSearchFieldRules.hasProtectedPrimaryKey(tableName))
|
||||
{
|
||||
tableNames.add(tableName);
|
||||
}
|
||||
|
||||
@@ -238,8 +238,7 @@ public class QuickSearchConfigPrimer
|
||||
}
|
||||
if(!QuickSearchFieldRules.isIndexable(table, fieldName))
|
||||
{
|
||||
LOG.warn("A field declared searchable in code cannot be indexed; it is not primed: " + QuickSearchFieldRules.whyNotIndexable(table, fieldName),
|
||||
logPair("tableName", tableName), logPair("fieldName", fieldName));
|
||||
QuickSearchFieldRules.warnExcludedFields(table);
|
||||
continue;
|
||||
}
|
||||
codeFields.add(codeFieldRow(code, fieldName, i));
|
||||
|
||||
@@ -377,7 +377,7 @@ public class QuickSearchConfigStore
|
||||
String problem = QuickSearchFieldRules.whyNotIndexable(table, fieldName);
|
||||
if(problem != null)
|
||||
{
|
||||
LOG.warn("Quick Search field row skipped: " + problem, logPair("tableName", tableName), logPair("fieldName", fieldName));
|
||||
QuickSearchFieldRules.warnExcludedFields(table);
|
||||
continue;
|
||||
}
|
||||
if(fields.contains(fieldName))
|
||||
|
||||
@@ -23,9 +23,14 @@ import java.util.LinkedHashSet;
|
||||
import java.util.List;
|
||||
import java.util.Locale;
|
||||
import java.util.Set;
|
||||
import java.util.WeakHashMap;
|
||||
import java.util.regex.Pattern;
|
||||
import com.kingsrook.qqq.backend.core.actions.ai.AiDataClassifications;
|
||||
import com.kingsrook.qqq.backend.core.actions.ai.DataClassification;
|
||||
import com.kingsrook.qqq.backend.core.actions.permissions.PermissionsHelper;
|
||||
import com.kingsrook.qqq.backend.core.actions.permissions.TablePermissionSubType;
|
||||
import com.kingsrook.qqq.backend.core.context.QContext;
|
||||
import com.kingsrook.qqq.backend.core.logging.QLogger;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryInput;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.QBackendMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
|
||||
@@ -48,11 +53,14 @@ import com.kingsrook.qbits.quicksearch.model.QuickSearchFieldRole;
|
||||
** on backend variants, not produced by a QBit (qbit-internal), not a QQQ
|
||||
** system table (audits, saved views and reports, scheduled jobs, scripts),
|
||||
** not named like a secret store, and has at least one indexable field. A
|
||||
** field is indexable when it is not hidden, not isSensitive, not a password
|
||||
** and not a blob or boolean.
|
||||
** field is indexable when it is not PII/PHI-classified, locked, hidden,
|
||||
** sensitive, masked, a blob or a boolean.
|
||||
*******************************************************************************/
|
||||
public final class QuickSearchFieldRules
|
||||
{
|
||||
private static final QLogger LOG = QLogger.getLogger(QuickSearchFieldRules.class);
|
||||
private static final WeakHashMap<QTableMetaData, Boolean> WARNED_TABLES = new WeakHashMap<>();
|
||||
|
||||
public static final int MAX_DEFAULT_FIELDS = 20;
|
||||
public static final int TITLE_WEIGHT = 3;
|
||||
|
||||
@@ -85,6 +93,9 @@ public final class QuickSearchFieldRules
|
||||
|
||||
/*******************************************************************************
|
||||
** Why a field cannot be indexed, or null when it can.
|
||||
** When the qbit moves to QQQ 4.1.0-RC.7, also honour core
|
||||
** ClassifiedValues.isClassified(table, field) (the host's AuditValueProtector
|
||||
** classification, qqq#1182) and FieldAccessHelper.getLockTier (qqq#1172).
|
||||
*******************************************************************************/
|
||||
public static String whyNotIndexable(QTableMetaData table, String fieldName)
|
||||
{
|
||||
@@ -101,6 +112,15 @@ public final class QuickSearchFieldRules
|
||||
{
|
||||
return ("field [" + fieldName + "] is hidden");
|
||||
}
|
||||
DataClassification classification = AiDataClassifications.ofField(table, fieldName);
|
||||
if(classification == DataClassification.PII || classification == DataClassification.PHI)
|
||||
{
|
||||
return ("field [" + fieldName + "] is classified " + classification + " and cannot be indexed");
|
||||
}
|
||||
if(field.getFieldSecurityLock() != null)
|
||||
{
|
||||
return ("field [" + fieldName + "] has a field security lock and cannot be indexed");
|
||||
}
|
||||
if(field.getIsSensitive() || (field.getType() != null && field.getType().needsMasked()))
|
||||
{
|
||||
return ("field [" + fieldName + "] is sensitive (its values must not reach the search index)");
|
||||
@@ -124,6 +144,96 @@ public final class QuickSearchFieldRules
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Whether a field contains protected values, independently of searchability.
|
||||
** Classification falls back to the table. When the qbit moves to QQQ
|
||||
** 4.1.0-RC.7, also honour ClassifiedValues.isClassified(table, field)
|
||||
** (qqq#1182) and FieldAccessHelper.getLockTier (qqq#1172).
|
||||
*******************************************************************************/
|
||||
public static boolean isProtected(QTableMetaData table, String fieldName)
|
||||
{
|
||||
QFieldMetaData field = table == null || fieldName == null ? null : table.getFields().get(fieldName);
|
||||
if(field == null)
|
||||
{
|
||||
return (false);
|
||||
}
|
||||
DataClassification classification = AiDataClassifications.ofField(table, fieldName);
|
||||
return (classification == DataClassification.PII || classification == DataClassification.PHI
|
||||
|| field.getFieldSecurityLock() != null || field.getIsSensitive()
|
||||
|| (field.getType() != null && field.getType().needsMasked()));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Warn once per table metadata lifetime; never include record values.
|
||||
*******************************************************************************/
|
||||
public static synchronized void warnExcludedFields(QTableMetaData table)
|
||||
{
|
||||
if(table != null && WARNED_TABLES.put(table, Boolean.TRUE) == null)
|
||||
{
|
||||
LOG.warn("Quick Search dropped fields that cannot be indexed (classified PII/PHI, secured, hidden, sensitive or unsupported fields) from table [" + table.getName() + "]");
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Filter explicit field lists as well as cached configurations at use time.
|
||||
*******************************************************************************/
|
||||
public static List<String> indexableFields(QTableMetaData table, List<String> fields)
|
||||
{
|
||||
List<String> result = new ArrayList<>();
|
||||
for(String field : CollectionUtils.nonNullList(fields))
|
||||
{
|
||||
if(isIndexable(table, field))
|
||||
{
|
||||
result.add(field);
|
||||
}
|
||||
else
|
||||
{
|
||||
warnExcludedFields(table);
|
||||
}
|
||||
}
|
||||
return (result);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Resolve a table's metadata for backend query and result filtering.
|
||||
*******************************************************************************/
|
||||
public static QTableMetaData lookupTable(String tableName)
|
||||
{
|
||||
QInstance instance = QContext.getQInstance();
|
||||
return (instance == null || tableName == null ? null : instance.getTable(tableName));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Combined text and labels from an older index cannot be attributed to
|
||||
** individual fields. Use only allowed field values for these tables.
|
||||
*******************************************************************************/
|
||||
public static boolean requiresFieldFiltering(String tableName)
|
||||
{
|
||||
QTableMetaData table = lookupTable(tableName);
|
||||
return (table != null && table.getFields().keySet().stream().anyMatch(f -> isProtected(table, f)));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** A protected primary key cannot be sent as an index id, even for deletes.
|
||||
*******************************************************************************/
|
||||
public static boolean hasProtectedPrimaryKey(String tableName)
|
||||
{
|
||||
QTableMetaData table = lookupTable(tableName);
|
||||
return (table != null && isProtected(table, table.getPrimaryKeyField()));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** The indexable fields of a table, in the table's order.
|
||||
*******************************************************************************/
|
||||
|
||||
+68
-1
@@ -19,7 +19,9 @@ package com.kingsrook.qbits.quicksearch.listeners;
|
||||
|
||||
import java.io.Serializable;
|
||||
import java.util.ArrayList;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import com.kingsrook.qqq.backend.core.actions.tables.InsertAction;
|
||||
import com.kingsrook.qqq.backend.core.actions.tables.QueryAction;
|
||||
import com.kingsrook.qqq.backend.core.actions.tables.UpdateAction;
|
||||
@@ -39,6 +41,7 @@ import com.kingsrook.qqq.backend.core.model.data.QRecord;
|
||||
import com.kingsrook.qqq.backend.core.utils.CollectionUtils;
|
||||
import com.kingsrook.qbits.quicksearch.QuickSearchRuntime;
|
||||
import com.kingsrook.qbits.quicksearch.QuickSearchableTableConfig;
|
||||
import com.kingsrook.qbits.quicksearch.config.QuickSearchConfigWrites;
|
||||
import com.kingsrook.qbits.quicksearch.config.QuickSearchFieldRules;
|
||||
import com.kingsrook.qbits.quicksearch.model.QuickSearchFailedEvent;
|
||||
import com.kingsrook.qbits.quicksearch.processes.AbstractIndexingStep;
|
||||
@@ -117,6 +120,11 @@ public class QuickSearchRecordChangeListener implements RecordChangeListenerInte
|
||||
}
|
||||
|
||||
String primaryKeyField = tableConfig.getPrimaryKeyField() != null ? tableConfig.getPrimaryKeyField() : "id";
|
||||
if(QuickSearchFieldRules.lookupTable(tableName) == null || QuickSearchFieldRules.isProtected(QuickSearchFieldRules.lookupTable(tableName), primaryKeyField))
|
||||
{
|
||||
QuickSearchFieldRules.warnExcludedFields(QuickSearchFieldRules.lookupTable(tableName));
|
||||
return;
|
||||
}
|
||||
|
||||
///////////////////////////////////////////////////////////////////////////
|
||||
// paused: index nothing, but keep the written keys (DEFERRED), which //
|
||||
@@ -283,6 +291,7 @@ public class QuickSearchRecordChangeListener implements RecordChangeListenerInte
|
||||
}
|
||||
|
||||
insertFailedEventRows(runtime, events, message, QuickSearchFailedEvent.STATUS_PENDING);
|
||||
incrementRealTimeErrorCounts(runtime, events);
|
||||
}
|
||||
catch(Exception e)
|
||||
{
|
||||
@@ -292,6 +301,54 @@ public class QuickSearchRecordChangeListener implements RecordChangeListenerInte
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** QQQ UpdateInput has no arithmetic update. Serialize this read-modify-write
|
||||
** across listeners in this JVM, after the source transaction has committed.
|
||||
** Counter failures must not prevent replay or fail the source write.
|
||||
*******************************************************************************/
|
||||
private static synchronized void incrementRealTimeErrorCounts(QuickSearchRuntime runtime, List<IndexEvent> events)
|
||||
{
|
||||
Map<String, Integer> counts = new HashMap<>();
|
||||
for(IndexEvent event : events)
|
||||
{
|
||||
counts.merge(event.getTableName(), 1, Integer::sum);
|
||||
}
|
||||
|
||||
for(Map.Entry<String, Integer> entry : counts.entrySet())
|
||||
{
|
||||
try
|
||||
{
|
||||
String indexTable = runtime.getConfig().getQuickSearchIndexTableName();
|
||||
QueryInput queryInput = new QueryInput();
|
||||
queryInput.setTableName(indexTable);
|
||||
queryInput.setFilter(new QQueryFilter(new QFilterCriteria("tableName", QCriteriaOperator.EQUALS, entry.getKey())).withLimit(1));
|
||||
List<QRecord> rows = new QueryAction().execute(queryInput).getRecords();
|
||||
if(CollectionUtils.nullSafeIsEmpty(rows))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
QRecord row = rows.get(0);
|
||||
Integer previous = row.getValueInteger("realTimeErrorCount");
|
||||
UpdateInput updateInput = new UpdateInput();
|
||||
updateInput.setTableName(indexTable);
|
||||
updateInput.setRecords(List.of(new QRecord().withValue("id", row.getValue("id"))
|
||||
.withValue("realTimeErrorCount", Math.addExact(previous == null ? 0 : previous, entry.getValue()))));
|
||||
List<QRecord> updated = QuickSearchConfigWrites.asSystem(() -> new UpdateAction().execute(updateInput)).getRecords();
|
||||
if(CollectionUtils.nullSafeIsEmpty(updated) || CollectionUtils.nullSafeHasContents(updated.get(0).getErrors()))
|
||||
{
|
||||
throw (new QException("Counter update returned errors"));
|
||||
}
|
||||
}
|
||||
catch(Exception | LinkageError e)
|
||||
{
|
||||
LOG.warn("Could not increment real-time indexing error count", e, logPair("tableName", entry.getKey()));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Keep changes made while indexing is paused, for the basepull to replay
|
||||
** when it resumes. Never throws.
|
||||
@@ -462,7 +519,17 @@ public class QuickSearchRecordChangeListener implements RecordChangeListenerInte
|
||||
{
|
||||
continue;
|
||||
}
|
||||
events.add(new IndexEvent().withAction(IndexEventAction.INDEX).withTableName(tableName).withRecordId(recordId).withRecord(record));
|
||||
QRecord safeRecord = new QRecord();
|
||||
for(var field : QuickSearchFieldRules.indexableFields(QuickSearchFieldRules.lookupTable(tableName)))
|
||||
{
|
||||
safeRecord.setValue(field.getName(), record.getValue(field.getName()));
|
||||
safeRecord.setDisplayValue(field.getName(), record.getDisplayValue(field.getName()));
|
||||
}
|
||||
if(!QuickSearchFieldRules.requiresFieldFiltering(tableName))
|
||||
{
|
||||
safeRecord.setRecordLabel(record.getRecordLabel());
|
||||
}
|
||||
events.add(new IndexEvent().withAction(IndexEventAction.INDEX).withTableName(tableName).withRecordId(recordId).withRecord(safeRecord));
|
||||
}
|
||||
return (events);
|
||||
}
|
||||
|
||||
+3
-1
@@ -26,6 +26,7 @@ import com.kingsrook.qqq.backend.core.model.metadata.fields.AdornmentType;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.fields.FieldAdornment;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.help.QHelpContent;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.layout.QIcon;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.possiblevalues.QPossibleValueSource;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.tables.Association;
|
||||
@@ -99,7 +100,8 @@ public class QuickSearchTableMetaDataHelper
|
||||
.withField(new QFieldMetaData("lastErrorMessage", QFieldType.TEXT).withIsEditable(false))
|
||||
.withField(new QFieldMetaData("recordCount", QFieldType.INTEGER).withIsEditable(false))
|
||||
.withField(new QFieldMetaData("documentCount", QFieldType.INTEGER).withIsEditable(false))
|
||||
.withField(new QFieldMetaData("realTimeErrorCount", QFieldType.INTEGER).withIsEditable(false))
|
||||
.withField(new QFieldMetaData("realTimeErrorCount", QFieldType.INTEGER).withIsEditable(false)
|
||||
.withHelpContent(new QHelpContent("Real-time indexing failures since the last full reindex or basepull")))
|
||||
.withField(new QFieldMetaData("status", QFieldType.STRING).withIsEditable(false))
|
||||
.withField(new QFieldMetaData("createDate", QFieldType.DATE_TIME).withIsEditable(false))
|
||||
.withField(new QFieldMetaData("modifyDate", QFieldType.DATE_TIME).withIsEditable(false))
|
||||
|
||||
+54
-8
@@ -33,6 +33,8 @@ import com.fasterxml.jackson.databind.node.JsonNodeFactory;
|
||||
import com.fasterxml.jackson.databind.node.ObjectNode;
|
||||
import com.kingsrook.qqq.backend.core.exceptions.QException;
|
||||
import com.kingsrook.qbits.quicksearch.QuickSearchableTableConfig;
|
||||
import com.kingsrook.qbits.quicksearch.config.QuickSearchFieldRules;
|
||||
import com.kingsrook.qbits.quicksearch.processes.IndexingUtils;
|
||||
import jakarta.json.stream.JsonGenerator;
|
||||
import org.opensearch.client.json.JsonpMapper;
|
||||
import org.opensearch.client.json.JsonpSerializable;
|
||||
@@ -42,6 +44,7 @@ import org.opensearch.client.opensearch._types.query_dsl.Query;
|
||||
import org.opensearch.client.opensearch.core.ExplainResponse;
|
||||
import org.opensearch.client.opensearch.core.SearchRequest;
|
||||
import org.opensearch.client.opensearch.core.SearchResponse;
|
||||
import org.opensearch.client.opensearch.core.search.Highlight;
|
||||
import org.opensearch.client.opensearch.core.search.Hit;
|
||||
import org.opensearch.client.opensearch.core.search.HighlightField;
|
||||
import org.opensearch.client.opensearch.core.search.MatchedQueries;
|
||||
@@ -169,13 +172,14 @@ public class QuickSearchDiagnosticsOperations
|
||||
{
|
||||
int boundedSize = Math.max(1, Math.min(size, MAX_PROBE_SIZE));
|
||||
Query query = quickSearchClient.buildSearchQuery(term, List.of(tableName), tableConfigs, true);
|
||||
Highlight highlight = QuickSearchFieldRules.requiresFieldFiltering(tableName) ? null : Highlight.of(h -> h
|
||||
.requireFieldMatch(true)
|
||||
.fields("searchableText", HighlightField.of(hf -> hf))
|
||||
.fields("fieldValues.*", HighlightField.of(hf -> hf)));
|
||||
SearchRequest request = SearchRequest.of(r -> r
|
||||
.index(indexName)
|
||||
.query(query)
|
||||
.highlight(h -> h
|
||||
.requireFieldMatch(true)
|
||||
.fields("searchableText", HighlightField.of(hf -> hf))
|
||||
.fields("fieldValues.*", HighlightField.of(hf -> hf)))
|
||||
.highlight(highlight)
|
||||
.trackTotalHits(t -> t.count(QuickSearchOpenSearchClient.MAX_RESULT_WINDOW))
|
||||
.size(boundedSize));
|
||||
|
||||
@@ -189,17 +193,26 @@ public class QuickSearchDiagnosticsOperations
|
||||
for(Hit<OpenSearchDocument> hit : response.hits().hits())
|
||||
{
|
||||
OpenSearchDocument source = hit.source();
|
||||
boolean filterFields = QuickSearchFieldRules.requiresFieldFiltering(tableName);
|
||||
if(source != null)
|
||||
{
|
||||
source = IndexingUtils.filterResult(source, tableConfigs.stream().filter(c -> tableName.equals(c.getTableName())).findFirst().orElse(null));
|
||||
}
|
||||
if(filterFields && source == null)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
hits.add(new ProbeHit(
|
||||
source == null ? idFromDocumentId(hit.id()) : source.getRecordId(),
|
||||
source == null ? null : source.getRecordLabel(),
|
||||
hit.score(),
|
||||
matchedClauses(hit.matchedQueries()),
|
||||
hit.highlight() == null ? Map.of() : new LinkedHashMap<>(hit.highlight())));
|
||||
filterFields || hit.highlight() == null ? Map.of() : new LinkedHashMap<>(hit.highlight())));
|
||||
}
|
||||
|
||||
Long total = response.hits().total() == null ? (long) hits.size() : response.hits().total().value();
|
||||
Boolean lowerBound = response.hits().total() != null && response.hits().total().relation() == TotalHitsRelation.Gte;
|
||||
return (new SearchProbe(tableName, toJson(request), toJson(response), response.took(), wall, total, lowerBound, hits));
|
||||
return (new SearchProbe(tableName, toJson(request), QuickSearchFieldRules.requiresFieldFiltering(tableName) ? "{}" : toJson(response), response.took(), wall, total, lowerBound, hits));
|
||||
}
|
||||
catch(OpenSearchException | IOException e)
|
||||
{
|
||||
@@ -308,7 +321,7 @@ public class QuickSearchDiagnosticsOperations
|
||||
requireOk(response, "Document read failed");
|
||||
JsonNode body = response.body();
|
||||
return (new DocumentView(body.path("found").asBoolean(false), body.has("_version") ? body.get("_version").asLong() : null,
|
||||
body.path("_index").asText(null), body.get("_source")));
|
||||
body.path("_index").asText(null), filterDocumentSource(tableName, body.get("_source"))));
|
||||
}
|
||||
|
||||
|
||||
@@ -338,7 +351,7 @@ public class QuickSearchDiagnosticsOperations
|
||||
{
|
||||
if(doc.path("found").asBoolean(false) && doc.has("_source"))
|
||||
{
|
||||
sources.put(idFromDocumentId(doc.path("_id").asText()), doc.get("_source"));
|
||||
sources.put(idFromDocumentId(doc.path("_id").asText()), filterDocumentSource(tableName, doc.get("_source")));
|
||||
}
|
||||
}
|
||||
return (sources);
|
||||
@@ -346,6 +359,39 @@ public class QuickSearchDiagnosticsOperations
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Old documents may retain protected values. Diagnostic reads expose only
|
||||
** attributable, indexable fields, never the old combined presentation.
|
||||
*******************************************************************************/
|
||||
private static JsonNode filterDocumentSource(String tableName, JsonNode source)
|
||||
{
|
||||
if(source == null || !QuickSearchFieldRules.requiresFieldFiltering(tableName))
|
||||
{
|
||||
return (source);
|
||||
}
|
||||
ObjectNode filtered = JsonNodeFactory.instance.objectNode();
|
||||
filtered.put("sourceTable", tableName);
|
||||
var table = QuickSearchFieldRules.lookupTable(tableName);
|
||||
if(!QuickSearchFieldRules.isProtected(table, table.getPrimaryKeyField()))
|
||||
{
|
||||
filtered.set("recordId", source.get("recordId"));
|
||||
}
|
||||
for(String container : List.of("fieldValues", "fieldValuesWord", "fieldValuesEnglish", "fieldValuesExact"))
|
||||
{
|
||||
ObjectNode values = filtered.putObject(container);
|
||||
source.path(container).fields().forEachRemaining(entry ->
|
||||
{
|
||||
if(QuickSearchFieldRules.isIndexable(table, entry.getKey()))
|
||||
{
|
||||
values.set(entry.getKey(), entry.getValue());
|
||||
}
|
||||
});
|
||||
}
|
||||
return (filtered);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Run _analyze on the index with a named analyzer (an index analyzer or a
|
||||
** built-in one). Text is truncated to MAX_ANALYZE_TEXT_LENGTH.
|
||||
|
||||
+57
-6
@@ -36,6 +36,7 @@ import com.kingsrook.qqq.backend.core.exceptions.QException;
|
||||
import com.kingsrook.qqq.backend.core.logging.QLogger;
|
||||
import com.kingsrook.qbits.quicksearch.QuickSearchQBitConfig;
|
||||
import com.kingsrook.qbits.quicksearch.QuickSearchableTableConfig;
|
||||
import com.kingsrook.qbits.quicksearch.config.QuickSearchFieldRules;
|
||||
import com.kingsrook.qbits.quicksearch.model.QuickSearchFieldAnalyzer;
|
||||
import com.kingsrook.qbits.quicksearch.processes.IndexingUtils;
|
||||
import org.opensearch.client.json.JsonData;
|
||||
@@ -53,6 +54,7 @@ import org.opensearch.client.opensearch._types.query_dsl.MultiMatchQuery;
|
||||
import org.opensearch.client.opensearch._types.query_dsl.Operator;
|
||||
import org.opensearch.client.opensearch._types.query_dsl.Query;
|
||||
import org.opensearch.client.opensearch._types.query_dsl.TermQuery;
|
||||
import org.opensearch.client.opensearch._types.query_dsl.TextQueryType;
|
||||
import org.opensearch.client.opensearch.core.BulkRequest;
|
||||
import org.opensearch.client.opensearch.core.BulkResponse;
|
||||
import org.opensearch.client.opensearch.core.DeleteByQueryRequest;
|
||||
@@ -796,7 +798,8 @@ public class QuickSearchOpenSearchClient implements Closeable
|
||||
try
|
||||
{
|
||||
Query finalQuery = buildSearchQuery(searchTerm, allowedTables, tableConfigs);
|
||||
Highlight highlight = Highlight.of(h -> h.fields("searchableText", HighlightField.of(hf -> hf)));
|
||||
Highlight highlight = allowedTables.stream().anyMatch(QuickSearchFieldRules::requiresFieldFiltering) ? null
|
||||
: Highlight.of(h -> h.fields("searchableText", HighlightField.of(hf -> hf)));
|
||||
|
||||
SearchRequest request = SearchRequest.of(r -> r
|
||||
.index(indexName)
|
||||
@@ -941,9 +944,22 @@ public class QuickSearchOpenSearchClient implements Closeable
|
||||
// fields kept out of the snippet (KEYWORD, EXACT, or includeInSnippet //
|
||||
// off) match on their own; with none, the query is exactly as before //
|
||||
////////////////////////////////////////////////////////////////////////////
|
||||
List<String> aggregateTables = allowedTables.stream().filter(t -> !QuickSearchFieldRules.requiresFieldFiltering(t)).toList();
|
||||
if(aggregateTables.isEmpty())
|
||||
{
|
||||
snippetMatch = Query.of(q -> q.matchNone(m -> m));
|
||||
}
|
||||
else if(aggregateTables.size() != allowedTables.size())
|
||||
{
|
||||
Query aggregateMatch = snippetMatch;
|
||||
snippetMatch = Query.of(q -> q.bool(b -> b.must(aggregateMatch).filter(f -> f.terms(t -> t.field("sourceTable")
|
||||
.terms(v -> v.value(aggregateTables.stream().map(FieldValue::of).toList()))))));
|
||||
}
|
||||
List<Query> ownMatches = buildOwnFieldMatchQueries(searchTerm, tableConfigs, allowedTables);
|
||||
Query match = ownMatches.isEmpty() ? snippetMatch
|
||||
: Query.of(q -> q.bool(b -> b.should(snippetMatch).should(ownMatches).minimumShouldMatch("1")));
|
||||
ownMatches.addAll(buildFilteredSnippetQueries(searchTerm, tableConfigs, allowedTables));
|
||||
Query safeSnippetMatch = snippetMatch;
|
||||
Query match = ownMatches.isEmpty() ? safeSnippetMatch
|
||||
: Query.of(q -> q.bool(b -> b.should(safeSnippetMatch).should(ownMatches).minimumShouldMatch("1")));
|
||||
|
||||
BoolQuery.Builder boolBuilder = new BoolQuery.Builder()
|
||||
.must(match)
|
||||
@@ -955,6 +971,36 @@ public class QuickSearchOpenSearchClient implements Closeable
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** For tables with excluded fields, match only attributable field values.
|
||||
** Old combined text may still contain fields that became classified later.
|
||||
*******************************************************************************/
|
||||
private List<Query> buildFilteredSnippetQueries(String term, List<QuickSearchableTableConfig> configs, Collection<String> allowedTables)
|
||||
{
|
||||
List<Query> queries = new ArrayList<>();
|
||||
for(QuickSearchableTableConfig config : configs == null ? List.<QuickSearchableTableConfig>of() : configs)
|
||||
{
|
||||
if(!allowedTables.contains(config.getTableName()) || !QuickSearchFieldRules.requiresFieldFiltering(config.getTableName()))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
var table = QuickSearchFieldRules.lookupTable(config.getTableName());
|
||||
List<String> fields = QuickSearchFieldRules.indexableFields(table, config.getSearchableFields()).stream()
|
||||
.filter(config::isIncludedInSnippet).map(f -> PATH_PREFIX + "." + f).toList();
|
||||
if(fields.isEmpty() || QuickSearchFieldRules.isProtected(table, table.getPrimaryKeyField()))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
queries.add(Query.of(q -> q.bool(b -> b
|
||||
.filter(f -> f.term(t -> t.field("sourceTable").value(FieldValue.of(config.getTableName()))))
|
||||
.must(m -> m.multiMatch(mm -> mm.query(term).fields(fields).type(TextQueryType.CrossFields)
|
||||
.operator(Operator.And).lenient(true))))));
|
||||
}
|
||||
return (queries);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Matches for the fields that are not in searchableText, each limited to
|
||||
** its own table: an EXACT field matches the whole (lower-cased) term, any
|
||||
@@ -965,7 +1011,7 @@ public class QuickSearchOpenSearchClient implements Closeable
|
||||
List<Query> queries = new ArrayList<>();
|
||||
for(QuickSearchableTableConfig tableConfig : tableConfigs == null ? List.<QuickSearchableTableConfig>of() : tableConfigs)
|
||||
{
|
||||
if(!allowedTables.contains(tableConfig.getTableName()) || tableConfig.isAllPlainFields())
|
||||
if(QuickSearchFieldRules.hasProtectedPrimaryKey(tableConfig.getTableName()) || !allowedTables.contains(tableConfig.getTableName()) || tableConfig.isAllPlainFields())
|
||||
{
|
||||
continue;
|
||||
}
|
||||
@@ -973,7 +1019,8 @@ public class QuickSearchOpenSearchClient implements Closeable
|
||||
Query inTable = Query.of(q -> q.term(t -> t.field("sourceTable").value(FieldValue.of(tableConfig.getTableName()))));
|
||||
for(String field : tableConfig.getSearchableFields() == null ? List.<String>of() : tableConfig.getSearchableFields())
|
||||
{
|
||||
if(tableConfig.isIncludedInSnippet(field))
|
||||
if(tableConfig.isIncludedInSnippet(field)
|
||||
|| (QuickSearchFieldRules.lookupTable(tableConfig.getTableName()) != null && !QuickSearchFieldRules.isIndexable(QuickSearchFieldRules.lookupTable(tableConfig.getTableName()), field)))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
@@ -1019,7 +1066,7 @@ public class QuickSearchOpenSearchClient implements Closeable
|
||||
|
||||
for(QuickSearchableTableConfig tableConfig : tableConfigs)
|
||||
{
|
||||
if(!allowedTables.contains(tableConfig.getTableName()))
|
||||
if(QuickSearchFieldRules.hasProtectedPrimaryKey(tableConfig.getTableName()) || !allowedTables.contains(tableConfig.getTableName()))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
@@ -1028,6 +1075,10 @@ public class QuickSearchOpenSearchClient implements Closeable
|
||||
List<String> fields = tableConfig.getSearchableFields() == null ? List.of() : tableConfig.getSearchableFields();
|
||||
for(String field : fields)
|
||||
{
|
||||
if(QuickSearchFieldRules.lookupTable(tableConfig.getTableName()) != null && !QuickSearchFieldRules.isIndexable(QuickSearchFieldRules.lookupTable(tableConfig.getTableName()), field))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
float boost = (weights == null || weights.get(field) == null) ? 1f : weights.get(field).floatValue();
|
||||
QuickSearchFieldAnalyzer analyzer = tableConfig.getAnalyzer(field);
|
||||
if(analyzer == QuickSearchFieldAnalyzer.EXACT)
|
||||
|
||||
@@ -132,7 +132,7 @@ public abstract class AbstractIndexingStep implements BackendStep
|
||||
protected List<QuickSearchableTableConfig> getDiscoveredTables()
|
||||
{
|
||||
List<QuickSearchableTableConfig> tables = QuickSearchQBitContext.getDiscoveredTables();
|
||||
return (tables == null ? Collections.emptyList() : tables);
|
||||
return (tables == null ? Collections.emptyList() : tables.stream().filter(t -> !QuickSearchFieldRules.hasProtectedPrimaryKey(t.getTableName())).toList());
|
||||
}
|
||||
|
||||
|
||||
@@ -142,7 +142,7 @@ public abstract class AbstractIndexingStep implements BackendStep
|
||||
*******************************************************************************/
|
||||
protected QuickSearchableTableConfig getTableConfig(String tableName)
|
||||
{
|
||||
return (QuickSearchQBitContext.getTableConfig(tableName));
|
||||
return (QuickSearchFieldRules.hasProtectedPrimaryKey(tableName) ? null : QuickSearchQBitContext.getTableConfig(tableName));
|
||||
}
|
||||
|
||||
|
||||
|
||||
@@ -46,6 +46,7 @@ import com.kingsrook.qbits.quicksearch.QuickSearchQBitConfig;
|
||||
import com.kingsrook.qbits.quicksearch.QuickSearchRuntime;
|
||||
import com.kingsrook.qbits.quicksearch.QuickSearchableTableConfig;
|
||||
import com.kingsrook.qbits.quicksearch.config.QuickSearchConfigWrites;
|
||||
import com.kingsrook.qbits.quicksearch.config.QuickSearchFieldRules;
|
||||
import com.kingsrook.qbits.quicksearch.model.QuickSearchFailedEvent;
|
||||
import com.kingsrook.qbits.quicksearch.model.QuickSearchIndex;
|
||||
import com.kingsrook.qbits.quicksearch.model.QuickSearchIndexRun;
|
||||
@@ -423,6 +424,7 @@ public class BasepullIndexStep extends AbstractIndexingStep
|
||||
{
|
||||
Map<String, Serializable> values = new HashMap<>();
|
||||
values.put("lastBasepullTime", runStart);
|
||||
values.put("realTimeErrorCount", 0);
|
||||
Integer documentCount = ReconcileIndexStep.safeCount(client, tableName);
|
||||
if(documentCount != null)
|
||||
{
|
||||
@@ -505,6 +507,11 @@ public class BasepullIndexStep extends AbstractIndexingStep
|
||||
|
||||
for(Map.Entry<String, List<QRecord>> entry : deleteByTable.entrySet())
|
||||
{
|
||||
if(QuickSearchFieldRules.hasProtectedPrimaryKey(entry.getKey()))
|
||||
{
|
||||
markReplayOutcome(entry.getValue(), false, List.of("The primary key cannot be indexed"), succeeded, failed);
|
||||
continue;
|
||||
}
|
||||
List<QRecord> toDelete = entry.getValue();
|
||||
try
|
||||
{
|
||||
|
||||
@@ -239,6 +239,7 @@ public class FullReindexStep extends AbstractIndexingStep
|
||||
|
||||
Map<String, Serializable> values = new HashMap<>();
|
||||
values.put("lastFullReindexTime", Instant.now());
|
||||
values.put("realTimeErrorCount", 0);
|
||||
values.put("lastBasepullTime", startTimes.get(tableName));
|
||||
values.put("recordCount", tableCounts.processed());
|
||||
Integer documentCount = ReconcileIndexStep.safeCount(client, tableName);
|
||||
|
||||
@@ -33,6 +33,7 @@ import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
|
||||
import com.kingsrook.qqq.backend.core.utils.StringUtils;
|
||||
import com.kingsrook.qbits.quicksearch.QuickSearchableTableConfig;
|
||||
import com.kingsrook.qbits.quicksearch.config.QuickSearchFieldRules;
|
||||
import com.kingsrook.qbits.quicksearch.model.QuickSearchFieldRole;
|
||||
import com.kingsrook.qbits.quicksearch.opensearch.OpenSearchDocument;
|
||||
import static com.kingsrook.qqq.backend.core.logging.LogUtils.logPair;
|
||||
@@ -103,6 +104,10 @@ public class IndexingUtils
|
||||
|
||||
for(String fieldName : fields)
|
||||
{
|
||||
if(table != null && !QuickSearchFieldRules.isIndexable(table, fieldName))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
String value = displayValue(record, fieldName, maxFieldLength);
|
||||
if(value == null)
|
||||
{
|
||||
@@ -157,7 +162,7 @@ public class IndexingUtils
|
||||
*******************************************************************************/
|
||||
public static OpenSearchDocument buildDocument(QRecord record, String tableName, String primaryKeyField, List<String> fields, Map<String, Integer> fieldWeights, Map<String, Boolean> includeLabels)
|
||||
{
|
||||
return (buildDocument(record, tableName, primaryKeyField, fields, includeLabels, lookupTable(tableName), null, null));
|
||||
return (buildDocument(record, tableName, primaryKeyField, fields, includeLabels, lookupTable(tableName), null, null, null));
|
||||
}
|
||||
|
||||
|
||||
@@ -165,13 +170,14 @@ public class IndexingUtils
|
||||
/*******************************************************************************
|
||||
** Build a document for a configured table: display values, label fallback,
|
||||
** truncation, and an external version from the basepull timestamp field.
|
||||
** Returns null when the record has no primary key.
|
||||
** Returns null when metadata is unavailable or the primary key is missing
|
||||
** or excluded by the field policy.
|
||||
*******************************************************************************/
|
||||
public static OpenSearchDocument buildDocument(QRecord record, QuickSearchableTableConfig tableConfig)
|
||||
{
|
||||
QTableMetaData table = lookupTable(tableConfig.getTableName());
|
||||
OpenSearchDocument doc = buildDocument(record, tableConfig.getTableName(), tableConfig.getPrimaryKeyField(), tableConfig.getSearchableFields(),
|
||||
tableConfig.getFieldIncludeLabels(), table, tableConfig.getMaxFieldLength(), tableConfig.getBasepullTimestampField());
|
||||
tableConfig.getFieldIncludeLabels(), table, tableConfig.getMaxFieldLength(), tableConfig.getBasepullTimestampField(), tableConfig.getRecordLabelFields());
|
||||
|
||||
if(doc != null && tableConfig.getRecordLabelFormat() != null && tableConfig.getRecordLabelFields() != null)
|
||||
{
|
||||
@@ -199,7 +205,7 @@ public class IndexingUtils
|
||||
*******************************************************************************/
|
||||
static void applyRolesAndAnalyzers(OpenSearchDocument doc, QRecord record, QuickSearchableTableConfig tableConfig, QTableMetaData table)
|
||||
{
|
||||
List<String> fields = tableConfig.getSearchableFields() == null ? List.of() : tableConfig.getSearchableFields();
|
||||
List<String> fields = table == null ? List.of() : QuickSearchFieldRules.indexableFields(table, tableConfig.getSearchableFields());
|
||||
if(!tableConfig.isAllPlainFields())
|
||||
{
|
||||
List<String> snippetFields = new ArrayList<>();
|
||||
@@ -299,8 +305,14 @@ public class IndexingUtils
|
||||
**
|
||||
*******************************************************************************/
|
||||
private static OpenSearchDocument buildDocument(QRecord record, String tableName, String primaryKeyField, List<String> fields, Map<String, Boolean> includeLabels,
|
||||
QTableMetaData table, Integer maxFieldLength, String timestampField)
|
||||
QTableMetaData table, Integer maxFieldLength, String timestampField, List<String> recordLabelFields)
|
||||
{
|
||||
if(table == null || primaryKeyField == null || table.getField(primaryKeyField) == null || QuickSearchFieldRules.isProtected(table, primaryKeyField))
|
||||
{
|
||||
QuickSearchFieldRules.warnExcludedFields(table);
|
||||
return (null);
|
||||
}
|
||||
fields = QuickSearchFieldRules.indexableFields(table, fields);
|
||||
String recordId = record.getValueString(primaryKeyField);
|
||||
if(recordId == null)
|
||||
{
|
||||
@@ -318,7 +330,15 @@ public class IndexingUtils
|
||||
}
|
||||
|
||||
String recordLabel = record.getRecordLabel();
|
||||
if(!StringUtils.hasContent(recordLabel) && table != null)
|
||||
boolean protectedLabel = table.getRecordLabelFields() != null
|
||||
&& table.getRecordLabelFields().stream().anyMatch(f -> QuickSearchFieldRules.isProtected(table, f));
|
||||
if(protectedLabel || (recordLabelFields != null && recordLabelFields.stream().anyMatch(f -> QuickSearchFieldRules.isProtected(table, f))))
|
||||
{
|
||||
recordLabel = null;
|
||||
record = new QRecord(record);
|
||||
record.setRecordLabel(null);
|
||||
}
|
||||
if(!StringUtils.hasContent(recordLabel) && !protectedLabel && table.getRecordLabelFields() != null)
|
||||
{
|
||||
try
|
||||
{
|
||||
@@ -331,7 +351,7 @@ public class IndexingUtils
|
||||
}
|
||||
|
||||
Long version = null;
|
||||
if(timestampField != null)
|
||||
if(timestampField != null && !QuickSearchFieldRules.isProtected(table, timestampField))
|
||||
{
|
||||
try
|
||||
{
|
||||
@@ -361,6 +381,12 @@ public class IndexingUtils
|
||||
*******************************************************************************/
|
||||
private static String formatLabel(QRecord record, QuickSearchableTableConfig tableConfig, String fallback)
|
||||
{
|
||||
QTableMetaData table = lookupTable(tableConfig.getTableName());
|
||||
if(tableConfig.getRecordLabelFields().stream().anyMatch(f -> QuickSearchFieldRules.isProtected(table, f)))
|
||||
{
|
||||
QuickSearchFieldRules.warnExcludedFields(table);
|
||||
return (fallback);
|
||||
}
|
||||
try
|
||||
{
|
||||
Object[] labelValues = new Object[tableConfig.getRecordLabelFields().size()];
|
||||
@@ -373,13 +399,42 @@ public class IndexingUtils
|
||||
}
|
||||
catch(Exception e)
|
||||
{
|
||||
LOG.warn("recordLabelFormat could not be applied; using default label", e, logPair("tableName", tableConfig.getTableName()));
|
||||
LOG.warn("recordLabelFormat could not be applied; using default label", logPair("tableName", tableConfig.getTableName()));
|
||||
return (fallback);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Rebuild result presentation from allowed field values, discarding old
|
||||
** aggregate labels, snippets and display values that may contain secrets.
|
||||
*******************************************************************************/
|
||||
public static OpenSearchDocument filterResult(OpenSearchDocument source, QuickSearchableTableConfig tableConfig)
|
||||
{
|
||||
if(!QuickSearchFieldRules.requiresFieldFiltering(source.getSourceTable()))
|
||||
{
|
||||
return (source);
|
||||
}
|
||||
QTableMetaData table = lookupTable(source.getSourceTable());
|
||||
if(tableConfig == null || QuickSearchFieldRules.isProtected(table, table.getPrimaryKeyField()))
|
||||
{
|
||||
return (null);
|
||||
}
|
||||
QRecord record = new QRecord().withValue(table.getPrimaryKeyField(), source.getRecordId());
|
||||
for(String field : QuickSearchFieldRules.indexableFields(table, tableConfig.getSearchableFields()))
|
||||
{
|
||||
Object value = source.getFieldValues() == null ? null : source.getFieldValues().get(field);
|
||||
if(value instanceof String text)
|
||||
{
|
||||
record.setValue(field, text);
|
||||
}
|
||||
}
|
||||
return (buildDocument(record, tableConfig));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
**
|
||||
*******************************************************************************/
|
||||
|
||||
@@ -169,6 +169,7 @@ public class ReconcileIndexStep extends AbstractIndexingStep
|
||||
if(ReconcileIndexStep.RUN_TYPE.equals(runType) == false)
|
||||
{
|
||||
values.put("lastFullReindexTime", Instant.now());
|
||||
values.put("realTimeErrorCount", 0);
|
||||
}
|
||||
updateIndexRow(indexId, values);
|
||||
}
|
||||
|
||||
+107
@@ -19,8 +19,13 @@ package com.kingsrook.qbits.quicksearch.config;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import com.kingsrook.qqq.backend.core.actions.ai.AiFieldMetaData;
|
||||
import com.kingsrook.qqq.backend.core.actions.ai.AiTableMetaData;
|
||||
import com.kingsrook.qqq.backend.core.actions.ai.DataClassification;
|
||||
import com.kingsrook.qqq.backend.core.actions.tables.UpdateAction;
|
||||
import com.kingsrook.qqq.backend.core.exceptions.QException;
|
||||
import com.kingsrook.qqq.backend.core.logging.QCollectingLogger;
|
||||
import com.kingsrook.qqq.backend.core.logging.QLogger;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.update.UpdateInput;
|
||||
import com.kingsrook.qqq.backend.core.model.data.QRecord;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData;
|
||||
@@ -28,6 +33,8 @@ import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType;
|
||||
import com.kingsrook.qqq.backend.core.context.QContext;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.values.SearchPossibleValueSourceInput;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.possiblevalues.QPossibleValue;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.security.FieldSecurityLock;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
|
||||
import com.kingsrook.qbits.quicksearch.model.QuickSearchFailedEvent;
|
||||
import com.kingsrook.qbits.quicksearch.model.QuickSearchFieldAnalyzer;
|
||||
import com.kingsrook.qbits.quicksearch.model.QuickSearchFieldRole;
|
||||
@@ -47,6 +54,106 @@ import static org.assertj.core.api.Assertions.assertThat;
|
||||
class QuickSearchConfigCustomizersTest extends BaseDataDrivenTest
|
||||
{
|
||||
|
||||
/*******************************************************************************
|
||||
** Classification falls back to the table; PUBLIC and unclassified fields
|
||||
** remain searchable. Password, hidden, sensitive and locked fields do not.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testClassifiedAndSecuredFieldRules()
|
||||
{
|
||||
QTableMetaData table = QContext.getQInstance().getTable(TEST_ENTITY_TABLE);
|
||||
assertThat(QuickSearchFieldRules.isIndexable(table, "name")).isTrue();
|
||||
assertThat(QuickSearchFieldRules.isProtected(table, "name")).isFalse();
|
||||
for(DataClassification classification : DataClassification.values())
|
||||
{
|
||||
table.getField("name").withSupplementalMetaData(new AiFieldMetaData().withClassification(classification));
|
||||
assertThat(QuickSearchFieldRules.isIndexable(table, "name")).as(classification.name())
|
||||
.isEqualTo(classification != DataClassification.PII && classification != DataClassification.PHI);
|
||||
assertThat(QuickSearchFieldRules.isProtected(table, "name")).as(classification.name())
|
||||
.isEqualTo(classification == DataClassification.PII || classification == DataClassification.PHI);
|
||||
}
|
||||
table.withSupplementalMetaData(new AiTableMetaData().withClassification(DataClassification.PHI));
|
||||
assertThat(QuickSearchFieldRules.whyNotIndexable(table, "description")).contains("classified PHI");
|
||||
assertThat(QuickSearchFieldRules.isProtected(table, "description")).isTrue();
|
||||
table.getField("name").withSupplementalMetaData(new AiFieldMetaData().withClassification(DataClassification.PUBLIC));
|
||||
assertThat(QuickSearchFieldRules.isIndexable(table, "name")).isTrue();
|
||||
table.getField("name").setFieldSecurityLock(new FieldSecurityLock());
|
||||
assertThat(QuickSearchFieldRules.isProtected(table, "name")).isTrue();
|
||||
assertThat(QuickSearchFieldRules.whyNotIndexable(table, "name")).contains("security lock");
|
||||
table.getField("name").setFieldSecurityLock(null);
|
||||
table.getField("name").setType(QFieldType.PASSWORD);
|
||||
assertThat(QuickSearchFieldRules.isProtected(table, "name")).isTrue();
|
||||
assertThat(QuickSearchFieldRules.whyNotIndexable(table, "name")).contains("sensitive");
|
||||
table.getField("name").setType(QFieldType.STRING);
|
||||
table.getField("name").setIsHidden(true);
|
||||
assertThat(QuickSearchFieldRules.whyNotIndexable(table, "name")).contains("hidden");
|
||||
assertThat(QuickSearchFieldRules.isProtected(table, "name")).isFalse();
|
||||
for(QFieldType type : List.of(QFieldType.BOOLEAN, QFieldType.BLOB))
|
||||
{
|
||||
table.getField("name").setType(type);
|
||||
assertThat(QuickSearchFieldRules.isProtected(table, "name")).isFalse();
|
||||
}
|
||||
table.getField("name").setType(null);
|
||||
assertThat(QuickSearchFieldRules.isProtected(table, "name")).isFalse();
|
||||
table.getField("name").setIsSensitive(true);
|
||||
assertThat(QuickSearchFieldRules.isProtected(table, "name")).isTrue();
|
||||
assertThat(QuickSearchFieldRules.isProtected(null, "name")).isFalse();
|
||||
assertThat(QuickSearchFieldRules.isProtected(table, null)).isFalse();
|
||||
assertThat(QuickSearchFieldRules.isProtected(table, "missing")).isFalse();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Repeated config loads and document writes warn only once per table.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testExcludedFieldsWarnOncePerTable()
|
||||
{
|
||||
QTableMetaData table = QContext.getQInstance().getTable(TEST_ENTITY_TABLE);
|
||||
table.getField("description").withSupplementalMetaData(new AiFieldMetaData().withClassification(DataClassification.PHI));
|
||||
QCollectingLogger logger = QLogger.activateCollectingLoggerForClass(QuickSearchFieldRules.class);
|
||||
try
|
||||
{
|
||||
for(int i = 0; i < 3; i++)
|
||||
{
|
||||
assertThat(QuickSearchFieldRules.indexableFields(table, List.of("name", "description"))).containsExactly("name");
|
||||
}
|
||||
}
|
||||
finally
|
||||
{
|
||||
QLogger.deactivateCollectingLoggerForClass(QuickSearchFieldRules.class);
|
||||
}
|
||||
assertThat(logger.getCollectedMessages()).singleElement()
|
||||
.satisfies(message -> assertThat(message.getMessage()).contains("dropped fields", TEST_ENTITY_TABLE, "PII/PHI"));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Config writes refuse classified fields with a useful message; the same
|
||||
** fields are absent from the picker and default selection.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testClassifiedFieldConfigIsRefused() throws QException
|
||||
{
|
||||
runtime.getConfigStore().tryPrime();
|
||||
Integer indexId = indexRow(TEST_ENTITY_TABLE).getValueInteger("id");
|
||||
QTableMetaData table = QContext.getQInstance().getTable(TEST_ENTITY_TABLE);
|
||||
for(DataClassification classification : List.of(DataClassification.PII, DataClassification.PHI))
|
||||
{
|
||||
String fieldName = classification.name().toLowerCase(java.util.Locale.ROOT);
|
||||
table.withField(new QFieldMetaData(fieldName, QFieldType.STRING)
|
||||
.withSupplementalMetaData(new AiFieldMetaData().withClassification(classification)));
|
||||
assertThat(insertField(indexId, fieldName, 1, null).getErrors()).singleElement()
|
||||
.satisfies(e -> assertThat(e.getMessage()).contains("classified " + classification, "cannot be indexed"));
|
||||
assertThat(QuickSearchFieldRules.indexableFields(table)).extracting(QFieldMetaData::getName).doesNotContain(fieldName);
|
||||
assertThat(QuickSearchFieldRules.defaultFields(table)).extracting(QuickSearchFieldRules.DefaultField::fieldName).doesNotContain(fieldName);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Field rows: a field must exist, be indexable, not sensitive or hidden,
|
||||
** and not be listed twice; weights 1-1000; known role and analyzer.
|
||||
|
||||
+130
@@ -19,7 +19,13 @@ package com.kingsrook.qbits.quicksearch.listeners;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import java.util.concurrent.CountDownLatch;
|
||||
import java.util.concurrent.Executors;
|
||||
import java.util.concurrent.Future;
|
||||
import java.util.concurrent.TimeUnit;
|
||||
import com.kingsrook.qqq.backend.core.actions.QBackendTransaction;
|
||||
import com.kingsrook.qqq.backend.core.actions.ai.AiFieldMetaData;
|
||||
import com.kingsrook.qqq.backend.core.actions.ai.DataClassification;
|
||||
import com.kingsrook.qqq.backend.core.actions.tables.DeleteAction;
|
||||
import com.kingsrook.qqq.backend.core.actions.tables.InsertAction;
|
||||
import com.kingsrook.qqq.backend.core.actions.tables.QueryAction;
|
||||
@@ -36,6 +42,7 @@ import com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryInput;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.update.UpdateInput;
|
||||
import com.kingsrook.qqq.backend.core.model.data.QRecord;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
|
||||
import com.kingsrook.qqq.backend.core.model.session.QSession;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.code.QCodeReference;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType;
|
||||
@@ -142,6 +149,28 @@ class QuickSearchRecordChangeListenerTest extends BaseQuickSearchTest
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** A custom search publisher also receives only allowed values, so it cannot
|
||||
** bypass the document builder's policy by indexing the event record.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testCustomPublisherReceivesNoClassifiedValues() throws QException
|
||||
{
|
||||
QContext.getQInstance().getTable(TEST_ENTITY_TABLE).getField("description")
|
||||
.withSupplementalMetaData(new AiFieldMetaData().withClassification(DataClassification.PHI));
|
||||
QContext.getQInstance().getTable(TEST_ENTITY_TABLE).withRecordLabelFields("description").withRecordLabelFormat("%s");
|
||||
new InsertAction().execute(new InsertInput(TEST_ENTITY_TABLE).withRecord(new QRecord()
|
||||
.withValue("name", "Public widget").withValue("description", "PHI-CANARY-7f3c")));
|
||||
ArgumentCaptor<List<IndexEvent>> captor = ArgumentCaptor.forClass(List.class);
|
||||
verify(publisher).publishIndexEvents(captor.capture());
|
||||
QRecord record = captor.getValue().get(0).getRecord();
|
||||
assertThat(record.getValues()).containsEntry("name", "Public widget").doesNotContainKey("description");
|
||||
assertThat(record.getDisplayValue("description")).isNull();
|
||||
assertThat(record.getRecordLabel()).isNull();
|
||||
}
|
||||
|
||||
|
||||
|
||||
@Test
|
||||
void testAppliesTo_onlyConfiguredTablesWhenEnabled()
|
||||
{
|
||||
@@ -203,7 +232,9 @@ class QuickSearchRecordChangeListenerTest extends BaseQuickSearchTest
|
||||
}
|
||||
|
||||
assertThat(queryFailedEvents()).isEmpty();
|
||||
assertThat(realTimeErrorCount()).isZero();
|
||||
transaction.commit();
|
||||
assertThat(realTimeErrorCount()).isEqualTo(2);
|
||||
|
||||
List<QRecord> failed = queryFailedEvents();
|
||||
assertThat(failed).extracting(r -> r.getValueString("recordId")).containsExactlyInAnyOrder("7", "8");
|
||||
@@ -328,6 +359,102 @@ class QuickSearchRecordChangeListenerTest extends BaseQuickSearchTest
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Count failed events, including repeated failures, rather than batches.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testPublishFailure_incrementsErrorCount() throws QException
|
||||
{
|
||||
insertIndexRowWithStatus(AbstractIndexingStep.STATUS_ACTIVE);
|
||||
doThrow(new QException("cluster down")).when(publisher).publishDeleteEvents(anyList());
|
||||
List<IndexEvent> events = List.of(
|
||||
new IndexEvent().withTableName(TEST_ENTITY_TABLE).withRecordId("7").withAction(IndexEventAction.DELETE),
|
||||
new IndexEvent().withTableName(TEST_ENTITY_TABLE).withRecordId("8").withAction(IndexEventAction.DELETE));
|
||||
|
||||
QuickSearchRecordChangeListener.publish(runtime, List.of(), events);
|
||||
assertThat(realTimeErrorCount()).isEqualTo(2);
|
||||
QuickSearchRecordChangeListener.publish(runtime, List.of(), events);
|
||||
assertThat(realTimeErrorCount()).isEqualTo(4);
|
||||
assertThat(queryFailedEvents()).hasSize(4);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Independent listeners must not overwrite each other's increments.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testConcurrentFailures_preserveErrorCount() throws Exception
|
||||
{
|
||||
insertIndexRowWithStatus(AbstractIndexingStep.STATUS_ACTIVE);
|
||||
doThrow(new QException("cluster down")).when(publisher).publishDeleteEvents(anyList());
|
||||
QInstance instance = QContext.getQInstance();
|
||||
CountDownLatch start = new CountDownLatch(1);
|
||||
try(var executor = Executors.newFixedThreadPool(4))
|
||||
{
|
||||
List<Future<?>> futures = new ArrayList<>();
|
||||
for(Integer worker = 0; worker < 4; worker++)
|
||||
{
|
||||
futures.add(executor.submit(() ->
|
||||
{
|
||||
QContext.init(instance, new QSession());
|
||||
try
|
||||
{
|
||||
assertThat(start.await(10, TimeUnit.SECONDS)).isTrue();
|
||||
for(Integer i = 0; i < 5; i++)
|
||||
{
|
||||
QuickSearchRecordChangeListener.publish(runtime, List.of(), List.of(
|
||||
new IndexEvent().withTableName(TEST_ENTITY_TABLE).withRecordId("7").withAction(IndexEventAction.DELETE)));
|
||||
}
|
||||
}
|
||||
finally
|
||||
{
|
||||
QContext.clear();
|
||||
}
|
||||
return (null);
|
||||
}));
|
||||
}
|
||||
start.countDown();
|
||||
for(Future<?> future : futures)
|
||||
{
|
||||
future.get(20, TimeUnit.SECONDS);
|
||||
}
|
||||
}
|
||||
assertThat(realTimeErrorCount()).isEqualTo(20);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Counter storage failure must leave the source write and replay intact.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testCounterUpdateFails_doesNotFailWrite() throws QException
|
||||
{
|
||||
insertIndexRowWithStatus(AbstractIndexingStep.STATUS_ACTIVE);
|
||||
doThrow(new QException("cluster down")).when(publisher).publishIndexEvents(anyList());
|
||||
try(MockedConstruction<UpdateAction> ignored = mockConstruction(UpdateAction.class, (mock, context) ->
|
||||
when(mock.execute(any(UpdateInput.class))).thenThrow(new QException("counter unavailable"))))
|
||||
{
|
||||
assertThat(insert("widget", null)).isNotNull();
|
||||
}
|
||||
assertThat(queryFailedEvents()).hasSize(1);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Read the persisted counter from the memory backend.
|
||||
*******************************************************************************/
|
||||
private Integer realTimeErrorCount() throws QException
|
||||
{
|
||||
QueryInput input = new QueryInput();
|
||||
input.setTableName(QuickSearchIndex.TABLE_NAME);
|
||||
return (new QueryAction().execute(input).getRecords().get(0).getValueInteger("realTimeErrorCount"));
|
||||
}
|
||||
|
||||
|
||||
|
||||
@Test
|
||||
void testDisabledTable_isSkipped() throws QException
|
||||
{
|
||||
@@ -410,6 +537,7 @@ class QuickSearchRecordChangeListenerTest extends BaseQuickSearchTest
|
||||
@Test
|
||||
void testUpdate_reReadFails_recordsFailedEventsAfterCommit() throws QException
|
||||
{
|
||||
insertIndexRowWithStatus(AbstractIndexingStep.STATUS_ACTIVE);
|
||||
QBackendTransaction transaction = new QBackendTransaction();
|
||||
try(MockedConstruction<QueryAction> ignored = failingQueries(new QException("possible-value backend unavailable")))
|
||||
{
|
||||
@@ -417,7 +545,9 @@ class QuickSearchRecordChangeListenerTest extends BaseQuickSearchTest
|
||||
}
|
||||
|
||||
assertThat(queryFailedEvents()).isEmpty();
|
||||
assertThat(realTimeErrorCount()).isNull();
|
||||
transaction.commit();
|
||||
assertThat(realTimeErrorCount()).isEqualTo(2);
|
||||
|
||||
List<QRecord> failed = queryFailedEvents();
|
||||
assertThat(failed).extracting(r -> r.getValueString("recordId")).containsExactlyInAnyOrder("7", "8");
|
||||
|
||||
+193
@@ -0,0 +1,193 @@
|
||||
/*
|
||||
* Copyright 2024 Kingsrook, LLC
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package com.kingsrook.qbits.quicksearch.opensearch;
|
||||
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import com.kingsrook.qqq.backend.core.actions.ai.AiFieldMetaData;
|
||||
import com.kingsrook.qqq.backend.core.actions.ai.DataClassification;
|
||||
import com.kingsrook.qqq.backend.core.actions.tables.InsertAction;
|
||||
import com.kingsrook.qqq.backend.core.context.QContext;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepInput;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepOutput;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.insert.InsertInput;
|
||||
import com.kingsrook.qqq.backend.core.model.data.QRecord;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.code.QCodeReference;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.qbits.QBitMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
|
||||
import com.kingsrook.qbits.quicksearch.BaseQuickSearchTest;
|
||||
import com.kingsrook.qbits.quicksearch.QuickSearchQBitConfig;
|
||||
import com.kingsrook.qbits.quicksearch.QuickSearchQBitContext;
|
||||
import com.kingsrook.qbits.quicksearch.QuickSearchRuntime;
|
||||
import com.kingsrook.qbits.quicksearch.QuickSearchableTableConfig;
|
||||
import com.kingsrook.qbits.quicksearch.actions.QuickSearchAction;
|
||||
import com.kingsrook.qbits.quicksearch.actions.QuickSearchInput;
|
||||
import com.kingsrook.qbits.quicksearch.listeners.QuickSearchRecordChangeListener;
|
||||
import com.kingsrook.qbits.quicksearch.processes.BasepullIndexStep;
|
||||
import com.kingsrook.qbits.quicksearch.processes.IndexingUtils;
|
||||
import com.kingsrook.qbits.quicksearch.publisher.SynchronousIndexEventPublisher;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.opensearch.client.opensearch.core.SearchResponse;
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.mockito.ArgumentMatchers.any;
|
||||
import static org.mockito.ArgumentMatchers.anyInt;
|
||||
import static org.mockito.ArgumentMatchers.anyList;
|
||||
import static org.mockito.ArgumentMatchers.anyString;
|
||||
import static org.mockito.Mockito.doAnswer;
|
||||
import static org.mockito.Mockito.doReturn;
|
||||
import static org.mockito.Mockito.mock;
|
||||
import static org.mockito.Mockito.spy;
|
||||
import static org.mockito.Mockito.when;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Canary coverage at the backend seam for live writes, batch indexing and
|
||||
** stale search results. No OpenSearch server is required.
|
||||
*******************************************************************************/
|
||||
class ClassifiedDataCanaryTest extends BaseQuickSearchTest
|
||||
{
|
||||
private static final String CANARY = "PHI-CANARY-7f3c";
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Classified values must never reach any document representation or result,
|
||||
** even with explicit field lists, label formats, roles and analyzer copies.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testCanaryAcrossRealtimeBasepullAndResults() throws Exception
|
||||
{
|
||||
QTableMetaData table = QContext.getQInstance().getTable(TEST_ENTITY_TABLE);
|
||||
table.getField("description").withSupplementalMetaData(new AiFieldMetaData().withClassification(DataClassification.PHI));
|
||||
table.withField(new QFieldMetaData("personal", QFieldType.STRING)
|
||||
.withSupplementalMetaData(new AiFieldMetaData().withClassification(DataClassification.PII)));
|
||||
table.withRecordLabelFields("description").withRecordLabelFormat("%s");
|
||||
|
||||
QuickSearchableTableConfig fields = new QuickSearchableTableConfig().withTableName(TEST_ENTITY_TABLE).withPrimaryKeyField("id")
|
||||
.withSearchableFields(List.of("name", "description", "personal")).withEnabledByDefault(true)
|
||||
.withBasepullTimestampField("modifyDate").withBasepullIntervalMinutes(5)
|
||||
.withRecordLabelFields(List.of("description", "personal")).withRecordLabelFormat("%s %s")
|
||||
.withFieldRoles(Map.of("name", "TITLE", "description", "SUBTITLE", "personal", "DISPLAY"))
|
||||
.withFieldAnalyzers(Map.of("description", "ENGLISH", "personal", "EXACT"));
|
||||
QuickSearchOpenSearchClient client = mock(QuickSearchOpenSearchClient.class);
|
||||
List<OpenSearchDocument> captured = new ArrayList<>();
|
||||
doAnswer(invocation ->
|
||||
{
|
||||
List<OpenSearchDocument> documents = invocation.getArgument(0);
|
||||
captured.addAll(documents);
|
||||
return (new BulkIndexResult().withSuccessCount(documents.size()));
|
||||
}).when(client).indexDocuments(anyList(), anyInt());
|
||||
when(client.indexExists()).thenReturn(true);
|
||||
when(client.countAllDocuments()).thenReturn(1_000L);
|
||||
when(client.countDocumentsForTable(anyString())).thenReturn(1L);
|
||||
|
||||
QuickSearchQBitConfig config = QuickSearchQBitContext.getConfig();
|
||||
config.withIndexEventPublisher(new SynchronousIndexEventPublisher(client, List.of(fields), 100));
|
||||
QuickSearchRuntime runtime = spy(new QuickSearchRuntime(config));
|
||||
doReturn(client).when(runtime).getClient();
|
||||
runtime.setDiscoveredTables(List.of(fields));
|
||||
config.setRuntime(runtime);
|
||||
QContext.getQInstance().addQBit(new QBitMetaData().withGroupId("com.kingsrook.qbits").withArtifactId("quick-search").withVersion("test").withConfig(config));
|
||||
QContext.getQInstance().withRecordChangeListener(new QCodeReference(QuickSearchRecordChangeListener.class));
|
||||
QuickSearchQBitContext.setClient(client);
|
||||
QuickSearchQBitContext.setDiscoveredTables(List.of(fields));
|
||||
|
||||
new InsertAction().execute(new InsertInput(TEST_ENTITY_TABLE).withRecord(new QRecord()
|
||||
.withValue("name", "Public widget").withValue("description", CANARY).withValue("personal", CANARY)));
|
||||
assertThat(captured).as("real-time indexing reached the backend").hasSize(1);
|
||||
new BasepullIndexStep().run(new RunBackendStepInput(), new RunBackendStepOutput());
|
||||
assertThat(captured.size()).as("basepull also reached the backend").isGreaterThan(1);
|
||||
ObjectMapper mapper = new ObjectMapper().registerModule(new JavaTimeModule());
|
||||
for(OpenSearchDocument document : captured)
|
||||
{
|
||||
assertThat(mapper.writeValueAsString(document)).doesNotContain(CANARY).contains("Public widget");
|
||||
assertThat(document.getFieldValues()).containsEntry("name", "Public widget").doesNotContainKeys("description", "personal");
|
||||
}
|
||||
|
||||
OpenSearchDocument stale = new OpenSearchDocument().withSourceTable(TEST_ENTITY_TABLE).withRecordId("1")
|
||||
.withRecordLabel(CANARY).withSearchableText(CANARY).withSubtitle(CANARY).withDisplayValues(Map.of("Personal", CANARY))
|
||||
.withFieldValues(Map.of("name", "Public widget", "description", CANARY, "personal", CANARY));
|
||||
SearchResponse<OpenSearchDocument> response = new SearchResponse.Builder<OpenSearchDocument>().took(1).timedOut(false)
|
||||
.shards(sh -> sh.total(1).successful(1).failed(0))
|
||||
.hits(h -> h.hits(hit -> hit.index("test").id("1").source(stale).highlight(Map.of("searchableText", List.of(CANARY))))).build();
|
||||
when(client.search(anyString(), anyList(), anyInt(), anyInt(), anyList(), any())).thenReturn(response);
|
||||
config.setApplyRecordSecurityLocks(false);
|
||||
var result = new QuickSearchAction().execute(new QuickSearchInput().withSearchTerm("Public"));
|
||||
assertThat(result.getResults()).hasSize(1);
|
||||
assertThat(mapper.writeValueAsString(result)).doesNotContain(CANARY).contains("Public widget");
|
||||
|
||||
try(QuickSearchOpenSearchClient queryClient = new QuickSearchOpenSearchClient(config))
|
||||
{
|
||||
String request = queryClient.buildSearchQuery("Public", List.of(TEST_ENTITY_TABLE), List.of(fields), false).toJsonString();
|
||||
assertThat(request).doesNotContain("searchableText", "fieldValues.description", "fieldValuesEnglish.description", "fieldValuesExact.personal", CANARY);
|
||||
assertThat(request).contains("fieldValues.name");
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Diagnostic document views must not reveal protected values retained in
|
||||
** old index documents, including analyzer copies and combined labels.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testDiagnosticDocumentReadsOmitClassifiedValues() throws Exception
|
||||
{
|
||||
QContext.getQInstance().getTable(TEST_ENTITY_TABLE).getField("description")
|
||||
.withSupplementalMetaData(new AiFieldMetaData().withClassification(DataClassification.PHI));
|
||||
OpenSearchDocument stale = new OpenSearchDocument().withRecordId("1").withSourceTable(TEST_ENTITY_TABLE)
|
||||
.withRecordLabel(CANARY).withSearchableText(CANARY).withSubtitle(CANARY).withDisplayValues(Map.of("Secret", CANARY))
|
||||
.withFieldValues(Map.of("name", "Public widget", "description", CANARY))
|
||||
.withFieldValuesWord(Map.of("description", CANARY)).withFieldValuesEnglish(Map.of("description", CANARY))
|
||||
.withFieldValuesExact(Map.of("description", CANARY));
|
||||
ObjectMapper mapper = new ObjectMapper().registerModule(new JavaTimeModule());
|
||||
var body = mapper.valueToTree(Map.of("found", true, "_source", stale,
|
||||
"docs", List.of(Map.of("found", true, "_id", TEST_ENTITY_TABLE + ":1", "_source", stale))));
|
||||
QuickSearchOpenSearchClient client = mock(QuickSearchOpenSearchClient.class);
|
||||
when(client.getIndexName()).thenReturn("test");
|
||||
QuickSearchDiagnosticsOperations ops = spy(new QuickSearchDiagnosticsOperations(client));
|
||||
doReturn(new QuickSearchDiagnosticsOperations.RawResponse(200, body)).when(ops).raw(anyString(), anyString(), any());
|
||||
assertThat(ops.getDocument(TEST_ENTITY_TABLE, "1").source().toString()).doesNotContain(CANARY).contains("Public widget");
|
||||
assertThat(ops.getDocuments(TEST_ENTITY_TABLE, List.of("1")).get("1").toString()).doesNotContain(CANARY).contains("Public widget");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Recheck metadata at document construction, including primary keys and
|
||||
** untrusted preformatted labels, without depending on config priming.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testTableClassificationAndProtectedPrimaryKey() throws Exception
|
||||
{
|
||||
QTableMetaData table = QContext.getQInstance().getTable(TEST_ENTITY_TABLE);
|
||||
table.getField("description").withSupplementalMetaData(new AiFieldMetaData().withClassification(DataClassification.PHI));
|
||||
table.withRecordLabelFields("description").withRecordLabelFormat("%s");
|
||||
QRecord record = new QRecord().withValue("id", 1).withValue("name", "Public widget").withValue("description", CANARY);
|
||||
record.setRecordLabel(CANARY);
|
||||
OpenSearchDocument document = IndexingUtils.buildDocument(record, QuickSearchQBitContext.getDiscoveredTables().get(0));
|
||||
assertThat(document.getRecordLabel()).isNull();
|
||||
assertThat(document.getSearchableText()).isEqualTo("Public widget");
|
||||
table.getField("id").withSupplementalMetaData(new AiFieldMetaData().withClassification(DataClassification.PII));
|
||||
assertThat(IndexingUtils.buildDocument(record, QuickSearchQBitContext.getDiscoveredTables().get(0))).isNull();
|
||||
}
|
||||
}
|
||||
@@ -304,6 +304,26 @@ class BasepullIndexStepTest extends BaseQuickSearchTest
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** A successful basepull starts a new real-time failure counting window.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testBasepull_resetsRealTimeErrorCount() throws QException
|
||||
{
|
||||
QRecord row = insertIndexRow(TEST_ENTITY_TABLE, true, null, 5);
|
||||
new UpdateAction().execute(new UpdateInput().withTableName(QuickSearchIndex.TABLE_NAME)
|
||||
.withRecord(new QRecord().withValue("id", row.getValue("id")).withValue("realTimeErrorCount", 7)));
|
||||
insertTestEntities(2, Instant.now());
|
||||
|
||||
new BasepullIndexStep().run(new RunBackendStepInput(), new RunBackendStepOutput());
|
||||
|
||||
QueryInput input = new QueryInput();
|
||||
input.setTableName(QuickSearchIndex.TABLE_NAME);
|
||||
assertThat(new QueryAction().execute(input).getRecords().get(0).getValueInteger("realTimeErrorCount")).isZero();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Test: no discovered tables, no quickSearchIndex rows - step completes
|
||||
** without calling the OpenSearch client.
|
||||
|
||||
@@ -162,6 +162,7 @@ class FullReindexStepTest extends BaseQuickSearchTest
|
||||
.withValue("enabled", enabled)
|
||||
.withValue("basepullIntervalMinutes", 5)
|
||||
.withValue("documentCount", documentCount)
|
||||
.withValue("realTimeErrorCount", 7)
|
||||
.withValue("status", "ACTIVE")));
|
||||
new InsertAction().execute(insertInput);
|
||||
}
|
||||
@@ -268,6 +269,7 @@ class FullReindexStepTest extends BaseQuickSearchTest
|
||||
@Test
|
||||
void testAllTables_updatesIndexRowAfterSwap() throws QException
|
||||
{
|
||||
insertIndexRow(true);
|
||||
insertTestEntities(2);
|
||||
when(mockClient.countDocumentsForTable(TEST_ENTITY_TABLE)).thenReturn(2L);
|
||||
|
||||
@@ -276,6 +278,7 @@ class FullReindexStepTest extends BaseQuickSearchTest
|
||||
QRecord row = queryIndexRow();
|
||||
assertThat(row).isNotNull();
|
||||
assertThat(row.getValue("lastFullReindexTime")).isNotNull();
|
||||
assertThat(row.getValueInteger("realTimeErrorCount")).isZero();
|
||||
assertThat(row.getValue("lastBasepullTime")).isNotNull();
|
||||
assertThat(row.getValueInteger("recordCount")).isEqualTo(2);
|
||||
assertThat(row.getValueInteger("documentCount")).isEqualTo(2);
|
||||
@@ -449,6 +452,7 @@ class FullReindexStepTest extends BaseQuickSearchTest
|
||||
@Test
|
||||
void testSingleTable_reconcilesInPlace_neverWipes() throws QException
|
||||
{
|
||||
insertIndexRow(true);
|
||||
insertTestEntities(2);
|
||||
|
||||
RunBackendStepOutput output = new RunBackendStepOutput();
|
||||
@@ -471,6 +475,7 @@ class FullReindexStepTest extends BaseQuickSearchTest
|
||||
assertThat(runs.get(0).getValueInteger("recordsProcessed")).isEqualTo(2);
|
||||
|
||||
assertThat(queryIndexRow().getValue("lastFullReindexTime")).isNotNull();
|
||||
assertThat(queryIndexRow().getValueInteger("realTimeErrorCount")).isZero();
|
||||
assertThat(output.getValueInteger("recordsIndexed")).isEqualTo(2);
|
||||
assertThat(output.getValueBoolean("aliasSwapped")).isFalse();
|
||||
}
|
||||
|
||||
@@ -21,6 +21,8 @@ import java.time.Instant;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import com.kingsrook.qqq.backend.core.actions.ai.AiFieldMetaData;
|
||||
import com.kingsrook.qqq.backend.core.actions.ai.DataClassification;
|
||||
import com.kingsrook.qqq.backend.core.context.QContext;
|
||||
import com.kingsrook.qqq.backend.core.model.data.QRecord;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.QAuthenticationType;
|
||||
@@ -33,8 +35,10 @@ import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.session.QSession;
|
||||
import com.kingsrook.qqq.backend.core.modules.backend.implementations.memory.MemoryBackendModule;
|
||||
import com.kingsrook.qbits.quicksearch.QuickSearchableTableConfig;
|
||||
import com.kingsrook.qbits.quicksearch.config.QuickSearchFieldRules;
|
||||
import com.kingsrook.qbits.quicksearch.opensearch.OpenSearchDocument;
|
||||
import org.junit.jupiter.api.AfterEach;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
@@ -45,6 +49,143 @@ import static org.assertj.core.api.Assertions.assertThat;
|
||||
class IndexingUtilsTest
|
||||
{
|
||||
|
||||
/*******************************************************************************
|
||||
** Document building requires field metadata to apply the index policy.
|
||||
*******************************************************************************/
|
||||
@BeforeEach
|
||||
void setUpMetadata()
|
||||
{
|
||||
QInstance instance = new QInstance();
|
||||
instance.addBackend(new QBackendMetaData().withName("memory").withBackendType(MemoryBackendModule.class));
|
||||
instance.withInstanceDefaultAuthentication(new QAuthenticationMetaData().withName("anonymous").withType(QAuthenticationType.FULLY_ANONYMOUS));
|
||||
for(String tableName : List.of("customers", "person", "product", "order"))
|
||||
{
|
||||
QTableMetaData table = new QTableMetaData().withName(tableName).withBackendName("memory").withPrimaryKeyField("id")
|
||||
.withField(new QFieldMetaData("id", QFieldType.INTEGER))
|
||||
.withField(new QFieldMetaData("modifyDate", QFieldType.DATE_TIME));
|
||||
for(String field : List.of("name", "description", "firstName", "lastName", "email", "statusId", "quantity", "notes", "sku"))
|
||||
{
|
||||
table.withField(new QFieldMetaData(field, QFieldType.STRING));
|
||||
}
|
||||
instance.addTable(table);
|
||||
}
|
||||
QContext.init(instance, new QSession());
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Unsupported search fields must not erase labels or rebuild results.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testUnprotectedBooleanAndBlobPreserveLabelAndResult()
|
||||
{
|
||||
QTableMetaData table = QContext.getQInstance().getTable("product");
|
||||
table.withField(new QFieldMetaData("active", QFieldType.BOOLEAN))
|
||||
.withField(new QFieldMetaData("attachment", QFieldType.BLOB))
|
||||
.withRecordLabelFields("name").withRecordLabelFormat("%s");
|
||||
QRecord record = new QRecord().withValue("id", 1).withValue("name", "Widget")
|
||||
.withValue("active", true).withValue("attachment", new byte[] { 1, 2 });
|
||||
record.setRecordLabel("Widget label");
|
||||
QuickSearchableTableConfig config = new QuickSearchableTableConfig().withTableName("product").withPrimaryKeyField("id")
|
||||
.withSearchableFields(List.of("name", "active", "attachment"));
|
||||
|
||||
OpenSearchDocument document = IndexingUtils.buildDocument(record, config);
|
||||
assertThat(document.getRecordLabel()).isEqualTo("Widget label");
|
||||
assertThat(document.getSearchableText()).isEqualTo("Widget");
|
||||
assertThat(document.getFieldValues()).containsExactlyEntriesOf(Map.of("name", "Widget"));
|
||||
assertThat(QuickSearchFieldRules.requiresFieldFiltering("product")).isFalse();
|
||||
assertThat(IndexingUtils.filterResult(document, config)).isSameAs(document);
|
||||
|
||||
record.setRecordLabel(null);
|
||||
assertThat(IndexingUtils.buildDocument(record, config).getRecordLabel()).isEqualTo("Widget");
|
||||
config.withRecordLabelFields(List.of("name", "active")).withRecordLabelFormat("%s: %s");
|
||||
assertThat(IndexingUtils.buildDocument(record, config).getRecordLabel()).isEqualTo("Widget: true");
|
||||
table.withRecordLabelFields("name", "active").withRecordLabelFormat("%s: %s");
|
||||
config.withRecordLabelFormat(null);
|
||||
assertThat(IndexingUtils.buildDocument(record, config).getRecordLabel()).isEqualTo("Widget: true");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** A protected field unrelated to the label must not erase a safe label.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testUnrelatedProtectedFieldPreservesLabel()
|
||||
{
|
||||
QTableMetaData table = QContext.getQInstance().getTable("product");
|
||||
table.withRecordLabelFields("name").withRecordLabelFormat("%s");
|
||||
table.getField("description").withSupplementalMetaData(new AiFieldMetaData().withClassification(DataClassification.PHI));
|
||||
QRecord record = new QRecord().withValue("id", 1).withValue("name", "Widget").withValue("description", "PHI-CANARY");
|
||||
record.setRecordLabel("Widget label");
|
||||
QuickSearchableTableConfig config = new QuickSearchableTableConfig().withTableName("product").withPrimaryKeyField("id")
|
||||
.withSearchableFields(List.of("name", "description"));
|
||||
|
||||
assertThat(IndexingUtils.buildDocument(record, config).getRecordLabel()).isEqualTo("Widget label");
|
||||
record.setRecordLabel(null);
|
||||
assertThat(IndexingUtils.buildDocument(record, config).getRecordLabel()).isEqualTo("Widget");
|
||||
assertThat(QuickSearchFieldRules.requiresFieldFiltering("product")).isTrue();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Both table and configured label formats must exclude protected fields.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testProtectedLabelFieldsOmitPreformattedAndComputedLabels()
|
||||
{
|
||||
QTableMetaData table = QContext.getQInstance().getTable("person");
|
||||
table.getField("email").withSupplementalMetaData(new AiFieldMetaData().withClassification(DataClassification.PII));
|
||||
table.withRecordLabelFields("name", "email").withRecordLabelFormat("%s %s");
|
||||
QRecord record = new QRecord().withValue("id", 1).withValue("name", "Public name").withValue("email", "PII-CANARY");
|
||||
record.setRecordLabel("Public name PII-CANARY");
|
||||
QuickSearchableTableConfig config = new QuickSearchableTableConfig().withTableName("person").withPrimaryKeyField("id")
|
||||
.withSearchableFields(List.of("name", "email"))
|
||||
.withRecordLabelFields(List.of("email")).withRecordLabelFormat("%s");
|
||||
|
||||
assertThat(IndexingUtils.buildDocument(record, config).getRecordLabel()).isNull();
|
||||
record.setRecordLabel(null);
|
||||
assertThat(IndexingUtils.buildDocument(record, config).getRecordLabel()).isNull();
|
||||
table.withRecordLabelFields("name").withRecordLabelFormat("%s");
|
||||
record.setRecordLabel("PII-CANARY");
|
||||
assertThat(IndexingUtils.buildDocument(record, config).getRecordLabel()).isEqualTo("Public name");
|
||||
assertThat(record.getRecordLabel()).isEqualTo("PII-CANARY");
|
||||
table.withRecordLabelFormat(null);
|
||||
assertThat(IndexingUtils.buildDocument(record, config).getRecordLabel()).isEqualTo("1");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Hidden keys and timestamps remain usable unless they are protected.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testHiddenPrimaryKeyAndTimestampAreNotProtected()
|
||||
{
|
||||
QTableMetaData table = QContext.getQInstance().getTable("product");
|
||||
table.getField("id").withIsHidden(true);
|
||||
table.getField("modifyDate").withIsHidden(true);
|
||||
Instant timestamp = Instant.parse("2026-10-14T12:00:00Z");
|
||||
QRecord record = new QRecord().withValue("id", 1).withValue("name", "Widget").withValue("modifyDate", timestamp);
|
||||
QuickSearchableTableConfig config = new QuickSearchableTableConfig().withTableName("product").withPrimaryKeyField("id")
|
||||
.withSearchableFields(List.of("name")).withBasepullTimestampField("modifyDate");
|
||||
|
||||
OpenSearchDocument document = IndexingUtils.buildDocument(record, config);
|
||||
assertThat(document.getRecordId()).isEqualTo("1");
|
||||
assertThat(document.getVersion()).isEqualTo(timestamp.toEpochMilli());
|
||||
assertThat(QuickSearchFieldRules.hasProtectedPrimaryKey("product")).isFalse();
|
||||
assertThat(QuickSearchFieldRules.requiresFieldFiltering("product")).isFalse();
|
||||
table.getField("modifyDate").withSupplementalMetaData(new AiFieldMetaData().withClassification(DataClassification.PHI));
|
||||
assertThat(IndexingUtils.buildDocument(record, config).getVersion()).isNull();
|
||||
table.getField("id").withIsSensitive(true);
|
||||
assertThat(QuickSearchFieldRules.hasProtectedPrimaryKey("product")).isTrue();
|
||||
assertThat(IndexingUtils.buildDocument(record, config)).isNull();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Test that normal input is trimmed and its case is preserved (the analyzer
|
||||
** lower-cases at index and search time).
|
||||
@@ -606,7 +747,7 @@ class IndexingUtilsTest
|
||||
.withSearchableFields(List.of("sku"))
|
||||
.withFieldIncludeLabels(Map.of("sku", true));
|
||||
|
||||
assertThat(IndexingUtils.buildDocument(record, tableConfig).getSearchableText()).isEqualTo("sku: AB-1");
|
||||
assertThat(IndexingUtils.buildDocument(record, tableConfig).getSearchableText()).isEqualTo("Sku: AB-1");
|
||||
|
||||
initContextWithPersonTable();
|
||||
assertThat(IndexingUtils.buildDocument(record, tableConfig).getSearchableText()).isEqualTo("SKU Code: AB-1");
|
||||
|
||||
+13
-1
@@ -21,8 +21,13 @@ import java.util.ArrayList;
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import com.kingsrook.qqq.backend.core.context.QContext;
|
||||
import com.kingsrook.qqq.backend.core.exceptions.QException;
|
||||
import com.kingsrook.qqq.backend.core.model.data.QRecord;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
|
||||
import com.kingsrook.qbits.quicksearch.BaseQuickSearchTest;
|
||||
import com.kingsrook.qbits.quicksearch.QuickSearchableTableConfig;
|
||||
import com.kingsrook.qbits.quicksearch.opensearch.BulkIndexResult;
|
||||
import com.kingsrook.qbits.quicksearch.opensearch.OpenSearchDocument;
|
||||
@@ -46,7 +51,7 @@ import static org.mockito.Mockito.when;
|
||||
/*******************************************************************************
|
||||
** Tests for SynchronousIndexEventPublisher.
|
||||
*******************************************************************************/
|
||||
class SynchronousIndexEventPublisherTest
|
||||
class SynchronousIndexEventPublisherTest extends BaseQuickSearchTest
|
||||
{
|
||||
private QuickSearchOpenSearchClient mockClient;
|
||||
private SynchronousIndexEventPublisher publisher;
|
||||
@@ -61,6 +66,13 @@ class SynchronousIndexEventPublisherTest
|
||||
@BeforeEach
|
||||
void setUp()
|
||||
{
|
||||
QContext.getQInstance().addTable(
|
||||
new QTableMetaData().withName("orders").withPrimaryKeyField("id")
|
||||
.withField(new QFieldMetaData("id", QFieldType.INTEGER))
|
||||
.withField(new QFieldMetaData("orderNumber", QFieldType.STRING))
|
||||
.withField(new QFieldMetaData("customerName", QFieldType.STRING)));
|
||||
QContext.getQInstance().addTable(new QTableMetaData().withName("products").withPrimaryKeyField("id")
|
||||
.withField(new QFieldMetaData("id", QFieldType.INTEGER)).withField(new QFieldMetaData("name", QFieldType.STRING)));
|
||||
mockClient = mock(QuickSearchOpenSearchClient.class);
|
||||
|
||||
QuickSearchableTableConfig ordersConfig = new QuickSearchableTableConfig()
|
||||
|
||||
Reference in new issue
Block a user