From a91f6c5e03df2192a6e64cfc0453ca1c8ad77c6e Mon Sep 17 00:00:00 2001 From: James Maes Date: Tue, 13 Oct 2026 17:43:50 -0500 Subject: [PATCH 1/5] feat(api): /qqq/v1 data-analysis extension, core pushdown backend, analyze permission UI API extension data-analysis 1.0.0 (capabilities, column-profile, distinct-values, table-profile, duplicates, runs) with typed DataAnalysis*V1 schemas and the committed OpenAPI fragment. The analyze permission is registered through core TableFeaturePermissionsMetaData. CoreAnalysisBackend pushes percentiles, stddev, null/blank counts, numeric and date buckets down through the RC.6 aggregate extensions; estimates sample natively and scale counts, and the stand-in uses one primary-key bound instead of an IN list. Builds against QQQ 4.1.0-RC.6. Co-Authored-By: Claude Opus 5.5 --- CHANGELOG.md | 13 + README.md | 48 +- docs/TODO.md | 7 + pom.xml | 2 +- .../DataAnalysisQBitProducer.java | 19 + .../dataanalysis/DataAnalysisRuntime.java | 2 +- .../dataanalysis/DataAnalysisService.java | 7 +- .../dataanalysis/api/DataAnalysisApi.java | 507 ++++++++ .../dataanalysis/api/DataAnalysisSchemas.java | 1149 ++++++++++++++++ .../dataanalysis/engine/AnalysisBackend.java | 44 +- .../dataanalysis/engine/ColumnProfiler.java | 80 +- .../engine/CoreAnalysisBackend.java | 475 +++++++ .../dataanalysis/engine/DrillFilters.java | 81 +- .../dataanalysis/engine/DuplicateFinder.java | 2 +- .../dataanalysis/engine/ProfileSupport.java | 20 +- .../engine/StandInAnalysisBackend.java | 173 ++- .../dataanalysis/engine/TableProfiler.java | 24 +- .../permissions/DataAnalysisPermissions.java | 6 +- .../result/DuplicatesRequest.java | 18 + .../qbits/dataanalysis/result/Metric.java | 18 + .../dataanalysis/run/AnalysisRunService.java | 4 +- .../openapi/qqq-v1/data-analysis.yaml | 1150 +++++++++++++++++ .../dataanalysis/CoreAnalysisBackendTest.java | 204 +++ .../dataanalysis/DataAnalysisApiTest.java | 290 +++++ .../DataAnalysisSecurityTest.java | 25 +- .../dataanalysis/EngineContractTest.java | 32 +- .../qbits/dataanalysis/EngineFixture.java | 10 +- .../H2CompatibilityEngineTest.java | 39 + .../qbits/dataanalysis/H2SamplingTest.java | 82 ++ .../dataanalysis/H2StreamedEngineTest.java | 48 + .../dataanalysis/OptionalMiddlewareTest.java | 77 ++ .../dataanalysis/PostgresEngineTest.java | 23 + 32 files changed, 4548 insertions(+), 131 deletions(-) create mode 100644 docs/TODO.md create mode 100644 src/main/java/com/kingsrook/qbits/dataanalysis/api/DataAnalysisApi.java create mode 100644 src/main/java/com/kingsrook/qbits/dataanalysis/api/DataAnalysisSchemas.java create mode 100644 src/main/java/com/kingsrook/qbits/dataanalysis/engine/CoreAnalysisBackend.java create mode 100644 src/main/resources/openapi/qqq-v1/data-analysis.yaml create mode 100644 src/test/java/com/kingsrook/qbits/dataanalysis/CoreAnalysisBackendTest.java create mode 100644 src/test/java/com/kingsrook/qbits/dataanalysis/DataAnalysisApiTest.java create mode 100644 src/test/java/com/kingsrook/qbits/dataanalysis/H2CompatibilityEngineTest.java create mode 100644 src/test/java/com/kingsrook/qbits/dataanalysis/H2SamplingTest.java create mode 100644 src/test/java/com/kingsrook/qbits/dataanalysis/H2StreamedEngineTest.java create mode 100644 src/test/java/com/kingsrook/qbits/dataanalysis/OptionalMiddlewareTest.java diff --git a/CHANGELOG.md b/CHANGELOG.md index 8a69132..3424b6f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,19 @@ Following [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and [Semantic ### Added +- `data-analysis` UI API extension 1.0.0: seven session-bound profile, capability, distinct-value, duplicate and run endpoints, typed schemas and a checked OpenAPI fragment. +- Core table-feature permission registration and capability-directed aggregate pushdown, with native sampling and portable streamed fallbacks. +- HTTP authorization, drill-to-core-count round trips, async polling, served OpenAPI and assistant discovery tests; H2 streamed and native-compatibility contract variants. + +### Changed + +- Scalable estimates sample each native aggregate without primary-key IN lists, scale counts using observed sample sizes, retain exact population totals and unscaled ratios, and drill over the full population. Portable estimates use one primary-key boundary and report unscaled prefix counts. + +- Target QQQ 4.1.0-RC.6; local verification uses `-Dqqq.snapshot.version=4.1.0-DATAANALYSIS-SNAPSHOT`. +- Empty-string and temporal drills round-trip through core HTTP filter interpretation. + +### Previously added + - Phase b host engine: typed column/table profiles, distinct pages, duplicates, count-equivalent drills, chart data, candidate keys and completeness heatmaps. - Internal `AnalysisBackend` port and RC.5 stand-in with aggregate pushdown, bounded query pages, deterministic prefix estimates and honest truncation metadata. - Personalized field/table authorization, enforced FK label lookup, runtime configuration overrides and minimum-group-size privacy before caching. diff --git a/README.md b/README.md index ba9f9ba..43e4329 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,13 @@ Statistical analysis and data dives on any QQQ table, filter or saved view: prof The host API provides column and table profiles, distinct-value pages, duplicate groups, drill-through filters, effective per-table configuration, privacy suppression, and asynchronous exact runs with a persistent per-user cache. Metadata, six visible tables, owner locks, PostgreSQL DDL generation and the Analyses home are also available. -HTTP endpoints require the QQQ RC.6 extension point and are next, along with the Analyze UI. Pivots, comparisons, anomalies, saved-analysis execution, scheduling and exports remain later phases. +Seven HTTP operations are available under `/qqq/v1/qbit/data-analysis`; the Analyze UI is a later phase. Pivots, comparisons, anomalies, saved-analysis execution, scheduling and exports remain later phases. ## Requirements -- Java 21; QQQ **4.1.0-RC.5+**. +- Java 21; QQQ **4.1.0-RC.6+**. - A configured QQQ backend for the qbit tables and authenticated sessions with permissions and security keys. -- The engine works on RC.5 through an internal stand-in. A future `CoreAnalysisBackend` can replace it when the core aggregate extensions ship. HTTP endpoints require the UI API extension point ([qqq#1128](https://github.com/QRun-IO/qqq/pull/1128), RC.6). +- Core aggregate and table-feature permission APIs ([qqq#1139](https://github.com/QRun-IO/qqq/pull/1139)) and the UI API extension point ([qqq#1128](https://github.com/QRun-IO/qqq/pull/1128)). Middleware Javalin remains optional; the producer registers endpoints only when it is present. ## Install @@ -58,7 +58,7 @@ Only Saved Analyses, Watches, Analysis Settings and Analysis Runs appear in navi | `data_analysis.admin` | The all-access key of the `data_analysis_user` record locks (see Security) | | `.analyze` | Analyze a source table, also requiring its READ permission | -`DataAnalysisPermissions.analyzePermissionName(table)` honors a custom permission base name and instance defaults. `canAnalyze(table)` is the legacy helper; its READ check follows the instance setting. The engine adds an explicit READ check and always uses `PermissionEnforcement.ENFORCE`, even when the instance default is off. The feature check is a stand-in for core `TableFeaturePermissionsMetaData` (§3.6); hosts must grant these analyze names explicitly until that hook registers them in the catalog. All qbit tables use standard permission rules (no custom checker), so their CRUD permissions appear in the core permission catalog and the qbit-authentik policy editor. Hosts explicitly grant source-table analyze permissions until the core feature hook ships. +`DataAnalysisPermissions.analyzePermissionName(table)` honors the effective table permission base. `canAnalyze(table)` delegates to core's table-feature permission check. The producer registers `analyze`, labelled **Analyze**, on configured source tables, excluding this qbit's own tables. No CRUD permission implies analyze. Core checks READ as well as the feature grant on protected tables. All analysis queries enforce permissions even when the instance default is off. Qbit CRUD permissions also appear in the core catalog. ## Security @@ -102,7 +102,7 @@ Cached results are scoped to the authenticated user, normalized request, effecti All properties have fluent `withX` setters. Global numeric defaults must be non-null and non-negative. Nullable per-table numeric overrides inherit global defaults; configured values must be non-negative. `TableAnalysisDefaults` also supports enabled, analyzable fields and excluded fields. Runtime `data_analysis_table_config` values override per-table code defaults, which override global defaults. Null row values inherit; blank field lists mean all readable fields or no exclusions. Include/exclude table lists remain an outer restriction, even if a runtime row enables the table. Only the config-row lookup uses a temporary system session, restored in `finally`. It selects configuration fields only and is memoized for 60 seconds. Settings editors can call `service.getConfigResolver().invalidate()` for immediate refresh. -`max_rows` bounds the stand-in's selected population and retained records. An exact request disables sampling but still respects this bound and reports `truncated: true` when necessary; increase the limit to obtain a complete larger profile. Zero selects no rows. Above `sample_threshold_rows`, estimates use the first `min(sample_rows, max_rows)` rows ordered by primary key. Counts describe that prefix, are not extrapolated, and carry `estimate`, `sampleRows`, `rowsScanned`, warnings and an `asOf` timestamp. This is deterministic prefix sampling, not a random sample. `cache_ttl_minutes: 0` disables cache reuse. +`max_rows` bounds the stand-in's selected population and retained records. An exact request disables sampling but still respects this bound and reports `truncated: true` when necessary; increase the limit to obtain a complete larger profile. Zero selects no rows in the stand-in. Above `sample_threshold_rows`, capable backends run each aggregate with `samplePercent = min(100, sample_rows * 100 / total)` on the user's filter. Counts, top values and histograms are scaled by the full population divided by the observed sample count for that call; ratios and descriptive statistics remain in sample units. The `rows` metric always reports the unsampled total for estimates. Other metrics carry `estimate: true` and an `≈ ` formatted prefix. Sampling never materializes a primary-key IN filter. Backends without sampling use one `pk <= boundary` criterion to compute an unscaled first-N prefix estimate. Estimate drills combine the original filter with the metric condition over the full population, so count/drill equivalence applies only to exact results. Warnings distinguish random samples from prefixes; `sampleRows`, `rowsScanned` and `asOf` describe coverage. `cache_ttl_minutes: 0` disables cache reuse. ## Host API @@ -136,9 +136,37 @@ The `result` package contains Serializable, Jackson-friendly request/result POJO Count drills combine an untouched copy of the request filter with their producing condition. Cardinality drills select one representative record per distinct non-null value; the privacy guard removes those representative drills. Truncated profiles retain their primary-key boundary in drills, so their counts remain reproducible. Serialized drill getters restore temporal operand types from the current instance metadata before core evaluates them. -## RC.5 stand-in +## HTTP endpoints -`engine.AnalysisBackend` isolates profilers from missing core operators. `StandInAnalysisBackend` pushes down COUNT, COUNT_DISTINCT, MIN, MAX, AVG, SUM, grouped counts, aggregate ordering and limits through core actions. RC.5 has no aggregate OFFSET, so pages over-fetch through the requested end and slice locally. Memory grouping pagination and scale-sensitive decimal equality have isolated compatibility handling. +Extension `data-analysis` version **1.0.0**, prefix `/qbit/data-analysis` inside `/qqq/v1`: + +| Method | Path after `/qqq/v1` | Body or purpose | +| --- | --- | --- | +| GET | `/qbit/data-analysis/tables/{table}/capabilities` | Availability, fields and charts, limits, backend capabilities, SQL Workbench presence | +| POST | `/qbit/data-analysis/tables/{table}/column-profile` | `{fieldName, filter, exact}` | +| POST | `/qbit/data-analysis/tables/{table}/distinct-values` | `{fieldName, filter, page, pageSize, search}` | +| POST | `/qbit/data-analysis/tables/{table}/table-profile` | `{filter, fields}` | +| POST | `/qbit/data-analysis/tables/{table}/duplicates` | `{fields, filter, limit}`; default limit 50, maximum 500 | +| POST | `/qbit/data-analysis/runs` | `{operation: COLUMN_PROFILE or TABLE_PROFILE, tableName, request}` returns `{runId, status}` | +| GET | `/qbit/data-analysis/runs/{runId}` | Status, timestamps, error, typed `columnProfile` or `tableProfile` | + +Every operation uses the request session through `DataAnalysisService`. Capabilities returns 200 with `canAnalyze: false` and no fields when denied. Other permission denials return 403, bad bodies or unavailable fields return 400, and unknown tables return 404. Core middleware supplies plain messages in its standard `{error: message}` JSON envelope. Run rows remain owner-locked. + +Requests and drills reuse core's `QueryFilter` JSON shape and schema reference. Versioned `DataAnalysis...V1` schemas cover profiles, metrics, drills, charts, series, points, field summaries, distinct and duplicate results, capabilities and runs. The [OpenAPI fragment](src/main/resources/openapi/qqq-v1/data-analysis.yaml) is checked against regeneration. The deployed `/qqq/v1/openapi.json` and `UiApiInvoker.listOperations()` include all seven operations. + +Regenerate deliberately after an API change: + +```bash +./mvnw -o -q test -Dtest=DataAnalysisApiTest#contract -Dopenapi.write=true -Dqqq.snapshot.version=4.1.0-DATAANALYSIS-SNAPSHOT +``` + +## Backend selection + +`DataAnalysisService` selects `CoreAnalysisBackend` when the source backend advertises aggregate capabilities, including memory. Supported standard deviation, percentiles, null/blank counts, numeric/date buckets and length statistics execute through core aggregates as the current session. Unsupported primitives delegate to `StandInAnalysisBackend`. Patterns and derived length histograms remain streamed; representative distinct drills and cyclic-date membership use bounded scans. + +The installed snapshot requires H2 PostgreSQL compatibility mode for native bucket SQL (`GROUP BY` positions). + +`engine.AnalysisBackend` isolates profilers from backend-specific operators. `StandInAnalysisBackend` pushes down COUNT, COUNT_DISTINCT, MIN, MAX, AVG, SUM, grouped counts, aggregate ordering and limits through core actions. RC.5 has no aggregate OFFSET, so pages over-fetch through the requested end and slice locally. Memory grouping pagination and scale-sensitive decimal equality have isolated compatibility handling. Variance, interpolated percentiles, string lengths/shapes, date classification, whitespace detection and representative-row drills use bounded primary-key query pages. Histogram/date membership counts use enforced range/count queries after their boundaries have been calculated. Numeric histograms have 20 interior bins between p1 and p99 plus below/above bins, and the last interior bin is closed. Profiles include Tukey outliers, date gaps, date-time weekday/hour patterns, chart alternatives, a seven-bucket moving average, table completeness and candidate keys (single fields and pairs among the eight most unique). @@ -152,15 +180,15 @@ Data versions use filtered COUNT plus MAX of a readable modification-date-like f 4. Review per-table include/exclude sets, limits and minimum group sizes before enabling analysis. Integrate Saved Analyses and Watches with host ESB/Quick Search when those optional host features are installed; this scaffold does not add those dependencies. 5. Use the Analyses home as the owner of analysis data. Other dashboards should link there until saved-analysis widgets are implemented. -Phase **b** profiles, drill-through and runs/cache are implemented through the host facade. Remaining work: **a** core aggregate extensions; **b** HTTP endpoints after QQQ RC.6 and analysis UI; **c** pivots; **d** comparisons and relationships; **e** watch evaluation and alerts; **f** saved-analysis execution, sharing, stars integration, schedules, chart widgets, full home and exports. The current home summarizes stored rows; the host facade executes profiles. The home does not send deliveries. +Phase **b** profiles, drill-through, runs/cache and HTTP endpoints are implemented. Remaining work: **b** analysis UI; **c** pivots; **d** comparisons and relationships; **e** watch evaluation and alerts; **f** saved-analysis execution, sharing, stars integration, schedules, chart widgets, full home and exports. The current home summarizes stored rows; the host facade executes profiles. The home does not send deliveries. ## Build ```bash -./mvnw verify +./mvnw -o -q verify -Dqqq.snapshot.version=4.1.0-DATAANALYSIS-SNAPSHOT ``` -The wrapper pins Maven 3.9.11. On Windows use `mvnw.cmd`. Verification runs Checkstyle, a shared JUnit 5/AssertJ contract suite on memory and H2, PostgreSQL via Testcontainers when Docker is available, and JaCoCo gates of 70% instructions and 90% classes. The suite checks numerical references, every emitted count/drill pair, security, guarded cache JSON, prefix sampling, asynchronous jobs and cache invalidation. For a populated local dependency cache use `./mvnw -o -q verify`. RDBMS, H2, Testcontainers PostgreSQL and the PostgreSQL driver are test-scoped; middleware Javalin is optional. +The wrapper pins Maven 3.9.11. On Windows use `mvnw.cmd`. Verification runs Checkstyle, a shared JUnit 5/AssertJ contract suite on memory and H2, PostgreSQL via Testcontainers when Docker is available, and JaCoCo gates of 70% instructions and 90% classes. The suite checks numerical references, every exact count/drill pair, full-population estimate drills, security, guarded cache JSON, native sampling, asynchronous jobs and cache invalidation. The POM targets RC.6; until its release, always supply the locally installed snapshot override shown above. RDBMS, H2, Testcontainers PostgreSQL and the PostgreSQL driver are test-scoped; middleware Javalin is optional. ## License diff --git a/docs/TODO.md b/docs/TODO.md new file mode 100644 index 0000000..e718b61 --- /dev/null +++ b/docs/TODO.md @@ -0,0 +1,7 @@ +# Phase b part 2 remaining work + +- Run the 21 PostgreSQL contract tests with accessible Docker, including the 50,000-row estimate regression at sample sizes 1,000 and 40,000. +- Review the existing endpoint work's core READ and H2 ordinal-grouping compatibility choices; this sampling task preserves them. +- Append the durable project/daily handoff in [SESSION-STATE.md](SESSION-STATE.md) to Second Brain from a workspace with vault write access. + +Completed: replace sampled-key IN scopes, scale native estimate counts, preserve raw ratios and full-population drills, update the OpenAPI contract and tests, and pass the requested offline Maven verification. diff --git a/pom.xml b/pom.xml index 4028e33..da25483 100644 --- a/pom.xml +++ b/pom.xml @@ -215,7 +215,7 @@ true - 4.1.0-RC.5 + 4.1.0-RC.6 diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/DataAnalysisQBitProducer.java b/src/main/java/com/kingsrook/qbits/dataanalysis/DataAnalysisQBitProducer.java index bbc5caf..24e95aa 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/DataAnalysisQBitProducer.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/DataAnalysisQBitProducer.java @@ -21,9 +21,12 @@ package com.kingsrook.qbits.dataanalysis; +import com.kingsrook.qbits.dataanalysis.api.DataAnalysisApi; import com.kingsrook.qqq.backend.core.exceptions.QException; import com.kingsrook.qqq.backend.core.model.metadata.MetaDataProducerMultiOutput; import com.kingsrook.qqq.backend.core.model.metadata.QInstance; +import com.kingsrook.qqq.backend.core.model.metadata.permissions.TableFeaturePermission; +import com.kingsrook.qqq.backend.core.model.metadata.permissions.TableFeaturePermissionsMetaData; import com.kingsrook.qqq.backend.core.model.metadata.qbits.QBitMetaData; import com.kingsrook.qqq.backend.core.model.metadata.qbits.QBitMetaDataProducer; @@ -129,6 +132,22 @@ public class DataAnalysisQBitProducer implements QBitMetaDataProducer !table.getName().startsWith(DataAnalysisQBitConfig.TABLE_NAME_PREFIX) + && (included.isEmpty() || included.contains(table.getName())) && !excluded.contains(table.getName()))); + try + { + Class.forName("io.javalin.Javalin"); + Class.forName("com.kingsrook.qqq.middleware.javalin.QJavalinImplementation"); + DataAnalysisApi.register(instance); + } + catch(ClassNotFoundException expected) + { + // The engine and metadata also work without the optional middleware. + } if(qBitConfig.getParentAppName() != null && instance.getApp(qBitConfig.getParentAppName()) != null) { instance.getApp(qBitConfig.getParentAppName()).withChild(instance.getApp(qBitConfig.getAppName())); diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/DataAnalysisRuntime.java b/src/main/java/com/kingsrook/qbits/dataanalysis/DataAnalysisRuntime.java index 991d427..cf2542f 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/DataAnalysisRuntime.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/DataAnalysisRuntime.java @@ -25,7 +25,7 @@ import com.kingsrook.qqq.backend.core.context.QContext; import com.kingsrook.qqq.backend.core.model.metadata.QSupplementalInstanceMetaData; /******************************************************************************* - ** Instance-scoped service holder for future endpoints and host integrations. + ** Instance-scoped service holder for UI API endpoints and host integrations. *******************************************************************************/ public class DataAnalysisRuntime implements QSupplementalInstanceMetaData { diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/DataAnalysisService.java b/src/main/java/com/kingsrook/qbits/dataanalysis/DataAnalysisService.java index 252e0f1..c6b106d 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/DataAnalysisService.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/DataAnalysisService.java @@ -25,6 +25,7 @@ import java.util.concurrent.Executor; import com.kingsrook.qbits.dataanalysis.engine.AnalysisBackend; import com.kingsrook.qbits.dataanalysis.engine.AnalysisSecurity; import com.kingsrook.qbits.dataanalysis.engine.ColumnProfiler; +import com.kingsrook.qbits.dataanalysis.engine.CoreAnalysisBackend; import com.kingsrook.qbits.dataanalysis.engine.DistinctValues; import com.kingsrook.qbits.dataanalysis.engine.DuplicateFinder; import com.kingsrook.qbits.dataanalysis.engine.EffectiveConfigResolver; @@ -82,7 +83,7 @@ public class DataAnalysisService public Capabilities capabilities(String table) throws QException { return (new Capabilities().withTableName(table).withFields(security.analyzableFields(table).stream().map(QFieldMetaData::getName).toList()) - .withConfig(configs.resolve(table)).withBackend("RC.5 stand-in; deterministic primary-key prefix sampling")); + .withConfig(configs.resolve(table)).withBackend(CoreAnalysisBackend.capabilities(table).isEmpty() ? "Streamed analysis" : "Core aggregate pushdown")); } @@ -163,11 +164,11 @@ public class DataAnalysisService /******************************************************************************* - ** Fresh per-request backend, ready for a future core-backed implementation. + ** Select core pushdown when the backend advertises analysis capabilities. *******************************************************************************/ public AnalysisBackend backend(String table) throws QException { - return (new StandInAnalysisBackend(configs.resolve(table))); + return (CoreAnalysisBackend.capabilities(table).isEmpty() ? new StandInAnalysisBackend(configs.resolve(table)) : new CoreAnalysisBackend(configs.resolve(table))); } diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/api/DataAnalysisApi.java b/src/main/java/com/kingsrook/qbits/dataanalysis/api/DataAnalysisApi.java new file mode 100644 index 0000000..2aeb0df --- /dev/null +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/api/DataAnalysisApi.java @@ -0,0 +1,507 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis.api; + +import java.util.List; +import java.util.Map; +import com.kingsrook.qbits.dataanalysis.DataAnalysisRuntime; +import com.kingsrook.qbits.dataanalysis.DataAnalysisService; +import com.kingsrook.qbits.dataanalysis.engine.CoreAnalysisBackend; +import com.kingsrook.qbits.dataanalysis.result.AnalysisRequest; +import com.kingsrook.qbits.dataanalysis.result.ChartKind; +import com.kingsrook.qbits.dataanalysis.result.ColumnProfileRequest; +import com.kingsrook.qbits.dataanalysis.result.DistinctValuesRequest; +import com.kingsrook.qbits.dataanalysis.result.DuplicatesRequest; +import com.kingsrook.qbits.dataanalysis.result.TableProfileRequest; +import com.kingsrook.qqq.backend.core.context.QContext; +import com.kingsrook.qqq.backend.core.exceptions.QBadRequestException; +import com.kingsrook.qqq.backend.core.exceptions.QNotFoundException; +import com.kingsrook.qqq.backend.core.exceptions.QPermissionDeniedException; +import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter; +import com.kingsrook.qqq.backend.core.model.metadata.QInstance; +import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData; +import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData; +import com.kingsrook.qqq.backend.core.utils.JsonUtils; +import com.kingsrook.qqq.middleware.javalin.specs.BasicOperation; +import com.kingsrook.qqq.middleware.javalin.specs.extensions.AbstractJsonEndpointSpec; +import com.kingsrook.qqq.middleware.javalin.specs.extensions.MiddlewareSpecExtension; +import com.kingsrook.qqq.middleware.javalin.specs.extensions.MiddlewareSpecExtensionsMetaData; +import com.kingsrook.qqq.openapi.model.HttpMethod; +import com.kingsrook.qqq.openapi.model.In; +import com.kingsrook.qqq.openapi.model.Parameter; +import com.kingsrook.qqq.openapi.model.Schema; +import com.kingsrook.qqq.openapi.model.Type; + +/******************************************************************************* + ** Session-bound profile operations registered only with optional Javalin present. + *******************************************************************************/ +public class DataAnalysisApi +{ + public static final String PREFIX = "/qbit/data-analysis"; + + /******************************************************************************* + ** Publish the extension through the core spec registry. + *******************************************************************************/ + public static void register(QInstance instance) + { + MiddlewareSpecExtensionsMetaData.ofOrWithNew(instance).withExtension(extension()); + } + + /******************************************************************************* + ** The same descriptor drives routes, OpenAPI and assistant tool discovery. + *******************************************************************************/ + public static MiddlewareSpecExtension extension() + { + return (new MiddlewareSpecExtension().withName("data-analysis").withSemanticVersion("1.0.0") + .withDescription("Profiles, distinct values, duplicate groups and exact analysis runs as the signed-in user.") + .withSpec(CapabilitiesSpec.class).withSpec(ColumnProfileSpec.class).withSpec(DistinctValuesSpec.class) + .withSpec(TableProfileSpec.class).withSpec(DuplicatesSpec.class).withSpec(StartRunSpec.class).withSpec(GetRunSpec.class)); + } + + /******************************************************************************* + ** Common schema catalog and path parameters for the seven JSON specs. + *******************************************************************************/ + public abstract static class ProfileSpec extends AbstractJsonEndpointSpec + { + private final String path; + private final HttpMethod method; + private final String summary; + private final String description; + private final String request; + private final String response; + + /******************************************************************************* + ** Bind immutable operation metadata. + *******************************************************************************/ + protected ProfileSpec(String path, HttpMethod method, String summary, String description, String request, String response) + { + this.path = path; + this.method = method; + this.summary = summary; + this.description = description; + this.request = request; + this.response = response; + } + + /******************************************************************************* + ** Assistant-facing operation purpose. + *******************************************************************************/ + @Override + public BasicOperation defineBasicOperation() + { + return (new BasicOperation().withPath(PREFIX + path).withHttpMethod(method).withShortSummary(summary).withLongDescription(description)); + } + + /******************************************************************************* + ** Required path parameter, when present. + *******************************************************************************/ + @Override + public List defineRequestParameters() + { + String name = path.contains("{table}") ? "table" : path.contains("{runId}") ? "runId" : null; + return (name == null ? List.of() : List.of(new Parameter().withName(name).withIn(In.PATH).withRequired(true) + .withDescription(name.equals("table") ? "QQQ table name to analyze." : "Owner-scoped analysis run id.").withSchema(new Schema().withType(Type.STRING)))); + } + + /******************************************************************************* + ** Versioned request schema. + *******************************************************************************/ + @Override + protected Schema defineRequestBodySchema() + { + return (request == null ? null : new Schema().withRef("#/components/schemas/DataAnalysis" + request + "V1")); + } + + /******************************************************************************* + ** Versioned response schema. + *******************************************************************************/ + @Override + protected String getResponseSchemaName() + { + return ("DataAnalysis" + response + "V1"); + } + + /******************************************************************************* + ** Include all referenced transport models and the shared core filter. + *******************************************************************************/ + @Override + public Map defineComponentSchemas() + { + return (this instanceof CapabilitiesSpec ? DataAnalysisSchemas.components() : Map.of()); + } + } + + /******************************************************************************* + ** Existing table lookup before invoking permission-sensitive operations. + *******************************************************************************/ + private static QTableMetaData table(String name) throws QNotFoundException + { + QTableMetaData table = QContext.getQInstance().getTable(name); + if(table == null) + { + throw new QNotFoundException("Unknown analysis table."); + } + return (table); + } + + /******************************************************************************* + ** Parse one JSON object with strict scalar/list types and core filter JSON. + *******************************************************************************/ + private static AnalysisRequest request(String operation, String table, Map body) throws Exception + { + table(table); + DataAnalysisService service = DataAnalysisRuntime.service(); + List readable = service.capabilities(table).getFields(); + try + { + for(String name : List.of("fieldName", "search")) + { + if(body.get(name) != null && !(body.get(name) instanceof String)) + { + throw new IllegalArgumentException(name + " must be a string."); + } + } + if(body.get("exact") != null && !(body.get("exact") instanceof Boolean)) + { + throw new IllegalArgumentException("exact must be a boolean."); + } + QQueryFilter filter = body.get("filter") == null ? null : JsonUtils.toObject(JsonUtils.toJson(body.get("filter")), QQueryFilter.class); + validateFilter(filter, readable); + List fields = null; + if(body.get("fields") != null) + { + if(!(body.get("fields") instanceof List values) || values.stream().anyMatch(v -> !(v instanceof String))) + { + throw new IllegalArgumentException("fields must be an array of field names."); + } + fields = ((List) body.get("fields")).stream().map(String.class::cast).toList(); + if(fields.isEmpty() || !readable.containsAll(fields)) + { + throw new IllegalArgumentException("Choose readable analysis fields."); + } + } + String field = (String) body.get("fieldName"); + if((operation.equals("COLUMN_PROFILE") || operation.equals("DISTINCT_VALUES")) && !readable.contains(field)) + { + throw new IllegalArgumentException("Choose a readable analysis field."); + } + boolean exact = Boolean.TRUE.equals(body.get("exact")); + return (switch(operation) + { + case "COLUMN_PROFILE" -> new ColumnProfileRequest().withTableName(table).withFilter(filter).withFieldName(field).withExact(exact); + case "TABLE_PROFILE" -> new TableProfileRequest().withTableName(table).withFilter(filter).withFields(fields); + case "DISTINCT_VALUES" -> new DistinctValuesRequest().withTableName(table).withFilter(filter).withFieldName(field) + .withPage(integer(body, "page", 0, 0, 1_000_000)).withPageSize(integer(body, "pageSize", 100, 1, 500)).withSearch((String) body.get("search")); + case "DUPLICATES" -> new DuplicatesRequest().withTableName(table).withFilter(filter) + .withFields(java.util.Objects.requireNonNull(fields, "Choose duplicate fields.")).withLimit(integer(body, "limit", 50, 1, 500)); + default -> throw new IllegalArgumentException("operation must be COLUMN_PROFILE or TABLE_PROFILE."); + }); + } + catch(Exception e) + { + throw new QBadRequestException("Invalid analysis request: " + e.getMessage()); + } + } + + /******************************************************************************* + ** Bad filter fields fail before any aggregate or cached result is consulted. + *******************************************************************************/ + private static void validateFilter(QQueryFilter filter, List readable) + { + if(filter == null) + { + return; + } + for(var criterion : filter.getCriteria()) + { + if(criterion.getOperator() == null || !readable.contains(criterion.getFieldName()) + || criterion.getOtherFieldName() != null && !readable.contains(criterion.getOtherFieldName())) + { + throw new IllegalArgumentException("Choose readable filter fields and a valid operator."); + } + } + filter.getSubFilters().forEach(sub -> validateFilter(sub, readable)); + } + + /******************************************************************************* + ** Reject fractional, null, overflowing and out-of-range numeric parameters. + *******************************************************************************/ + private static int integer(Map body, String name, int fallback, int min, int max) + { + if(!body.containsKey(name)) + { + return (fallback); + } + Object value = body.get(name); + if(!(value instanceof Number number) || number.doubleValue() != number.intValue() || number.intValue() < min || number.intValue() > max) + { + throw new IllegalArgumentException(name + " must be an integer from " + min + " to " + max + "."); + } + return (number.intValue()); + } + + /******************************************************************************* + ** Transport conversion avoids middleware dependencies in engine results. + *******************************************************************************/ + private static T transport(Object value, Class type) throws Exception + { + return (JsonUtils.toObject(JsonUtils.toJson(value), type)); + } + + /******************************************************************************* + ** Check analysis availability. + *******************************************************************************/ + public static class CapabilitiesSpec extends ProfileSpec + { + /******************************************************************************* + ** Public constructor used by the core extension registry. + *******************************************************************************/ + public CapabilitiesSpec() + { + super("/tables/{table}/capabilities", HttpMethod.GET, "Check analysis availability", + "Discover whether the current user can analyze this table, readable fields, chart defaults, limits and backend capabilities.", null, "Capabilities"); + } + + /******************************************************************************* + ** Execute in the request session established by core middleware. + *******************************************************************************/ + @Override + protected Object handle(JsonInput input) throws Exception + { + return (capabilities(input.getPathParam("table"))); + } + } + + /******************************************************************************* + ** Profile one column. + *******************************************************************************/ + public static class ColumnProfileSpec extends ProfileSpec + { + /******************************************************************************* + ** Public constructor used by the core extension registry. + *******************************************************************************/ + public ColumnProfileSpec() + { + super("/tables/{table}/column-profile", HttpMethod.POST, "Profile one column", + "Profile one column of a table under a filter: counts, nulls, distinct values, top values, numeric statistics and histogram, date patterns; every number has a drill-through filter unless privacy suppresses it.", "ColumnProfileRequest", "ColumnProfile"); + } + + /******************************************************************************* + ** Execute in the request session established by core middleware. + *******************************************************************************/ + @Override + protected Object handle(JsonInput input) throws Exception + { + return (transport(DataAnalysisRuntime.service().columnProfile((ColumnProfileRequest) request("COLUMN_PROFILE", input.getPathParam("table"), input.getBody())), DataAnalysisSchemas.DataAnalysisColumnProfileV1.class)); + } + } + + /******************************************************************************* + ** List distinct column values. + *******************************************************************************/ + public static class DistinctValuesSpec extends ProfileSpec + { + /******************************************************************************* + ** Public constructor used by the core extension registry. + *******************************************************************************/ + public DistinctValuesSpec() + { + super("/tables/{table}/distinct-values", HttpMethod.POST, "List distinct column values", + "Page through distinct stored values with display labels, counts and drill-through filters; search narrows stored values.", "DistinctValuesRequest", "DistinctValuesPage"); + } + + /******************************************************************************* + ** Execute in the request session established by core middleware. + *******************************************************************************/ + @Override + protected Object handle(JsonInput input) throws Exception + { + return (transport(DataAnalysisRuntime.service().distinctValues((DistinctValuesRequest) request("DISTINCT_VALUES", input.getPathParam("table"), input.getBody())), DataAnalysisSchemas.DataAnalysisDistinctValuesPageV1.class)); + } + } + + /******************************************************************************* + ** Profile table completeness and keys. + *******************************************************************************/ + public static class TableProfileSpec extends ProfileSpec + { + /******************************************************************************* + ** Public constructor used by the core extension registry. + *******************************************************************************/ + public TableProfileSpec() + { + super("/tables/{table}/table-profile", HttpMethod.POST, "Profile table completeness and keys", + "Profile readable fields under a filter for completeness, uniqueness, constant or empty columns and candidate keys.", "TableProfileRequest", "TableProfile"); + } + + /******************************************************************************* + ** Execute in the request session established by core middleware. + *******************************************************************************/ + @Override + protected Object handle(JsonInput input) throws Exception + { + return (transport(DataAnalysisRuntime.service().tableProfile((TableProfileRequest) request("TABLE_PROFILE", input.getPathParam("table"), input.getBody())), DataAnalysisSchemas.DataAnalysisTableProfileV1.class)); + } + } + + /******************************************************************************* + ** Find duplicate groups. + *******************************************************************************/ + public static class DuplicatesSpec extends ProfileSpec + { + /******************************************************************************* + ** Public constructor used by the core extension registry. + *******************************************************************************/ + public DuplicatesSpec() + { + super("/tables/{table}/duplicates", HttpMethod.POST, "Find duplicate groups", + "Group matching records by the selected readable fields and return repeated tuples with counts and drill-through filters.", "DuplicatesRequest", "DuplicatesResult"); + } + + /******************************************************************************* + ** Execute in the request session established by core middleware. + *******************************************************************************/ + @Override + protected Object handle(JsonInput input) throws Exception + { + return (transport(DataAnalysisRuntime.service().duplicates((DuplicatesRequest) request("DUPLICATES", input.getPathParam("table"), input.getBody())), DataAnalysisSchemas.DataAnalysisDuplicatesResultV1.class)); + } + } + + /******************************************************************************* + ** Start an exact profile run. + *******************************************************************************/ + public static class StartRunSpec extends ProfileSpec + { + /******************************************************************************* + ** Public constructor used by the core extension registry. + *******************************************************************************/ + public StartRunSpec() + { + super("/runs", HttpMethod.POST, "Start an exact profile run", + "Start an owner-scoped exact column or table profile. Poll the returned runId until COMPLETE or FAILED; results honor the current session permissions.", "StartRunRequest", "RunStarted"); + } + + /******************************************************************************* + ** Execute in the request session established by core middleware. + *******************************************************************************/ + @Override + protected Object handle(JsonInput input) throws Exception + { + Map body = input.getBody(); + if(body == null || !(body.get("tableName") instanceof String name) || !(body.get("operation") instanceof String operation) + || !List.of("COLUMN_PROFILE", "TABLE_PROFILE").contains(operation) || !(body.get("request") instanceof Map)) + { + throw new QBadRequestException("Supply operation, tableName and a profile request object."); + } + Map parameters = JsonUtils.toObject(JsonUtils.toJson(body.get("request")), java.util.LinkedHashMap.class); + String id = DataAnalysisRuntime.service().startExactRun(request(operation, name, parameters)); + DataAnalysisSchemas.DataAnalysisRunStartedV1 result = new DataAnalysisSchemas.DataAnalysisRunStartedV1(); + result.runId = id; + result.status = DataAnalysisRuntime.service().getRun(id).getStatus(); + return (result); + } + } + + /******************************************************************************* + ** Get an exact profile run. + *******************************************************************************/ + public static class GetRunSpec extends ProfileSpec + { + /******************************************************************************* + ** Public constructor used by the core extension registry. + *******************************************************************************/ + public GetRunSpec() + { + super("/runs/{runId}", HttpMethod.GET, "Get an exact profile run", + "Read status, timestamps and the typed columnProfile or tableProfile result of an owner-scoped run. Completed results are rechecked against current permissions.", null, "RunStatus"); + } + + /******************************************************************************* + ** Execute in the request session established by core middleware. + *******************************************************************************/ + @Override + protected Object handle(JsonInput input) throws Exception + { + return (transport(DataAnalysisRuntime.service().getRun(input.getPathParam("runId")), DataAnalysisSchemas.DataAnalysisRunStatusV1.class)); + } + } + + /******************************************************************************* + ** Permission probing is a successful response with no disclosed field list. + *******************************************************************************/ + private static DataAnalysisSchemas.DataAnalysisCapabilitiesV1 capabilities(String name) throws Exception + { + QTableMetaData table = table(name); + DataAnalysisSchemas.DataAnalysisCapabilitiesV1 result = new DataAnalysisSchemas.DataAnalysisCapabilitiesV1(); + result.tableName = name; + result.tableLabel = table.getLabel(); + result.canAnalyze = false; + result.fields = List.of(); + result.backendCapabilities = List.of(); + result.sqlWorkbenchAvailable = QContext.getQInstance().getApp("sqlWorkbench") != null + || QContext.getQInstance().getTables().keySet().stream().anyMatch(t -> t.startsWith("sql_workbench_")); + try + { + var capabilities = DataAnalysisRuntime.service().capabilities(name); + result.canAnalyze = true; + result.backendCapabilities = CoreAnalysisBackend.capabilities(name).stream().map(Enum::name).sorted().toList(); + result.fields = capabilities.getFields().stream().map(f -> capabilityField(table.getField(f))).toList(); + var config = capabilities.getConfig(); + result.limits = new DataAnalysisSchemas.DataAnalysisLimitsV1(); + result.limits.maxRows = config.getMaxRows(); + result.limits.sampleThresholdRows = config.getSampleThresholdRows(); + result.limits.sampleRows = config.getSampleRows(); + result.limits.minGroupSize = config.getMinGroupSize(); + } + catch(QPermissionDeniedException expected) + { + // A UI capability probe deliberately reports denial without an error. + } + return (result); + } + + /******************************************************************************* + ** Semantic type and the default visualization, with PVS/FK taking priority. + *******************************************************************************/ + private static DataAnalysisSchemas.DataAnalysisCapabilityFieldV1 capabilityField(QFieldMetaData field) + { + DataAnalysisSchemas.DataAnalysisCapabilityFieldV1 result = new DataAnalysisSchemas.DataAnalysisCapabilityFieldV1(); + result.name = field.getName(); + result.label = field.getLabel(); + result.type = field.getType().name(); + result.kind = field.getPossibleValueSourceName() != null ? "CATEGORY" : switch(field.getType()) + { + case INTEGER, LONG, DECIMAL -> "NUMERIC"; + case DATE -> "DATE"; + case DATE_TIME -> "DATE_TIME"; + case BOOLEAN -> "BOOLEAN"; + default -> "TEXT"; + }; + result.defaultChartKind = switch(result.kind) + { + case "NUMERIC" -> ChartKind.HISTOGRAM; + case "DATE", "DATE_TIME" -> ChartKind.TIME_SERIES; + default -> ChartKind.BAR; + }; + return (result); + } +} diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/api/DataAnalysisSchemas.java b/src/main/java/com/kingsrook/qbits/dataanalysis/api/DataAnalysisSchemas.java new file mode 100644 index 0000000..794dbd5 --- /dev/null +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/api/DataAnalysisSchemas.java @@ -0,0 +1,1149 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis.api; + +import java.io.Serializable; +import java.math.BigDecimal; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import com.kingsrook.qbits.dataanalysis.result.ChartKind; +import com.kingsrook.qbits.dataanalysis.result.ValueType; +import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter; +import com.kingsrook.qqq.middleware.javalin.schemabuilder.ToSchema; +import com.kingsrook.qqq.middleware.javalin.schemabuilder.annotations.OpenAPIDescription; +import com.kingsrook.qqq.middleware.javalin.specs.v1.responses.components.QueryFilter; +import com.kingsrook.qqq.openapi.model.Schema; +import com.kingsrook.qqq.openapi.model.Type; + +/******************************************************************************* + ** Versioned transport models isolated from the optional middleware-free engine. + *******************************************************************************/ +public class DataAnalysisSchemas +{ + /******************************************************************************* + ** Core's Schema model lacks the standard OpenAPI required property. + *******************************************************************************/ + public static class RequiredSchema extends Schema + { + private final List required; + + /******************************************************************************* + ** Declare the fields the endpoint requires at runtime. + *******************************************************************************/ + public RequiredSchema(List required) + { + this.required = required; + } + + /******************************************************************************* + ** Standard JSON Schema required property serialized by core's generator. + *******************************************************************************/ + public List getRequired() + { + return (required); + } + } + + /******************************************************************************* + ** Shared component reference, including the core QueryFilter contract. + *******************************************************************************/ + private static Schema ref(String name) + { + return (new Schema().withRef("#/components/schemas/" + name)); + } + + /******************************************************************************* + ** Complete standalone extension component catalog. + *******************************************************************************/ + public static Map components() + { + Map result = new LinkedHashMap<>(); + result.put("QueryFilter", new QueryFilter().toSchema()); + result.put("FilterCriteria", new com.kingsrook.qqq.middleware.javalin.specs.v1.responses.components.FilterCriteria().toSchema()); + result.put("OrderBy", new com.kingsrook.qqq.middleware.javalin.specs.v1.responses.components.OrderBy().toSchema()); + result.put("DataAnalysisAxisV1", new DataAnalysisAxisV1().toSchema()); + result.put("DataAnalysisCandidateKeyV1", new DataAnalysisCandidateKeyV1().toSchema()); + result.put("DataAnalysisChartV1", new DataAnalysisChartV1().toSchema()); + result.put("DataAnalysisColumnProfileV1", new DataAnalysisColumnProfileV1().toSchema()); + result.put("DataAnalysisColumnProfileRequestV1", new DataAnalysisColumnProfileRequestV1().toSchema()); + result.put("DataAnalysisDateProfileV1", new DataAnalysisDateProfileV1().toSchema()); + result.put("DataAnalysisDistinctValuesPageV1", new DataAnalysisDistinctValuesPageV1().toSchema()); + result.put("DataAnalysisDistinctValuesRequestV1", new DataAnalysisDistinctValuesRequestV1().toSchema()); + result.put("DataAnalysisDrillV1", new DataAnalysisDrillV1().toSchema()); + result.put("DataAnalysisDuplicatesRequestV1", new DataAnalysisDuplicatesRequestV1().toSchema()); + result.put("DataAnalysisDuplicatesResultV1", new DataAnalysisDuplicatesResultV1().toSchema()); + result.put("DataAnalysisFieldSummaryV1", new DataAnalysisFieldSummaryV1().toSchema()); + result.put("DataAnalysisMetricV1", new DataAnalysisMetricV1().toSchema()); + result.put("DataAnalysisNumericProfileV1", new DataAnalysisNumericProfileV1().toSchema()); + result.put("DataAnalysisPointV1", new DataAnalysisPointV1().toSchema()); + result.put("DataAnalysisRunStatusV1", new DataAnalysisRunStatusV1().toSchema()); + result.put("DataAnalysisSeriesV1", new DataAnalysisSeriesV1().toSchema()); + result.put("DataAnalysisTableProfileV1", new DataAnalysisTableProfileV1().toSchema()); + result.put("DataAnalysisTableProfileRequestV1", new DataAnalysisTableProfileRequestV1().toSchema()); + result.put("DataAnalysisTextProfileV1", new DataAnalysisTextProfileV1().toSchema()); + result.put("DataAnalysisValueCountV1", new DataAnalysisValueCountV1().toSchema()); + result.put("DataAnalysisCapabilitiesV1", new DataAnalysisCapabilitiesV1().toSchema()); + result.put("DataAnalysisCapabilityFieldV1", new DataAnalysisCapabilityFieldV1().toSchema()); + result.put("DataAnalysisLimitsV1", new DataAnalysisLimitsV1().toSchema()); + result.put("DataAnalysisStartRunRequestV1", new DataAnalysisStartRunRequestV1().toSchema()); + result.put("DataAnalysisRunStartedV1", new DataAnalysisRunStartedV1().toSchema()); + return (result); + } + + /******************************************************************************* + ** Axis version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisAxisV1 implements ToSchema + { + @OpenAPIDescription("Field.") + public String field; + + @OpenAPIDescription("Label.") + public String label; + + @OpenAPIDescription("Value type.") + public ValueType valueType; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("field", new Schema().withType(Type.STRING).withDescription("Field.").withNullable(true)); + properties.put("label", new Schema().withType(Type.STRING).withDescription("Label.").withNullable(true)); + properties.put("valueType", new Schema().withType(Type.STRING).withEnumValues(java.util.Arrays.stream(ValueType.values()).map(Enum::name).toList()).withDescription("Value type.").withNullable(true)); + return (new Schema().withType(Type.OBJECT).withNullable(true).withProperties(properties)); + } + } + + /******************************************************************************* + ** CandidateKey version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisCandidateKeyV1 implements ToSchema + { + @OpenAPIDescription("Readable fields to include; omit for all analyzable fields on a table profile.") + public List fields; + + @OpenAPIDescription("Row count.") + public Long rowCount; + + @OpenAPIDescription("Open the matching records using this table and QueryFilter; null when suppressed.") + public DataAnalysisDrillV1 drill; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("fields", new Schema().withType(Type.ARRAY).withItems(new Schema().withType(Type.STRING)).withDescription("Readable fields to include; omit for all analyzable fields on a table profile.").withNullable(true)); + properties.put("rowCount", new Schema().withType(Type.INTEGER).withDescription("Row count.").withNullable(true)); + properties.put("drill", ref("DataAnalysisDrillV1").withDescription("Open the matching records using this table and QueryFilter; null when suppressed.").withNullable(true)); + return (new Schema().withType(Type.OBJECT).withNullable(true).withProperties(properties)); + } + } + + /******************************************************************************* + ** Chart version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisChartV1 implements ToSchema + { + @OpenAPIDescription("Semantic field kind: NUMERIC, DATE, DATE_TIME, TEXT, BOOLEAN or CATEGORY.") + public ChartKind kind; + + @OpenAPIDescription("Alternatives.") + public List alternatives; + + @OpenAPIDescription("X.") + public DataAnalysisAxisV1 x; + + @OpenAPIDescription("Y.") + public DataAnalysisAxisV1 y; + + @OpenAPIDescription("Series.") + public List series; + + @OpenAPIDescription("Annotations.") + public List annotations; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("kind", new Schema().withType(Type.STRING).withEnumValues(java.util.Arrays.stream(ChartKind.values()).map(Enum::name).toList()).withDescription("Semantic field kind: NUMERIC, DATE, DATE_TIME, TEXT, BOOLEAN or CATEGORY.").withNullable(true)); + properties.put("alternatives", new Schema().withType(Type.ARRAY).withItems(new Schema().withType(Type.STRING).withEnumValues(java.util.Arrays.stream(ChartKind.values()).map(Enum::name).toList())).withDescription("Alternatives.").withNullable(true)); + properties.put("x", ref("DataAnalysisAxisV1").withDescription("X.").withNullable(true)); + properties.put("y", ref("DataAnalysisAxisV1").withDescription("Y.").withNullable(true)); + properties.put("series", new Schema().withType(Type.ARRAY).withItems(ref("DataAnalysisSeriesV1")).withDescription("Series.").withNullable(true)); + properties.put("annotations", new Schema().withType(Type.ARRAY).withItems(new Schema().withType(Type.STRING)).withDescription("Annotations.").withNullable(true)); + return (new Schema().withType(Type.OBJECT).withNullable(true).withProperties(properties)); + } + } + + /******************************************************************************* + ** ColumnProfile version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisColumnProfileV1 implements ToSchema + { + @OpenAPIDescription("Table name.") + public String tableName; + + @OpenAPIDescription("Core QueryFilter JSON, identical to the table query and count endpoints.") + public QQueryFilter filter; + + @OpenAPIDescription("True when statistics describe a sample rather than the entire filtered population.") + public Boolean estimate; + + @OpenAPIDescription("Actual number of rows in the sample, not an extrapolated count.") + public Long sampleRows; + + @OpenAPIDescription("True when the row limit prevented a complete scan.") + public Boolean truncated; + + @OpenAPIDescription("Number of source rows included in computation.") + public Long rowsScanned; + + @OpenAPIDescription("As of.") + public String asOf; + + @OpenAPIDescription("Data version.") + public String dataVersion; + + @OpenAPIDescription("Warnings.") + public List warnings; + + @OpenAPIDescription("Readable field name to profile or enumerate.") + public String fieldName; + + @OpenAPIDescription("Field label.") + public String fieldLabel; + + @OpenAPIDescription("Field type.") + public String fieldType; + + @OpenAPIDescription("Counts.") + public List counts; + + @OpenAPIDescription("Numeric.") + public DataAnalysisNumericProfileV1 numeric; + + @OpenAPIDescription("Dates.") + public DataAnalysisDateProfileV1 dates; + + @OpenAPIDescription("Text.") + public DataAnalysisTextProfileV1 text; + + @OpenAPIDescription("Booleans.") + public List booleans; + + @OpenAPIDescription("Top values.") + public List topValues; + + @OpenAPIDescription("Chart.") + public DataAnalysisChartV1 chart; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("tableName", new Schema().withType(Type.STRING).withDescription("Table name.").withNullable(true)); + properties.put("filter", ref("QueryFilter").withDescription("Core QueryFilter JSON, identical to the table query and count endpoints.").withNullable(true)); + properties.put("estimate", new Schema().withType(Type.BOOLEAN).withDescription("True when statistics describe a sample rather than the entire filtered population.").withNullable(true)); + properties.put("sampleRows", new Schema().withType(Type.INTEGER).withDescription("Actual number of rows in the sample, not an extrapolated count.").withNullable(true)); + properties.put("truncated", new Schema().withType(Type.BOOLEAN).withDescription("True when the row limit prevented a complete scan.").withNullable(true)); + properties.put("rowsScanned", new Schema().withType(Type.INTEGER).withDescription("Number of source rows included in computation.").withNullable(true)); + properties.put("asOf", new Schema().withType(Type.STRING).withFormat("date-time").withDescription("As of.").withNullable(true)); + properties.put("dataVersion", new Schema().withType(Type.STRING).withDescription("Data version.").withNullable(true)); + properties.put("warnings", new Schema().withType(Type.ARRAY).withItems(new Schema().withType(Type.STRING)).withDescription("Warnings.").withNullable(true)); + properties.put("fieldName", new Schema().withType(Type.STRING).withDescription("Readable field name to profile or enumerate.").withNullable(true)); + properties.put("fieldLabel", new Schema().withType(Type.STRING).withDescription("Field label.").withNullable(true)); + properties.put("fieldType", new Schema().withType(Type.STRING).withDescription("Field type.").withNullable(true)); + properties.put("counts", new Schema().withType(Type.ARRAY).withItems(ref("DataAnalysisMetricV1")).withDescription("Counts.").withNullable(true)); + properties.put("numeric", ref("DataAnalysisNumericProfileV1").withDescription("Numeric.").withNullable(true)); + properties.put("dates", ref("DataAnalysisDateProfileV1").withDescription("Dates.").withNullable(true)); + properties.put("text", ref("DataAnalysisTextProfileV1").withDescription("Text.").withNullable(true)); + properties.put("booleans", new Schema().withType(Type.ARRAY).withItems(ref("DataAnalysisMetricV1")).withDescription("Booleans.").withNullable(true)); + properties.put("topValues", new Schema().withType(Type.ARRAY).withItems(ref("DataAnalysisValueCountV1")).withDescription("Top values.").withNullable(true)); + properties.put("chart", ref("DataAnalysisChartV1").withDescription("Chart.").withNullable(true)); + return (new Schema().withType(Type.OBJECT).withNullable(true).withProperties(properties)); + } + } + + /******************************************************************************* + ** ColumnProfileRequest version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisColumnProfileRequestV1 implements ToSchema + { + @OpenAPIDescription("Core QueryFilter JSON, identical to the table query and count endpoints.") + public QQueryFilter filter; + + @OpenAPIDescription("Request exact computation instead of the configured estimate.") + public Boolean exact; + + @OpenAPIDescription("Readable field name to profile or enumerate.") + public String fieldName; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("filter", ref("QueryFilter").withDescription("Core QueryFilter JSON, identical to the table query and count endpoints.")); + properties.put("exact", new Schema().withType(Type.BOOLEAN).withDescription("Request exact computation instead of the configured estimate.")); + properties.put("fieldName", new Schema().withType(Type.STRING).withDescription("Readable field name to profile or enumerate.")); + return (new RequiredSchema(List.of("fieldName")).withType(Type.OBJECT).withProperties(properties).withAdditionalProperties(false)); + } + } + + /******************************************************************************* + ** DateProfile version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisDateProfileV1 implements ToSchema + { + @OpenAPIDescription("Metrics.") + public List metrics; + + @OpenAPIDescription("Unit.") + public String unit; + + @OpenAPIDescription("Buckets.") + public List buckets; + + @OpenAPIDescription("Gaps.") + public List gaps; + + @OpenAPIDescription("Day of week.") + public List dayOfWeek; + + @OpenAPIDescription("Hour of day.") + public List hourOfDay; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("metrics", new Schema().withType(Type.ARRAY).withItems(ref("DataAnalysisMetricV1")).withDescription("Metrics.").withNullable(true)); + properties.put("unit", new Schema().withType(Type.STRING).withDescription("Unit.").withNullable(true)); + properties.put("buckets", new Schema().withType(Type.ARRAY).withItems(ref("DataAnalysisValueCountV1")).withDescription("Buckets.").withNullable(true)); + properties.put("gaps", new Schema().withType(Type.ARRAY).withItems(ref("DataAnalysisValueCountV1")).withDescription("Gaps.").withNullable(true)); + properties.put("dayOfWeek", new Schema().withType(Type.ARRAY).withItems(ref("DataAnalysisValueCountV1")).withDescription("Day of week.").withNullable(true)); + properties.put("hourOfDay", new Schema().withType(Type.ARRAY).withItems(ref("DataAnalysisValueCountV1")).withDescription("Hour of day.").withNullable(true)); + return (new Schema().withType(Type.OBJECT).withNullable(true).withProperties(properties)); + } + } + + /******************************************************************************* + ** DistinctValuesPage version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisDistinctValuesPageV1 implements ToSchema + { + @OpenAPIDescription("Table name.") + public String tableName; + + @OpenAPIDescription("Core QueryFilter JSON, identical to the table query and count endpoints.") + public QQueryFilter filter; + + @OpenAPIDescription("True when statistics describe a sample rather than the entire filtered population.") + public Boolean estimate; + + @OpenAPIDescription("Actual number of rows in the sample, not an extrapolated count.") + public Long sampleRows; + + @OpenAPIDescription("True when the row limit prevented a complete scan.") + public Boolean truncated; + + @OpenAPIDescription("Number of source rows included in computation.") + public Long rowsScanned; + + @OpenAPIDescription("As of.") + public String asOf; + + @OpenAPIDescription("Data version.") + public String dataVersion; + + @OpenAPIDescription("Warnings.") + public List warnings; + + @OpenAPIDescription("Readable field name to profile or enumerate.") + public String fieldName; + + @OpenAPIDescription("Zero-based page number.") + public Integer page; + + @OpenAPIDescription("Maximum values per page, from 1 to 500.") + public Integer pageSize; + + @OpenAPIDescription("Has more.") + public Boolean hasMore; + + @OpenAPIDescription("Total distinct.") + public Long totalDistinct; + + @OpenAPIDescription("Values.") + public List values; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("tableName", new Schema().withType(Type.STRING).withDescription("Table name.").withNullable(true)); + properties.put("filter", ref("QueryFilter").withDescription("Core QueryFilter JSON, identical to the table query and count endpoints.").withNullable(true)); + properties.put("estimate", new Schema().withType(Type.BOOLEAN).withDescription("True when statistics describe a sample rather than the entire filtered population.").withNullable(true)); + properties.put("sampleRows", new Schema().withType(Type.INTEGER).withDescription("Actual number of rows in the sample, not an extrapolated count.").withNullable(true)); + properties.put("truncated", new Schema().withType(Type.BOOLEAN).withDescription("True when the row limit prevented a complete scan.").withNullable(true)); + properties.put("rowsScanned", new Schema().withType(Type.INTEGER).withDescription("Number of source rows included in computation.").withNullable(true)); + properties.put("asOf", new Schema().withType(Type.STRING).withFormat("date-time").withDescription("As of.").withNullable(true)); + properties.put("dataVersion", new Schema().withType(Type.STRING).withDescription("Data version.").withNullable(true)); + properties.put("warnings", new Schema().withType(Type.ARRAY).withItems(new Schema().withType(Type.STRING)).withDescription("Warnings.").withNullable(true)); + properties.put("fieldName", new Schema().withType(Type.STRING).withDescription("Readable field name to profile or enumerate.").withNullable(true)); + properties.put("page", new Schema().withType(Type.INTEGER).withDescription("Zero-based page number.").withNullable(true)); + properties.put("pageSize", new Schema().withType(Type.INTEGER).withDescription("Maximum values per page, from 1 to 500.").withNullable(true)); + properties.put("hasMore", new Schema().withType(Type.BOOLEAN).withDescription("Has more.").withNullable(true)); + properties.put("totalDistinct", new Schema().withType(Type.INTEGER).withDescription("Total distinct.").withNullable(true)); + properties.put("values", new Schema().withType(Type.ARRAY).withItems(ref("DataAnalysisValueCountV1")).withDescription("Values.").withNullable(true)); + return (new Schema().withType(Type.OBJECT).withNullable(true).withProperties(properties)); + } + } + + /******************************************************************************* + ** DistinctValuesRequest version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisDistinctValuesRequestV1 implements ToSchema + { + @OpenAPIDescription("Core QueryFilter JSON, identical to the table query and count endpoints.") + public QQueryFilter filter; + + @OpenAPIDescription("Readable field name to profile or enumerate.") + public String fieldName; + + @OpenAPIDescription("Zero-based page number.") + public Integer page; + + @OpenAPIDescription("Maximum values per page, from 1 to 500.") + public Integer pageSize; + + @OpenAPIDescription("Optional search text applied to stored values.") + public String search; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("filter", ref("QueryFilter").withDescription("Core QueryFilter JSON, identical to the table query and count endpoints.")); + properties.put("fieldName", new Schema().withType(Type.STRING).withDescription("Readable field name to profile or enumerate.")); + properties.put("page", new Schema().withType(Type.INTEGER).withDescription("Zero-based page number.")); + properties.put("pageSize", new Schema().withType(Type.INTEGER).withDescription("Maximum values per page, from 1 to 500.")); + properties.put("search", new Schema().withType(Type.STRING).withDescription("Optional search text applied to stored values.")); + return (new RequiredSchema(List.of("fieldName")).withType(Type.OBJECT).withProperties(properties).withAdditionalProperties(false)); + } + } + + /******************************************************************************* + ** Drill version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisDrillV1 implements ToSchema + { + @OpenAPIDescription("Table name.") + public String tableName; + + @OpenAPIDescription("Core QueryFilter JSON, identical to the table query and count endpoints.") + public QQueryFilter filter; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("tableName", new Schema().withType(Type.STRING).withDescription("Table name.").withNullable(true)); + properties.put("filter", ref("QueryFilter").withDescription("Core QueryFilter JSON, identical to the table query and count endpoints.").withNullable(true)); + return (new Schema().withType(Type.OBJECT).withNullable(true).withProperties(properties)); + } + } + + /******************************************************************************* + ** DuplicatesRequest version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisDuplicatesRequestV1 implements ToSchema + { + @OpenAPIDescription("Core QueryFilter JSON, identical to the table query and count endpoints.") + public QQueryFilter filter; + + @OpenAPIDescription("Readable fields to include; omit for all analyzable fields on a table profile.") + public List fields; + + @OpenAPIDescription("Maximum duplicate groups to return, from 1 to 500; default 50.") + public Integer limit; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("filter", ref("QueryFilter").withDescription("Core QueryFilter JSON, identical to the table query and count endpoints.")); + properties.put("fields", new Schema().withType(Type.ARRAY).withItems(new Schema().withType(Type.STRING)).withDescription("Readable fields to include; omit for all analyzable fields on a table profile.")); + properties.put("limit", new Schema().withType(Type.INTEGER).withDescription("Maximum duplicate groups to return, from 1 to 500; default 50.")); + return (new RequiredSchema(List.of("fields")).withType(Type.OBJECT).withProperties(properties).withAdditionalProperties(false)); + } + } + + /******************************************************************************* + ** DuplicatesResult version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisDuplicatesResultV1 implements ToSchema + { + @OpenAPIDescription("Table name.") + public String tableName; + + @OpenAPIDescription("Core QueryFilter JSON, identical to the table query and count endpoints.") + public QQueryFilter filter; + + @OpenAPIDescription("True when statistics describe a sample rather than the entire filtered population.") + public Boolean estimate; + + @OpenAPIDescription("Actual number of rows in the sample, not an extrapolated count.") + public Long sampleRows; + + @OpenAPIDescription("True when the row limit prevented a complete scan.") + public Boolean truncated; + + @OpenAPIDescription("Number of source rows included in computation.") + public Long rowsScanned; + + @OpenAPIDescription("As of.") + public String asOf; + + @OpenAPIDescription("Data version.") + public String dataVersion; + + @OpenAPIDescription("Warnings.") + public List warnings; + + @OpenAPIDescription("Readable fields to include; omit for all analyzable fields on a table profile.") + public List fields; + + @OpenAPIDescription("Groups.") + public List groups; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("tableName", new Schema().withType(Type.STRING).withDescription("Table name.").withNullable(true)); + properties.put("filter", ref("QueryFilter").withDescription("Core QueryFilter JSON, identical to the table query and count endpoints.").withNullable(true)); + properties.put("estimate", new Schema().withType(Type.BOOLEAN).withDescription("True when statistics describe a sample rather than the entire filtered population.").withNullable(true)); + properties.put("sampleRows", new Schema().withType(Type.INTEGER).withDescription("Actual number of rows in the sample, not an extrapolated count.").withNullable(true)); + properties.put("truncated", new Schema().withType(Type.BOOLEAN).withDescription("True when the row limit prevented a complete scan.").withNullable(true)); + properties.put("rowsScanned", new Schema().withType(Type.INTEGER).withDescription("Number of source rows included in computation.").withNullable(true)); + properties.put("asOf", new Schema().withType(Type.STRING).withFormat("date-time").withDescription("As of.").withNullable(true)); + properties.put("dataVersion", new Schema().withType(Type.STRING).withDescription("Data version.").withNullable(true)); + properties.put("warnings", new Schema().withType(Type.ARRAY).withItems(new Schema().withType(Type.STRING)).withDescription("Warnings.").withNullable(true)); + properties.put("fields", new Schema().withType(Type.ARRAY).withItems(new Schema().withType(Type.STRING)).withDescription("Readable fields to include; omit for all analyzable fields on a table profile.").withNullable(true)); + properties.put("groups", new Schema().withType(Type.ARRAY).withItems(ref("DataAnalysisValueCountV1")).withDescription("Groups.").withNullable(true)); + return (new Schema().withType(Type.OBJECT).withNullable(true).withProperties(properties)); + } + } + + /******************************************************************************* + ** FieldSummary version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisFieldSummaryV1 implements ToSchema + { + @OpenAPIDescription("Field.") + public String field; + + @OpenAPIDescription("Label.") + public String label; + + @OpenAPIDescription("Type.") + public String type; + + @OpenAPIDescription("Completeness.") + public BigDecimal completeness; + + @OpenAPIDescription("Distinct.") + public Long distinct; + + @OpenAPIDescription("Uniqueness.") + public BigDecimal uniqueness; + + @OpenAPIDescription("Constant.") + public Boolean constant; + + @OpenAPIDescription("Empty.") + public Boolean empty; + + @OpenAPIDescription("Nulls.") + public DataAnalysisMetricV1 nulls; + + @OpenAPIDescription("Blanks.") + public DataAnalysisMetricV1 blanks; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("field", new Schema().withType(Type.STRING).withDescription("Field.").withNullable(true)); + properties.put("label", new Schema().withType(Type.STRING).withDescription("Label.").withNullable(true)); + properties.put("type", new Schema().withType(Type.STRING).withDescription("Type.").withNullable(true)); + properties.put("completeness", new Schema().withType(Type.NUMBER).withDescription("Completeness.").withNullable(true)); + properties.put("distinct", new Schema().withType(Type.INTEGER).withDescription("Distinct.").withNullable(true)); + properties.put("uniqueness", new Schema().withType(Type.NUMBER).withDescription("Uniqueness.").withNullable(true)); + properties.put("constant", new Schema().withType(Type.BOOLEAN).withDescription("Constant.").withNullable(true)); + properties.put("empty", new Schema().withType(Type.BOOLEAN).withDescription("Empty.").withNullable(true)); + properties.put("nulls", ref("DataAnalysisMetricV1").withDescription("Nulls.").withNullable(true)); + properties.put("blanks", ref("DataAnalysisMetricV1").withDescription("Blanks.").withNullable(true)); + return (new Schema().withType(Type.OBJECT).withNullable(true).withProperties(properties)); + } + } + + /******************************************************************************* + ** Metric version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisMetricV1 implements ToSchema + { + @OpenAPIDescription("Key.") + public Boolean estimate; + public String key; + + @OpenAPIDescription("Label.") + public String label; + + @OpenAPIDescription("Value.") + public Serializable value; + + @OpenAPIDescription("Value type.") + public ValueType valueType; + + @OpenAPIDescription("Formatted.") + public String formatted; + + @OpenAPIDescription("Open the matching records using this table and QueryFilter; null when suppressed.") + public DataAnalysisDrillV1 drill; + + @OpenAPIDescription("Suppressed.") + public Boolean suppressed; + + @OpenAPIDescription("Suppressed reason.") + public String suppressedReason; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("key", new Schema().withType(Type.STRING).withDescription("Key.").withNullable(true)); + properties.put("label", new Schema().withType(Type.STRING).withDescription("Label.").withNullable(true)); + properties.put("value", new Schema().withOneOf(List.of(new Schema().withType(Type.STRING), new Schema().withType(Type.NUMBER), new Schema().withType(Type.BOOLEAN), new Schema().withType(Type.OBJECT).withNullable(true))).withDescription("Value.").withNullable(true)); + properties.put("valueType", new Schema().withType(Type.STRING).withEnumValues(java.util.Arrays.stream(ValueType.values()).map(Enum::name).toList()).withDescription("Value type.").withNullable(true)); + properties.put("estimate", new Schema().withType(Type.BOOLEAN).withDescription("Whether this metric is estimated; the population rows metric remains exact.")); + properties.put("formatted", new Schema().withType(Type.STRING).withDescription("Formatted.").withNullable(true)); + properties.put("drill", ref("DataAnalysisDrillV1").withDescription("Open the matching records using this table and QueryFilter; null when suppressed.").withNullable(true)); + properties.put("suppressed", new Schema().withType(Type.BOOLEAN).withDescription("Suppressed.").withNullable(true)); + properties.put("suppressedReason", new Schema().withType(Type.STRING).withDescription("Suppressed reason.").withNullable(true)); + return (new Schema().withType(Type.OBJECT).withNullable(true).withProperties(properties)); + } + } + + /******************************************************************************* + ** NumericProfile version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisNumericProfileV1 implements ToSchema + { + @OpenAPIDescription("Metrics.") + public List metrics; + + @OpenAPIDescription("Histogram.") + public List histogram; + + @OpenAPIDescription("Outliers.") + public List outliers; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("metrics", new Schema().withType(Type.ARRAY).withItems(ref("DataAnalysisMetricV1")).withDescription("Metrics.").withNullable(true)); + properties.put("histogram", new Schema().withType(Type.ARRAY).withItems(ref("DataAnalysisValueCountV1")).withDescription("Histogram.").withNullable(true)); + properties.put("outliers", new Schema().withType(Type.ARRAY).withItems(ref("DataAnalysisValueCountV1")).withDescription("Outliers.").withNullable(true)); + return (new Schema().withType(Type.OBJECT).withNullable(true).withProperties(properties)); + } + } + + /******************************************************************************* + ** Point version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisPointV1 implements ToSchema + { + @OpenAPIDescription("X.") + public Serializable x; + + @OpenAPIDescription("Y.") + public BigDecimal y; + + @OpenAPIDescription("Label.") + public String label; + + @OpenAPIDescription("Open the matching records using this table and QueryFilter; null when suppressed.") + public DataAnalysisDrillV1 drill; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("x", new Schema().withOneOf(List.of(new Schema().withType(Type.STRING), new Schema().withType(Type.NUMBER), new Schema().withType(Type.BOOLEAN), new Schema().withType(Type.OBJECT).withNullable(true))).withDescription("X.").withNullable(true)); + properties.put("y", new Schema().withType(Type.NUMBER).withDescription("Y.").withNullable(true)); + properties.put("label", new Schema().withType(Type.STRING).withDescription("Label.").withNullable(true)); + properties.put("drill", ref("DataAnalysisDrillV1").withDescription("Open the matching records using this table and QueryFilter; null when suppressed.").withNullable(true)); + return (new Schema().withType(Type.OBJECT).withNullable(true).withProperties(properties)); + } + } + + /******************************************************************************* + ** RunStatus version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisRunStatusV1 implements ToSchema + { + @OpenAPIDescription("Run id.") + public String runId; + + @OpenAPIDescription("Status.") + public String status; + + @OpenAPIDescription("Error.") + public String error; + + @OpenAPIDescription("Completed column result; null for other operations or unfinished runs.") + public DataAnalysisColumnProfileV1 columnProfile; + + @OpenAPIDescription("Completed table result; null for other operations or unfinished runs.") + public DataAnalysisTableProfileV1 tableProfile; + + @OpenAPIDescription("Started at.") + public String startedAt; + + @OpenAPIDescription("Finished at.") + public String finishedAt; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("runId", new Schema().withType(Type.STRING).withDescription("Run id.").withNullable(true)); + properties.put("status", new Schema().withType(Type.STRING).withDescription("Status.").withNullable(true)); + properties.put("error", new Schema().withType(Type.STRING).withDescription("Error.").withNullable(true)); + properties.put("columnProfile", ref("DataAnalysisColumnProfileV1").withDescription("Completed column result; null for other operations or unfinished runs.").withNullable(true)); + properties.put("tableProfile", ref("DataAnalysisTableProfileV1").withDescription("Completed table result; null for other operations or unfinished runs.").withNullable(true)); + properties.put("startedAt", new Schema().withType(Type.STRING).withFormat("date-time").withDescription("Started at.").withNullable(true)); + properties.put("finishedAt", new Schema().withType(Type.STRING).withFormat("date-time").withDescription("Finished at.").withNullable(true)); + return (new Schema().withType(Type.OBJECT).withNullable(true).withProperties(properties)); + } + } + + /******************************************************************************* + ** Series version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisSeriesV1 implements ToSchema + { + @OpenAPIDescription("Name.") + public String name; + + @OpenAPIDescription("Points.") + public List points; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("name", new Schema().withType(Type.STRING).withDescription("Name.").withNullable(true)); + properties.put("points", new Schema().withType(Type.ARRAY).withItems(ref("DataAnalysisPointV1")).withDescription("Points.").withNullable(true)); + return (new Schema().withType(Type.OBJECT).withNullable(true).withProperties(properties)); + } + } + + /******************************************************************************* + ** TableProfile version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisTableProfileV1 implements ToSchema + { + @OpenAPIDescription("Table name.") + public String tableName; + + @OpenAPIDescription("Core QueryFilter JSON, identical to the table query and count endpoints.") + public QQueryFilter filter; + + @OpenAPIDescription("True when statistics describe a sample rather than the entire filtered population.") + public Boolean estimate; + + @OpenAPIDescription("Actual number of rows in the sample, not an extrapolated count.") + public Long sampleRows; + + @OpenAPIDescription("True when the row limit prevented a complete scan.") + public Boolean truncated; + + @OpenAPIDescription("Number of source rows included in computation.") + public Long rowsScanned; + + @OpenAPIDescription("As of.") + public String asOf; + + @OpenAPIDescription("Data version.") + public String dataVersion; + + @OpenAPIDescription("Warnings.") + public List warnings; + + @OpenAPIDescription("Row count.") + public DataAnalysisMetricV1 rowCount; + + @OpenAPIDescription("Readable fields to include; omit for all analyzable fields on a table profile.") + public List fields; + + @OpenAPIDescription("Heatmap.") + public DataAnalysisChartV1 heatmap; + + @OpenAPIDescription("Candidate keys.") + public List candidateKeys; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("tableName", new Schema().withType(Type.STRING).withDescription("Table name.").withNullable(true)); + properties.put("filter", ref("QueryFilter").withDescription("Core QueryFilter JSON, identical to the table query and count endpoints.").withNullable(true)); + properties.put("estimate", new Schema().withType(Type.BOOLEAN).withDescription("True when statistics describe a sample rather than the entire filtered population.").withNullable(true)); + properties.put("sampleRows", new Schema().withType(Type.INTEGER).withDescription("Actual number of rows in the sample, not an extrapolated count.").withNullable(true)); + properties.put("truncated", new Schema().withType(Type.BOOLEAN).withDescription("True when the row limit prevented a complete scan.").withNullable(true)); + properties.put("rowsScanned", new Schema().withType(Type.INTEGER).withDescription("Number of source rows included in computation.").withNullable(true)); + properties.put("asOf", new Schema().withType(Type.STRING).withFormat("date-time").withDescription("As of.").withNullable(true)); + properties.put("dataVersion", new Schema().withType(Type.STRING).withDescription("Data version.").withNullable(true)); + properties.put("warnings", new Schema().withType(Type.ARRAY).withItems(new Schema().withType(Type.STRING)).withDescription("Warnings.").withNullable(true)); + properties.put("rowCount", ref("DataAnalysisMetricV1").withDescription("Row count.").withNullable(true)); + properties.put("fields", new Schema().withType(Type.ARRAY).withItems(ref("DataAnalysisFieldSummaryV1")).withDescription("Readable fields to include; omit for all analyzable fields on a table profile.").withNullable(true)); + properties.put("heatmap", ref("DataAnalysisChartV1").withDescription("Heatmap.").withNullable(true)); + properties.put("candidateKeys", new Schema().withType(Type.ARRAY).withItems(ref("DataAnalysisCandidateKeyV1")).withDescription("Candidate keys.").withNullable(true)); + return (new Schema().withType(Type.OBJECT).withNullable(true).withProperties(properties)); + } + } + + /******************************************************************************* + ** TableProfileRequest version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisTableProfileRequestV1 implements ToSchema + { + @OpenAPIDescription("Core QueryFilter JSON, identical to the table query and count endpoints.") + public QQueryFilter filter; + + @OpenAPIDescription("Readable fields to include; omit for all analyzable fields on a table profile.") + public List fields; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("filter", ref("QueryFilter").withDescription("Core QueryFilter JSON, identical to the table query and count endpoints.")); + properties.put("fields", new Schema().withType(Type.ARRAY).withItems(new Schema().withType(Type.STRING)).withDescription("Readable fields to include; omit for all analyzable fields on a table profile.")); + return (new Schema().withType(Type.OBJECT).withProperties(properties).withAdditionalProperties(false)); + } + } + + /******************************************************************************* + ** TextProfile version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisTextProfileV1 implements ToSchema + { + @OpenAPIDescription("Metrics.") + public List metrics; + + @OpenAPIDescription("Histogram.") + public List histogram; + + @OpenAPIDescription("Patterns.") + public List patterns; + + @OpenAPIDescription("Actual number of rows in the sample, not an extrapolated count.") + public Long sampleRows; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("metrics", new Schema().withType(Type.ARRAY).withItems(ref("DataAnalysisMetricV1")).withDescription("Metrics.").withNullable(true)); + properties.put("histogram", new Schema().withType(Type.ARRAY).withItems(ref("DataAnalysisValueCountV1")).withDescription("Histogram.").withNullable(true)); + properties.put("patterns", new Schema().withType(Type.ARRAY).withItems(ref("DataAnalysisValueCountV1")).withDescription("Patterns.").withNullable(true)); + properties.put("sampleRows", new Schema().withType(Type.INTEGER).withDescription("Actual number of rows in the sample, not an extrapolated count.").withNullable(true)); + return (new Schema().withType(Type.OBJECT).withNullable(true).withProperties(properties)); + } + } + + /******************************************************************************* + ** ValueCount version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisValueCountV1 implements ToSchema + { + @OpenAPIDescription("Value.") + public Serializable value; + + @OpenAPIDescription("Label.") + public String label; + + @OpenAPIDescription("Count.") + public Long count; + + @OpenAPIDescription("Share.") + public BigDecimal share; + + @OpenAPIDescription("Open the matching records using this table and QueryFilter; null when suppressed.") + public DataAnalysisDrillV1 drill; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("value", new Schema().withOneOf(List.of(new Schema().withType(Type.STRING), new Schema().withType(Type.NUMBER), new Schema().withType(Type.BOOLEAN), new Schema().withType(Type.OBJECT).withNullable(true))).withDescription("Value.").withNullable(true)); + properties.put("label", new Schema().withType(Type.STRING).withDescription("Label.").withNullable(true)); + properties.put("count", new Schema().withType(Type.INTEGER).withDescription("Count.").withNullable(true)); + properties.put("share", new Schema().withType(Type.NUMBER).withDescription("Share.").withNullable(true)); + properties.put("drill", ref("DataAnalysisDrillV1").withDescription("Open the matching records using this table and QueryFilter; null when suppressed.").withNullable(true)); + return (new Schema().withType(Type.OBJECT).withNullable(true).withProperties(properties)); + } + } + + /******************************************************************************* + ** Capabilities version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisCapabilitiesV1 implements ToSchema + { + @OpenAPIDescription("Whether this session may analyze the table; false responses expose no fields.") + public Boolean canAnalyze; + + @OpenAPIDescription("Table name.") + public String tableName; + + @OpenAPIDescription("Table label.") + public String tableLabel; + + @OpenAPIDescription("Readable fields to include; omit for all analyzable fields on a table profile.") + public List fields; + + @OpenAPIDescription("Limits.") + public DataAnalysisLimitsV1 limits; + + @OpenAPIDescription("Backend capabilities.") + public List backendCapabilities; + + @OpenAPIDescription("Whether SQL Workbench metadata is installed in this instance.") + public Boolean sqlWorkbenchAvailable; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("canAnalyze", new Schema().withType(Type.BOOLEAN).withDescription("Whether this session may analyze the table; false responses expose no fields.").withNullable(true)); + properties.put("tableName", new Schema().withType(Type.STRING).withDescription("Table name.").withNullable(true)); + properties.put("tableLabel", new Schema().withType(Type.STRING).withDescription("Table label.").withNullable(true)); + properties.put("fields", new Schema().withType(Type.ARRAY).withItems(ref("DataAnalysisCapabilityFieldV1")).withDescription("Readable fields to include; omit for all analyzable fields on a table profile.").withNullable(true)); + properties.put("limits", ref("DataAnalysisLimitsV1").withDescription("Limits.").withNullable(true)); + properties.put("backendCapabilities", new Schema().withType(Type.ARRAY).withItems(new Schema().withType(Type.STRING)).withDescription("Backend capabilities.").withNullable(true)); + properties.put("sqlWorkbenchAvailable", new Schema().withType(Type.BOOLEAN).withDescription("Whether SQL Workbench metadata is installed in this instance.").withNullable(true)); + return (new Schema().withType(Type.OBJECT).withNullable(true).withProperties(properties)); + } + } + + /******************************************************************************* + ** CapabilityField version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisCapabilityFieldV1 implements ToSchema + { + @OpenAPIDescription("Name.") + public String name; + + @OpenAPIDescription("Label.") + public String label; + + @OpenAPIDescription("Type.") + public String type; + + @OpenAPIDescription("Semantic field kind: NUMERIC, DATE, DATE_TIME, TEXT, BOOLEAN or CATEGORY.") + public String kind; + + @OpenAPIDescription("Default chart kind.") + public ChartKind defaultChartKind; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("name", new Schema().withType(Type.STRING).withDescription("Name.").withNullable(true)); + properties.put("label", new Schema().withType(Type.STRING).withDescription("Label.").withNullable(true)); + properties.put("type", new Schema().withType(Type.STRING).withDescription("Type.").withNullable(true)); + properties.put("kind", new Schema().withType(Type.STRING).withDescription("Semantic field kind: NUMERIC, DATE, DATE_TIME, TEXT, BOOLEAN or CATEGORY.").withNullable(true)); + properties.put("defaultChartKind", new Schema().withType(Type.STRING).withEnumValues(java.util.Arrays.stream(ChartKind.values()).map(Enum::name).toList()).withDescription("Default chart kind.").withNullable(true)); + return (new Schema().withType(Type.OBJECT).withNullable(true).withProperties(properties)); + } + } + + /******************************************************************************* + ** Limits version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisLimitsV1 implements ToSchema + { + @OpenAPIDescription("Max rows.") + public Integer maxRows; + + @OpenAPIDescription("Sample threshold rows.") + public Integer sampleThresholdRows; + + @OpenAPIDescription("Actual number of rows in the sample, not an extrapolated count.") + public Integer sampleRows; + + @OpenAPIDescription("Min group size.") + public Integer minGroupSize; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("maxRows", new Schema().withType(Type.INTEGER).withDescription("Max rows.").withNullable(true)); + properties.put("sampleThresholdRows", new Schema().withType(Type.INTEGER).withDescription("Sample threshold rows.").withNullable(true)); + properties.put("sampleRows", new Schema().withType(Type.INTEGER).withDescription("Actual number of rows in the sample, not an extrapolated count.").withNullable(true)); + properties.put("minGroupSize", new Schema().withType(Type.INTEGER).withDescription("Min group size.").withNullable(true)); + return (new Schema().withType(Type.OBJECT).withNullable(true).withProperties(properties)); + } + } + + /******************************************************************************* + ** StartRunRequest version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisStartRunRequestV1 implements ToSchema + { + @OpenAPIDescription("COLUMN_PROFILE or TABLE_PROFILE.") + public String operation; + + @OpenAPIDescription("Table name.") + public String tableName; + + @OpenAPIDescription("Profile parameters for the selected operation, without tableName.") + public Object request; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("operation", new Schema().withType(Type.STRING).withEnumValues(List.of("COLUMN_PROFILE", "TABLE_PROFILE")).withDescription("COLUMN_PROFILE or TABLE_PROFILE.")); + properties.put("tableName", new Schema().withType(Type.STRING).withDescription("Table name.")); + properties.put("request", new Schema().withOneOf(List.of(ref("DataAnalysisColumnProfileRequestV1"), ref("DataAnalysisTableProfileRequestV1"))).withDescription("Profile parameters for the selected operation, without tableName.")); + return (new RequiredSchema(List.of("operation", "tableName", "request")).withType(Type.OBJECT).withProperties(properties).withAdditionalProperties(false)); + } + } + + /******************************************************************************* + ** RunStarted version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisRunStartedV1 implements ToSchema + { + @OpenAPIDescription("Run id.") + public String runId; + + @OpenAPIDescription("Status.") + public String status; + + /******************************************************************************* + ** Explicit component references keep the standalone contract reusable. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("runId", new Schema().withType(Type.STRING).withDescription("Run id.").withNullable(true)); + properties.put("status", new Schema().withType(Type.STRING).withDescription("Status.").withNullable(true)); + return (new Schema().withType(Type.OBJECT).withNullable(true).withProperties(properties)); + } + } +} diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/AnalysisBackend.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/AnalysisBackend.java index 54ec58a..14ebe27 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/AnalysisBackend.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/AnalysisBackend.java @@ -44,10 +44,27 @@ public interface AnalysisBackend /******************************************************************************* - ** Actual row coverage and deterministic selected population. + ** Computation scope, observed coverage and optional native sampling percentage. *******************************************************************************/ - record Scope(QQueryFilter filter, long total, long rowsScanned, boolean truncated, boolean estimate) + record Scope(QQueryFilter filter, long total, long rowsScanned, boolean truncated, boolean estimate, BigDecimal samplePercent) { + /******************************************************************************* + ** Exact and prefix scopes have no random sampling percentage. + *******************************************************************************/ + public Scope(QQueryFilter filter, long total, long rowsScanned, boolean truncated, boolean estimate) + { + this(filter, total, rowsScanned, truncated, estimate, null); + } + + /******************************************************************************* + ** Explain whether counts extrapolate a random sample or describe a prefix. + *******************************************************************************/ + public String warning() + { + return (samplePercent == null ? "Estimate from the first " + rowsScanned + " rows by id" + : "Estimate from a random sample of about " + rowsScanned + " rows (" + samplePercent.stripTrailingZeros().toPlainString() + + "%). Counts are scaled to the full " + total + " rows; run exact for exact numbers."); + } } @@ -55,8 +72,16 @@ public interface AnalysisBackend /******************************************************************************* ** Blank includes null and whitespace; distinct excludes null. *******************************************************************************/ - record FieldCounts(long nonNull, long nulls, long blanks, long distinct, QQueryFilter blankFilter, QQueryFilter distinctFilter) + record FieldCounts(long nonNull, long nulls, long blanks, long distinct, QQueryFilter blankFilter, QQueryFilter distinctFilter, BigDecimal uniqueness, BigDecimal completeness, boolean constant) { + /******************************************************************************* + ** Exact and prefix counters use their own population for ratios. + *******************************************************************************/ + public FieldCounts(long nonNull, long nulls, long blanks, long distinct, QQueryFilter blankFilter, QQueryFilter distinctFilter) + { + this(nonNull, nulls, blanks, distinct, blankFilter, distinctFilter, ProfileSupport.share(distinct, nonNull), + ProfileSupport.share(nonNull + nulls - blanks, nonNull + nulls), distinct == 1); + } } @@ -64,8 +89,15 @@ public interface AnalysisBackend /******************************************************************************* ** Group and exact predicate producing its members. *******************************************************************************/ - record GroupCount(Serializable value, String label, long count, QQueryFilter condition) + record GroupCount(Serializable value, String label, long count, QQueryFilter condition, BigDecimal share) { + /******************************************************************************* + ** Ordinary groups derive their share from the profiler population. + *******************************************************************************/ + public GroupCount(Serializable value, String label, long count, QQueryFilter condition) + { + this(value, label, count, condition, null); + } } @@ -89,12 +121,12 @@ public interface AnalysisBackend /******************************************************************************* - ** Exact filtered count. + ** Filtered count; a native estimate scales conditional counts to its population. *******************************************************************************/ long count(String table, QQueryFilter filter) throws QException; /******************************************************************************* - ** Select the bounded population used consistently by all operations. + ** Configure a request-local exact, prefix or native sampling scope. *******************************************************************************/ Scope scope(String table, QQueryFilter filter, boolean exact) throws QException; diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/ColumnProfiler.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/ColumnProfiler.java index 7710dcf..55edeb3 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/ColumnProfiler.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/ColumnProfiler.java @@ -68,38 +68,40 @@ public class ColumnProfiler String name = field.getName(); QQueryFilter filter = scope.filter(); long rows = backend.count(table, filter); + QQueryFilter drillFilter = scope.estimate() ? request.getFilter() : filter; AnalysisBackend.FieldCounts counts = backend.fieldCounts(table, filter, List.of(name)).get(name); ColumnProfile result = new ColumnProfile().withTableName(table).withFieldName(name).withFieldLabel(field.getLabel()).withFieldType(field.getType().name()) - .withFilter(DrillFilters.restoreTypes(request.getTableName(), request.getFilter())).withEstimate(scope.estimate()).withSampleRows(scope.estimate() ? rows : 0L) + .withFilter(DrillFilters.restoreTypes(request.getTableName(), request.getFilter())).withEstimate(scope.estimate()).withSampleRows(scope.estimate() ? scope.rowsScanned() : 0L) .withRowsScanned(scope.rowsScanned()).withTruncated(scope.truncated()).withAsOf(Instant.now()); - result.getCounts().add(ProfileSupport.count("rows", rows, table, filter, null)); - result.getCounts().add(ProfileSupport.count("nonNull", counts.nonNull(), table, filter, DrillFilters.nonNull(name, field.getType().isStringLike()))); - result.getCounts().add(ProfileSupport.count("nulls", counts.nulls(), table, filter, DrillFilters.nulls(name, field.getType().isStringLike()))); + result.getCounts().add(ProfileSupport.count("rows", scope.estimate() ? scope.total() : rows, table, drillFilter, null)); + result.getCounts().add(ProfileSupport.count("nonNull", counts.nonNull(), table, drillFilter, DrillFilters.nonNull(name, field.getType().isStringLike()))); + result.getCounts().add(ProfileSupport.count("nulls", counts.nulls(), table, drillFilter, DrillFilters.nulls(name, field.getType().isStringLike()))); if(field.getType().isStringLike()) { - result.getCounts().add(ProfileSupport.count("blanks", counts.blanks(), table, filter, counts.blankFilter())); + result.getCounts().add(ProfileSupport.count("blanks", counts.blanks(), table, drillFilter, counts.blankFilter())); } - result.getCounts().add(ProfileSupport.count("distinct", counts.distinct(), table, filter, counts.distinctFilter())); - result.getCounts().add(ProfileSupport.metric("uniqueness", ProfileSupport.share(counts.distinct(), counts.nonNull()), ValueType.PERCENT)); - result.withTopValues(ProfileSupport.values(table, filter, field, backend.topValues(table, filter, name, 20, 0, null), rows)); + result.getCounts().add(ProfileSupport.count("distinct", counts.distinct(), table, drillFilter, counts.distinctFilter())); + result.getCounts().add(ProfileSupport.metric("uniqueness", counts.uniqueness(), ValueType.PERCENT)); + result.withTopValues(ProfileSupport.values(table, drillFilter, field, backend.topValues(table, filter, name, 20, 0, null), rows)); QFieldType type = field.getType(); if(type == QFieldType.INTEGER || type == QFieldType.LONG || type == QFieldType.DECIMAL) { - numeric(result, filter, rows); + numeric(result, filter, drillFilter, rows); } else if(type == QFieldType.DATE || type == QFieldType.DATE_TIME) { - dates(result, filter, rows, type); + dates(result, filter, drillFilter, rows, type); } else if(type.isStringLike()) { AnalysisBackend.LengthSummary summary = backend.lengthSummary(table, filter, name); - TextProfile text = new TextProfile().withHistogram(ProfileSupport.values(table, filter, null, summary.histogram(), rows)) - .withPatterns(ProfileSupport.values(table, filter, null, backend.patterns(table, filter, name, 10_000), Math.min(rows, 10_000))) - .withSampleRows(Math.min(rows, 10_000)); + TextProfile text = new TextProfile().withHistogram(ProfileSupport.values(table, drillFilter, null, summary.histogram(), rows)) + .withPatterns(ProfileSupport.values(table, drillFilter, null, backend.patterns(table, filter, name, 10_000), Math.min(rows, 10_000))) + .withSampleRows(Math.min(scope.rowsScanned(), 10_000)); summary.metrics().forEach((key, value) -> text.getMetrics().add(ProfileSupport.metric(key, value, ValueType.DECIMAL))); result.withText(text); - result.getWarnings().add("Patterns use the first " + Math.min(rows, 10_000) + " rows by primary key."); + result.getWarnings().add(scope.samplePercent() == null ? "Patterns use the first " + Math.min(rows, 10_000) + " rows by primary key." + : "Patterns use up to " + Math.min(scope.rowsScanned(), 10_000) + " sampled rows."); } else if(type == QFieldType.BOOLEAN) { @@ -107,11 +109,28 @@ public class ColumnProfiler for(boolean value : List.of(true, false)) { QQueryFilter condition = DrillFilters.value(name, value, false); - result.getBooleans().add(ProfileSupport.count(Boolean.toString(value), backend.count(table, DrillFilters.and(filter, condition)), table, filter, condition)); + result.getBooleans().add(ProfileSupport.count(Boolean.toString(value), backend.count(table, DrillFilters.and(filter, condition)), table, drillFilter, condition)); } - result.getBooleans().add(ProfileSupport.count("nulls", counts.nulls(), table, filter, DrillFilters.nulls(name, false))); + result.getBooleans().add(ProfileSupport.count("nulls", counts.nulls(), table, drillFilter, DrillFilters.nulls(name, false))); } new MinGroupSizeGuard(config.getMinGroupSize()).column(result, rows); + if(scope.estimate()) + { + ProfileSupport.markEstimates(result.getCounts()); + ProfileSupport.markEstimates(result.getBooleans()); + if(result.getNumeric() != null) + { + ProfileSupport.markEstimates(result.getNumeric().getMetrics()); + } + if(result.getDates() != null) + { + ProfileSupport.markEstimates(result.getDates().getMetrics()); + } + if(result.getText() != null) + { + ProfileSupport.markEstimates(result.getText().getMetrics()); + } + } if(field.getPossibleValueSourceName() != null || result.getNumeric() == null && result.getDates() == null) { result.withChart(ProfileSupport.chart(ChartKind.BAR, ChartKind.PARETO, name, result.getTopValues())); @@ -128,17 +147,22 @@ public class ColumnProfiler { result.getWarnings().add("No readable records match this analysis scope."); } - else if(counts.nonNull() == 0) + else if(counts.nonNull() == 0 && (!scope.estimate() || scope.rowsScanned() > 0)) { result.getWarnings().add("All values in this analysis scope are null."); } if(scope.estimate()) { - result.getWarnings().add("Estimate: first " + rows + " rows by primary key; not a random sample."); + result.getWarnings().add(scope.warning()); + if(scope.rowsScanned() == 0) + { + result.getWarnings().add("No sample rows were observed; run exact for exact numbers."); + } } if(scope.truncated()) { - result.getWarnings().add("Partial result: max_rows reached; counts and drills cover only the selected prefix."); + result.getWarnings().add(scope.estimate() ? "Partial result: max_rows reached; counts cover the selected prefix and drills cover the full population." + : "Partial result: max_rows reached; counts and drills cover only the selected prefix."); } return (result); } @@ -148,7 +172,7 @@ public class ColumnProfiler /******************************************************************************* ** Numeric moments, twenty interior bins, exterior bins and Tukey outliers. *******************************************************************************/ - private void numeric(ColumnProfile result, QQueryFilter filter, long rows) throws QException + private void numeric(ColumnProfile result, QQueryFilter filter, QQueryFilter drillFilter, long rows) throws QException { String table = result.getTableName(); String field = result.getFieldName(); @@ -158,12 +182,12 @@ public class ColumnProfiler summary.metrics().forEach((key, value) -> numeric.getMetrics().add(ProfileSupport.metric(key, value, ValueType.DECIMAL))); for(AnalysisBackend.GroupCount count : summary.counts()) { - numeric.getMetrics().add(ProfileSupport.count(count.label(), count.count(), table, filter, count.condition())); + numeric.getMetrics().add(ProfileSupport.count(count.label(), count.count(), table, drillFilter, count.condition())); } - numeric.getMetrics().add(ProfileSupport.count("outliers", summary.outlierCount(), table, filter, summary.outlierFilter())); - numeric.withHistogram(ProfileSupport.values(table, filter, null, + numeric.getMetrics().add(ProfileSupport.count("outliers", summary.outlierCount(), table, drillFilter, summary.outlierFilter())); + numeric.withHistogram(ProfileSupport.values(table, drillFilter, null, backend.numericHistogram(table, filter, field, summary.metrics().get("p1"), summary.metrics().get("p99"), 20), rows)); - numeric.withOutliers(ProfileSupport.values(table, filter, null, summary.outliers(), rows)); + numeric.withOutliers(ProfileSupport.values(table, drillFilter, null, summary.outliers(), rows)); result.withNumeric(numeric); } @@ -172,7 +196,7 @@ public class ColumnProfiler /******************************************************************************* ** Date extrema, range, calendar volume, gaps and cyclic time patterns. *******************************************************************************/ - private void dates(ColumnProfile result, QQueryFilter filter, long rows, QFieldType type) throws QException + private void dates(ColumnProfile result, QQueryFilter filter, QQueryFilter drillFilter, long rows, QFieldType type) throws QException { String table = result.getTableName(); String field = result.getFieldName(); @@ -188,12 +212,12 @@ public class ColumnProfiler AnalysisBackend.DateUnit unit = autoBucket(first, last); dates.withUnit(unit.name()); dates.getMetrics().add(ProfileSupport.metric("range", ChronoUnit.DAYS.between(first, last), ValueType.DURATION)); - List buckets = ProfileSupport.values(table, filter, null, backend.dateBuckets(table, filter, field, unit, zone), rows); + List buckets = ProfileSupport.values(table, drillFilter, null, backend.dateBuckets(table, filter, field, unit, zone), rows); dates.withBuckets(buckets).withGaps(buckets.stream().filter(b -> b.getCount() == 0).toList()); if(type == QFieldType.DATE_TIME) { - dates.withDayOfWeek(ProfileSupport.values(table, filter, null, backend.dateBuckets(table, filter, field, AnalysisBackend.DateUnit.DAY_OF_WEEK, zone), rows)) - .withHourOfDay(ProfileSupport.values(table, filter, null, backend.dateBuckets(table, filter, field, AnalysisBackend.DateUnit.HOUR_OF_DAY, zone), rows)); + dates.withDayOfWeek(ProfileSupport.values(table, drillFilter, null, backend.dateBuckets(table, filter, field, AnalysisBackend.DateUnit.DAY_OF_WEEK, zone), rows)) + .withHourOfDay(ProfileSupport.values(table, drillFilter, null, backend.dateBuckets(table, filter, field, AnalysisBackend.DateUnit.HOUR_OF_DAY, zone), rows)); } } result.withDates(dates); diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/CoreAnalysisBackend.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/CoreAnalysisBackend.java new file mode 100644 index 0000000..e5f9201 --- /dev/null +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/CoreAnalysisBackend.java @@ -0,0 +1,475 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis.engine; + +import java.io.Serializable; +import java.math.BigDecimal; +import java.math.MathContext; +import java.math.RoundingMode; +import java.time.LocalDate; +import java.time.ZoneId; +import java.util.ArrayList; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Set; +import com.kingsrook.qqq.backend.core.exceptions.QException; +import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.Aggregate; +import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.AggregateCapability; +import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.AggregateInput; +import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.AggregateOperator; +import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.AggregateResult; +import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.DateBucket; +import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.DateBucketUnit; +import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.GroupBy; +import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.NumericBucket; +import com.kingsrook.qqq.backend.core.model.actions.tables.query.QCriteriaOperator; +import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter; +import com.kingsrook.qqq.backend.core.model.data.QRecord; +import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType; +import com.kingsrook.qqq.backend.core.modules.backend.QBackendModuleDispatcher; +import com.kingsrook.qqq.backend.core.utils.JsonUtils; + +/******************************************************************************* + ** Capability-directed aggregates; streamed primitives retain portable drills. + *******************************************************************************/ +public class CoreAnalysisBackend extends StandInAnalysisBackend +{ + private BigDecimal samplePercent; + private QQueryFilter populationFilter; + private long populationRows; + private long aggregateRows; + private BigDecimal lastCountShare; + + /******************************************************************************* + ** Bind the same bounded configuration as the streamed implementation. + *******************************************************************************/ + public CoreAnalysisBackend(EffectiveConfig config) + { + super(config); + } + + /******************************************************************************* + ** Ask the actual backend implementation, including dialect-specific support. + *******************************************************************************/ + public static Set capabilities(String table) throws QException + { + AggregateInput input = new AggregateInput(table); + return (new QBackendModuleDispatcher().getQBackendModule(input.getBackend()).getAggregateInterface().getSupportedCapabilities(input)); + } + + /******************************************************************************* + ** Sampling belongs to each aggregate, never to a materialized key filter. + *******************************************************************************/ + @Override + public Scope scope(String table, QQueryFilter filter, boolean exact) throws QException + { + samplePercent = null; + long total = super.count(table, filter); + if(exact || total <= config.getSampleThresholdRows() || !capabilities(table).contains(AggregateCapability.SAMPLING)) + { + return (super.scope(table, filter, exact)); + } + estimating = true; + populationRows = total; + populationFilter = DrillFilters.copy(filter); + samplePercent = BigDecimal.valueOf(config.getSampleRows()).multiply(BigDecimal.valueOf(100)) + .divide(BigDecimal.valueOf(total), MathContext.DECIMAL128).min(BigDecimal.valueOf(100)); + long seen = sampledCount(table, populationFilter); + return (new Scope(DrillFilters.copy(filter), total, seen, false, true, samplePercent)); + } + + /******************************************************************************* + ** Count the sampled call's actual rows rather than assuming the requested size. + *******************************************************************************/ + private long sampledCount(String table, QQueryFilter filter) throws QException + { + if(samplePercent.signum() == 0) + { + return (0); + } + List result = super.aggregate(new AggregateInput(table).withFilter(DrillFilters.copy(filter)) + .withAggregate(countOf(primaryKey(table), AggregateOperator.COUNT)).withSamplePercent(samplePercent)); + return (result.isEmpty() ? 0 : number(result.getFirst(), primaryKey(table), AggregateOperator.COUNT).longValue()); + } + + /******************************************************************************* + ** Unpaginated groups supply their own denominator, including null groups. + ** Limited groups use a separate sampled population count for this call. + *******************************************************************************/ + @Override + protected List aggregate(AggregateInput input) throws QException + { + if(samplePercent == null) + { + return (super.aggregate(input)); + } + if(samplePercent.signum() == 0) + { + aggregateRows = 0; + return (List.of()); + } + Aggregate count = countOf(primaryKey(input.getTableName()), AggregateOperator.COUNT); + if(input.getAggregates() == null || !input.getAggregates().contains(count)) + { + input.withAggregate(count); + } + input.withSamplePercent(samplePercent); + boolean fullPopulation = JsonUtils.toJson(DrillFilters.copy(input.getFilter())).equals(JsonUtils.toJson(populationFilter)); + List result = super.aggregate(input); + aggregateRows = fullPopulation && input.getLimit() == null + ? result.stream().mapToLong(r -> number(r, primaryKey(input.getTableName()), AggregateOperator.COUNT).longValue()).sum() + : sampledCount(input.getTableName(), populationFilter); + return (result); + } + + /******************************************************************************* + ** Population rows remain exact; conditional counters estimate their membership. + *******************************************************************************/ + @Override + public long count(String table, QQueryFilter filter) throws QException + { + if(samplePercent == null) + { + return (super.count(table, filter)); + } + if(JsonUtils.toJson(DrillFilters.copy(filter)).equals(JsonUtils.toJson(populationFilter))) + { + lastCountShare = ProfileSupport.share(populationRows, populationRows); + return (populationRows); + } + long value = sampledCount(table, filter); + aggregateRows = sampledCount(table, populationFilter); + lastCountShare = ProfileSupport.share(value, aggregateRows); + return (aggregateCount(value)); + } + + /******************************************************************************* + ** Round count estimates only after normalizing by observed sample rows. + *******************************************************************************/ + @Override + protected long aggregateCount(long value) + { + return (samplePercent == null ? value : aggregateRows == 0 ? 0 : BigDecimal.valueOf(value).multiply(BigDecimal.valueOf(populationRows)) + .divide(BigDecimal.valueOf(aggregateRows), 0, RoundingMode.HALF_UP).longValueExact()); + } + + /******************************************************************************* + ** Keep ratios in sample units, independent of count rounding. + *******************************************************************************/ + @Override + protected BigDecimal aggregateShare(long value) + { + return (samplePercent == null ? null : ProfileSupport.share(value, aggregateRows)); + } + + /******************************************************************************* + ** Conditional groups retain the ratio from their sampled count call. + *******************************************************************************/ + @Override + protected BigDecimal countShare() + { + return (samplePercent == null ? null : lastCountShare); + } + + /******************************************************************************* + ** Streamed fallbacks also observe native sampling, without binding sampled ids. + *******************************************************************************/ + @Override + protected List rows(String table, QQueryFilter filter, Set fields, int limit) throws QException + { + if(samplePercent == null) + { + return (super.rows(table, filter, fields, limit)); + } + if(limit == 0 || config.getMaxRows() == 0) + { + return (List.of()); + } + AggregateInput input = new AggregateInput(table).withFilter(DrillFilters.copy(filter)).withGroupBy(new GroupBy(field(table, primaryKey(table)))) + .withLimit(Math.min(limit, config.getMaxRows())); + fields.stream().filter(f -> !f.equals(primaryKey(table))).forEach(f -> input.withGroupBy(new GroupBy(field(table, f)))); + List result = new ArrayList<>(); + for(AggregateResult row : aggregate(input)) + { + QRecord record = new QRecord(); + row.getGroupByValues().forEach((key, value) -> record.setValue(key.getFieldName(), value)); + result.add(record); + } + return (result); + } + + /******************************************************************************* + ** Every field batch shares a COUNT denominator from the same sampled call. + *******************************************************************************/ + @Override + public Map fieldCounts(String table, QQueryFilter filter, List fields) throws QException + { + if(samplePercent == null) + { + return (super.fieldCounts(table, filter, fields)); + } + Map result = new LinkedHashMap<>(); + for(int start = 0; start < fields.size(); start += 20) + { + List batch = fields.subList(start, Math.min(start + 20, fields.size())); + AggregateInput input = new AggregateInput(table).withFilter(DrillFilters.copy(filter)); + for(String field : batch) + { + input.withAggregate(countOf(field, AggregateOperator.COUNT)).withAggregate(countOf(field, AggregateOperator.COUNT_DISTINCT)); + } + fieldCountAggregates(input, batch); + List stringFields = batch.stream().filter(f -> field(table, f).getType().isStringLike()).toList(); + List records = stringFields.isEmpty() ? List.of() : rows(table, filter, Set.copyOf(stringFields), config.getMaxRows()); + List results = aggregate(input); + long seen = aggregateRows; + for(String field : batch) + { + boolean string = field(table, field).getType().isStringLike(); + long nonNull = results.isEmpty() ? 0 : number(results.getFirst(), field, AggregateOperator.COUNT).longValue(); + long distinct = results.isEmpty() ? 0 : number(results.getFirst(), field, AggregateOperator.COUNT_DISTINCT).longValue(); + long blanks = string && capabilities(table).contains(AggregateCapability.NULL_BLANK_COUNTS) && !results.isEmpty() + ? number(results.getFirst(), field, AggregateOperator.COUNT_BLANK).longValue() : seen - nonNull; + QQueryFilter blankFilter = DrillFilters.nulls(field, string); + if(string) + { + blankFilter = new QQueryFilter().withBooleanOperator(QQueryFilter.BooleanOperator.OR).withSubFilter(blankFilter); + for(String blank : records.stream().map(r -> r.getValueString(field)).filter(Objects::nonNull).filter(String::isBlank).distinct().toList()) + { + blankFilter.withSubFilter(DrillFilters.condition(field, QCriteriaOperator.EQUALS, blank)); + } + } + long blankCount = aggregateCount(blanks); + BigDecimal completeness = ProfileSupport.share(seen - blanks, seen); + if(string && !capabilities(table).contains(AggregateCapability.NULL_BLANK_COUNTS)) + { + blankCount = count(table, DrillFilters.and(filter, blankFilter)); + completeness = BigDecimal.ONE.subtract(countShare()); + aggregateRows = seen; + } + result.put(field, new FieldCounts(aggregateCount(nonNull), aggregateCount(seen - nonNull), blankCount, aggregateCount(distinct), + blankFilter, DrillFilters.nonNull(field, string), ProfileSupport.share(distinct, nonNull), completeness, distinct == 1)); + } + } + return (result); + } + + /******************************************************************************* + ** Add supported counters to the existing twenty-field aggregate batch. + *******************************************************************************/ + @Override + protected void fieldCountAggregates(AggregateInput input, List fields) throws QException + { + if(capabilities(input.getTableName()).contains(AggregateCapability.NULL_BLANK_COUNTS)) + { + for(String name : fields) + { + input.withAggregate(new Aggregate(name, AggregateOperator.COUNT_NULL)); + if(field(input.getTableName(), name).getType().isStringLike()) + { + input.withAggregate(new Aggregate(name, AggregateOperator.COUNT_BLANK)); + } + } + } + } + + /******************************************************************************* + ** Read native counters, falling back to the portable predicate counter. + *******************************************************************************/ + @Override + protected long fieldCount(String table, QQueryFilter filter, String field, AggregateOperator operator, + List results, QQueryFilter condition) throws QException + { + if(capabilities(table).contains(AggregateCapability.NULL_BLANK_COUNTS)) + { + return (results.isEmpty() ? 0 : number(results.getFirst(), field, operator).longValue()); + } + return (super.fieldCount(table, filter, field, operator, results, condition)); + } + + /******************************************************************************* + ** Push each supported statistic, streaming only unavailable operators. + *******************************************************************************/ + @Override + protected Map numericMetrics(String table, QQueryFilter filter, String field, List percentiles, List values) throws QException + { + Set supported = capabilities(table); + if(!supported.containsAll(Set.of(AggregateCapability.STDDEV, AggregateCapability.PERCENTILE))) + { + return (partialNumericMetrics(table, filter, field, percentiles, values, supported)); + } + return (nativeNumericMetrics(table, filter, field, percentiles, supported)); + } + + /******************************************************************************* + ** Existing streamed arithmetic supplies only unavailable metrics. + *******************************************************************************/ + private Map partialNumericMetrics(String table, QQueryFilter filter, String field, List percentiles, + List values, Set supported) throws QException + { + Map metrics = super.numericMetrics(table, filter, field, percentiles, values); + metrics.putAll(nativeNumericMetrics(table, filter, field, percentiles, supported)); + return (metrics); + } + + /******************************************************************************* + ** One aggregate call computes basic moments and all supported extensions. + *******************************************************************************/ + private Map nativeNumericMetrics(String table, QQueryFilter filter, String field, List percentiles, + Set supported) throws QException + { + Map metrics = new LinkedHashMap<>(); + AggregateInput input = new AggregateInput(table).withFilter(DrillFilters.copy(filter)); + Map names = Map.of(AggregateOperator.MIN, "min", AggregateOperator.MAX, "max", AggregateOperator.AVG, "mean", AggregateOperator.SUM, "sum", AggregateOperator.STDDEV_SAMP, "stddev"); + for(AggregateOperator op : names.keySet()) + { + if(op != AggregateOperator.STDDEV_SAMP || supported.contains(AggregateCapability.STDDEV)) + { + input.withAggregate(new Aggregate(field, op)); + } + } + if(supported.contains(AggregateCapability.PERCENTILE)) + { + percentiles.forEach(p -> input.withAggregate(new Aggregate(field, AggregateOperator.PERCENTILE_CONT).withPercentile(p))); + } + for(AggregateResult row : aggregate(input)) + { + row.getAggregateValues().entrySet().stream().filter(e -> e.getKey().getOperator() != AggregateOperator.COUNT).forEach(entry -> + { + Aggregate key = entry.getKey(); + Serializable value = entry.getValue(); + metrics.put(key.getOperator() == AggregateOperator.PERCENTILE_CONT + ? "p" + key.getPercentile().multiply(BigDecimal.valueOf(100)).stripTrailingZeros().toPlainString() : names.get(key.getOperator()), + value == null ? null : new BigDecimal(value.toString())); + }); + } + return (metrics); + } + + /******************************************************************************* + ** Convert native bin numbers into identical half-open drill predicates. + *******************************************************************************/ + @Override + public List numericHistogram(String table, QQueryFilter filter, String field, BigDecimal low, BigDecimal high, int bins) throws QException + { + if(low == null || high == null || low.compareTo(high) >= 0 || !capabilities(table).contains(AggregateCapability.NUMERIC_BUCKET)) + { + return (super.numericHistogram(table, filter, field, low, high, bins)); + } + GroupBy group = new GroupBy(field(table, field)).withBucket(new NumericBucket(low, high, bins)); + Map counts = bucketCounts(table, filter, group); + List values = !estimating && isMemory(table) ? rows(table, filter, Set.of(field), config.getMaxRows()).stream().map(r -> r.getValue(field)) + .filter(Objects::nonNull).map(v -> new BigDecimal(v.toString())).toList() : List.of(); + List result = new ArrayList<>(); + result.add(new GroupCount("Below " + low, "Below " + low, aggregateCount(counts.getOrDefault(0, 0L)), numericRange(table, field, values, null, low, false), aggregateShare(counts.getOrDefault(0, 0L)))); + BigDecimal width = high.subtract(low).divide(BigDecimal.valueOf(bins), MathContext.DECIMAL128); + for(int i = 0; i < bins; i++) + { + BigDecimal start = low.add(width.multiply(BigDecimal.valueOf(i))); + BigDecimal end = i == bins - 1 ? high : low.add(width.multiply(BigDecimal.valueOf(i + 1))); + String label = "[" + start + ", " + end + (i == bins - 1 ? "]" : ")"); + result.add(new GroupCount(label, label, aggregateCount(counts.getOrDefault(i + 1, 0L)), numericRange(table, field, values, start, end, i == bins - 1), aggregateShare(counts.getOrDefault(i + 1, 0L)))); + } + result.add(new GroupCount("Above " + high, "Above " + high, aggregateCount(counts.getOrDefault(bins + 1, 0L)), + DrillFilters.and(DrillFilters.condition(field, QCriteriaOperator.IS_NOT_BLANK), DrillFilters.condition(field, QCriteriaOperator.GREATER_THAN, high)), aggregateShare(counts.getOrDefault(bins + 1, 0L)))); + return (result); + } + + /******************************************************************************* + ** Native dates use the session zone; fill calendar gaps with zero counts. + *******************************************************************************/ + @Override + public List dateBuckets(String table, QQueryFilter filter, String field, DateUnit unit, ZoneId zone) throws QException + { + GroupBy group = new GroupBy(field(table, field)).withBucket(new DateBucket(DateBucketUnit.valueOf(unit.name()))); + AggregateInput probe = new AggregateInput(table).withGroupBy(group); + if(!new QBackendModuleDispatcher().getQBackendModule(probe.getBackend()).getAggregateInterface().getSupportedCapabilities(probe).contains(AggregateCapability.DATE_BUCKET)) + { + return (super.dateBuckets(table, filter, field, unit, zone)); + } + Map counts = bucketCounts(table, filter, group); + if(unit == DateUnit.DAY_OF_WEEK || unit == DateUnit.HOUR_OF_DAY) + { + long seen = aggregateRows; + List conditions = super.dateBuckets(table, filter, field, unit, zone); + aggregateRows = seen; + return (conditions.stream() + .map(g -> new GroupCount(g.value(), g.label(), aggregateCount(counts.getOrDefault(g.value(), 0L)), g.condition(), aggregateShare(counts.getOrDefault(g.value(), 0L)))).toList()); + } + List dates = counts.keySet().stream().filter(Objects::nonNull).map(v -> (LocalDate) v).sorted().toList(); + List result = new ArrayList<>(); + if(!dates.isEmpty()) + { + LocalDate start = dates.getFirst(); + while(!start.isAfter(dates.getLast())) + { + LocalDate end = next(start, unit); + String label = start + " / " + end; + result.add(new GroupCount(label, label, aggregateCount(counts.getOrDefault(start, 0L)), + DrillFilters.dateRange(field, start, end, field(table, field).getType() == QFieldType.DATE_TIME, zone), aggregateShare(counts.getOrDefault(start, 0L)))); + start = end; + } + } + return (result); + } + + /******************************************************************************* + ** Length moments are native; the derived length histogram remains streamed. + *******************************************************************************/ + @Override + public LengthSummary lengthSummary(String table, QQueryFilter filter, String field) throws QException + { + LengthSummary streamed = super.lengthSummary(table, filter, field); + if(capabilities(table).contains(AggregateCapability.STRING_LENGTH)) + { + AggregateInput input = new AggregateInput(table).withFilter(DrillFilters.copy(filter)); + Map names = Map.of(AggregateOperator.MIN_LENGTH, "minLength", AggregateOperator.MAX_LENGTH, "maxLength", AggregateOperator.AVG_LENGTH, "meanLength"); + names.keySet().forEach(op -> input.withAggregate(new Aggregate(field, op))); + for(AggregateResult row : aggregate(input)) + { + row.getAggregateValues().forEach((key, value) -> + { + if(value != null && names.containsKey(key.getOperator())) + { + streamed.metrics().put(names.get(key.getOperator()), new BigDecimal(value.toString())); + } + }); + } + } + return (streamed); + } + + /******************************************************************************* + ** Bucket result keys retain core's typed date or integer values. + *******************************************************************************/ + private Map bucketCounts(String table, QQueryFilter filter, GroupBy group) throws QException + { + Map result = new LinkedHashMap<>(); + AggregateInput input = new AggregateInput(table).withFilter(DrillFilters.copy(filter)).withGroupBy(group) + .withAggregate(countOf(primaryKey(table), AggregateOperator.COUNT)); + for(AggregateResult row : aggregate(input)) + { + result.put(row.getGroupByValues().get(group), number(row, primaryKey(table), AggregateOperator.COUNT).longValue()); + } + return (result); + } +} diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/DrillFilters.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/DrillFilters.java index d860959..51a81a4 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/DrillFilters.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/DrillFilters.java @@ -75,11 +75,63 @@ public final class DrillFilters *******************************************************************************/ public static Drill drill(String table, QQueryFilter original, QQueryFilter condition) { - return (new Drill().withTableName(table).withFilter(and(original, condition))); + QQueryFilter filter = and(original, condition); + var instance = com.kingsrook.qqq.backend.core.context.QContext.getQInstance(); + if(instance != null && "memory".equals(instance.getBackend(instance.getTable(table).getBackendName()).getBackendType())) + { + filter = memoryTemporalBounds(restoreTypes(table, filter)); + } + return (new Drill().withTableName(table).withFilter(filter)); } + /******************************************************************************* + ** Memory's inclusive lower bound uses Java equality, which differs after + ** HTTP turns dates into strings. Strict lower bounds avoid that equality. + ** Only memory uses this adjustment: SQL timestamp precision may be coarser. + *******************************************************************************/ + private static QQueryFilter memoryTemporalBounds(QQueryFilter filter) + { + filter.setSubFilters(new java.util.ArrayList<>(filter.getSubFilters())); + for(var criterion : new java.util.ArrayList<>(filter.getCriteria())) + { + if(criterion.getValues() != null && !criterion.getValues().isEmpty() + && criterion.getValues().stream().allMatch(v -> v instanceof java.time.Instant || v instanceof LocalDate) + && (criterion.getOperator() == QCriteriaOperator.EQUALS || criterion.getOperator() == QCriteriaOperator.IN)) + { + QQueryFilter members = new QQueryFilter().withBooleanOperator(QQueryFilter.BooleanOperator.OR); + for(Serializable value : criterion.getValues()) + { + members.withSubFilter(range(criterion.getFieldName(), value, value, true)); + } + filter.getCriteria().remove(criterion); + filter.withSubFilter(members); + continue; + } + if(criterion.getValues() != null && criterion.getValues().size() == 1) + { + Serializable value = criterion.getValues().getFirst(); + if(value instanceof java.time.Instant || value instanceof LocalDate) + { + Serializable previous = value instanceof java.time.Instant instant ? instant.minusNanos(1) : ((LocalDate) value).minusDays(1); + if(criterion.getOperator() == QCriteriaOperator.GREATER_THAN_OR_EQUALS) + { + criterion.setOperator(QCriteriaOperator.GREATER_THAN); + criterion.setValues(List.of(previous)); + } + else if(criterion.getOperator() == QCriteriaOperator.LESS_THAN) + { + criterion.setOperator(QCriteriaOperator.LESS_THAN_OR_EQUALS); + criterion.setValues(List.of(previous)); + } + } + } + } + filter.getSubFilters().forEach(DrillFilters::memoryTemporalBounds); + return (filter); + } + /******************************************************************************* ** One criterion, including predicates without operands. *******************************************************************************/ @@ -116,7 +168,7 @@ public final class DrillFilters QQueryFilter result = condition(field, QCriteriaOperator.IS_NOT_BLANK); if(string) { - result.withBooleanOperator(QQueryFilter.BooleanOperator.OR).withCriteria(field, QCriteriaOperator.EQUALS, ""); + result.withBooleanOperator(QQueryFilter.BooleanOperator.OR).withSubFilter(emptyString(field)); } return (result); } @@ -128,7 +180,8 @@ public final class DrillFilters *******************************************************************************/ public static QQueryFilter value(String field, Serializable value, boolean string) { - return (value == null ? nulls(field, string) : condition(field, QCriteriaOperator.EQUALS, value)); + return (value == null ? nulls(field, string) : "".equals(value) ? emptyString(field) + : value instanceof java.time.Instant || value instanceof LocalDate ? range(field, value, value, true) : condition(field, QCriteriaOperator.EQUALS, value)); } @@ -181,11 +234,33 @@ public final class DrillFilters *******************************************************************************/ public static QQueryFilter in(String field, List values) { + if(values.stream().anyMatch(v -> v instanceof java.time.Instant || v instanceof LocalDate)) + { + QQueryFilter result = new QQueryFilter().withBooleanOperator(QQueryFilter.BooleanOperator.OR); + values.forEach(value -> result.withSubFilter(range(field, value, value, true))); + return (result); + } + if(values.contains("")) + { + List nonEmpty = values.stream().filter(v -> !"".equals(v)).toList(); + return (new QQueryFilter().withBooleanOperator(QQueryFilter.BooleanOperator.OR).withSubFilter(emptyString(field)).withSubFilter(in(field, nonEmpty))); + } return (values.isEmpty() ? condition(field, QCriteriaOperator.FALSE) : new QQueryFilter().withCriteria(field, QCriteriaOperator.IN, values)); } + /******************************************************************************* + ** Core HTTP interpretation treats empty string operands as missing inputs. + ** A zero-length predicate expresses the same set without an empty operand. + *******************************************************************************/ + private static QQueryFilter emptyString(String field) + { + return (new QQueryFilter().withCriteria(new com.kingsrook.qqq.backend.core.model.actions.tables.query.QFilterCriteria(field, QCriteriaOperator.EQUALS, 0) + .withFieldFunction(new com.kingsrook.qqq.backend.core.model.metadata.fields.functions.FieldFunction().withFieldName(field) + .withFunctionTypeIdentifier(com.kingsrook.qqq.backend.core.model.metadata.fields.functions.implementations.StringLengthFunction.IDENTIFIER)))); + } + /******************************************************************************* ** JSON has no temporal scalar types. Restore them from current metadata before ** a cached drill is handed back to core, without mutating the stored filter. diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/DuplicateFinder.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/DuplicateFinder.java index e8fe3e1..fb251c0 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/DuplicateFinder.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/DuplicateFinder.java @@ -51,6 +51,6 @@ public class DuplicateFinder return (new DuplicatesResult().withTableName(request.getTableName()).withFields(request.getFields()).withFilter(DrillFilters.copy(request.getFilter())) .withRowsScanned(scope.rowsScanned()).withTruncated(scope.truncated()).withAsOf(Instant.now()) .withGroups(new MinGroupSizeGuard(config.getMinGroupSize()).groups(ProfileSupport.values(request.getTableName(), scope.filter(), null, - backend.duplicates(request.getTableName(), scope.filter(), request.getFields(), 50), scope.rowsScanned())))); + backend.duplicates(request.getTableName(), scope.filter(), request.getFields(), request.getLimit()), scope.rowsScanned())))); } } diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/ProfileSupport.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/ProfileSupport.java index 0092e3f..83c8b59 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/ProfileSupport.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/ProfileSupport.java @@ -81,6 +81,24 @@ public final class ProfileSupport + /******************************************************************************* + ** The population row total is exact even when other metrics are estimates. + *******************************************************************************/ + public static void markEstimates(List metrics) + { + if(metrics != null) + { + metrics.stream().filter(m -> !"rows".equals(m.getKey())).forEach(m -> + { + m.withEstimate(true); + if(m.getFormatted() != null) + { + m.withFormatted("≈ " + m.getFormatted()); + } + }); + } + } + /******************************************************************************* ** PVS translations run as the current user; drill values always remain ids. *******************************************************************************/ @@ -98,7 +116,7 @@ public final class ProfileSupport label = translated; } } - result.add(new ValueCount().withValue(group.value()).withLabel(label).withCount(group.count()).withShare(share(group.count(), total)) + result.add(new ValueCount().withValue(group.value()).withLabel(label).withCount(group.count()).withShare(group.share() == null ? share(group.count(), total) : group.share()) .withDrill(DrillFilters.drill(table, filter, group.condition()))); } return (result); diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/StandInAnalysisBackend.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/StandInAnalysisBackend.java index 121d9bd..a8ee186 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/StandInAnalysisBackend.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/StandInAnalysisBackend.java @@ -68,7 +68,8 @@ import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType; public class StandInAnalysisBackend implements AnalysisBackend { private static final MathContext MATH = MathContext.DECIMAL128; - private final EffectiveConfig config; + protected final EffectiveConfig config; + protected boolean estimating; /******************************************************************************* ** Bind one request's detached configuration. @@ -94,13 +95,14 @@ public class StandInAnalysisBackend implements AnalysisBackend /******************************************************************************* - ** A boundary query selects the prefix retained in every drill. + ** A single boundary parameter bounds the prefix used for computation. *******************************************************************************/ @Override public Scope scope(String table, QQueryFilter filter, boolean exact) throws QException { long total = count(table, filter); boolean estimate = !exact && total > config.getSampleThresholdRows(); + estimating = estimate; int limit = estimate ? Math.min(config.getSampleRows(), config.getMaxRows()) : config.getMaxRows(); QQueryFilter scoped = DrillFilters.copy(filter); if(total > limit) @@ -108,7 +110,7 @@ public class StandInAnalysisBackend implements AnalysisBackend String pk = primaryKey(table); if(limit == 0) { - scoped = DrillFilters.and(scoped, DrillFilters.in(pk, List.of())); + scoped = DrillFilters.and(scoped, DrillFilters.condition(pk, QCriteriaOperator.IS_BLANK)); } else { @@ -141,7 +143,7 @@ public class StandInAnalysisBackend implements AnalysisBackend /******************************************************************************* ** Bound both page size and retained records. *******************************************************************************/ - private List rows(String table, QQueryFilter filter, Set fields, int limit) throws QException + protected List rows(String table, QQueryFilter filter, Set fields, int limit) throws QException { List records = new ArrayList<>(); int bound = Math.min(limit, config.getMaxRows()); @@ -163,7 +165,7 @@ public class StandInAnalysisBackend implements AnalysisBackend /******************************************************************************* ** Core applies table permissions, field locks and record locks. *******************************************************************************/ - private List aggregate(AggregateInput input) throws QException + protected List aggregate(AggregateInput input) throws QException { QQueryFilter restored = DrillFilters.restoreTypes(input.getTableName(), input.getFilter()); restored.setOrderBys(input.getFilter().getOrderBys()); @@ -191,6 +193,7 @@ public class StandInAnalysisBackend implements AnalysisBackend { input.withAggregate(countOf(field, AggregateOperator.COUNT)).withAggregate(countOf(field, AggregateOperator.COUNT_DISTINCT)); } + fieldCountAggregates(input, batch); List aggregates = aggregate(input); Set selection = new LinkedHashSet<>(batch); selection.add(primaryKey(table)); @@ -198,7 +201,7 @@ public class StandInAnalysisBackend implements AnalysisBackend for(String field : batch) { boolean string = field(table, field).getType().isStringLike(); - long nulls = count(table, DrillFilters.and(filter, DrillFilters.nulls(field, string))); + long nulls = fieldCount(table, filter, field, AggregateOperator.COUNT_NULL, aggregates, DrillFilters.nulls(field, string)); Map representatives = new LinkedHashMap<>(); Set blanks = new LinkedHashSet<>(); for(QRecord record : records) @@ -220,12 +223,12 @@ public class StandInAnalysisBackend implements AnalysisBackend .withSubFilter(DrillFilters.in(field, new ArrayList<>(blanks))); } long distinct = aggregates.isEmpty() ? 0 : number(aggregates.getFirst(), field, AggregateOperator.COUNT_DISTINCT).longValue(); - if(isMemory(table) && field(table, field).getType() == QFieldType.DECIMAL) + if(!estimating && isMemory(table) && field(table, field).getType() == QFieldType.DECIMAL) { distinct = representatives.size(); } - result.put(field, new FieldCounts(total - nulls, nulls, string ? count(table, DrillFilters.and(filter, blankFilter)) : nulls, - distinct, blankFilter, DrillFilters.in(primaryKey(table), new ArrayList<>(representatives.values())))); + result.put(field, new FieldCounts(total - nulls, nulls, string ? fieldCount(table, filter, field, AggregateOperator.COUNT_BLANK, aggregates, blankFilter) : nulls, + distinct, blankFilter, estimating ? DrillFilters.nonNull(field, string) : DrillFilters.in(primaryKey(table), new ArrayList<>(representatives.values())))); } } return (result); @@ -233,6 +236,23 @@ public class StandInAnalysisBackend implements AnalysisBackend + /******************************************************************************* + ** Subclasses may extend the existing batch with native null/blank counts. + *******************************************************************************/ + protected void fieldCountAggregates(AggregateInput input, List fields) throws QException + { + // The portable backend counts null and blank predicates separately. + } + + /******************************************************************************* + ** Count the exact drill predicate when native counters are unavailable. + *******************************************************************************/ + protected long fieldCount(String table, QQueryFilter filter, String field, AggregateOperator operator, + List results, QQueryFilter condition) throws QException + { + return (count(table, DrillFilters.and(filter, condition))); + } + /******************************************************************************* ** Push down group, count, ordering and pagination. *******************************************************************************/ @@ -254,6 +274,30 @@ public class StandInAnalysisBackend implements AnalysisBackend + /******************************************************************************* + ** Random backends scale a count using the current aggregate's sample size. + *******************************************************************************/ + protected long aggregateCount(long value) + { + return (value); + } + + /******************************************************************************* + ** Random backends retain the raw sample ratio before rounding counts. + *******************************************************************************/ + protected BigDecimal aggregateShare(long value) + { + return (null); + } + + /******************************************************************************* + ** Exact and prefix groups derive shares from the profiler's row count. + *******************************************************************************/ + protected BigDecimal countShare() + { + return (null); + } + /******************************************************************************* ** Tuple drills use IN for non-null values and null-only predicates otherwise. *******************************************************************************/ @@ -270,7 +314,8 @@ public class StandInAnalysisBackend implements AnalysisBackend Map merged = new LinkedHashMap<>(); for(AggregateResult row : aggregate(input)) { - long size = number(row, primaryKey(table), AggregateOperator.COUNT).longValue(); + long rawSize = number(row, primaryKey(table), AggregateOperator.COUNT).longValue(); + long size = aggregateCount(rawSize); LinkedHashMap tuple = new LinkedHashMap<>(); QQueryFilter condition = new QQueryFilter(); for(String field : fields) @@ -278,7 +323,7 @@ public class StandInAnalysisBackend implements AnalysisBackend Serializable value = row.getGroupByValues().entrySet().stream().filter(e -> field.equals(e.getKey().getFieldName())).findFirst().orElseThrow().getValue(); tuple.put(field, value instanceof BigDecimal d ? new BigDecimal(d.stripTrailingZeros().toPlainString()) : value); condition.withSubFilter(value == null ? DrillFilters.nulls(field, field(table, field).getType().isStringLike()) - : value instanceof BigDecimal ? DrillFilters.in(field, List.of(value.toString())) + : value instanceof BigDecimal && !estimating ? DrillFilters.in(field, List.of(value.toString())) : duplicates ? DrillFilters.in(field, List.of(value)) : DrillFilters.value(field, value, field(table, field).getType().isStringLike())); } Serializable value = duplicates ? tuple : tuple.get(fields.getFirst()); @@ -288,7 +333,7 @@ public class StandInAnalysisBackend implements AnalysisBackend size += previous.count(); condition = new QQueryFilter().withBooleanOperator(QQueryFilter.BooleanOperator.OR).withSubFilter(previous.condition()).withSubFilter(condition); } - merged.put(value, new GroupCount(value, value == null ? "(null)" : value.toString(), size, condition)); + merged.put(value, new GroupCount(value, value == null ? "(null)" : value.toString(), size, condition, aggregateShare(rawSize))); } List groups = new ArrayList<>(merged.values()); if(isMemory(table)) @@ -308,14 +353,8 @@ public class StandInAnalysisBackend implements AnalysisBackend { List values = rows(table, filter, Set.of(field), config.getMaxRows()).stream().map(r -> r.getValue(field)) .filter(Objects::nonNull).map(v -> new BigDecimal(v.toString())).sorted().toList(); - Map metrics = new LinkedHashMap<>(); - AggregateInput input = new AggregateInput(table).withFilter(DrillFilters.copy(filter)); - for(AggregateOperator op : List.of(AggregateOperator.MIN, AggregateOperator.MAX, AggregateOperator.AVG, AggregateOperator.SUM)) - { - input.withAggregate(new Aggregate(field, op)); - } - List results = aggregate(input); - if(values.isEmpty()) + Map metrics = numericMetrics(table, filter, field, percentiles, values); + if(metrics.isEmpty() || metrics.get("min") == null) { for(String key : List.of("min", "max", "mean", "stddev", "sum")) { @@ -325,23 +364,12 @@ public class StandInAnalysisBackend implements AnalysisBackend { metrics.put("p" + p.multiply(BigDecimal.valueOf(100)).stripTrailingZeros().toPlainString(), null); } - QQueryFilter empty = DrillFilters.in(primaryKey(table), List.of()); - return (new NumericSummary(metrics, List.of(), 0, empty, List.of(new GroupCount("zeros", "zeros", 0, empty), new GroupCount("negatives", "negatives", 0, empty)))); + QQueryFilter empty = DrillFilters.condition(primaryKey(table), QCriteriaOperator.IS_BLANK); + return (new NumericSummary(metrics, List.of(), 0, empty, List.of(new GroupCount("zeros", "zeros", 0, estimating ? DrillFilters.condition(field, QCriteriaOperator.EQUALS, BigDecimal.ZERO) : empty), + new GroupCount("negatives", "negatives", 0, estimating ? DrillFilters.range(field, null, BigDecimal.ZERO, false) : empty)))); } - AggregateResult result = results.getFirst(); - metrics.put("min", number(result, field, AggregateOperator.MIN)); - metrics.put("max", number(result, field, AggregateOperator.MAX)); - metrics.put("mean", number(result, field, AggregateOperator.AVG)); - metrics.put("sum", number(result, field, AggregateOperator.SUM)); - BigDecimal mean = values.stream().reduce(BigDecimal.ZERO, BigDecimal::add).divide(BigDecimal.valueOf(values.size()), MATH); - BigDecimal variance = values.stream().map(v -> v.subtract(mean).pow(2)).reduce(BigDecimal.ZERO, BigDecimal::add); - metrics.put("stddev", values.size() < 2 ? null : variance.divide(BigDecimal.valueOf(values.size() - 1), MATH).sqrt(MATH)); - for(BigDecimal p : percentiles) - { - metrics.put("p" + p.multiply(BigDecimal.valueOf(100)).stripTrailingZeros().toPlainString(), percentile(values, p)); - } - BigDecimal q1 = percentile(values, new BigDecimal("0.25")); - BigDecimal q3 = percentile(values, new BigDecimal("0.75")); + BigDecimal q1 = metrics.containsKey("p25") ? metrics.get("p25") : percentile(values, new BigDecimal("0.25")); + BigDecimal q3 = metrics.containsKey("p75") ? metrics.get("p75") : percentile(values, new BigDecimal("0.75")); BigDecimal span = q3.subtract(q1).multiply(new BigDecimal("1.5")); BigDecimal low = q1.subtract(span); BigDecimal high = q3.add(span); @@ -355,10 +383,10 @@ public class StandInAnalysisBackend implements AnalysisBackend List extremeGroups = new ArrayList<>(); for(BigDecimal value : extremes) { - QQueryFilter condition = DrillFilters.in(field, equalNumbers(values, value)); - extremeGroups.add(new GroupCount(value, value.toPlainString(), count(table, DrillFilters.and(filter, condition)), condition)); + QQueryFilter condition = estimating ? DrillFilters.condition(field, QCriteriaOperator.EQUALS, value) : DrillFilters.in(field, equalNumbers(values, value)); + extremeGroups.add(new GroupCount(value, value.toPlainString(), count(table, DrillFilters.and(filter, condition)), condition, countShare())); } - QQueryFilter zeros = DrillFilters.in(field, equalNumbers(values, BigDecimal.ZERO)); + QQueryFilter zeros = estimating ? DrillFilters.condition(field, QCriteriaOperator.EQUALS, BigDecimal.ZERO) : DrillFilters.in(field, equalNumbers(values, BigDecimal.ZERO)); QQueryFilter negatives = numericRange(table, field, values, null, BigDecimal.ZERO, false); return (new NumericSummary(metrics, extremeGroups, count(table, DrillFilters.and(filter, outliers)), outliers, List.of(bucket(table, filter, "zeros", zeros), bucket(table, filter, "negatives", negatives)))); @@ -366,6 +394,39 @@ public class StandInAnalysisBackend implements AnalysisBackend + /******************************************************************************* + ** Portable numeric moments; core-backed subclasses replace supported work. + *******************************************************************************/ + protected Map numericMetrics(String table, QQueryFilter filter, String field, List percentiles, List values) throws QException + { + Map metrics = new LinkedHashMap<>(); + if(values.isEmpty()) + { + return (metrics); + } + AggregateInput input = new AggregateInput(table).withFilter(DrillFilters.copy(filter)); + for(AggregateOperator op : List.of(AggregateOperator.MIN, AggregateOperator.MAX, AggregateOperator.AVG, AggregateOperator.SUM)) + { + input.withAggregate(new Aggregate(field, op)); + } + List results = aggregate(input); + AggregateResult result = results.getFirst(); + metrics.put("min", number(result, field, AggregateOperator.MIN)); + metrics.put("max", number(result, field, AggregateOperator.MAX)); + metrics.put("mean", number(result, field, AggregateOperator.AVG)); + metrics.put("sum", number(result, field, AggregateOperator.SUM)); + BigDecimal mean = values.stream().reduce(BigDecimal.ZERO, BigDecimal::add).divide(BigDecimal.valueOf(values.size()), MATH); + BigDecimal variance = values.stream().map(v -> v.subtract(mean).pow(2)).reduce(BigDecimal.ZERO, BigDecimal::add); + metrics.put("stddev", values.size() < 2 ? null : variance.divide(BigDecimal.valueOf(values.size() - 1), MATH).sqrt(MATH)); + for(BigDecimal p : percentiles) + { + metrics.put("p" + p.multiply(BigDecimal.valueOf(100)).stripTrailingZeros().toPlainString(), percentile(values, p)); + } + return (metrics); + } + + + /******************************************************************************* ** PostgreSQL percentile_cont interpolation at p * (n - 1). *******************************************************************************/ @@ -415,7 +476,7 @@ public class StandInAnalysisBackend implements AnalysisBackend *******************************************************************************/ private GroupCount bucket(String table, QQueryFilter filter, String label, QQueryFilter condition) throws QException { - return (new GroupCount(label, label, count(table, DrillFilters.and(filter, condition)), condition)); + return (new GroupCount(label, label, count(table, DrillFilters.and(filter, condition)), condition, countShare())); } @@ -464,7 +525,7 @@ public class StandInAnalysisBackend implements AnalysisBackend /******************************************************************************* ** ISO weeks begin Monday. *******************************************************************************/ - private static LocalDate floor(LocalDate date, DateUnit unit) + protected static LocalDate floor(LocalDate date, DateUnit unit) { return (switch(unit) { @@ -480,7 +541,7 @@ public class StandInAnalysisBackend implements AnalysisBackend /******************************************************************************* ** Calendar arithmetic handles leap years and daylight savings. *******************************************************************************/ - private static LocalDate next(LocalDate date, DateUnit unit) + protected static LocalDate next(LocalDate date, DateUnit unit) { return (switch(unit) { @@ -506,7 +567,13 @@ public class StandInAnalysisBackend implements AnalysisBackend result.put("max", null); for(AggregateResult row : aggregate(input)) { - row.getAggregateValues().forEach((key, value) -> result.put(key.getOperator().name().toLowerCase(java.util.Locale.ROOT), value)); + row.getAggregateValues().forEach((key, value) -> + { + if(key.getOperator() == AggregateOperator.MIN || key.getOperator() == AggregateOperator.MAX) + { + result.put(key.getOperator().name().toLowerCase(java.util.Locale.ROOT), value); + } + }); } return (result); } @@ -543,7 +610,7 @@ public class StandInAnalysisBackend implements AnalysisBackend List records = rows(table, filter, Set.of(field, primaryKey(table)), sampleRows); QQueryFilter sampled = records.isEmpty() ? DrillFilters.in(primaryKey(table), List.of()) : DrillFilters.condition(primaryKey(table), QCriteriaOperator.LESS_THAN_OR_EQUALS, records.getLast().getValue(primaryKey(table))); - return (mappedGroups(table, DrillFilters.and(filter, sampled), field, records, v -> shape(v.toString()), 10)); + return (mappedGroups(table, estimating ? filter : DrillFilters.and(filter, sampled), field, records, v -> shape(v.toString()), 10)); } @@ -575,8 +642,8 @@ public class StandInAnalysisBackend implements AnalysisBackend List groups = new ArrayList<>(); for(Map.Entry> entry : members.entrySet()) { - QQueryFilter condition = DrillFilters.and(filter, DrillFilters.in(field, new ArrayList<>(entry.getValue()))); - groups.add(new GroupCount(entry.getKey(), entry.getKey().toString(), count(table, condition), condition)); + QQueryFilter condition = DrillFilters.in(field, new ArrayList<>(entry.getValue())); + groups.add(new GroupCount(entry.getKey(), entry.getKey().toString(), count(table, DrillFilters.and(filter, condition)), estimating ? condition : DrillFilters.and(filter, condition), countShare())); } return (groups.stream().sorted(Comparator.comparingLong(GroupCount::count).reversed().thenComparing(GroupCount::label)).limit(limit).toList()); } @@ -597,7 +664,7 @@ public class StandInAnalysisBackend implements AnalysisBackend /******************************************************************************* ** Metadata lookup follows facade security checks. *******************************************************************************/ - private static QFieldMetaData field(String table, String field) + protected static QFieldMetaData field(String table, String field) { return (QContext.getQInstance().getTable(table).getField(field)); } @@ -607,7 +674,7 @@ public class StandInAnalysisBackend implements AnalysisBackend /******************************************************************************* ** Deterministic paging requires an addressable primary key. *******************************************************************************/ - private static String primaryKey(String table) + protected static String primaryKey(String table) { return (QContext.getQInstance().getTable(table).getPrimaryKeyField()); } @@ -618,7 +685,7 @@ public class StandInAnalysisBackend implements AnalysisBackend ** COUNT and COUNT_DISTINCT always read as integers: RC.5's RDBMS reader ** otherwise reads them as the field's type (a boolean count fails). *******************************************************************************/ - private static Aggregate countOf(String field, AggregateOperator op) + protected static Aggregate countOf(String field, AggregateOperator op) { return (new Aggregate(field, op).withFieldType(QFieldType.INTEGER)); } @@ -628,7 +695,7 @@ public class StandInAnalysisBackend implements AnalysisBackend /******************************************************************************* ** The value of one aggregate of a result row (0 when absent). *******************************************************************************/ - private static BigDecimal number(AggregateResult row, String field, AggregateOperator op) + protected static BigDecimal number(AggregateResult row, String field, AggregateOperator op) { Serializable value = row.getAggregateValues().entrySet().stream().filter(e -> field.equals(e.getKey().getFieldName()) && op == e.getKey().getOperator()) .map(Map.Entry::getValue).filter(Objects::nonNull).findFirst().orElse(0); @@ -642,9 +709,9 @@ public class StandInAnalysisBackend implements AnalysisBackend ** Use strict comparison plus actual boundary spellings to preserve half-open ** membership. SQL backends use ordinary range predicates. *******************************************************************************/ - private static QQueryFilter numericRange(String table, String field, List values, BigDecimal low, BigDecimal high, boolean closed) + protected QQueryFilter numericRange(String table, String field, List values, BigDecimal low, BigDecimal high, boolean closed) { - if(!isMemory(table)) + if(estimating || !isMemory(table)) { return (DrillFilters.range(field, low, high, closed)); } @@ -682,7 +749,7 @@ public class StandInAnalysisBackend implements AnalysisBackend /******************************************************************************* ** Isolate compatibility fixes to the RC.5 memory implementation. *******************************************************************************/ - private static boolean isMemory(String table) + protected static boolean isMemory(String table) { return ("memory".equals(QContext.getQInstance().getBackend(QContext.getQInstance().getTable(table).getBackendName()).getBackendType())); } diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/TableProfiler.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/TableProfiler.java index fd55ba8..2560174 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/TableProfiler.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/TableProfiler.java @@ -60,22 +60,23 @@ public class TableProfiler String table = request.getTableName(); QQueryFilter filter = scope.filter(); long rows = backend.count(table, filter); + QQueryFilter drillFilter = scope.estimate() ? request.getFilter() : filter; TableProfile result = new TableProfile().withTableName(table).withFilter(DrillFilters.restoreTypes(request.getTableName(), request.getFilter())).withEstimate(scope.estimate()) - .withSampleRows(scope.estimate() ? rows : 0L).withRowsScanned(scope.rowsScanned()).withTruncated(scope.truncated()).withAsOf(Instant.now()) - .withRowCount(ProfileSupport.count("rows", rows, table, filter, null)); + .withSampleRows(scope.estimate() ? scope.rowsScanned() : 0L).withRowsScanned(scope.rowsScanned()).withTruncated(scope.truncated()).withAsOf(Instant.now()) + .withRowCount(ProfileSupport.count("rows", scope.estimate() ? scope.total() : rows, table, drillFilter, null)); Map counts = backend.fieldCounts(table, filter, fields.stream().map(QFieldMetaData::getName).toList()); for(QFieldMetaData field : fields) { String name = field.getName(); AnalysisBackend.FieldCounts c = counts.get(name); result.getFields().add(new FieldSummary().withField(name).withLabel(field.getLabel()).withType(field.getType().name()) - .withCompleteness(ProfileSupport.share(rows - c.blanks(), rows)).withDistinct(c.distinct()).withUniqueness(ProfileSupport.share(c.distinct(), c.nonNull())) - .withConstant(c.distinct() == 1).withEmpty(c.blanks() == rows) - .withNulls(ProfileSupport.count("nulls", c.nulls(), table, filter, DrillFilters.nulls(name, field.getType().isStringLike()))) - .withBlanks(ProfileSupport.count("blanks", c.blanks(), table, filter, c.blankFilter()))); + .withCompleteness(c.completeness()).withDistinct(c.distinct()).withUniqueness(c.uniqueness()) + .withConstant(c.constant()).withEmpty(c.blanks() == rows) + .withNulls(ProfileSupport.count("nulls", c.nulls(), table, drillFilter, DrillFilters.nulls(name, field.getType().isStringLike()))) + .withBlanks(ProfileSupport.count("blanks", c.blanks(), table, drillFilter, c.blankFilter()))); if(rows > 0 && c.distinct() == rows && c.nulls() == 0) { - result.getCandidateKeys().add(key(table, filter, List.of(name), rows)); + result.getCandidateKeys().add(key(table, drillFilter, List.of(name), rows)); } } List ranked = result.getFields().stream().sorted(Comparator.comparing(FieldSummary::getUniqueness).reversed().thenComparing(FieldSummary::getField)).limit(8).toList(); @@ -86,7 +87,7 @@ public class TableProfiler List pair = List.of(ranked.get(i).getField(), ranked.get(j).getField()); if(rows > 0 && pair.stream().allMatch(f -> counts.get(f).nulls() == 0) && backend.duplicates(table, filter, pair, 1).isEmpty()) { - result.getCandidateKeys().add(key(table, filter, pair, rows)); + result.getCandidateKeys().add(key(table, drillFilter, pair, rows)); } } } @@ -97,7 +98,12 @@ public class TableProfiler { result.getHeatmap().getSeries().getFirst().getPoints().add(new Point().withX(field.getField()).withLabel(field.getLabel()).withY(field.getCompleteness())); } - if(scope.estimate() || scope.truncated()) + if(scope.estimate()) + { + result.getFields().forEach(f -> ProfileSupport.markEstimates(List.of(f.getNulls(), f.getBlanks()))); + result.getWarnings().add(scope.warning()); + } + else if(scope.truncated()) { result.getWarnings().add("Profiles and candidate keys describe only the first " + rows + " rows by primary key."); } diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/permissions/DataAnalysisPermissions.java b/src/main/java/com/kingsrook/qbits/dataanalysis/permissions/DataAnalysisPermissions.java index d3a5c31..5bda962 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/permissions/DataAnalysisPermissions.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/permissions/DataAnalysisPermissions.java @@ -27,12 +27,11 @@ import com.kingsrook.qqq.backend.core.context.QContext; import com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryInput; import com.kingsrook.qqq.backend.core.model.metadata.permissions.QPermissionRules; 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.utils.StringUtils; /******************************************************************************* - ** Data Analysis permissions and the temporary per-table feature check. + ** Data Analysis permissions through the core table feature registry. *******************************************************************************/ public final class DataAnalysisPermissions { @@ -68,9 +67,8 @@ public final class DataAnalysisPermissions *******************************************************************************/ public static boolean canAnalyze(QTableMetaData table) { - QSession session = QContext.getQSession(); boolean read = !Boolean.TRUE.equals(QContext.getQInstance().getEnforcePermissionsInCoreActions()) || PermissionsHelper.hasTablePermission(new QueryInput(table.getName()), table.getName(), TablePermissionSubType.READ); - return (read && session != null && session.hasPermission(analyzePermissionName(table))); + return (read && PermissionsHelper.hasTableFeaturePermission(QContext.getQInstance(), QContext.getQSession(), table, "analyze")); } } diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/result/DuplicatesRequest.java b/src/main/java/com/kingsrook/qbits/dataanalysis/result/DuplicatesRequest.java index c1bae39..d1b0172 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/result/DuplicatesRequest.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/result/DuplicatesRequest.java @@ -36,6 +36,7 @@ public class DuplicatesRequest implements AnalysisRequest private QQueryFilter filter; private Boolean exact = false; private List fields; + private Integer limit = 50; @@ -120,4 +121,21 @@ public class DuplicatesRequest implements AnalysisRequest this.fields = fields; return (this); } + + /******************************************************************************* + ** Maximum duplicate groups requested. + *******************************************************************************/ + public Integer getLimit() + { + return (limit); + } + + /******************************************************************************* + ** Fluent duplicate group limit. + *******************************************************************************/ + public DuplicatesRequest withLimit(Integer limit) + { + this.limit = limit; + return (this); + } } diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/result/Metric.java b/src/main/java/com/kingsrook/qbits/dataanalysis/result/Metric.java index 456f77c..b82fefa 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/result/Metric.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/result/Metric.java @@ -31,6 +31,7 @@ import com.fasterxml.jackson.annotation.JsonAutoDetect; @JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY) public class Metric implements Serializable { + private Boolean estimate = false; private String key; private String label; private Serializable value; @@ -42,6 +43,23 @@ public class Metric implements Serializable + /******************************************************************************* + ** Whether the metric describes a sampled estimate. + *******************************************************************************/ + public Boolean getEstimate() + { + return (estimate); + } + + /******************************************************************************* + ** Mark an estimated metric independently of the exact population row total. + *******************************************************************************/ + public Metric withEstimate(Boolean estimate) + { + this.estimate = estimate; + return (this); + } + /******************************************************************************* ** Getter for key. *******************************************************************************/ diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/run/AnalysisRunService.java b/src/main/java/com/kingsrook/qbits/dataanalysis/run/AnalysisRunService.java index ddecca4..f9abd27 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/run/AnalysisRunService.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/run/AnalysisRunService.java @@ -96,7 +96,7 @@ public class AnalysisRunService AnalysisBackend.Scope scope = backend.scope(request.getTableName(), request.getFilter(), Boolean.TRUE.equals(request.getExact())); if(scope.estimate()) { - return (service.compute(request, backend, scope).withDataVersion(DataVersion.of(backend, request.getTableName(), request.getFilter()))); + return (service.compute(request, backend, scope).withDataVersion(DataVersion.of(service.backend(request.getTableName()), request.getTableName(), request.getFilter()))); } return (exact(request).getColumnProfile()); } @@ -113,7 +113,7 @@ public class AnalysisRunService AnalysisBackend.Scope scope = backend.scope(request.getTableName(), request.getFilter(), Boolean.TRUE.equals(request.getExact())); if(scope.estimate()) { - return (service.compute(request, backend, scope).withDataVersion(DataVersion.of(backend, request.getTableName(), request.getFilter()))); + return (service.compute(request, backend, scope).withDataVersion(DataVersion.of(service.backend(request.getTableName()), request.getTableName(), request.getFilter()))); } return (exact(request).getTableProfile()); } diff --git a/src/main/resources/openapi/qqq-v1/data-analysis.yaml b/src/main/resources/openapi/qqq-v1/data-analysis.yaml new file mode 100644 index 0000000..7f0b3df --- /dev/null +++ b/src/main/resources/openapi/qqq-v1/data-analysis.yaml @@ -0,0 +1,1150 @@ +components: + schemas: + DataAnalysisAxisV1: + nullable: true + properties: + field: + description: "Field." + nullable: true + type: "string" + label: + description: "Label." + nullable: true + type: "string" + valueType: + description: "Value type." + enum: + - "COUNT" + - "DECIMAL" + - "PERCENT" + - "DATE" + - "DATE_TIME" + - "DURATION" + - "TEXT" + nullable: true + type: "string" + type: "object" + DataAnalysisCandidateKeyV1: + nullable: true + properties: + fields: + description: "Readable fields to include; omit for all analyzable fields\ + \ on a table profile." + items: + type: "string" + nullable: true + type: "array" + rowCount: + description: "Row count." + nullable: true + type: "integer" + drill: + $ref: "#/components/schemas/DataAnalysisDrillV1" + description: "Open the matching records using this table and QueryFilter;\ + \ null when suppressed." + nullable: true + type: "object" + DataAnalysisCapabilitiesV1: + nullable: true + properties: + canAnalyze: + description: "Whether this session may analyze the table; false responses\ + \ expose no fields." + nullable: true + type: "boolean" + tableName: + description: "Table name." + nullable: true + type: "string" + tableLabel: + description: "Table label." + nullable: true + type: "string" + fields: + description: "Readable fields to include; omit for all analyzable fields\ + \ on a table profile." + items: + $ref: "#/components/schemas/DataAnalysisCapabilityFieldV1" + nullable: true + type: "array" + limits: + $ref: "#/components/schemas/DataAnalysisLimitsV1" + description: "Limits." + nullable: true + backendCapabilities: + description: "Backend capabilities." + items: + type: "string" + nullable: true + type: "array" + sqlWorkbenchAvailable: + description: "Whether SQL Workbench metadata is installed in this instance." + nullable: true + type: "boolean" + type: "object" + DataAnalysisCapabilityFieldV1: + nullable: true + properties: + name: + description: "Name." + nullable: true + type: "string" + label: + description: "Label." + nullable: true + type: "string" + type: + description: "Type." + nullable: true + type: "string" + kind: + description: "Semantic field kind: NUMERIC, DATE, DATE_TIME, TEXT, BOOLEAN\ + \ or CATEGORY." + nullable: true + type: "string" + defaultChartKind: + description: "Default chart kind." + enum: + - "HISTOGRAM" + - "BOX" + - "BAR" + - "PARETO" + - "TIME_SERIES" + - "SCATTER" + - "HEATMAP" + nullable: true + type: "string" + type: "object" + DataAnalysisChartV1: + nullable: true + properties: + kind: + description: "Semantic field kind: NUMERIC, DATE, DATE_TIME, TEXT, BOOLEAN\ + \ or CATEGORY." + enum: + - "HISTOGRAM" + - "BOX" + - "BAR" + - "PARETO" + - "TIME_SERIES" + - "SCATTER" + - "HEATMAP" + nullable: true + type: "string" + alternatives: + description: "Alternatives." + items: + enum: + - "HISTOGRAM" + - "BOX" + - "BAR" + - "PARETO" + - "TIME_SERIES" + - "SCATTER" + - "HEATMAP" + type: "string" + nullable: true + type: "array" + x: + $ref: "#/components/schemas/DataAnalysisAxisV1" + description: "X." + nullable: true + "y": + $ref: "#/components/schemas/DataAnalysisAxisV1" + description: "Y." + nullable: true + series: + description: "Series." + items: + $ref: "#/components/schemas/DataAnalysisSeriesV1" + nullable: true + type: "array" + annotations: + description: "Annotations." + items: + type: "string" + nullable: true + type: "array" + type: "object" + DataAnalysisColumnProfileRequestV1: + additionalProperties: false + properties: + filter: + $ref: "#/components/schemas/QueryFilter" + description: "Core QueryFilter JSON, identical to the table query and count\ + \ endpoints." + exact: + description: "Request exact computation instead of the configured estimate." + type: "boolean" + fieldName: + description: "Readable field name to profile or enumerate." + type: "string" + required: + - "fieldName" + type: "object" + DataAnalysisColumnProfileV1: + nullable: true + properties: + tableName: + description: "Table name." + nullable: true + type: "string" + filter: + $ref: "#/components/schemas/QueryFilter" + description: "Core QueryFilter JSON, identical to the table query and count\ + \ endpoints." + nullable: true + estimate: + description: "True when statistics describe a sample rather than the entire\ + \ filtered population." + nullable: true + type: "boolean" + sampleRows: + description: "Actual number of rows in the sample, not an extrapolated count." + nullable: true + type: "integer" + truncated: + description: "True when the row limit prevented a complete scan." + nullable: true + type: "boolean" + rowsScanned: + description: "Number of source rows included in computation." + nullable: true + type: "integer" + asOf: + description: "As of." + format: "date-time" + nullable: true + type: "string" + dataVersion: + description: "Data version." + nullable: true + type: "string" + warnings: + description: "Warnings." + items: + type: "string" + nullable: true + type: "array" + fieldName: + description: "Readable field name to profile or enumerate." + nullable: true + type: "string" + fieldLabel: + description: "Field label." + nullable: true + type: "string" + fieldType: + description: "Field type." + nullable: true + type: "string" + counts: + description: "Counts." + items: + $ref: "#/components/schemas/DataAnalysisMetricV1" + nullable: true + type: "array" + numeric: + $ref: "#/components/schemas/DataAnalysisNumericProfileV1" + description: "Numeric." + nullable: true + dates: + $ref: "#/components/schemas/DataAnalysisDateProfileV1" + description: "Dates." + nullable: true + text: + $ref: "#/components/schemas/DataAnalysisTextProfileV1" + description: "Text." + nullable: true + booleans: + description: "Booleans." + items: + $ref: "#/components/schemas/DataAnalysisMetricV1" + nullable: true + type: "array" + topValues: + description: "Top values." + items: + $ref: "#/components/schemas/DataAnalysisValueCountV1" + nullable: true + type: "array" + chart: + $ref: "#/components/schemas/DataAnalysisChartV1" + description: "Chart." + nullable: true + type: "object" + DataAnalysisDateProfileV1: + nullable: true + properties: + metrics: + description: "Metrics." + items: + $ref: "#/components/schemas/DataAnalysisMetricV1" + nullable: true + type: "array" + unit: + description: "Unit." + nullable: true + type: "string" + buckets: + description: "Buckets." + items: + $ref: "#/components/schemas/DataAnalysisValueCountV1" + nullable: true + type: "array" + gaps: + description: "Gaps." + items: + $ref: "#/components/schemas/DataAnalysisValueCountV1" + nullable: true + type: "array" + dayOfWeek: + description: "Day of week." + items: + $ref: "#/components/schemas/DataAnalysisValueCountV1" + nullable: true + type: "array" + hourOfDay: + description: "Hour of day." + items: + $ref: "#/components/schemas/DataAnalysisValueCountV1" + nullable: true + type: "array" + type: "object" + DataAnalysisDistinctValuesPageV1: + nullable: true + properties: + tableName: + description: "Table name." + nullable: true + type: "string" + filter: + $ref: "#/components/schemas/QueryFilter" + description: "Core QueryFilter JSON, identical to the table query and count\ + \ endpoints." + nullable: true + estimate: + description: "True when statistics describe a sample rather than the entire\ + \ filtered population." + nullable: true + type: "boolean" + sampleRows: + description: "Actual number of rows in the sample, not an extrapolated count." + nullable: true + type: "integer" + truncated: + description: "True when the row limit prevented a complete scan." + nullable: true + type: "boolean" + rowsScanned: + description: "Number of source rows included in computation." + nullable: true + type: "integer" + asOf: + description: "As of." + format: "date-time" + nullable: true + type: "string" + dataVersion: + description: "Data version." + nullable: true + type: "string" + warnings: + description: "Warnings." + items: + type: "string" + nullable: true + type: "array" + fieldName: + description: "Readable field name to profile or enumerate." + nullable: true + type: "string" + page: + description: "Zero-based page number." + nullable: true + type: "integer" + pageSize: + description: "Maximum values per page, from 1 to 500." + nullable: true + type: "integer" + hasMore: + description: "Has more." + nullable: true + type: "boolean" + totalDistinct: + description: "Total distinct." + nullable: true + type: "integer" + values: + description: "Values." + items: + $ref: "#/components/schemas/DataAnalysisValueCountV1" + nullable: true + type: "array" + type: "object" + DataAnalysisDistinctValuesRequestV1: + additionalProperties: false + properties: + filter: + $ref: "#/components/schemas/QueryFilter" + description: "Core QueryFilter JSON, identical to the table query and count\ + \ endpoints." + fieldName: + description: "Readable field name to profile or enumerate." + type: "string" + page: + description: "Zero-based page number." + type: "integer" + pageSize: + description: "Maximum values per page, from 1 to 500." + type: "integer" + search: + description: "Optional search text applied to stored values." + type: "string" + required: + - "fieldName" + type: "object" + DataAnalysisDrillV1: + nullable: true + properties: + tableName: + description: "Table name." + nullable: true + type: "string" + filter: + $ref: "#/components/schemas/QueryFilter" + description: "Core QueryFilter JSON, identical to the table query and count\ + \ endpoints." + nullable: true + type: "object" + DataAnalysisDuplicatesRequestV1: + additionalProperties: false + properties: + filter: + $ref: "#/components/schemas/QueryFilter" + description: "Core QueryFilter JSON, identical to the table query and count\ + \ endpoints." + fields: + description: "Readable fields to include; omit for all analyzable fields\ + \ on a table profile." + items: + type: "string" + type: "array" + limit: + description: "Maximum duplicate groups to return, from 1 to 500; default\ + \ 50." + type: "integer" + required: + - "fields" + type: "object" + DataAnalysisDuplicatesResultV1: + nullable: true + properties: + tableName: + description: "Table name." + nullable: true + type: "string" + filter: + $ref: "#/components/schemas/QueryFilter" + description: "Core QueryFilter JSON, identical to the table query and count\ + \ endpoints." + nullable: true + estimate: + description: "True when statistics describe a sample rather than the entire\ + \ filtered population." + nullable: true + type: "boolean" + sampleRows: + description: "Actual number of rows in the sample, not an extrapolated count." + nullable: true + type: "integer" + truncated: + description: "True when the row limit prevented a complete scan." + nullable: true + type: "boolean" + rowsScanned: + description: "Number of source rows included in computation." + nullable: true + type: "integer" + asOf: + description: "As of." + format: "date-time" + nullable: true + type: "string" + dataVersion: + description: "Data version." + nullable: true + type: "string" + warnings: + description: "Warnings." + items: + type: "string" + nullable: true + type: "array" + fields: + description: "Readable fields to include; omit for all analyzable fields\ + \ on a table profile." + items: + type: "string" + nullable: true + type: "array" + groups: + description: "Groups." + items: + $ref: "#/components/schemas/DataAnalysisValueCountV1" + nullable: true + type: "array" + type: "object" + DataAnalysisFieldSummaryV1: + nullable: true + properties: + field: + description: "Field." + nullable: true + type: "string" + label: + description: "Label." + nullable: true + type: "string" + type: + description: "Type." + nullable: true + type: "string" + completeness: + description: "Completeness." + nullable: true + type: "number" + distinct: + description: "Distinct." + nullable: true + type: "integer" + uniqueness: + description: "Uniqueness." + nullable: true + type: "number" + constant: + description: "Constant." + nullable: true + type: "boolean" + empty: + description: "Empty." + nullable: true + type: "boolean" + nulls: + $ref: "#/components/schemas/DataAnalysisMetricV1" + description: "Nulls." + nullable: true + blanks: + $ref: "#/components/schemas/DataAnalysisMetricV1" + description: "Blanks." + nullable: true + type: "object" + DataAnalysisLimitsV1: + nullable: true + properties: + maxRows: + description: "Max rows." + nullable: true + type: "integer" + sampleThresholdRows: + description: "Sample threshold rows." + nullable: true + type: "integer" + sampleRows: + description: "Actual number of rows in the sample, not an extrapolated count." + nullable: true + type: "integer" + minGroupSize: + description: "Min group size." + nullable: true + type: "integer" + type: "object" + DataAnalysisMetricV1: + nullable: true + properties: + key: + description: "Key." + nullable: true + type: "string" + label: + description: "Label." + nullable: true + type: "string" + value: + description: "Value." + nullable: true + oneOf: + - type: "string" + - type: "number" + - type: "boolean" + - nullable: true + type: "object" + valueType: + description: "Value type." + enum: + - "COUNT" + - "DECIMAL" + - "PERCENT" + - "DATE" + - "DATE_TIME" + - "DURATION" + - "TEXT" + nullable: true + type: "string" + estimate: + description: "Whether this metric is estimated; the population rows metric\ + \ remains exact." + type: "boolean" + formatted: + description: "Formatted." + nullable: true + type: "string" + drill: + $ref: "#/components/schemas/DataAnalysisDrillV1" + description: "Open the matching records using this table and QueryFilter;\ + \ null when suppressed." + nullable: true + suppressed: + description: "Suppressed." + nullable: true + type: "boolean" + suppressedReason: + description: "Suppressed reason." + nullable: true + type: "string" + type: "object" + DataAnalysisNumericProfileV1: + nullable: true + properties: + metrics: + description: "Metrics." + items: + $ref: "#/components/schemas/DataAnalysisMetricV1" + nullable: true + type: "array" + histogram: + description: "Histogram." + items: + $ref: "#/components/schemas/DataAnalysisValueCountV1" + nullable: true + type: "array" + outliers: + description: "Outliers." + items: + $ref: "#/components/schemas/DataAnalysisValueCountV1" + nullable: true + type: "array" + type: "object" + DataAnalysisPointV1: + nullable: true + properties: + x: + description: "X." + nullable: true + oneOf: + - type: "string" + - type: "number" + - type: "boolean" + - nullable: true + type: "object" + "y": + description: "Y." + nullable: true + type: "number" + label: + description: "Label." + nullable: true + type: "string" + drill: + $ref: "#/components/schemas/DataAnalysisDrillV1" + description: "Open the matching records using this table and QueryFilter;\ + \ null when suppressed." + nullable: true + type: "object" + DataAnalysisRunStartedV1: + nullable: true + properties: + runId: + description: "Run id." + nullable: true + type: "string" + status: + description: "Status." + nullable: true + type: "string" + type: "object" + DataAnalysisRunStatusV1: + nullable: true + properties: + runId: + description: "Run id." + nullable: true + type: "string" + status: + description: "Status." + nullable: true + type: "string" + error: + description: "Error." + nullable: true + type: "string" + columnProfile: + $ref: "#/components/schemas/DataAnalysisColumnProfileV1" + description: "Completed column result; null for other operations or unfinished\ + \ runs." + nullable: true + tableProfile: + $ref: "#/components/schemas/DataAnalysisTableProfileV1" + description: "Completed table result; null for other operations or unfinished\ + \ runs." + nullable: true + startedAt: + description: "Started at." + format: "date-time" + nullable: true + type: "string" + finishedAt: + description: "Finished at." + format: "date-time" + nullable: true + type: "string" + type: "object" + DataAnalysisSeriesV1: + nullable: true + properties: + name: + description: "Name." + nullable: true + type: "string" + points: + description: "Points." + items: + $ref: "#/components/schemas/DataAnalysisPointV1" + nullable: true + type: "array" + type: "object" + DataAnalysisStartRunRequestV1: + additionalProperties: false + properties: + operation: + description: "COLUMN_PROFILE or TABLE_PROFILE." + enum: + - "COLUMN_PROFILE" + - "TABLE_PROFILE" + type: "string" + tableName: + description: "Table name." + type: "string" + request: + description: "Profile parameters for the selected operation, without tableName." + oneOf: + - $ref: "#/components/schemas/DataAnalysisColumnProfileRequestV1" + - $ref: "#/components/schemas/DataAnalysisTableProfileRequestV1" + required: + - "operation" + - "tableName" + - "request" + type: "object" + DataAnalysisTableProfileRequestV1: + additionalProperties: false + properties: + filter: + $ref: "#/components/schemas/QueryFilter" + description: "Core QueryFilter JSON, identical to the table query and count\ + \ endpoints." + fields: + description: "Readable fields to include; omit for all analyzable fields\ + \ on a table profile." + items: + type: "string" + type: "array" + type: "object" + DataAnalysisTableProfileV1: + nullable: true + properties: + tableName: + description: "Table name." + nullable: true + type: "string" + filter: + $ref: "#/components/schemas/QueryFilter" + description: "Core QueryFilter JSON, identical to the table query and count\ + \ endpoints." + nullable: true + estimate: + description: "True when statistics describe a sample rather than the entire\ + \ filtered population." + nullable: true + type: "boolean" + sampleRows: + description: "Actual number of rows in the sample, not an extrapolated count." + nullable: true + type: "integer" + truncated: + description: "True when the row limit prevented a complete scan." + nullable: true + type: "boolean" + rowsScanned: + description: "Number of source rows included in computation." + nullable: true + type: "integer" + asOf: + description: "As of." + format: "date-time" + nullable: true + type: "string" + dataVersion: + description: "Data version." + nullable: true + type: "string" + warnings: + description: "Warnings." + items: + type: "string" + nullable: true + type: "array" + rowCount: + $ref: "#/components/schemas/DataAnalysisMetricV1" + description: "Row count." + nullable: true + fields: + description: "Readable fields to include; omit for all analyzable fields\ + \ on a table profile." + items: + $ref: "#/components/schemas/DataAnalysisFieldSummaryV1" + nullable: true + type: "array" + heatmap: + $ref: "#/components/schemas/DataAnalysisChartV1" + description: "Heatmap." + nullable: true + candidateKeys: + description: "Candidate keys." + items: + $ref: "#/components/schemas/DataAnalysisCandidateKeyV1" + nullable: true + type: "array" + type: "object" + DataAnalysisTextProfileV1: + nullable: true + properties: + metrics: + description: "Metrics." + items: + $ref: "#/components/schemas/DataAnalysisMetricV1" + nullable: true + type: "array" + histogram: + description: "Histogram." + items: + $ref: "#/components/schemas/DataAnalysisValueCountV1" + nullable: true + type: "array" + patterns: + description: "Patterns." + items: + $ref: "#/components/schemas/DataAnalysisValueCountV1" + nullable: true + type: "array" + sampleRows: + description: "Actual number of rows in the sample, not an extrapolated count." + nullable: true + type: "integer" + type: "object" + DataAnalysisValueCountV1: + nullable: true + properties: + value: + description: "Value." + nullable: true + oneOf: + - type: "string" + - type: "number" + - type: "boolean" + - nullable: true + type: "object" + label: + description: "Label." + nullable: true + type: "string" + count: + description: "Count." + nullable: true + type: "integer" + share: + description: "Share." + nullable: true + type: "number" + drill: + $ref: "#/components/schemas/DataAnalysisDrillV1" + description: "Open the matching records using this table and QueryFilter;\ + \ null when suppressed." + nullable: true + type: "object" + FilterCriteria: + properties: + fieldName: + description: "Field name that this criteria applies to" + type: "string" + operator: + description: "Logical operator that applies to this criteria" + enum: + - "EQUALS" + - "NOT_EQUALS" + - "NOT_EQUALS_OR_IS_NULL" + - "IN" + - "NOT_IN" + - "IS_NULL_OR_IN" + - "LIKE" + - "NOT_LIKE" + - "STARTS_WITH" + - "ENDS_WITH" + - "CONTAINS" + - "NOT_STARTS_WITH" + - "NOT_ENDS_WITH" + - "NOT_CONTAINS" + - "LESS_THAN" + - "LESS_THAN_OR_EQUALS" + - "GREATER_THAN" + - "GREATER_THAN_OR_EQUALS" + - "IS_BLANK" + - "IS_NOT_BLANK" + - "BETWEEN" + - "NOT_BETWEEN" + - "TRUE" + - "FALSE" + type: "string" + values: + description: "Values to apply via the operator to the field" + items: + type: "string" + type: "array" + type: "object" + OrderBy: + properties: + fieldName: + description: "Field name that this order-by applies to" + type: "string" + isAscending: + description: "Whether this order-by is ascending or descending" + type: "boolean" + type: "object" + QueryFilter: + properties: + booleanOperator: + description: "Boolean operator to apply between criteria" + enum: + - "AND" + - "OR" + type: "string" + criteria: + description: "Field level criteria that make up the query filter" + items: + $ref: "#/components/schemas/FilterCriteria" + type: "array" + limit: + description: "Maximum number of results to return." + type: "number" + orderBys: + description: "How the query's results should be ordered (sorted)." + items: + $ref: "#/components/schemas/OrderBy" + type: "array" + skip: + description: "Records to skip (e.g., to implement pagination)" + type: "number" + type: "object" + securitySchemes: + sessionUuidCookie: + in: "cookie" + name: "sessionUUID" + type: "apiKey" +info: + contact: + email: "contact@kingsrook.com" + description: "Profiles, distinct values, duplicate groups and exact analysis runs\ + \ as the signed-in user." + title: "QQQ Middleware API extension: data-analysis" + version: "1.0.0" +openapi: "3.0.3" +paths: + /qqq/v1/qbit/data-analysis/tables/{table}/capabilities: + get: + description: "Discover whether the current user can analyze this table, readable\ + \ fields, chart defaults, limits and backend capabilities." + parameters: + - description: "QQQ table name to analyze." + in: "path" + name: "table" + required: true + schema: + type: "string" + responses: + 200: + content: + application/json: + schema: + $ref: "#/components/schemas/DataAnalysisCapabilitiesV1" + description: "Successful Response" + security: + - sessionUuidCookie: + - "N/A" + summary: "Check analysis availability" + /qqq/v1/qbit/data-analysis/tables/{table}/column-profile: + post: + description: "Profile one column of a table under a filter: counts, nulls, distinct\ + \ values, top values, numeric statistics and histogram, date patterns; every\ + \ number has a drill-through filter unless privacy suppresses it." + parameters: + - description: "QQQ table name to analyze." + in: "path" + name: "table" + required: true + schema: + type: "string" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataAnalysisColumnProfileRequestV1" + required: true + responses: + 200: + content: + application/json: + schema: + $ref: "#/components/schemas/DataAnalysisColumnProfileV1" + description: "Successful Response" + security: + - sessionUuidCookie: + - "N/A" + summary: "Profile one column" + /qqq/v1/qbit/data-analysis/tables/{table}/distinct-values: + post: + description: "Page through distinct stored values with display labels, counts\ + \ and drill-through filters; search narrows stored values." + parameters: + - description: "QQQ table name to analyze." + in: "path" + name: "table" + required: true + schema: + type: "string" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataAnalysisDistinctValuesRequestV1" + required: true + responses: + 200: + content: + application/json: + schema: + $ref: "#/components/schemas/DataAnalysisDistinctValuesPageV1" + description: "Successful Response" + security: + - sessionUuidCookie: + - "N/A" + summary: "List distinct column values" + /qqq/v1/qbit/data-analysis/tables/{table}/table-profile: + post: + description: "Profile readable fields under a filter for completeness, uniqueness,\ + \ constant or empty columns and candidate keys." + parameters: + - description: "QQQ table name to analyze." + in: "path" + name: "table" + required: true + schema: + type: "string" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataAnalysisTableProfileRequestV1" + required: true + responses: + 200: + content: + application/json: + schema: + $ref: "#/components/schemas/DataAnalysisTableProfileV1" + description: "Successful Response" + security: + - sessionUuidCookie: + - "N/A" + summary: "Profile table completeness and keys" + /qqq/v1/qbit/data-analysis/tables/{table}/duplicates: + post: + description: "Group matching records by the selected readable fields and return\ + \ repeated tuples with counts and drill-through filters." + parameters: + - description: "QQQ table name to analyze." + in: "path" + name: "table" + required: true + schema: + type: "string" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataAnalysisDuplicatesRequestV1" + required: true + responses: + 200: + content: + application/json: + schema: + $ref: "#/components/schemas/DataAnalysisDuplicatesResultV1" + description: "Successful Response" + security: + - sessionUuidCookie: + - "N/A" + summary: "Find duplicate groups" + /qqq/v1/qbit/data-analysis/runs: + post: + description: "Start an owner-scoped exact column or table profile. Poll the\ + \ returned runId until COMPLETE or FAILED; results honor the current session\ + \ permissions." + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataAnalysisStartRunRequestV1" + required: true + responses: + 200: + content: + application/json: + schema: + $ref: "#/components/schemas/DataAnalysisRunStartedV1" + description: "Successful Response" + security: + - sessionUuidCookie: + - "N/A" + summary: "Start an exact profile run" + /qqq/v1/qbit/data-analysis/runs/{runId}: + get: + description: "Read status, timestamps and the typed columnProfile or tableProfile\ + \ result of an owner-scoped run. Completed results are rechecked against current\ + \ permissions." + parameters: + - description: "Owner-scoped analysis run id." + in: "path" + name: "runId" + required: true + schema: + type: "string" + responses: + 200: + content: + application/json: + schema: + $ref: "#/components/schemas/DataAnalysisRunStatusV1" + description: "Successful Response" + security: + - sessionUuidCookie: + - "N/A" + summary: "Get an exact profile run" diff --git a/src/test/java/com/kingsrook/qbits/dataanalysis/CoreAnalysisBackendTest.java b/src/test/java/com/kingsrook/qbits/dataanalysis/CoreAnalysisBackendTest.java new file mode 100644 index 0000000..324d20e --- /dev/null +++ b/src/test/java/com/kingsrook/qbits/dataanalysis/CoreAnalysisBackendTest.java @@ -0,0 +1,204 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis; + +import java.util.Set; +import com.kingsrook.qbits.dataanalysis.engine.CoreAnalysisBackend; +import com.kingsrook.qbits.dataanalysis.engine.StandInAnalysisBackend; +import com.kingsrook.qbits.dataanalysis.result.ColumnProfileRequest; +import com.kingsrook.qqq.backend.core.actions.interfaces.AggregateInterface; +import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.AggregateCapability; +import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.AggregateInput; +import com.kingsrook.qqq.backend.core.modules.backend.QBackendModuleDispatcher; +import com.kingsrook.qqq.backend.core.modules.backend.implementations.memory.MemoryBackendModule; +import com.kingsrook.qqq.backend.core.modules.backend.implementations.memory.MemoryAggregateAction; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.Test; +import static org.assertj.core.api.Assertions.assertThat; + +/******************************************************************************* + ** Native sample membership and capability-directed fallback behavior. + *******************************************************************************/ +class CoreAnalysisBackendTest extends EngineFixture +{ + /******************************************************************************* + ** Restore the global dispatcher after a capability-specific fixture. + *******************************************************************************/ + @AfterEach + void restoreModule() + { + QBackendModuleDispatcher.registerBackendModule(new MemoryBackendModule()); + } + + /******************************************************************************* + ** Deterministic memory sampling scales every-k-th counts to the population. + *******************************************************************************/ + @Test + void sampledPopulation() throws Exception + { + config.withDefaultSampleThresholdRows(5).withDefaultSampleRows(4); + assertThat(service.backend("orders")).isInstanceOf(CoreAnalysisBackend.class); + var profile = service.columnProfile(new ColumnProfileRequest().withTableName("orders").withFieldName("amount")); + assertThat(profile.getEstimate()).isTrue(); + assertThat(profile.getSampleRows()).isEqualTo(4); + assertThat(profile.getNumeric().getMetrics().stream().filter(m -> m.getKey().equals("sum")).findFirst().orElseThrow().getValue().toString()).isEqualTo("1030"); + var counts = profile.getCounts().stream().collect(java.util.stream.Collectors.toMap(m -> m.getKey(), m -> m)); + assertThat(counts.get("rows").getValue()).isEqualTo(12L); + assertThat(counts.get("rows").getEstimate()).isFalse(); + assertThat(counts.get("nonNull").getValue()).isEqualTo(Math.round(4.0 * 12 / 4)); + assertThat(profile.getTopValues()).allSatisfy(v -> + { + assertThat(v.getCount()).isEqualTo(Math.round(1.0 * 12 / 4)); + assertThat(v.getShare()).isEqualByComparingTo("0.25"); + }); + assertThat(com.kingsrook.qqq.backend.core.utils.JsonUtils.toJson(profile)).doesNotContain("\"operator\":\"IN\""); + new MemoryEngineTest().assertDrills(profile); + config.withDefaultMaxRows(0); + service.getConfigResolver().invalidate(); + var empty = service.columnProfile(new ColumnProfileRequest().withTableName("orders").withFieldName("amount")); + assertThat(empty.getEstimate()).isTrue(); + assertThat(empty.getSampleRows()).isEqualTo(4); + assertThat(empty.getTruncated()).isFalse(); + } + + /******************************************************************************* + ** Rounding counts must not alter raw shares, and drills retain the user filter. + *******************************************************************************/ + @Test + void filteredSampleRatios() throws Exception + { + config.withDefaultSampleThresholdRows(2).withDefaultSampleRows(4); + var filter = com.kingsrook.qbits.dataanalysis.engine.DrillFilters.condition("id", + com.kingsrook.qqq.backend.core.model.actions.tables.query.QCriteriaOperator.GREATER_THAN, 1); + var profile = service.columnProfile(new ColumnProfileRequest().withTableName("orders").withFieldName("amount").withFilter(filter)); + // The filtered ids 2..12, sampled every third row, yield 2, 5, 8, 11. + var sampledAmounts = java.util.Arrays.asList(0, 20, 40, null); + long nonNull = sampledAmounts.stream().filter(java.util.Objects::nonNull).count(); + var counts = profile.getCounts().stream().collect(java.util.stream.Collectors.toMap(m -> m.getKey(), m -> m)); + assertThat(profile.getSampleRows()).isEqualTo(sampledAmounts.size()); + assertThat(counts.get("rows").getValue()).isEqualTo(11L); + assertThat(counts.get("nonNull").getValue()).isEqualTo(Math.round(nonNull * 11.0 / sampledAmounts.size())); + assertThat(counts.get("nulls").getValue()).isEqualTo(Math.round((sampledAmounts.size() - nonNull) * 11.0 / sampledAmounts.size())); + assertThat(profile.getTopValues()).hasSize(4).allSatisfy(v -> + { + assertThat(v.getCount()).isEqualTo(Math.round(11.0 / sampledAmounts.size())); + assertThat(v.getShare()).isEqualByComparingTo("0.25"); + }); + var exact = new StandInAnalysisBackend(service.getConfigResolver().resolve("orders")); + assertThat(exact.count("orders", counts.get("rows").getDrill().getFilter())).isEqualTo(11); + assertThat(exact.count("orders", counts.get("nonNull").getDrill().getFilter())).isEqualTo(10); + var twenty = profile.getTopValues().stream().filter(v -> v.getValue() != null && v.getValue().toString().equals("20")).findFirst().orElseThrow(); + assertThat(exact.count("orders", twenty.getDrill().getFilter())).isEqualTo(2); + } + + /******************************************************************************* + ** Zero and capped percentages never divide by zero or restrict the row drill. + *******************************************************************************/ + @Test + void samplingBoundaries() throws Exception + { + config.withDefaultSampleThresholdRows(2).withDefaultSampleRows(0); + var empty = service.columnProfile(new ColumnProfileRequest().withTableName("orders").withFieldName("amount")); + assertThat(empty.getSampleRows()).isZero(); + assertThat(empty.getCounts().getFirst().getValue()).isEqualTo(12L); + assertThat(empty.getCounts().get(1).getValue()).isEqualTo(0L); + config.withDefaultSampleRows(100); + service.getConfigResolver().invalidate(); + var scope = service.backend("orders").scope("orders", null, false); + assertThat(scope.samplePercent()).isEqualByComparingTo("100"); + assertThat(scope.rowsScanned()).isEqualTo(12); + } + + /******************************************************************************* + ** A non-random estimate has one boundary bind and population-wide drills. + *******************************************************************************/ + @Test + void prefixBoundary() throws Exception + { + capabilities(Set.of()); + config.withDefaultSampleThresholdRows(2).withDefaultSampleRows(4); + var filter = com.kingsrook.qbits.dataanalysis.engine.DrillFilters.condition("id", + com.kingsrook.qqq.backend.core.model.actions.tables.query.QCriteriaOperator.GREATER_THAN, 2); + var backend = service.backend("orders"); + var scope = backend.scope("orders", filter, false); + assertThat(scope.filter().getSubFilters().get(1).getCriteria()).singleElement().satisfies(c -> + { + assertThat(c.getFieldName()).isEqualTo("id"); + assertThat(c.getOperator()).isEqualTo(com.kingsrook.qqq.backend.core.model.actions.tables.query.QCriteriaOperator.LESS_THAN_OR_EQUALS); + assertThat(c.getValues()).containsExactly(6); + }); + var profile = service.columnProfile(new ColumnProfileRequest().withTableName("orders").withFieldName("quantity").withFilter(filter)); + assertThat(profile.getCounts().getFirst().getValue()).isEqualTo(10L); + assertThat(profile.getCounts().stream().filter(m -> m.getKey().equals("nonNull")).findFirst().orElseThrow().getValue()).isEqualTo(4L); + assertThat(profile.getWarnings()).contains("Estimate from the first 4 rows by id"); + var drill = profile.getCounts().getFirst().getDrill(); + assertThat(new StandInAnalysisBackend(service.getConfigResolver().resolve("orders")).count("orders", drill.getFilter())).isEqualTo(10); + assertThat(com.kingsrook.qqq.backend.core.utils.JsonUtils.toJson(profile)).doesNotContain("\"operator\":\"IN\""); + } + + /******************************************************************************* + ** Empty capabilities select the stand-in; partial support uses core plus fallback. + *******************************************************************************/ + @Test + void fallbackSelection() throws Exception + { + capabilities(Set.of()); + assertThat(service.backend("orders")).isExactlyInstanceOf(StandInAnalysisBackend.class); + capabilities(Set.of(AggregateCapability.STDDEV)); + assertThat(service.backend("orders")).isInstanceOf(CoreAnalysisBackend.class); + var profile = service.columnProfile(new ColumnProfileRequest().withTableName("orders").withFieldName("amount")); + assertThat(profile.getNumeric().getMetrics().stream().filter(m -> m.getKey().equals("p50")).findFirst().orElseThrow().getValue().toString()).isEqualTo("20.0"); + new MemoryEngineTest().assertDrills(profile); + } + + /******************************************************************************* + ** Advertise selected capabilities while retaining the fixture's actual actions. + *******************************************************************************/ + private void capabilities(Set supported) + { + LimitedMemoryBackend.supported = supported; + QBackendModuleDispatcher.registerBackendModule(new LimitedMemoryBackend()); + } + + /******************************************************************************* + ** Public no-argument backend class required by the module dispatcher. + *******************************************************************************/ + public static class LimitedMemoryBackend extends MemoryBackendModule + { + private static Set supported = Set.of(); + + /******************************************************************************* + ** Retain real memory execution with a deliberately reduced feature set. + *******************************************************************************/ + @Override + public AggregateInterface getAggregateInterface() + { + return (new MemoryAggregateAction() + { + @Override + public Set getSupportedCapabilities(AggregateInput input) + { + return (supported); + } + }); + } + } +} diff --git a/src/test/java/com/kingsrook/qbits/dataanalysis/DataAnalysisApiTest.java b/src/test/java/com/kingsrook/qbits/dataanalysis/DataAnalysisApiTest.java new file mode 100644 index 0000000..1c6d144 --- /dev/null +++ b/src/test/java/com/kingsrook/qbits/dataanalysis/DataAnalysisApiTest.java @@ -0,0 +1,290 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis; + +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.List; +import java.util.Map; +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.kingsrook.qbits.dataanalysis.api.DataAnalysisApi; +import com.kingsrook.qqq.backend.core.instances.AbstractQQQApplication; +import com.kingsrook.qqq.backend.core.model.metadata.QInstance; +import com.kingsrook.qqq.backend.core.model.metadata.authentication.QAuthenticationMetaData; +import com.kingsrook.qqq.backend.core.model.metadata.QAuthenticationType; +import com.kingsrook.qqq.backend.core.model.metadata.code.QCodeReference; +import com.kingsrook.qqq.backend.core.model.session.QSession; +import com.kingsrook.qqq.backend.core.modules.authentication.QAuthenticationModuleCustomizerInterface; +import com.kingsrook.qqq.middleware.javalin.QApplicationJavalinServer; +import com.kingsrook.qqq.middleware.javalin.QJavalinImplementation; +import com.kingsrook.qqq.middleware.javalin.specs.invoke.UiApiInvoker; +import com.kingsrook.qqq.middleware.javalin.specs.invoke.UiApiRequest; +import com.kingsrook.qqq.middleware.javalin.specs.v1.MiddlewareVersionV1; +import com.kingsrook.qqq.middleware.javalin.tools.UiApiContract; +import com.kingsrook.qqq.openapi.model.HttpMethod; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.Test; +import static org.assertj.core.api.Assertions.assertThat; + +/******************************************************************************* + ** Real HTTP session, schema and drill round-trip acceptance tests. + *******************************************************************************/ +class DataAnalysisApiTest extends EngineFixture +{ + private QApplicationJavalinServer server; + private UiApiInvoker invoker; + private String caller = "analysis-user"; + + /******************************************************************************* + ** Give MOCK sessions only the grants represented by their caller cookie. + *******************************************************************************/ + public static class Sessions implements QAuthenticationModuleCustomizerInterface + { + /******************************************************************************* + ** Build the host's ordinary user permission and record-lock policy. + *******************************************************************************/ + @Override + public void customizeSession(QInstance instance, QSession session, Map context) + { + QSession grants = TestSupport.admin().withPermissions("orders.read", "customer.read").withSecurityKeyValue("orders.all", true); + session.setPermissions(grants.getPermissions()); + session.setSecurityKeyValues(grants.getSecurityKeyValues()); + if(!"denied".equals(session.getUuid())) + { + session.withPermission("orders.analyze"); + } + session.withSecurityKeyValue("data_analysis_user", session.getUser().getIdReference()); + } + } + + /******************************************************************************* + ** Start on an OS-selected port using the actual spec router and authentication. + *******************************************************************************/ + private void start() throws Exception + { + instance.withInstanceDefaultAuthentication(new QAuthenticationMetaData().withName("http-test").withType(QAuthenticationType.MOCK) + .withCustomizer(new QCodeReference(Sessions.class))); + QInstance fixture = instance; + server = new QApplicationJavalinServer(new AbstractQQQApplication() + { + @Override + public QInstance defineQInstance() + { + return (fixture); + } + }).withPort(0).withServeFrontendNext(false).withServeFrontendMaterialDashboard(false) + .withServeLegacyUnversionedMiddlewareAPI(false).withStrictUiApiRoutes(true); + server.start(); + invoker = UiApiInvoker.forServer(server); + } + + /******************************************************************************* + ** Stop the server before the fixture releases context. + *******************************************************************************/ + @AfterEach + void stop() + { + if(server != null) + { + server.stop(); + } + QJavalinImplementation.setSessionCookieHttpOnly(false); + } + + /******************************************************************************* + ** Invoke through loopback, forwarding the actual session cookie. + *******************************************************************************/ + private JsonNode call(HttpMethod method, String path, Object body, int status) throws Exception + { + var request = new UiApiRequest().withMethod(method).withPath(DataAnalysisApi.PREFIX + path) + .withPathParam("table", "orders").withSessionUUID(caller).withUserTimezone("America/Chicago"); + if(body != null) + { + request.withJsonBody(body); + } + var response = invoker.invoke(request); + assertThat(response.getStatus()).as(response.getBody()).isEqualTo(status); + return (response.getJson()); + } + + /******************************************************************************* + ** All operations, assistant discovery, OpenAPI and count-drill equivalence. + *******************************************************************************/ + @Test + void happyPathsAndDrills() throws Exception + { + start(); + JsonNode capabilities = call(HttpMethod.GET, "/tables/{table}/capabilities", null, 200); + assertThat(capabilities.path("canAnalyze").asBoolean()).isTrue(); + assertThat(capabilities.path("backendCapabilities").toString()).contains("NUMERIC_BUCKET"); + assertThat(capabilities.path("fields").toString()).doesNotContain("secret").contains("CATEGORY", "HISTOGRAM"); + for(String field : List.of("amount", "note", "created", "order_date", "paid", "status")) + { + checkDrills(call(HttpMethod.POST, "/tables/{table}/column-profile", Map.of("fieldName", field), 200)); + } + checkDrills(call(HttpMethod.POST, "/tables/{table}/column-profile", Map.of("fieldName", "amount", "filter", + Map.of("criteria", List.of(Map.of("fieldName", "created", "operator", "EQUALS", "values", List.of("2026-01-01T12:00:00Z"))))), 200)); + checkDrills(call(HttpMethod.POST, "/tables/{table}/distinct-values", Map.of("fieldName", "status", "pageSize", 1), 200)); + checkDrills(call(HttpMethod.POST, "/tables/{table}/table-profile", Map.of("fields", List.of("amount", "note")), 200)); + checkDrills(call(HttpMethod.POST, "/tables/{table}/duplicates", Map.of("fields", List.of("quantity"), "limit", 2), 200)); + for(String operation : List.of("COLUMN_PROFILE", "TABLE_PROFILE")) + { + JsonNode started = call(HttpMethod.POST, "/runs", Map.of("operation", operation, "tableName", "orders", "request", + operation.equals("COLUMN_PROFILE") ? Map.of("fieldName", "quantity") : Map.of("fields", List.of("paid"))), 200); + JsonNode run = null; + for(int i = 0; i < 100; i++) + { + var response = invoker.invoke(new UiApiRequest().withMethod(HttpMethod.GET).withPath(DataAnalysisApi.PREFIX + "/runs/{runId}") + .withPathParam("runId", started.path("runId").asText()).withSessionUUID(caller).withUserTimezone("America/Chicago")); + assertThat(response.getStatus()).as(response.getBody()).isEqualTo(200); + run = response.getJson(); + if(!run.path("status").asText().equals("RUNNING")) + { + break; + } + Thread.sleep(20); + } + assertThat(run.path("status").asText()).isEqualTo("COMPLETE"); + var denied = invoker.invoke(new UiApiRequest().withMethod(HttpMethod.GET).withPath(DataAnalysisApi.PREFIX + "/runs/{runId}") + .withPathParam("runId", started.path("runId").asText()).withSessionUUID("another-owner")); + assertThat(denied.getStatus()).isEqualTo(403); + assertThat(run.path(operation.equals("COLUMN_PROFILE") ? "columnProfile" : "tableProfile").isObject()).isTrue(); + } + assertThat(invoker.listOperations().stream().filter(o -> o.pathTemplate().startsWith(DataAnalysisApi.PREFIX)).toList()).hasSize(7); + var client = java.net.http.HttpClient.newHttpClient(); + var response = client.send(java.net.http.HttpRequest.newBuilder(java.net.URI.create("http://127.0.0.1:" + server.getBoundPort() + "/qqq/v1/openapi.json")).build(), java.net.http.HttpResponse.BodyHandlers.ofString()); + assertThat(response.statusCode()).isEqualTo(200); + JsonNode api = new ObjectMapper().readTree(response.body()); + assertThat(api.path("paths").has("/qqq/v1/qbit/data-analysis/tables/{table}/column-profile")).isTrue(); + assertThat(api.path("components").path("schemas").has("DataAnalysisMetricV1")).isTrue(); + } + + /******************************************************************************* + ** Estimate payloads preserve exact totals and send drills to all matching rows. + *******************************************************************************/ + @Test + void estimateDrills() throws Exception + { + config.withDefaultSampleThresholdRows(2).withDefaultSampleRows(4); + instance.withSupplementalMetaData(new DataAnalysisRuntime(config)); + start(); + JsonNode profile = call(HttpMethod.POST, "/tables/{table}/column-profile", Map.of("fieldName", "amount"), 200); + assertThat(profile.path("estimate").asBoolean()).isTrue(); + assertThat(profile.path("sampleRows").asLong()).isEqualTo(4); + JsonNode rows = profile.path("counts").get(0); + assertThat(rows.path("value").asLong()).isEqualTo(12); + assertThat(rows.path("estimate").asBoolean()).isFalse(); + assertThat(profile.path("counts").get(1).path("formatted").asText()).startsWith("≈ "); + assertThat(profile.toString()).doesNotContain("\"operator\":\"IN\""); + var response = invoker.invoke(new UiApiRequest().withMethod(HttpMethod.POST).withPath("/table/{tableName}/count") + .withPathParam("tableName", "orders").withJsonBody(Map.of("filter", rows.path("drill").path("filter"))) + .withSessionUUID(caller).withUserTimezone("America/Chicago")); + assertThat(response.getStatus()).isEqualTo(200); + assertThat(response.getJson().path("count").asLong()).isEqualTo(12); + checkDrills(profile); + JsonNode table = call(HttpMethod.POST, "/tables/{table}/table-profile", Map.of("fields", List.of("amount", "quantity")), 200); + assertThat(table.path("estimate").asBoolean()).isTrue(); + assertThat(table.path("rowCount").path("value").asLong()).isEqualTo(12); + checkDrills(table); + } + + /******************************************************************************* + ** Recursively post returned count drills to the core count endpoint. + *******************************************************************************/ + private void checkDrills(JsonNode node) throws Exception + { + if(node.path("estimate").asBoolean(false)) + { + return; + } + if(node.isObject() && node.hasNonNull("drill")) + { + JsonNode expected = node.has("count") ? node.get("count") : node.has("y") ? node.get("y") : "COUNT".equals(node.path("valueType").asText()) ? node.get("value") : null; + if(expected != null && expected.isNumber()) + { + JsonNode drill = node.get("drill"); + var response = invoker.invoke(new UiApiRequest().withMethod(HttpMethod.POST).withPath("/table/{tableName}/count") + .withPathParam("tableName", drill.path("tableName").asText()).withJsonBody(Map.of("filter", drill.get("filter"))).withSessionUUID(caller).withUserTimezone("America/Chicago")); + assertThat(response.getStatus()).as(response.getBody()).isEqualTo(200); + assertThat(response.getJson().path("count").asLong()).as(drill.toString()).isEqualTo(expected.asLong()); + } + } + if(node.isContainerNode()) + { + for(JsonNode child : node) + { + checkDrills(child); + } + } + } + + /******************************************************************************* + ** Denials, locked fields, missing tables and malformed request bodies. + *******************************************************************************/ + @Test + void errors() throws Exception + { + start(); + call(HttpMethod.POST, "/tables/{table}/column-profile", Map.of("fieldName", "secret"), 400); + call(HttpMethod.POST, "/tables/{table}/column-profile", Map.of("fieldName", "missing"), 400); + call(HttpMethod.POST, "/tables/{table}/column-profile", Map.of(), 400); + call(HttpMethod.POST, "/tables/{table}/column-profile", Map.of("fieldName", 1), 400); + call(HttpMethod.POST, "/tables/{table}/column-profile", Map.of("fieldName", "amount", "exact", "yes"), 400); + call(HttpMethod.POST, "/tables/{table}/distinct-values", Map.of("fieldName", "note", "pageSize", 0), 400); + call(HttpMethod.POST, "/tables/{table}/duplicates", Map.of("fields", List.of()), 400); + call(HttpMethod.POST, "/tables/{table}/table-profile", Map.of("fields", "amount"), 400); + call(HttpMethod.POST, "/runs", Map.of("operation", "PIVOT"), 400); + call(HttpMethod.POST, "/runs", com.fasterxml.jackson.databind.node.NullNode.getInstance(), 400); + call(HttpMethod.POST, "/tables/{table}/column-profile", Map.of("fieldName", "amount", "filter", + Map.of("criteria", List.of(Map.of("fieldName", "secret", "operator", "EQUALS", "values", List.of("hidden"))))), 400); + var absent = invoker.invoke(new UiApiRequest().withMethod(HttpMethod.GET).withPath(DataAnalysisApi.PREFIX + "/tables/{table}/capabilities") + .withPathParam("table", "missing").withSessionUUID(caller).withUserTimezone("America/Chicago")); + assertThat(absent.getStatus()).isEqualTo(404); + caller = "denied"; + assertThat(call(HttpMethod.GET, "/tables/{table}/capabilities", null, 200).path("canAnalyze").asBoolean()).isFalse(); + call(HttpMethod.POST, "/tables/{table}/column-profile", Map.of("fieldName", "amount"), 403); + call(HttpMethod.POST, "/tables/{table}/distinct-values", Map.of("fieldName", "amount"), 403); + call(HttpMethod.POST, "/tables/{table}/table-profile", Map.of(), 403); + call(HttpMethod.POST, "/tables/{table}/duplicates", Map.of("fields", List.of("amount")), 403); + call(HttpMethod.POST, "/runs", Map.of("operation", "COLUMN_PROFILE", "tableName", "orders", "request", Map.of("fieldName", "amount")), 403); + } + + /******************************************************************************* + ** Generated fragment is committed verbatim and has only the seven operations. + *******************************************************************************/ + @Test + void contract() throws Exception + { + MiddlewareVersionV1 version = new MiddlewareVersionV1(); + version.setQInstance(instance); + String yaml = UiApiContract.generateExtensionYaml(version, DataAnalysisApi.extension()); + Path path = Path.of("src/main/resources/openapi/qqq-v1/data-analysis.yaml"); + if(Boolean.getBoolean("openapi.write")) + { + Files.createDirectories(path.getParent()); + Files.writeString(path, yaml); + } + assertThat(Files.exists(path)).as("Regenerate with ./mvnw -o test -Dtest=DataAnalysisApiTest#contract -Dopenapi.write=true -Dqqq.snapshot.version=4.1.0-DATAANALYSIS-SNAPSHOT").isTrue(); + assertThat(Files.readString(path).replace("\r\n", "\n")).as("OpenAPI changed: regenerate with -Dopenapi.write=true").isEqualTo(yaml.replace("\r\n", "\n")); + } +} + diff --git a/src/test/java/com/kingsrook/qbits/dataanalysis/DataAnalysisSecurityTest.java b/src/test/java/com/kingsrook/qbits/dataanalysis/DataAnalysisSecurityTest.java index 84ded3a..57013c9 100644 --- a/src/test/java/com/kingsrook/qbits/dataanalysis/DataAnalysisSecurityTest.java +++ b/src/test/java/com/kingsrook/qbits/dataanalysis/DataAnalysisSecurityTest.java @@ -91,7 +91,7 @@ class DataAnalysisSecurityTest instance.withEnforcePermissionsInCoreActions(false); assertThat(DataAnalysisPermissions.canAnalyze(table)).isFalse(); QContext.init(instance, TestSupport.user("alice").withPermission("sales.orders.analyze")); - assertThat(DataAnalysisPermissions.canAnalyze(table)).isTrue(); + assertThat(DataAnalysisPermissions.canAnalyze(table)).isFalse(); table.withPermissionRules(null); instance.withDefaultPermissionRules(new QPermissionRules().withLevel(PermissionLevel.READ_INSERT_EDIT_DELETE_PERMISSIONS).withPermissionBaseName("defaultBase")); assertThat(DataAnalysisPermissions.analyzePermissionName(table)).isEqualTo("defaultBase.analyze"); @@ -101,6 +101,29 @@ class DataAnalysisSecurityTest + /******************************************************************************* + ** The core permission catalog honors configured inclusion and exclusion. + *******************************************************************************/ + @Test + void analyzeCatalog() throws Exception + { + QInstance instance = new QInstance().withEnforcePermissionsInCoreActions(true); + instance.addBackend(new com.kingsrook.qqq.backend.core.model.metadata.QBackendMetaData().withName("memory").withBackendType(com.kingsrook.qqq.backend.core.modules.backend.implementations.memory.MemoryBackendModule.class)); + for(String name : List.of("orders", "excluded", "outside")) + { + instance.addTable(new QTableMetaData().withName(name).withLabel(name).withPermissionRules( + new QPermissionRules().withLevel(PermissionLevel.READ_INSERT_EDIT_DELETE_PERMISSIONS))); + } + new DataAnalysisQBitProducer().withQBitConfig(new DataAnalysisQBitConfig().withBackendName("memory") + .withIncludeTables(java.util.Set.of("orders", "excluded")).withExcludeTables(java.util.Set.of("excluded"))).produce(instance); + assertThat(com.kingsrook.qqq.backend.core.actions.permissions.PermissionsHelper.getAllAvailablePermissions(instance)).anySatisfy(permission -> + { + assertThat(permission.getName()).isEqualTo("orders.analyze"); + assertThat(permission.getPermissionType()).isEqualTo("Analyze"); + }).noneMatch(permission -> permission.getName().equals("excluded.analyze") || permission.getName().equals("outside.analyze") + || permission.getName().startsWith("data_analysis") && permission.getName().endsWith(".analyze")); + } + /******************************************************************************* ** Saved, star and run locks hide others even when the shared flag is true. *******************************************************************************/ diff --git a/src/test/java/com/kingsrook/qbits/dataanalysis/EngineContractTest.java b/src/test/java/com/kingsrook/qbits/dataanalysis/EngineContractTest.java index a2421cf..c5343e5 100644 --- a/src/test/java/com/kingsrook/qbits/dataanalysis/EngineContractTest.java +++ b/src/test/java/com/kingsrook/qbits/dataanalysis/EngineContractTest.java @@ -279,12 +279,26 @@ abstract class EngineContractTest extends EngineFixture void estimatesRunsAndCache() throws Exception { config.withDefaultSampleThresholdRows(5).withDefaultSampleRows(4); - service = new DataAnalysisService(config); + service = newService(config, java.util.concurrent.ForkJoinPool.commonPool()); ColumnProfile estimate = service.columnProfile(column("amount")); assertThat(estimate.getEstimate()).isTrue(); - assertThat(estimate.getSampleRows()).isEqualTo(4); - assertMetric(estimate.getCounts(), "rows", "4"); - assertMetric(estimate.getNumeric().getMetrics(), "sum", "10"); + assertMetric(estimate.getCounts(), "rows", "12"); + assertThat(metric(estimate.getCounts(), "rows").getEstimate()).isFalse(); + assertThat(metric(estimate.getCounts(), "nonNull").getEstimate()).isTrue(); + assertThat(metric(estimate.getCounts(), "nonNull").getFormatted()).startsWith("≈ "); + assertDrills(estimate); + assertThat(count(metric(estimate.getCounts(), "rows").getDrill())).isEqualTo(12); + if(service.backend("orders") instanceof com.kingsrook.qbits.dataanalysis.engine.CoreAnalysisBackend) + { + assertThat(estimate.getWarnings()).anyMatch(w -> w.contains("random sample") && w.contains("scaled to the full 12 rows")); + } + else + { + assertThat(estimate.getSampleRows()).isEqualTo(4); + assertMetric(estimate.getCounts(), "nonNull", "4"); + assertMetric(estimate.getNumeric().getMetrics(), "sum", "10"); + assertThat(estimate.getWarnings()).contains("Estimate from the first 4 rows by id"); + } String id = service.startExactRun(column("amount")); RunStatus run = awaitRun(id); assertThat(run.getStatus()).isEqualTo("COMPLETE"); @@ -444,6 +458,10 @@ abstract class EngineContractTest extends EngineFixture *******************************************************************************/ private void walk(JsonNode node) throws Exception { + if(node.path("estimate").asBoolean(false)) + { + return; + } if(node.isObject()) { if(node.hasNonNull("drill")) @@ -551,7 +569,7 @@ abstract class EngineContractTest extends EngineFixture int previous = runs().size(); service.columnProfile(column("amount")); assertThat(runs()).hasSize(previous + 1); - service = new DataAnalysisService(config, task -> + service = newService(config, task -> { throw new java.util.concurrent.RejectedExecutionException("test"); }); @@ -632,7 +650,7 @@ abstract class EngineContractTest extends EngineFixture void executionFailureAndGuardedBooleans() throws Exception { List jobs = new java.util.ArrayList<>(); - service = new DataAnalysisService(config, jobs::add); + service = newService(config, jobs::add); String id = service.startExactRun(column("amount")); var table = instance.getTables().remove("orders"); jobs.getFirst().run(); @@ -641,7 +659,7 @@ abstract class EngineContractTest extends EngineFixture assertThat(service.getRun(id).getError()).contains("could not be completed"); assertThat(runs().getFirst().getValue("result_json")).isNull(); config.withDefaultMinGroupSize(3); - service = new DataAnalysisService(config, Runnable::run); + service = newService(config, Runnable::run); var paid = service.columnProfile(column("paid")); assertThat(paid.getBooleans()).anySatisfy(m -> { diff --git a/src/test/java/com/kingsrook/qbits/dataanalysis/EngineFixture.java b/src/test/java/com/kingsrook/qbits/dataanalysis/EngineFixture.java index cb3a382..8642f4f 100644 --- a/src/test/java/com/kingsrook/qbits/dataanalysis/EngineFixture.java +++ b/src/test/java/com/kingsrook/qbits/dataanalysis/EngineFixture.java @@ -118,7 +118,15 @@ abstract class EngineFixture .withValue("note", notes[i]).withValue("paid", i == 11 ? null : i % 2 == 0).withValue("modifyDate", Instant.parse("2026-10-13T12:00:00Z"))); } config = new DataAnalysisQBitConfig().withBackendName("memory"); - service = new DataAnalysisService(config, Runnable::run); + service = newService(config, Runnable::run); + } + + /******************************************************************************* + ** Allow the identical contract to exercise both primitive implementations. + *******************************************************************************/ + protected DataAnalysisService newService(DataAnalysisQBitConfig configuration, java.util.concurrent.Executor executor) + { + return (new DataAnalysisService(configuration, executor)); } /******************************************************************************* diff --git a/src/test/java/com/kingsrook/qbits/dataanalysis/H2CompatibilityEngineTest.java b/src/test/java/com/kingsrook/qbits/dataanalysis/H2CompatibilityEngineTest.java new file mode 100644 index 0000000..afedf5b --- /dev/null +++ b/src/test/java/com/kingsrook/qbits/dataanalysis/H2CompatibilityEngineTest.java @@ -0,0 +1,39 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis; + +import com.kingsrook.qqq.backend.module.rdbms.model.metadata.RDBMSBackendMetaData; + +/******************************************************************************* + ** Verify native bucket SQL in H2's ordinal-grouping compatibility mode. + *******************************************************************************/ +class H2CompatibilityEngineTest extends H2EngineTest +{ + /******************************************************************************* + ** H2 supports core's GROUP BY positions in PostgreSQL compatibility mode. + *******************************************************************************/ + @Override + protected RDBMSBackendMetaData database() + { + RDBMSBackendMetaData database = super.database(); + return (database.withJdbcUrl(database.getJdbcUrl() + ";MODE=PostgreSQL")); + } +} diff --git a/src/test/java/com/kingsrook/qbits/dataanalysis/H2SamplingTest.java b/src/test/java/com/kingsrook/qbits/dataanalysis/H2SamplingTest.java new file mode 100644 index 0000000..2570efe --- /dev/null +++ b/src/test/java/com/kingsrook/qbits/dataanalysis/H2SamplingTest.java @@ -0,0 +1,82 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis; + +import java.util.List; +import com.kingsrook.qbits.dataanalysis.engine.DrillFilters; +import com.kingsrook.qbits.dataanalysis.engine.StandInAnalysisBackend; +import com.kingsrook.qbits.dataanalysis.result.ColumnProfileRequest; +import com.kingsrook.qqq.backend.core.model.actions.tables.query.QCriteriaOperator; +import com.kingsrook.qqq.backend.module.rdbms.model.metadata.RDBMSBackendMetaData; +import org.junit.jupiter.api.Test; +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.within; + +/******************************************************************************* + ** RAND samples fluctuate around population counts without changing drill scope. + *******************************************************************************/ +class H2SamplingTest extends EngineFixture +{ + /******************************************************************************* + ** Ordinal grouping is supported by H2's PostgreSQL compatibility mode. + *******************************************************************************/ + @Override + protected RDBMSBackendMetaData database() + { + return (new RDBMSBackendMetaData().withVendor("h2").withUsername("sa").withPassword("") + .withJdbcUrl("jdbc:h2:mem:sampling_" + java.util.UUID.randomUUID() + ";DB_CLOSE_DELAY=-1;DATABASE_TO_UPPER=FALSE;MODE=PostgreSQL")); + } + + /******************************************************************************* + ** A large sample gives stable tolerances and includes filtered-out records. + *******************************************************************************/ + @Test + void randomCountsAndHistograms() throws Exception + { + try(var statement = connection.createStatement()) + { + statement.execute("INSERT INTO orders (id, customer, amount) SELECT x, 1, CASE WHEN MOD(x, 4) = 0 THEN NULL ELSE MOD(x, 10) END FROM SYSTEM_RANGE(1001, 11000) AS source(x)"); + } + config.withDefaultSampleThresholdRows(100).withDefaultSampleRows(2000); + service.getConfigResolver().invalidate(); + var filter = DrillFilters.condition("id", QCriteriaOperator.GREATER_THAN, 1000); + var profile = service.columnProfile(new ColumnProfileRequest().withTableName("orders").withFieldName("amount").withFilter(filter)); + assertThat(profile.getEstimate()).isTrue(); + var metrics = profile.getCounts().stream().collect(java.util.stream.Collectors.toMap(m -> m.getKey(), m -> m)); + assertThat(metrics.get("rows").getValue()).isEqualTo(10000L); + assertThat(metrics.get("rows").getEstimate()).isFalse(); + assertThat(((Number) metrics.get("nulls").getValue()).longValue()).isCloseTo(2500L, within(500L)); + assertThat(((Number) metrics.get("nonNull").getValue()).longValue()).isCloseTo(7500L, within(500L)); + assertThat(metrics.get("nonNull").getFormatted()).startsWith("≈ "); + assertThat(profile.getNumeric().getHistogram().stream().mapToLong(v -> v.getCount()).sum()).isCloseTo(7500L, within(700L)); + var exact = new StandInAnalysisBackend(service.getConfigResolver().resolve("orders")); + assertThat(exact.count("orders", metrics.get("rows").getDrill().getFilter())).isEqualTo(10000); + for(var value : profile.getTopValues()) + { + long population = exact.count("orders", value.getDrill().getFilter()); + assertThat(value.getCount()).isCloseTo(population, within(500L)); + } + assertThat(com.kingsrook.qqq.backend.core.utils.JsonUtils.toJson(profile)).doesNotContain("\"operator\":\"IN\""); + var table = service.tableProfile(new com.kingsrook.qbits.dataanalysis.result.TableProfileRequest().withTableName("orders").withFilter(filter).withFields(List.of("amount"))); + assertThat(table.getRowCount().getValue()).isEqualTo(10000L); + assertThat(table.getEstimate()).isTrue(); + } +} diff --git a/src/test/java/com/kingsrook/qbits/dataanalysis/H2StreamedEngineTest.java b/src/test/java/com/kingsrook/qbits/dataanalysis/H2StreamedEngineTest.java new file mode 100644 index 0000000..ecc0423 --- /dev/null +++ b/src/test/java/com/kingsrook/qbits/dataanalysis/H2StreamedEngineTest.java @@ -0,0 +1,48 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis; + +import java.util.concurrent.Executor; +import com.kingsrook.qbits.dataanalysis.engine.AnalysisBackend; +import com.kingsrook.qbits.dataanalysis.engine.StandInAnalysisBackend; +import com.kingsrook.qqq.backend.core.exceptions.QException; + +/******************************************************************************* + ** Run every engine contract assertion with the portable streamed implementation. + *******************************************************************************/ +class H2StreamedEngineTest extends H2EngineTest +{ + /******************************************************************************* + ** Change only the backend under test, preserving the entire shared contract. + *******************************************************************************/ + @Override + protected DataAnalysisService newService(DataAnalysisQBitConfig configuration, Executor executor) + { + return (new DataAnalysisService(configuration, executor) + { + @Override + public AnalysisBackend backend(String table) throws QException + { + return (new StandInAnalysisBackend(getConfigResolver().resolve(table))); + } + }); + } +} diff --git a/src/test/java/com/kingsrook/qbits/dataanalysis/OptionalMiddlewareTest.java b/src/test/java/com/kingsrook/qbits/dataanalysis/OptionalMiddlewareTest.java new file mode 100644 index 0000000..94bb62e --- /dev/null +++ b/src/test/java/com/kingsrook/qbits/dataanalysis/OptionalMiddlewareTest.java @@ -0,0 +1,77 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis; + +import java.nio.file.Path; +import java.util.Arrays; +import java.util.concurrent.TimeUnit; +import java.util.stream.Collectors; +import org.junit.jupiter.api.Test; +import static org.assertj.core.api.Assertions.assertThat; + +/******************************************************************************* + ** A separate JVM proves the optional middleware is not needed by the engine. + *******************************************************************************/ +class OptionalMiddlewareTest +{ + /******************************************************************************* + ** Remove Javalin and middleware artifacts from the actual test classpath. + *******************************************************************************/ + @Test + void engineWithoutMiddleware() throws Exception + { + String classpath = Arrays.stream(System.getProperty("surefire.test.class.path", System.getProperty("java.class.path")).split(java.io.File.pathSeparator)) + .filter(entry -> !entry.contains("qqq-middleware-javalin") && !Path.of(entry).getFileName().toString().startsWith("javalin-")) + .collect(Collectors.joining(java.io.File.pathSeparator)); + Path log = Path.of("target", "core-only-smoke.log"); + Process process = new ProcessBuilder(Path.of(System.getProperty("java.home"), "bin", "java").toString(), "-cp", classpath, CoreOnlySmoke.class.getName()) + .redirectErrorStream(true).redirectOutput(log.toFile()).start(); + try + { + assertThat(process.waitFor(30, TimeUnit.SECONDS)).as("Core-only JVM timed out").isTrue(); + assertThat(process.exitValue()).as(java.nio.file.Files.readString(log)).isZero(); + } + finally + { + if(process.isAlive()) + { + process.destroyForcibly(); + } + } + } + + /******************************************************************************* + ** Entry point in the classpath with middleware removed. + *******************************************************************************/ + public static class CoreOnlySmoke + { + /******************************************************************************* + ** Metadata and runtime must initialize without loading any API classes. + *******************************************************************************/ + public static void main(String[] args) throws Exception + { + var instance = TestSupport.instance(); + assertThat(instance.getSupplementalMetaData("dataAnalysisRuntime")).isNotNull(); + assertThat(instance.getSupplementalMetaData("middlewareSpecExtensions")).isNull(); + assertThat(instance.getTable("data_analysis_run")).isNotNull(); + } + } +} diff --git a/src/test/java/com/kingsrook/qbits/dataanalysis/PostgresEngineTest.java b/src/test/java/com/kingsrook/qbits/dataanalysis/PostgresEngineTest.java index 9a23267..42121cd 100644 --- a/src/test/java/com/kingsrook/qbits/dataanalysis/PostgresEngineTest.java +++ b/src/test/java/com/kingsrook/qbits/dataanalysis/PostgresEngineTest.java @@ -60,6 +60,29 @@ class PostgresEngineTest extends EngineContractTest } } + /******************************************************************************* + ** Large populations never become one bind per sampled primary key. + *******************************************************************************/ + @org.junit.jupiter.api.Test + void largeEstimate() throws Exception + { + try(var statement = connection.createStatement()) + { + statement.execute("TRUNCATE TABLE orders"); + statement.execute("INSERT INTO orders (id, customer, paid) SELECT id, 1, id % 2 = 0 FROM generate_series(1, 50000) AS id"); + } + config.withDefaultSampleThresholdRows(100).withDefaultSampleRows(1000); + service.getConfigResolver().invalidate(); + var profile = service.columnProfile(new com.kingsrook.qbits.dataanalysis.result.ColumnProfileRequest().withTableName("orders").withFieldName("paid")); + org.assertj.core.api.Assertions.assertThat(profile.getEstimate()).isTrue(); + assertMetric(profile.getCounts(), "rows", "50000"); + org.assertj.core.api.Assertions.assertThat(com.kingsrook.qqq.backend.core.utils.JsonUtils.toJson(profile)).doesNotContain("\"operator\":\"IN\""); + // Also exceed the old parameter ceiling with the requested sample itself. + config.withDefaultSampleRows(40000); + service.getConfigResolver().invalidate(); + assertMetric(service.columnProfile(new com.kingsrook.qbits.dataanalysis.result.ColumnProfileRequest().withTableName("orders").withFieldName("paid")).getCounts(), "rows", "50000"); + } + /******************************************************************************* ** Credentials belong only to the ephemeral test container. *******************************************************************************/ -- 2.54.0 From c90d6c98664de13a0d42e3fce33218dfe979e69b Mon Sep 17 00:00:00 2001 From: James Maes Date: Tue, 13 Oct 2026 17:44:00 -0500 Subject: [PATCH 2/5] chore: drop the agent handoff note Co-Authored-By: Claude Opus 5.5 --- docs/TODO.md | 7 ------- 1 file changed, 7 deletions(-) delete mode 100644 docs/TODO.md diff --git a/docs/TODO.md b/docs/TODO.md deleted file mode 100644 index e718b61..0000000 --- a/docs/TODO.md +++ /dev/null @@ -1,7 +0,0 @@ -# Phase b part 2 remaining work - -- Run the 21 PostgreSQL contract tests with accessible Docker, including the 50,000-row estimate regression at sample sizes 1,000 and 40,000. -- Review the existing endpoint work's core READ and H2 ordinal-grouping compatibility choices; this sampling task preserves them. -- Append the durable project/daily handoff in [SESSION-STATE.md](SESSION-STATE.md) to Second Brain from a workspace with vault write access. - -Completed: replace sampled-key IN scopes, scale native estimate counts, preserve raw ratios and full-population drills, update the OpenAPI contract and tests, and pass the requested offline Maven verification. -- 2.54.0 From d8b52113caed47ca5af6977ce0863b5004178fde Mon Sep 17 00:00:00 2001 From: James Maes Date: Tue, 13 Oct 2026 18:26:45 -0500 Subject: [PATCH 3/5] feat(results): human labels, formatted values, nice bins, date labels, current home Every metric carries a plain-English label and a display-formatted value (grouping, percent, the field's display format), histogram bins use nice edges with formatted labels, date buckets are labelled by unit, warnings appear only when true, and the Analyses home shows saved analyses, watches and recent runs with honest empty states (and no mojibake). Co-Authored-By: Claude Opus 5.5 --- .../dataanalysis/api/DataAnalysisSchemas.java | 24 +- .../dataanalysis/app/DataAnalysisHome.java | 87 +++++-- .../dataanalysis/engine/AnalysisBackend.java | 13 +- .../engine/AnalysisFormatting.java | 225 ++++++++++++++++++ .../dataanalysis/engine/ColumnProfiler.java | 30 ++- .../engine/CoreAnalysisBackend.java | 20 +- .../dataanalysis/engine/MetricLabels.java | 65 +++++ .../engine/MinGroupSizeGuard.java | 4 +- .../qbits/dataanalysis/engine/NiceBins.java | 62 +++++ .../dataanalysis/engine/ProfileSupport.java | 11 +- .../engine/StandInAnalysisBackend.java | 46 +++- .../dataanalysis/engine/TableProfiler.java | 2 +- .../openapi/qqq-v1/data-analysis.yaml | 15 +- .../dataanalysis/AnalysisFormattingTest.java | 158 ++++++++++++ .../dataanalysis/CoreAnalysisBackendTest.java | 5 +- .../dataanalysis/DataAnalysisHomeTest.java | 45 +++- .../dataanalysis/EngineContractTest.java | 63 ++++- .../qbits/dataanalysis/EngineFixture.java | 3 +- .../PresentationSamplingTest.java | 115 +++++++++ 19 files changed, 901 insertions(+), 92 deletions(-) create mode 100644 src/main/java/com/kingsrook/qbits/dataanalysis/engine/AnalysisFormatting.java create mode 100644 src/main/java/com/kingsrook/qbits/dataanalysis/engine/MetricLabels.java create mode 100644 src/main/java/com/kingsrook/qbits/dataanalysis/engine/NiceBins.java create mode 100644 src/test/java/com/kingsrook/qbits/dataanalysis/AnalysisFormattingTest.java create mode 100644 src/test/java/com/kingsrook/qbits/dataanalysis/PresentationSamplingTest.java diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/api/DataAnalysisSchemas.java b/src/main/java/com/kingsrook/qbits/dataanalysis/api/DataAnalysisSchemas.java index 794dbd5..151c72e 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/api/DataAnalysisSchemas.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/api/DataAnalysisSchemas.java @@ -603,13 +603,13 @@ public class DataAnalysisSchemas @OpenAPIDescription("Type.") public String type; - @OpenAPIDescription("Completeness.") + @OpenAPIDescription("Non-empty share as a 0..1 ratio rounded to six decimals.") public BigDecimal completeness; @OpenAPIDescription("Distinct.") public Long distinct; - @OpenAPIDescription("Uniqueness.") + @OpenAPIDescription("Distinct share as a 0..1 ratio rounded to six decimals.") public BigDecimal uniqueness; @OpenAPIDescription("Constant.") @@ -634,9 +634,9 @@ public class DataAnalysisSchemas properties.put("field", new Schema().withType(Type.STRING).withDescription("Field.").withNullable(true)); properties.put("label", new Schema().withType(Type.STRING).withDescription("Label.").withNullable(true)); properties.put("type", new Schema().withType(Type.STRING).withDescription("Type.").withNullable(true)); - properties.put("completeness", new Schema().withType(Type.NUMBER).withDescription("Completeness.").withNullable(true)); + properties.put("completeness", new Schema().withType(Type.NUMBER).withDescription("Non-empty share as a 0..1 ratio rounded to six decimals.").withNullable(true)); properties.put("distinct", new Schema().withType(Type.INTEGER).withDescription("Distinct.").withNullable(true)); - properties.put("uniqueness", new Schema().withType(Type.NUMBER).withDescription("Uniqueness.").withNullable(true)); + properties.put("uniqueness", new Schema().withType(Type.NUMBER).withDescription("Distinct share as a 0..1 ratio rounded to six decimals.").withNullable(true)); properties.put("constant", new Schema().withType(Type.BOOLEAN).withDescription("Constant.").withNullable(true)); properties.put("empty", new Schema().withType(Type.BOOLEAN).withDescription("Empty.").withNullable(true)); properties.put("nulls", ref("DataAnalysisMetricV1").withDescription("Nulls.").withNullable(true)); @@ -654,16 +654,16 @@ public class DataAnalysisSchemas public Boolean estimate; public String key; - @OpenAPIDescription("Label.") + @OpenAPIDescription("Plain-English metric label, ready to display.") public String label; - @OpenAPIDescription("Value.") + @OpenAPIDescription("Raw numeric or temporal value. PERCENT is a 0..1 ratio rounded to six decimals; DECIMAL field statistics have ten significant digits. DATE_TIME is an ISO instant.") public Serializable value; @OpenAPIDescription("Value type.") public ValueType valueType; - @OpenAPIDescription("Formatted.") + @OpenAPIDescription("Display-ready value, including grouping, field display formats, percent signs and session-zone dates; null when absent or suppressed.") public String formatted; @OpenAPIDescription("Open the matching records using this table and QueryFilter; null when suppressed.") @@ -683,11 +683,11 @@ public class DataAnalysisSchemas { Map properties = new LinkedHashMap<>(); properties.put("key", new Schema().withType(Type.STRING).withDescription("Key.").withNullable(true)); - properties.put("label", new Schema().withType(Type.STRING).withDescription("Label.").withNullable(true)); - properties.put("value", new Schema().withOneOf(List.of(new Schema().withType(Type.STRING), new Schema().withType(Type.NUMBER), new Schema().withType(Type.BOOLEAN), new Schema().withType(Type.OBJECT).withNullable(true))).withDescription("Value.").withNullable(true)); + properties.put("label", new Schema().withType(Type.STRING).withDescription("Plain-English metric label, ready to display.").withNullable(true)); + properties.put("value", new Schema().withOneOf(List.of(new Schema().withType(Type.STRING), new Schema().withType(Type.NUMBER), new Schema().withType(Type.BOOLEAN), new Schema().withType(Type.OBJECT).withNullable(true))).withDescription("Raw numeric or temporal value. PERCENT is a 0..1 ratio rounded to six decimals; DECIMAL field statistics have ten significant digits. DATE_TIME is an ISO instant.").withNullable(true)); properties.put("valueType", new Schema().withType(Type.STRING).withEnumValues(java.util.Arrays.stream(ValueType.values()).map(Enum::name).toList()).withDescription("Value type.").withNullable(true)); properties.put("estimate", new Schema().withType(Type.BOOLEAN).withDescription("Whether this metric is estimated; the population rows metric remains exact.")); - properties.put("formatted", new Schema().withType(Type.STRING).withDescription("Formatted.").withNullable(true)); + properties.put("formatted", new Schema().withType(Type.STRING).withDescription("Display-ready value, including grouping, field display formats, percent signs and session-zone dates; null when absent or suppressed.").withNullable(true)); properties.put("drill", ref("DataAnalysisDrillV1").withDescription("Open the matching records using this table and QueryFilter; null when suppressed.").withNullable(true)); properties.put("suppressed", new Schema().withType(Type.BOOLEAN).withDescription("Suppressed.").withNullable(true)); properties.put("suppressedReason", new Schema().withType(Type.STRING).withDescription("Suppressed reason.").withNullable(true)); @@ -961,7 +961,7 @@ public class DataAnalysisSchemas @OpenAPIDescription("Count.") public Long count; - @OpenAPIDescription("Share.") + @OpenAPIDescription("Share as a 0..1 ratio rounded to six decimals.") public BigDecimal share; @OpenAPIDescription("Open the matching records using this table and QueryFilter; null when suppressed.") @@ -977,7 +977,7 @@ public class DataAnalysisSchemas properties.put("value", new Schema().withOneOf(List.of(new Schema().withType(Type.STRING), new Schema().withType(Type.NUMBER), new Schema().withType(Type.BOOLEAN), new Schema().withType(Type.OBJECT).withNullable(true))).withDescription("Value.").withNullable(true)); properties.put("label", new Schema().withType(Type.STRING).withDescription("Label.").withNullable(true)); properties.put("count", new Schema().withType(Type.INTEGER).withDescription("Count.").withNullable(true)); - properties.put("share", new Schema().withType(Type.NUMBER).withDescription("Share.").withNullable(true)); + properties.put("share", new Schema().withType(Type.NUMBER).withDescription("Share as a 0..1 ratio rounded to six decimals.").withNullable(true)); properties.put("drill", ref("DataAnalysisDrillV1").withDescription("Open the matching records using this table and QueryFilter; null when suppressed.").withNullable(true)); return (new Schema().withType(Type.OBJECT).withNullable(true).withProperties(properties)); } diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/app/DataAnalysisHome.java b/src/main/java/com/kingsrook/qbits/dataanalysis/app/DataAnalysisHome.java index b8d0bb8..fa345a9 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/app/DataAnalysisHome.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/app/DataAnalysisHome.java @@ -22,26 +22,33 @@ package com.kingsrook.qbits.dataanalysis.app; import java.time.Instant; -import java.time.temporal.ChronoUnit; +import java.util.Arrays; import java.util.List; +import java.util.Locale; +import java.util.stream.Collectors; import com.kingsrook.qbits.dataanalysis.DataAnalysisQBitConfig; +import com.kingsrook.qbits.dataanalysis.engine.AnalysisFormatting; import com.kingsrook.qbits.dataanalysis.model.DataAnalysisTables; import com.kingsrook.qqq.backend.core.actions.dashboard.widgets.AbstractWidgetRenderer; import com.kingsrook.qqq.backend.core.actions.permissions.PermissionEnforcement; import com.kingsrook.qqq.backend.core.actions.permissions.PermissionsHelper; import com.kingsrook.qqq.backend.core.actions.permissions.TablePermissionSubType; import com.kingsrook.qqq.backend.core.actions.tables.CountAction; +import com.kingsrook.qqq.backend.core.actions.tables.QueryAction; import com.kingsrook.qqq.backend.core.context.QContext; import com.kingsrook.qqq.backend.core.exceptions.QException; import com.kingsrook.qqq.backend.core.model.actions.tables.count.CountInput; import com.kingsrook.qqq.backend.core.model.actions.tables.query.QCriteriaOperator; import com.kingsrook.qqq.backend.core.model.actions.tables.query.QFilterCriteria; +import com.kingsrook.qqq.backend.core.model.actions.tables.query.QFilterOrderBy; import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter; +import com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryInput; import com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryJoin; import com.kingsrook.qqq.backend.core.model.actions.widgets.RenderWidgetInput; import com.kingsrook.qqq.backend.core.model.actions.widgets.RenderWidgetOutput; import com.kingsrook.qqq.backend.core.model.dashboard.widgets.RawHTML; import com.kingsrook.qqq.backend.core.model.dashboard.widgets.WidgetType; +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.dashboard.QWidgetMetaData; import com.kingsrook.qqq.backend.core.model.metadata.layout.QAppMetaData; @@ -93,7 +100,8 @@ public class DataAnalysisHome extends AbstractWidgetRenderer /******************************************************************************* - ** Standard QQQ widget renderer entry point. + ** RawHTML is carried as a JSON string by the HTML widget, not a text/html response. + ** Entities keep static separators independent of any host charset handling. *******************************************************************************/ @Override public RenderWidgetOutput render(RenderWidgetInput input) throws QException @@ -110,7 +118,7 @@ public class DataAnalysisHome extends AbstractWidgetRenderer { StringBuilder html = new StringBuilder("
"); String userId = QContext.getQSession() == null || QContext.getQSession().getUser() == null ? null : QContext.getQSession().getUser().getIdReference(); - html.append("

Saved analyses

"); + html.append("

Saved analyses

"); if(userId == null) { html.append("

Sign in to see your saved analyses and stars.

"); @@ -119,7 +127,7 @@ public class DataAnalysisHome extends AbstractWidgetRenderer { int mine = count(DataAnalysisTables.SAVED, equal("owner_user_id", userId)); int shared = count(DataAnalysisTables.SAVED, equal("shared", true)); - html.append("

Mine: ").append(mine).append(" · Shared (visible to you): ").append(shared).append("

"); + html.append("

Mine: ").append(AnalysisFormatting.number(mine, 0)).append(" · Shared (visible to you): ").append(AnalysisFormatting.number(shared, 0)).append("

"); if(canRead(DataAnalysisTables.SAVED_STAR)) { CountInput stars = new CountInput(DataAnalysisTables.SAVED).withIncludeDistinctCount(true) @@ -127,28 +135,28 @@ public class DataAnalysisHome extends AbstractWidgetRenderer .withFilter(equal(DataAnalysisTables.SAVED_STAR + ".user_id", userId)); stars.setPermissionEnforcement(PermissionEnforcement.ENFORCE); int starred = new CountAction().execute(stars).getDistinctCount(); - html.append("

Starred by me: ").append(starred).append("

"); + html.append("

Starred by me: ").append(AnalysisFormatting.number(starred, 0)).append("

"); } if(mine == 0 && shared == 0) { - html.append("

No saved analyses yet. Saving analyses from the Analyze action is planned for a later release.

"); + html.append("

No saved analyses yet. Open any table and choose Analyze on a column header to explore its data.

"); } - html.append("

The Analyze action will be available in a later UI release.

"); link(html, DataAnalysisTables.SAVED); } else { html.append("

Saved analyses are unavailable: you need data_analysis.saved.read.

"); } - html.append("

Watches

"); + html.append("

Watches

"); if(canRead(DataAnalysisTables.WATCH)) { + int total = count(DataAnalysisTables.WATCH, new QQueryFilter()); int enabled = count(DataAnalysisTables.WATCH, equal("enabled", true)); int firing = count(DataAnalysisTables.WATCH, equal("state", "FIRING")); - html.append("

Enabled: ").append(enabled).append(" · Firing: ").append(firing).append("

"); - if(enabled == 0 && firing == 0) + html.append("

Total: ").append(AnalysisFormatting.number(total, 0)).append(" · Enabled: ").append(AnalysisFormatting.number(enabled, 0)).append(" · Firing: ").append(AnalysisFormatting.number(firing, 0)).append("

"); + if(total == 0) { - html.append("

No active watches: watch evaluation is planned for phase e.

"); + html.append("

No watches yet.

"); } link(html, DataAnalysisTables.WATCH); } @@ -156,15 +164,37 @@ public class DataAnalysisHome extends AbstractWidgetRenderer { html.append("

Watches are unavailable: you need data_analysis.watch.read.

"); } - html.append("

Runs in the last 7 days

"); - if(canRead(DataAnalysisTables.RUN)) + html.append("

Recent analysis runs

"); + if(userId == null) { - int complete = count(DataAnalysisTables.RUN, recentRuns("COMPLETE", now)); - int failed = count(DataAnalysisTables.RUN, recentRuns("FAILED", now)); - html.append("

Complete: ").append(complete).append(" · Failed: ").append(failed).append("

"); - if(complete == 0 && failed == 0) + html.append("

Sign in to see your recent analysis runs.

"); + } + else if(canRead(DataAnalysisTables.RUN)) + { + QueryInput query = new QueryInput(DataAnalysisTables.RUN).withFilter(equal("user_id", userId) + .withCriteria(new QFilterCriteria("started_at", QCriteriaOperator.LESS_THAN_OR_EQUALS, now)) + .withOrderBy(new QFilterOrderBy("started_at", false)).withOrderBy(new QFilterOrderBy("id", false)).withLimit(5)); + query.setPermissionEnforcement(PermissionEnforcement.ENFORCE); + List runs = new QueryAction().execute(query).getRecords(); + if(runs.isEmpty()) { - html.append("

No completed or failed runs in this period.

"); + html.append("

No analysis runs yet.

"); + } + else + { + html.append("
    "); + for(QRecord run : runs) + { + QTableMetaData table = QContext.getQInstance().getTable(run.getValueString("table_name")); + String tableLabel = table == null ? run.getValueString("table_name") : table.getLabel(); + String path = QContext.getQInstance().getTablePath(DataAnalysisTables.RUN) + "/" + run.getValueInteger("id"); + html.append("
  • ").append(escape(tableLabel)).append(" · ") + .append(escape(words(run.getValueString("operation")))).append("
    Status
    ") + .append(escape(words(run.getValueString("status")))).append("
    Finished
    ") + .append(run.getValue("finished_at") == null ? "Not finished" : escape(AnalysisFormatting.instant(run.getValueInstant("finished_at")))) + .append("
    • "); + } + html.append("
"); } link(html, DataAnalysisTables.RUN); } @@ -198,13 +228,22 @@ public class DataAnalysisHome extends AbstractWidgetRenderer /******************************************************************************* - ** Runs started within the inclusive seven-day interval, excluding future rows. + ** Stored operation and status keys are displayed as ordinary words. *******************************************************************************/ - private static QQueryFilter recentRuns(String status, Instant now) + private static String words(String value) { - return (equal("status", status) - .withCriteria(new QFilterCriteria("started_at", QCriteriaOperator.GREATER_THAN_OR_EQUALS, now.minus(7, ChronoUnit.DAYS))) - .withCriteria(new QFilterCriteria("started_at", QCriteriaOperator.LESS_THAN_OR_EQUALS, now))); + return (value == null ? "Unknown" : Arrays.stream(value.toLowerCase(Locale.ROOT).split("_")) + .filter(part -> !part.isEmpty()).map(part -> Character.toUpperCase(part.charAt(0)) + part.substring(1)).collect(Collectors.joining(" "))); + } + + + + /******************************************************************************* + ** Metadata and persisted values must never become executable widget markup. + *******************************************************************************/ + private static String escape(String value) + { + return (value == null ? "Unknown" : value.replace("&", "&").replace("\"", """).replace("<", "<").replace(">", ">").replace("'", "'")); } @@ -227,7 +266,7 @@ public class DataAnalysisHome extends AbstractWidgetRenderer private static void link(StringBuilder html, String table) throws QException { String path = QContext.getQInstance().getTablePath(table); - html.append("", ">")) + html.append("View all"); } } diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/AnalysisBackend.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/AnalysisBackend.java index 14ebe27..77f122c 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/AnalysisBackend.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/AnalysisBackend.java @@ -38,7 +38,7 @@ public interface AnalysisBackend *******************************************************************************/ enum DateUnit { - DAY, WEEK, MONTH, YEAR, DAY_OF_WEEK, HOUR_OF_DAY + DAY, WEEK, MONTH, QUARTER, YEAR, HOUR, DAY_OF_WEEK, HOUR_OF_DAY } @@ -120,6 +120,15 @@ public interface AnalysisBackend + /******************************************************************************* + ** Actual inspected non-null values, independent of estimated population counts. + *******************************************************************************/ + record PatternSummary(List groups, long values, boolean truncated) + { + } + + + /******************************************************************************* ** Filtered count; a native estimate scales conditional counts to its population. *******************************************************************************/ @@ -168,7 +177,7 @@ public interface AnalysisBackend /******************************************************************************* ** Top shapes over a bounded primary-key prefix. *******************************************************************************/ - List patterns(String table, QQueryFilter filter, String field, int sampleRows) throws QException; + PatternSummary patterns(String table, QQueryFilter filter, String field, int sampleRows) throws QException; /******************************************************************************* ** Top groups with count greater than one. diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/AnalysisFormatting.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/AnalysisFormatting.java new file mode 100644 index 0000000..badae57 --- /dev/null +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/AnalysisFormatting.java @@ -0,0 +1,225 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis.engine; + +import java.io.Serializable; +import java.math.BigDecimal; +import java.math.MathContext; +import java.math.RoundingMode; +import java.time.DayOfWeek; +import java.time.Instant; +import java.time.LocalDate; +import java.time.Period; +import java.time.ZoneId; +import java.time.format.DateTimeFormatter; +import java.time.format.TextStyle; +import java.util.ArrayList; +import java.util.List; +import java.util.Locale; +import com.kingsrook.qbits.dataanalysis.result.Metric; +import com.kingsrook.qbits.dataanalysis.result.ValueType; +import com.kingsrook.qqq.backend.core.actions.values.QValueFormatter; +import com.kingsrook.qqq.backend.core.model.metadata.fields.DisplayFormat; +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.utils.ValueUtils; + +/******************************************************************************* + ** Display-ready values shared by metrics, chart labels and the home widget. + *******************************************************************************/ +public final class AnalysisFormatting +{ + /******************************************************************************* + ** Utility class. + *******************************************************************************/ + private AnalysisFormatting() + { + } + + + + /******************************************************************************* + ** Ratios remain numeric and bounded, with stable JSON precision. + *******************************************************************************/ + public static BigDecimal ratio(BigDecimal value) + { + return (value.max(BigDecimal.ZERO).min(BigDecimal.ONE).setScale(6, RoundingMode.HALF_UP).stripTrailingZeros()); + } + + + + /******************************************************************************* + ** Plain numeric defaults are independent of the server locale. + *******************************************************************************/ + public static String number(Number value, int decimals) + { + return (String.format(Locale.US, "%,." + decimals + "f", new BigDecimal(value.toString()))); + } + + + + /******************************************************************************* + ** Types and length keys determine display without changing numeric raw values. + *******************************************************************************/ + public static String scalar(String key, Serializable value, ValueType type) + { + if(value == null) + { + return (null); + } + if(type == ValueType.PERCENT) + { + BigDecimal percent = new BigDecimal(value.toString()).multiply(BigDecimal.valueOf(100)).setScale(1, RoundingMode.HALF_UP); + return (percent.signum() == 0 || percent.compareTo(BigDecimal.valueOf(100)) == 0 ? percent.toBigInteger() + "%" : percent.toPlainString() + "%"); + } + if(type == ValueType.DATE_TIME) + { + return (instant((Instant) value)); + } + if(value instanceof Number n) + { + return (number(n, "meanLength".equals(key) ? 1 : type == ValueType.COUNT || key.endsWith("Length") ? 0 : 2)); + } + return (value.toString()); + } + + + + /******************************************************************************* + ** Display formats belong to the host field; fallback defaults preserve fractions. + *******************************************************************************/ + public static String numeric(QFieldMetaData field, String key, BigDecimal value) + { + if(value == null) + { + return (null); + } + String format = field.getDisplayFormat(); + if(format != null && !format.isBlank() && !DisplayFormat.DEFAULT.equals(format)) + { + Serializable displayValue = format.endsWith("d") ? value.toBigInteger() : value; + return (QValueFormatter.formatValue(format, displayValue)); + } + return (number(value, field.getType() == QFieldType.DECIMAL || "mean".equals(key) || "stddev".equals(key) ? 2 : 0)); + } + + + + /******************************************************************************* + ** Decimal statistics retain ten significant digits; formatting uses the original. + *******************************************************************************/ + public static Metric numericMetric(QFieldMetaData field, String key, BigDecimal value) + { + BigDecimal raw = value == null || field.getType() != QFieldType.DECIMAL ? value : value.round(new MathContext(10)); + return (ProfileSupport.metric(key, raw, ValueType.DECIMAL).withFormatted(numeric(field, key, value))); + } + + + + /******************************************************************************* + ** Use the same field formatter on both ends of every histogram interval. + *******************************************************************************/ + public static String interval(QFieldMetaData field, BigDecimal low, BigDecimal high) + { + return (low == null ? "Below " + edge(field, high) + : high == null ? edge(field, low) + " and above" + : edge(field, low) + " – " + edge(field, high)); + } + + + + /******************************************************************************* + ** Whole edges omit redundant cents; unformatted fractional edges stay distinct. + *******************************************************************************/ + private static String edge(QFieldMetaData field, BigDecimal value) + { + String format = field.getDisplayFormat(); + int scale = Math.max(0, value.stripTrailingZeros().scale()); + if(format == null || format.isBlank() || DisplayFormat.DEFAULT.equals(format)) + { + return (number(value, scale)); + } + String formatted = numeric(field, "min", value); + return (scale == 0 && DisplayFormat.CURRENCY.equals(format) && formatted.endsWith(".00") + ? formatted.substring(0, formatted.length() - 3) : formatted); + } + + + + /******************************************************************************* + ** Instants remain UTC in raw values and display in the current session zone. + *******************************************************************************/ + public static String instant(Instant value) + { + return (DateTimeFormatter.ofPattern("uuuu-MM-dd HH:mm", Locale.US).format(value.atZone(ValueUtils.getSessionOrInstanceZoneId()))); + } + + + + /******************************************************************************* + ** Calendar duration avoids misleading fixed-length month and year arithmetic. + *******************************************************************************/ + public static String duration(LocalDate first, LocalDate last) + { + Period period = Period.between(first, last); + List parts = new ArrayList<>(); + if(period.getYears() != 0) + { + parts.add(period.getYears() + (period.getYears() == 1 ? " year" : " years")); + } + if(period.getMonths() != 0) + { + parts.add(period.getMonths() + (period.getMonths() == 1 ? " month" : " months")); + } + if(period.getDays() != 0 || parts.isEmpty()) + { + parts.add(period.getDays() + (period.getDays() == 1 ? " day" : " days")); + } + return (String.join(" ", parts)); + } + + + + /******************************************************************************* + ** Calendar labels describe one bucket; the raw value remains its ISO start. + *******************************************************************************/ + public static String dateBucket(Serializable start, AnalysisBackend.DateUnit unit, ZoneId zone) + { + if(unit == AnalysisBackend.DateUnit.DAY_OF_WEEK) + { + return (DayOfWeek.of(((Number) start).intValue()).getDisplayName(TextStyle.FULL, Locale.US)); + } + if(unit == AnalysisBackend.DateUnit.HOUR_OF_DAY) + { + return (String.format(Locale.US, "%02d:00", ((Number) start).intValue())); + } + LocalDate date = ProfileSupport.day(start, zone); + return (switch(unit) + { + case YEAR -> Integer.toString(date.getYear()); + case QUARTER -> date.getYear() + " Q" + ((date.getMonthValue() - 1) / 3 + 1); + case MONTH -> DateTimeFormatter.ofPattern("MMM uuuu", Locale.US).format(date); + case WEEK -> "Week of " + date; + case HOUR -> DateTimeFormatter.ofPattern("uuuu-MM-dd HH:00", Locale.US).format(((Instant) start).atZone(zone)); + default -> date.toString(); + }); + } +} diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/ColumnProfiler.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/ColumnProfiler.java index 55edeb3..27945b2 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/ColumnProfiler.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/ColumnProfiler.java @@ -86,7 +86,7 @@ public class ColumnProfiler QFieldType type = field.getType(); if(type == QFieldType.INTEGER || type == QFieldType.LONG || type == QFieldType.DECIMAL) { - numeric(result, filter, drillFilter, rows); + numeric(result, filter, drillFilter, rows, field); } else if(type == QFieldType.DATE || type == QFieldType.DATE_TIME) { @@ -95,13 +95,18 @@ public class ColumnProfiler else if(type.isStringLike()) { AnalysisBackend.LengthSummary summary = backend.lengthSummary(table, filter, name); + AnalysisBackend.PatternSummary patterns = backend.patterns(table, filter, name, 10_000); + long patternValues = patterns.values(); TextProfile text = new TextProfile().withHistogram(ProfileSupport.values(table, drillFilter, null, summary.histogram(), rows)) - .withPatterns(ProfileSupport.values(table, drillFilter, null, backend.patterns(table, filter, name, 10_000), Math.min(rows, 10_000))) - .withSampleRows(Math.min(scope.rowsScanned(), 10_000)); + .withPatterns(ProfileSupport.values(table, drillFilter, null, patterns.groups(), patternValues)) + .withSampleRows(patternValues); summary.metrics().forEach((key, value) -> text.getMetrics().add(ProfileSupport.metric(key, value, ValueType.DECIMAL))); result.withText(text); - result.getWarnings().add(scope.samplePercent() == null ? "Patterns use the first " + Math.min(rows, 10_000) + " rows by primary key." - : "Patterns use up to " + Math.min(scope.rowsScanned(), 10_000) + " sampled rows."); + if(patterns.truncated()) + { + result.getWarnings().add(scope.samplePercent() == null ? "Patterns are based on the first " + AnalysisFormatting.number(patternValues, 0) + " values." + : "Patterns are based on " + AnalysisFormatting.number(patternValues, 0) + " sampled values."); + } } else if(type == QFieldType.BOOLEAN) { @@ -142,14 +147,15 @@ public class ColumnProfiler else { result.withChart(ProfileSupport.chart(ChartKind.TIME_SERIES, ChartKind.BAR, name, result.getDates().getBuckets())); + result.getChart().getX().withLabel(field.getLabel() + (result.getDates().getUnit() == null ? "" : " (" + result.getDates().getUnit().toLowerCase(java.util.Locale.ROOT) + ")")); } - if(rows == 0) + if(scope.total() == 0) { result.getWarnings().add("No readable records match this analysis scope."); } - else if(counts.nonNull() == 0 && (!scope.estimate() || scope.rowsScanned() > 0)) + else if(counts.nonNull() == 0 && rows > 0 && (!scope.estimate() || scope.rowsScanned() > 0)) { - result.getWarnings().add("All values in this analysis scope are null."); + result.getWarnings().add(scope.estimate() ? "All observed values are null." : "All values in this analysis scope are null."); } if(scope.estimate()) { @@ -170,16 +176,16 @@ public class ColumnProfiler /******************************************************************************* - ** Numeric moments, twenty interior bins, exterior bins and Tukey outliers. + ** Numeric moments, nice interior bins, exterior bins and Tukey outliers. *******************************************************************************/ - private void numeric(ColumnProfile result, QQueryFilter filter, QQueryFilter drillFilter, long rows) throws QException + private void numeric(ColumnProfile result, QQueryFilter filter, QQueryFilter drillFilter, long rows, QFieldMetaData metadata) throws QException { String table = result.getTableName(); String field = result.getFieldName(); AnalysisBackend.NumericSummary summary = backend.numericSummary(table, filter, field, List.of("0.01", "0.05", "0.25", "0.50", "0.75", "0.95", "0.99").stream().map(BigDecimal::new).toList()); NumericProfile numeric = new NumericProfile(); - summary.metrics().forEach((key, value) -> numeric.getMetrics().add(ProfileSupport.metric(key, value, ValueType.DECIMAL))); + summary.metrics().forEach((key, value) -> numeric.getMetrics().add(AnalysisFormatting.numericMetric(metadata, key, value))); for(AnalysisBackend.GroupCount count : summary.counts()) { numeric.getMetrics().add(ProfileSupport.count(count.label(), count.count(), table, drillFilter, count.condition())); @@ -211,7 +217,7 @@ public class ColumnProfiler LocalDate last = ProfileSupport.day(extrema.get("max"), zone); AnalysisBackend.DateUnit unit = autoBucket(first, last); dates.withUnit(unit.name()); - dates.getMetrics().add(ProfileSupport.metric("range", ChronoUnit.DAYS.between(first, last), ValueType.DURATION)); + dates.getMetrics().add(ProfileSupport.metric("range", ChronoUnit.DAYS.between(first, last), ValueType.DURATION).withFormatted(AnalysisFormatting.duration(first, last))); List buckets = ProfileSupport.values(table, drillFilter, null, backend.dateBuckets(table, filter, field, unit, zone), rows); dates.withBuckets(buckets).withGaps(buckets.stream().filter(b -> b.getCount() == 0).toList()); if(type == QFieldType.DATE_TIME) diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/CoreAnalysisBackend.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/CoreAnalysisBackend.java index e5f9201..3520581 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/CoreAnalysisBackend.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/CoreAnalysisBackend.java @@ -85,7 +85,7 @@ public class CoreAnalysisBackend extends StandInAnalysisBackend { samplePercent = null; long total = super.count(table, filter); - if(exact || total <= config.getSampleThresholdRows() || !capabilities(table).contains(AggregateCapability.SAMPLING)) + if(exact || total <= config.getSampleThresholdRows() || total <= config.getSampleRows() || !capabilities(table).contains(AggregateCapability.SAMPLING)) { return (super.scope(table, filter, exact)); } @@ -375,21 +375,25 @@ public class CoreAnalysisBackend extends StandInAnalysisBackend { return (super.numericHistogram(table, filter, field, low, high, bins)); } + NiceBins nice = NiceBins.covering(low, high); + low = nice.low(); + high = nice.high(); + bins = nice.count(); GroupBy group = new GroupBy(field(table, field)).withBucket(new NumericBucket(low, high, bins)); Map counts = bucketCounts(table, filter, group); List values = !estimating && isMemory(table) ? rows(table, filter, Set.of(field), config.getMaxRows()).stream().map(r -> r.getValue(field)) .filter(Objects::nonNull).map(v -> new BigDecimal(v.toString())).toList() : List.of(); List result = new ArrayList<>(); - result.add(new GroupCount("Below " + low, "Below " + low, aggregateCount(counts.getOrDefault(0, 0L)), numericRange(table, field, values, null, low, false), aggregateShare(counts.getOrDefault(0, 0L)))); + result.add(new GroupCount(AnalysisFormatting.interval(field(table, field), null, low), AnalysisFormatting.interval(field(table, field), null, low), aggregateCount(counts.getOrDefault(0, 0L)), numericRange(table, field, values, null, low, false), aggregateShare(counts.getOrDefault(0, 0L)))); BigDecimal width = high.subtract(low).divide(BigDecimal.valueOf(bins), MathContext.DECIMAL128); for(int i = 0; i < bins; i++) { BigDecimal start = low.add(width.multiply(BigDecimal.valueOf(i))); BigDecimal end = i == bins - 1 ? high : low.add(width.multiply(BigDecimal.valueOf(i + 1))); - String label = "[" + start + ", " + end + (i == bins - 1 ? "]" : ")"); + String label = AnalysisFormatting.interval(field(table, field), start, end); result.add(new GroupCount(label, label, aggregateCount(counts.getOrDefault(i + 1, 0L)), numericRange(table, field, values, start, end, i == bins - 1), aggregateShare(counts.getOrDefault(i + 1, 0L)))); } - result.add(new GroupCount("Above " + high, "Above " + high, aggregateCount(counts.getOrDefault(bins + 1, 0L)), + result.add(new GroupCount(AnalysisFormatting.interval(field(table, field), high, null), AnalysisFormatting.interval(field(table, field), high, null), aggregateCount(counts.getOrDefault(bins + 1, 0L)), DrillFilters.and(DrillFilters.condition(field, QCriteriaOperator.IS_NOT_BLANK), DrillFilters.condition(field, QCriteriaOperator.GREATER_THAN, high)), aggregateShare(counts.getOrDefault(bins + 1, 0L)))); return (result); } @@ -400,6 +404,10 @@ public class CoreAnalysisBackend extends StandInAnalysisBackend @Override public List dateBuckets(String table, QQueryFilter filter, String field, DateUnit unit, ZoneId zone) throws QException { + if(unit == DateUnit.HOUR || unit == DateUnit.QUARTER) + { + return (super.dateBuckets(table, filter, field, unit, zone)); + } GroupBy group = new GroupBy(field(table, field)).withBucket(new DateBucket(DateBucketUnit.valueOf(unit.name()))); AggregateInput probe = new AggregateInput(table).withGroupBy(group); if(!new QBackendModuleDispatcher().getQBackendModule(probe.getBackend()).getAggregateInterface().getSupportedCapabilities(probe).contains(AggregateCapability.DATE_BUCKET)) @@ -423,8 +431,8 @@ public class CoreAnalysisBackend extends StandInAnalysisBackend while(!start.isAfter(dates.getLast())) { LocalDate end = next(start, unit); - String label = start + " / " + end; - result.add(new GroupCount(label, label, aggregateCount(counts.getOrDefault(start, 0L)), + String label = AnalysisFormatting.dateBucket(start, unit, zone); + result.add(new GroupCount(start, label, aggregateCount(counts.getOrDefault(start, 0L)), DrillFilters.dateRange(field, start, end, field(table, field).getType() == QFieldType.DATE_TIME, zone), aggregateShare(counts.getOrDefault(start, 0L)))); start = end; } diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/MetricLabels.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/MetricLabels.java new file mode 100644 index 0000000..2b7ce09 --- /dev/null +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/MetricLabels.java @@ -0,0 +1,65 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis.engine; + +import java.util.Map; +import java.util.Objects; +import com.kingsrook.qbits.dataanalysis.result.ValueType; + +/******************************************************************************* + ** One vocabulary for every emitted metric, including date-specific extrema. + *******************************************************************************/ +public final class MetricLabels +{ + private static final Map LABELS = Map.ofEntries( + Map.entry("rows", "Rows"), Map.entry("nonNull", "Non-empty"), Map.entry("nulls", "Nulls"), + Map.entry("blanks", "Blanks"), Map.entry("distinct", "Distinct values"), Map.entry("uniqueness", "Uniqueness"), + Map.entry("completeness", "Completeness"), Map.entry("share", "Share"), + Map.entry("min", "Minimum"), Map.entry("max", "Maximum"), Map.entry("mean", "Mean"), + Map.entry("median", "Median"), Map.entry("stddev", "Standard deviation"), Map.entry("sum", "Sum"), + Map.entry("zeros", "Zeros"), Map.entry("negatives", "Negatives"), Map.entry("outliers", "Outliers"), + Map.entry("p1", "1st percentile"), Map.entry("p5", "5th percentile"), Map.entry("p25", "25th percentile (Q1)"), + Map.entry("p50", "Median"), Map.entry("p75", "75th percentile (Q3)"), Map.entry("p95", "95th percentile"), Map.entry("p99", "99th percentile"), + Map.entry("minLength", "Shortest"), Map.entry("maxLength", "Longest"), Map.entry("meanLength", "Average length"), + Map.entry("earliest", "Earliest"), Map.entry("latest", "Latest"), Map.entry("range", "Range"), + Map.entry("true", "True"), Map.entry("false", "False"), Map.entry("other", "Other")); + + /******************************************************************************* + ** Utility class. + *******************************************************************************/ + private MetricLabels() + { + } + + + + /******************************************************************************* + ** Fail at construction when a new metric lacks a human label. + *******************************************************************************/ + public static String label(String key, ValueType type) + { + if(type == ValueType.DATE || type == ValueType.DATE_TIME) + { + key = "min".equals(key) ? "earliest" : "max".equals(key) ? "latest" : key; + } + return (Objects.requireNonNull(LABELS.get(key), "Missing metric label: " + key)); + } +} diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/MinGroupSizeGuard.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/MinGroupSizeGuard.java index c9a82a2..3331d96 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/MinGroupSizeGuard.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/MinGroupSizeGuard.java @@ -71,7 +71,7 @@ public class MinGroupSizeGuard } if(hidden > 0) { - result.add(new ValueCount().withLabel("Other (" + hidden + " groups below " + minimum + ")").withCount(count).withShare(share)); + result.add(new ValueCount().withLabel("Other (" + hidden + " groups below " + minimum + ")").withCount(count).withShare(AnalysisFormatting.ratio(share))); } return (result); } @@ -114,7 +114,7 @@ public class MinGroupSizeGuard List booleanGroups = profile.getBooleans().stream().map(m -> new ValueCount().withValue(m.getKey()).withLabel(m.getLabel()) .withCount(((Number) m.getValue()).longValue()).withShare(ProfileSupport.share(((Number) m.getValue()).longValue(), rows)).withDrill(m.getDrill())).toList(); profile.withBooleans(groups(booleanGroups).stream().map(v -> ProfileSupport.metric(v.getValue() == null ? "other" : v.getValue().toString(), v.getCount(), - com.kingsrook.qbits.dataanalysis.result.ValueType.COUNT).withLabel(v.getLabel()).withDrill(v.getDrill())).toList()); + com.kingsrook.qbits.dataanalysis.result.ValueType.COUNT).withDrill(v.getDrill())).toList()); } } if(profile.getNumeric() != null) diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/NiceBins.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/NiceBins.java new file mode 100644 index 0000000..76807f3 --- /dev/null +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/NiceBins.java @@ -0,0 +1,62 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis.engine; + +import java.math.BigDecimal; +import java.math.RoundingMode; +import java.util.List; + +/******************************************************************************* + ** Exact decimal boundaries with a readable step and approximately twenty bins. + *******************************************************************************/ +public record NiceBins(BigDecimal low, BigDecimal high, int count) +{ + /******************************************************************************* + ** Select the closest 10..25-bin enclosure from 1, 2, 2.5 and 5 times powers of ten. + *******************************************************************************/ + public static NiceBins covering(BigDecimal low, BigDecimal high) + { + BigDecimal span = high.subtract(low); + if(span.signum() == 0) + { + span = low.abs().max(BigDecimal.ONE); + low = low.subtract(span.divide(BigDecimal.valueOf(2))); + high = high.add(span.divide(BigDecimal.valueOf(2))); + } + int exponent = span.precision() - span.scale() - 2; + NiceBins best = null; + for(int power = exponent - 2; power <= exponent + 2; power++) + { + for(String factor : List.of("1", "2", "2.5", "5")) + { + BigDecimal step = new BigDecimal(factor).scaleByPowerOfTen(power); + BigDecimal first = low.divide(step, 0, RoundingMode.FLOOR).multiply(step); + BigDecimal last = high.divide(step, 0, RoundingMode.CEILING).multiply(step); + int count = last.subtract(first).divide(step).intValueExact(); + if(count >= 10 && count <= 25 && (best == null || Math.abs(count - 20) < Math.abs(best.count() - 20))) + { + best = new NiceBins(first, last, count); + } + } + } + return (java.util.Objects.requireNonNull(best)); + } +} diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/ProfileSupport.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/ProfileSupport.java index 83c8b59..716de31 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/ProfileSupport.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/ProfileSupport.java @@ -56,7 +56,7 @@ public final class ProfileSupport *******************************************************************************/ public static BigDecimal share(long count, long rows) { - return (rows == 0 ? BigDecimal.ZERO : BigDecimal.valueOf(count).divide(BigDecimal.valueOf(rows), MathContext.DECIMAL128)); + return (rows == 0 ? BigDecimal.ZERO : BigDecimal.valueOf(count).divide(BigDecimal.valueOf(rows), 6, java.math.RoundingMode.HALF_UP).stripTrailingZeros()); } @@ -76,7 +76,12 @@ public final class ProfileSupport *******************************************************************************/ public static Metric metric(String key, Serializable value, ValueType type) { - return (new Metric().withKey(key).withLabel(key).withValue(value).withValueType(type).withFormatted(value == null ? null : value.toString())); + if(type == ValueType.PERCENT && value != null) + { + value = AnalysisFormatting.ratio(new BigDecimal(value.toString())); + } + return (new Metric().withKey(key).withLabel(MetricLabels.label(key, type)).withValue(value).withValueType(type) + .withFormatted(AnalysisFormatting.scalar(key, value, type))); } @@ -116,7 +121,7 @@ public final class ProfileSupport label = translated; } } - result.add(new ValueCount().withValue(group.value()).withLabel(label).withCount(group.count()).withShare(group.share() == null ? share(group.count(), total) : group.share()) + result.add(new ValueCount().withValue(group.value()).withLabel(label).withCount(group.count()).withShare(group.share() == null ? share(group.count(), total) : AnalysisFormatting.ratio(group.share())) .withDrill(DrillFilters.drill(table, filter, group.condition()))); } return (result); diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/StandInAnalysisBackend.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/StandInAnalysisBackend.java index a8ee186..48b342f 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/StandInAnalysisBackend.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/StandInAnalysisBackend.java @@ -101,7 +101,7 @@ public class StandInAnalysisBackend implements AnalysisBackend public Scope scope(String table, QQueryFilter filter, boolean exact) throws QException { long total = count(table, filter); - boolean estimate = !exact && total > config.getSampleThresholdRows(); + boolean estimate = !exact && total > config.getSampleThresholdRows() && total > Math.min(config.getSampleRows(), config.getMaxRows()); estimating = estimate; int limit = estimate ? Math.min(config.getSampleRows(), config.getMaxRows()) : config.getMaxRows(); QQueryFilter scoped = DrillFilters.copy(filter); @@ -455,17 +455,21 @@ public class StandInAnalysisBackend implements AnalysisBackend { return (result); } + NiceBins nice = NiceBins.covering(low, high); + low = nice.low(); + high = nice.high(); + bins = nice.count(); List values = rows(table, filter, Set.of(field), config.getMaxRows()).stream().map(r -> r.getValue(field)) .filter(Objects::nonNull).map(v -> new BigDecimal(v.toString())).toList(); - result.add(bucket(table, filter, "Below " + low, numericRange(table, field, values, null, low, false))); + result.add(bucket(table, filter, AnalysisFormatting.interval(field(table, field), null, low), numericRange(table, field, values, null, low, false))); BigDecimal width = high.subtract(low).divide(BigDecimal.valueOf(bins), MATH); for(int i = 0; i < bins; i++) { BigDecimal start = low.add(width.multiply(BigDecimal.valueOf(i))); BigDecimal end = i == bins - 1 ? high : low.add(width.multiply(BigDecimal.valueOf(i + 1))); - result.add(bucket(table, filter, "[" + start + ", " + end + (i == bins - 1 ? "]" : ")"), numericRange(table, field, values, start, end, i == bins - 1))); + result.add(bucket(table, filter, AnalysisFormatting.interval(field(table, field), start, end), numericRange(table, field, values, start, end, i == bins - 1))); } - result.add(bucket(table, filter, "Above " + high, DrillFilters.and(DrillFilters.condition(field, QCriteriaOperator.IS_NOT_BLANK), DrillFilters.condition(field, QCriteriaOperator.GREATER_THAN, high)))); + result.add(bucket(table, filter, AnalysisFormatting.interval(field(table, field), high, null), DrillFilters.and(DrillFilters.condition(field, QCriteriaOperator.IS_NOT_BLANK), DrillFilters.condition(field, QCriteriaOperator.GREATER_THAN, high)))); return (result); } @@ -491,7 +495,26 @@ public class StandInAnalysisBackend implements AnalysisBackend if(unit == DateUnit.DAY_OF_WEEK || unit == DateUnit.HOUR_OF_DAY) { return (mappedGroups(table, filter, field, records, v -> unit == DateUnit.DAY_OF_WEEK ? day(v, zone).getDayOfWeek().getValue() - : ((Instant) v).atZone(zone).getHour(), 24)); + : ((Instant) v).atZone(zone).getHour(), 24).stream() + .map(g -> new GroupCount(g.value(), AnalysisFormatting.dateBucket(g.value(), unit, zone), g.count(), g.condition(), g.share())).toList()); + } + if(unit == DateUnit.HOUR) + { + List instants = records.stream().map(r -> (Instant) r.getValue(field)).filter(Objects::nonNull).sorted().toList(); + List hours = new ArrayList<>(); + if(!instants.isEmpty()) + { + Instant start = instants.getFirst().atZone(zone).truncatedTo(java.time.temporal.ChronoUnit.HOURS).toInstant(); + while(!start.isAfter(instants.getLast())) + { + Instant end = start.plus(1, java.time.temporal.ChronoUnit.HOURS); + QQueryFilter condition = DrillFilters.and(DrillFilters.condition(field, QCriteriaOperator.GREATER_THAN_OR_EQUALS, start), + DrillFilters.condition(field, QCriteriaOperator.LESS_THAN, end)); + hours.add(new GroupCount(start, AnalysisFormatting.dateBucket(start, unit, zone), count(table, DrillFilters.and(filter, condition)), condition, countShare())); + start = end; + } + } + return (hours); } List dates = records.stream().map(r -> r.getValue(field)).filter(Objects::nonNull).map(v -> day(v, zone)).sorted().toList(); List result = new ArrayList<>(); @@ -504,7 +527,8 @@ public class StandInAnalysisBackend implements AnalysisBackend while(!start.isAfter(last)) { LocalDate end = next(start, unit); - result.add(bucket(table, filter, start + " / " + end, DrillFilters.dateRange(field, start, end, field(table, field).getType() == QFieldType.DATE_TIME, zone))); + QQueryFilter condition = DrillFilters.dateRange(field, start, end, field(table, field).getType() == QFieldType.DATE_TIME, zone); + result.add(new GroupCount(start, AnalysisFormatting.dateBucket(start, unit, zone), count(table, DrillFilters.and(filter, condition)), condition, countShare())); start = end; } return (result); @@ -531,6 +555,7 @@ public class StandInAnalysisBackend implements AnalysisBackend { case WEEK -> date.with(TemporalAdjusters.previousOrSame(DayOfWeek.MONDAY)); case MONTH -> date.withDayOfMonth(1); + case QUARTER -> date.withMonth((date.getMonthValue() - 1) / 3 * 3 + 1).withDayOfMonth(1); case YEAR -> date.withDayOfYear(1); default -> date; }); @@ -547,6 +572,7 @@ public class StandInAnalysisBackend implements AnalysisBackend { case WEEK -> date.plusWeeks(1); case MONTH -> date.plusMonths(1); + case QUARTER -> date.plusMonths(3); case YEAR -> date.plusYears(1); default -> date.plusDays(1); }); @@ -605,12 +631,14 @@ public class StandInAnalysisBackend implements AnalysisBackend ** Shapes use a primary-key prefix of at most the requested sample size. *******************************************************************************/ @Override - public List patterns(String table, QQueryFilter filter, String field, int sampleRows) throws QException + public PatternSummary patterns(String table, QQueryFilter filter, String field, int sampleRows) throws QException { - List records = rows(table, filter, Set.of(field, primaryKey(table)), sampleRows); + List records = rows(table, DrillFilters.and(filter, DrillFilters.nonNull(field, true)), Set.of(field, primaryKey(table)), sampleRows + 1); + boolean truncated = records.size() > sampleRows; + records = records.subList(0, Math.min(records.size(), sampleRows)); QQueryFilter sampled = records.isEmpty() ? DrillFilters.in(primaryKey(table), List.of()) : DrillFilters.condition(primaryKey(table), QCriteriaOperator.LESS_THAN_OR_EQUALS, records.getLast().getValue(primaryKey(table))); - return (mappedGroups(table, estimating ? filter : DrillFilters.and(filter, sampled), field, records, v -> shape(v.toString()), 10)); + return (new PatternSummary(mappedGroups(table, estimating ? filter : DrillFilters.and(filter, sampled), field, records, v -> shape(v.toString()), 10), records.size(), truncated)); } diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/TableProfiler.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/TableProfiler.java index 2560174..14a8a1d 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/TableProfiler.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/TableProfiler.java @@ -70,7 +70,7 @@ public class TableProfiler String name = field.getName(); AnalysisBackend.FieldCounts c = counts.get(name); result.getFields().add(new FieldSummary().withField(name).withLabel(field.getLabel()).withType(field.getType().name()) - .withCompleteness(c.completeness()).withDistinct(c.distinct()).withUniqueness(c.uniqueness()) + .withCompleteness(AnalysisFormatting.ratio(c.completeness())).withDistinct(c.distinct()).withUniqueness(AnalysisFormatting.ratio(c.uniqueness())) .withConstant(c.constant()).withEmpty(c.blanks() == rows) .withNulls(ProfileSupport.count("nulls", c.nulls(), table, drillFilter, DrillFilters.nulls(name, field.getType().isStringLike()))) .withBlanks(ProfileSupport.count("blanks", c.blanks(), table, drillFilter, c.blankFilter()))); diff --git a/src/main/resources/openapi/qqq-v1/data-analysis.yaml b/src/main/resources/openapi/qqq-v1/data-analysis.yaml index 7f0b3df..de5cdc6 100644 --- a/src/main/resources/openapi/qqq-v1/data-analysis.yaml +++ b/src/main/resources/openapi/qqq-v1/data-analysis.yaml @@ -511,7 +511,7 @@ components: nullable: true type: "string" completeness: - description: "Completeness." + description: "Non-empty share as a 0..1 ratio rounded to six decimals." nullable: true type: "number" distinct: @@ -519,7 +519,7 @@ components: nullable: true type: "integer" uniqueness: - description: "Uniqueness." + description: "Distinct share as a 0..1 ratio rounded to six decimals." nullable: true type: "number" constant: @@ -567,11 +567,13 @@ components: nullable: true type: "string" label: - description: "Label." + description: "Plain-English metric label, ready to display." nullable: true type: "string" value: - description: "Value." + description: "Raw numeric or temporal value. PERCENT is a 0..1 ratio rounded\ + \ to six decimals; DECIMAL field statistics have ten significant digits.\ + \ DATE_TIME is an ISO instant." nullable: true oneOf: - type: "string" @@ -596,7 +598,8 @@ components: \ remains exact." type: "boolean" formatted: - description: "Formatted." + description: "Display-ready value, including grouping, field display formats,\ + \ percent signs and session-zone dates; null when absent or suppressed." nullable: true type: "string" drill: @@ -872,7 +875,7 @@ components: nullable: true type: "integer" share: - description: "Share." + description: "Share as a 0..1 ratio rounded to six decimals." nullable: true type: "number" drill: diff --git a/src/test/java/com/kingsrook/qbits/dataanalysis/AnalysisFormattingTest.java b/src/test/java/com/kingsrook/qbits/dataanalysis/AnalysisFormattingTest.java new file mode 100644 index 0000000..f454bee --- /dev/null +++ b/src/test/java/com/kingsrook/qbits/dataanalysis/AnalysisFormattingTest.java @@ -0,0 +1,158 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis; + +import java.math.BigDecimal; +import java.time.Instant; +import java.time.LocalDate; +import java.time.ZoneId; +import java.util.List; +import java.util.Map; +import com.kingsrook.qbits.dataanalysis.engine.AnalysisBackend; +import com.kingsrook.qbits.dataanalysis.engine.AnalysisFormatting; +import com.kingsrook.qbits.dataanalysis.engine.MetricLabels; +import com.kingsrook.qbits.dataanalysis.engine.NiceBins; +import com.kingsrook.qbits.dataanalysis.engine.ProfileSupport; +import com.kingsrook.qbits.dataanalysis.result.ValueType; +import com.kingsrook.qqq.backend.core.model.metadata.fields.DisplayFormat; +import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData; +import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType; +import org.junit.jupiter.api.Test; +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatThrownBy; + +/******************************************************************************* + ** Public presentation contracts, including precision and calendar edge cases. + *******************************************************************************/ +class AnalysisFormattingTest +{ + /******************************************************************************* + ** Raw ratios remain numeric while display strings are ready for a CLI. + *******************************************************************************/ + @Test + void numbersPercentagesAndLengths() + { + assertThat(ProfileSupport.metric("rows", 12498L, ValueType.COUNT).getFormatted()).isEqualTo("12,498"); + for(String key : List.of("uniqueness", "completeness", "share")) + { + var metric = ProfileSupport.metric(key, new BigDecimal("0.987654321"), ValueType.PERCENT); + assertThat(metric.getValue()).isEqualTo(new BigDecimal("0.987654")); + assertThat(metric.getFormatted()).isEqualTo("98.8%"); + assertThat(metric.getValueType()).isEqualTo(ValueType.PERCENT); + } + assertThat(ProfileSupport.metric("share", BigDecimal.ONE, ValueType.PERCENT).getFormatted()).isEqualTo("100%"); + assertThat(ProfileSupport.metric("share", BigDecimal.ZERO, ValueType.PERCENT).getFormatted()).isEqualTo("0%"); + assertThat(ProfileSupport.share(1, 3)).isEqualByComparingTo("0.333333"); + assertThat(ProfileSupport.share(0, 0)).isZero(); + assertThat(ProfileSupport.metric("meanLength", new BigDecimal("12.345"), ValueType.DECIMAL).getFormatted()).isEqualTo("12.3"); + assertThat(ProfileSupport.metric("minLength", BigDecimal.TEN, ValueType.DECIMAL).getFormatted()).isEqualTo("10"); + assertThat(ProfileSupport.metric("max", null, ValueType.DECIMAL).getFormatted()).isNull(); + assertThatThrownBy(() -> MetricLabels.label("unknown", ValueType.COUNT)).isInstanceOf(NullPointerException.class).hasMessageContaining("Missing metric label"); + } + + + + /******************************************************************************* + ** Host currency and custom display formats take precedence over numeric defaults. + *******************************************************************************/ + @Test + void fieldFormatsAndRawPrecision() + { + QFieldMetaData decimal = new QFieldMetaData("amount", QFieldType.DECIMAL); + assertThat(AnalysisFormatting.numeric(decimal, "min", new BigDecimal("81753.32"))).isEqualTo("81,753.32"); + decimal.withDisplayFormat(DisplayFormat.CURRENCY); + assertThat(AnalysisFormatting.numeric(decimal, "min", new BigDecimal("81753.32"))).isEqualTo("$81,753.32"); + var metric = AnalysisFormatting.numericMetric(decimal, "mean", new BigDecimal("125916.45167830173")); + assertThat(metric.getValue()).isEqualTo(new BigDecimal("125916.4517")); + assertThat(metric.getFormatted()).isEqualTo("$125,916.45"); + assertThat(AnalysisFormatting.numericMetric(decimal, "max", null).getValue()).isNull(); + QFieldMetaData integer = new QFieldMetaData("quantity", QFieldType.INTEGER); + assertThat(AnalysisFormatting.numeric(integer, "max", new BigDecimal("12498"))).isEqualTo("12,498"); + assertThat(AnalysisFormatting.numeric(integer, "mean", new BigDecimal("12.345"))).isEqualTo("12.35"); + assertThat(AnalysisFormatting.numeric(integer, "stddev", new BigDecimal("12.345"))).isEqualTo("12.35"); + assertThat(AnalysisFormatting.numeric(integer.withDisplayFormat(DisplayFormat.DECIMAL1_COMMAS), "mean", new BigDecimal("12.345"))).isEqualTo("12.3"); + QFieldMetaData large = new QFieldMetaData("large", QFieldType.LONG).withDisplayFormat(DisplayFormat.COMMAS); + assertThat(AnalysisFormatting.numeric(large, "sum", new BigDecimal("9000000000"))).isEqualTo("9,000,000,000"); + } + + + + /******************************************************************************* + ** Nice boundaries remain exact at small scales, negative values and constants. + *******************************************************************************/ + @Test + void niceEdgesAndLabels() + { + for(List range : List.of(List.of("25317.13", "65781.79"), List.of("-0.0093", "0.0357"), List.of("42", "42"), List.of("0", "0"), List.of("-9", "905"))) + { + BigDecimal low = new BigDecimal(range.getFirst()); + BigDecimal high = new BigDecimal(range.getLast()); + NiceBins bins = NiceBins.covering(low, high); + assertThat(bins.count()).isBetween(10, 25); + assertThat(bins.low()).isLessThanOrEqualTo(low); + assertThat(bins.high()).isGreaterThanOrEqualTo(high); + BigDecimal step = bins.high().subtract(bins.low()).divide(BigDecimal.valueOf(bins.count())).stripTrailingZeros(); + assertThat(step.scaleByPowerOfTen(step.scale() - step.precision() + 1).toPlainString()).isIn("1", "2", "2.5", "5"); + assertThat(bins.low().remainder(step)).isZero(); + assertThat(bins.high().remainder(step)).isZero(); + } + QFieldMetaData field = new QFieldMetaData("amount", QFieldType.INTEGER); + assertThat(AnalysisFormatting.interval(field, new BigDecimal("60000"), new BigDecimal("65000"))).isEqualTo("60,000 – 65,000"); + assertThat(AnalysisFormatting.interval(field, null, new BigDecimal("25000"))).isEqualTo("Below 25,000"); + assertThat(AnalysisFormatting.interval(field, new BigDecimal("65000"), null)).isEqualTo("65,000 and above"); + assertThat(AnalysisFormatting.interval(field, new BigDecimal("1.25"), new BigDecimal("1.5"))).isEqualTo("1.25 – 1.5"); + field.withDisplayFormat(DisplayFormat.CURRENCY); + assertThat(AnalysisFormatting.interval(field, new BigDecimal("60000"), new BigDecimal("65000"))).isEqualTo("$60,000 – $65,000"); + } + + + + /******************************************************************************* + ** Every supported unit has a human label without replacing its ISO coordinate. + *******************************************************************************/ + @Test + void dateUnitsAndDurations() + { + ZoneId zone = ZoneId.of("America/Chicago"); + LocalDate date = LocalDate.of(2024, 3, 4); + Map labels = Map.of( + AnalysisBackend.DateUnit.YEAR, "2024", AnalysisBackend.DateUnit.QUARTER, "2024 Q1", AnalysisBackend.DateUnit.MONTH, "Mar 2024", + AnalysisBackend.DateUnit.WEEK, "Week of 2024-03-04", AnalysisBackend.DateUnit.DAY, "2024-03-04"); + labels.forEach((unit, label) -> assertThat(AnalysisFormatting.dateBucket(date, unit, zone)).isEqualTo(label)); + assertThat(AnalysisFormatting.dateBucket(Instant.parse("2024-03-04T19:00:00Z"), AnalysisBackend.DateUnit.HOUR, zone)).isEqualTo("2024-03-04 13:00"); + for(int i = 1; i <= 7; i++) + { + assertThat(AnalysisFormatting.dateBucket(i, AnalysisBackend.DateUnit.DAY_OF_WEEK, zone)) + .isEqualTo(List.of("Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday").get(i - 1)); + } + for(int i = 0; i < 24; i++) + { + assertThat(AnalysisFormatting.dateBucket(i, AnalysisBackend.DateUnit.HOUR_OF_DAY, zone)).isEqualTo(String.format(java.util.Locale.US, "%02d:00", i)); + } + assertThat(AnalysisFormatting.duration(date, date.plusYears(48).plusMonths(2))).isEqualTo("48 years 2 months"); + assertThat(AnalysisFormatting.duration(date, date.plusDays(12))).isEqualTo("12 days"); + assertThat(AnalysisFormatting.duration(date, date.plusYears(1).plusMonths(1).plusDays(1))).isEqualTo("1 year 1 month 1 day"); + assertThat(AnalysisFormatting.duration(date, date)).isEqualTo("0 days"); + assertThat(ProfileSupport.metric("min", date, ValueType.DATE).getLabel()).isEqualTo("Earliest"); + assertThat(ProfileSupport.metric("max", date, ValueType.DATE).getLabel()).isEqualTo("Latest"); + assertThat(ProfileSupport.metric("min", date, ValueType.DATE).getFormatted()).isEqualTo("2024-03-04"); + } +} diff --git a/src/test/java/com/kingsrook/qbits/dataanalysis/CoreAnalysisBackendTest.java b/src/test/java/com/kingsrook/qbits/dataanalysis/CoreAnalysisBackendTest.java index 324d20e..ed2a248 100644 --- a/src/test/java/com/kingsrook/qbits/dataanalysis/CoreAnalysisBackendTest.java +++ b/src/test/java/com/kingsrook/qbits/dataanalysis/CoreAnalysisBackendTest.java @@ -110,7 +110,7 @@ class CoreAnalysisBackendTest extends EngineFixture } /******************************************************************************* - ** Zero and capped percentages never divide by zero or restrict the row drill. + ** Empty samples keep the population drill; inspecting every row is exact. *******************************************************************************/ @Test void samplingBoundaries() throws Exception @@ -123,7 +123,8 @@ class CoreAnalysisBackendTest extends EngineFixture config.withDefaultSampleRows(100); service.getConfigResolver().invalidate(); var scope = service.backend("orders").scope("orders", null, false); - assertThat(scope.samplePercent()).isEqualByComparingTo("100"); + assertThat(scope.samplePercent()).isNull(); + assertThat(scope.estimate()).isFalse(); assertThat(scope.rowsScanned()).isEqualTo(12); } diff --git a/src/test/java/com/kingsrook/qbits/dataanalysis/DataAnalysisHomeTest.java b/src/test/java/com/kingsrook/qbits/dataanalysis/DataAnalysisHomeTest.java index 68c7fd9..f8439b7 100644 --- a/src/test/java/com/kingsrook/qbits/dataanalysis/DataAnalysisHomeTest.java +++ b/src/test/java/com/kingsrook/qbits/dataanalysis/DataAnalysisHomeTest.java @@ -33,7 +33,6 @@ import com.kingsrook.qqq.backend.core.model.session.QSession; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.Test; import static org.assertj.core.api.Assertions.assertThat; -import static org.assertj.core.api.Assertions.assertThatThrownBy; /******************************************************************************* @@ -62,8 +61,12 @@ class DataAnalysisHomeTest QContext.init(instance, TestSupport.user("alice").withPermissions("data_analysis.saved.read", "data_analysis.watch.read", "data_analysis.run.read")); String html = DataAnalysisHome.render(Instant.now()); assertThat(html).contains("Mine: 0", "Starred by me: 0", "No saved analyses yet", - "No active watches", "No completed or failed runs", "View all"); - assertThat(new DataAnalysisHome().render(new RenderWidgetInput())).isNotNull(); + "No watches yet.", "No analysis runs yet.", "View all", "Open any table and choose Analyze on a column header to explore its data.", "

"); + var widget = new DataAnalysisHome().render(new RenderWidgetInput()).getWidgetData(); + assertThat(widget).isInstanceOf(com.kingsrook.qqq.backend.core.model.dashboard.widgets.RawHTML.class); + assertThat(((com.kingsrook.qqq.backend.core.model.dashboard.widgets.RawHTML) widget).getType()).isEqualTo("html"); + assertThat(html).contains("·").doesNotContain("Â", "later", "phase", " c < 128)).isTrue(); QContext.init(instance, TestSupport.user("alice")); html = DataAnalysisHome.render(Instant.now()); assertThat(html).contains("you need data_analysis.saved.read", "you need data_analysis.watch.read").doesNotContain("Mine: 0", "Complete: 0"); @@ -99,11 +102,39 @@ class DataAnalysisHomeTest run("bob", "FAILED", now); QContext.init(instance, TestSupport.user("alice").withPermissions("data_analysis.saved.read", "data_analysis.watch.read", "data_analysis.run.read")); String html = DataAnalysisHome.render(now); - assertThat(html).contains("Mine: 2", "Shared (visible to you): 1", "Starred by me: 1", "Enabled: 2", "Firing: 1", "Complete: 2", "Failed: 1") - .doesNotContain("No saved analyses", "No active watches", "No completed or failed runs"); + assertThat(html).contains("Mine: 2", "Shared (visible to you): 1", "Starred by me: 1", "Enabled: 2", "Firing: 1", "Recent analysis runs", "Complete", "Failed", "Running", "Not finished") + .doesNotContain("No saved analyses", "No watches yet", "No analysis runs yet"); QContext.init(instance, TestSupport.user("bob").withPermissions("data_analysis.saved.read", "data_analysis.run.read")); html = DataAnalysisHome.render(now); - assertThat(html).contains("Mine: 1", "Shared (visible to you): 1", "Starred by me: 0", "Complete: 0", "Failed: 1", "you need data_analysis.watch.read"); + assertThat(html).contains("Mine: 1", "Shared (visible to you): 1", "Starred by me: 0", "Failed", "you need data_analysis.watch.read"); + } + + + + /******************************************************************************* + ** Latest five remain owner-scoped even with administrator bypass and escape HTML. + *******************************************************************************/ + @Test + void recentRunDetailsAndLimit() throws Exception + { + QInstance instance = TestSupport.instance(); + instance.getTable(DataAnalysisTables.SAVED).withLabel("Saved & review"); + Instant now = Instant.parse("2026-10-13T23:10:00Z"); + for(int i = 0; i < 7; i++) + { + TestSupport.insert(DataAnalysisTables.RUN, new QRecord().withValue("table_name", DataAnalysisTables.SAVED) + .withValue("operation", "COLUMN_PROFILE").withValue("user_id", "admin").withValue("status", "COMPLETE") + .withValue("started_at", now.minusSeconds(i * 60L)).withValue("finished_at", now.minusSeconds(i * 60L))); + } + TestSupport.insert(DataAnalysisTables.RUN, new QRecord().withValue("table_name", "private_bob_table") + .withValue("operation", "TABLE_PROFILE").withValue("user_id", "bob").withValue("status", "FAILED").withValue("started_at", now)); + QContext.init(instance, TestSupport.admin().withValue(QSession.VALUE_KEY_USER_TIMEZONE, "America/Chicago")); + String html = DataAnalysisHome.render(now); + assertThat(html).contains("Saved <analysis> & review", "Column Profile", "2026-10-13 18:10", "2026-10-13 18:06", ""); + assertThat(html.split("
  • ", -1)).hasSize(6); + assertThat(html).contains("href=\"" + instance.getTablePath(DataAnalysisTables.RUN) + "/1\""); + assertThat(html).contains("href=\"" + instance.getTablePath(DataAnalysisTables.RUN) + "\">View all"); } @@ -113,7 +144,7 @@ class DataAnalysisHomeTest *******************************************************************************/ private static void run(String user, String status, Instant started) throws Exception { - TestSupport.insert(DataAnalysisTables.RUN, new QRecord().withValue("table_name", "orders").withValue("operation", "profile") + TestSupport.insert(DataAnalysisTables.RUN, new QRecord().withValue("table_name", "orders").withValue("operation", "COLUMN_PROFILE") .withValue("user_id", user).withValue("status", status).withValue("started_at", started)); } } diff --git a/src/test/java/com/kingsrook/qbits/dataanalysis/EngineContractTest.java b/src/test/java/com/kingsrook/qbits/dataanalysis/EngineContractTest.java index c5343e5..3275715 100644 --- a/src/test/java/com/kingsrook/qbits/dataanalysis/EngineContractTest.java +++ b/src/test/java/com/kingsrook/qbits/dataanalysis/EngineContractTest.java @@ -64,7 +64,60 @@ import static org.assertj.core.api.Assertions.within; abstract class EngineContractTest extends EngineFixture { /******************************************************************************* - ** All numeric moments and percentiles agree to 1e-9. + ** Every emitted key across all profile kinds has a label, on every backend. + *******************************************************************************/ + @Test + void presentationAcrossProfileKinds() throws Exception + { + java.util.Set keys = new java.util.HashSet<>(); + for(String field : List.of("amount", "quantity", "note", "paid", "order_date", "created")) + { + ColumnProfile profile = service.columnProfile(column(field)); + java.util.List metrics = new java.util.ArrayList<>(profile.getCounts()); + if(profile.getNumeric() != null) + { + metrics.addAll(profile.getNumeric().getMetrics()); + } + if(profile.getText() != null) + { + metrics.addAll(profile.getText().getMetrics()); + } + if(profile.getDates() != null) + { + metrics.addAll(profile.getDates().getMetrics()); + assertThat(profile.getChart().getX().getLabel()).endsWith(" (day)"); + assertThat(profile.getChart().getSeries().getFirst().getPoints().getFirst().getX().toString()).isEqualTo("2026-01-01"); + } + if(profile.getBooleans() != null) + { + metrics.addAll(profile.getBooleans()); + } + for(Metric metric : metrics) + { + keys.add(metric.getKey()); + assertThat(metric.getLabel()).isEqualTo(com.kingsrook.qbits.dataanalysis.engine.MetricLabels.label(metric.getKey(), metric.getValueType())); + assertThat(metric.getFormatted()).isNotBlank(); + } + } + assertThat(keys).containsExactlyInAnyOrder("rows", "nonNull", "nulls", "blanks", "distinct", "uniqueness", "min", "max", "mean", "sum", "stddev", + "p1", "p5", "p25", "p50", "p75", "p95", "p99", "zeros", "negatives", "outliers", "minLength", "maxLength", "meanLength", "true", "false", "range"); + ColumnProfile amount = service.columnProfile(column("amount")); + assertThat(metric(amount.getNumeric().getMetrics(), "sum").getFormatted()).isEqualTo("$1,170.00"); + assertThat(amount.getNumeric().getHistogram()).allSatisfy(v -> assertThat(v.getLabel()).contains("$")); + Metric uniqueness = metric(amount.getCounts(), "uniqueness"); + assertThat(uniqueness.getValueType().name()).isEqualTo("PERCENT"); + assertThat(uniqueness.getValue().toString()).isEqualTo("0.727273"); + assertThat(uniqueness.getFormatted()).isEqualTo("72.7%"); + assertThat(metric(service.columnProfile(column("created")).getDates().getMetrics(), "min").getFormatted()).isEqualTo("2026-01-01 06:00"); + assertThat(service.columnProfile(column("note")).getWarnings()).isEmpty(); + var table = service.tableProfile(new TableProfileRequest().withTableName("orders").withFields(List.of("note"))); + assertThat(table.getRowCount().getLabel()).isEqualTo("Rows"); + assertThat(table.getFields().getFirst().getNulls().getLabel()).isEqualTo("Nulls"); + assertThat(table.getFields().getFirst().getBlanks().getLabel()).isEqualTo("Blanks"); + } + + /******************************************************************************* + ** Decimal moments retain ten significant digits; drills retain exact membership. *******************************************************************************/ @Test void numericProfile() throws Exception @@ -80,12 +133,12 @@ abstract class EngineContractTest extends EngineFixture Map.entry("zeros", "2"), Map.entry("negatives", "1"), Map.entry("outliers", "1")); for(var entry : expected.entrySet()) { - assertMetric(result.getNumeric().getMetrics(), entry.getKey(), entry.getValue()); + assertMetric(result.getNumeric().getMetrics(), entry.getKey(), new BigDecimal(entry.getValue()).round(new java.math.MathContext(10)).toPlainString()); } double[] values = {-10, 0, 0, 10, 10, 20, 20, 30, 40, 50, 1000}; double mean = 1170.0 / 11; double variance = java.util.Arrays.stream(values).map(v -> Math.pow(v - mean, 2)).sum() / 10; - assertMetric(result.getNumeric().getMetrics(), "stddev", Double.toString(Math.sqrt(variance))); + assertMetric(result.getNumeric().getMetrics(), "stddev", BigDecimal.valueOf(Math.sqrt(variance)).round(new java.math.MathContext(10)).toPlainString()); assertThat(result.getNumeric().getHistogram()).hasSize(22); assertThat(result.getNumeric().getHistogram().stream().mapToLong(v -> v.getCount()).sum()).isEqualTo(11); assertThat(result.getNumeric().getOutliers()).singleElement().satisfies(v -> assertThat(new BigDecimal(v.getValue().toString())).isEqualByComparingTo("1000")); @@ -156,7 +209,7 @@ abstract class EngineContractTest extends EngineFixture assertThat(table.getFields()).anySatisfy(f -> { assertThat(f.getField()).isEqualTo("note"); - assertThat(f.getCompleteness().doubleValue()).isCloseTo(8.0 / 12, within(1e-9)); + assertThat(f.getCompleteness().doubleValue()).isEqualTo(0.666667); }); assertThat(table.getCandidateKeys()).anyMatch(k -> k.getFields().equals(List.of("id"))); var pairs = service.tableProfile(new TableProfileRequest().withTableName("orders").withFields(List.of("status", "quantity"))); @@ -409,7 +462,7 @@ abstract class EngineContractTest extends EngineFixture assertThat(ColumnProfiler.autoBucket(first, first.plusYears(2).plusDays(1))).isEqualTo(AnalysisBackend.DateUnit.MONTH); assertThat(ColumnProfiler.autoBucket(first, first.plusYears(10))).isEqualTo(AnalysisBackend.DateUnit.MONTH); assertThat(ColumnProfiler.autoBucket(first, first.plusYears(10).plusDays(1))).isEqualTo(AnalysisBackend.DateUnit.YEAR); - for(AnalysisBackend.DateUnit unit : List.of(AnalysisBackend.DateUnit.WEEK, AnalysisBackend.DateUnit.MONTH, AnalysisBackend.DateUnit.YEAR)) + for(AnalysisBackend.DateUnit unit : List.of(AnalysisBackend.DateUnit.WEEK, AnalysisBackend.DateUnit.MONTH, AnalysisBackend.DateUnit.QUARTER, AnalysisBackend.DateUnit.YEAR)) { var buckets = service.backend("orders").dateBuckets("orders", null, "order_date", unit, java.time.ZoneId.of("America/Chicago")); assertThat(buckets.stream().mapToLong(AnalysisBackend.GroupCount::count).sum()).isEqualTo(12); diff --git a/src/test/java/com/kingsrook/qbits/dataanalysis/EngineFixture.java b/src/test/java/com/kingsrook/qbits/dataanalysis/EngineFixture.java index 8642f4f..8c4105a 100644 --- a/src/test/java/com/kingsrook/qbits/dataanalysis/EngineFixture.java +++ b/src/test/java/com/kingsrook/qbits/dataanalysis/EngineFixture.java @@ -31,6 +31,7 @@ import com.kingsrook.qqq.backend.core.context.QContext; import com.kingsrook.qqq.backend.core.instances.QInstanceEnricher; 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.metadata.fields.DisplayFormat; 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.possiblevalues.QPossibleValue; @@ -96,7 +97,7 @@ abstract class EngineFixture .withPermissionRules(DataAnalysisTables.permissionRules("orders")) .withField(new QFieldMetaData("id", QFieldType.INTEGER)).withField(new QFieldMetaData("customer", QFieldType.INTEGER).withPossibleValueSourceName("customer")) .withField(new QFieldMetaData("status", QFieldType.STRING).withPossibleValueSourceName("statusValues")) - .withField(new QFieldMetaData("amount", QFieldType.DECIMAL)).withField(new QFieldMetaData("quantity", QFieldType.INTEGER)) + .withField(new QFieldMetaData("amount", QFieldType.DECIMAL).withDisplayFormat(DisplayFormat.CURRENCY)).withField(new QFieldMetaData("quantity", QFieldType.INTEGER)) .withField(new QFieldMetaData("order_date", QFieldType.DATE)).withField(new QFieldMetaData("created", QFieldType.DATE_TIME)) .withField(new QFieldMetaData("note", QFieldType.STRING)).withField(new QFieldMetaData("paid", QFieldType.BOOLEAN)) .withField(new QFieldMetaData("modifyDate", QFieldType.DATE_TIME).withBackendName("modify_date")) diff --git a/src/test/java/com/kingsrook/qbits/dataanalysis/PresentationSamplingTest.java b/src/test/java/com/kingsrook/qbits/dataanalysis/PresentationSamplingTest.java new file mode 100644 index 0000000..b4a7ec4 --- /dev/null +++ b/src/test/java/com/kingsrook/qbits/dataanalysis/PresentationSamplingTest.java @@ -0,0 +1,115 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis; + +import java.time.Instant; +import java.time.ZoneId; +import java.util.ArrayList; +import java.util.List; +import com.kingsrook.qbits.dataanalysis.engine.AnalysisBackend; +import com.kingsrook.qbits.dataanalysis.engine.DrillFilters; +import com.kingsrook.qbits.dataanalysis.result.ColumnProfileRequest; +import com.kingsrook.qqq.backend.core.actions.tables.InsertAction; +import com.kingsrook.qqq.backend.core.model.actions.tables.insert.InsertInput; +import com.kingsrook.qqq.backend.core.model.actions.tables.query.QCriteriaOperator; +import com.kingsrook.qqq.backend.core.model.data.QRecord; +import org.junit.jupiter.api.Test; +import static org.assertj.core.api.Assertions.assertThat; + +/******************************************************************************* + ** Real rows prove warning boundaries and date coordinates without Docker. + *******************************************************************************/ +class PresentationSamplingTest extends EngineFixture +{ + /******************************************************************************* + ** Null prefixes do not consume the budget; warn only after 10,000 values. + *******************************************************************************/ + @Test + void patternWarningOnlyWhenTruncated() throws Exception + { + List records = new ArrayList<>(); + for(int i = 100; i <= 10101; i++) + { + records.add(new QRecord().withValue("id", i).withValue("customer", 1).withValue("note", i == 100 ? null : "AA-11")); + } + assertThat(new InsertAction().execute(new InsertInput("orders").withRecords(records)).getRecords()).allSatisfy(r -> assertThat(r.getErrors()).isNullOrEmpty()); + var filter = DrillFilters.condition("id", QCriteriaOperator.GREATER_THAN_OR_EQUALS, 100); + var request = new ColumnProfileRequest().withTableName("orders").withFieldName("note").withFilter(filter).withExact(true); + var truncated = service.columnProfile(request); + assertThat(truncated.getText().getSampleRows()).isEqualTo(10000); + assertThat(truncated.getWarnings()).containsExactly("Patterns are based on the first 10,000 values."); + request.withFilter(DrillFilters.and(filter, DrillFilters.condition("id", QCriteriaOperator.LESS_THAN_OR_EQUALS, 10100))); + var all = service.columnProfile(request); + assertThat(all.getText().getSampleRows()).isEqualTo(10000); + assertThat(all.getWarnings()).isEmpty(); + } + + + + /******************************************************************************* + ** Empty samples are not empty populations; full scans are not estimates. + *******************************************************************************/ + @Test + void warningsDescribeObservedScope() throws Exception + { + config.withDefaultSampleThresholdRows(1).withDefaultSampleRows(100); + var request = new ColumnProfileRequest().withTableName("orders").withFieldName("note"); + var complete = service.columnProfile(request); + assertThat(complete.getEstimate()).isFalse(); + assertThat(complete.getWarnings()).isEmpty(); + config.withDefaultSampleRows(0); + service.getConfigResolver().invalidate(); + var emptySample = service.columnProfile(request); + assertThat(emptySample.getWarnings()).contains("No sample rows were observed; run exact for exact numbers.") + .doesNotContain("No readable records match this analysis scope.", "All values in this analysis scope are null."); + var empty = service.columnProfile(request.withExact(true).withFilter(DrillFilters.condition("id", QCriteriaOperator.EQUALS, -1))); + assertThat(empty.getWarnings()).containsExactly("No readable records match this analysis scope."); + var nulls = service.columnProfile(request.withFilter(DrillFilters.condition("id", QCriteriaOperator.EQUALS, 1))); + assertThat(nulls.getWarnings()).containsExactly("All values in this analysis scope are null."); + } + + + + /******************************************************************************* + ** Hour buckets cross DST in real elapsed hours and preserve ISO instants. + *******************************************************************************/ + @Test + void hourlyBucketCoordinatesAndLabels() throws Exception + { + var backend = service.backend("orders"); + ZoneId zone = ZoneId.of("America/Chicago"); + var buckets = backend.dateBuckets("orders", null, "created", AnalysisBackend.DateUnit.HOUR, zone); + assertThat(buckets.getFirst().value()).isEqualTo(Instant.parse("2026-01-01T12:00:00Z")); + assertThat(buckets.getFirst().label()).isEqualTo("2026-01-01 06:00"); + assertThat(buckets.stream().mapToLong(AnalysisBackend.GroupCount::count).sum()).isEqualTo(12); + for(var bucket : buckets) + { + assertThat(backend.count("orders", bucket.condition())).isEqualTo(bucket.count()); + } + TestSupport.insert("orders", new QRecord().withValue("id", 20).withValue("customer", 1).withValue("created", Instant.parse("2026-11-01T06:30:00Z"))); + TestSupport.insert("orders", new QRecord().withValue("id", 21).withValue("customer", 1).withValue("created", Instant.parse("2026-11-01T07:30:00Z"))); + var filter = DrillFilters.condition("id", QCriteriaOperator.GREATER_THAN_OR_EQUALS, 20); + var dst = backend.dateBuckets("orders", filter, "created", AnalysisBackend.DateUnit.HOUR, zone); + assertThat(dst).hasSize(2).allSatisfy(b -> assertThat(b.label()).isEqualTo("2026-11-01 01:00")); + assertThat(dst).extracting(AnalysisBackend.GroupCount::value).doesNotHaveDuplicates(); + assertThat(dst).allSatisfy(b -> assertThat(b.count()).isEqualTo(1)); + } +} -- 2.54.0 From d591d3d7e84db3a4a920842b8c5908d47ff84654 Mon Sep 17 00:00:00 2001 From: James Maes Date: Tue, 13 Oct 2026 18:56:37 -0500 Subject: [PATCH 4/5] feat(pivot): pivot / group-by explorer and the field-access resolver seam POST /tables/{table}/pivot (extension 1.1.0): up to 3 row and 2 column dimensions with date buckets or nice numeric bins, fields from to-one exposed joins, count/sum/avg/min/max/distinct/percentile measures, totals, Other-merging by top-N, the privacy guard and a drill per cell. FieldAnalysisAccessResolver maps fields to FULL / EXACT_MATCH_ONLY / NONE (core secured-data tiers when present, FieldSecurityLock otherwise); only FULL fields are analyzable, drills never name others, and exact-run cache keys include the user's field-access fingerprint. Co-Authored-By: Claude Opus 5.5 --- CHANGELOG.md | 8 +- README.md | 21 +- .../dataanalysis/DataAnalysisQBitConfig.java | 21 + .../dataanalysis/DataAnalysisService.java | 56 +- .../dataanalysis/api/DataAnalysisApi.java | 89 ++- .../dataanalysis/api/DataAnalysisSchemas.java | 285 ++++++++ .../engine/AnalysisDrillGuard.java | 168 +++++ .../dataanalysis/engine/AnalysisLabels.java | 26 +- .../dataanalysis/engine/AnalysisSecurity.java | 64 +- .../dataanalysis/engine/ColumnProfiler.java | 12 +- .../engine/CoreTierFieldAccessResolver.java | 118 ++++ .../dataanalysis/engine/DistinctValues.java | 12 +- .../engine/FieldAnalysisAccess.java | 29 + .../engine/FieldAnalysisAccessResolver.java | 43 ++ .../FieldSecurityLockFieldAccessResolver.java | 42 ++ .../engine/MinGroupSizeGuard.java | 12 + .../qbits/dataanalysis/engine/NiceBins.java | 12 +- .../dataanalysis/engine/PivotExplorer.java | 607 ++++++++++++++++++ .../dataanalysis/engine/ProfileSupport.java | 11 +- .../qbits/dataanalysis/result/PivotCell.java | 89 +++ .../dataanalysis/result/PivotDimension.java | 88 +++ .../dataanalysis/result/PivotHeader.java | 69 ++ .../dataanalysis/result/PivotMeasure.java | 95 +++ .../dataanalysis/result/PivotMeasureInfo.java | 87 +++ .../dataanalysis/result/PivotNumericBins.java | 88 +++ .../dataanalysis/result/PivotRequest.java | 182 ++++++ .../dataanalysis/result/PivotResult.java | 252 ++++++++ .../dataanalysis/run/AnalysisRunService.java | 3 +- .../openapi/qqq-v1/data-analysis.yaml | 235 ++++++- .../dataanalysis/CoreAnalysisBackendTest.java | 24 + .../dataanalysis/DataAnalysisApiTest.java | 41 +- .../dataanalysis/EngineContractTest.java | 6 +- .../dataanalysis/FieldAnalysisAccessTest.java | 244 +++++++ .../qbits/dataanalysis/PivotContractTest.java | 350 ++++++++++ 34 files changed, 3447 insertions(+), 42 deletions(-) create mode 100644 src/main/java/com/kingsrook/qbits/dataanalysis/engine/AnalysisDrillGuard.java create mode 100644 src/main/java/com/kingsrook/qbits/dataanalysis/engine/CoreTierFieldAccessResolver.java create mode 100644 src/main/java/com/kingsrook/qbits/dataanalysis/engine/FieldAnalysisAccess.java create mode 100644 src/main/java/com/kingsrook/qbits/dataanalysis/engine/FieldAnalysisAccessResolver.java create mode 100644 src/main/java/com/kingsrook/qbits/dataanalysis/engine/FieldSecurityLockFieldAccessResolver.java create mode 100644 src/main/java/com/kingsrook/qbits/dataanalysis/engine/PivotExplorer.java create mode 100644 src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotCell.java create mode 100644 src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotDimension.java create mode 100644 src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotHeader.java create mode 100644 src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotMeasure.java create mode 100644 src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotMeasureInfo.java create mode 100644 src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotNumericBins.java create mode 100644 src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotRequest.java create mode 100644 src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotResult.java create mode 100644 src/test/java/com/kingsrook/qbits/dataanalysis/FieldAnalysisAccessTest.java create mode 100644 src/test/java/com/kingsrook/qbits/dataanalysis/PivotContractTest.java diff --git a/CHANGELOG.md b/CHANGELOG.md index 3424b6f..66c54b8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,13 @@ Following [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and [Semantic ### Added -- `data-analysis` UI API extension 1.0.0: seven session-bound profile, capability, distinct-value, duplicate and run endpoints, typed schemas and a checked OpenAPI fragment. +- Phase c pivot backend and `POST /qbit/data-analysis/tables/{table}/pivot`, extension version 1.1.0, typed schemas and regenerated OpenAPI fragment. +- Row/column dimensions, calendar/numeric buckets, seven measure operators, sparse cells, exact Other recomputation, totals, privacy suppression and count-equivalent drills. +- Exposed-join dimensions and measures with READ/FULL checks; filter-only drills for to-one paths and explicit null-drill warnings for to-many paths whose joined-row counts can exceed record counts. +- Configurable field-access resolver, cached reflective core tier bridge with legacy fallback, FULL-only capabilities/selections/labels, generated-drill protection and field-access cache fingerprints. +- Shared memory/H2/PostgreSQL pivot contracts, HTTP drills and errors, reflective resolver/fallback and tier-change cache tests. + +- Session-bound profile, capability, distinct-value, duplicate and run endpoints, typed schemas and a checked OpenAPI fragment (introduced in extension 1.0.0). - Core table-feature permission registration and capability-directed aggregate pushdown, with native sampling and portable streamed fallbacks. - HTTP authorization, drill-to-core-count round trips, async polling, served OpenAPI and assistant discovery tests; H2 streamed and native-compatibility contract variants. diff --git a/README.md b/README.md index 43e4329..48c0ff4 100644 --- a/README.md +++ b/README.md @@ -138,7 +138,7 @@ Count drills combine an untouched copy of the request filter with their producin ## HTTP endpoints -Extension `data-analysis` version **1.0.0**, prefix `/qbit/data-analysis` inside `/qqq/v1`: +Extension `data-analysis` version **1.1.0**, prefix `/qbit/data-analysis` inside `/qqq/v1`: | Method | Path after `/qqq/v1` | Body or purpose | | --- | --- | --- | @@ -147,12 +147,13 @@ Extension `data-analysis` version **1.0.0**, prefix `/qbit/data-analysis` inside | POST | `/qbit/data-analysis/tables/{table}/distinct-values` | `{fieldName, filter, page, pageSize, search}` | | POST | `/qbit/data-analysis/tables/{table}/table-profile` | `{filter, fields}` | | POST | `/qbit/data-analysis/tables/{table}/duplicates` | `{fields, filter, limit}`; default limit 50, maximum 500 | +| POST | `/qbit/data-analysis/tables/{table}/pivot` | `{rows, columns, values, filter, showTotals, limitGroups}`; 1–3 row dimensions, 0–2 column dimensions, 1–6 measures | | POST | `/qbit/data-analysis/runs` | `{operation: COLUMN_PROFILE or TABLE_PROFILE, tableName, request}` returns `{runId, status}` | | GET | `/qbit/data-analysis/runs/{runId}` | Status, timestamps, error, typed `columnProfile` or `tableProfile` | Every operation uses the request session through `DataAnalysisService`. Capabilities returns 200 with `canAnalyze: false` and no fields when denied. Other permission denials return 403, bad bodies or unavailable fields return 400, and unknown tables return 404. Core middleware supplies plain messages in its standard `{error: message}` JSON envelope. Run rows remain owner-locked. -Requests and drills reuse core's `QueryFilter` JSON shape and schema reference. Versioned `DataAnalysis...V1` schemas cover profiles, metrics, drills, charts, series, points, field summaries, distinct and duplicate results, capabilities and runs. The [OpenAPI fragment](src/main/resources/openapi/qqq-v1/data-analysis.yaml) is checked against regeneration. The deployed `/qqq/v1/openapi.json` and `UiApiInvoker.listOperations()` include all seven operations. +Requests and drills reuse core's `QueryFilter` JSON shape and schema reference. Versioned `DataAnalysis...V1` schemas cover profiles, metrics, drills, charts, series, points, field summaries, distinct and duplicate results, capabilities and runs. The [OpenAPI fragment](src/main/resources/openapi/qqq-v1/data-analysis.yaml) is checked against regeneration. The deployed `/qqq/v1/openapi.json` and `UiApiInvoker.listOperations()` include all eight operations. Regenerate deliberately after an API change: @@ -160,6 +161,20 @@ Regenerate deliberately after an API change: ./mvnw -o -q test -Dtest=DataAnalysisApiTest#contract -Dopenapi.write=true -Dqqq.snapshot.version=4.1.0-DATAANALYSIS-SNAPSHOT ``` +## Pivot backend and field access + +`DataAnalysisService.pivot(PivotRequest)` returns sparse cells indexed into row/column header tuples, aligned totals, typed/formatted metrics, warnings and `asOf`. `COUNT` counts records (including null measure values); other operators require a field. `PERCENTILE` uses continuous interpolation with a fraction from 0 to 1. Calendar buckets use the session timezone. Numeric bins reuse profile nice-edge selection when explicit bounds are omitted; the last interior bin includes its maximum. + +The planner first requests count-ordered top-N groups for every dimension (default 50, maximum 200), then dimension counts for privacy/cardinality, one grouped matrix and one aggregate per totals level. Additional aggregates recompute merged Other cells/totals: averages, distinct counts and percentiles cannot safely be combined from displayed cells. Ordinary Other predicates exclude kept values and handle null/empty strings separately. Boolean, temporal and bucketed Other groups use equivalent membership/range predicates for core HTTP compatibility. Cyclic date predicates enumerate observed values through core grouping; memory numeric boundaries reuse the profiles' decimal-scale compatibility helper. Native pivots are exact; bounded core streamed fallback marks partial results as estimates and disables their drills. + +`joinTable.field` resolves only through an unambiguous exposed join path. Every table in that path requires READ and the selected field must be FULL; core enforces joins and record locks. The installed data-analysis snapshot does not contain the related-record picker path API, so this implementation uses `getExposedJoins()` and `QueryJoin`. Paths whose every hop is MANY_TO_ONE or ONE_TO_ONE in the analyzed direction support ordinary filter-only drills: core infers the joins from qualified criteria. To-many paths can multiply a base record, so their pivots retain null drills and warn that counts include one row per related table record. + +`min_group_size` suppresses rare dimension groups and rare row/column tuples; every measure of a small cell or total is suppressed, including COUNT, with no drill. Totals include the full authorized population. As with existing profiles, separate aggregate calls are not a transactional snapshot. + +Hosts can supply `withFieldAnalysisAccessResolver(() -> resolver)`. FULL fields alone appear in capabilities and may be selected. EXACT_MATCH_ONLY and NONE get the same 400 as an unknown field; user-authored filters are passed through for core enforcement. Generated drills using a restricted field (including representative primary keys) are disabled. Related PVS display labels also require FULL access. Exact-run cache identities hash the sorted FULL-field list, the optional core access fingerprint, and related label access. + +The default resolver discovers the optional core `fieldaccess.FieldAccessHelper` class and its static methods once. FULL maps to FULL, REVEALABLE to EXACT_MATCH_ONLY, MASKED/HIDDEN to NONE. Without that class, legacy field locks supply FULL/NONE. Replace the reflective calls when the core package ships. Reflection tests use a local stand-in helper rather than shadowing a future real core class at its FQN; the installed snapshot exercises the actual fallback selection. Exact-run persistence continues to support profiles only; pivot results are synchronous. + ## Backend selection `DataAnalysisService` selects `CoreAnalysisBackend` when the source backend advertises aggregate capabilities, including memory. Supported standard deviation, percentiles, null/blank counts, numeric/date buckets and length statistics execute through core aggregates as the current session. Unsupported primitives delegate to `StandInAnalysisBackend`. Patterns and derived length histograms remain streamed; representative distinct drills and cyclic-date membership use bounded scans. @@ -180,7 +195,7 @@ Data versions use filtered COUNT plus MAX of a readable modification-date-like f 4. Review per-table include/exclude sets, limits and minimum group sizes before enabling analysis. Integrate Saved Analyses and Watches with host ESB/Quick Search when those optional host features are installed; this scaffold does not add those dependencies. 5. Use the Analyses home as the owner of analysis data. Other dashboards should link there until saved-analysis widgets are implemented. -Phase **b** profiles, drill-through, runs/cache and HTTP endpoints are implemented. Remaining work: **b** analysis UI; **c** pivots; **d** comparisons and relationships; **e** watch evaluation and alerts; **f** saved-analysis execution, sharing, stars integration, schedules, chart widgets, full home and exports. The current home summarizes stored rows; the host facade executes profiles. The home does not send deliveries. +Phase **b** profiles, drill-through, runs/cache and HTTP endpoints, and phase **c** pivot backend are implemented. Remaining work: **b** analysis UI; **c** pivot UI; **d** comparisons and relationships; **e** watch evaluation and alerts; **f** saved-analysis execution, sharing, stars integration, schedules, chart widgets, full home and exports. The current home summarizes stored rows; the host facade executes profiles. The home does not send deliveries. ## Build diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/DataAnalysisQBitConfig.java b/src/main/java/com/kingsrook/qbits/dataanalysis/DataAnalysisQBitConfig.java index 384b1b3..6120fa9 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/DataAnalysisQBitConfig.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/DataAnalysisQBitConfig.java @@ -26,6 +26,9 @@ import java.util.LinkedHashSet; import java.util.List; import java.util.Map; import java.util.Set; +import java.util.function.Supplier; +import com.kingsrook.qbits.dataanalysis.engine.CoreTierFieldAccessResolver; +import com.kingsrook.qbits.dataanalysis.engine.FieldAnalysisAccessResolver; import com.kingsrook.qqq.backend.core.model.metadata.QInstance; import com.kingsrook.qqq.backend.core.model.metadata.qbits.QBitConfig; @@ -35,6 +38,7 @@ import com.kingsrook.qqq.backend.core.model.metadata.qbits.QBitConfig; *******************************************************************************/ public class DataAnalysisQBitConfig implements QBitConfig { + private Supplier fieldAnalysisAccessResolver = CoreTierFieldAccessResolver::defaultResolver; private String backendName; private String schedulerName; private String appName = "dataAnalysis"; @@ -387,4 +391,21 @@ public class DataAnalysisQBitConfig implements QBitConfig this.tableDefaults = tableDefaults; return (this); } + + /******************************************************************************* + ** Host override for session-aware field analysis access. + *******************************************************************************/ + public Supplier getFieldAnalysisAccessResolver() + { + return (fieldAnalysisAccessResolver); + } + + /******************************************************************************* + ** Configure an instance supplier; each service resolves one policy instance. + *******************************************************************************/ + public DataAnalysisQBitConfig withFieldAnalysisAccessResolver(Supplier resolver) + { + this.fieldAnalysisAccessResolver = java.util.Objects.requireNonNull(resolver); + return (this); + } } diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/DataAnalysisService.java b/src/main/java/com/kingsrook/qbits/dataanalysis/DataAnalysisService.java index c6b106d..729b33a 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/DataAnalysisService.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/DataAnalysisService.java @@ -21,14 +21,21 @@ package com.kingsrook.qbits.dataanalysis; import java.util.List; +import java.util.Map; +import java.util.Set; import java.util.concurrent.Executor; import com.kingsrook.qbits.dataanalysis.engine.AnalysisBackend; +import com.kingsrook.qbits.dataanalysis.engine.AnalysisDrillGuard; +import com.kingsrook.qbits.dataanalysis.engine.AnalysisLabels; import com.kingsrook.qbits.dataanalysis.engine.AnalysisSecurity; import com.kingsrook.qbits.dataanalysis.engine.ColumnProfiler; import com.kingsrook.qbits.dataanalysis.engine.CoreAnalysisBackend; import com.kingsrook.qbits.dataanalysis.engine.DistinctValues; +import com.kingsrook.qbits.dataanalysis.engine.DrillFilters; import com.kingsrook.qbits.dataanalysis.engine.DuplicateFinder; import com.kingsrook.qbits.dataanalysis.engine.EffectiveConfigResolver; +import com.kingsrook.qbits.dataanalysis.engine.FieldAnalysisAccessResolver; +import com.kingsrook.qbits.dataanalysis.engine.PivotExplorer; import com.kingsrook.qbits.dataanalysis.engine.StandInAnalysisBackend; import com.kingsrook.qbits.dataanalysis.engine.TableProfiler; import com.kingsrook.qbits.dataanalysis.result.AnalysisRequest; @@ -39,6 +46,8 @@ import com.kingsrook.qbits.dataanalysis.result.DistinctValuesPage; import com.kingsrook.qbits.dataanalysis.result.DistinctValuesRequest; import com.kingsrook.qbits.dataanalysis.result.DuplicatesRequest; import com.kingsrook.qbits.dataanalysis.result.DuplicatesResult; +import com.kingsrook.qbits.dataanalysis.result.PivotRequest; +import com.kingsrook.qbits.dataanalysis.result.PivotResult; import com.kingsrook.qbits.dataanalysis.result.RunStatus; import com.kingsrook.qbits.dataanalysis.result.TableProfile; import com.kingsrook.qbits.dataanalysis.result.TableProfileRequest; @@ -53,6 +62,7 @@ public class DataAnalysisService { private final EffectiveConfigResolver configs; private final AnalysisSecurity security; + private final FieldAnalysisAccessResolver fieldAccess; private final AnalysisRunService runs; /******************************************************************************* @@ -71,7 +81,8 @@ public class DataAnalysisService public DataAnalysisService(DataAnalysisQBitConfig config, Executor executor) { configs = new EffectiveConfigResolver(config); - security = new AnalysisSecurity(configs); + fieldAccess = config.getFieldAnalysisAccessResolver().get(); + security = new AnalysisSecurity(configs, fieldAccess); runs = new AnalysisRunService(this, executor); } @@ -116,7 +127,7 @@ public class DataAnalysisService public DistinctValuesPage distinctValues(DistinctValuesRequest request) throws QException { validate(request); - return (new DistinctValues(backend(request.getTableName())).page(request, security.field(request.getTableName(), request.getFieldName()), configs.resolve(request.getTableName()))); + return (protect(new DistinctValues(backend(request.getTableName()), fieldAccess).page(request, security.field(request.getTableName(), request.getFieldName()), configs.resolve(request.getTableName())), request)); } @@ -127,7 +138,7 @@ public class DataAnalysisService public DuplicatesResult duplicates(DuplicatesRequest request) throws QException { validate(request); - return (new DuplicateFinder(backend(request.getTableName())).find(request, configs.resolve(request.getTableName()))); + return (protect(new DuplicateFinder(backend(request.getTableName())).find(request, configs.resolve(request.getTableName())), request)); } @@ -219,7 +230,7 @@ public class DataAnalysisService public ColumnProfile compute(ColumnProfileRequest request, AnalysisBackend backend, AnalysisBackend.Scope scope) throws QException { validate(request); - return (new ColumnProfiler(backend).profile(request, security.field(request.getTableName(), request.getFieldName()), scope, configs.resolve(request.getTableName()))); + return (protect(new ColumnProfiler(backend, fieldAccess).profile(request, security.field(request.getTableName(), request.getFieldName()), scope, configs.resolve(request.getTableName())), request)); } @@ -232,6 +243,41 @@ public class DataAnalysisService validate(request); List fields = security.analyzableFields(request.getTableName()).stream() .filter(f -> request.getFields() == null || request.getFields().contains(f.getName())).toList(); - return (new TableProfiler(backend).profile(request, fields, scope)); + return (protect(new TableProfiler(backend).profile(request, fields, scope), request)); + } + + /******************************************************************************* + ** Field policy identity is re-evaluated before cache reads and writes. + *******************************************************************************/ + public String fieldAccessFingerprint(String table) throws QException + { + return (security.accessFingerprint(table)); + } + + /******************************************************************************* + ** Execute a pivot as the current user through core aggregates. + *******************************************************************************/ + public PivotResult pivot(PivotRequest request) throws QException + { + validate(request); + return (new PivotExplorer(security, configs.resolve(request.getTableName())).execute(request)); + } + + /******************************************************************************* + ** Generated primary-key drills also obey the configured field-access seam. + *******************************************************************************/ + private T protect(T result, AnalysisRequest request) throws QException + { + new AnalysisDrillGuard(Set.copyOf(capabilities(request.getTableName()).getFields()), + DrillFilters.restoreTypes(request.getTableName(), request.getFilter())).apply(result); + return (result); + } + + /******************************************************************************* + ** Include resolved tiers of related label fields in cache identity. + *******************************************************************************/ + public Map fieldAccessPolicy(String table) throws QException + { + return (AnalysisLabels.policy(table, fieldAccess)); } } diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/api/DataAnalysisApi.java b/src/main/java/com/kingsrook/qbits/dataanalysis/api/DataAnalysisApi.java index 2aeb0df..9951b86 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/api/DataAnalysisApi.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/api/DataAnalysisApi.java @@ -30,6 +30,7 @@ import com.kingsrook.qbits.dataanalysis.result.ChartKind; import com.kingsrook.qbits.dataanalysis.result.ColumnProfileRequest; import com.kingsrook.qbits.dataanalysis.result.DistinctValuesRequest; import com.kingsrook.qbits.dataanalysis.result.DuplicatesRequest; +import com.kingsrook.qbits.dataanalysis.result.PivotRequest; import com.kingsrook.qbits.dataanalysis.result.TableProfileRequest; import com.kingsrook.qqq.backend.core.context.QContext; import com.kingsrook.qqq.backend.core.exceptions.QBadRequestException; @@ -70,10 +71,10 @@ public class DataAnalysisApi *******************************************************************************/ public static MiddlewareSpecExtension extension() { - return (new MiddlewareSpecExtension().withName("data-analysis").withSemanticVersion("1.0.0") - .withDescription("Profiles, distinct values, duplicate groups and exact analysis runs as the signed-in user.") + return (new MiddlewareSpecExtension().withName("data-analysis").withSemanticVersion("1.1.0") + .withDescription("Profiles, pivots, distinct values, duplicate groups and exact analysis runs as the signed-in user.") .withSpec(CapabilitiesSpec.class).withSpec(ColumnProfileSpec.class).withSpec(DistinctValuesSpec.class) - .withSpec(TableProfileSpec.class).withSpec(DuplicatesSpec.class).withSpec(StartRunSpec.class).withSpec(GetRunSpec.class)); + .withSpec(PivotSpec.class).withSpec(TableProfileSpec.class).withSpec(DuplicatesSpec.class).withSpec(StartRunSpec.class).withSpec(GetRunSpec.class)); } /******************************************************************************* @@ -184,7 +185,7 @@ public class DataAnalysisApi throw new IllegalArgumentException("exact must be a boolean."); } QQueryFilter filter = body.get("filter") == null ? null : JsonUtils.toObject(JsonUtils.toJson(body.get("filter")), QQueryFilter.class); - validateFilter(filter, readable); + validateFilter(filter); List fields = null; if(body.get("fields") != null) { @@ -224,7 +225,7 @@ public class DataAnalysisApi /******************************************************************************* ** Bad filter fields fail before any aggregate or cached result is consulted. *******************************************************************************/ - private static void validateFilter(QQueryFilter filter, List readable) + private static void validateFilter(QQueryFilter filter) { if(filter == null) { @@ -232,13 +233,12 @@ public class DataAnalysisApi } for(var criterion : filter.getCriteria()) { - if(criterion.getOperator() == null || !readable.contains(criterion.getFieldName()) - || criterion.getOtherFieldName() != null && !readable.contains(criterion.getOtherFieldName())) + if(criterion.getOperator() == null || criterion.getFieldName() == null) { throw new IllegalArgumentException("Choose readable filter fields and a valid operator."); } } - filter.getSubFilters().forEach(sub -> validateFilter(sub, readable)); + filter.getSubFilters().forEach(sub -> validateFilter(sub)); } /******************************************************************************* @@ -504,4 +504,77 @@ public class DataAnalysisApi }; return (result); } + + /******************************************************************************* + ** Group records by row and column dimensions. + *******************************************************************************/ + public static class PivotSpec extends ProfileSpec + { + /******************************************************************************* + ** Publish assistant-friendly grouping and measure capabilities. + *******************************************************************************/ + public PivotSpec() + { + super("/tables/{table}/pivot", HttpMethod.POST, "Explore a pivot table", + "Group records by up to 3 row and 2 column fields (with date or numeric buckets) and compute counts, sums, averages, min/max, distinct counts or percentiles per cell; every cell has a drill-through filter.", "PivotRequest", "Pivot"); + } + + /******************************************************************************* + ** Strict body validation precedes the session-bound engine. + *******************************************************************************/ + @Override + protected Object handle(JsonInput input) throws Exception + { + String tableName = input.getPathParam("table"); + table(tableName); + DataAnalysisRuntime.service().capabilities(tableName); + PivotRequest pivot; + try + { + Map body = input.getBody(); + integer(body, "limitGroups", 50, 1, 200); + if(body.containsKey("showTotals") && !(body.get("showTotals") instanceof Boolean)) + { + throw new IllegalArgumentException("showTotals must be a boolean."); + } + for(String axis : List.of("rows", "columns")) + { + if(body.containsKey(axis)) + { + if(!(body.get(axis) instanceof List dimensions)) + { + throw new IllegalArgumentException("Dimensions must be arrays."); + } + for(Object dimension : dimensions) + { + if(!(dimension instanceof Map map) || !(map.get("field") instanceof String)) + { + throw new IllegalArgumentException("Each dimension requires a field name."); + } + if(map.get("numericBins") instanceof Map bins) + { + Object count = bins.get("count"); + if(count != null && (!(count instanceof Number number) || number.doubleValue() != number.intValue())) + { + throw new IllegalArgumentException("Bin count must be an integer."); + } + } + } + } + } + if(!(body.get("values") instanceof List values) || values.stream().anyMatch(v -> !(v instanceof Map m) + || !(m.get("operator") instanceof String) || m.get("field") != null && !(m.get("field") instanceof String))) + { + throw new IllegalArgumentException("Measures require an operator and optional field name."); + } + pivot = JsonUtils.toObject(JsonUtils.toJson(body), PivotRequest.class).withTableName(tableName); + validateFilter(pivot.getFilter()); + } + catch(Exception e) + { + throw new QBadRequestException("Invalid pivot request."); + } + return (transport(DataAnalysisRuntime.service().pivot(pivot), DataAnalysisSchemas.DataAnalysisPivotV1.class)); + } + } } diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/api/DataAnalysisSchemas.java b/src/main/java/com/kingsrook/qbits/dataanalysis/api/DataAnalysisSchemas.java index 151c72e..19faa6e 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/api/DataAnalysisSchemas.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/api/DataAnalysisSchemas.java @@ -106,6 +106,14 @@ public class DataAnalysisSchemas result.put("DataAnalysisLimitsV1", new DataAnalysisLimitsV1().toSchema()); result.put("DataAnalysisStartRunRequestV1", new DataAnalysisStartRunRequestV1().toSchema()); result.put("DataAnalysisRunStartedV1", new DataAnalysisRunStartedV1().toSchema()); + result.put("DataAnalysisPivotRequestV1", new DataAnalysisPivotRequestV1().toSchema()); + result.put("DataAnalysisPivotDimensionV1", new DataAnalysisPivotDimensionV1().toSchema()); + result.put("DataAnalysisPivotNumericBinsV1", new DataAnalysisPivotNumericBinsV1().toSchema()); + result.put("DataAnalysisPivotMeasureV1", new DataAnalysisPivotMeasureV1().toSchema()); + result.put("DataAnalysisPivotHeaderV1", new DataAnalysisPivotHeaderV1().toSchema()); + result.put("DataAnalysisPivotMeasureInfoV1", new DataAnalysisPivotMeasureInfoV1().toSchema()); + result.put("DataAnalysisPivotCellV1", new DataAnalysisPivotCellV1().toSchema()); + result.put("DataAnalysisPivotV1", new DataAnalysisPivotV1().toSchema()); return (result); } @@ -1146,4 +1154,281 @@ public class DataAnalysisSchemas return (new Schema().withType(Type.OBJECT).withNullable(true).withProperties(properties)); } } + + /******************************************************************************* + ** Nested arrays share the same explicit schema construction. + *******************************************************************************/ + private static Schema array(Schema items) + { + return (new Schema().withType(Type.ARRAY).withItems(items)); + } + + /******************************************************************************* + ** PivotRequest version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisPivotRequestV1 implements ToSchema + { + @OpenAPIDescription("User query filter, passed through for core enforcement.") + public QQueryFilter filter; + + @OpenAPIDescription("One to three row dimensions.") + public List rows; + + @OpenAPIDescription("Zero to two column dimensions; defaults to empty.") + public List columns; + + @OpenAPIDescription("One to six measures.") + public List values; + + @OpenAPIDescription("Include row, column and grand totals; defaults to true.") + public Boolean showTotals; + + @OpenAPIDescription("Kept groups per dimension; default 50, maximum 200.") + public Integer limitGroups; + + /******************************************************************************* + ** Explicit references preserve the standalone extension contract. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("filter", ref("QueryFilter").withDescription("User query filter, passed through for core enforcement.")); + properties.put("rows", array(ref("DataAnalysisPivotDimensionV1")).withDescription("One to three row dimensions.")); + properties.put("columns", array(ref("DataAnalysisPivotDimensionV1")).withDescription("Zero to two column dimensions; defaults to empty.")); + properties.put("values", array(ref("DataAnalysisPivotMeasureV1")).withDescription("One to six measures.")); + properties.put("showTotals", new Schema().withType(Type.BOOLEAN).withDescription("Include row, column and grand totals; defaults to true.")); + properties.put("limitGroups", new Schema().withType(Type.INTEGER).withDescription("Kept groups per dimension; default 50, maximum 200.")); + return (new RequiredSchema(List.of("rows", "values")).withType(Type.OBJECT).withProperties(properties)); + } + } + + /******************************************************************************* + ** PivotDimension version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisPivotDimensionV1 implements ToSchema + { + @OpenAPIDescription("FULL field name, optionally joinTable.field through an exposed join.") + public String field; + + @OpenAPIDescription("Optional calendar or cyclic bucket in the session timezone.") + public String dateBucket; + + @OpenAPIDescription("Optional equal-width numeric bins; mutually exclusive with dateBucket.") + public DataAnalysisPivotNumericBinsV1 numericBins; + + /******************************************************************************* + ** Explicit references preserve the standalone extension contract. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("field", new Schema().withType(Type.STRING).withDescription("FULL field name, optionally joinTable.field through an exposed join.")); + properties.put("dateBucket", new Schema().withType(Type.STRING).withEnumValues(List.of("YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "DAY_OF_WEEK", "HOUR_OF_DAY")).withDescription("Optional calendar or cyclic bucket in the session timezone.")); + properties.put("numericBins", ref("DataAnalysisPivotNumericBinsV1").withDescription("Optional equal-width numeric bins; mutually exclusive with dateBucket.")); + return (new RequiredSchema(List.of("field")).withType(Type.OBJECT).withProperties(properties)); + } + } + + /******************************************************************************* + ** PivotNumericBins version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisPivotNumericBinsV1 implements ToSchema + { + @OpenAPIDescription("Number of bins, 1–200; defaults to 20.") + public Integer count; + + @OpenAPIDescription("Optional explicit lower bound; otherwise a nice enclosing edge.") + public BigDecimal min; + + @OpenAPIDescription("Optional explicit upper bound; final interior bin includes this value.") + public BigDecimal max; + + /******************************************************************************* + ** Explicit references preserve the standalone extension contract. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("count", new Schema().withType(Type.INTEGER).withDescription("Number of bins, 1–200; defaults to 20.")); + properties.put("min", new Schema().withType(Type.NUMBER).withDescription("Optional explicit lower bound; otherwise a nice enclosing edge.")); + properties.put("max", new Schema().withType(Type.NUMBER).withDescription("Optional explicit upper bound; final interior bin includes this value.")); + return (new Schema().withType(Type.OBJECT).withProperties(properties)); + } + } + + /******************************************************************************* + ** PivotMeasure version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisPivotMeasureV1 implements ToSchema + { + @OpenAPIDescription("Aggregate operator. COUNT counts records, including null values.") + public String operator; + + @OpenAPIDescription("FULL field to aggregate; optional for COUNT.") + public String field; + + @OpenAPIDescription("PERCENTILE only: percentile_cont fraction from 0 to 1.") + public BigDecimal percentile; + + /******************************************************************************* + ** Explicit references preserve the standalone extension contract. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("operator", new Schema().withType(Type.STRING).withEnumValues(List.of("COUNT", "SUM", "AVG", "MIN", "MAX", "COUNT_DISTINCT", "PERCENTILE")).withDescription("Aggregate operator. COUNT counts records, including null values.")); + properties.put("field", new Schema().withType(Type.STRING).withDescription("FULL field to aggregate; optional for COUNT.")); + properties.put("percentile", new Schema().withType(Type.NUMBER).withDescription("PERCENTILE only: percentile_cont fraction from 0 to 1.")); + return (new RequiredSchema(List.of("operator")).withType(Type.OBJECT).withProperties(properties)); + } + } + + /******************************************************************************* + ** PivotHeader version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisPivotHeaderV1 implements ToSchema + { + @OpenAPIDescription("Typed group key; null for a blank group or Other.") + public Serializable value; + + @OpenAPIDescription("Display label, including Other (k groups).") + public String label; + + /******************************************************************************* + ** Explicit references preserve the standalone extension contract. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("value", new Schema().withNullable(true).withDescription("Typed group key; null for a blank group or Other.")); + properties.put("label", new Schema().withType(Type.STRING).withDescription("Display label, including Other (k groups).")); + return (new Schema().withType(Type.OBJECT).withProperties(properties)); + } + } + + /******************************************************************************* + ** PivotMeasureInfo version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisPivotMeasureInfoV1 implements ToSchema + { + @OpenAPIDescription("Stable measure key by request position.") + public String key; + + @OpenAPIDescription("Display label.") + public String label; + + @OpenAPIDescription("Semantic metric type.") + public ValueType valueType; + + /******************************************************************************* + ** Explicit references preserve the standalone extension contract. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("key", new Schema().withType(Type.STRING).withDescription("Stable measure key by request position.")); + properties.put("label", new Schema().withType(Type.STRING).withDescription("Display label.")); + properties.put("valueType", new Schema().withType(Type.STRING).withEnumValues(java.util.Arrays.stream(ValueType.values()).map(Enum::name).toList()).withDescription("Semantic metric type.")); + return (new Schema().withType(Type.OBJECT).withProperties(properties)); + } + } + + /******************************************************************************* + ** PivotCell version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisPivotCellV1 implements ToSchema + { + @OpenAPIDescription("Zero-based index in rowHeaders.") + public Integer rowIndex; + + @OpenAPIDescription("Zero-based index in columnHeaders.") + public Integer columnIndex; + + @OpenAPIDescription("Metrics in requested measure order; suppressed metrics have no value or drill.") + public List values; + + /******************************************************************************* + ** Explicit references preserve the standalone extension contract. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("rowIndex", new Schema().withType(Type.INTEGER).withDescription("Zero-based index in rowHeaders.")); + properties.put("columnIndex", new Schema().withType(Type.INTEGER).withDescription("Zero-based index in columnHeaders.")); + properties.put("values", array(ref("DataAnalysisMetricV1")).withDescription("Metrics in requested measure order; suppressed metrics have no value or drill.")); + return (new Schema().withType(Type.OBJECT).withProperties(properties)); + } + } + + /******************************************************************************* + ** Pivot version 1 transport contract. + *******************************************************************************/ + public static class DataAnalysisPivotV1 implements ToSchema + { + @OpenAPIDescription("Row header tuples in cell-index order.") + public List> rowHeaders; + + @OpenAPIDescription("Column header tuples; an empty tuple represents no column dimensions.") + public List> columnHeaders; + + @OpenAPIDescription("Measure metadata in request order.") + public List measures; + + @OpenAPIDescription("Sparse cells; absent combinations are not materialized.") + public List cells; + + @OpenAPIDescription("Metric tuples aligned with rowHeaders; empty when totals disabled.") + public List> rowTotals; + + @OpenAPIDescription("Metric tuples aligned with columnHeaders; empty when totals disabled.") + public List> columnTotals; + + @OpenAPIDescription("Grand-total metrics; empty when totals disabled.") + public List grandTotals; + + @OpenAPIDescription("Row groups were merged into Other.") + public Boolean truncatedRows; + + @OpenAPIDescription("Column groups were merged into Other.") + public Boolean truncatedColumns; + + @OpenAPIDescription("True when bounded streamed fallback produced a partial result.") + public Boolean estimate; + + @OpenAPIDescription("Privacy, partial-result and joined-drill limitations.") + public List warnings; + + @OpenAPIDescription("UTC timestamp of computation.") + public String asOf; + + /******************************************************************************* + ** Explicit references preserve the standalone extension contract. + *******************************************************************************/ + @Override + public Schema toSchema() + { + Map properties = new LinkedHashMap<>(); + properties.put("rowHeaders", array(array(ref("DataAnalysisPivotHeaderV1"))).withDescription("Row header tuples in cell-index order.")); + properties.put("columnHeaders", array(array(ref("DataAnalysisPivotHeaderV1"))).withDescription("Column header tuples; an empty tuple represents no column dimensions.")); + properties.put("measures", array(ref("DataAnalysisPivotMeasureInfoV1")).withDescription("Measure metadata in request order.")); + properties.put("cells", array(ref("DataAnalysisPivotCellV1")).withDescription("Sparse cells; absent combinations are not materialized.")); + properties.put("rowTotals", array(array(ref("DataAnalysisMetricV1"))).withDescription("Metric tuples aligned with rowHeaders; empty when totals disabled.")); + properties.put("columnTotals", array(array(ref("DataAnalysisMetricV1"))).withDescription("Metric tuples aligned with columnHeaders; empty when totals disabled.")); + properties.put("grandTotals", array(ref("DataAnalysisMetricV1")).withDescription("Grand-total metrics; empty when totals disabled.")); + properties.put("truncatedRows", new Schema().withType(Type.BOOLEAN).withDescription("Row groups were merged into Other.")); + properties.put("truncatedColumns", new Schema().withType(Type.BOOLEAN).withDescription("Column groups were merged into Other.")); + properties.put("estimate", new Schema().withType(Type.BOOLEAN).withDescription("True when bounded streamed fallback produced a partial result.")); + properties.put("warnings", array(new Schema().withType(Type.STRING)).withDescription("Privacy, partial-result and joined-drill limitations.")); + properties.put("asOf", new Schema().withType(Type.STRING).withDescription("UTC timestamp of computation.")); + return (new Schema().withType(Type.OBJECT).withProperties(properties)); + } + } + } diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/AnalysisDrillGuard.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/AnalysisDrillGuard.java new file mode 100644 index 0000000..f0fe01c --- /dev/null +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/AnalysisDrillGuard.java @@ -0,0 +1,168 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis.engine; + +import java.util.Set; +import com.kingsrook.qbits.dataanalysis.result.CandidateKey; +import com.kingsrook.qbits.dataanalysis.result.Chart; +import com.kingsrook.qbits.dataanalysis.result.ColumnProfile; +import com.kingsrook.qbits.dataanalysis.result.DateProfile; +import com.kingsrook.qbits.dataanalysis.result.DistinctValuesPage; +import com.kingsrook.qbits.dataanalysis.result.Drill; +import com.kingsrook.qbits.dataanalysis.result.DuplicatesResult; +import com.kingsrook.qbits.dataanalysis.result.FieldSummary; +import com.kingsrook.qbits.dataanalysis.result.Metric; +import com.kingsrook.qbits.dataanalysis.result.NumericProfile; +import com.kingsrook.qbits.dataanalysis.result.Point; +import com.kingsrook.qbits.dataanalysis.result.Series; +import com.kingsrook.qbits.dataanalysis.result.TableProfile; +import com.kingsrook.qbits.dataanalysis.result.TextProfile; +import com.kingsrook.qbits.dataanalysis.result.ValueCount; +import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter; +import com.kingsrook.qqq.backend.core.utils.JsonUtils; + +/******************************************************************************* + ** Final defense for profile-generated drills, including representative primary + ** keys and prefix bounds. User-authored predicates remain intact; unsafe generated + ** drills are disabled rather than broadened by removing their conditions. + *******************************************************************************/ +public class AnalysisDrillGuard +{ + private final Set fields; + private final String original; + + /******************************************************************************* + ** Resolve FULL fields once per completed result. + *******************************************************************************/ + public AnalysisDrillGuard(Set fields, QQueryFilter original) + { + this.fields = fields; + this.original = JsonUtils.toJson(DrillFilters.copy(original)); + } + + /******************************************************************************* + ** Visit only typed result containers, never the caller's query. + *******************************************************************************/ + public void apply(Object value) + { + if(value instanceof Iterable list) + { + list.forEach(this::apply); + } + else if(value instanceof Metric metric) + { + metric.withDrill(permitted(metric.getDrill())); + } + else if(value instanceof ValueCount count) + { + count.withDrill(permitted(count.getDrill())); + } + else if(value instanceof Point point) + { + point.withDrill(permitted(point.getDrill())); + } + else if(value instanceof CandidateKey key) + { + key.withDrill(permitted(key.getDrill())); + } + else if(value instanceof ColumnProfile profile) + { + apply(profile.getCounts()); + apply(profile.getTopValues()); + apply(profile.getBooleans()); + apply(profile.getNumeric()); + apply(profile.getDates()); + apply(profile.getText()); + apply(profile.getChart()); + } + else if(value instanceof NumericProfile profile) + { + apply(profile.getMetrics()); + apply(profile.getHistogram()); + apply(profile.getOutliers()); + } + else if(value instanceof DateProfile profile) + { + apply(profile.getMetrics()); + apply(profile.getBuckets()); + apply(profile.getGaps()); + apply(profile.getDayOfWeek()); + apply(profile.getHourOfDay()); + } + else if(value instanceof TextProfile profile) + { + apply(profile.getMetrics()); + apply(profile.getHistogram()); + apply(profile.getPatterns()); + } + else if(value instanceof TableProfile profile) + { + apply(profile.getRowCount()); + apply(profile.getFields()); + apply(profile.getCandidateKeys()); + apply(profile.getHeatmap()); + } + else if(value instanceof FieldSummary field) + { + apply(field.getNulls()); + apply(field.getBlanks()); + } + else if(value instanceof Chart chart) + { + apply(chart.getSeries()); + } + else if(value instanceof Series series) + { + apply(series.getPoints()); + } + else if(value instanceof DistinctValuesPage page) + { + apply(page.getValues()); + } + else if(value instanceof DuplicatesResult result) + { + apply(result.getGroups()); + } + } + + /******************************************************************************* + ** Preserve count equivalence by removing the entire unsafe drill. + *******************************************************************************/ + private Drill permitted(Drill drill) + { + return (drill == null || safe(drill.getFilter()) ? drill : null); + } + + /******************************************************************************* + ** An exact copy of a user subtree is exempt from analysis field restrictions. + *******************************************************************************/ + private boolean safe(QQueryFilter filter) + { + if(original.equals(JsonUtils.toJson(DrillFilters.copy(filter)))) + { + return (true); + } + return (filter.getCriteria().stream().allMatch(c -> fields.contains(c.getFieldName()) + && (c.getOtherFieldName() == null || fields.contains(c.getOtherFieldName())) + && (c.getFieldFunction() == null || fields.contains(c.getFieldFunction().getFieldName()))) + && filter.getSubFilters().stream().allMatch(this::safe)); + } +} diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/AnalysisLabels.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/AnalysisLabels.java index 4372566..3cf2229 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/AnalysisLabels.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/AnalysisLabels.java @@ -25,7 +25,6 @@ import java.util.LinkedHashSet; import java.util.List; import java.util.Set; import com.kingsrook.qqq.backend.core.actions.metadata.personalization.TableMetaDataPersonalizerAction; -import com.kingsrook.qqq.backend.core.actions.permissions.FieldSecurityLockHelper; import com.kingsrook.qqq.backend.core.actions.permissions.PermissionEnforcement; import com.kingsrook.qqq.backend.core.actions.tables.QueryAction; import com.kingsrook.qqq.backend.core.actions.values.QPossibleValueTranslator; @@ -64,7 +63,7 @@ public final class AnalysisLabels *******************************************************************************/ public static String translate(QFieldMetaData field, Serializable value) throws QException { - return (translate(field, value, new LinkedHashSet<>())); + return (translate(field, value, CoreTierFieldAccessResolver.defaultResolver())); } @@ -72,7 +71,15 @@ public final class AnalysisLabels /******************************************************************************* ** Resolve nested PVS label fields without invoking core's trusted lookup path. *******************************************************************************/ - private static String translate(QFieldMetaData field, Serializable value, Set visited) throws QException + public static String translate(QFieldMetaData field, Serializable value, FieldAnalysisAccessResolver access) throws QException + { + return (translate(field, value, new LinkedHashSet<>(), access)); + } + + /******************************************************************************* + ** Resolve nested labels only through FULL fields under the host policy. + *******************************************************************************/ + private static String translate(QFieldMetaData field, Serializable value, Set visited, FieldAnalysisAccessResolver access) throws QException { if(value == null) { @@ -98,7 +105,7 @@ public final class AnalysisLabels List labelFields = original.getRecordLabelFields() == null ? List.of() : original.getRecordLabelFields(); for(String labelField : labelFields) { - if(!table.getFields().containsKey(labelField) || !FieldSecurityLockHelper.isFieldAccessible(table.getField(labelField))) + if(!table.getFields().containsKey(labelField) || access.resolve(table, table.getField(labelField)) != FieldAnalysisAccess.FULL) { return (fallback); } @@ -119,7 +126,7 @@ public final class AnalysisLabels QFieldMetaData labelMetadata = table.getField(labelField); if(labelMetadata.getPossibleValueSourceName() != null) { - record.withDisplayValue(labelField, translate(labelMetadata, record.getValue(labelField), visited)); + record.withDisplayValue(labelField, translate(labelMetadata, record.getValue(labelField), visited, access)); } } String label = QValueFormatter.formatRecordLabel(table, record); @@ -144,6 +151,14 @@ public final class AnalysisLabels ** host changing field/record locks cannot release older translated labels. *******************************************************************************/ public static java.util.Map policy(String tableName) throws QException + { + return (policy(tableName, CoreTierFieldAccessResolver.defaultResolver())); + } + + /******************************************************************************* + ** Include host-resolved tiers of related labels in the exact-run identity. + *******************************************************************************/ + public static java.util.Map policy(String tableName, FieldAnalysisAccessResolver access) throws QException { java.util.Map result = new java.util.TreeMap<>(); java.util.ArrayDeque pending = new java.util.ArrayDeque<>(); @@ -160,6 +175,7 @@ public final class AnalysisLabels QTableMetaData table = TableMetaDataPersonalizerAction.execute(input, true); java.util.Map entry = new java.util.TreeMap<>(); entry.put("fields", table.getFields()); + entry.put("fullFields", table.getFields().values().stream().filter(f -> access.resolve(table, f) == FieldAnalysisAccess.FULL).map(QFieldMetaData::getName).sorted().toList()); entry.put("locks", table.getRecordSecurityLocks()); entry.put("labelFields", table.getRecordLabelFields()); entry.put("labelFormat", table.getRecordLabelFormat()); diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/AnalysisSecurity.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/AnalysisSecurity.java index dbf399a..f72f08a 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/AnalysisSecurity.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/AnalysisSecurity.java @@ -20,19 +20,21 @@ package com.kingsrook.qbits.dataanalysis.engine; +import java.io.Serializable; import java.util.List; import com.kingsrook.qbits.dataanalysis.permissions.DataAnalysisPermissions; import com.kingsrook.qqq.backend.core.actions.metadata.personalization.TableMetaDataPersonalizerAction; -import com.kingsrook.qqq.backend.core.actions.permissions.FieldSecurityLockHelper; import com.kingsrook.qqq.backend.core.actions.permissions.PermissionEnforcement; 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.exceptions.QBadRequestException; import com.kingsrook.qqq.backend.core.exceptions.QException; import com.kingsrook.qqq.backend.core.exceptions.QPermissionDeniedException; import com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryInput; import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData; import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData; +import com.kingsrook.qqq.backend.core.utils.JsonUtils; /******************************************************************************* ** Fail closed before any source-table computation, including cache retrieval. @@ -40,17 +42,27 @@ import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData; public class AnalysisSecurity { private final EffectiveConfigResolver configs; + private final FieldAnalysisAccessResolver fieldAccess; /******************************************************************************* ** Use the runtime's configuration policy. *******************************************************************************/ public AnalysisSecurity(EffectiveConfigResolver configs) { - this.configs = configs; + this(configs, CoreTierFieldAccessResolver.defaultResolver()); } + /******************************************************************************* + ** Bind the host field policy. + *******************************************************************************/ + public AnalysisSecurity(EffectiveConfigResolver configs, FieldAnalysisAccessResolver fieldAccess) + { + this.configs = configs; + this.fieldAccess = fieldAccess; + } + /******************************************************************************* ** Explicit enforcement is independent of the instance's default switch. *******************************************************************************/ @@ -76,7 +88,7 @@ public class AnalysisSecurity { QTableMetaData table = table(name); EffectiveConfig c = configs.resolve(name); - return (table.getFields().values().stream().filter(FieldSecurityLockHelper::isFieldAccessible) + return (table.getFields().values().stream().filter(f -> fieldAccess.resolve(table, f) == FieldAnalysisAccess.FULL) .filter(f -> c.getAnalyzableFields().isEmpty() || c.getAnalyzableFields().contains(f.getName())) .filter(f -> !c.getExcludedFields().contains(f.getName())).toList()); } @@ -89,6 +101,50 @@ public class AnalysisSecurity public QFieldMetaData field(String table, String field) throws QException { return (analyzableFields(table).stream().filter(f -> f.getName().equals(field)).findFirst() - .orElseThrow(() -> new QPermissionDeniedException("Analysis is unavailable for this field."))); + .orElseThrow(() -> new QBadRequestException("Unknown analysis field."))); + } + + /******************************************************************************* + ** Core fingerprint plus the sorted FULL-field list, hashed by the run identity. + *******************************************************************************/ + public String accessFingerprint(String table) throws QException + { + return (fieldAccess.getAccessFingerprint() + ":" + JsonUtils.toJson(analyzableFields(table).stream().map(QFieldMetaData::getName).sorted().toList())); + } + + /******************************************************************************* + ** Check a joined field without requiring the related table analyze permission. + *******************************************************************************/ + public QFieldMetaData joinedField(String tableName, String fieldName) throws QException + { + QTableMetaData table = joinedTable(tableName); + QFieldMetaData field = table.getFields().get(fieldName); + if(field == null || fieldAccess.resolve(table, field) != FieldAnalysisAccess.FULL) + { + throw new QBadRequestException("Unknown analysis field."); + } + return (field); + } + + /******************************************************************************* + ** Display labels use the same policy as the selected pivot field. + *******************************************************************************/ + public String label(QFieldMetaData field, Serializable value) throws QException + { + return (AnalysisLabels.translate(field, value, fieldAccess)); + } + + /******************************************************************************* + ** Each intermediate exposed-join table requires READ, without analyze rights. + *******************************************************************************/ + public QTableMetaData joinedTable(String tableName) throws QException + { + QueryInput input = new QueryInput(tableName); + input.setPermissionEnforcement(PermissionEnforcement.ENFORCE); + if(QContext.getQInstance().getTable(tableName) == null || !PermissionsHelper.hasTablePermission(input, tableName, TablePermissionSubType.READ)) + { + throw new QBadRequestException("Unknown analysis field."); + } + return (TableMetaDataPersonalizerAction.execute(input, true)); } } diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/ColumnProfiler.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/ColumnProfiler.java index 27945b2..8c81601 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/ColumnProfiler.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/ColumnProfiler.java @@ -48,13 +48,23 @@ import com.kingsrook.qqq.backend.core.utils.ValueUtils; public class ColumnProfiler { private final AnalysisBackend backend; + private final FieldAnalysisAccessResolver fieldAccess; /******************************************************************************* ** The backend can be replaced when core's new operators ship. *******************************************************************************/ public ColumnProfiler(AnalysisBackend backend) + { + this(backend, CoreTierFieldAccessResolver.defaultResolver()); + } + + /******************************************************************************* + ** Bind the host field policy for possible-value labels. + *******************************************************************************/ + public ColumnProfiler(AnalysisBackend backend, FieldAnalysisAccessResolver fieldAccess) { this.backend = backend; + this.fieldAccess = fieldAccess; } @@ -82,7 +92,7 @@ public class ColumnProfiler } result.getCounts().add(ProfileSupport.count("distinct", counts.distinct(), table, drillFilter, counts.distinctFilter())); result.getCounts().add(ProfileSupport.metric("uniqueness", counts.uniqueness(), ValueType.PERCENT)); - result.withTopValues(ProfileSupport.values(table, drillFilter, field, backend.topValues(table, filter, name, 20, 0, null), rows)); + result.withTopValues(ProfileSupport.values(table, drillFilter, field, backend.topValues(table, filter, name, 20, 0, null), rows, fieldAccess)); QFieldType type = field.getType(); if(type == QFieldType.INTEGER || type == QFieldType.LONG || type == QFieldType.DECIMAL) { diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/CoreTierFieldAccessResolver.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/CoreTierFieldAccessResolver.java new file mode 100644 index 0000000..1f9c7c4 --- /dev/null +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/CoreTierFieldAccessResolver.java @@ -0,0 +1,118 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis.engine; + +import java.lang.reflect.Method; +import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData; +import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData; + +/******************************************************************************* + ** Optional core bridge: replace with direct calls once QQQ ships the fieldaccess package. + ** Class and method discovery happen once; invocation failures fail closed. + *******************************************************************************/ +public class CoreTierFieldAccessResolver implements FieldAnalysisAccessResolver +{ + private static final CoreTierFieldAccessResolver DEFAULT = discover(); + private final Method tier; + private final Method fingerprint; + + /******************************************************************************* + ** Bind discovered static methods once. + *******************************************************************************/ + public CoreTierFieldAccessResolver(Class helper) throws ReflectiveOperationException + { + tier = helper.getMethod("getTier", QTableMetaData.class, String.class); + Method optional; + try + { + optional = helper.getMethod("getAccessFingerprint"); + } + catch(NoSuchMethodException e) + { + optional = null; + } + fingerprint = optional; + } + + /******************************************************************************* + ** Resolve the optional class once per class loader. + *******************************************************************************/ + private static CoreTierFieldAccessResolver discover() + { + try + { + return (new CoreTierFieldAccessResolver(Class.forName("com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.FieldAccessHelper"))); + } + catch(ClassNotFoundException e) + { + return (null); + } + catch(ReflectiveOperationException e) + { + throw new ExceptionInInitializerError(e); + } + } + + /******************************************************************************* + ** Use legacy locks only when the core helper class is absent. + *******************************************************************************/ + public static FieldAnalysisAccessResolver defaultResolver() + { + return (DEFAULT == null ? new FieldSecurityLockFieldAccessResolver() : DEFAULT); + } + + /******************************************************************************* + ** Unknown tiers and invocation failures never grant analysis rights. + *******************************************************************************/ + @Override + public FieldAnalysisAccess resolve(QTableMetaData table, QFieldMetaData field) + { + try + { + return (switch(String.valueOf(tier.invoke(null, table, field.getName()))) + { + case "FULL" -> FieldAnalysisAccess.FULL; + case "REVEALABLE" -> FieldAnalysisAccess.EXACT_MATCH_ONLY; + default -> FieldAnalysisAccess.NONE; + }); + } + catch(ReflectiveOperationException e) + { + return (FieldAnalysisAccess.NONE); + } + } + + /******************************************************************************* + ** A broken fingerprint prevents cache reuse rather than returning stale data. + *******************************************************************************/ + @Override + public String getAccessFingerprint() + { + try + { + return (fingerprint == null ? "" : (String) fingerprint.invoke(null)); + } + catch(ReflectiveOperationException e) + { + throw new IllegalStateException("Could not resolve field access fingerprint.", e); + } + } +} diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/DistinctValues.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/DistinctValues.java index 4ee6dce..d09b914 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/DistinctValues.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/DistinctValues.java @@ -34,13 +34,23 @@ import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData; public class DistinctValues { private final AnalysisBackend backend; + private final FieldAnalysisAccessResolver fieldAccess; /******************************************************************************* ** Bind primitive operations. *******************************************************************************/ public DistinctValues(AnalysisBackend backend) + { + this(backend, CoreTierFieldAccessResolver.defaultResolver()); + } + + /******************************************************************************* + ** Bind the host field policy for possible-value labels. + *******************************************************************************/ + public DistinctValues(AnalysisBackend backend, FieldAnalysisAccessResolver fieldAccess) { this.backend = backend; + this.fieldAccess = fieldAccess; } @@ -60,7 +70,7 @@ public class DistinctValues boolean wholeListing = config.getMinGroupSize() > 0 || request.getSearch() != null && !request.getSearch().isBlank(); int fetch = wholeListing ? Math.max(1, config.getMaxRows()) : request.getPageSize() + 1; List values = ProfileSupport.values(request.getTableName(), scope.filter(), field, - backend.topValues(request.getTableName(), scope.filter(), field.getName(), fetch, wholeListing ? 0 : offset, request.getSearch()), scope.rowsScanned()); + backend.topValues(request.getTableName(), scope.filter(), field.getName(), fetch, wholeListing ? 0 : offset, request.getSearch()), scope.rowsScanned(), fieldAccess); long totalDistinct = wholeListing ? values.stream().filter(v -> v.getValue() != null).count() : backend.fieldCounts(request.getTableName(), scope.filter(), List.of(field.getName())).get(field.getName()).distinct(); values = new MinGroupSizeGuard(config.getMinGroupSize()).groups(values); diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/FieldAnalysisAccess.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/FieldAnalysisAccess.java new file mode 100644 index 0000000..dee6b1b --- /dev/null +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/FieldAnalysisAccess.java @@ -0,0 +1,29 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis.engine; + +/******************************************************************************* + ** Analysis access is stricter than the ability to submit an exact query. + *******************************************************************************/ +public enum FieldAnalysisAccess +{ + FULL, EXACT_MATCH_ONLY, NONE +} diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/FieldAnalysisAccessResolver.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/FieldAnalysisAccessResolver.java new file mode 100644 index 0000000..91bb0d0 --- /dev/null +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/FieldAnalysisAccessResolver.java @@ -0,0 +1,43 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis.engine; + +import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData; +import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData; + +/******************************************************************************* + ** Resolve the current user's analysis rights without exposing protected values. + *******************************************************************************/ +public interface FieldAnalysisAccessResolver +{ + /******************************************************************************* + ** Only FULL fields may contribute generated analysis predicates. + *******************************************************************************/ + FieldAnalysisAccess resolve(QTableMetaData table, QFieldMetaData field); + + /******************************************************************************* + ** Optional core policy fingerprint supplements the FULL-field list hash. + *******************************************************************************/ + default String getAccessFingerprint() + { + return (""); + } +} diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/FieldSecurityLockFieldAccessResolver.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/FieldSecurityLockFieldAccessResolver.java new file mode 100644 index 0000000..1175e23 --- /dev/null +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/FieldSecurityLockFieldAccessResolver.java @@ -0,0 +1,42 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis.engine; + +import com.kingsrook.qqq.backend.core.actions.permissions.FieldSecurityLockHelper; +import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData; +import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData; + +/******************************************************************************* + ** Legacy lock adapter. The core tier API (qbit-secured-data) will map REVEALABLE + ** to EXACT_MATCH_ONLY, MASKED/HIDDEN without filter rights to NONE, and + ** MASKED/HIDDEN with filter rights to FULL. + *******************************************************************************/ +public class FieldSecurityLockFieldAccessResolver implements FieldAnalysisAccessResolver +{ + /******************************************************************************* + ** Keep the legacy lock enforcement when core tiers are not installed. + *******************************************************************************/ + @Override + public FieldAnalysisAccess resolve(QTableMetaData table, QFieldMetaData field) + { + return (FieldSecurityLockHelper.isFieldAccessible(field) ? FieldAnalysisAccess.FULL : FieldAnalysisAccess.NONE); + } +} diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/MinGroupSizeGuard.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/MinGroupSizeGuard.java index 3331d96..67f3559 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/MinGroupSizeGuard.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/MinGroupSizeGuard.java @@ -143,4 +143,16 @@ public class MinGroupSizeGuard profile.getText().withHistogram(groups(profile.getText().getHistogram())).withPatterns(groups(profile.getText().getPatterns())); } } + + /******************************************************************************* + ** Small pivot cells suppress every measure, including count, with no drill. + *******************************************************************************/ + public void pivotMetrics(List metrics, long rows) + { + if(rows < minimum) + { + metrics.forEach(m -> m.withValue(null).withFormatted(null).withDrill(null).withSuppressed(true) + .withSuppressedReason("Hidden: fewer than " + minimum + " records")); + } + } } diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/NiceBins.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/NiceBins.java index 76807f3..6616b50 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/NiceBins.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/NiceBins.java @@ -33,6 +33,14 @@ public record NiceBins(BigDecimal low, BigDecimal high, int count) ** Select the closest 10..25-bin enclosure from 1, 2, 2.5 and 5 times powers of ten. *******************************************************************************/ public static NiceBins covering(BigDecimal low, BigDecimal high) + { + return (covering(low, high, 20)); + } + + /******************************************************************************* + ** Choose readable enclosing edges for a requested pivot bin count. + *******************************************************************************/ + public static NiceBins covering(BigDecimal low, BigDecimal high, int target) { BigDecimal span = high.subtract(low); if(span.signum() == 0) @@ -41,7 +49,7 @@ public record NiceBins(BigDecimal low, BigDecimal high, int count) low = low.subtract(span.divide(BigDecimal.valueOf(2))); high = high.add(span.divide(BigDecimal.valueOf(2))); } - int exponent = span.precision() - span.scale() - 2; + int exponent = span.precision() - span.scale() - Integer.toString(target).length(); NiceBins best = null; for(int power = exponent - 2; power <= exponent + 2; power++) { @@ -51,7 +59,7 @@ public record NiceBins(BigDecimal low, BigDecimal high, int count) BigDecimal first = low.divide(step, 0, RoundingMode.FLOOR).multiply(step); BigDecimal last = high.divide(step, 0, RoundingMode.CEILING).multiply(step); int count = last.subtract(first).divide(step).intValueExact(); - if(count >= 10 && count <= 25 && (best == null || Math.abs(count - 20) < Math.abs(best.count() - 20))) + if(count >= Math.max(1, target / 2) && count <= Math.max(2, target * 5 / 4) && (best == null || Math.abs(count - target) < Math.abs(best.count() - target))) { best = new NiceBins(first, last, count); } diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/PivotExplorer.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/PivotExplorer.java new file mode 100644 index 0000000..b1c23f5 --- /dev/null +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/PivotExplorer.java @@ -0,0 +1,607 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis.engine; + +import java.io.Serializable; +import java.math.BigDecimal; +import java.math.MathContext; +import java.time.Instant; +import java.time.LocalDate; +import java.util.ArrayList; +import java.util.LinkedHashMap; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import com.kingsrook.qbits.dataanalysis.result.Metric; +import com.kingsrook.qbits.dataanalysis.result.PivotCell; +import com.kingsrook.qbits.dataanalysis.result.PivotDimension; +import com.kingsrook.qbits.dataanalysis.result.PivotHeader; +import com.kingsrook.qbits.dataanalysis.result.PivotMeasure; +import com.kingsrook.qbits.dataanalysis.result.PivotMeasureInfo; +import com.kingsrook.qbits.dataanalysis.result.PivotRequest; +import com.kingsrook.qbits.dataanalysis.result.PivotResult; +import com.kingsrook.qbits.dataanalysis.result.ValueType; +import com.kingsrook.qqq.backend.core.actions.permissions.PermissionEnforcement; +import com.kingsrook.qqq.backend.core.actions.tables.AggregateAction; +import com.kingsrook.qqq.backend.core.context.QContext; +import com.kingsrook.qqq.backend.core.exceptions.QBadRequestException; +import com.kingsrook.qqq.backend.core.exceptions.QException; +import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.Aggregate; +import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.AggregateInput; +import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.AggregateOperator; +import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.AggregateResult; +import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.DateBucket; +import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.DateBucketUnit; +import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.GroupBy; +import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.NumericBucket; +import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.QFilterOrderByAggregate; +import com.kingsrook.qqq.backend.core.model.actions.tables.query.QCriteriaOperator; +import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter; +import com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryJoin; +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.joins.JoinType; +import com.kingsrook.qqq.backend.core.model.metadata.tables.ExposedJoin; +import com.kingsrook.qqq.backend.core.utils.ValueUtils; +import com.kingsrook.qqq.backend.core.utils.aggregates.AggregateAnalysis; + +/******************************************************************************* + ** Request-local pivot planner. Core executes every aggregate with ENFORCE. + ** Merged cells are re-aggregated so non-additive measures remain exact. + *******************************************************************************/ +public class PivotExplorer +{ + private final AnalysisSecurity security; + private final EffectiveConfig config; + private final List joins = new ArrayList<>(); + private final LinkedHashSet toManyTables = new LinkedHashSet<>(); + private final LinkedHashSet multiHopTables = new LinkedHashSet<>(); + private PivotRequest request; + private Aggregate count; + private final List measures = new ArrayList<>(); + private final List measureInfo = new ArrayList<>(); + private boolean partial; + + /******************************************************************************* + ** Bind the current user's policy and bounded streamed fallback. + *******************************************************************************/ + public PivotExplorer(AnalysisSecurity security, EffectiveConfig config) + { + this.security = security; + this.config = config; + } + + /******************************************************************************* + ** One slot is a visible group or the exact complement of the kept groups. + *******************************************************************************/ + private record Slot(Serializable value, String label, QQueryFilter condition, boolean other) + { + } + + /******************************************************************************* + ** Dimension state owns predicates, so no generated filter names hidden fields. + *******************************************************************************/ + private record Dimension(GroupBy group, QFieldMetaData field, Map kept, Map counts, Slot other) + { + /******************************************************************************* + ** Return the kept group, Other, or null for a privacy-suppressed group. + *******************************************************************************/ + Slot slot(Serializable value, int minimum) + { + return (counts.getOrDefault(value, 0L) < minimum ? null : kept.getOrDefault(value, other)); + } + } + + /******************************************************************************* + ** Validate the complete plan before any source computation. + *******************************************************************************/ + public PivotResult execute(PivotRequest request) throws QException + { + this.request = request; + validate(); + String primaryKey = QContext.getQInstance().getTable(request.getTableName()).getPrimaryKeyField(); + count = new Aggregate(primaryKey, AggregateOperator.COUNT).withFieldType(QFieldType.INTEGER); + List requested = new ArrayList<>(request.getRows()); + requested.addAll(request.getColumns()); + List fields = new ArrayList<>(); + for(PivotDimension dimension : requested) + { + fields.add(resolve(dimension.getField())); + } + for(int i = 0; i < request.getValues().size(); i++) + { + prepareMeasure(request.getValues().get(i), i); + } + List dimensions = new ArrayList<>(); + for(int i = 0; i < requested.size(); i++) + { + dimensions.add(dimension(requested.get(i), fields.get(i))); + } + int rowCount = request.getRows().size(); + List rows = dimensions.subList(0, rowCount); + List columns = dimensions.subList(rowCount, dimensions.size()); + PivotResult result = new PivotResult().withAsOf(Instant.now()).withMeasures(measureInfo) + .withTruncatedRows(rows.stream().anyMatch(d -> d.other() != null)) + .withTruncatedColumns(columns.stream().anyMatch(d -> d.other() != null)); + Map, List> matrix = level(dimensions); + Map, List> rowTotals = request.getShowTotals() || config.getMinGroupSize() > 0 ? level(rows) : Map.of(); + Map, List> columnTotals = request.getShowTotals() || config.getMinGroupSize() > 0 ? level(columns) : Map.of(); + List> rowKeys = new ArrayList<>(); + List> columnKeys = new ArrayList<>(); + for(var entry : matrix.entrySet()) + { + List row = List.copyOf(entry.getKey().subList(0, rowCount)); + List column = List.copyOf(entry.getKey().subList(rowCount, dimensions.size())); + if(config.getMinGroupSize() > 0 && (rowTotals.getOrDefault(row, List.of()).stream().allMatch(m -> m.getSuppressed()) + || columnTotals.getOrDefault(column, List.of()).stream().allMatch(m -> m.getSuppressed()))) + { + continue; + } + if(!rowKeys.contains(row)) + { + rowKeys.add(row); + } + if(!columnKeys.contains(column)) + { + columnKeys.add(column); + } + result.getCells().add(new PivotCell().withRowIndex(rowKeys.indexOf(row)).withColumnIndex(columnKeys.indexOf(column)).withValues(entry.getValue())); + } + result.withRowHeaders(headers(rowKeys)).withColumnHeaders(headers(columnKeys)); + if(request.getShowTotals()) + { + rowKeys.forEach(key -> result.getRowTotals().add(rowTotals.getOrDefault(key, List.of()))); + columnKeys.forEach(key -> result.getColumnTotals().add(columnTotals.getOrDefault(key, List.of()))); + result.withGrandTotals(level(List.of()).getOrDefault(List.of(), List.of())); + } + for(String tableName : toManyTables) + { + result.getWarnings().add("Counts include one row per related " + QContext.getQInstance().getTable(tableName).getLabel() + + "; drill-through is not available for this dimension."); + } + for(String tableName : multiHopTables) + { + result.getWarnings().add("Drill-through is not available for fields reached through more than one join (" + QContext.getQInstance().getTable(tableName).getLabel() + ")."); + } + if(config.getMinGroupSize() > 0) + { + result.getWarnings().add("Groups below " + config.getMinGroupSize() + " records are omitted; small cells and totals are suppressed."); + } + if(partial) + { + result.withEstimate(true); + result.getWarnings().add("Partial pivot: the streamed row limit was reached. Drills are disabled because aggregates may cover different prefixes."); + result.getCells().forEach(c -> disableDrills(c.getValues())); + result.getRowTotals().forEach(this::disableDrills); + result.getColumnTotals().forEach(this::disableDrills); + disableDrills(result.getGrandTotals()); + } + return (result); + } + + /******************************************************************************* + ** Reject invalid shapes and types before aggregate execution. + *******************************************************************************/ + private void validate() throws QException + { + if(request.getRows() == null || request.getRows().isEmpty() || request.getRows().size() > 3 + || request.getColumns() == null || request.getColumns().size() > 2 || request.getValues() == null + || request.getValues().isEmpty() || request.getValues().size() > 6 || request.getShowTotals() == null + || request.getLimitGroups() == null || request.getLimitGroups() < 1 || request.getLimitGroups() > 200) + { + throw new QBadRequestException("Choose 1�3 row dimensions, 0�2 column dimensions, 1�6 measures and a group limit from 1 to 200."); + } + List dimensions = new ArrayList<>(request.getRows()); + dimensions.addAll(request.getColumns()); + LinkedHashSet names = new LinkedHashSet<>(); + for(PivotDimension dimension : dimensions) + { + if(dimension == null || dimension.getField() == null || !names.add(dimension.getField())) + { + throw new QBadRequestException("Choose distinct dimension fields."); + } + QFieldMetaData field = resolve(dimension.getField()); + var bins = dimension.getNumericBins(); + if(dimension.getDateBucket() != null && (bins != null || field.getType() != QFieldType.DATE && field.getType() != QFieldType.DATE_TIME) + || bins != null && (!numeric(field) || bins.getCount() == null || bins.getCount() < 1 || bins.getCount() > 200 + || bins.getMin() != null && bins.getMax() != null && bins.getMin().compareTo(bins.getMax()) >= 0)) + { + throw new QBadRequestException("Buckets must match the field type; numeric bins require 1�200 bins and min < max."); + } + } + } + + /******************************************************************************* + ** Only exposed, unambiguous paths may introduce a joined field. + ** The installed snapshot has no related-record picker join-path helper. + *******************************************************************************/ + private QFieldMetaData resolve(String name) throws QException + { + if(name == null || !name.contains(".")) + { + return (security.field(request.getTableName(), name)); + } + String[] parts = name.split("\\.", -1); + var table = QContext.getQInstance().getTable(request.getTableName()); + List exposed = table.getExposedJoins() == null ? List.of() : table.getExposedJoins(); + List paths = exposed.stream().filter(j -> j.getJoinTable().equals(parts[0])).toList(); + if(parts.length != 2 || paths.size() != 1 || paths.getFirst().getJoinPath() == null || paths.getFirst().getJoinPath().isEmpty()) + { + throw new QBadRequestException("Unknown analysis field."); + } + String current = table.getName(); + boolean toOne = true; + for(String joinName : paths.getFirst().getJoinPath()) + { + var metadata = QContext.getQInstance().getJoin(joinName); + if(metadata == null || !current.equals(metadata.getLeftTable()) && !current.equals(metadata.getRightTable())) + { + throw new QBadRequestException("Unknown analysis field."); + } + String next = current.equals(metadata.getLeftTable()) ? metadata.getRightTable() : metadata.getLeftTable(); + JoinType type = metadata.getType(); + if(type != null && current.equals(metadata.getRightTable())) + { + type = type.flip(); + } + toOne &= type == JoinType.MANY_TO_ONE || type == JoinType.ONE_TO_ONE; + security.joinedTable(next); + QueryJoin existing = joins.stream().filter(j -> next.equals(j.getJoinTable())).findFirst().orElse(null); + if(existing == null) + { + joins.add(new QueryJoin(current, next).withJoinMetaData(metadata)); + } + else if(!existing.getJoinMetaData().getName().equals(joinName)) + { + throw new QBadRequestException("Ambiguous analysis join path."); + } + current = next; + } + if(!current.equals(parts[0])) + { + throw new QBadRequestException("Unknown analysis field."); + } + if(!toOne) + { + toManyTables.add(current); + } + else if(paths.getFirst().getJoinPath().size() > 1) + { + /////////////////////////////////////////////////////////////////////////////// + // counts are per record, but core's implicit joins for a multi-hop filter // + // do not reproduce them on every backend yet (memory counts differ), so no // + // drill until that is fixed in core // + /////////////////////////////////////////////////////////////////////////////// + multiHopTables.add(current); + } + return (security.joinedField(parts[0], parts[1])); + } + + /******************************************************************************* + ** Count records even when a supplied COUNT field is nullable. + *******************************************************************************/ + private void prepareMeasure(PivotMeasure measure, int index) throws QException + { + if(measure == null || measure.getOperator() == null) + { + throw new QBadRequestException("Choose a measure operator."); + } + QFieldMetaData field = measure.getField() == null && measure.getOperator() == PivotMeasure.Operator.COUNT ? null : resolve(measure.getField()); + PivotMeasure.Operator operator = measure.getOperator(); + if((operator == PivotMeasure.Operator.SUM || operator == PivotMeasure.Operator.AVG || operator == PivotMeasure.Operator.PERCENTILE) && !numeric(field) + || operator == PivotMeasure.Operator.PERCENTILE && (measure.getPercentile() == null || measure.getPercentile().signum() < 0 || measure.getPercentile().compareTo(BigDecimal.ONE) > 0) + || operator != PivotMeasure.Operator.PERCENTILE && measure.getPercentile() != null) + { + throw new QBadRequestException("Numeric measures require a numeric field; percentile must be between 0 and 1."); + } + Aggregate aggregate = operator == PivotMeasure.Operator.COUNT ? count : new Aggregate(measure.getField(), + operator == PivotMeasure.Operator.PERCENTILE ? AggregateOperator.PERCENTILE_CONT : AggregateOperator.valueOf(operator.name())); + if(operator == PivotMeasure.Operator.PERCENTILE) + { + aggregate.withPercentile(measure.getPercentile()); + } + if(operator == PivotMeasure.Operator.COUNT_DISTINCT) + { + aggregate.withFieldType(QFieldType.INTEGER); + } + measures.add(aggregate); + ValueType type = operator == PivotMeasure.Operator.COUNT || operator == PivotMeasure.Operator.COUNT_DISTINCT ? ValueType.COUNT + : numeric(field) ? ValueType.DECIMAL : field.getType() == QFieldType.DATE ? ValueType.DATE : field.getType() == QFieldType.DATE_TIME ? ValueType.DATE_TIME : ValueType.TEXT; + measureInfo.add(new PivotMeasureInfo().withKey("value" + index).withLabel(operator.name() + (field == null ? " records" : " " + field.getLabel())).withValueType(type)); + } + + /******************************************************************************* + ** Numeric buckets and moments accept the same numeric QQQ field types. + *******************************************************************************/ + private static boolean numeric(QFieldMetaData field) + { + return (field != null && (field.getType() == QFieldType.INTEGER || field.getType() == QFieldType.LONG || field.getType() == QFieldType.DECIMAL)); + } + + /******************************************************************************* + ** Select top groups first, then collect cardinality and privacy counts. + *******************************************************************************/ + private Dimension dimension(PivotDimension requested, QFieldMetaData field) throws QException + { + GroupBy group = new GroupBy(field.getType(), requested.getField()); + if(requested.getDateBucket() != null) + { + group.withBucket(new DateBucket(requested.getDateBucket())); + } + if(requested.getNumericBins() != null) + { + var bins = requested.getNumericBins(); + BigDecimal low = bins.getMin(); + BigDecimal high = bins.getMax(); + if(low == null || high == null) + { + Aggregate min = new Aggregate(requested.getField(), AggregateOperator.MIN); + Aggregate max = new Aggregate(requested.getField(), AggregateOperator.MAX); + var extrema = aggregate(List.of(), request.getFilter(), List.of(min, max), null); + Serializable first = extrema.isEmpty() ? null : extrema.getFirst().getAggregateValues().get(min); + Serializable last = extrema.isEmpty() ? null : extrema.getFirst().getAggregateValues().get(max); + NiceBins nice = NiceBins.covering(first == null ? BigDecimal.ZERO : new BigDecimal(first.toString()), last == null ? BigDecimal.ONE : new BigDecimal(last.toString()), bins.getCount()); + low = low == null ? nice.low() : low; + high = high == null ? nice.high() : high; + } + if(low.compareTo(high) >= 0) + { + throw new QBadRequestException("Numeric bin min must be below max."); + } + group.withBucket(new NumericBucket(low, high, bins.getCount())); + } + List top = aggregate(List.of(group), request.getFilter(), List.of(count), request.getLimitGroups()); + List all = aggregate(List.of(group), request.getFilter(), List.of(count), null); + Map counts = new LinkedHashMap<>(); + all.forEach(r -> counts.put(r.getGroupByValues().get(group), count(r))); + Map kept = new LinkedHashMap<>(); + for(AggregateResult row : top) + { + Serializable value = row.getGroupByValues().get(group); + if(count(row) >= config.getMinGroupSize()) + { + kept.put(value, new Slot(value, label(group, field, value), condition(group, field, value), false)); + } + } + List remaining = counts.keySet().stream().filter(v -> !kept.containsKey(v) && counts.get(v) >= config.getMinGroupSize()).toList(); + Slot other = null; + if(!remaining.isEmpty()) + { + QQueryFilter predicate; + if(group.getBucket() == null && field.getType() != QFieldType.BOOLEAN && config.getMinGroupSize() == 0 && !kept.containsKey("") && kept.keySet().stream().noneMatch(v -> v instanceof Instant || v instanceof LocalDate)) + { + List values = kept.keySet().stream().filter(Objects::nonNull).toList(); + predicate = values.isEmpty() ? new QQueryFilter() : new QQueryFilter().withCriteria(group.getFieldName(), QCriteriaOperator.NOT_IN, values); + predicate = DrillFilters.and(predicate, DrillFilters.nonNull(group.getFieldName(), field.getType().isStringLike())); + if(!kept.containsKey(null)) + { + predicate = new QQueryFilter().withBooleanOperator(QQueryFilter.BooleanOperator.OR).withSubFilter(predicate).withSubFilter(DrillFilters.nulls(group.getFieldName(), field.getType().isStringLike())); + } + if(field.getType().isStringLike()) + { + predicate = new QQueryFilter().withBooleanOperator(QQueryFilter.BooleanOperator.OR).withSubFilter(predicate).withSubFilter(DrillFilters.value(group.getFieldName(), "", true)); + } + } + else + { + predicate = new QQueryFilter().withBooleanOperator(QQueryFilter.BooleanOperator.OR); + for(Serializable value : remaining) + { + predicate.withSubFilter(condition(group, field, value)); + } + } + other = new Slot(null, "Other (" + remaining.size() + " groups)", predicate, true); + } + return (new Dimension(group, field, kept, counts, other)); + } + + /******************************************************************************* + ** Native group keys are displayed as labels without changing filter operands. + *******************************************************************************/ + private String label(GroupBy group, QFieldMetaData field, Serializable value) throws QException + { + if(value == null) + { + return ("(Blank)"); + } + if(group.getBucket() instanceof DateBucket date) + { + return (AnalysisFormatting.dateBucket(value, AnalysisBackend.DateUnit.valueOf(date.getUnit().name()), ValueUtils.getSessionOrInstanceZoneId())); + } + if(group.getBucket() instanceof NumericBucket bins) + { + BigDecimal[] edges = edges(bins, ((Number) value).intValue()); + return (AnalysisFormatting.interval(field, edges[0], edges[1])); + } + return (security.label(field, value)); + } + + /******************************************************************************* + ** Match core's final closed numeric bin and exterior bins. + *******************************************************************************/ + private static BigDecimal[] edges(NumericBucket bins, int index) + { + BigDecimal width = bins.getMax().subtract(bins.getMin()).divide(BigDecimal.valueOf(bins.getCount()), MathContext.DECIMAL128); + return (new BigDecimal[] { index == 0 ? null : index > bins.getCount() ? bins.getMax() : bins.getMin().add(width.multiply(BigDecimal.valueOf(index - 1))), + index == 0 ? bins.getMin() : index > bins.getCount() ? null : index == bins.getCount() ? bins.getMax() : bins.getMin().add(width.multiply(BigDecimal.valueOf(index))) }); + } + + /******************************************************************************* + ** Calendar and numeric predicates use core bucket boundaries in the session zone. + *******************************************************************************/ + private QQueryFilter condition(GroupBy group, QFieldMetaData field, Serializable value) throws QException + { + String name = group.getFieldName(); + if(value == null || group.getBucket() == null) + { + return (DrillFilters.value(name, value, field.getType().isStringLike())); + } + if(group.getBucket() instanceof NumericBucket bins) + { + int index = ((Number) value).intValue(); + BigDecimal[] edges = edges(bins, index); + if(StandInAnalysisBackend.isMemory(request.getTableName()) && index <= bins.getCount()) + { + GroupBy raw = new GroupBy(field.getType(), name); + List members = aggregate(List.of(raw), request.getFilter(), List.of(count), null).stream() + .map(r -> r.getGroupByValues().get(raw)).filter(Objects::nonNull).map(v -> new BigDecimal(v.toString())).toList(); + return (new StandInAnalysisBackend(config).numericRange(request.getTableName(), name, members, edges[0], edges[1], index == bins.getCount())); + } + return (index > bins.getCount() ? DrillFilters.condition(name, QCriteriaOperator.GREATER_THAN, bins.getMax()) + : DrillFilters.range(name, edges[0], edges[1], index == bins.getCount())); + } + DateBucketUnit unit = ((DateBucket) group.getBucket()).getUnit(); + if(unit == DateBucketUnit.HOUR) + { + Instant start = ValueUtils.getValueAsInstant(value); + return (DrillFilters.range(name, start, start.plusSeconds(3600), false)); + } + if(unit == DateBucketUnit.DAY_OF_WEEK || unit == DateBucketUnit.HOUR_OF_DAY) + { + GroupBy raw = new GroupBy(field.getType(), name); + List members = aggregate(List.of(raw), request.getFilter(), List.of(count), null).stream().map(r -> r.getGroupByValues().get(raw)) + .filter(v -> Objects.equals(AggregateAnalysis.bucket(v, group.getBucket(), ValueUtils.getSessionOrInstanceZoneId()), value)).toList(); + return (DrillFilters.in(name, members)); + } + LocalDate start = ValueUtils.getValueAsLocalDate(value); + LocalDate end = switch(unit) + { + case YEAR -> start.plusYears(1); + case QUARTER -> start.plusMonths(3); + case MONTH -> start.plusMonths(1); + case WEEK -> start.plusWeeks(1); + default -> start.plusDays(1); + }; + return (DrillFilters.dateRange(name, start, end, field.getType() == QFieldType.DATE_TIME, ValueUtils.getSessionOrInstanceZoneId())); + } + + /******************************************************************************* + ** A level is the full matrix, row totals, column totals or grand totals. + *******************************************************************************/ + private Map, List> level(List dimensions) throws QException + { + List requested = new ArrayList<>(measures); + if(!requested.contains(count)) + { + requested.add(count); + } + Map, List> grouped = new LinkedHashMap<>(); + List aggregates = aggregate(dimensions.stream().map(Dimension::group).toList(), request.getFilter(), requested, null); + if(dimensions.isEmpty() && aggregates.isEmpty()) + { + AggregateResult empty = new AggregateResult(); + requested.forEach(a -> empty.withAggregateValue(a, a.getOperator() == AggregateOperator.COUNT || a.getOperator() == AggregateOperator.COUNT_DISTINCT ? 0L : null)); + aggregates = List.of(empty); + } + for(AggregateResult row : aggregates) + { + List key = new ArrayList<>(); + for(Dimension dimension : dimensions) + { + key.add(dimension.slot(row.getGroupByValues().get(dimension.group()), config.getMinGroupSize())); + } + if(!key.contains(null)) + { + grouped.computeIfAbsent(key, ignored -> new ArrayList<>()).add(row); + } + } + Map, List> result = new LinkedHashMap<>(); + for(var entry : grouped.entrySet()) + { + QQueryFilter predicate = new QQueryFilter(); + entry.getKey().forEach(slot -> predicate.withSubFilter(slot.condition())); + AggregateResult row = entry.getValue().getFirst(); + if(entry.getKey().stream().anyMatch(Slot::other)) + { + var merged = aggregate(List.of(), DrillFilters.and(request.getFilter(), predicate), requested, null); + if(merged.isEmpty()) + { + continue; + } + row = merged.getFirst(); + } + List values = new ArrayList<>(); + for(int i = 0; i < measures.size(); i++) + { + PivotMeasureInfo info = measureInfo.get(i); + Serializable value = row.getAggregateValues().get(measures.get(i)); + Metric metric = new Metric().withKey(info.getKey()).withLabel(info.getLabel()).withValueType(info.getValueType()).withValue(value) + .withFormatted(AnalysisFormatting.scalar(info.getKey(), value, info.getValueType())); + if(toManyTables.isEmpty() && multiHopTables.isEmpty()) + { + metric.withDrill(DrillFilters.drill(request.getTableName(), request.getFilter(), predicate)); + } + values.add(metric); + } + new MinGroupSizeGuard(config.getMinGroupSize()).pivotMetrics(values, count(row)); + result.put(entry.getKey(), values); + } + return (result); + } + + /******************************************************************************* + ** Count is always present, even when the user selects only non-count measures. + *******************************************************************************/ + private long count(AggregateResult row) + { + Object value = row.getAggregateValues().get(count); + return (value == null ? 0 : ((Number) value).longValue()); + } + + /******************************************************************************* + ** Core owns SQL pushdown, joins, record locks, field locks and bounded fallback. + *******************************************************************************/ + private List aggregate(List groups, QQueryFilter filter, List aggregates, Integer limit) throws QException + { + QQueryFilter query = DrillFilters.restoreTypes(request.getTableName(), filter); + if(limit != null) + { + query.withOrderBy(new QFilterOrderByAggregate(count, false)); + } + AggregateInput input = new AggregateInput(request.getTableName()).withFilter(query).withQueryJoins(joins.stream().map(QueryJoin::clone).toList()) + .withAllowStreamedFallback(true).withStreamedRowLimit(config.getMaxRows()).withLimit(limit); + groups.forEach(input::withGroupBy); + new LinkedHashSet<>(aggregates).forEach(input::withAggregate); + input.setPermissionEnforcement(PermissionEnforcement.ENFORCE); + var output = new AggregateAction().execute(input); + partial |= output.getTruncated(); + return (limit == null ? output.getResults() : output.getResults().stream().sorted(java.util.Comparator.comparingLong(this::count).reversed() + .thenComparing(r -> String.valueOf(r.getGroupByValues().values()))).limit(limit).toList()); + } + + /******************************************************************************* + ** Header tuples retain typed values; Other is distinguished by its label. + *******************************************************************************/ + private static List> headers(List> keys) + { + return (keys.stream().map(key -> key.stream().map(slot -> new PivotHeader().withValue(slot.value()).withLabel(slot.label())).toList()).toList()); + } + + /******************************************************************************* + ** Partial numbers must never claim an exact drill equivalence. + *******************************************************************************/ + private void disableDrills(List metrics) + { + metrics.forEach(m -> m.withDrill(null).withEstimate(true)); + } +} + diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/ProfileSupport.java b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/ProfileSupport.java index 716de31..4039225 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/engine/ProfileSupport.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/engine/ProfileSupport.java @@ -108,6 +108,15 @@ public final class ProfileSupport ** PVS translations run as the current user; drill values always remain ids. *******************************************************************************/ public static List values(String table, QQueryFilter filter, QFieldMetaData field, List groups, long total) throws QException + { + return (values(table, filter, field, groups, total, CoreTierFieldAccessResolver.defaultResolver())); + } + + /******************************************************************************* + ** Host field policy applies to related display labels as well as source values. + *******************************************************************************/ + public static List values(String table, QQueryFilter filter, QFieldMetaData field, List groups, long total, + FieldAnalysisAccessResolver access) throws QException { List result = new ArrayList<>(); for(AnalysisBackend.GroupCount group : groups) @@ -115,7 +124,7 @@ public final class ProfileSupport String label = group.label(); if(field != null && field.getPossibleValueSourceName() != null && group.value() != null) { - String translated = AnalysisLabels.translate(field, group.value()); + String translated = AnalysisLabels.translate(field, group.value(), access); if(translated != null) { label = translated; diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotCell.java b/src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotCell.java new file mode 100644 index 0000000..8ecdccb --- /dev/null +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotCell.java @@ -0,0 +1,89 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis.result; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.List; +import com.fasterxml.jackson.annotation.JsonAutoDetect; + +/******************************************************************************* + ** Typed PivotCell contract. + *******************************************************************************/ +@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY) +public class PivotCell implements Serializable +{ + private Integer rowIndex; + private Integer columnIndex; + private List values = new ArrayList<>(); + + + /******************************************************************************* + ** Getter for rowIndex. + *******************************************************************************/ + public Integer getRowIndex() + { + return (rowIndex); + } + + /******************************************************************************* + ** Fluent setter for rowIndex. + *******************************************************************************/ + public PivotCell withRowIndex(Integer rowIndex) + { + this.rowIndex = rowIndex; + return (this); + } + + /******************************************************************************* + ** Getter for columnIndex. + *******************************************************************************/ + public Integer getColumnIndex() + { + return (columnIndex); + } + + /******************************************************************************* + ** Fluent setter for columnIndex. + *******************************************************************************/ + public PivotCell withColumnIndex(Integer columnIndex) + { + this.columnIndex = columnIndex; + return (this); + } + + /******************************************************************************* + ** Getter for values. + *******************************************************************************/ + public List getValues() + { + return (values); + } + + /******************************************************************************* + ** Fluent setter for values. + *******************************************************************************/ + public PivotCell withValues(List values) + { + this.values = values; + return (this); + } +} diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotDimension.java b/src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotDimension.java new file mode 100644 index 0000000..ffe9a13 --- /dev/null +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotDimension.java @@ -0,0 +1,88 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis.result; + +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.DateBucketUnit; + +/******************************************************************************* + ** Typed PivotDimension contract. + *******************************************************************************/ +@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY) +public class PivotDimension implements Serializable +{ + private String field; + private DateBucketUnit dateBucket; + private PivotNumericBins numericBins; + + + /******************************************************************************* + ** Getter for field. + *******************************************************************************/ + public String getField() + { + return (field); + } + + /******************************************************************************* + ** Fluent setter for field. + *******************************************************************************/ + public PivotDimension withField(String field) + { + this.field = field; + return (this); + } + + /******************************************************************************* + ** Getter for dateBucket. + *******************************************************************************/ + public DateBucketUnit getDateBucket() + { + return (dateBucket); + } + + /******************************************************************************* + ** Fluent setter for dateBucket. + *******************************************************************************/ + public PivotDimension withDateBucket(DateBucketUnit dateBucket) + { + this.dateBucket = dateBucket; + return (this); + } + + /******************************************************************************* + ** Getter for numericBins. + *******************************************************************************/ + public PivotNumericBins getNumericBins() + { + return (numericBins); + } + + /******************************************************************************* + ** Fluent setter for numericBins. + *******************************************************************************/ + public PivotDimension withNumericBins(PivotNumericBins numericBins) + { + this.numericBins = numericBins; + return (this); + } +} diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotHeader.java b/src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotHeader.java new file mode 100644 index 0000000..22f9b8d --- /dev/null +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotHeader.java @@ -0,0 +1,69 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis.result; + +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonAutoDetect; + +/******************************************************************************* + ** Typed PivotHeader contract. + *******************************************************************************/ +@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY) +public class PivotHeader implements Serializable +{ + private Serializable value; + private String label; + + + /******************************************************************************* + ** Getter for value. + *******************************************************************************/ + public Serializable getValue() + { + return (value); + } + + /******************************************************************************* + ** Fluent setter for value. + *******************************************************************************/ + public PivotHeader withValue(Serializable value) + { + this.value = value; + return (this); + } + + /******************************************************************************* + ** Getter for label. + *******************************************************************************/ + public String getLabel() + { + return (label); + } + + /******************************************************************************* + ** Fluent setter for label. + *******************************************************************************/ + public PivotHeader withLabel(String label) + { + this.label = label; + return (this); + } +} diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotMeasure.java b/src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotMeasure.java new file mode 100644 index 0000000..186cae2 --- /dev/null +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotMeasure.java @@ -0,0 +1,95 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis.result; + +import java.io.Serializable; +import java.math.BigDecimal; +import com.fasterxml.jackson.annotation.JsonAutoDetect; + +/******************************************************************************* + ** Typed PivotMeasure contract. + *******************************************************************************/ +@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY) +public class PivotMeasure implements Serializable +{ + private Operator operator; + private String field; + private BigDecimal percentile; + + /******************************************************************************* + ** Supported pivot measures. COUNT counts records, regardless of field nulls. + *******************************************************************************/ + public enum Operator + { + COUNT, SUM, AVG, MIN, MAX, COUNT_DISTINCT, PERCENTILE + } + + /******************************************************************************* + ** Getter for operator. + *******************************************************************************/ + public Operator getOperator() + { + return (operator); + } + + /******************************************************************************* + ** Fluent setter for operator. + *******************************************************************************/ + public PivotMeasure withOperator(Operator operator) + { + this.operator = operator; + return (this); + } + + /******************************************************************************* + ** Getter for field. + *******************************************************************************/ + public String getField() + { + return (field); + } + + /******************************************************************************* + ** Fluent setter for field. + *******************************************************************************/ + public PivotMeasure withField(String field) + { + this.field = field; + return (this); + } + + /******************************************************************************* + ** Getter for percentile. + *******************************************************************************/ + public BigDecimal getPercentile() + { + return (percentile); + } + + /******************************************************************************* + ** Fluent setter for percentile. + *******************************************************************************/ + public PivotMeasure withPercentile(BigDecimal percentile) + { + this.percentile = percentile; + return (this); + } +} diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotMeasureInfo.java b/src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotMeasureInfo.java new file mode 100644 index 0000000..b3abf97 --- /dev/null +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotMeasureInfo.java @@ -0,0 +1,87 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis.result; + +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonAutoDetect; + +/******************************************************************************* + ** Typed PivotMeasureInfo contract. + *******************************************************************************/ +@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY) +public class PivotMeasureInfo implements Serializable +{ + private String key; + private String label; + private ValueType valueType; + + + /******************************************************************************* + ** Getter for key. + *******************************************************************************/ + public String getKey() + { + return (key); + } + + /******************************************************************************* + ** Fluent setter for key. + *******************************************************************************/ + public PivotMeasureInfo withKey(String key) + { + this.key = key; + return (this); + } + + /******************************************************************************* + ** Getter for label. + *******************************************************************************/ + public String getLabel() + { + return (label); + } + + /******************************************************************************* + ** Fluent setter for label. + *******************************************************************************/ + public PivotMeasureInfo withLabel(String label) + { + this.label = label; + return (this); + } + + /******************************************************************************* + ** Getter for valueType. + *******************************************************************************/ + public ValueType getValueType() + { + return (valueType); + } + + /******************************************************************************* + ** Fluent setter for valueType. + *******************************************************************************/ + public PivotMeasureInfo withValueType(ValueType valueType) + { + this.valueType = valueType; + return (this); + } +} diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotNumericBins.java b/src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotNumericBins.java new file mode 100644 index 0000000..3d634ec --- /dev/null +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotNumericBins.java @@ -0,0 +1,88 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis.result; + +import java.io.Serializable; +import java.math.BigDecimal; +import com.fasterxml.jackson.annotation.JsonAutoDetect; + +/******************************************************************************* + ** Typed PivotNumericBins contract. + *******************************************************************************/ +@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY) +public class PivotNumericBins implements Serializable +{ + private Integer count = 20; + private BigDecimal min; + private BigDecimal max; + + + /******************************************************************************* + ** Getter for count. + *******************************************************************************/ + public Integer getCount() + { + return (count); + } + + /******************************************************************************* + ** Fluent setter for count. + *******************************************************************************/ + public PivotNumericBins withCount(Integer count) + { + this.count = count; + return (this); + } + + /******************************************************************************* + ** Getter for min. + *******************************************************************************/ + public BigDecimal getMin() + { + return (min); + } + + /******************************************************************************* + ** Fluent setter for min. + *******************************************************************************/ + public PivotNumericBins withMin(BigDecimal min) + { + this.min = min; + return (this); + } + + /******************************************************************************* + ** Getter for max. + *******************************************************************************/ + public BigDecimal getMax() + { + return (max); + } + + /******************************************************************************* + ** Fluent setter for max. + *******************************************************************************/ + public PivotNumericBins withMax(BigDecimal max) + { + this.max = max; + return (this); + } +} diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotRequest.java b/src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotRequest.java new file mode 100644 index 0000000..db9683a --- /dev/null +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotRequest.java @@ -0,0 +1,182 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis.result; + +import java.util.ArrayList; +import java.util.List; +import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter; + +/******************************************************************************* + ** Typed PivotRequest contract. + *******************************************************************************/ +@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY) +public class PivotRequest implements AnalysisRequest +{ + private String tableName; + private QQueryFilter filter; + private Boolean exact = true; + private List rows = new ArrayList<>(); + private List columns = new ArrayList<>(); + private List values = new ArrayList<>(); + private Boolean showTotals = true; + private Integer limitGroups = 50; + + + /******************************************************************************* + ** Getter for tableName. + *******************************************************************************/ + @Override + public String getTableName() + { + return (tableName); + } + + /******************************************************************************* + ** Fluent setter for tableName. + *******************************************************************************/ + public PivotRequest withTableName(String tableName) + { + this.tableName = tableName; + return (this); + } + + /******************************************************************************* + ** Getter for filter. + *******************************************************************************/ + @Override + public QQueryFilter getFilter() + { + return (filter); + } + + /******************************************************************************* + ** Fluent setter for filter. + *******************************************************************************/ + public PivotRequest withFilter(QQueryFilter filter) + { + this.filter = filter; + return (this); + } + + /******************************************************************************* + ** Getter for exact. + *******************************************************************************/ + @Override + public Boolean getExact() + { + return (exact); + } + + /******************************************************************************* + ** Fluent setter for exact. + *******************************************************************************/ + public PivotRequest withExact(Boolean exact) + { + this.exact = exact; + return (this); + } + + /******************************************************************************* + ** Getter for rows. + *******************************************************************************/ + public List getRows() + { + return (rows); + } + + /******************************************************************************* + ** Fluent setter for rows. + *******************************************************************************/ + public PivotRequest withRows(List rows) + { + this.rows = rows; + return (this); + } + + /******************************************************************************* + ** Getter for columns. + *******************************************************************************/ + public List getColumns() + { + return (columns); + } + + /******************************************************************************* + ** Fluent setter for columns. + *******************************************************************************/ + public PivotRequest withColumns(List columns) + { + this.columns = columns; + return (this); + } + + /******************************************************************************* + ** Getter for values. + *******************************************************************************/ + public List getValues() + { + return (values); + } + + /******************************************************************************* + ** Fluent setter for values. + *******************************************************************************/ + public PivotRequest withValues(List values) + { + this.values = values; + return (this); + } + + /******************************************************************************* + ** Getter for showTotals. + *******************************************************************************/ + public Boolean getShowTotals() + { + return (showTotals); + } + + /******************************************************************************* + ** Fluent setter for showTotals. + *******************************************************************************/ + public PivotRequest withShowTotals(Boolean showTotals) + { + this.showTotals = showTotals; + return (this); + } + + /******************************************************************************* + ** Getter for limitGroups. + *******************************************************************************/ + public Integer getLimitGroups() + { + return (limitGroups); + } + + /******************************************************************************* + ** Fluent setter for limitGroups. + *******************************************************************************/ + public PivotRequest withLimitGroups(Integer limitGroups) + { + this.limitGroups = limitGroups; + return (this); + } +} diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotResult.java b/src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotResult.java new file mode 100644 index 0000000..4e33020 --- /dev/null +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/result/PivotResult.java @@ -0,0 +1,252 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis.result; + +import java.io.Serializable; +import java.time.Instant; +import java.util.ArrayList; +import java.util.List; +import com.fasterxml.jackson.annotation.JsonAutoDetect; + +/******************************************************************************* + ** Typed PivotResult contract. + *******************************************************************************/ +@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY) +public class PivotResult implements Serializable +{ + private List> rowHeaders = new ArrayList<>(); + private List> columnHeaders = new ArrayList<>(); + private List measures = new ArrayList<>(); + private List cells = new ArrayList<>(); + private List> rowTotals = new ArrayList<>(); + private List> columnTotals = new ArrayList<>(); + private List grandTotals = new ArrayList<>(); + private Boolean truncatedRows = false; + private Boolean truncatedColumns = false; + private Boolean estimate = false; + private List warnings = new ArrayList<>(); + private Instant asOf; + + + /******************************************************************************* + ** Getter for rowHeaders. + *******************************************************************************/ + public List> getRowHeaders() + { + return (rowHeaders); + } + + /******************************************************************************* + ** Fluent setter for rowHeaders. + *******************************************************************************/ + public PivotResult withRowHeaders(List> rowHeaders) + { + this.rowHeaders = rowHeaders; + return (this); + } + + /******************************************************************************* + ** Getter for columnHeaders. + *******************************************************************************/ + public List> getColumnHeaders() + { + return (columnHeaders); + } + + /******************************************************************************* + ** Fluent setter for columnHeaders. + *******************************************************************************/ + public PivotResult withColumnHeaders(List> columnHeaders) + { + this.columnHeaders = columnHeaders; + return (this); + } + + /******************************************************************************* + ** Getter for measures. + *******************************************************************************/ + public List getMeasures() + { + return (measures); + } + + /******************************************************************************* + ** Fluent setter for measures. + *******************************************************************************/ + public PivotResult withMeasures(List measures) + { + this.measures = measures; + return (this); + } + + /******************************************************************************* + ** Getter for cells. + *******************************************************************************/ + public List getCells() + { + return (cells); + } + + /******************************************************************************* + ** Fluent setter for cells. + *******************************************************************************/ + public PivotResult withCells(List cells) + { + this.cells = cells; + return (this); + } + + /******************************************************************************* + ** Getter for rowTotals. + *******************************************************************************/ + public List> getRowTotals() + { + return (rowTotals); + } + + /******************************************************************************* + ** Fluent setter for rowTotals. + *******************************************************************************/ + public PivotResult withRowTotals(List> rowTotals) + { + this.rowTotals = rowTotals; + return (this); + } + + /******************************************************************************* + ** Getter for columnTotals. + *******************************************************************************/ + public List> getColumnTotals() + { + return (columnTotals); + } + + /******************************************************************************* + ** Fluent setter for columnTotals. + *******************************************************************************/ + public PivotResult withColumnTotals(List> columnTotals) + { + this.columnTotals = columnTotals; + return (this); + } + + /******************************************************************************* + ** Getter for grandTotals. + *******************************************************************************/ + public List getGrandTotals() + { + return (grandTotals); + } + + /******************************************************************************* + ** Fluent setter for grandTotals. + *******************************************************************************/ + public PivotResult withGrandTotals(List grandTotals) + { + this.grandTotals = grandTotals; + return (this); + } + + /******************************************************************************* + ** Getter for truncatedRows. + *******************************************************************************/ + public Boolean getTruncatedRows() + { + return (truncatedRows); + } + + /******************************************************************************* + ** Fluent setter for truncatedRows. + *******************************************************************************/ + public PivotResult withTruncatedRows(Boolean truncatedRows) + { + this.truncatedRows = truncatedRows; + return (this); + } + + /******************************************************************************* + ** Getter for truncatedColumns. + *******************************************************************************/ + public Boolean getTruncatedColumns() + { + return (truncatedColumns); + } + + /******************************************************************************* + ** Fluent setter for truncatedColumns. + *******************************************************************************/ + public PivotResult withTruncatedColumns(Boolean truncatedColumns) + { + this.truncatedColumns = truncatedColumns; + return (this); + } + + /******************************************************************************* + ** Getter for estimate. + *******************************************************************************/ + public Boolean getEstimate() + { + return (estimate); + } + + /******************************************************************************* + ** Fluent setter for estimate. + *******************************************************************************/ + public PivotResult withEstimate(Boolean estimate) + { + this.estimate = estimate; + return (this); + } + + /******************************************************************************* + ** Getter for warnings. + *******************************************************************************/ + public List getWarnings() + { + return (warnings); + } + + /******************************************************************************* + ** Fluent setter for warnings. + *******************************************************************************/ + public PivotResult withWarnings(List warnings) + { + this.warnings = warnings; + return (this); + } + + /******************************************************************************* + ** Getter for asOf. + *******************************************************************************/ + public Instant getAsOf() + { + return (asOf); + } + + /******************************************************************************* + ** Fluent setter for asOf. + *******************************************************************************/ + public PivotResult withAsOf(Instant asOf) + { + this.asOf = asOf; + return (this); + } +} diff --git a/src/main/java/com/kingsrook/qbits/dataanalysis/run/AnalysisRunService.java b/src/main/java/com/kingsrook/qbits/dataanalysis/run/AnalysisRunService.java index f9abd27..b519af8 100644 --- a/src/main/java/com/kingsrook/qbits/dataanalysis/run/AnalysisRunService.java +++ b/src/main/java/com/kingsrook/qbits/dataanalysis/run/AnalysisRunService.java @@ -441,7 +441,8 @@ public class AnalysisRunService identity.put("zone", ValueUtils.getSessionOrInstanceZoneId().getId()); identity.put("config", service.getConfigResolver().resolve(request.getTableName())); identity.put("fields", service.capabilities(request.getTableName()).getFields().stream().sorted().toList()); - identity.put("policy", com.kingsrook.qbits.dataanalysis.engine.AnalysisLabels.policy(request.getTableName())); + identity.put("fieldAccess", digest(service.fieldAccessFingerprint(request.getTableName()))); + identity.put("policy", service.fieldAccessPolicy(request.getTableName())); identity.put("backendVariants", QContext.getQSession().getBackendVariants()); try { diff --git a/src/main/resources/openapi/qqq-v1/data-analysis.yaml b/src/main/resources/openapi/qqq-v1/data-analysis.yaml index de5cdc6..5d53e6d 100644 --- a/src/main/resources/openapi/qqq-v1/data-analysis.yaml +++ b/src/main/resources/openapi/qqq-v1/data-analysis.yaml @@ -638,6 +638,206 @@ components: nullable: true type: "array" type: "object" + DataAnalysisPivotCellV1: + properties: + rowIndex: + description: "Zero-based index in rowHeaders." + type: "integer" + columnIndex: + description: "Zero-based index in columnHeaders." + type: "integer" + values: + description: "Metrics in requested measure order; suppressed metrics have\ + \ no value or drill." + items: + $ref: "#/components/schemas/DataAnalysisMetricV1" + type: "array" + type: "object" + DataAnalysisPivotDimensionV1: + properties: + field: + description: "FULL field name, optionally joinTable.field through an exposed\ + \ join." + type: "string" + dateBucket: + description: "Optional calendar or cyclic bucket in the session timezone." + enum: + - "YEAR" + - "QUARTER" + - "MONTH" + - "WEEK" + - "DAY" + - "HOUR" + - "DAY_OF_WEEK" + - "HOUR_OF_DAY" + type: "string" + numericBins: + $ref: "#/components/schemas/DataAnalysisPivotNumericBinsV1" + description: "Optional equal-width numeric bins; mutually exclusive with\ + \ dateBucket." + required: + - "field" + type: "object" + DataAnalysisPivotHeaderV1: + properties: + value: + description: "Typed group key; null for a blank group or Other." + nullable: true + label: + description: "Display label, including Other (k groups)." + type: "string" + type: "object" + DataAnalysisPivotMeasureInfoV1: + properties: + key: + description: "Stable measure key by request position." + type: "string" + label: + description: "Display label." + type: "string" + valueType: + description: "Semantic metric type." + enum: + - "COUNT" + - "DECIMAL" + - "PERCENT" + - "DATE" + - "DATE_TIME" + - "DURATION" + - "TEXT" + type: "string" + type: "object" + DataAnalysisPivotMeasureV1: + properties: + operator: + description: "Aggregate operator. COUNT counts records, including null values." + enum: + - "COUNT" + - "SUM" + - "AVG" + - "MIN" + - "MAX" + - "COUNT_DISTINCT" + - "PERCENTILE" + type: "string" + field: + description: "FULL field to aggregate; optional for COUNT." + type: "string" + percentile: + description: "PERCENTILE only: percentile_cont fraction from 0 to 1." + type: "number" + required: + - "operator" + type: "object" + DataAnalysisPivotNumericBinsV1: + properties: + count: + description: "Number of bins, 1–200; defaults to 20." + type: "integer" + min: + description: "Optional explicit lower bound; otherwise a nice enclosing\ + \ edge." + type: "number" + max: + description: "Optional explicit upper bound; final interior bin includes\ + \ this value." + type: "number" + type: "object" + DataAnalysisPivotRequestV1: + properties: + filter: + $ref: "#/components/schemas/QueryFilter" + description: "User query filter, passed through for core enforcement." + rows: + description: "One to three row dimensions." + items: + $ref: "#/components/schemas/DataAnalysisPivotDimensionV1" + type: "array" + columns: + description: "Zero to two column dimensions; defaults to empty." + items: + $ref: "#/components/schemas/DataAnalysisPivotDimensionV1" + type: "array" + values: + description: "One to six measures." + items: + $ref: "#/components/schemas/DataAnalysisPivotMeasureV1" + type: "array" + showTotals: + description: "Include row, column and grand totals; defaults to true." + type: "boolean" + limitGroups: + description: "Kept groups per dimension; default 50, maximum 200." + type: "integer" + required: + - "rows" + - "values" + type: "object" + DataAnalysisPivotV1: + properties: + rowHeaders: + description: "Row header tuples in cell-index order." + items: + items: + $ref: "#/components/schemas/DataAnalysisPivotHeaderV1" + type: "array" + type: "array" + columnHeaders: + description: "Column header tuples; an empty tuple represents no column\ + \ dimensions." + items: + items: + $ref: "#/components/schemas/DataAnalysisPivotHeaderV1" + type: "array" + type: "array" + measures: + description: "Measure metadata in request order." + items: + $ref: "#/components/schemas/DataAnalysisPivotMeasureInfoV1" + type: "array" + cells: + description: "Sparse cells; absent combinations are not materialized." + items: + $ref: "#/components/schemas/DataAnalysisPivotCellV1" + type: "array" + rowTotals: + description: "Metric tuples aligned with rowHeaders; empty when totals disabled." + items: + items: + $ref: "#/components/schemas/DataAnalysisMetricV1" + type: "array" + type: "array" + columnTotals: + description: "Metric tuples aligned with columnHeaders; empty when totals\ + \ disabled." + items: + items: + $ref: "#/components/schemas/DataAnalysisMetricV1" + type: "array" + type: "array" + grandTotals: + description: "Grand-total metrics; empty when totals disabled." + items: + $ref: "#/components/schemas/DataAnalysisMetricV1" + type: "array" + truncatedRows: + description: "Row groups were merged into Other." + type: "boolean" + truncatedColumns: + description: "Column groups were merged into Other." + type: "boolean" + estimate: + description: "True when bounded streamed fallback produced a partial result." + type: "boolean" + warnings: + description: "Privacy, partial-result and joined-drill limitations." + items: + type: "string" + type: "array" + asOf: + description: "UTC timestamp of computation." + type: "string" + type: "object" DataAnalysisPointV1: nullable: true properties: @@ -965,10 +1165,10 @@ components: info: contact: email: "contact@kingsrook.com" - description: "Profiles, distinct values, duplicate groups and exact analysis runs\ - \ as the signed-in user." + description: "Profiles, pivots, distinct values, duplicate groups and exact analysis\ + \ runs as the signed-in user." title: "QQQ Middleware API extension: data-analysis" - version: "1.0.0" + version: "1.1.0" openapi: "3.0.3" paths: /qqq/v1/qbit/data-analysis/tables/{table}/capabilities: @@ -1050,6 +1250,35 @@ paths: - sessionUuidCookie: - "N/A" summary: "List distinct column values" + /qqq/v1/qbit/data-analysis/tables/{table}/pivot: + post: + description: "Group records by up to 3 row and 2 column fields (with date or\ + \ numeric buckets) and compute counts, sums, averages, min/max, distinct counts\ + \ or percentiles per cell; every cell has a drill-through filter." + parameters: + - description: "QQQ table name to analyze." + in: "path" + name: "table" + required: true + schema: + type: "string" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataAnalysisPivotRequestV1" + required: true + responses: + 200: + content: + application/json: + schema: + $ref: "#/components/schemas/DataAnalysisPivotV1" + description: "Successful Response" + security: + - sessionUuidCookie: + - "N/A" + summary: "Explore a pivot table" /qqq/v1/qbit/data-analysis/tables/{table}/table-profile: post: description: "Profile readable fields under a filter for completeness, uniqueness,\ diff --git a/src/test/java/com/kingsrook/qbits/dataanalysis/CoreAnalysisBackendTest.java b/src/test/java/com/kingsrook/qbits/dataanalysis/CoreAnalysisBackendTest.java index ed2a248..d07a423 100644 --- a/src/test/java/com/kingsrook/qbits/dataanalysis/CoreAnalysisBackendTest.java +++ b/src/test/java/com/kingsrook/qbits/dataanalysis/CoreAnalysisBackendTest.java @@ -202,4 +202,28 @@ class CoreAnalysisBackendTest extends EngineFixture }); } } + + /******************************************************************************* + ** Core fallback limits never produce a falsely exact pivot drill. + *******************************************************************************/ + @Test + void partialPivotDisablesDrills() throws Exception + { + capabilities(Set.of()); + config.withDefaultMaxRows(3); + service.getConfigResolver().invalidate(); + var request = new com.kingsrook.qbits.dataanalysis.result.PivotRequest().withTableName("orders") + .withRows(java.util.List.of(new com.kingsrook.qbits.dataanalysis.result.PivotDimension().withField("created") + .withDateBucket(com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.DateBucketUnit.DAY))) + .withValues(java.util.List.of(new com.kingsrook.qbits.dataanalysis.result.PivotMeasure().withField("amount") + .withOperator(com.kingsrook.qbits.dataanalysis.result.PivotMeasure.Operator.PERCENTILE).withPercentile(new java.math.BigDecimal("0.5")))); + var result = service.pivot(request); + assertThat(result.getEstimate()).isTrue(); + assertThat(result.getWarnings()).anyMatch(w -> w.startsWith("Partial pivot")); + assertThat(result.getCells()).isNotEmpty().allSatisfy(c -> assertThat(c.getValues()).allSatisfy(m -> + { + assertThat(m.getDrill()).isNull(); + assertThat(m.getEstimate()).isTrue(); + })); + } } diff --git a/src/test/java/com/kingsrook/qbits/dataanalysis/DataAnalysisApiTest.java b/src/test/java/com/kingsrook/qbits/dataanalysis/DataAnalysisApiTest.java index 1c6d144..5f12f49 100644 --- a/src/test/java/com/kingsrook/qbits/dataanalysis/DataAnalysisApiTest.java +++ b/src/test/java/com/kingsrook/qbits/dataanalysis/DataAnalysisApiTest.java @@ -169,7 +169,7 @@ class DataAnalysisApiTest extends EngineFixture assertThat(denied.getStatus()).isEqualTo(403); assertThat(run.path(operation.equals("COLUMN_PROFILE") ? "columnProfile" : "tableProfile").isObject()).isTrue(); } - assertThat(invoker.listOperations().stream().filter(o -> o.pathTemplate().startsWith(DataAnalysisApi.PREFIX)).toList()).hasSize(7); + assertThat(invoker.listOperations().stream().filter(o -> o.pathTemplate().startsWith(DataAnalysisApi.PREFIX)).toList()).hasSize(8); var client = java.net.http.HttpClient.newHttpClient(); var response = client.send(java.net.http.HttpRequest.newBuilder(java.net.URI.create("http://127.0.0.1:" + server.getBoundPort() + "/qqq/v1/openapi.json")).build(), java.net.http.HttpResponse.BodyHandlers.ofString()); assertThat(response.statusCode()).isEqualTo(200); @@ -255,7 +255,7 @@ class DataAnalysisApiTest extends EngineFixture call(HttpMethod.POST, "/runs", Map.of("operation", "PIVOT"), 400); call(HttpMethod.POST, "/runs", com.fasterxml.jackson.databind.node.NullNode.getInstance(), 400); call(HttpMethod.POST, "/tables/{table}/column-profile", Map.of("fieldName", "amount", "filter", - Map.of("criteria", List.of(Map.of("fieldName", "secret", "operator", "EQUALS", "values", List.of("hidden"))))), 400); + Map.of("criteria", List.of(Map.of("fieldName", "secret", "operator", "EQUALS", "values", List.of("hidden"))))), 403); var absent = invoker.invoke(new UiApiRequest().withMethod(HttpMethod.GET).withPath(DataAnalysisApi.PREFIX + "/tables/{table}/capabilities") .withPathParam("table", "missing").withSessionUUID(caller).withUserTimezone("America/Chicago")); assertThat(absent.getStatus()).isEqualTo(404); @@ -269,7 +269,7 @@ class DataAnalysisApiTest extends EngineFixture } /******************************************************************************* - ** Generated fragment is committed verbatim and has only the seven operations. + ** Generated fragment is committed verbatim and has only the eight operations. *******************************************************************************/ @Test void contract() throws Exception @@ -286,5 +286,38 @@ class DataAnalysisApiTest extends EngineFixture assertThat(Files.exists(path)).as("Regenerate with ./mvnw -o test -Dtest=DataAnalysisApiTest#contract -Dopenapi.write=true -Dqqq.snapshot.version=4.1.0-DATAANALYSIS-SNAPSHOT").isTrue(); assertThat(Files.readString(path).replace("\r\n", "\n")).as("OpenAPI changed: regenerate with -Dopenapi.write=true").isEqualTo(yaml.replace("\r\n", "\n")); } + @Test + void pivotHttp() throws Exception + { + start(); + var body = Map.of("rows", List.of(Map.of("field", "status")), "columns", List.of(Map.of("field", "customer")), + "values", List.of(Map.of("operator", "COUNT"))); + JsonNode result = call(HttpMethod.POST, "/tables/{table}/pivot", body, 200); + assertThat(result.path("cells").size()).isEqualTo(4); + checkDrills(result); + checkDrills(call(HttpMethod.POST, "/tables/{table}/pivot", Map.of("rows", List.of(Map.of("field", "paid")), + "values", List.of(Map.of("operator", "COUNT")), "limitGroups", 1), 200)); + for(String field : List.of("note", "amount", "quantity")) + { + checkDrills(call(HttpMethod.POST, "/tables/{table}/pivot", Map.of("rows", List.of(Map.of("field", field)), + "values", List.of(Map.of("operator", "COUNT")), "limitGroups", 1), 200)); + } + for(String unit : List.of("DAY", "HOUR", "DAY_OF_WEEK", "HOUR_OF_DAY")) + { + checkDrills(call(HttpMethod.POST, "/tables/{table}/pivot", Map.of("rows", List.of(Map.of("field", "created", "dateBucket", unit)), + "values", List.of(Map.of("operator", "COUNT"))), 200)); + } + checkDrills(call(HttpMethod.POST, "/tables/{table}/pivot", Map.of("rows", List.of(Map.of("field", "amount", "numericBins", Map.of("count", 10))), + "values", List.of(Map.of("operator", "COUNT"))), 200)); + for(String field : List.of("secret", "missing")) + { + call(HttpMethod.POST, "/tables/{table}/pivot", Map.of("rows", List.of(Map.of("field", field)), "values", List.of(Map.of("operator", "COUNT"))), 400); + call(HttpMethod.POST, "/tables/{table}/pivot", Map.of("rows", List.of(Map.of("field", "status")), "values", List.of(Map.of("operator", "MIN", "field", field))), 400); + } + call(HttpMethod.POST, "/tables/{table}/pivot", Map.of(), 400); + call(HttpMethod.POST, "/tables/{table}/pivot", Map.of("rows", "status", "values", List.of(Map.of("operator", "COUNT"))), 400); + call(HttpMethod.POST, "/tables/{table}/pivot", Map.of("rows", List.of(Map.of("field", "status")), "values", List.of(Map.of("operator", "COUNT")), "limitGroups", 1.5), 400); + caller = "denied"; + call(HttpMethod.POST, "/tables/{table}/pivot", body, 403); + } } - diff --git a/src/test/java/com/kingsrook/qbits/dataanalysis/EngineContractTest.java b/src/test/java/com/kingsrook/qbits/dataanalysis/EngineContractTest.java index 3275715..e16bbe4 100644 --- a/src/test/java/com/kingsrook/qbits/dataanalysis/EngineContractTest.java +++ b/src/test/java/com/kingsrook/qbits/dataanalysis/EngineContractTest.java @@ -61,7 +61,7 @@ import static org.assertj.core.api.Assertions.within; /******************************************************************************* ** Shared backend acceptance tests, including a generic drill equivalence walker. *******************************************************************************/ -abstract class EngineContractTest extends EngineFixture +abstract class EngineContractTest extends PivotContractTest { /******************************************************************************* ** Every emitted key across all profile kinds has a label, on every backend. @@ -249,7 +249,7 @@ abstract class EngineContractTest extends EngineFixture void permissionChecks() throws Exception { assertThat(service.capabilities("orders").getFields()).doesNotContain("secret"); - assertThatThrownBy(() -> service.columnProfile(column("secret"))).isInstanceOf(QPermissionDeniedException.class); + assertThatThrownBy(() -> service.columnProfile(column("secret"))).isInstanceOf(com.kingsrook.qqq.backend.core.exceptions.QBadRequestException.class); QContext.init(instance, TestSupport.user("alice").withPermission("orders.analyze")); assertThatThrownBy(() -> service.columnProfile(column("amount"))).isInstanceOf(QPermissionDeniedException.class); QContext.init(instance, TestSupport.user("alice").withPermission("orders.read")); @@ -258,7 +258,7 @@ abstract class EngineContractTest extends EngineFixture config.withTableDefaults(Map.of("orders", new TableAnalysisDefaults().withExcludedFields(Set.of("amount")))); service.getConfigResolver().invalidate(); assertThat(service.capabilities("orders").getFields()).doesNotContain("amount"); - assertThatThrownBy(() -> service.columnProfile(column("amount"))).isInstanceOf(QPermissionDeniedException.class); + assertThatThrownBy(() -> service.columnProfile(column("amount"))).isInstanceOf(com.kingsrook.qqq.backend.core.exceptions.QBadRequestException.class); assertThatThrownBy(() -> service.capabilities("missing")).isInstanceOf(QPermissionDeniedException.class); } diff --git a/src/test/java/com/kingsrook/qbits/dataanalysis/FieldAnalysisAccessTest.java b/src/test/java/com/kingsrook/qbits/dataanalysis/FieldAnalysisAccessTest.java new file mode 100644 index 0000000..fb25ada --- /dev/null +++ b/src/test/java/com/kingsrook/qbits/dataanalysis/FieldAnalysisAccessTest.java @@ -0,0 +1,244 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis; + +import java.util.List; +import java.util.concurrent.atomic.AtomicReference; +import com.kingsrook.qbits.dataanalysis.engine.CoreTierFieldAccessResolver; +import com.kingsrook.qbits.dataanalysis.engine.DrillFilters; +import com.kingsrook.qbits.dataanalysis.engine.FieldAnalysisAccess; +import com.kingsrook.qbits.dataanalysis.engine.FieldAnalysisAccessResolver; +import com.kingsrook.qbits.dataanalysis.engine.FieldSecurityLockFieldAccessResolver; +import com.kingsrook.qbits.dataanalysis.result.DistinctValuesRequest; +import com.kingsrook.qbits.dataanalysis.result.ValueCount; +import com.kingsrook.qbits.dataanalysis.result.ColumnProfile; +import com.kingsrook.qbits.dataanalysis.result.ColumnProfileRequest; +import com.kingsrook.qbits.dataanalysis.result.Metric; +import com.kingsrook.qbits.dataanalysis.result.PivotCell; +import com.kingsrook.qbits.dataanalysis.result.PivotDimension; +import com.kingsrook.qbits.dataanalysis.result.PivotMeasure; +import com.kingsrook.qbits.dataanalysis.result.PivotRequest; +import com.kingsrook.qbits.dataanalysis.result.PivotResult; +import com.kingsrook.qqq.backend.core.context.QContext; +import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData; +import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData; +import com.kingsrook.qqq.backend.core.model.actions.tables.query.QCriteriaOperator; +import com.kingsrook.qqq.backend.core.utils.JsonUtils; +import org.junit.jupiter.api.Test; +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatThrownBy; +import static org.assertj.core.api.Assertions.within; + +/******************************************************************************* + ** Exercise reflection without shadowing a future real core package on test classpaths. + *******************************************************************************/ +class FieldAnalysisAccessTest extends EngineFixture +{ + /******************************************************************************* + ** Test helper for field-access behavior. + *******************************************************************************/ + public static class TierApi + { + static String tier = "FULL"; + static boolean fail; + /******************************************************************************* + ** Verify or support the pivot and field-access contract. + *******************************************************************************/ + public static String getTier(QTableMetaData table, String field) + { + if(fail) + { + throw new IllegalStateException("unavailable"); + } + return (tier); + } + /******************************************************************************* + ** Verify or support the pivot and field-access contract. + *******************************************************************************/ + public static String getAccessFingerprint() + { + if(fail) + { + throw new IllegalStateException("unavailable"); + } + return ("policy-v1"); + } + } + + /******************************************************************************* + ** Test helper for field-access behavior. + *******************************************************************************/ + public static class TierOnlyApi + { + /******************************************************************************* + ** Verify or support the pivot and field-access contract. + *******************************************************************************/ + public static String getTier(QTableMetaData table, String field) + { + return ("FULL"); + } + } + + /******************************************************************************* + ** Verify or support the pivot and field-access contract. + *******************************************************************************/ + @Test + void legacyFallbackAndReflectiveTierMapping() throws Exception + { + var table = instance.getTable("orders"); + var fallback = new FieldSecurityLockFieldAccessResolver(); + assertThat(fallback.resolve(table, table.getField("amount"))).isEqualTo(FieldAnalysisAccess.FULL); + assertThat(fallback.resolve(table, table.getField("secret"))).isEqualTo(FieldAnalysisAccess.NONE); + // The snapshot has no tier package. Test the actual default selection. + assertThat(CoreTierFieldAccessResolver.defaultResolver()).isInstanceOf(FieldSecurityLockFieldAccessResolver.class); + var resolver = new CoreTierFieldAccessResolver(TierApi.class); + try + { + for(String tier : List.of("FULL", "REVEALABLE", "MASKED", "HIDDEN", "UNKNOWN")) + { + TierApi.tier = tier; + assertThat(resolver.resolve(table, table.getField("amount"))).isEqualTo(tier.equals("FULL") ? FieldAnalysisAccess.FULL : tier.equals("REVEALABLE") ? FieldAnalysisAccess.EXACT_MATCH_ONLY : FieldAnalysisAccess.NONE); + } + assertThat(resolver.getAccessFingerprint()).isEqualTo("policy-v1"); + TierApi.fail = true; + assertThat(resolver.resolve(table, table.getField("amount"))).isEqualTo(FieldAnalysisAccess.NONE); + assertThatThrownBy(resolver::getAccessFingerprint).isInstanceOf(IllegalStateException.class); + assertThat(new CoreTierFieldAccessResolver(TierOnlyApi.class).getAccessFingerprint()).isEmpty(); + } + finally + { + TierApi.fail = false; + TierApi.tier = "FULL"; + } + } + + /******************************************************************************* + ** Verify or support the pivot and field-access contract. + *******************************************************************************/ + @Test + void customPolicyAndUserFilterPassThrough() throws Exception + { + config.withFieldAnalysisAccessResolver(() -> (table, field) -> field.getName().equals("note") ? FieldAnalysisAccess.NONE + : field.getName().equals("paid") ? FieldAnalysisAccess.EXACT_MATCH_ONLY : new FieldSecurityLockFieldAccessResolver().resolve(table, field)); + service = new DataAnalysisService(config, Runnable::run); + assertThat(service.capabilities("orders").getFields()).doesNotContain("note", "paid", "secret"); + for(String field : List.of("note", "paid")) + { + assertThatThrownBy(() -> service.columnProfile(new ColumnProfileRequest().withTableName("orders").withFieldName(field))) + .isInstanceOf(com.kingsrook.qqq.backend.core.exceptions.QBadRequestException.class); + assertThatThrownBy(() -> service.pivot(new PivotRequest().withTableName("orders").withRows(List.of(new PivotDimension().withField(field))) + .withValues(List.of(new PivotMeasure().withOperator(PivotMeasure.Operator.COUNT))))) + .isInstanceOf(com.kingsrook.qqq.backend.core.exceptions.QBadRequestException.class); + assertThatThrownBy(() -> service.pivot(new PivotRequest().withTableName("orders").withRows(List.of(new PivotDimension().withField("status"))) + .withValues(List.of(new PivotMeasure().withOperator(PivotMeasure.Operator.MIN).withField(field))))) + .isInstanceOf(com.kingsrook.qqq.backend.core.exceptions.QBadRequestException.class); + } + var request = new PivotRequest().withTableName("orders").withRows(List.of(new PivotDimension().withField("status"))) + .withValues(List.of(new PivotMeasure().withOperator(PivotMeasure.Operator.COUNT))); + assertThat(JsonUtils.toJson(service.pivot(request))).doesNotContain("\"fieldName\":\"note\"", "\"fieldName\":\"paid\""); + var ownFilter = DrillFilters.condition("paid", QCriteriaOperator.EQUALS, true); + String before = JsonUtils.toJson(ownFilter); + PivotResult result = service.pivot(request.withFilter(ownFilter)); + assertThat(JsonUtils.toJson(ownFilter)).isEqualTo(before); + assertThat(((Number)result.getGrandTotals().getFirst().getValue()).intValue()).isEqualTo(6); + for(PivotCell cell : result.getCells()) + { + var drill = cell.getValues().getFirst().getDrill().getFilter(); + assertThat(JsonUtils.toJson(drill.getSubFilters().getFirst())).isEqualTo(before); + assertThat(JsonUtils.toJson(drill.getSubFilters().get(1))).doesNotContain("paid", "note"); + } + } + + /******************************************************************************* + ** Verify or support the pivot and field-access contract. + *******************************************************************************/ + @Test + void cacheMissesOnFieldTierAndCoreFingerprintChanges() throws Exception + { + AtomicReference tier = new AtomicReference<>(FieldAnalysisAccess.FULL); + AtomicReference fingerprint = new AtomicReference<>("first"); + config.withFieldAnalysisAccessResolver(() -> new FieldAnalysisAccessResolver() + { + /******************************************************************************* + ** Verify or support the pivot and field-access contract. + *******************************************************************************/ + @Override + public FieldAnalysisAccess resolve(QTableMetaData table, QFieldMetaData field) + { + return (field.getName().equals("quantity") ? tier.get() : new FieldSecurityLockFieldAccessResolver().resolve(table, field)); + } + /******************************************************************************* + ** Verify or support the pivot and field-access contract. + *******************************************************************************/ + @Override + public String getAccessFingerprint() + { + return (fingerprint.get()); + } + }); + service = new DataAnalysisService(config, Runnable::run); + ColumnProfileRequest request = new ColumnProfileRequest().withTableName("orders").withFieldName("amount").withExact(true); + String first = service.startExactRun(request); + assertThat(service.startExactRun(request)).isEqualTo(first); + tier.set(FieldAnalysisAccess.EXACT_MATCH_ONLY); + String second = service.startExactRun(request); + assertThat(second).isNotEqualTo(first); + assertThatThrownBy(() -> service.getRun(first)).isInstanceOf(com.kingsrook.qqq.backend.core.exceptions.QPermissionDeniedException.class); + fingerprint.set("second"); + assertThat(service.startExactRun(request)).isNotEqualTo(second); + } + /******************************************************************************* + ** Verify or support the pivot and field-access contract. + *******************************************************************************/ + @Test + void generatedRepresentativeDrillsCannotUseRestrictedPrimaryKey() throws Exception + { + config.withFieldAnalysisAccessResolver(() -> (table, field) -> field.getName().equals("id") ? FieldAnalysisAccess.NONE + : new FieldSecurityLockFieldAccessResolver().resolve(table, field)); + service = new DataAnalysisService(config, Runnable::run); + ColumnProfile profile = service.columnProfile(new ColumnProfileRequest().withTableName("orders").withFieldName("status").withExact(true)); + Metric distinct = profile.getCounts().stream().filter(m -> m.getKey().equals("distinct")).findFirst().orElseThrow(); + assertThat(distinct.getDrill()).isNull(); + assertThat(profile.getCounts().getFirst().getDrill()).isNotNull(); + var ownFilter = DrillFilters.condition("id", QCriteriaOperator.EQUALS, 1); + profile = service.columnProfile(new ColumnProfileRequest().withTableName("orders").withFieldName("status").withFilter(ownFilter).withExact(true)); + assertThat(profile.getCounts().getFirst().getDrill()).isNotNull(); + assertThat(JsonUtils.toJson(profile.getCounts().getFirst().getDrill())).contains("id"); + } + /******************************************************************************* + ** Related label tiers must neither leak labels nor reuse a stale cache entry. + *******************************************************************************/ + @Test + void relatedLabelTierChangesInvalidateCache() throws Exception + { + AtomicReference tier = new AtomicReference<>(FieldAnalysisAccess.FULL); + config.withFieldAnalysisAccessResolver(() -> (table, field) -> table.getName().equals("customer") && field.getName().equals("name") + ? tier.get() : new FieldSecurityLockFieldAccessResolver().resolve(table, field)); + service = new DataAnalysisService(config, Runnable::run); + ColumnProfileRequest request = new ColumnProfileRequest().withTableName("orders").withFieldName("customer").withExact(true); + String first = service.startExactRun(request); + assertThat(service.columnProfile(request).getTopValues()).extracting(ValueCount::getLabel).contains("Alice Co"); + tier.set(FieldAnalysisAccess.NONE); + assertThat(service.startExactRun(request)).isNotEqualTo(first); + assertThat(service.columnProfile(request).getTopValues()).extracting(ValueCount::getLabel).containsExactly("1", "2"); + assertThat(service.distinctValues(new DistinctValuesRequest().withTableName("orders").withFieldName("customer")).getValues()).extracting(ValueCount::getLabel).containsExactly("1", "2"); + } +} diff --git a/src/test/java/com/kingsrook/qbits/dataanalysis/PivotContractTest.java b/src/test/java/com/kingsrook/qbits/dataanalysis/PivotContractTest.java new file mode 100644 index 0000000..0443a6e --- /dev/null +++ b/src/test/java/com/kingsrook/qbits/dataanalysis/PivotContractTest.java @@ -0,0 +1,350 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * 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 + * + * https://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.dataanalysis; + +import java.math.BigDecimal; +import java.util.List; +import java.util.ArrayList; +import com.kingsrook.qbits.dataanalysis.result.Drill; +import com.kingsrook.qbits.dataanalysis.result.Metric; +import com.kingsrook.qbits.dataanalysis.result.PivotCell; +import com.kingsrook.qbits.dataanalysis.result.PivotDimension; +import com.kingsrook.qbits.dataanalysis.result.PivotHeader; +import com.kingsrook.qbits.dataanalysis.result.PivotMeasure; +import com.kingsrook.qbits.dataanalysis.result.PivotNumericBins; +import com.kingsrook.qbits.dataanalysis.result.PivotRequest; +import com.kingsrook.qbits.dataanalysis.result.PivotResult; +import com.kingsrook.qbits.dataanalysis.result.ValueType; +import com.kingsrook.qbits.dataanalysis.engine.DrillFilters; +import com.kingsrook.qqq.backend.core.actions.permissions.PermissionEnforcement; +import com.kingsrook.qqq.backend.core.actions.tables.CountAction; +import com.kingsrook.qqq.backend.core.actions.tables.QueryAction; +import com.kingsrook.qqq.backend.core.context.QContext; +import com.kingsrook.qqq.backend.core.model.actions.tables.count.CountInput; +import com.kingsrook.qqq.backend.core.model.actions.tables.query.QCriteriaOperator; +import com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryInput; +import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.DateBucketUnit; +import com.kingsrook.qqq.backend.core.model.metadata.joins.QJoinMetaData; +import com.kingsrook.qqq.backend.core.model.metadata.joins.JoinOn; +import com.kingsrook.qqq.backend.core.model.metadata.joins.JoinType; +import com.kingsrook.qqq.backend.core.model.metadata.tables.ExposedJoin; +import com.kingsrook.qqq.backend.core.utils.JsonUtils; +import org.junit.jupiter.api.Test; +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatThrownBy; +import static org.assertj.core.api.Assertions.within; + +/******************************************************************************* + ** Pivot contract inherited by every existing backend test configuration. + *******************************************************************************/ +abstract class PivotContractTest extends EngineFixture +{ + /******************************************************************************* + ** Verify or support the pivot and field-access contract. + *******************************************************************************/ + protected PivotDimension dimension(String field) + { + return (new PivotDimension().withField(field)); + } + + /******************************************************************************* + ** Verify or support the pivot and field-access contract. + *******************************************************************************/ + protected PivotMeasure measure(PivotMeasure.Operator operator, String field) + { + return (new PivotMeasure().withOperator(operator).withField(field)); + } + + /******************************************************************************* + ** Verify or support the pivot and field-access contract. + *******************************************************************************/ + protected PivotRequest pivot(List rows, List columns) + { + return (new PivotRequest().withTableName("orders").withRows(rows.stream().map(this::dimension).toList()) + .withColumns(columns.stream().map(this::dimension).toList()).withValues(List.of(measure(PivotMeasure.Operator.COUNT, null)))); + } + + /******************************************************************************* + ** Verify or support the pivot and field-access contract. + *******************************************************************************/ + private void equalNumber(Metric metric, String value) + { + assertThat(new BigDecimal(metric.getValue().toString())).isEqualByComparingTo(value); + } + + /******************************************************************************* + ** Verify or support the pivot and field-access contract. + *******************************************************************************/ + protected void countDrills(PivotResult result) throws Exception + { + List> groups = new ArrayList<>(result.getRowTotals()); + groups.addAll(result.getColumnTotals()); + groups.add(result.getGrandTotals()); + result.getCells().forEach(c -> groups.add(c.getValues())); + for(List metrics : groups) + { + for(Metric metric : metrics) + { + if(metric.getKey().equals("value0") && !metric.getSuppressed()) + { + assertThat(metric.getDrill()).isNotNull(); + Drill drill = JsonUtils.toObject(JsonUtils.toJson(metric.getDrill()), Drill.class); + CountInput input = new CountInput(drill.getTableName()).withFilter(drill.getFilter()); + input.setPermissionEnforcement(PermissionEnforcement.ENFORCE); + assertThat(new CountAction().execute(input).getCount()).as(JsonUtils.toJson(drill)).isEqualTo(((Number) metric.getValue()).intValue()); + QueryInput query = new QueryInput(drill.getTableName()).withFilter(drill.getFilter()); + query.setPermissionEnforcement(PermissionEnforcement.ENFORCE); + assertThat(new QueryAction().execute(query).getRecords()).as(JsonUtils.toJson(drill)).hasSize(((Number) metric.getValue()).intValue()); + } + } + } + } + + /******************************************************************************* + ** Verify or support the pivot and field-access contract. + *******************************************************************************/ + @Test + void pivotShapesAndTotals() throws Exception + { + for(PivotRequest request : List.of(pivot(List.of("status"), List.of("customer")), pivot(List.of("status", "paid"), List.of("customer")), + pivot(List.of("status"), List.of("customer", "paid")))) + { + PivotResult result = service.pivot(request); + equalNumber(result.getGrandTotals().getFirst(), "12"); + assertThat(result.getCells().stream().mapToLong(c -> ((Number)c.getValues().getFirst().getValue()).longValue()).sum()).isEqualTo(12); + countDrills(result); + } + PivotResult result = service.pivot(pivot(List.of("status"), List.of("customer"))); + assertThat(result.getCells()).hasSize(4); + assertThat(result.getCells()).allSatisfy(c -> assertThat(((Number)c.getValues().getFirst().getValue()).longValue()).isIn(2L, 4L)); + assertThat(result.getRowTotals()).allSatisfy(m -> equalNumber(m.getFirst(), "6")); + result = service.pivot(pivot(List.of("status"), List.of()).withShowTotals(false)); + assertThat(result.getGrandTotals()).isEmpty(); + assertThat(result.getRowTotals()).isEmpty(); + assertThat(result.getColumnHeaders()).containsExactly(List.of()); + } + + /******************************************************************************* + ** Verify or support the pivot and field-access contract. + *******************************************************************************/ + @Test + void pivotOtherAndNonAdditiveMeasures() throws Exception + { + PivotRequest request = pivot(List.of("quantity"), List.of("status")).withLimitGroups(1).withValues(List.of( + measure(PivotMeasure.Operator.COUNT, null), measure(PivotMeasure.Operator.SUM, "amount"), measure(PivotMeasure.Operator.AVG, "amount"), + measure(PivotMeasure.Operator.COUNT_DISTINCT, "amount"), measure(PivotMeasure.Operator.PERCENTILE, "amount").withPercentile(new BigDecimal("0.5")))); + PivotResult result = service.pivot(request); + assertThat(result.getTruncatedRows()).isTrue(); + assertThat(result.getTruncatedColumns()).isTrue(); + assertThat(result.getRowHeaders().stream().flatMap(List::stream).map(PivotHeader::getLabel)).anyMatch(l -> l.equals("Other (5 groups)")); + equalNumber(result.getGrandTotals().get(1), "1170"); + equalNumber(result.getGrandTotals().get(3), "8"); + equalNumber(result.getGrandTotals().get(4), "20"); + countDrills(result); + for(PivotCell cell : result.getCells()) + { + var input = new com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryInput("orders").withFilter(cell.getValues().getFirst().getDrill().getFilter()); + input.setPermissionEnforcement(PermissionEnforcement.ENFORCE); + var numbers = new com.kingsrook.qqq.backend.core.actions.tables.QueryAction().execute(input).getRecords().stream().map(r -> r.getValueBigDecimal("amount")) + .filter(java.util.Objects::nonNull).sorted().toList(); + BigDecimal sum = numbers.stream().reduce(BigDecimal.ZERO, BigDecimal::add); + equalNumber(cell.getValues().get(1), sum.toString()); + assertThat(new BigDecimal(cell.getValues().get(2).getValue().toString()).doubleValue()).isCloseTo(sum.doubleValue() / numbers.size(), within(0.000000001)); + equalNumber(cell.getValues().get(3), Long.toString(numbers.stream().map(BigDecimal::stripTrailingZeros).distinct().count())); + BigDecimal median = numbers.size() % 2 == 1 ? numbers.get(numbers.size() / 2) : numbers.get(numbers.size() / 2 - 1).add(numbers.get(numbers.size() / 2)).divide(BigDecimal.valueOf(2)); + equalNumber(cell.getValues().get(4), median.toString()); + } + for(String field : List.of("paid", "note", "amount")) + { + countDrills(service.pivot(pivot(List.of(field), List.of()).withLimitGroups(1))); + } + } + + /******************************************************************************* + ** Verify or support the pivot and field-access contract. + *******************************************************************************/ + @Test + void pivotBuckets() throws Exception + { + for(DateBucketUnit unit : DateBucketUnit.values()) + { + PivotRequest request = pivot(List.of("created"), List.of("status")).withRows(List.of(dimension("created").withDateBucket(unit))); + PivotResult result = service.pivot(request); + equalNumber(result.getGrandTotals().getFirst(), "12"); + countDrills(result); + } + PivotResult dates = service.pivot(pivot(List.of("order_date"), List.of("status")).withRows(List.of(dimension("order_date").withDateBucket(DateBucketUnit.DAY)))); + assertThat(dates.getCells()).hasSize(4); + countDrills(dates); + for(PivotNumericBins bins : List.of(new PivotNumericBins().withCount(4).withMin(BigDecimal.ZERO).withMax(BigDecimal.valueOf(40)), new PivotNumericBins().withCount(10))) + { + countDrills(service.pivot(pivot(List.of("amount"), List.of("status")).withRows(List.of(dimension("amount").withNumericBins(bins))))); + } + } + + /******************************************************************************* + ** Verify or support the pivot and field-access contract. + *******************************************************************************/ + @Test + void pivotPrivacyAndUserFilter() throws Exception + { + config.withDefaultMinGroupSize(3); + service.getConfigResolver().invalidate(); + PivotResult result = service.pivot(pivot(List.of("status"), List.of("customer")).withValues(List.of(measure(PivotMeasure.Operator.COUNT, null), measure(PivotMeasure.Operator.SUM, "amount")))); + assertThat(result.getCells().stream().filter(c -> c.getValues().getFirst().getSuppressed())).hasSize(2); + result.getCells().stream().filter(c -> c.getValues().getFirst().getSuppressed()).forEach(c -> assertThat(c.getValues()).allSatisfy(m -> + { + assertThat(m.getValue()).isNull(); + assertThat(m.getDrill()).isNull(); + })); + assertThat(service.pivot(pivot(List.of("quantity"), List.of())).getRowHeaders()).isEmpty(); + config.withDefaultMinGroupSize(0); + service.getConfigResolver().invalidate(); + var filter = DrillFilters.condition("customer", QCriteriaOperator.EQUALS, 1); + String before = JsonUtils.toJson(filter); + result = service.pivot(pivot(List.of("status"), List.of()).withFilter(filter)); + equalNumber(result.getGrandTotals().getFirst(), "8"); + assertThat(JsonUtils.toJson(filter)).isEqualTo(before); + countDrills(result); + } + + /******************************************************************************* + ** Verify or support the pivot and field-access contract. + *******************************************************************************/ + @Test + void pivotJoinedDimensionAndPermissions() throws Exception + { + instance.addJoin(new QJoinMetaData().withName("ordersCustomer").withLeftTable("orders").withRightTable("customer") + .withType(JoinType.MANY_TO_ONE).withJoinOn(new JoinOn("customer", "id"))); + instance.getTable("orders").withExposedJoin(new ExposedJoin().withJoinTable("customer").withJoinPath(List.of("ordersCustomer"))); + PivotResult result = service.pivot(pivot(List.of("customer.name"), List.of("status"))); + assertThat(result.getRowHeaders().stream().flatMap(List::stream).map(PivotHeader::getValue)).containsExactlyInAnyOrder("Alice Co", "Bob Co"); + equalNumber(result.getGrandTotals().getFirst(), "12"); + assertThat(result.getWarnings()).isEmpty(); + assertThat(result.getCells()).allSatisfy(c -> assertThat(JsonUtils.toJson(c.getValues().getFirst().getDrill())).contains("customer.name")); + countDrills(result); + countDrills(service.pivot(pivot(List.of("customer.name"), List.of("status")).withLimitGroups(1) + .withFilter(DrillFilters.condition("paid", QCriteriaOperator.EQUALS, true)))); + instance.getJoins().put("ordersCustomer", instance.getJoin("ordersCustomer").flip()); + countDrills(service.pivot(pivot(List.of("customer.name"), List.of("status")))); + QContext.getQSession().getPermissions().remove("customer.read"); + assertThatThrownBy(() -> service.pivot(pivot(List.of("customer.name"), List.of()))).isInstanceOf(com.kingsrook.qqq.backend.core.exceptions.QBadRequestException.class); + } + + /******************************************************************************* + ** Reversing a many-to-one join multiplies records and disables every drill. + *******************************************************************************/ + @Test + void pivotToManyDimension() throws Exception + { + instance.addJoin(new QJoinMetaData().withName("ordersCustomer").withLeftTable("orders").withRightTable("customer") + .withType(JoinType.MANY_TO_ONE).withJoinOn(new JoinOn("customer", "id"))); + instance.getTable("customer").withExposedJoin(new ExposedJoin().withJoinTable("orders").withJoinPath(List.of("ordersCustomer"))); + QContext.getQSession().getPermissions().add("customer.analyze"); + for(int direction = 0; direction < 2; direction++) + { + PivotResult result = service.pivot(pivot(List.of("orders.status"), List.of()).withTableName("customer")); + equalNumber(result.getGrandTotals().getFirst(), "12"); + assertThat(result.getWarnings()).containsExactly("Counts include one row per related " + instance.getTable("orders").getLabel() + + "; drill-through is not available for this dimension."); + assertThat(result.getCells()).allSatisfy(c -> assertThat(c.getValues()).allSatisfy(m -> assertThat(m.getDrill()).isNull())); + assertThat(result.getRowTotals()).allSatisfy(metrics -> assertThat(metrics).allSatisfy(m -> assertThat(m.getDrill()).isNull())); + assertThat(result.getColumnTotals()).allSatisfy(metrics -> assertThat(metrics).allSatisfy(m -> assertThat(m.getDrill()).isNull())); + assertThat(result.getGrandTotals()).allSatisfy(m -> assertThat(m.getDrill()).isNull()); + instance.getJoins().put("ordersCustomer", instance.getJoin("ordersCustomer").flip()); + } + } + + /******************************************************************************* + ** Every hop must be to-one, including hops preceding a one-to-one target. + *******************************************************************************/ + @Test + void pivotMultiHopDimension() throws Exception + { + instance.addTable(new com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData().withName("region").withLabel("Region") + .withBackendName(instance.getTable("customer").getBackendName()).withPrimaryKeyField("id") + .withField(new com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData("id", com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType.INTEGER)) + .withField(new com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData("name", com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType.STRING))); + if(connection != null) + { + try(var statement = connection.createStatement()) + { + statement.execute("DROP TABLE IF EXISTS region"); + statement.execute("CREATE TABLE region (id INTEGER PRIMARY KEY, name VARCHAR(100))"); + } + } + new com.kingsrook.qqq.backend.core.instances.QInstanceEnricher(instance).enrich(); + TestSupport.insert("region", new com.kingsrook.qqq.backend.core.model.data.QRecord().withValue("id", 1).withValue("name", "East")); + TestSupport.insert("region", new com.kingsrook.qqq.backend.core.model.data.QRecord().withValue("id", 2).withValue("name", "West")); + instance.addJoin(new QJoinMetaData().withName("ordersCustomer").withLeftTable("orders").withRightTable("customer") + .withType(JoinType.MANY_TO_ONE).withJoinOn(new JoinOn("customer", "id"))); + instance.addJoin(new QJoinMetaData().withName("customerRegion").withLeftTable("region").withRightTable("customer") + .withType(JoinType.ONE_TO_ONE).withJoinOn(new JoinOn("id", "id"))); + instance.getTable("orders").withExposedJoin(new ExposedJoin().withJoinTable("region").withJoinPath(List.of("ordersCustomer", "customerRegion"))); + PivotResult result = service.pivot(pivot(List.of("region.name"), List.of("status"))); + assertThat(result.getWarnings()).containsExactly("Drill-through is not available for fields reached through more than one join (Region)."); + assertThat(result.getCells()).allSatisfy(c -> assertThat(c.getValues().getFirst().getDrill()).isNull()); + instance.getJoin("ordersCustomer").withType(JoinType.MANY_TO_MANY); + result = service.pivot(pivot(List.of("region.name"), List.of("status"))); + assertThat(result.getWarnings()).containsExactly("Counts include one row per related Region; drill-through is not available for this dimension."); + assertThat(result.getCells()).allSatisfy(c -> assertThat(c.getValues().getFirst().getDrill()).isNull()); + } + + /******************************************************************************* + ** Verify or support the pivot and field-access contract. + *******************************************************************************/ + @Test + void pivotValidation() throws Exception + { + for(String field : List.of("secret", "missing", "missing.field")) + { + assertThatThrownBy(() -> service.pivot(pivot(List.of(field), List.of()))).isInstanceOf(com.kingsrook.qqq.backend.core.exceptions.QBadRequestException.class); + assertThatThrownBy(() -> service.pivot(pivot(List.of("status"), List.of()).withValues(List.of(measure(PivotMeasure.Operator.MIN, field))))) + .isInstanceOf(com.kingsrook.qqq.backend.core.exceptions.QBadRequestException.class); + } + for(PivotRequest bad : List.of(pivot(List.of(), List.of()), pivot(List.of("status"), List.of()).withLimitGroups(201), + pivot(List.of("status"), List.of("status")), pivot(List.of("status"), List.of()).withRows(List.of(dimension("status").withDateBucket(DateBucketUnit.YEAR))), + pivot(List.of("status"), List.of()).withValues(List.of(measure(PivotMeasure.Operator.PERCENTILE, "amount").withPercentile(BigDecimal.TEN))))) + { + assertThatThrownBy(() -> service.pivot(bad)).isInstanceOf(com.kingsrook.qqq.backend.core.exceptions.QBadRequestException.class); + } + } + /******************************************************************************* + ** Verify or support the pivot and field-access contract. + *******************************************************************************/ + @Test + void pivotTypedExtremesAndEmptyScope() throws Exception + { + PivotResult result = service.pivot(pivot(List.of("status"), List.of()).withValues(List.of(measure(PivotMeasure.Operator.COUNT, "amount"), + measure(PivotMeasure.Operator.MIN, "order_date"), measure(PivotMeasure.Operator.MAX, "created"), measure(PivotMeasure.Operator.MIN, "amount"), + measure(PivotMeasure.Operator.MAX, "amount")))); + equalNumber(result.getGrandTotals().getFirst(), "12"); + equalNumber(result.getGrandTotals().get(3), "-10"); + equalNumber(result.getGrandTotals().get(4), "1000"); + assertThat(result.getGrandTotals().get(1).getValueType()).isEqualTo(ValueType.DATE); + assertThat(result.getGrandTotals().get(2).getValueType()).isEqualTo(ValueType.DATE_TIME); + countDrills(result); + result = service.pivot(pivot(List.of("status"), List.of()).withFilter(DrillFilters.condition("id", QCriteriaOperator.EQUALS, -1))); + assertThat(result.getCells()).isEmpty(); + equalNumber(result.getGrandTotals().getFirst(), "0"); + countDrills(result); + } +} -- 2.54.0 From bb8b431b7f565d2e39b8f7ea5fb6e765176b8a6b Mon Sep 17 00:00:00 2001 From: James Maes Date: Tue, 13 Oct 2026 22:17:04 -0500 Subject: [PATCH 5/5] chore(api): regenerate the OpenAPI fragment against QQQ 4.1.0-RC.6 Co-Authored-By: Claude Opus 5.5 --- src/main/resources/openapi/qqq-v1/data-analysis.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/src/main/resources/openapi/qqq-v1/data-analysis.yaml b/src/main/resources/openapi/qqq-v1/data-analysis.yaml index de5cdc6..dd72587 100644 --- a/src/main/resources/openapi/qqq-v1/data-analysis.yaml +++ b/src/main/resources/openapi/qqq-v1/data-analysis.yaml @@ -903,6 +903,7 @@ components: - "STARTS_WITH" - "ENDS_WITH" - "CONTAINS" + - "CONTAINS_ALL" - "NOT_STARTS_WITH" - "NOT_ENDS_WITH" - "NOT_CONTAINS" -- 2.54.0