You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tika.apache.org by ta...@apache.org on 2026/02/26 01:12:58 UTC
(tika) branch TIKA-4674-progress-timeout created (now fbfcdcd1f7)
This is an automated email from the ASF dual-hosted git repository.
tallison pushed a change to branch TIKA-4674-progress-timeout
in repository https://gitbox.apache.org/repos/asf/tika.git
at fbfcdcd1f7 TIKA-4674 - progress timeout
This branch includes the following new commits:
new fbfcdcd1f7 TIKA-4674 - progress timeout
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(tika) 01/01: TIKA-4674 - progress timeout
Posted by ta...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
tallison pushed a commit to branch TIKA-4674-progress-timeout
in repository https://gitbox.apache.org/repos/asf/tika.git
commit fbfcdcd1f70978547d9622dabb32e3f747b8176c
Author: tallison <ta...@apache.org>
AuthorDate: Wed Feb 25 20:12:45 2026 -0500
TIKA-4674 - progress timeout
---
docs/modules/ROOT/nav.adoc | 1 +
docs/modules/ROOT/pages/pipes/index.adoc | 1 +
.../ROOT/pages/pipes/shared-server-mode.adoc | 10 +-
docs/modules/ROOT/pages/pipes/timeouts.adoc | 170 +++++++++++++++++++++
.../src/main/java/org/apache/tika/cli/TikaCLI.java | 4 +-
.../test/resources/configs/config-template.json | 6 +-
.../apache/tika/config/TikaProgressTracker.java | 82 ++++++++++
.../org/apache/tika/config/TikaTaskTimeout.java | 76 ---------
.../java/org/apache/tika/config/TimeoutLimits.java | 112 ++++++++++----
.../tika/parser/external2/ExternalParser.java | 6 +-
.../tika/config/TikaProgressTrackerTest.java | 103 +++++++++++++
.../customocr/tika-config-inline.json | 1 -
.../customocr/tika-config-rendered.json | 1 -
.../sample-configs/grobid/tika-config.json | 1 -
.../tika-grpc/sample-configs/ner/tika-config.json | 1 -
.../src/test/resources/tika-pipes-test-config.json | 6 +-
.../src/test/resources/kafka/plugins-template.json | 1 -
.../resources/opensearch/plugins-template.json | 3 +-
.../opensearch/tika-config-opensearch.json | 3 +-
.../src/test/resources/s3/plugins-template.json | 1 -
.../src/test/resources/solr/plugins-template.json | 3 +-
.../src/test/resources/tika-config-solr-urls.json | 1 -
.../org/apache/tika/parser/gdal/GDALParser.java | 6 +-
.../tika/inference/OpenAIImageEmbeddingParser.java | 6 +-
.../tika/parser/ocr/tess4j/Tess4JParser.java | 6 +-
.../apache/tika/parser/vlm/AbstractVLMParser.java | 6 +-
.../apache/tika/parser/ocr/TesseractOCRParser.java | 6 +-
.../tika/parser/ocr/TesseractOCRParserTest.java | 4 +-
.../apache/tika/parser/strings/StringsParser.java | 11 +-
.../org/apache/tika/async/cli/PluginsWriter.java | 15 +-
.../test/resources/configs/config-template.json | 6 +-
.../org/apache/tika/pipes/core/PipesClient.java | 41 +++--
.../org/apache/tika/pipes/core/PipesConfig.java | 15 --
.../tika/pipes/core/config/ConfigMerger.java | 22 ++-
.../tika/pipes/core/config/ConfigOverrides.java | 39 +++--
.../tika/pipes/core/protocol/PipesMessage.java | 16 +-
.../tika/pipes/core/server/ConnectionHandler.java | 62 +++++---
.../apache/tika/pipes/core/server/PipesServer.java | 43 ++++--
.../tika/pipes/core/config/ConfigMergerTest.java | 11 +-
.../tika/pipes/core/protocol/PipesMessageTest.java | 2 +-
.../apache/tika/pipes/fork/PipesForkParser.java | 6 +-
.../tika/pipes/fork/PipesForkParserConfig.java | 22 ++-
.../tika/pipes/fork/PipesForkParserTest.java | 52 +++----
.../apache/tika/pipes/core/PipesClientTest.java | 10 +-
.../resources/configs/tika-config-bad-class.json | 6 +-
.../configs/tika-config-bad-java-path.json | 6 +-
.../configs/tika-config-bad-jvm-args.json | 6 +-
.../test/resources/configs/tika-config-basic.json | 8 +-
.../configs/tika-config-crashing-detector.json | 6 +-
.../resources/configs/tika-config-emit-all.json | 6 +-
.../resources/configs/tika-config-passback.json | 8 +-
.../configs/tika-config-shared-server.json | 8 +-
.../configs/tika-config-timeout-lt-heartbeat.json | 6 +-
.../resources/configs/tika-config-truncate.json | 4 +-
.../resources/configs/tika-config-uppercasing.json | 8 +-
.../configs/tika-config-write-limiter.json | 4 +-
.../tika/serialization/ParseContextUtils.java | 4 +-
.../java/org/apache/tika/config/AllLimitsTest.java | 11 +-
.../org/apache/tika/config/TimeoutLimitsTest.java | 55 +++++--
.../tika/config/loader/ConfigLoaderTest.java | 24 +--
.../serialization/RoundTripSerializationTest.java | 38 +++--
.../TestParseContextSerialization.java | 33 ++--
.../test/resources/configs/all-limits-test.json | 3 +-
.../test/resources/configs/test-config-loader.json | 2 +-
.../resources/configs/test-partial-config.json | 2 +-
.../resources/configs/timeout-limits-test.json | 3 +-
.../core/TikaServerPipesIntegrationTest.java | 2 +-
.../resources/configs/cxf-test-base-template.json | 8 +-
.../configs/cxf-unpack-test-template.json | 4 +-
.../configs/tika-config-server-basic.json | 6 +-
.../configs/tika-config-server-emitter.json | 6 +-
.../tika-config-server-fetcher-template.json | 6 +-
.../tika-config-server-fetchers-emitters.json | 6 +-
.../configs/tika-config-server-pipes-basic.json | 6 +-
.../tika-config-server-tls-one-way-template.json | 6 +-
.../tika-config-server-tls-two-way-template.json | 6 +-
.../resources/configs/tika-config-server-tls.json | 6 +-
.../test/resources/configs/tika-config-server.json | 6 +-
.../configs/tika-config-timeout-100ms.json | 4 +-
.../configs/tika-config-with-timeout.json | 4 +-
.../resources/configs/cxf-test-base-template.json | 8 +-
.../configs/tika-config-for-server-tests.json | 6 +-
.../test/resources/configs/tika-config-json.json | 6 +-
.../tika-config-langdetect-opennlp-filter.json | 6 +-
.../tika-config-langdetect-optimaize-filter.json | 6 +-
85 files changed, 953 insertions(+), 406 deletions(-)
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
index d4bf3cb857..a8b28ca0e9 100644
--- a/docs/modules/ROOT/nav.adoc
+++ b/docs/modules/ROOT/nav.adoc
@@ -23,6 +23,7 @@
* xref:pipes/index.adoc[Pipes]
** xref:pipes/parse-modes.adoc[Parse Modes]
** xref:pipes/unpack-config.adoc[Extracting Embedded Bytes]
+** xref:pipes/timeouts.adoc[Timeouts]
* xref:configuration/index.adoc[Configuration]
** xref:configuration/parsers/pdf-parser.adoc[PDF Parser]
** xref:configuration/parsers/tesseract-ocr-parser.adoc[Tesseract OCR]
diff --git a/docs/modules/ROOT/pages/pipes/index.adoc b/docs/modules/ROOT/pages/pipes/index.adoc
index ff67ab6e0c..d483d611b6 100644
--- a/docs/modules/ROOT/pages/pipes/index.adoc
+++ b/docs/modules/ROOT/pages/pipes/index.adoc
@@ -31,6 +31,7 @@ Tika Pipes provides a framework for processing large volumes of documents with:
* xref:pipes/parse-modes.adoc[Parse Modes] - Control how documents are parsed and emitted (`RMETA`, `CONCATENATE`, `CONTENT_ONLY`, `UNPACK`)
* xref:pipes/unpack-config.adoc[Extracting Embedded Bytes] - Extract raw bytes from embedded documents using `ParseMode.UNPACK`
+* xref:pipes/timeouts.adoc[Timeouts] - Two-tier timeout system for handling long-running and hung parsers
// Add links to specific topics as they are created
// * link:getting-started.html[Getting Started]
diff --git a/docs/modules/ROOT/pages/pipes/shared-server-mode.adoc b/docs/modules/ROOT/pages/pipes/shared-server-mode.adoc
index 4924a0b8d4..d956acb5fa 100644
--- a/docs/modules/ROOT/pages/pipes/shared-server-mode.adoc
+++ b/docs/modules/ROOT/pages/pipes/shared-server-mode.adoc
@@ -79,12 +79,18 @@ Enable shared mode by setting `useSharedServer` to `true` in your pipes configur
"pipes": {
"numClients": 4,
"useSharedServer": true,
- "forkedJvmArgs": ["-Xmx4g"],
- "timeoutMillis": 60000
+ "forkedJvmArgs": ["-Xmx4g"]
+ },
+ "parse-context": {
+ "timeout-limits": {
+ "progressTimeoutMillis": 60000
+ }
}
}
----
+See xref:pipes/timeouts.adoc[Timeouts] for details on configuring timeouts.
+
== Sizing Guidance
When using shared mode, size the JVM heap for worst-case concurrent load:
diff --git a/docs/modules/ROOT/pages/pipes/timeouts.adoc b/docs/modules/ROOT/pages/pipes/timeouts.adoc
new file mode 100644
index 0000000000..77008aa9b9
--- /dev/null
+++ b/docs/modules/ROOT/pages/pipes/timeouts.adoc
@@ -0,0 +1,170 @@
+//
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF licenses this file to You under the Apache License, Version 2.0
+// (the "License"); you may not use this file except in compliance with
+// the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+= Timeouts
+
+== Overview
+
+Tika Pipes uses a two-tier timeout system to handle both long-running tasks and hung parsers:
+
+* **`progressTimeoutMillis`** -- Maximum time between progress updates.
+ If no progress is reported within this interval, the task is considered stalled and killed.
+ Default: `60000` (1 minute).
+
+* **`totalTaskTimeoutMillis`** -- Maximum wall-clock time for an entire task.
+ Even if the parser is making progress, the task is killed after this time.
+ Default: `3600000` (1 hour).
+
+Parsers that never report progress effectively get `progressTimeoutMillis` as their total timeout.
+Parsers that do report progress (e.g., OCR processing multiple pages) can run up to `totalTaskTimeoutMillis`.
+
+== Configuration
+
+Timeouts are configured via `TimeoutLimits` in the `parse-context` section of your JSON configuration:
+
+[source,json]
+----
+{
+ "parse-context": {
+ "timeout-limits": {
+ "totalTaskTimeoutMillis": 3600000,
+ "progressTimeoutMillis": 60000
+ }
+ }
+}
+----
+
+This can be combined with other parse-context settings:
+
+[source,json]
+----
+{
+ "pipes": {
+ "numClients": 4,
+ "forkedJvmArgs": ["-Xmx1g"]
+ },
+ "parse-context": {
+ "timeout-limits": {
+ "totalTaskTimeoutMillis": 7200000,
+ "progressTimeoutMillis": 120000
+ }
+ }
+}
+----
+
+== Per-Request Overrides
+
+When using Tika Server with `enableUnsecureFeatures: true`, timeouts can be overridden per-request
+by including `TimeoutLimits` in the `ParseContext` of a `FetchEmitTuple`:
+
+[source,java]
+----
+ParseContext parseContext = new ParseContext();
+parseContext.setJsonConfig("timeout-limits",
+ "{\"progressTimeoutMillis\": 300000}");
+
+FetchEmitTuple t = new FetchEmitTuple("id",
+ new FetchKey("my-fetcher", "large-document.pdf"),
+ new EmitKey("my-emitter", "output-key"),
+ parseContext);
+----
+
+== How It Works
+
+=== Progress Tracking
+
+When a task starts, the server creates a `TikaProgressTracker` and places it in the `ParseContext`.
+Parsers that perform long-running external operations (OCR, VLM inference, etc.) call
+`TikaProgressTracker.update(context)` after completing each unit of work:
+
+[source,java]
+----
+// In a parser after completing an external process:
+TikaProgressTracker.update(parseContext);
+----
+
+The server's monitoring loop checks both timeouts on every heartbeat:
+
+1. Has `totalTaskTimeoutMillis` elapsed since the task started? -> TIMEOUT
+2. Has `progressTimeoutMillis` elapsed since the last progress update? -> TIMEOUT
+
+=== Which Parsers Report Progress?
+
+The following parsers call `TikaProgressTracker.update()` after each external operation:
+
+* `TesseractOCRParser` -- after each OCR invocation
+* `ExternalParser` -- after each external process completes
+* `GDALParser` -- after GDAL processing
+* `Tess4JParser` -- after each in-process OCR operation
+* VLM parsers (`OllamaParser`, `ClaudeParser`, etc.) -- after each API call
+* `OpenAIImageEmbeddingParser` -- after each embedding call
+* `StringsParser` -- after the strings command completes
+
+Parsers that don't report progress (most built-in parsers) are bounded by `progressTimeoutMillis` alone.
+
+== Example: OCR Pipeline
+
+For a pipeline processing scanned PDFs with hundreds of pages:
+
+[source,json]
+----
+{
+ "parse-context": {
+ "timeout-limits": {
+ "totalTaskTimeoutMillis": 7200000,
+ "progressTimeoutMillis": 300000
+ }
+ }
+}
+----
+
+This allows up to 2 hours total per document, but kills the task if any single OCR page takes longer
+than 5 minutes. A 200-page document where each page takes 30 seconds of OCR will complete successfully
+(~100 minutes total), while a document stuck on a single page will be killed after 5 minutes.
+
+== Example: Quick Batch Processing
+
+For processing many small documents where you want fast failure:
+
+[source,json]
+----
+{
+ "parse-context": {
+ "timeout-limits": {
+ "totalTaskTimeoutMillis": 30000,
+ "progressTimeoutMillis": 10000
+ }
+ }
+}
+----
+
+== CLI Usage
+
+When using `tika-app` with `--fork`, the `--fork-timeout` flag sets `progressTimeoutMillis`:
+
+[source,bash]
+----
+java -jar tika-app.jar --fork --fork-timeout=120000 -i /input -o /output
+----
+
+== Living Code Reference
+
+* link:https://github.com/apache/tika/blob/main/tika-core/src/main/java/org/apache/tika/config/TimeoutLimits.java[`TimeoutLimits.java`] -- Configuration class with defaults and helper methods
+* link:https://github.com/apache/tika/blob/main/tika-core/src/main/java/org/apache/tika/config/TikaProgressTracker.java[`TikaProgressTracker.java`] -- Progress tracking for parsers
+* link:https://github.com/apache/tika/blob/main/tika-core/src/test/java/org/apache/tika/config/TikaProgressTrackerTest.java[`TikaProgressTrackerTest.java`] -- Unit tests for the progress tracker
+* link:https://github.com/apache/tika/blob/main/tika-serialization/src/test/java/org/apache/tika/config/TimeoutLimitsTest.java[`TimeoutLimitsTest.java`] -- Unit tests for TimeoutLimits serialization
+* link:https://github.com/apache/tika/blob/main/tika-pipes/tika-pipes-integration-tests/src/test/java/org/apache/tika/pipes/core/PipesClientTest.java[`PipesClientTest.java`] -- Integration tests including timeout behavior
diff --git a/tika-app/src/main/java/org/apache/tika/cli/TikaCLI.java b/tika-app/src/main/java/org/apache/tika/cli/TikaCLI.java
index 4fbedb8db9..dd677c6ac2 100644
--- a/tika-app/src/main/java/org/apache/tika/cli/TikaCLI.java
+++ b/tika-app/src/main/java/org/apache/tika/cli/TikaCLI.java
@@ -66,6 +66,7 @@ import org.xml.sax.helpers.DefaultHandler;
import org.apache.tika.Tika;
import org.apache.tika.async.cli.TikaAsyncCLI;
import org.apache.tika.config.EmbeddedLimits;
+import org.apache.tika.config.TimeoutLimits;
import org.apache.tika.config.loader.TikaLoader;
import org.apache.tika.detect.CompositeDetector;
import org.apache.tika.detect.Detector;
@@ -633,7 +634,8 @@ public class TikaCLI {
}
// Set timeout
- config.setTimeoutMillis(forkTimeout);
+ config.setTimeoutLimits(new TimeoutLimits(
+ TimeoutLimits.DEFAULT_TOTAL_TASK_TIMEOUT_MILLIS, forkTimeout));
// Set JVM args if provided
if (forkJvmArgs != null && !forkJvmArgs.isEmpty()) {
diff --git a/tika-app/src/test/resources/configs/config-template.json b/tika-app/src/test/resources/configs/config-template.json
index 62940e6711..1cce9b9de9 100644
--- a/tika-app/src/test/resources/configs/config-template.json
+++ b/tika-app/src/test/resources/configs/config-template.json
@@ -32,6 +32,11 @@
"emitterId": "fse"
}
},
+ "parse-context": {
+ "timeout-limits": {
+ "progressTimeoutMillis": 60000
+ }
+ },
"pipes": {
"parseMode": "RMETA",
"onParseException": "EMIT",
@@ -40,7 +45,6 @@
"queueSize": 10000,
"numEmitters": 1,
"emitIntermediateResults": false,
- "timeoutMillis": 60000,
"startupTimeoutMillis": 240000,
"sleepOnStartupTimeoutMillis": 240000,
"shutdownClientAfterMillis": 300000,
diff --git a/tika-core/src/main/java/org/apache/tika/config/TikaProgressTracker.java b/tika-core/src/main/java/org/apache/tika/config/TikaProgressTracker.java
new file mode 100644
index 0000000000..2aa52a1a5e
--- /dev/null
+++ b/tika-core/src/main/java/org/apache/tika/config/TikaProgressTracker.java
@@ -0,0 +1,82 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.tika.config;
+
+import java.util.concurrent.atomic.AtomicLong;
+
+import org.apache.tika.parser.ParseContext;
+
+/**
+ * Tracks parse progress for the two-tier timeout system.
+ * <p>
+ * Parsers call {@link #update(ParseContext)} after completing a unit of work
+ * (e.g., finishing an external process for one page of OCR). The monitoring loop
+ * reads {@link #getLastProgressMillis()} to detect stalled parsers.
+ * <p>
+ * This is runtime-only state (NOT Serializable) — it is placed into
+ * {@link ParseContext} on the server side before submitting a parse task
+ * and is never sent over the wire.
+ *
+ * @since Apache Tika 4.0
+ */
+public class TikaProgressTracker {
+
+ private final AtomicLong lastProgressMillis;
+
+ /**
+ * Creates a tracker initialized to the current time.
+ */
+ public TikaProgressTracker() {
+ this.lastProgressMillis = new AtomicLong(System.currentTimeMillis());
+ }
+
+ /**
+ * Signals progress from a ParseContext. If no tracker is present, this is a no-op.
+ * <p>
+ * This is the preferred way for parsers to signal progress:
+ * <pre>
+ * TikaProgressTracker.update(context);
+ * </pre>
+ *
+ * @param context the ParseContext (may be null)
+ */
+ public static void update(ParseContext context) {
+ if (context == null) {
+ return;
+ }
+ TikaProgressTracker tracker = context.get(TikaProgressTracker.class);
+ if (tracker != null) {
+ tracker.update();
+ }
+ }
+
+ /**
+ * Signals progress directly on this tracker instance.
+ */
+ public void update() {
+ lastProgressMillis.set(System.currentTimeMillis());
+ }
+
+ /**
+ * Returns the epoch millis of the last progress update.
+ *
+ * @return epoch millis of last progress
+ */
+ public long getLastProgressMillis() {
+ return lastProgressMillis.get();
+ }
+}
diff --git a/tika-core/src/main/java/org/apache/tika/config/TikaTaskTimeout.java b/tika-core/src/main/java/org/apache/tika/config/TikaTaskTimeout.java
deleted file mode 100644
index 2f922c52aa..0000000000
--- a/tika-core/src/main/java/org/apache/tika/config/TikaTaskTimeout.java
+++ /dev/null
@@ -1,76 +0,0 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.apache.tika.config;
-
-import java.io.Serializable;
-
-import org.apache.tika.parser.ParseContext;
-
-/**
- * Configuration class for specifying parse task timeout.
- * <p>
- * This is a config POJO (not a component like Parser/Detector), so it uses
- * standard Jackson format rather than compact component format:
- * <pre>
- * {
- * "parse-context": {
- * "tika-task-timeout": {
- * "timeoutMillis": 30000
- * }
- * }
- * }
- * </pre>
- */
-@TikaComponent(spi = false)
-public class TikaTaskTimeout implements Serializable {
-
- private long timeoutMillis;
-
- /**
- * No-arg constructor for Jackson deserialization.
- */
- public TikaTaskTimeout() {
- }
-
- /**
- * Constructor with timeout value.
- *
- * @param timeoutMillis timeout in milliseconds
- */
- public TikaTaskTimeout(long timeoutMillis) {
- this.timeoutMillis = timeoutMillis;
- }
-
- public long getTimeoutMillis() {
- return timeoutMillis;
- }
-
- public void setTimeoutMillis(long timeoutMillis) {
- this.timeoutMillis = timeoutMillis;
- }
-
- public static long getTimeoutMillis(ParseContext context, long defaultTimeoutMillis) {
- if (context == null) {
- return defaultTimeoutMillis;
- }
- TikaTaskTimeout tikaTaskTimeout = context.get(TikaTaskTimeout.class);
- if (tikaTaskTimeout == null) {
- return defaultTimeoutMillis;
- }
- return tikaTaskTimeout.getTimeoutMillis();
- }
-}
diff --git a/tika-core/src/main/java/org/apache/tika/config/TimeoutLimits.java b/tika-core/src/main/java/org/apache/tika/config/TimeoutLimits.java
index c0dffbc423..f64a1b3772 100644
--- a/tika-core/src/main/java/org/apache/tika/config/TimeoutLimits.java
+++ b/tika-core/src/main/java/org/apache/tika/config/TimeoutLimits.java
@@ -17,35 +17,32 @@
package org.apache.tika.config;
import java.io.Serializable;
+import java.util.Objects;
import org.apache.tika.parser.ParseContext;
/**
- * Configuration for task timeout limits.
+ * Configuration for the two-tier task timeout system.
* <p>
- * This controls the maximum time allowed for a parse operation:
* <ul>
- * <li>{@code taskTimeoutMillis} - maximum time in milliseconds for a parse task (default: 60000)</li>
+ * <li>{@code totalTaskTimeoutMillis} — bounds entire task wall-clock time
+ * (default: 3,600,000 ms = 1 hour)</li>
+ * <li>{@code progressTimeoutMillis} — bounds time since the last progress update;
+ * catches infinite loops and hung processes (default: 60,000 ms = 1 minute)</li>
* </ul>
* <p>
- * <b>Timeout behavior:</b> When the timeout is reached, the parse task is killed and a
- * {@code TikaTimeoutException} is thrown. There is no silent truncation option for timeouts.
- * <p>
- * <b>Warning:</b> If {@code taskTimeoutMillis} is shorter than parser-specific timeouts
- * (e.g., TesseractOCRConfig.timeoutSeconds, ExternalParserConfig.timeoutMs), the task will
- * be killed before the parser completes. Common conflicts to watch for:
- * <ul>
- * <li>TesseractOCRConfig.timeoutSeconds default: 120s (120000ms)</li>
- * <li>ExternalParserConfig.timeoutMs default: 60s (60000ms)</li>
- * <li>StringsConfig.timeoutSeconds default: 120s (120000ms)</li>
- * </ul>
+ * Parsers that never call {@link TikaProgressTracker#update()} effectively get
+ * {@code progressTimeoutMillis} as their total timeout (same as the old single-timeout
+ * behavior). Parsers that <em>do</em> update progress can run up to
+ * {@code totalTaskTimeoutMillis}.
* <p>
* Example configuration:
* <pre>
* {
* "parse-context": {
* "timeout-limits": {
- * "taskTimeoutMillis": 120000
+ * "totalTaskTimeoutMillis": 3600000,
+ * "progressTimeoutMillis": 60000
* }
* }
* }
@@ -56,11 +53,13 @@ import org.apache.tika.parser.ParseContext;
@TikaComponent(spi = false)
public class TimeoutLimits implements Serializable {
- private static final long serialVersionUID = 1L;
+ private static final long serialVersionUID = 2L;
- public static final long DEFAULT_TASK_TIMEOUT_MILLIS = 60_000;
+ public static final long DEFAULT_TOTAL_TASK_TIMEOUT_MILLIS = 3_600_000L;
+ public static final long DEFAULT_PROGRESS_TIMEOUT_MILLIS = 60_000L;
- private long taskTimeoutMillis = DEFAULT_TASK_TIMEOUT_MILLIS;
+ private long totalTaskTimeoutMillis = DEFAULT_TOTAL_TASK_TIMEOUT_MILLIS;
+ private long progressTimeoutMillis = DEFAULT_PROGRESS_TIMEOUT_MILLIS;
/**
* No-arg constructor for Jackson deserialization.
@@ -69,30 +68,52 @@ public class TimeoutLimits implements Serializable {
}
/**
- * Constructor with timeout parameter.
+ * Constructor with both timeout parameters.
+ *
+ * @param totalTaskTimeoutMillis maximum wall-clock time for a task
+ * @param progressTimeoutMillis maximum time between progress updates
+ */
+ public TimeoutLimits(long totalTaskTimeoutMillis, long progressTimeoutMillis) {
+ this.totalTaskTimeoutMillis = totalTaskTimeoutMillis;
+ this.progressTimeoutMillis = progressTimeoutMillis;
+ }
+
+ /**
+ * Gets the maximum wall-clock time in milliseconds for a parse task.
+ *
+ * @return total task timeout in milliseconds
+ */
+ public long getTotalTaskTimeoutMillis() {
+ return totalTaskTimeoutMillis;
+ }
+
+ /**
+ * Sets the maximum wall-clock time in milliseconds for a parse task.
*
- * @param taskTimeoutMillis maximum time in milliseconds for a parse task
+ * @param totalTaskTimeoutMillis total task timeout in milliseconds
*/
- public TimeoutLimits(long taskTimeoutMillis) {
- this.taskTimeoutMillis = taskTimeoutMillis;
+ public void setTotalTaskTimeoutMillis(long totalTaskTimeoutMillis) {
+ this.totalTaskTimeoutMillis = totalTaskTimeoutMillis;
}
/**
- * Gets the maximum time in milliseconds for a parse task.
+ * Gets the maximum time in milliseconds between progress updates before
+ * the task is considered stalled.
*
- * @return task timeout in milliseconds
+ * @return progress timeout in milliseconds
*/
- public long getTaskTimeoutMillis() {
- return taskTimeoutMillis;
+ public long getProgressTimeoutMillis() {
+ return progressTimeoutMillis;
}
/**
- * Sets the maximum time in milliseconds for a parse task.
+ * Sets the maximum time in milliseconds between progress updates before
+ * the task is considered stalled.
*
- * @param taskTimeoutMillis task timeout in milliseconds
+ * @param progressTimeoutMillis progress timeout in milliseconds
*/
- public void setTaskTimeoutMillis(long taskTimeoutMillis) {
- this.taskTimeoutMillis = taskTimeoutMillis;
+ public void setProgressTimeoutMillis(long progressTimeoutMillis) {
+ this.progressTimeoutMillis = progressTimeoutMillis;
}
/**
@@ -109,10 +130,34 @@ public class TimeoutLimits implements Serializable {
return limits != null ? limits : new TimeoutLimits();
}
+ /**
+ * Returns the per-process timeout to use for external process execution.
+ * <p>
+ * This checks for {@link TimeoutLimits} in the ParseContext and returns
+ * {@code max(0, progressTimeoutMillis - 100)} to give the monitoring loop
+ * a small window to detect the timeout before the process itself times out.
+ * Falls back to {@code defaultMs} if no TimeoutLimits is found.
+ *
+ * @param context the ParseContext (may be null)
+ * @param defaultMs default timeout if no TimeoutLimits in context
+ * @return timeout in milliseconds for external process execution
+ */
+ public static long getProcessTimeoutMillis(ParseContext context, long defaultMs) {
+ if (context == null) {
+ return defaultMs;
+ }
+ TimeoutLimits limits = context.get(TimeoutLimits.class);
+ if (limits == null) {
+ return defaultMs;
+ }
+ return Math.max(0, limits.progressTimeoutMillis - 100);
+ }
+
@Override
public String toString() {
return "TimeoutLimits{" +
- "taskTimeoutMillis=" + taskTimeoutMillis +
+ "totalTaskTimeoutMillis=" + totalTaskTimeoutMillis +
+ ", progressTimeoutMillis=" + progressTimeoutMillis +
'}';
}
@@ -125,11 +170,12 @@ public class TimeoutLimits implements Serializable {
return false;
}
TimeoutLimits that = (TimeoutLimits) o;
- return taskTimeoutMillis == that.taskTimeoutMillis;
+ return totalTaskTimeoutMillis == that.totalTaskTimeoutMillis &&
+ progressTimeoutMillis == that.progressTimeoutMillis;
}
@Override
public int hashCode() {
- return (int) (taskTimeoutMillis ^ (taskTimeoutMillis >>> 32));
+ return Objects.hash(totalTaskTimeoutMillis, progressTimeoutMillis);
}
}
diff --git a/tika-core/src/main/java/org/apache/tika/parser/external2/ExternalParser.java b/tika-core/src/main/java/org/apache/tika/parser/external2/ExternalParser.java
index 25abd588d3..1c87ecaf99 100644
--- a/tika-core/src/main/java/org/apache/tika/parser/external2/ExternalParser.java
+++ b/tika-core/src/main/java/org/apache/tika/parser/external2/ExternalParser.java
@@ -36,7 +36,8 @@ import org.xml.sax.SAXException;
import org.apache.tika.config.ConfigDeserializer;
import org.apache.tika.config.JsonConfig;
import org.apache.tika.config.TikaComponent;
-import org.apache.tika.config.TikaTaskTimeout;
+import org.apache.tika.config.TikaProgressTracker;
+import org.apache.tika.config.TimeoutLimits;
import org.apache.tika.exception.TikaException;
import org.apache.tika.io.TemporaryResources;
import org.apache.tika.io.TikaInputStream;
@@ -140,7 +141,7 @@ public class ExternalParser implements Parser {
}
}
FileProcessResult result = null;
- long localTimeoutMillis = TikaTaskTimeout.getTimeoutMillis(context, config.getTimeoutMs());
+ long localTimeoutMillis = TimeoutLimits.getProcessTimeoutMillis(context, config.getTimeoutMs());
if (outputFileInCommandline) {
result = ProcessUtils.execute(new ProcessBuilder(thisCommandLine),
localTimeoutMillis, config.getMaxStdOut(), config.getMaxStdErr());
@@ -151,6 +152,7 @@ public class ExternalParser implements Parser {
}
metadata.set(ExternalProcess.IS_TIMEOUT, result.isTimeout());
metadata.set(ExternalProcess.EXIT_VALUE, result.getExitValue());
+ TikaProgressTracker.update(context);
metadata.set(ExternalProcess.STD_OUT_LENGTH, result.getStdoutLength());
metadata.set(ExternalProcess.STD_OUT_IS_TRUNCATED,
result.isStdoutTruncated());
diff --git a/tika-core/src/test/java/org/apache/tika/config/TikaProgressTrackerTest.java b/tika-core/src/test/java/org/apache/tika/config/TikaProgressTrackerTest.java
new file mode 100644
index 0000000000..3c20a1e135
--- /dev/null
+++ b/tika-core/src/test/java/org/apache/tika/config/TikaProgressTrackerTest.java
@@ -0,0 +1,103 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.tika.config;
+
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.TimeUnit;
+
+import org.junit.jupiter.api.Test;
+
+import org.apache.tika.parser.ParseContext;
+
+public class TikaProgressTrackerTest {
+
+ @Test
+ public void testInitialTimestamp() {
+ long before = System.currentTimeMillis();
+ TikaProgressTracker tracker = new TikaProgressTracker();
+ long after = System.currentTimeMillis();
+
+ assertTrue(tracker.getLastProgressMillis() >= before);
+ assertTrue(tracker.getLastProgressMillis() <= after);
+ }
+
+ @Test
+ public void testUpdateAdvancesTimestamp() throws Exception {
+ TikaProgressTracker tracker = new TikaProgressTracker();
+ long initial = tracker.getLastProgressMillis();
+
+ Thread.sleep(50);
+ tracker.update();
+
+ assertTrue(tracker.getLastProgressMillis() > initial);
+ }
+
+ @Test
+ public void testConcurrentUpdates() throws Exception {
+ TikaProgressTracker tracker = new TikaProgressTracker();
+ int numThreads = 4;
+ CountDownLatch startLatch = new CountDownLatch(1);
+ CountDownLatch doneLatch = new CountDownLatch(numThreads);
+
+ for (int i = 0; i < numThreads; i++) {
+ new Thread(() -> {
+ try {
+ startLatch.await();
+ for (int j = 0; j < 100; j++) {
+ tracker.update();
+ }
+ } catch (InterruptedException e) {
+ Thread.currentThread().interrupt();
+ } finally {
+ doneLatch.countDown();
+ }
+ }).start();
+ }
+
+ startLatch.countDown();
+ assertTrue(doneLatch.await(5, TimeUnit.SECONDS));
+ assertTrue(tracker.getLastProgressMillis() > 0);
+ }
+
+ @Test
+ public void testStaticUpdateWithParseContext() throws Exception {
+ TikaProgressTracker tracker = new TikaProgressTracker();
+ long initial = tracker.getLastProgressMillis();
+
+ ParseContext context = new ParseContext();
+ context.set(TikaProgressTracker.class, tracker);
+
+ Thread.sleep(50);
+ TikaProgressTracker.update(context);
+
+ assertTrue(tracker.getLastProgressMillis() > initial);
+ }
+
+ @Test
+ public void testStaticUpdateWithNullContext() {
+ // Should not throw
+ TikaProgressTracker.update(null);
+ }
+
+ @Test
+ public void testStaticUpdateWithNoTracker() {
+ // Should not throw
+ TikaProgressTracker.update(new ParseContext());
+ }
+}
diff --git a/tika-e2e-tests/tika-grpc/sample-configs/customocr/tika-config-inline.json b/tika-e2e-tests/tika-grpc/sample-configs/customocr/tika-config-inline.json
index cadb8db5ac..0881c3cfbe 100644
--- a/tika-e2e-tests/tika-grpc/sample-configs/customocr/tika-config-inline.json
+++ b/tika-e2e-tests/tika-grpc/sample-configs/customocr/tika-config-inline.json
@@ -9,7 +9,6 @@
"-Xmx1g",
"-XX:ParallelGCThreads=2"
],
- "timeoutMillis": 60000,
"maxForEmitBatchBytes": -1
},
"parsers": [
diff --git a/tika-e2e-tests/tika-grpc/sample-configs/customocr/tika-config-rendered.json b/tika-e2e-tests/tika-grpc/sample-configs/customocr/tika-config-rendered.json
index a3d8545893..2887f27163 100644
--- a/tika-e2e-tests/tika-grpc/sample-configs/customocr/tika-config-rendered.json
+++ b/tika-e2e-tests/tika-grpc/sample-configs/customocr/tika-config-rendered.json
@@ -9,7 +9,6 @@
"-Xmx1g",
"-XX:ParallelGCThreads=2"
],
- "timeoutMillis": 60000,
"maxForEmitBatchBytes": -1
},
"parsers": [
diff --git a/tika-e2e-tests/tika-grpc/sample-configs/grobid/tika-config.json b/tika-e2e-tests/tika-grpc/sample-configs/grobid/tika-config.json
index 740a17d2a5..f8201e192d 100644
--- a/tika-e2e-tests/tika-grpc/sample-configs/grobid/tika-config.json
+++ b/tika-e2e-tests/tika-grpc/sample-configs/grobid/tika-config.json
@@ -9,7 +9,6 @@
"-Xmx1g",
"-XX:ParallelGCThreads=2"
],
- "timeoutMillis": 60000,
"maxForEmitBatchBytes": -1
},
"parsers": [
diff --git a/tika-e2e-tests/tika-grpc/sample-configs/ner/tika-config.json b/tika-e2e-tests/tika-grpc/sample-configs/ner/tika-config.json
index d984e2b3b0..479df09d29 100644
--- a/tika-e2e-tests/tika-grpc/sample-configs/ner/tika-config.json
+++ b/tika-e2e-tests/tika-grpc/sample-configs/ner/tika-config.json
@@ -9,7 +9,6 @@
"-Xmx1g",
"-XX:ParallelGCThreads=2"
],
- "timeoutMillis": 60000,
"maxForEmitBatchBytes": -1
},
"parsers": [
diff --git a/tika-grpc/src/test/resources/tika-pipes-test-config.json b/tika-grpc/src/test/resources/tika-pipes-test-config.json
index f259570318..a5ff9f5f1a 100644
--- a/tika-grpc/src/test/resources/tika-pipes-test-config.json
+++ b/tika-grpc/src/test/resources/tika-pipes-test-config.json
@@ -1,4 +1,9 @@
{
+ "parse-context": {
+ "timeout-limits": {
+ "progressTimeoutMillis": 60000
+ }
+ },
"pipes": {
"javaPath": "JAVA_PATH",
"numClients": 2,
@@ -6,7 +11,6 @@
"-Xmx1g",
"-XX:ParallelGCThreads=2"
],
- "timeoutMillis": 60000,
"emitStrategy": {
"type": "PASSBACK_ALL"
},
diff --git a/tika-integration-tests/tika-pipes-kafka-integration-tests/src/test/resources/kafka/plugins-template.json b/tika-integration-tests/tika-pipes-kafka-integration-tests/src/test/resources/kafka/plugins-template.json
index a58ee6b824..9f859f8907 100644
--- a/tika-integration-tests/tika-pipes-kafka-integration-tests/src/test/resources/kafka/plugins-template.json
+++ b/tika-integration-tests/tika-pipes-kafka-integration-tests/src/test/resources/kafka/plugins-template.json
@@ -101,7 +101,6 @@
"-XX:+ExitOnOutOfMemoryError",
"LOG4J_JVM_ARG"
],
- "timeoutMillis": 60000,
"emitStrategy": {
"type": "DYNAMIC",
"thresholdBytes": 10000
diff --git a/tika-integration-tests/tika-pipes-opensearch-integration-tests/src/test/resources/opensearch/plugins-template.json b/tika-integration-tests/tika-pipes-opensearch-integration-tests/src/test/resources/opensearch/plugins-template.json
index 0c601b66a0..aa886d0712 100644
--- a/tika-integration-tests/tika-pipes-opensearch-integration-tests/src/test/resources/opensearch/plugins-template.json
+++ b/tika-integration-tests/tika-pipes-opensearch-integration-tests/src/test/resources/opensearch/plugins-template.json
@@ -69,8 +69,7 @@
"-Xmx512m",
"-XX:ParallelGCThreads=2",
"LOG4J_JVM_ARG"
- ],
- "timeoutMillis": 60000
+ ]
},
"metadata-filters": [
{
diff --git a/tika-integration-tests/tika-pipes-opensearch-integration-tests/src/test/resources/opensearch/tika-config-opensearch.json b/tika-integration-tests/tika-pipes-opensearch-integration-tests/src/test/resources/opensearch/tika-config-opensearch.json
index afad751349..f5449b3931 100644
--- a/tika-integration-tests/tika-pipes-opensearch-integration-tests/src/test/resources/opensearch/tika-config-opensearch.json
+++ b/tika-integration-tests/tika-pipes-opensearch-integration-tests/src/test/resources/opensearch/tika-config-opensearch.json
@@ -110,8 +110,7 @@
"-Xmx512m",
"-XX:ParallelGCThreads=2",
"LOG4J_JVM_ARG"
- ],
- "timeoutMillis": 60000
+ ]
},
"plugin-roots": "target/plugins"
}
diff --git a/tika-integration-tests/tika-pipes-s3-integration-tests/src/test/resources/s3/plugins-template.json b/tika-integration-tests/tika-pipes-s3-integration-tests/src/test/resources/s3/plugins-template.json
index b7bce1b100..33eba8223a 100644
--- a/tika-integration-tests/tika-pipes-s3-integration-tests/src/test/resources/s3/plugins-template.json
+++ b/tika-integration-tests/tika-pipes-s3-integration-tests/src/test/resources/s3/plugins-template.json
@@ -68,7 +68,6 @@
"-XX:+ExitOnOutOfMemoryError",
"LOG4J_JVM_ARG"
],
- "timeoutMillis": 60000,
"emitStrategy": {
"type": "DYNAMIC",
"thresholdBytes": 10000
diff --git a/tika-integration-tests/tika-pipes-solr-integration-tests/src/test/resources/solr/plugins-template.json b/tika-integration-tests/tika-pipes-solr-integration-tests/src/test/resources/solr/plugins-template.json
index 4f8f0e8719..b6e33ca4ab 100644
--- a/tika-integration-tests/tika-pipes-solr-integration-tests/src/test/resources/solr/plugins-template.json
+++ b/tika-integration-tests/tika-pipes-solr-integration-tests/src/test/resources/solr/plugins-template.json
@@ -101,8 +101,7 @@
"-XX:ParallelGCThreads=2",
"-XX:+ExitOnOutOfMemoryError",
"LOG4J_JVM_ARG"
- ],
- "timeoutMillis": 60000
+ ]
},
"plugin-roots": "target/plugins"
}
diff --git a/tika-integration-tests/tika-pipes-solr-integration-tests/src/test/resources/tika-config-solr-urls.json b/tika-integration-tests/tika-pipes-solr-integration-tests/src/test/resources/tika-config-solr-urls.json
index 3b6aa35d34..00b4a77dde 100644
--- a/tika-integration-tests/tika-pipes-solr-integration-tests/src/test/resources/tika-config-solr-urls.json
+++ b/tika-integration-tests/tika-pipes-solr-integration-tests/src/test/resources/tika-config-solr-urls.json
@@ -51,7 +51,6 @@
"-XX:+ExitOnOutOfMemoryError",
"-Dlog4j.configurationFile={LOG4J_PROPERTIES_FILE}"
],
- "timeoutMillis": 60000,
"emitStrategy": {
"type": "DYNAMIC",
"thresholdBytes": 10000
diff --git a/tika-parsers/tika-parsers-extended/tika-parser-scientific-module/src/main/java/org/apache/tika/parser/gdal/GDALParser.java b/tika-parsers/tika-parsers-extended/tika-parser-scientific-module/src/main/java/org/apache/tika/parser/gdal/GDALParser.java
index 12a9d9799a..6f1a071419 100644
--- a/tika-parsers/tika-parsers-extended/tika-parser-scientific-module/src/main/java/org/apache/tika/parser/gdal/GDALParser.java
+++ b/tika-parsers/tika-parsers-extended/tika-parser-scientific-module/src/main/java/org/apache/tika/parser/gdal/GDALParser.java
@@ -39,7 +39,8 @@ import org.xml.sax.ContentHandler;
import org.xml.sax.SAXException;
import org.apache.tika.config.TikaComponent;
-import org.apache.tika.config.TikaTaskTimeout;
+import org.apache.tika.config.TikaProgressTracker;
+import org.apache.tika.config.TimeoutLimits;
import org.apache.tika.exception.TikaException;
import org.apache.tika.io.TemporaryResources;
import org.apache.tika.io.TikaInputStream;
@@ -194,12 +195,13 @@ public class GDALParser implements Parser {
String[] runCommand = processCommand(tis).split("\\s+", -1);
- long localTimeoutMillis = TikaTaskTimeout.getTimeoutMillis(context, timeoutMs);
+ long localTimeoutMillis = TimeoutLimits.getProcessTimeoutMillis(context, timeoutMs);
FileProcessResult result = ProcessUtils.execute(new ProcessBuilder(runCommand),
localTimeoutMillis, maxStdOut, maxStdErr);
metadata.set(ExternalProcess.IS_TIMEOUT, result.isTimeout());
metadata.set(ExternalProcess.EXIT_VALUE, result.getExitValue());
+ TikaProgressTracker.update(context);
metadata.set(ExternalProcess.STD_OUT_LENGTH, result.getStdoutLength());
metadata.set(ExternalProcess.STD_OUT_IS_TRUNCATED, result.isStdoutTruncated());
metadata.set(ExternalProcess.STD_ERR_LENGTH, result.getStderrLength());
diff --git a/tika-parsers/tika-parsers-ml/tika-inference/src/main/java/org/apache/tika/inference/OpenAIImageEmbeddingParser.java b/tika-parsers/tika-parsers-ml/tika-inference/src/main/java/org/apache/tika/inference/OpenAIImageEmbeddingParser.java
index 44d3808136..b88c54d1bf 100644
--- a/tika-parsers/tika-parsers-ml/tika-inference/src/main/java/org/apache/tika/inference/OpenAIImageEmbeddingParser.java
+++ b/tika-parsers/tika-parsers-ml/tika-inference/src/main/java/org/apache/tika/inference/OpenAIImageEmbeddingParser.java
@@ -43,7 +43,8 @@ import org.apache.tika.config.Initializable;
import org.apache.tika.config.JsonConfig;
import org.apache.tika.config.ParseContextConfig;
import org.apache.tika.config.TikaComponent;
-import org.apache.tika.config.TikaTaskTimeout;
+import org.apache.tika.config.TikaProgressTracker;
+import org.apache.tika.config.TimeoutLimits;
import org.apache.tika.exception.TikaConfigException;
import org.apache.tika.exception.TikaException;
import org.apache.tika.inference.locator.Locators;
@@ -165,11 +166,12 @@ public class OpenAIImageEmbeddingParser implements Parser, Initializable {
String mimeType = detectMimeType(metadata);
String base64Data = Base64.getEncoder().encodeToString(imageBytes);
- long timeoutMillis = TikaTaskTimeout.getTimeoutMillis(
+ long timeoutMillis = TimeoutLimits.getProcessTimeoutMillis(
parseContext, config.getTimeoutSeconds() * 1000L);
float[] vector = callEmbeddingEndpoint(config, mimeType, base64Data,
timeoutMillis);
+ TikaProgressTracker.update(parseContext);
// Build a Chunk with the vector and locators
Locators locators = buildLocators(metadata);
diff --git a/tika-parsers/tika-parsers-ml/tika-parser-tess4j-module/src/main/java/org/apache/tika/parser/ocr/tess4j/Tess4JParser.java b/tika-parsers/tika-parsers-ml/tika-parser-tess4j-module/src/main/java/org/apache/tika/parser/ocr/tess4j/Tess4JParser.java
index 8796736251..d02952e6bb 100644
--- a/tika-parsers/tika-parsers-ml/tika-parser-tess4j-module/src/main/java/org/apache/tika/parser/ocr/tess4j/Tess4JParser.java
+++ b/tika-parsers/tika-parsers-ml/tika-parser-tess4j-module/src/main/java/org/apache/tika/parser/ocr/tess4j/Tess4JParser.java
@@ -43,7 +43,8 @@ import org.apache.tika.config.Initializable;
import org.apache.tika.config.JsonConfig;
import org.apache.tika.config.ParseContextConfig;
import org.apache.tika.config.TikaComponent;
-import org.apache.tika.config.TikaTaskTimeout;
+import org.apache.tika.config.TikaProgressTracker;
+import org.apache.tika.config.TimeoutLimits;
import org.apache.tika.exception.TikaConfigException;
import org.apache.tika.exception.TikaException;
import org.apache.tika.io.TikaInputStream;
@@ -152,7 +153,7 @@ public class Tess4JParser implements Parser, Initializable {
xhtml.startDocument();
Tesseract tesseract = null;
- long timeoutMillis = TikaTaskTimeout.getTimeoutMillis(
+ long timeoutMillis = TimeoutLimits.getProcessTimeoutMillis(
parseContext, config.getTimeoutSeconds() * 1000L);
try {
tesseract = borrowTesseract(timeoutMillis);
@@ -188,6 +189,7 @@ public class Tess4JParser implements Parser, Initializable {
}
String ocrResult = tesseract.doOCR(image);
+ TikaProgressTracker.update(parseContext);
// Emit the text as XHTML
AttributesImpl attrs = new AttributesImpl();
diff --git a/tika-parsers/tika-parsers-ml/tika-parser-vlm-ocr-module/src/main/java/org/apache/tika/parser/vlm/AbstractVLMParser.java b/tika-parsers/tika-parsers-ml/tika-parser-vlm-ocr-module/src/main/java/org/apache/tika/parser/vlm/AbstractVLMParser.java
index 5b16f2c90e..c135cea99f 100644
--- a/tika-parsers/tika-parsers-ml/tika-parser-vlm-ocr-module/src/main/java/org/apache/tika/parser/vlm/AbstractVLMParser.java
+++ b/tika-parsers/tika-parsers-ml/tika-parser-vlm-ocr-module/src/main/java/org/apache/tika/parser/vlm/AbstractVLMParser.java
@@ -36,7 +36,8 @@ import org.xml.sax.helpers.AttributesImpl;
import org.apache.tika.config.Initializable;
import org.apache.tika.config.ParseContextConfig;
-import org.apache.tika.config.TikaTaskTimeout;
+import org.apache.tika.config.TikaProgressTracker;
+import org.apache.tika.config.TimeoutLimits;
import org.apache.tika.exception.TikaConfigException;
import org.apache.tika.exception.TikaException;
import org.apache.tika.extractor.ParentContentHandler;
@@ -192,7 +193,7 @@ public abstract class AbstractVLMParser implements Parser, Initializable {
byte[] fileBytes = readFully(tis);
String base64Data = Base64.getEncoder().encodeToString(fileBytes);
- long timeoutMillis = TikaTaskTimeout.getTimeoutMillis(
+ long timeoutMillis = TimeoutLimits.getProcessTimeoutMillis(
parseContext, config.getTimeoutSeconds() * 1000L);
OkHttpClient client = getClientWithTimeout(timeoutMillis);
@@ -207,6 +208,7 @@ public abstract class AbstractVLMParser implements Parser, Initializable {
}
String responseBody = response.body() != null ? response.body().string() : "";
responseText = extractResponseText(responseBody, metadata);
+ TikaProgressTracker.update(parseContext);
} catch (IOException e) {
throw new TikaException("VLM request failed: " + e.getMessage(), e);
}
diff --git a/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-ocr-module/src/main/java/org/apache/tika/parser/ocr/TesseractOCRParser.java b/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-ocr-module/src/main/java/org/apache/tika/parser/ocr/TesseractOCRParser.java
index 4a1e19d316..5c4ded595a 100644
--- a/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-ocr-module/src/main/java/org/apache/tika/parser/ocr/TesseractOCRParser.java
+++ b/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-ocr-module/src/main/java/org/apache/tika/parser/ocr/TesseractOCRParser.java
@@ -62,7 +62,8 @@ import org.apache.tika.config.Initializable;
import org.apache.tika.config.JsonConfig;
import org.apache.tika.config.ParseContextConfig;
import org.apache.tika.config.TikaComponent;
-import org.apache.tika.config.TikaTaskTimeout;
+import org.apache.tika.config.TikaProgressTracker;
+import org.apache.tika.config.TimeoutLimits;
import org.apache.tika.exception.TikaConfigException;
import org.apache.tika.exception.TikaException;
import org.apache.tika.extractor.ParentContentHandler;
@@ -485,12 +486,13 @@ public class TesseractOCRParser extends AbstractExternalProcessParser implements
Process process = null;
String id = null;
- long timeoutMillis = TikaTaskTimeout.getTimeoutMillis(parseContext,
+ long timeoutMillis = TimeoutLimits.getProcessTimeoutMillis(parseContext,
config.getTimeoutSeconds() * 1000);
try {
process = pb.start();
id = register(process);
runOCRProcess(process, timeoutMillis);
+ TikaProgressTracker.update(parseContext);
} finally {
if (process != null) {
process.destroyForcibly();
diff --git a/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-ocr-module/src/test/java/org/apache/tika/parser/ocr/TesseractOCRParserTest.java b/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-ocr-module/src/test/java/org/apache/tika/parser/ocr/TesseractOCRParserTest.java
index ac68306c13..c4b89a0db1 100644
--- a/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-ocr-module/src/test/java/org/apache/tika/parser/ocr/TesseractOCRParserTest.java
+++ b/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-ocr-module/src/test/java/org/apache/tika/parser/ocr/TesseractOCRParserTest.java
@@ -30,7 +30,7 @@ import java.util.regex.Pattern;
import org.junit.jupiter.api.Test;
import org.apache.tika.TikaTest;
-import org.apache.tika.config.TikaTaskTimeout;
+import org.apache.tika.config.TimeoutLimits;
import org.apache.tika.config.loader.TikaLoader;
import org.apache.tika.exception.TikaConfigException;
import org.apache.tika.exception.TikaException;
@@ -187,7 +187,7 @@ public class TesseractOCRParserTest extends TikaTest {
.loadAutoDetectParser();
Metadata m = new Metadata();
ParseContext parseContext = new ParseContext();
- parseContext.set(TikaTaskTimeout.class, new TikaTaskTimeout(50));
+ parseContext.set(TimeoutLimits.class, new TimeoutLimits(50, 50));
getXML("testRotated+10.png", p, m, parseContext);
fail("should have thrown a timeout");
} catch (TikaException e) {
diff --git a/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-text-module/src/main/java/org/apache/tika/parser/strings/StringsParser.java b/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-text-module/src/main/java/org/apache/tika/parser/strings/StringsParser.java
index fbec536ba4..cd863a718c 100644
--- a/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-text-module/src/main/java/org/apache/tika/parser/strings/StringsParser.java
+++ b/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-text-module/src/main/java/org/apache/tika/parser/strings/StringsParser.java
@@ -38,6 +38,8 @@ import org.apache.tika.config.ConfigDeserializer;
import org.apache.tika.config.Initializable;
import org.apache.tika.config.JsonConfig;
import org.apache.tika.config.TikaComponent;
+import org.apache.tika.config.TikaProgressTracker;
+import org.apache.tika.config.TimeoutLimits;
import org.apache.tika.detect.FileCommandDetector;
import org.apache.tika.exception.TikaConfigException;
import org.apache.tika.exception.TikaException;
@@ -120,7 +122,7 @@ public class StringsParser implements Parser, Initializable {
xhtml.startDocument();
- totalBytes = doStrings(input, stringsConfig, xhtml);
+ totalBytes = doStrings(input, stringsConfig, xhtml, context);
xhtml.endDocument();
@@ -176,7 +178,8 @@ public class StringsParser implements Parser, Initializable {
* @throws TikaException if the parsing process has been interrupted.
* @throws SAXException
*/
- private int doStrings(File input, StringsConfig config, XHTMLContentHandler xhtml)
+ private int doStrings(File input, StringsConfig config, XHTMLContentHandler xhtml,
+ ParseContext context)
throws IOException, TikaException, SAXException {
String stringsProg = defaultConfig.getStringsPath() + getStringsProg();
@@ -204,11 +207,13 @@ public class StringsParser implements Parser, Initializable {
Thread gobbler = logStream(out, xhtml, totalBytes);
gobbler.start();
try {
- boolean completed = process.waitFor(config.getTimeoutSeconds(), TimeUnit.SECONDS);
+ long timeoutMillis = TimeoutLimits.getProcessTimeoutMillis(context, config.getTimeoutSeconds() * 1000L);
+ boolean completed = process.waitFor(timeoutMillis, TimeUnit.MILLISECONDS);
if (!completed) {
throw new TimeoutException("timed out");
}
gobbler.join(10000);
+ TikaProgressTracker.update(context);
} catch (InterruptedException | TimeoutException e) {
throw new TikaException("strings process failed", e);
} finally {
diff --git a/tika-pipes/tika-async-cli/src/main/java/org/apache/tika/async/cli/PluginsWriter.java b/tika-pipes/tika-async-cli/src/main/java/org/apache/tika/async/cli/PluginsWriter.java
index dd2b02d067..7871bfb9a5 100644
--- a/tika-pipes/tika-async-cli/src/main/java/org/apache/tika/async/cli/PluginsWriter.java
+++ b/tika-pipes/tika-async-cli/src/main/java/org/apache/tika/async/cli/PluginsWriter.java
@@ -100,9 +100,6 @@ public class PluginsWriter {
if (simpleAsyncConfig.getXmx() != null) {
pipesConfig.setForkedJvmArgs(new ArrayList<>(List.of(simpleAsyncConfig.getXmx())));
}
- if (simpleAsyncConfig.getTimeoutMs() != null) {
- pipesConfig.setTimeoutMillis(simpleAsyncConfig.getTimeoutMs());
- }
if (simpleAsyncConfig.isContentOnly()) {
pipesConfig.setParseMode(ParseMode.CONTENT_ONLY);
} else if (simpleAsyncConfig.isConcatenate()) {
@@ -123,6 +120,18 @@ public class PluginsWriter {
root.set("pipes", objectMapper.valueToTree(pipesConfig));
+ // Write timeout limits to parse-context if configured
+ if (simpleAsyncConfig.getTimeoutMs() != null) {
+ ObjectNode parseContext = (ObjectNode) root.get("parse-context");
+ if (parseContext == null) {
+ parseContext = objectMapper.createObjectNode();
+ root.set("parse-context", parseContext);
+ }
+ ObjectNode timeoutNode = objectMapper.createObjectNode();
+ timeoutNode.put("progressTimeoutMillis", simpleAsyncConfig.getTimeoutMs());
+ parseContext.set("timeout-limits", timeoutNode);
+ }
+
objectMapper.writerWithDefaultPrettyPrinter().writeValue(output.toFile(), root);
} catch (Exception e) {
throw new IOException(e);
diff --git a/tika-pipes/tika-async-cli/src/test/resources/configs/config-template.json b/tika-pipes/tika-async-cli/src/test/resources/configs/config-template.json
index 03384695ea..58c630f352 100644
--- a/tika-pipes/tika-async-cli/src/test/resources/configs/config-template.json
+++ b/tika-pipes/tika-async-cli/src/test/resources/configs/config-template.json
@@ -23,13 +23,17 @@
}
}
},
+ "parse-context": {
+ "timeout-limits": {
+ "progressTimeoutMillis": 60000
+ }
+ },
"pipes": {
"emitWithinMillis": 10000,
"emitMaxEstimatedBytes": 100000,
"queueSize": 10000,
"numEmitters": 1,
"emitIntermediateResults": false,
- "timeoutMillis": 60000,
"startupTimeoutMillis": 240000,
"sleepOnStartupTimeoutMillis": 240000,
"shutdownClientAfterMillis": 300000,
diff --git a/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/PipesClient.java b/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/PipesClient.java
index fb4ae62824..b65a0627b7 100644
--- a/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/PipesClient.java
+++ b/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/PipesClient.java
@@ -40,10 +40,9 @@ import java.util.concurrent.atomic.AtomicInteger;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-import org.apache.tika.config.TikaTaskTimeout;
+import org.apache.tika.config.TimeoutLimits;
import org.apache.tika.metadata.Metadata;
import org.apache.tika.metadata.TikaCoreProperties;
-import org.apache.tika.parser.ParseContext;
import org.apache.tika.pipes.api.FetchEmitTuple;
import org.apache.tika.pipes.api.PipesResult;
import org.apache.tika.pipes.api.emitter.EmitKey;
@@ -307,7 +306,9 @@ public class PipesClient implements Closeable {
}
private PipesResult waitForServer(FetchEmitTuple t, IntermediateResult intermediateResult) throws InterruptedException {
- long timeoutMillis = getTimeoutMillis(pipesConfig, t.getParseContext());
+ TimeoutLimits limits = TimeoutLimits.get(t.getParseContext());
+ long progressTimeoutMillis = limits.getProgressTimeoutMillis();
+ long totalTaskTimeoutMillis = limits.getTotalTaskTimeoutMillis();
Instant start = Instant.now();
Instant lastUpdate = start;
@@ -315,16 +316,26 @@ public class PipesClient implements Closeable {
if (Thread.currentThread().isInterrupted()) {
throw new InterruptedException("thread interrupt");
}
- long totalElapsed = Duration.between(start, Instant.now()).toMillis();
- if (totalElapsed > timeoutMillis) {
- LOG.warn("clientId={}: timeout on client side: id={} elapsed={} timeoutMillis={}",
- pipesClientId, t.getId(), totalElapsed, timeoutMillis);
+ Instant now = Instant.now();
+ long totalElapsed = Duration.between(start, now).toMillis();
+ if (totalElapsed > totalTaskTimeoutMillis) {
+ LOG.warn("clientId={}: total task timeout: id={} elapsed={}ms limit={}ms",
+ pipesClientId, t.getId(), totalElapsed, totalTaskTimeoutMillis);
// Mark for restart - server is stuck on current request and needs to be restarted
serverManager.markServerForRestart();
closeConnection();
return buildFatalResult(t.getId(), t.getEmitKey(), PipesResult.RESULT_STATUS.TIMEOUT,
intermediateResult.get());
}
+ long timeSinceUpdate = Duration.between(lastUpdate, now).toMillis();
+ if (timeSinceUpdate > progressTimeoutMillis) {
+ LOG.warn("clientId={}: progress timeout: id={} timeSinceUpdate={}ms limit={}ms",
+ pipesClientId, t.getId(), timeSinceUpdate, progressTimeoutMillis);
+ serverManager.markServerForRestart();
+ closeConnection();
+ return buildFatalResult(t.getId(), t.getEmitKey(), PipesResult.RESULT_STATUS.TIMEOUT,
+ intermediateResult.get());
+ }
try {
PipesMessage msg = PipesMessage.read(connectionTuple.input);
LOG.trace("clientId={}: received message type={} id={}", pipesClientId, msg.type(), t.getId());
@@ -358,7 +369,7 @@ public class PipesClient implements Closeable {
lastUpdate = Instant.now();
break;
case WORKING:
- lastUpdate = Instant.now();
+ lastUpdate = Instant.ofEpochMilli(msg.lastProgressMillis());
break;
case FINISHED:
PipesResult result = JsonPipesIpc.fromBytes(msg.payload(), PipesResult.class);
@@ -441,18 +452,4 @@ public class PipesClient implements Closeable {
private record ConnectionTuple(Socket socket, DataInputStream input, DataOutputStream output) {
}
- public static long getTimeoutMillis(PipesConfig pipesConfig, ParseContext parseContext) {
- long defaultTimeoutMillis = pipesConfig.getTimeoutMillis();
-
- if (parseContext == null) {
- return defaultTimeoutMillis;
- }
-
- TikaTaskTimeout tikaTaskTimeout = parseContext.get(TikaTaskTimeout.class);
- if (tikaTaskTimeout == null) {
- return defaultTimeoutMillis;
- }
- LOG.debug("applying timeout from parseContext: {}ms", tikaTaskTimeout.getTimeoutMillis());
- return tikaTaskTimeout.getTimeoutMillis();
- }
}
diff --git a/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/PipesConfig.java b/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/PipesConfig.java
index 16b7f6d410..2f72cec73a 100644
--- a/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/PipesConfig.java
+++ b/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/PipesConfig.java
@@ -27,8 +27,6 @@ import org.apache.tika.pipes.api.ParseMode;
public class PipesConfig {
- public static final long DEFAULT_TIMEOUT_MILLIS = 60000;
-
public static final long DEFAULT_STARTUP_TIMEOUT_MILLIS = 240000;
public static final long DEFAULT_SHUTDOWN_CLIENT_AFTER_MILLS = 300000;
@@ -58,7 +56,6 @@ public class PipesConfig {
*/
private boolean useSharedServer = DEFAULT_USE_SHARED_SERVER;
- private long timeoutMillis = DEFAULT_TIMEOUT_MILLIS;
private long socketTimeoutMs = DEFAULT_SOCKET_TIMEOUT_MS;
private long heartbeatIntervalMs = DEFAULT_HEARTBEAT_INTERVAL_MS;
private long startupTimeoutMillis = DEFAULT_STARTUP_TIMEOUT_MILLIS;
@@ -153,18 +150,6 @@ public class PipesConfig {
return config;
}
- public long getTimeoutMillis() {
- return timeoutMillis;
- }
-
- /**
- * How long to wait in milliseconds before timing out the forked process.
- * @param timeoutMillis
- */
- public void setTimeoutMillis(long timeoutMillis) {
- this.timeoutMillis = timeoutMillis;
- }
-
public long getSocketTimeoutMs() {
return socketTimeoutMs;
}
diff --git a/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/config/ConfigMerger.java b/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/config/ConfigMerger.java
index 998074bab4..33756dbd77 100644
--- a/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/config/ConfigMerger.java
+++ b/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/config/ConfigMerger.java
@@ -32,6 +32,8 @@ import com.fasterxml.jackson.databind.node.ObjectNode;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+import org.apache.tika.config.TimeoutLimits;
+
/**
* Utility for merging configuration overrides with existing Tika JSON configuration.
* <p>
@@ -57,7 +59,7 @@ import org.slf4j.LoggerFactory;
* ConfigOverrides overrides = ConfigOverrides.builder()
* .addFetcher("my-fetcher", "file-system-fetcher",
* Map.of("basePath", "/tmp/input"))
- * .setPipesConfig(4, 60000, null)
+ * .setPipesConfig(4, null)
* .setEmitStrategy(EmitStrategy.PASSBACK_ALL)
* .build();
*
@@ -154,9 +156,6 @@ public class ConfigMerger {
if (pc.getNumClients() > 0) {
pipesNode.put("numClients", pc.getNumClients());
}
- if (pc.getTimeoutMillis() > 0) {
- pipesNode.put("timeoutMillis", pc.getTimeoutMillis());
- }
if (pc.getStartupTimeoutMillis() > 0) {
pipesNode.put("startupTimeoutMillis", pc.getStartupTimeoutMillis());
}
@@ -174,8 +173,7 @@ public class ConfigMerger {
pipesNode.set("forkedJvmArgs", argsArray);
}
- LOG.debug("Applied pipes config: numClients={}, timeoutMillis={}",
- pc.getNumClients(), pc.getTimeoutMillis());
+ LOG.debug("Applied pipes config: numClients={}", pc.getNumClients());
}
// Apply emit strategy
@@ -192,6 +190,18 @@ public class ConfigMerger {
LOG.debug("Set plugin-roots: {}", overrides.getPluginRoots());
}
+ // Apply timeout limits to parse-context section
+ if (overrides.getTimeoutLimits() != null) {
+ TimeoutLimits tl = overrides.getTimeoutLimits();
+ ObjectNode parseContextNode = getOrCreateObject(mapper, root, "parse-context");
+ ObjectNode timeoutNode = getOrCreateObject(mapper, parseContextNode, "timeout-limits");
+ timeoutNode.put("totalTaskTimeoutMillis", tl.getTotalTaskTimeoutMillis());
+ timeoutNode.put("progressTimeoutMillis", tl.getProgressTimeoutMillis());
+ LOG.debug("Applied timeout limits: totalTaskTimeoutMillis={}, " +
+ "progressTimeoutMillis={}", tl.getTotalTaskTimeoutMillis(),
+ tl.getProgressTimeoutMillis());
+ }
+
// Write merged config to temp file
Path tempConfig = Files.createTempFile("tika-config-merged-", ".json");
mapper.writerWithDefaultPrettyPrinter().writeValue(tempConfig.toFile(), root);
diff --git a/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/config/ConfigOverrides.java b/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/config/ConfigOverrides.java
index 84536129f8..b3c1b23f4d 100644
--- a/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/config/ConfigOverrides.java
+++ b/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/config/ConfigOverrides.java
@@ -22,6 +22,7 @@ import java.util.HashMap;
import java.util.List;
import java.util.Map;
+import org.apache.tika.config.TimeoutLimits;
import org.apache.tika.pipes.core.EmitStrategy;
/**
@@ -36,7 +37,7 @@ import org.apache.tika.pipes.core.EmitStrategy;
* ConfigOverrides overrides = ConfigOverrides.builder()
* .addFetcher("my-fetcher", "file-system-fetcher",
* Map.of("basePath", "/tmp/input"))
- * .setPipesConfig(4, 60000, null)
+ * .setPipesConfig(4, null)
* .setEmitStrategy(EmitStrategy.PASSBACK_ALL)
* .setPluginRoots("plugins")
* .build();
@@ -49,6 +50,7 @@ public class ConfigOverrides {
private final PipesConfigOverride pipesConfig;
private final String pluginRoots;
private final EmitStrategy emitStrategy;
+ private final TimeoutLimits timeoutLimits;
private ConfigOverrides(Builder builder) {
this.fetchers = Collections.unmodifiableList(new ArrayList<>(builder.fetchers));
@@ -56,6 +58,7 @@ public class ConfigOverrides {
this.pipesConfig = builder.pipesConfig;
this.pluginRoots = builder.pluginRoots;
this.emitStrategy = builder.emitStrategy;
+ this.timeoutLimits = builder.timeoutLimits;
}
public static Builder builder() {
@@ -82,6 +85,10 @@ public class ConfigOverrides {
return emitStrategy;
}
+ public TimeoutLimits getTimeoutLimits() {
+ return timeoutLimits;
+ }
+
/**
* Represents a fetcher configuration override.
*/
@@ -141,16 +148,14 @@ public class ConfigOverrides {
*/
public static class PipesConfigOverride {
private final int numClients;
- private final long timeoutMillis;
private final long startupTimeoutMillis;
private final int maxFilesProcessedPerProcess;
private final List<String> forkedJvmArgs;
- public PipesConfigOverride(int numClients, long timeoutMillis,
+ public PipesConfigOverride(int numClients,
long startupTimeoutMillis, int maxFilesProcessedPerProcess,
List<String> forkedJvmArgs) {
this.numClients = numClients;
- this.timeoutMillis = timeoutMillis;
this.startupTimeoutMillis = startupTimeoutMillis;
this.maxFilesProcessedPerProcess = maxFilesProcessedPerProcess;
this.forkedJvmArgs = forkedJvmArgs != null ?
@@ -161,10 +166,6 @@ public class ConfigOverrides {
return numClients;
}
- public long getTimeoutMillis() {
- return timeoutMillis;
- }
-
public long getStartupTimeoutMillis() {
return startupTimeoutMillis;
}
@@ -187,6 +188,7 @@ public class ConfigOverrides {
private PipesConfigOverride pipesConfig;
private String pluginRoots;
private EmitStrategy emitStrategy;
+ private TimeoutLimits timeoutLimits;
private Builder() {
}
@@ -221,13 +223,12 @@ public class ConfigOverrides {
* Set pipes configuration with basic options.
*
* @param numClients number of forked JVM clients
- * @param timeoutMillis parse timeout in milliseconds
* @param forkedJvmArgs JVM arguments for forked processes (may be null)
* @return this builder
*/
- public Builder setPipesConfig(int numClients, long timeoutMillis,
+ public Builder setPipesConfig(int numClients,
List<String> forkedJvmArgs) {
- return setPipesConfig(numClients, timeoutMillis,
+ return setPipesConfig(numClients,
org.apache.tika.pipes.core.PipesConfig.DEFAULT_STARTUP_TIMEOUT_MILLIS,
org.apache.tika.pipes.core.PipesConfig.DEFAULT_MAX_FILES_PROCESSED_PER_PROCESS,
forkedJvmArgs);
@@ -237,20 +238,30 @@ public class ConfigOverrides {
* Set pipes configuration with all options.
*
* @param numClients number of forked JVM clients
- * @param timeoutMillis parse timeout in milliseconds
* @param startupTimeoutMillis startup timeout in milliseconds
* @param maxFilesProcessedPerProcess max files before process restart
* @param forkedJvmArgs JVM arguments for forked processes (may be null)
* @return this builder
*/
- public Builder setPipesConfig(int numClients, long timeoutMillis,
+ public Builder setPipesConfig(int numClients,
long startupTimeoutMillis, int maxFilesProcessedPerProcess,
List<String> forkedJvmArgs) {
- this.pipesConfig = new PipesConfigOverride(numClients, timeoutMillis,
+ this.pipesConfig = new PipesConfigOverride(numClients,
startupTimeoutMillis, maxFilesProcessedPerProcess, forkedJvmArgs);
return this;
}
+ /**
+ * Set the timeout limits to write to the parse-context section.
+ *
+ * @param timeoutLimits the timeout limits (may be null to use defaults)
+ * @return this builder
+ */
+ public Builder setTimeoutLimits(TimeoutLimits timeoutLimits) {
+ this.timeoutLimits = timeoutLimits;
+ return this;
+ }
+
/**
* Set the plugin roots path.
*
diff --git a/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/protocol/PipesMessage.java b/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/protocol/PipesMessage.java
index 753f780fda..5aecc5c90a 100644
--- a/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/protocol/PipesMessage.java
+++ b/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/protocol/PipesMessage.java
@@ -125,12 +125,14 @@ public record PipesMessage(PipesMessageType type, byte[] payload) {
}
/**
- * Creates a WORKING heartbeat with a progress counter in the payload.
+ * Creates a WORKING heartbeat with the last-progress timestamp in the payload.
+ *
+ * @param lastProgressMillis epoch millis of the last progress update
*/
- public static PipesMessage working(long counter) {
+ public static PipesMessage working(long lastProgressMillis) {
byte[] payload = ByteBuffer.allocate(Long.BYTES)
.order(ByteOrder.BIG_ENDIAN)
- .putLong(counter)
+ .putLong(lastProgressMillis)
.array();
return new PipesMessage(PipesMessageType.WORKING, payload);
}
@@ -156,11 +158,13 @@ public record PipesMessage(PipesMessageType type, byte[] payload) {
}
/**
- * Extracts the progress counter from a WORKING message payload.
+ * Extracts the last-progress timestamp from a WORKING message payload.
+ *
+ * @return epoch millis of the last progress update reported by the server
*/
- public long progressCounter() {
+ public long lastProgressMillis() {
if (type != PipesMessageType.WORKING) {
- throw new IllegalStateException("progressCounter() only valid for WORKING messages");
+ throw new IllegalStateException("lastProgressMillis() only valid for WORKING messages");
}
return ByteBuffer.wrap(payload)
.order(ByteOrder.BIG_ENDIAN)
diff --git a/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/server/ConnectionHandler.java b/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/server/ConnectionHandler.java
index 25e080a941..e720c73c43 100644
--- a/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/server/ConnectionHandler.java
+++ b/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/server/ConnectionHandler.java
@@ -40,13 +40,14 @@ import java.util.concurrent.atomic.AtomicInteger;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+import org.apache.tika.config.TikaProgressTracker;
+import org.apache.tika.config.TimeoutLimits;
import org.apache.tika.exception.TikaConfigException;
import org.apache.tika.metadata.Metadata;
import org.apache.tika.parser.ParseContext;
import org.apache.tika.pipes.api.FetchEmitTuple;
import org.apache.tika.pipes.api.PipesResult;
import org.apache.tika.pipes.core.EmitStrategyConfig;
-import org.apache.tika.pipes.core.PipesClient;
import org.apache.tika.pipes.core.PipesConfig;
import org.apache.tika.pipes.core.protocol.PipesMessage;
import org.apache.tika.pipes.core.protocol.PipesMessageType;
@@ -154,12 +155,14 @@ public class ConnectionHandler implements Runnable, Closeable {
ServerProtocolIO.validateFetchEmitTuple(fetchEmitTuple);
ParseContext mergedContext = resources.createMergedParseContext(fetchEmitTuple.getParseContext());
ParseContextUtils.resolveAll(mergedContext, getClass().getClassLoader());
+ TikaProgressTracker tracker = new TikaProgressTracker();
+ mergedContext.set(TikaProgressTracker.class, tracker);
PipesWorker pipesWorker = createPipesWorker(intermediateResult, fetchEmitTuple,
mergedContext, countDownLatch);
executorCompletionService.submit(pipesWorker);
- loopUntilDone(fetchEmitTuple, mergedContext, intermediateResult, countDownLatch);
+ loopUntilDone(fetchEmitTuple, mergedContext, intermediateResult, countDownLatch, tracker);
} catch (TikaConfigException e) {
LOG.error("handlerId={}: config error processing request", handlerId, e);
handleCrash(PipesMessageType.UNSPECIFIED_CRASH, fetchEmitTuple.getId(), e);
@@ -210,10 +213,13 @@ public class ConnectionHandler implements Runnable, Closeable {
private void loopUntilDone(FetchEmitTuple fetchEmitTuple, ParseContext mergedContext,
ArrayBlockingQueue<Metadata> intermediateResult,
- CountDownLatch countDownLatch) throws InterruptedException, IOException {
+ CountDownLatch countDownLatch,
+ TikaProgressTracker tracker) throws InterruptedException, IOException {
Instant start = Instant.now();
- long timeoutMillis = PipesClient.getTimeoutMillis(pipesConfig, mergedContext);
- long progressCounter = 1;
+ TimeoutLimits limits = TimeoutLimits.get(mergedContext);
+ long progressTimeoutMillis = limits.getProgressTimeoutMillis();
+ long totalTaskTimeoutMillis = limits.getTotalTaskTimeoutMillis();
+ long heartbeatCounter = 1;
boolean wroteIntermediateResult = false;
while (running) {
@@ -256,26 +262,46 @@ public class ConnectionHandler implements Runnable, Closeable {
// Send fire-and-forget heartbeat
long elapsed = System.currentTimeMillis() - start.toEpochMilli();
- if (elapsed > progressCounter * heartbeatIntervalMs) {
- LOG.trace("handlerId={}: still processing, counter={}", handlerId, progressCounter);
- PipesMessage.working(progressCounter++).write(output);
+ if (elapsed > heartbeatCounter * heartbeatIntervalMs) {
+ LOG.trace("handlerId={}: still processing, counter={}", handlerId, heartbeatCounter);
+ PipesMessage.working(tracker.getLastProgressMillis()).write(output);
+ heartbeatCounter++;
}
- // Check timeout
- if (Duration.between(start, Instant.now()).toMillis() > timeoutMillis) {
- handleTimeout(fetchEmitTuple.getId());
+ // Check timeouts
+ if (checkTotalTimeout(start, totalTaskTimeoutMillis, fetchEmitTuple.getId())) {
return;
}
+ if (checkProgressTimeout(tracker, progressTimeoutMillis, fetchEmitTuple.getId())) {
+ return;
+ }
+ }
+ }
+
+ private boolean checkTotalTimeout(Instant start, long totalTaskTimeoutMillis, String id) {
+ long elapsed = Duration.between(start, Instant.now()).toMillis();
+ if (elapsed > totalTaskTimeoutMillis) {
+ handleCrash(PipesMessageType.TIMEOUT, id,
+ new RuntimeException("Server-side total task timeout after " + elapsed + "ms (limit: " + totalTaskTimeoutMillis + "ms)"));
+ // Timeout means a parsing thread is stuck - the JVM must be restarted
+ LOG.error("handlerId={}: exiting server due to total task timeout", handlerId);
+ System.exit(PipesMessageType.TIMEOUT.getExitCode().orElse(17));
+ return true;
}
+ return false;
}
- private void handleTimeout(String id) throws IOException {
- LOG.warn("handlerId={}: timeout processing id={}", handlerId, id);
- handleCrash(PipesMessageType.TIMEOUT, id,
- new RuntimeException("Server-side timeout processing " + id));
- // Timeout means a parsing thread is stuck - the JVM must be restarted
- LOG.error("handlerId={}: exiting server due to timeout", handlerId);
- System.exit(PipesMessageType.TIMEOUT.getExitCode().orElse(17));
+ private boolean checkProgressTimeout(TikaProgressTracker tracker, long progressTimeoutMillis, String id) {
+ long timeSinceProgress = System.currentTimeMillis() - tracker.getLastProgressMillis();
+ if (timeSinceProgress > progressTimeoutMillis) {
+ handleCrash(PipesMessageType.TIMEOUT, id,
+ new RuntimeException("Server-side progress timeout: no progress for " + timeSinceProgress + "ms (limit: " + progressTimeoutMillis + "ms)"));
+ // Timeout means a parsing thread is stuck - the JVM must be restarted
+ LOG.error("handlerId={}: exiting server due to progress timeout", handlerId);
+ System.exit(PipesMessageType.TIMEOUT.getExitCode().orElse(17));
+ return true;
+ }
+ return false;
}
private void handleCrash(PipesMessageType crashType, String id, Throwable t) {
diff --git a/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/server/PipesServer.java b/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/server/PipesServer.java
index e69137e5f7..76a90519d2 100644
--- a/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/server/PipesServer.java
+++ b/tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/server/PipesServer.java
@@ -45,6 +45,8 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.xml.sax.SAXException;
+import org.apache.tika.config.TikaProgressTracker;
+import org.apache.tika.config.TimeoutLimits;
import org.apache.tika.config.loader.TikaJsonConfig;
import org.apache.tika.config.loader.TikaLoader;
import org.apache.tika.detect.Detector;
@@ -342,11 +344,13 @@ public class PipesServer implements AutoCloseable {
ParseContext mergedContext = createMergedParseContext(fetchEmitTuple.getParseContext());
// Resolve friendly-named configs in ParseContext to actual objects
ParseContextUtils.resolveAll(mergedContext, getClass().getClassLoader());
+ TikaProgressTracker tracker = new TikaProgressTracker();
+ mergedContext.set(TikaProgressTracker.class, tracker);
PipesWorker pipesWorker = getPipesWorker(intermediateResult, fetchEmitTuple, mergedContext, countDownLatch);
executorCompletionService.submit(pipesWorker);
try {
- loopUntilDone(fetchEmitTuple, mergedContext, executorCompletionService, intermediateResult, countDownLatch);
+ loopUntilDone(fetchEmitTuple, mergedContext, executorCompletionService, intermediateResult, countDownLatch, tracker);
} catch (Throwable t) {
LOG.error("Serious problem processing request", t);
}
@@ -388,10 +392,13 @@ public class PipesServer implements AutoCloseable {
private void loopUntilDone(FetchEmitTuple fetchEmitTuple, ParseContext mergedContext,
ExecutorCompletionService<PipesResult> executorCompletionService,
- ArrayBlockingQueue<Metadata> intermediateResult, CountDownLatch countDownLatch) throws InterruptedException, IOException {
+ ArrayBlockingQueue<Metadata> intermediateResult, CountDownLatch countDownLatch,
+ TikaProgressTracker tracker) throws InterruptedException, IOException {
Instant start = Instant.now();
- long timeoutMillis = PipesClient.getTimeoutMillis(pipesConfig, mergedContext);
- long progressCounter = 1;
+ TimeoutLimits limits = TimeoutLimits.get(mergedContext);
+ long progressTimeoutMillis = limits.getProgressTimeoutMillis();
+ long totalTaskTimeoutMillis = limits.getTotalTaskTimeoutMillis();
+ long heartbeatCounter = 1;
boolean wroteIntermediateResult = false;
while (true) {
@@ -431,22 +438,36 @@ public class PipesServer implements AutoCloseable {
// Send fire-and-forget heartbeat if we've waited long enough
long elapsed = System.currentTimeMillis() - start.toEpochMilli();
- if (elapsed > progressCounter * heartbeatIntervalMs) {
- LOG.debug("still processing: {}", progressCounter);
- PipesMessage.working(progressCounter++).write(output);
+ if (elapsed > heartbeatCounter * heartbeatIntervalMs) {
+ PipesMessage.working(tracker.getLastProgressMillis()).write(output);
+ heartbeatCounter++;
}
- if (checkTimeout(start, timeoutMillis, fetchEmitTuple.getId())) {
+ if (checkTotalTimeout(start, totalTaskTimeoutMillis, fetchEmitTuple.getId())) {
return; // handleCrash calls exit(), but guard against unexpected return
}
+ if (checkProgressTimeout(tracker, progressTimeoutMillis, fetchEmitTuple.getId())) {
+ return;
+ }
}
}
- private boolean checkTimeout(Instant start, long timeoutMillis, String id) {
- if (Duration.between(start, Instant.now()).toMillis() > timeoutMillis) {
+ private boolean checkTotalTimeout(Instant start, long totalTaskTimeoutMillis, String id) {
+ long elapsed = Duration.between(start, Instant.now()).toMillis();
+ if (elapsed > totalTaskTimeoutMillis) {
+ handleCrash(PipesMessageType.TIMEOUT, id,
+ new RuntimeException("Server-side total task timeout after " + elapsed + "ms (limit: " + totalTaskTimeoutMillis + "ms)"));
+ return true;
+ }
+ return false;
+ }
+
+ private boolean checkProgressTimeout(TikaProgressTracker tracker, long progressTimeoutMillis, String id) {
+ long timeSinceProgress = System.currentTimeMillis() - tracker.getLastProgressMillis();
+ if (timeSinceProgress > progressTimeoutMillis) {
handleCrash(PipesMessageType.TIMEOUT, id,
- new RuntimeException("Server-side timeout after " + timeoutMillis + "ms"));
+ new RuntimeException("Server-side progress timeout: no progress for " + timeSinceProgress + "ms (limit: " + progressTimeoutMillis + "ms)"));
return true;
}
return false;
diff --git a/tika-pipes/tika-pipes-core/src/test/java/org/apache/tika/pipes/core/config/ConfigMergerTest.java b/tika-pipes/tika-pipes-core/src/test/java/org/apache/tika/pipes/core/config/ConfigMergerTest.java
index 39be285793..a76e27ad8a 100644
--- a/tika-pipes/tika-pipes-core/src/test/java/org/apache/tika/pipes/core/config/ConfigMergerTest.java
+++ b/tika-pipes/tika-pipes-core/src/test/java/org/apache/tika/pipes/core/config/ConfigMergerTest.java
@@ -45,7 +45,7 @@ public class ConfigMergerTest {
ConfigOverrides overrides = ConfigOverrides.builder()
.addFetcher("my-fetcher", "file-system-fetcher",
Map.of("basePath", "/tmp/input", "allowAbsolutePaths", true))
- .setPipesConfig(4, 60000, null)
+ .setPipesConfig(4, null)
.setEmitStrategy(EmitStrategy.PASSBACK_ALL)
.setPluginRoots("plugins")
.build();
@@ -70,7 +70,6 @@ public class ConfigMergerTest {
// Check pipes config
assertTrue(root.has("pipes"));
assertEquals(4, root.get("pipes").get("numClients").asInt());
- assertEquals(60000, root.get("pipes").get("timeoutMillis").asLong());
// Check emit strategy
assertEquals("PASSBACK_ALL", root.get("pipes").get("emitStrategy").get("type").asText());
@@ -107,7 +106,7 @@ public class ConfigMergerTest {
ConfigOverrides overrides = ConfigOverrides.builder()
.addFetcher("new-fetcher", "file-system-fetcher",
Map.of("basePath", "/new/path"))
- .setPipesConfig(8, 120000, null)
+ .setPipesConfig(8, null)
.build();
ConfigMerger.MergeResult result = ConfigMerger.mergeOrCreate(existingPath, overrides);
@@ -133,7 +132,6 @@ public class ConfigMergerTest {
// Pipes config should be overridden
assertEquals(8, root.get("pipes").get("numClients").asInt());
- assertEquals(120000, root.get("pipes").get("timeoutMillis").asLong());
// Existing plugin-roots should be preserved (not overridden)
assertEquals("existing-plugins", root.get("plugin-roots").asText());
@@ -190,7 +188,7 @@ public class ConfigMergerTest {
@Test
public void testJvmArgs() throws IOException {
ConfigOverrides overrides = ConfigOverrides.builder()
- .setPipesConfig(4, 60000, List.of("-Xmx512m", "-Dsome.prop=value"))
+ .setPipesConfig(4, List.of("-Xmx512m", "-Dsome.prop=value"))
.build();
ConfigMerger.MergeResult result = ConfigMerger.mergeOrCreate(null, overrides);
@@ -211,7 +209,7 @@ public class ConfigMergerTest {
@Test
public void testFullPipesConfig() throws IOException {
ConfigOverrides overrides = ConfigOverrides.builder()
- .setPipesConfig(8, 120000, 300000, 5000, List.of("-Xmx1g"))
+ .setPipesConfig(8, 300000, 5000, List.of("-Xmx1g"))
.build();
ConfigMerger.MergeResult result = ConfigMerger.mergeOrCreate(null, overrides);
@@ -221,7 +219,6 @@ public class ConfigMergerTest {
JsonNode pipes = root.get("pipes");
assertEquals(8, pipes.get("numClients").asInt());
- assertEquals(120000, pipes.get("timeoutMillis").asLong());
assertEquals(300000, pipes.get("startupTimeoutMillis").asLong());
assertEquals(5000, pipes.get("maxFilesProcessedPerProcess").asInt());
diff --git a/tika-pipes/tika-pipes-core/src/test/java/org/apache/tika/pipes/core/protocol/PipesMessageTest.java b/tika-pipes/tika-pipes-core/src/test/java/org/apache/tika/pipes/core/protocol/PipesMessageTest.java
index 372cf49bee..396ae61de7 100644
--- a/tika-pipes/tika-pipes-core/src/test/java/org/apache/tika/pipes/core/protocol/PipesMessageTest.java
+++ b/tika-pipes/tika-pipes-core/src/test/java/org/apache/tika/pipes/core/protocol/PipesMessageTest.java
@@ -71,7 +71,7 @@ class PipesMessageTest {
PipesMessage original = PipesMessage.working(42L);
PipesMessage roundTripped = roundTrip(original);
assertEquals(PipesMessageType.WORKING, roundTripped.type());
- assertEquals(42L, roundTripped.progressCounter());
+ assertEquals(42L, roundTripped.lastProgressMillis());
}
@Test
diff --git a/tika-pipes/tika-pipes-fork-parser/src/main/java/org/apache/tika/pipes/fork/PipesForkParser.java b/tika-pipes/tika-pipes-fork-parser/src/main/java/org/apache/tika/pipes/fork/PipesForkParser.java
index 3357db35cb..b9e7bb6d57 100644
--- a/tika-pipes/tika-pipes-fork-parser/src/main/java/org/apache/tika/pipes/fork/PipesForkParser.java
+++ b/tika-pipes/tika-pipes-fork-parser/src/main/java/org/apache/tika/pipes/fork/PipesForkParser.java
@@ -385,13 +385,17 @@ public class PipesForkParser implements Closeable {
// Set pipes configuration
.setPipesConfig(
pc.getNumClients(),
- pc.getTimeoutMillis(),
pc.getStartupTimeoutMillis(),
pc.getMaxFilesProcessedPerProcess(),
pc.getForkedJvmArgs())
// Use PASSBACK_ALL strategy - results returned through socket
.setEmitStrategy(EmitStrategy.PASSBACK_ALL);
+ // Set timeout limits if configured
+ if (config.getTimeoutLimits() != null) {
+ builder.setTimeoutLimits(config.getTimeoutLimits());
+ }
+
// Set plugin roots if specified
if (config.getPluginsDir() != null) {
builder.setPluginRoots(config.getPluginsDir().toAbsolutePath().toString());
diff --git a/tika-pipes/tika-pipes-fork-parser/src/main/java/org/apache/tika/pipes/fork/PipesForkParserConfig.java b/tika-pipes/tika-pipes-fork-parser/src/main/java/org/apache/tika/pipes/fork/PipesForkParserConfig.java
index 237e7e2d2d..06d42b97c2 100644
--- a/tika-pipes/tika-pipes-fork-parser/src/main/java/org/apache/tika/pipes/fork/PipesForkParserConfig.java
+++ b/tika-pipes/tika-pipes-fork-parser/src/main/java/org/apache/tika/pipes/fork/PipesForkParserConfig.java
@@ -21,6 +21,7 @@ import java.util.ArrayList;
import java.util.List;
import org.apache.tika.config.EmbeddedLimits;
+import org.apache.tika.config.TimeoutLimits;
import org.apache.tika.pipes.api.ParseMode;
import org.apache.tika.pipes.core.PipesConfig;
import org.apache.tika.sax.BasicContentHandlerFactory;
@@ -41,6 +42,7 @@ public class PipesForkParserConfig {
private Path pluginsDir;
private EmbeddedLimits embeddedLimits;
private Path userConfigPath;
+ private TimeoutLimits timeoutLimits;
public PipesForkParserConfig() {
this.pipesConfig = new PipesConfig();
@@ -179,16 +181,28 @@ public class PipesForkParserConfig {
}
/**
- * Set the timeout in milliseconds for parsing operations.
+ * Set the timeout limits for parsing operations.
+ * <p>
+ * The progress timeout bounds the time between progress updates (catches
+ * hung parsers). The total task timeout bounds overall wall-clock time.
*
- * @param timeoutMillis the timeout in milliseconds
+ * @param timeoutLimits the timeout limits
* @return this config for chaining
*/
- public PipesForkParserConfig setTimeoutMillis(long timeoutMillis) {
- pipesConfig.setTimeoutMillis(timeoutMillis);
+ public PipesForkParserConfig setTimeoutLimits(TimeoutLimits timeoutLimits) {
+ this.timeoutLimits = timeoutLimits;
return this;
}
+ /**
+ * Get the timeout limits.
+ *
+ * @return the timeout limits, or null if not set (defaults will be used)
+ */
+ public TimeoutLimits getTimeoutLimits() {
+ return timeoutLimits;
+ }
+
/**
* Set the JVM arguments for the forked process.
*
diff --git a/tika-pipes/tika-pipes-fork-parser/src/test/java/org/apache/tika/pipes/fork/PipesForkParserTest.java b/tika-pipes/tika-pipes-fork-parser/src/test/java/org/apache/tika/pipes/fork/PipesForkParserTest.java
index 9d46945c5c..f3a0e43d51 100644
--- a/tika-pipes/tika-pipes-fork-parser/src/test/java/org/apache/tika/pipes/fork/PipesForkParserTest.java
+++ b/tika-pipes/tika-pipes-fork-parser/src/test/java/org/apache/tika/pipes/fork/PipesForkParserTest.java
@@ -81,7 +81,6 @@ public class PipesForkParserTest {
.setPluginsDir(PLUGINS_DIR)
.setHandlerType(BasicContentHandlerFactory.HANDLER_TYPE.TEXT)
.setParseMode(ParseMode.RMETA)
- .setTimeoutMillis(60000)
.addJvmArg("-Xmx256m");
try (PipesForkParser parser = new PipesForkParser(config);
@@ -114,8 +113,7 @@ public class PipesForkParserTest {
PipesForkParserConfig config = new PipesForkParserConfig()
.setPluginsDir(PLUGINS_DIR)
.setHandlerType(BasicContentHandlerFactory.HANDLER_TYPE.TEXT)
- .setParseMode(ParseMode.RMETA)
- .setTimeoutMillis(60000);
+ .setParseMode(ParseMode.RMETA);
try (PipesForkParser parser = new PipesForkParser(config);
TikaInputStream tis = TikaInputStream.get(testFile)) {
@@ -144,8 +142,7 @@ public class PipesForkParserTest {
PipesForkParserConfig config = new PipesForkParserConfig()
.setPluginsDir(PLUGINS_DIR)
.setHandlerType(BasicContentHandlerFactory.HANDLER_TYPE.TEXT)
- .setParseMode(ParseMode.RMETA)
- .setTimeoutMillis(60000);
+ .setParseMode(ParseMode.RMETA);
try (PipesForkParser parser = new PipesForkParser(config)) {
try (TikaInputStream tis1 = TikaInputStream.get(testFile1)) {
@@ -171,8 +168,7 @@ public class PipesForkParserTest {
PipesForkParserConfig config = new PipesForkParserConfig()
.setPluginsDir(PLUGINS_DIR)
.setHandlerType(BasicContentHandlerFactory.HANDLER_TYPE.TEXT)
- .setParseMode(ParseMode.CONCATENATE)
- .setTimeoutMillis(60000);
+ .setParseMode(ParseMode.CONCATENATE);
try (PipesForkParser parser = new PipesForkParser(config);
TikaInputStream tis = TikaInputStream.get(testZip)) {
@@ -205,8 +201,7 @@ public class PipesForkParserTest {
PipesForkParserConfig config = new PipesForkParserConfig()
.setPluginsDir(PLUGINS_DIR)
.setHandlerType(BasicContentHandlerFactory.HANDLER_TYPE.TEXT)
- .setParseMode(ParseMode.NO_PARSE)
- .setTimeoutMillis(60000);
+ .setParseMode(ParseMode.NO_PARSE);
try (PipesForkParser parser = new PipesForkParser(config);
TikaInputStream tis = TikaInputStream.get(testFile)) {
@@ -243,8 +238,7 @@ public class PipesForkParserTest {
PipesForkParserConfig config = new PipesForkParserConfig()
.setPluginsDir(PLUGINS_DIR)
.setHandlerType(BasicContentHandlerFactory.HANDLER_TYPE.TEXT)
- .setParseMode(ParseMode.NO_PARSE)
- .setTimeoutMillis(60000);
+ .setParseMode(ParseMode.NO_PARSE);
try (PipesForkParser parser = new PipesForkParser(config);
TikaInputStream tis = TikaInputStream.get(testZip)) {
@@ -280,8 +274,7 @@ public class PipesForkParserTest {
PipesForkParserConfig config = new PipesForkParserConfig()
.setPluginsDir(PLUGINS_DIR)
.setHandlerType(BasicContentHandlerFactory.HANDLER_TYPE.TEXT)
- .setParseMode(ParseMode.RMETA)
- .setTimeoutMillis(60000);
+ .setParseMode(ParseMode.RMETA);
try (PipesForkParser parser = new PipesForkParser(config);
TikaInputStream tis = TikaInputStream.get(testZip)) {
@@ -308,8 +301,7 @@ public class PipesForkParserTest {
PipesForkParserConfig explicitConfig = new PipesForkParserConfig()
.setPluginsDir(PLUGINS_DIR)
.setHandlerType(BasicContentHandlerFactory.HANDLER_TYPE.TEXT)
- .setParseMode(ParseMode.RMETA)
- .setTimeoutMillis(60000);
+ .setParseMode(ParseMode.RMETA);
int explicitMetadataCount;
try (PipesForkParser parser = new PipesForkParser(explicitConfig);
@@ -344,8 +336,7 @@ public class PipesForkParserTest {
PipesForkParserConfig textConfig = new PipesForkParserConfig()
.setPluginsDir(PLUGINS_DIR)
.setHandlerType(BasicContentHandlerFactory.HANDLER_TYPE.TEXT)
- .setParseMode(ParseMode.RMETA)
- .setTimeoutMillis(60000);
+ .setParseMode(ParseMode.RMETA);
String textContent;
try (PipesForkParser parser = new PipesForkParser(textConfig);
@@ -364,8 +355,7 @@ public class PipesForkParserTest {
PipesForkParserConfig xmlConfig = new PipesForkParserConfig()
.setPluginsDir(PLUGINS_DIR)
.setHandlerType(BasicContentHandlerFactory.HANDLER_TYPE.XML)
- .setParseMode(ParseMode.RMETA)
- .setTimeoutMillis(60000);
+ .setParseMode(ParseMode.RMETA);
String xmlContent;
try (PipesForkParser parser = new PipesForkParser(xmlConfig);
@@ -399,8 +389,7 @@ public class PipesForkParserTest {
.setPluginsDir(PLUGINS_DIR)
.setHandlerType(BasicContentHandlerFactory.HANDLER_TYPE.TEXT)
.setParseMode(ParseMode.RMETA)
- .setWriteLimit(100) // Limit to 100 characters
- .setTimeoutMillis(60000);
+ .setWriteLimit(100); // Limit to 100 characters
try (PipesForkParser parser = new PipesForkParser(config);
TikaInputStream tis = TikaInputStream.get(testFile)) {
@@ -448,8 +437,7 @@ public class PipesForkParserTest {
Files.writeString(realFile, "This file exists");
PipesForkParserConfig config = new PipesForkParserConfig()
- .setPluginsDir(PLUGINS_DIR)
- .setTimeoutMillis(60000);
+ .setPluginsDir(PLUGINS_DIR);
try (PipesForkParser parser = new PipesForkParser(config)) {
// First attempt - TikaInputStream.get() will throw for non-existent file
@@ -474,8 +462,7 @@ public class PipesForkParserTest {
Files.writeString(testFile, "Simple content");
PipesForkParserConfig config = new PipesForkParserConfig()
- .setPluginsDir(PLUGINS_DIR)
- .setTimeoutMillis(60000);
+ .setPluginsDir(PLUGINS_DIR);
try (PipesForkParser parser = new PipesForkParser(config);
TikaInputStream tis = TikaInputStream.get(testFile)) {
@@ -500,8 +487,7 @@ public class PipesForkParserTest {
Files.writeString(testFile, "Test categorization");
PipesForkParserConfig config = new PipesForkParserConfig()
- .setPluginsDir(PLUGINS_DIR)
- .setTimeoutMillis(60000);
+ .setPluginsDir(PLUGINS_DIR);
try (PipesForkParser parser = new PipesForkParser(config);
TikaInputStream tis = TikaInputStream.get(testFile)) {
@@ -533,8 +519,7 @@ public class PipesForkParserTest {
PipesForkParserConfig config = new PipesForkParserConfig()
.setPluginsDir(PLUGINS_DIR)
.setHandlerType(BasicContentHandlerFactory.HANDLER_TYPE.TEXT)
- .setParseMode(ParseMode.RMETA)
- .setTimeoutMillis(60000);
+ .setParseMode(ParseMode.RMETA);
try (PipesForkParser parser = new PipesForkParser(config)) {
// Use parse(Path) directly without wrapping in TikaInputStream
@@ -564,8 +549,7 @@ public class PipesForkParserTest {
PipesForkParserConfig config = new PipesForkParserConfig()
.setPluginsDir(PLUGINS_DIR)
.setHandlerType(BasicContentHandlerFactory.HANDLER_TYPE.TEXT)
- .setParseMode(ParseMode.RMETA)
- .setTimeoutMillis(60000);
+ .setParseMode(ParseMode.RMETA);
try (PipesForkParser parser = new PipesForkParser(config)) {
Metadata initialMetadata = new Metadata();
@@ -591,8 +575,7 @@ public class PipesForkParserTest {
PipesForkParserConfig config = new PipesForkParserConfig()
.setPluginsDir(PLUGINS_DIR)
.setHandlerType(BasicContentHandlerFactory.HANDLER_TYPE.TEXT)
- .setParseMode(ParseMode.RMETA)
- .setTimeoutMillis(60000);
+ .setParseMode(ParseMode.RMETA);
try (PipesForkParser parser = new PipesForkParser(config)) {
// Parse both files using Path directly
@@ -615,8 +598,7 @@ public class PipesForkParserTest {
PipesForkParserConfig config = new PipesForkParserConfig()
.setPluginsDir(PLUGINS_DIR)
.setHandlerType(BasicContentHandlerFactory.HANDLER_TYPE.TEXT)
- .setParseMode(ParseMode.RMETA)
- .setTimeoutMillis(60000);
+ .setParseMode(ParseMode.RMETA);
// Parse with Path
String pathContent;
diff --git a/tika-pipes/tika-pipes-integration-tests/src/test/java/org/apache/tika/pipes/core/PipesClientTest.java b/tika-pipes/tika-pipes-integration-tests/src/test/java/org/apache/tika/pipes/core/PipesClientTest.java
index a84edf5275..c603bd12e5 100644
--- a/tika-pipes/tika-pipes-integration-tests/src/test/java/org/apache/tika/pipes/core/PipesClientTest.java
+++ b/tika-pipes/tika-pipes-integration-tests/src/test/java/org/apache/tika/pipes/core/PipesClientTest.java
@@ -30,7 +30,7 @@ import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
-import org.apache.tika.config.TikaTaskTimeout;
+import org.apache.tika.config.TimeoutLimits;
import org.apache.tika.config.loader.TikaJsonConfig;
import org.apache.tika.metadata.Metadata;
import org.apache.tika.metadata.TikaCoreProperties;
@@ -181,7 +181,7 @@ public class PipesClientTest {
//TODO -- figure out how to test pipes server timeout alone
//I did both manually during development, but unit tests are better. :D
ParseContext parseContext = new ParseContext();
- parseContext.set(TikaTaskTimeout.class, new TikaTaskTimeout(1000));
+ parseContext.set(TimeoutLimits.class, new TimeoutLimits(1000, 1000));
// Use JSON config approach for Jackson serialization compatibility
// Don't resolve here - let PipesServer resolve on its side
parseContext.setJsonConfig("metadata-filters", """
@@ -198,7 +198,7 @@ public class PipesClientTest {
@Test
public void testRuntimeTimeoutChange(@TempDir Path tmp) throws Exception {
- // Test that TikaTaskTimeout can be changed at runtime via ParseContext
+ // Test that TimeoutLimits can be changed at runtime via ParseContext
// Use a mock file with 3 second delay
Path inputDir = tmp.resolve("input");
Files.createDirectories(inputDir);
@@ -217,7 +217,7 @@ public class PipesClientTest {
try (PipesClient pipesClient = new PipesClient(pipesConfig, tikaConfigPath)) {
// First test: Short timeout (1 second) - should timeout
ParseContext shortTimeoutContext = new ParseContext();
- shortTimeoutContext.set(TikaTaskTimeout.class, new TikaTaskTimeout(1000));
+ shortTimeoutContext.set(TimeoutLimits.class, new TimeoutLimits(1000, 1000));
PipesResult timeoutResult = pipesClient.process(
new FetchEmitTuple(testFile, new FetchKey(fetcherName, testFile),
@@ -229,7 +229,7 @@ public class PipesClientTest {
// Second test: Long timeout (10 seconds) - should succeed
ParseContext longTimeoutContext = new ParseContext();
- longTimeoutContext.set(TikaTaskTimeout.class, new TikaTaskTimeout(10000));
+ longTimeoutContext.set(TimeoutLimits.class, new TimeoutLimits(10000, 10000));
PipesResult successResult = pipesClient.process(
new FetchEmitTuple(testFile, new FetchKey(fetcherName, testFile),
diff --git a/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-bad-class.json b/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-bad-class.json
index 07101e7df4..4eca108614 100644
--- a/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-bad-class.json
+++ b/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-bad-class.json
@@ -8,7 +8,6 @@
},
"pipes": {
"numClients": 1,
- "timeoutMillis": 5000,
"forkedJvmArgs": [
"-Xmx256m"
],
@@ -17,5 +16,10 @@
"thresholdBytes": 1000000
}
},
+ "parse-context": {
+ "timeout-limits": {
+ "progressTimeoutMillis": 5000
+ }
+ },
"plugin-roots": "PLUGINS_PATHS"
}
diff --git a/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-bad-java-path.json b/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-bad-java-path.json
index d4228852fc..cea0813a50 100644
--- a/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-bad-java-path.json
+++ b/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-bad-java-path.json
@@ -8,7 +8,6 @@
},
"pipes": {
"numClients": 1,
- "timeoutMillis": 5000,
"javaPath": "thisIsntJava",
"forkedJvmArgs": [
"-Xmx256m"
@@ -18,5 +17,10 @@
"thresholdBytes": 1000000
}
},
+ "parse-context": {
+ "timeout-limits": {
+ "progressTimeoutMillis": 5000
+ }
+ },
"plugin-roots": "PLUGINS_PATHS"
}
diff --git a/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-bad-jvm-args.json b/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-bad-jvm-args.json
index b1ae58bcce..be1a3a0807 100644
--- a/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-bad-jvm-args.json
+++ b/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-bad-jvm-args.json
@@ -8,7 +8,6 @@
},
"pipes": {
"numClients": 1,
- "timeoutMillis": 5000,
"forkedJvmArgs": [
"-Xmx256m",
"-ThisIsntAThing"
@@ -18,5 +17,10 @@
"thresholdBytes": 1000000
}
},
+ "parse-context": {
+ "timeout-limits": {
+ "progressTimeoutMillis": 5000
+ }
+ },
"plugin-roots": "PLUGINS_PATHS"
}
diff --git a/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-basic.json b/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-basic.json
index 0a8d40b1fa..4696e1d0f6 100644
--- a/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-basic.json
+++ b/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-basic.json
@@ -35,7 +35,6 @@
"parseMode": "RMETA",
"onParseException": "EMIT",
"numClients": 4,
- "timeoutMillis": 5000,
"emitIntermediateResults": "EMIT_INTERMEDIATE_RESULTS",
"forkedJvmArgs": ["-Xmx512m"],
"emitStrategy": {
@@ -47,7 +46,10 @@
"throwOnZeroBytes": false
},
"parse-context": {
- "mock-digester-factory": {}
- },
+ "mock-digester-factory": {},
+ "timeout-limits": {
+ "progressTimeoutMillis": 5000
+ }
+ },
"plugin-roots": "PLUGINS_PATHS"
}
diff --git a/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-crashing-detector.json b/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-crashing-detector.json
index 80d5cce6da..0fbf912a1d 100644
--- a/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-crashing-detector.json
+++ b/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-crashing-detector.json
@@ -18,7 +18,6 @@
},
"pipes": {
"numClients": 1,
- "timeoutMillis": 5000,
"forkedJvmArgs": [
"-Xmx256m"
],
@@ -27,6 +26,11 @@
"thresholdBytes": 1000000
}
},
+ "parse-context": {
+ "timeout-limits": {
+ "progressTimeoutMillis": 5000
+ }
+ },
"detectors": [
{
"org.apache.tika.pipes.core.CrashingDetector": {}
diff --git a/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-emit-all.json b/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-emit-all.json
index 534ae36bac..b527f1ef1d 100644
--- a/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-emit-all.json
+++ b/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-emit-all.json
@@ -18,7 +18,6 @@
},
"pipes": {
"numClients": 1,
- "timeoutMillis": 60000,
"forkedJvmArgs": [
"-Xmx256m"
],
@@ -26,5 +25,10 @@
"type": "EMIT_ALL"
}
},
+ "parse-context": {
+ "timeout-limits": {
+ "progressTimeoutMillis": 60000
+ }
+ },
"plugin-roots": "PLUGINS_PATHS"
}
diff --git a/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-passback.json b/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-passback.json
index 3cbbab6950..3857d65e30 100644
--- a/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-passback.json
+++ b/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-passback.json
@@ -35,7 +35,6 @@
"parseMode": "RMETA",
"onParseException": "EMIT",
"numClients": 4,
- "timeoutMillis": 5000,
"emitIntermediateResults": "EMIT_INTERMEDIATE_RESULTS",
"forkedJvmArgs": ["-Xmx512m"],
"emitStrategy": {
@@ -46,7 +45,10 @@
"throwOnZeroBytes": false
},
"parse-context": {
- "mock-digester-factory": {}
- },
+ "mock-digester-factory": {},
+ "timeout-limits": {
+ "progressTimeoutMillis": 5000
+ }
+ },
"plugin-roots": "PLUGINS_PATHS"
}
diff --git a/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-shared-server.json b/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-shared-server.json
index 48e3edef5f..efe62a5be9 100644
--- a/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-shared-server.json
+++ b/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-shared-server.json
@@ -35,7 +35,6 @@
"parseMode": "RMETA",
"onParseException": "EMIT",
"numClients": 4,
- "timeoutMillis": 5000,
"useSharedServer": true,
"emitIntermediateResults": "EMIT_INTERMEDIATE_RESULTS",
"forkedJvmArgs": ["-Xmx512m"],
@@ -48,7 +47,10 @@
"throwOnZeroBytes": false
},
"parse-context": {
- "mock-digester-factory": {}
- },
+ "mock-digester-factory": {},
+ "timeout-limits": {
+ "progressTimeoutMillis": 5000
+ }
+ },
"plugin-roots": "PLUGINS_PATHS"
}
diff --git a/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-timeout-lt-heartbeat.json b/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-timeout-lt-heartbeat.json
index 1efc061291..3133771d70 100644
--- a/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-timeout-lt-heartbeat.json
+++ b/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-timeout-lt-heartbeat.json
@@ -18,7 +18,6 @@
},
"pipes": {
"numClients": 1,
- "timeoutMillis": 60000,
"socketTimeoutMs": 3000,
"heartbeatIntervalMs": 10000,
"forkedJvmArgs": [
@@ -26,5 +25,10 @@
"-Dtika.pipes.allowInvalidHeartbeat=true"
]
},
+ "parse-context": {
+ "timeout-limits": {
+ "progressTimeoutMillis": 60000
+ }
+ },
"plugin-roots": "PLUGINS_PATHS"
}
diff --git a/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-truncate.json b/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-truncate.json
index b6303b0cfc..9bc7efa5e8 100644
--- a/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-truncate.json
+++ b/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-truncate.json
@@ -35,7 +35,6 @@
"parseMode": "RMETA",
"onParseException": "EMIT",
"numClients": 4,
- "timeoutMillis": 5000,
"emitIntermediateResults": "EMIT_INTERMEDIATE_RESULTS",
"forkedJvmArgs": ["-Xmx512m"],
"emitStrategy": {
@@ -53,6 +52,9 @@
},
"runpack-extractor-factory": {
"maxEmbeddedBytesForExtraction": 10
+ },
+ "timeout-limits": {
+ "progressTimeoutMillis": 5000
}
},
"plugin-roots": "PLUGINS_PATHS"
diff --git a/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-uppercasing.json b/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-uppercasing.json
index 2dd4c0c31b..7732becfc8 100644
--- a/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-uppercasing.json
+++ b/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-uppercasing.json
@@ -31,7 +31,6 @@
"parseMode": "RMETA",
"onParseException": "EMIT",
"numClients": 4,
- "timeoutMillis": 5000,
"emitIntermediateResults": "EMIT_INTERMEDIATE_RESULTS",
"forkedJvmArgs": ["-Xmx512m"],
"emitStrategy": {
@@ -43,7 +42,10 @@
"throwOnZeroBytes": false
},
"parse-context": {
- "mock-digester-factory": {}
- },
+ "mock-digester-factory": {},
+ "timeout-limits": {
+ "progressTimeoutMillis": 5000
+ }
+ },
"plugin-roots": "PLUGINS_PATHS"
}
diff --git a/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-write-limiter.json b/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-write-limiter.json
index dbfbcd4f31..8fecf2a11f 100644
--- a/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-write-limiter.json
+++ b/tika-pipes/tika-pipes-integration-tests/src/test/resources/configs/tika-config-write-limiter.json
@@ -35,7 +35,6 @@
"parseMode": "RMETA",
"onParseException": "EMIT",
"numClients": 1,
- "timeoutMillis": 5000,
"emitIntermediateResults": false,
"forkedJvmArgs": ["-Xmx512m"],
"emitStrategy": {
@@ -53,6 +52,9 @@
"maxFieldSize": 1000,
"maxTotalBytes": 10000,
"maxValuesPerField": 5
+ },
+ "timeout-limits": {
+ "progressTimeoutMillis": 5000
}
},
"plugin-roots": "PLUGINS_PATHS"
diff --git a/tika-serialization/src/main/java/org/apache/tika/serialization/ParseContextUtils.java b/tika-serialization/src/main/java/org/apache/tika/serialization/ParseContextUtils.java
index c95b9fe275..626b69dfe7 100644
--- a/tika-serialization/src/main/java/org/apache/tika/serialization/ParseContextUtils.java
+++ b/tika-serialization/src/main/java/org/apache/tika/serialization/ParseContextUtils.java
@@ -41,8 +41,8 @@ import org.apache.tika.parser.ParseContext;
* Uses friendly-name format for configuration:
* <pre>
* "parse-context": {
- * "tika-task-timeout": {
- * "timeoutMillis": 30000
+ * "timeout-limits": {
+ * "progressTimeoutMillis": 60000
* },
* "pdf-parser": {
* "extractInlineImages": true
diff --git a/tika-serialization/src/test/java/org/apache/tika/config/AllLimitsTest.java b/tika-serialization/src/test/java/org/apache/tika/config/AllLimitsTest.java
index b509d03bab..54739df876 100644
--- a/tika-serialization/src/test/java/org/apache/tika/config/AllLimitsTest.java
+++ b/tika-serialization/src/test/java/org/apache/tika/config/AllLimitsTest.java
@@ -53,7 +53,8 @@ import org.apache.tika.parser.ParseContext;
* "zipBombRatio": 100
* },
* "timeout-limits": {
- * "taskTimeoutMillis": 60000
+ * "totalTaskTimeoutMillis": 3600000,
+ * "progressTimeoutMillis": 60000
* },
* "standard-metadata-limiter-factory": {
* "maxTotalBytes": 1048576,
@@ -95,7 +96,7 @@ public class AllLimitsTest extends TikaTest {
// Verify TimeoutLimits
TimeoutLimits timeoutLimits = context.get(TimeoutLimits.class);
assertNotNull(timeoutLimits, "TimeoutLimits should be loaded");
- assertEquals(60000, timeoutLimits.getTaskTimeoutMillis());
+ assertEquals(60000, timeoutLimits.getProgressTimeoutMillis());
// Verify MetadataWriteLimiterFactory
MetadataWriteLimiterFactory metadataFactory = context.get(MetadataWriteLimiterFactory.class);
@@ -118,7 +119,7 @@ public class AllLimitsTest extends TikaTest {
TimeoutLimits timeoutLimits = context.get(TimeoutLimits.class);
assertNotNull(timeoutLimits);
- assertEquals(60000, timeoutLimits.getTaskTimeoutMillis());
+ assertEquals(60000, timeoutLimits.getProgressTimeoutMillis());
}
@Test
@@ -134,7 +135,7 @@ public class AllLimitsTest extends TikaTest {
assertEquals(100000, outputLimits.getWriteLimit());
TimeoutLimits timeoutLimits = TimeoutLimits.get(context);
- assertEquals(60000, timeoutLimits.getTaskTimeoutMillis());
+ assertEquals(60000, timeoutLimits.getProgressTimeoutMillis());
}
@Test
@@ -150,6 +151,6 @@ public class AllLimitsTest extends TikaTest {
TimeoutLimits timeoutLimits = TimeoutLimits.get(null);
assertNotNull(timeoutLimits);
- assertEquals(TimeoutLimits.DEFAULT_TASK_TIMEOUT_MILLIS, timeoutLimits.getTaskTimeoutMillis());
+ assertEquals(TimeoutLimits.DEFAULT_PROGRESS_TIMEOUT_MILLIS, timeoutLimits.getProgressTimeoutMillis());
}
}
diff --git a/tika-serialization/src/test/java/org/apache/tika/config/TimeoutLimitsTest.java b/tika-serialization/src/test/java/org/apache/tika/config/TimeoutLimitsTest.java
index 4217349134..d82f040fad 100644
--- a/tika-serialization/src/test/java/org/apache/tika/config/TimeoutLimitsTest.java
+++ b/tika-serialization/src/test/java/org/apache/tika/config/TimeoutLimitsTest.java
@@ -36,7 +36,8 @@ public class TimeoutLimitsTest extends TikaTest {
TimeoutLimits limits = context.get(TimeoutLimits.class);
assertNotNull(limits);
- assertEquals(120000, limits.getTaskTimeoutMillis());
+ assertEquals(120000, limits.getProgressTimeoutMillis());
+ assertEquals(7200000, limits.getTotalTaskTimeoutMillis());
}
@Test
@@ -46,14 +47,17 @@ public class TimeoutLimitsTest extends TikaTest {
TimeoutLimits limits = context.get(TimeoutLimits.class);
assertNotNull(limits);
- assertEquals(120000, limits.getTaskTimeoutMillis());
+ assertEquals(120000, limits.getProgressTimeoutMillis());
+ assertEquals(7200000, limits.getTotalTaskTimeoutMillis());
}
@Test
public void testDefaults() {
TimeoutLimits limits = new TimeoutLimits();
- assertEquals(TimeoutLimits.DEFAULT_TASK_TIMEOUT_MILLIS, limits.getTaskTimeoutMillis());
- assertEquals(60000, limits.getTaskTimeoutMillis());
+ assertEquals(TimeoutLimits.DEFAULT_PROGRESS_TIMEOUT_MILLIS, limits.getProgressTimeoutMillis());
+ assertEquals(60000, limits.getProgressTimeoutMillis());
+ assertEquals(TimeoutLimits.DEFAULT_TOTAL_TASK_TIMEOUT_MILLIS, limits.getTotalTaskTimeoutMillis());
+ assertEquals(3600000, limits.getTotalTaskTimeoutMillis());
}
@Test
@@ -61,36 +65,61 @@ public class TimeoutLimitsTest extends TikaTest {
// Test with null context
TimeoutLimits limits = TimeoutLimits.get(null);
assertNotNull(limits);
- assertEquals(TimeoutLimits.DEFAULT_TASK_TIMEOUT_MILLIS, limits.getTaskTimeoutMillis());
+ assertEquals(TimeoutLimits.DEFAULT_PROGRESS_TIMEOUT_MILLIS, limits.getProgressTimeoutMillis());
+ assertEquals(TimeoutLimits.DEFAULT_TOTAL_TASK_TIMEOUT_MILLIS, limits.getTotalTaskTimeoutMillis());
// Test with context that doesn't have TimeoutLimits
ParseContext context = new ParseContext();
limits = TimeoutLimits.get(context);
assertNotNull(limits);
- assertEquals(TimeoutLimits.DEFAULT_TASK_TIMEOUT_MILLIS, limits.getTaskTimeoutMillis());
+ assertEquals(TimeoutLimits.DEFAULT_PROGRESS_TIMEOUT_MILLIS, limits.getProgressTimeoutMillis());
// Test with context that has TimeoutLimits
- TimeoutLimits customLimits = new TimeoutLimits(300000);
+ TimeoutLimits customLimits = new TimeoutLimits(7200000, 300000);
context.set(TimeoutLimits.class, customLimits);
limits = TimeoutLimits.get(context);
- assertEquals(300000, limits.getTaskTimeoutMillis());
+ assertEquals(300000, limits.getProgressTimeoutMillis());
+ assertEquals(7200000, limits.getTotalTaskTimeoutMillis());
+ }
+
+ @Test
+ public void testGetProcessTimeoutMillis() {
+ // Test with null context
+ assertEquals(5000, TimeoutLimits.getProcessTimeoutMillis(null, 5000));
+
+ // Test with context that doesn't have TimeoutLimits
+ ParseContext context = new ParseContext();
+ assertEquals(5000, TimeoutLimits.getProcessTimeoutMillis(context, 5000));
+
+ // Test with context that has TimeoutLimits
+ TimeoutLimits limits = new TimeoutLimits(3600000, 60000);
+ context.set(TimeoutLimits.class, limits);
+ assertEquals(59900, TimeoutLimits.getProcessTimeoutMillis(context, 5000));
+
+ // Test with very small progress timeout
+ TimeoutLimits smallLimits = new TimeoutLimits(3600000, 50);
+ context.set(TimeoutLimits.class, smallLimits);
+ assertEquals(0, TimeoutLimits.getProcessTimeoutMillis(context, 5000));
}
@Test
public void testEqualsAndHashCode() {
- TimeoutLimits limits1 = new TimeoutLimits(120000);
- TimeoutLimits limits2 = new TimeoutLimits(120000);
- TimeoutLimits limits3 = new TimeoutLimits(300000);
+ TimeoutLimits limits1 = new TimeoutLimits(3600000, 120000);
+ TimeoutLimits limits2 = new TimeoutLimits(3600000, 120000);
+ TimeoutLimits limits3 = new TimeoutLimits(7200000, 120000);
+ TimeoutLimits limits4 = new TimeoutLimits(3600000, 300000);
assertEquals(limits1, limits2);
assertEquals(limits1.hashCode(), limits2.hashCode());
assertFalse(limits1.equals(limits3));
+ assertFalse(limits1.equals(limits4));
}
@Test
public void testToString() {
- TimeoutLimits limits = new TimeoutLimits(120000);
+ TimeoutLimits limits = new TimeoutLimits(3600000, 120000);
String str = limits.toString();
- assertTrue(str.contains("taskTimeoutMillis=120000"));
+ assertTrue(str.contains("totalTaskTimeoutMillis=3600000"));
+ assertTrue(str.contains("progressTimeoutMillis=120000"));
}
}
diff --git a/tika-serialization/src/test/java/org/apache/tika/config/loader/ConfigLoaderTest.java b/tika-serialization/src/test/java/org/apache/tika/config/loader/ConfigLoaderTest.java
index 5efa4136ac..2f9de840a9 100644
--- a/tika-serialization/src/test/java/org/apache/tika/config/loader/ConfigLoaderTest.java
+++ b/tika-serialization/src/test/java/org/apache/tika/config/loader/ConfigLoaderTest.java
@@ -90,7 +90,7 @@ public class ConfigLoaderTest {
/**
* Config class with suffix that should be stripped.
*/
- public static class TikaTaskTimeout {
+ public static class TestTimeoutConfig {
private long millis;
public long getMillis() {
@@ -206,10 +206,10 @@ public class ConfigLoaderTest {
}
@Test
- public void testLoadByClassNameTikaTaskTimeout() throws Exception {
- // TikaTaskTimeout -> "tika-task-timeout" (no suffix stripping)
- // JSON has "tika-task-timeout"
- TikaTaskTimeout timeout = configLoader.load(TikaTaskTimeout.class);
+ public void testLoadByClassNameTestTimeoutConfig() throws Exception {
+ // TestTimeoutConfig -> "test-timeout-config" (kebab-case)
+ // JSON has "test-timeout-config"
+ TestTimeoutConfig timeout = configLoader.load(TestTimeoutConfig.class);
assertNotNull(timeout);
assertEquals(30000, timeout.getMillis());
@@ -396,12 +396,12 @@ public class ConfigLoaderTest {
assertNotNull(config);
// Non-existent class
- TikaTaskTimeout defaultTimeout = new TikaTaskTimeout();
+ TestTimeoutConfig defaultTimeout = new TestTimeoutConfig();
defaultTimeout.setMillis(60000);
// Use a class name that won't match
- TikaTaskTimeout result = configLoader.load("NonExistentConfig.class",
- TikaTaskTimeout.class,
+ TestTimeoutConfig result = configLoader.load("NonExistentConfig.class",
+ TestTimeoutConfig.class,
defaultTimeout);
assertEquals(60000, result.getMillis());
}
@@ -606,12 +606,12 @@ public class ConfigLoaderTest {
TikaJsonConfig config = TikaJsonConfig.load(configPath);
ConfigLoader loader = new ConfigLoader(config, TikaObjectMapperFactory.getMapper());
- TikaTaskTimeout defaults = new TikaTaskTimeout();
+ TestTimeoutConfig defaults = new TestTimeoutConfig();
defaults.setMillis(60000);
- // Note: tika-task-timeout in JSON has millis: 30000
- TikaTaskTimeout result = loader.loadWithDefaults("tika-task-timeout",
- TikaTaskTimeout.class,
+ // Note: test-timeout-config in JSON has millis: 30000
+ TestTimeoutConfig result = loader.loadWithDefaults("test-timeout-config",
+ TestTimeoutConfig.class,
defaults);
// Result should have JSON value
diff --git a/tika-serialization/src/test/java/org/apache/tika/serialization/RoundTripSerializationTest.java b/tika-serialization/src/test/java/org/apache/tika/serialization/RoundTripSerializationTest.java
index e1432e9677..5482131289 100644
--- a/tika-serialization/src/test/java/org/apache/tika/serialization/RoundTripSerializationTest.java
+++ b/tika-serialization/src/test/java/org/apache/tika/serialization/RoundTripSerializationTest.java
@@ -27,7 +27,7 @@ import com.fasterxml.jackson.databind.module.SimpleModule;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
-import org.apache.tika.config.TikaTaskTimeout;
+import org.apache.tika.config.TimeoutLimits;
import org.apache.tika.config.loader.TikaObjectMapperFactory;
import org.apache.tika.parser.ParseContext;
import org.apache.tika.serialization.serdes.ParseContextDeserializer;
@@ -82,7 +82,8 @@ public class RoundTripSerializationTest {
ParseContext original = new ParseContext();
original.setJsonConfig("pdf-parser", "{\"ocrStrategy\":\"AUTO\"}");
original.setJsonConfig("html-parser", "{\"extractScripts\":false}");
- original.setJsonConfig("tika-task-timeout", "{\"timeoutMillis\":30000}");
+ original.setJsonConfig("timeout-limits",
+ "{\"progressTimeoutMillis\":30000,\"totalTaskTimeoutMillis\":120000}");
String json = mapper.writeValueAsString(original);
ParseContext reloaded = mapper.readValue(json, ParseContext.class);
@@ -90,7 +91,7 @@ public class RoundTripSerializationTest {
assertEquals(3, reloaded.getJsonConfigs().size());
assertTrue(reloaded.hasJsonConfig("pdf-parser"));
assertTrue(reloaded.hasJsonConfig("html-parser"));
- assertTrue(reloaded.hasJsonConfig("tika-task-timeout"));
+ assertTrue(reloaded.hasJsonConfig("timeout-limits"));
}
@Test
@@ -116,7 +117,8 @@ public class RoundTripSerializationTest {
void testMultipleRoundTripsStability() throws Exception {
ParseContext context = new ParseContext();
context.setJsonConfig("pdf-parser", "{\"ocrStrategy\":\"NO_OCR\"}");
- context.setJsonConfig("tika-task-timeout", "{\"timeoutMillis\":45000}");
+ context.setJsonConfig("timeout-limits",
+ "{\"progressTimeoutMillis\":45000,\"totalTaskTimeoutMillis\":180000}");
// Perform 5 round-trips
for (int i = 0; i < 5; i++) {
@@ -127,43 +129,47 @@ public class RoundTripSerializationTest {
// Verify values preserved after multiple round-trips
assertEquals(2, context.getJsonConfigs().size());
assertTrue(context.getJsonConfig("pdf-parser").json().contains("NO_OCR"));
- assertTrue(context.getJsonConfig("tika-task-timeout").json().contains("45000"));
+ assertTrue(context.getJsonConfig("timeout-limits").json().contains("45000"));
}
- // ==================== TikaTaskTimeout Round-Trip ====================
+ // ==================== TimeoutLimits Round-Trip ====================
@Test
- void testTikaTaskTimeoutRoundTrip() throws Exception {
+ void testTimeoutLimitsRoundTrip() throws Exception {
ParseContext original = new ParseContext();
- original.setJsonConfig("tika-task-timeout", "{\"timeoutMillis\":60000}");
+ original.setJsonConfig("timeout-limits",
+ "{\"progressTimeoutMillis\":60000,\"totalTaskTimeoutMillis\":3600000}");
String json = mapper.writeValueAsString(original);
ParseContext reloaded = mapper.readValue(json, ParseContext.class);
// Resolve and verify
ParseContextUtils.resolveAll(reloaded, Thread.currentThread().getContextClassLoader());
- TikaTaskTimeout timeout = reloaded.get(TikaTaskTimeout.class);
+ TimeoutLimits limits = reloaded.get(TimeoutLimits.class);
- assertNotNull(timeout);
- assertEquals(60000, timeout.getTimeoutMillis());
+ assertNotNull(limits);
+ assertEquals(60000, limits.getProgressTimeoutMillis());
+ assertEquals(3600000, limits.getTotalTaskTimeoutMillis());
}
@Test
- void testTikaTaskTimeoutDifferentValues() throws Exception {
+ void testTimeoutLimitsDifferentValues() throws Exception {
long[] testValues = {1000, 5000, 30000, 120000, 600000};
for (long value : testValues) {
ParseContext original = new ParseContext();
- original.setJsonConfig("tika-task-timeout", "{\"timeoutMillis\":" + value + "}");
+ original.setJsonConfig("timeout-limits",
+ "{\"progressTimeoutMillis\":" + value +
+ ",\"totalTaskTimeoutMillis\":" + (value * 10) + "}");
String json = mapper.writeValueAsString(original);
ParseContext reloaded = mapper.readValue(json, ParseContext.class);
ParseContextUtils.resolveAll(reloaded, Thread.currentThread().getContextClassLoader());
- TikaTaskTimeout timeout = reloaded.get(TikaTaskTimeout.class);
+ TimeoutLimits limits = reloaded.get(TimeoutLimits.class);
- assertEquals(value, timeout.getTimeoutMillis(),
- "Timeout " + value + " should survive round-trip");
+ assertEquals(value, limits.getProgressTimeoutMillis(),
+ "progressTimeoutMillis " + value + " should survive round-trip");
}
}
diff --git a/tika-serialization/src/test/java/org/apache/tika/serialization/TestParseContextSerialization.java b/tika-serialization/src/test/java/org/apache/tika/serialization/TestParseContextSerialization.java
index 960f1a2e7a..e4dcd731e3 100644
--- a/tika-serialization/src/test/java/org/apache/tika/serialization/TestParseContextSerialization.java
+++ b/tika-serialization/src/test/java/org/apache/tika/serialization/TestParseContextSerialization.java
@@ -31,7 +31,7 @@ import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.module.SimpleModule;
import org.junit.jupiter.api.Test;
-import org.apache.tika.config.TikaTaskTimeout;
+import org.apache.tika.config.TimeoutLimits;
import org.apache.tika.config.loader.TikaObjectMapperFactory;
import org.apache.tika.extractor.DocumentSelector;
import org.apache.tika.extractor.SkipEmbeddedDocumentSelector;
@@ -129,31 +129,37 @@ public class TestParseContextSerialization {
}
@Test
- public void testTikaTaskTimeoutFormat() throws Exception {
- // Test serializing tika-task-timeout configuration
+ public void testTimeoutLimitsFormat() throws Exception {
+ // Test serializing timeout-limits configuration
ParseContext pc = new ParseContext();
- pc.setJsonConfig("tika-task-timeout", "{\"timeoutMillis\":30000}");
+ pc.setJsonConfig("timeout-limits",
+ "{\"progressTimeoutMillis\":30000,\"totalTaskTimeoutMillis\":120000}");
String json = serializeParseContext(pc);
ObjectMapper mapper = createMapper();
JsonNode root = mapper.readTree(json);
- assertTrue(root.has("tika-task-timeout"), "Should have tika-task-timeout field");
+ assertTrue(root.has("timeout-limits"), "Should have timeout-limits field");
assertEquals(30000, root
- .get("tika-task-timeout")
- .get("timeoutMillis")
+ .get("timeout-limits")
+ .get("progressTimeoutMillis")
+ .asInt());
+ assertEquals(120000, root
+ .get("timeout-limits")
+ .get("totalTaskTimeoutMillis")
.asInt());
// Verify round-trip
ParseContext deserialized = mapper.readValue(json, ParseContext.class);
- assertTrue(deserialized.hasJsonConfig("tika-task-timeout"));
+ assertTrue(deserialized.hasJsonConfig("timeout-limits"));
// Resolve and verify
ParseContextUtils.resolveAll(deserialized, Thread.currentThread().getContextClassLoader());
- TikaTaskTimeout timeout = deserialized.get(TikaTaskTimeout.class);
- assertNotNull(timeout, "TikaTaskTimeout should be resolved");
- assertEquals(30000, timeout.getTimeoutMillis());
+ TimeoutLimits limits = deserialized.get(TimeoutLimits.class);
+ assertNotNull(limits, "TimeoutLimits should be resolved");
+ assertEquals(30000, limits.getProgressTimeoutMillis());
+ assertEquals(120000, limits.getTotalTaskTimeoutMillis());
}
@Test
@@ -228,7 +234,8 @@ public class TestParseContextSerialization {
pc.setJsonConfig("pdf-parser", "{\"ocrStrategy\":\"AUTO\"}");
pc.setJsonConfig("html-parser", "{\"extractScripts\":true}");
- pc.setJsonConfig("tika-task-timeout", "{\"timeoutMillis\":5000}");
+ pc.setJsonConfig("timeout-limits",
+ "{\"progressTimeoutMillis\":5000,\"totalTaskTimeoutMillis\":60000}");
pc.setJsonConfig("my-custom-config", "{\"enabled\":true,\"maxRetries\":3}");
String json = serializeParseContext(pc);
@@ -240,7 +247,7 @@ public class TestParseContextSerialization {
assertEquals(4, root.size(), "Should have 4 config fields");
assertTrue(root.has("pdf-parser"));
assertTrue(root.has("html-parser"));
- assertTrue(root.has("tika-task-timeout"));
+ assertTrue(root.has("timeout-limits"));
assertTrue(root.has("my-custom-config"));
// Verify round-trip
diff --git a/tika-serialization/src/test/resources/configs/all-limits-test.json b/tika-serialization/src/test/resources/configs/all-limits-test.json
index daaf6be58f..b82c0f747a 100644
--- a/tika-serialization/src/test/resources/configs/all-limits-test.json
+++ b/tika-serialization/src/test/resources/configs/all-limits-test.json
@@ -18,7 +18,8 @@
"zipBombRatio": 100
},
"timeout-limits": {
- "taskTimeoutMillis": 60000
+ "totalTaskTimeoutMillis": 3600000,
+ "progressTimeoutMillis": 60000
},
"standard-metadata-limiter-factory": {
"maxTotalBytes": 1048576,
diff --git a/tika-serialization/src/test/resources/configs/test-config-loader.json b/tika-serialization/src/test/resources/configs/test-config-loader.json
index 2dc8eb30a8..a03d681ff2 100644
--- a/tika-serialization/src/test/resources/configs/test-config-loader.json
+++ b/tika-serialization/src/test/resources/configs/test-config-loader.json
@@ -17,7 +17,7 @@
"prefix": "test-"
},
- "tika-task-timeout": {
+ "test-timeout-config": {
"millis": 30000
},
diff --git a/tika-serialization/src/test/resources/configs/test-partial-config.json b/tika-serialization/src/test/resources/configs/test-partial-config.json
index 50b8144867..377f2513ea 100644
--- a/tika-serialization/src/test/resources/configs/test-partial-config.json
+++ b/tika-serialization/src/test/resources/configs/test-partial-config.json
@@ -10,7 +10,7 @@
"enabled": false
},
- "tika-task-timeout": {
+ "test-timeout-config": {
"millis": 30000
}
}
diff --git a/tika-serialization/src/test/resources/configs/timeout-limits-test.json b/tika-serialization/src/test/resources/configs/timeout-limits-test.json
index ac9090e8f2..c5710c9497 100644
--- a/tika-serialization/src/test/resources/configs/timeout-limits-test.json
+++ b/tika-serialization/src/test/resources/configs/timeout-limits-test.json
@@ -1,7 +1,8 @@
{
"parse-context": {
"timeout-limits": {
- "taskTimeoutMillis": 120000
+ "totalTaskTimeoutMillis": 7200000,
+ "progressTimeoutMillis": 120000
}
}
}
diff --git a/tika-server/tika-server-core/src/test/java/org/apache/tika/server/core/TikaServerPipesIntegrationTest.java b/tika-server/tika-server-core/src/test/java/org/apache/tika/server/core/TikaServerPipesIntegrationTest.java
index bcbe5251c7..f4a4520d67 100644
--- a/tika-server/tika-server-core/src/test/java/org/apache/tika/server/core/TikaServerPipesIntegrationTest.java
+++ b/tika-server/tika-server-core/src/test/java/org/apache/tika/server/core/TikaServerPipesIntegrationTest.java
@@ -225,7 +225,7 @@ public class TikaServerPipesIntegrationTest extends IntegrationTestBase {
parseContext.set(ContentHandlerFactory.class,
new BasicContentHandlerFactory(BasicContentHandlerFactory.HANDLER_TYPE.XML, -1));
parseContext.set(ParseMode.class, ParseMode.RMETA);
- parseContext.setJsonConfig("tika-task-timeout", "{\"timeoutMillis\":" + timeoutMillis + "}");
+ parseContext.setJsonConfig("timeout-limits", "{\"progressTimeoutMillis\":" + timeoutMillis + "}");
FetchEmitTuple t = new FetchEmitTuple(fileName,
new FetchKey(CXFTestBase.FETCHER_ID, fileName),
diff --git a/tika-server/tika-server-core/src/test/resources/configs/cxf-test-base-template.json b/tika-server/tika-server-core/src/test/resources/configs/cxf-test-base-template.json
index c360dd70c7..b2c0ef4118 100644
--- a/tika-server/tika-server-core/src/test/resources/configs/cxf-test-base-template.json
+++ b/tika-server/tika-server-core/src/test/resources/configs/cxf-test-base-template.json
@@ -35,7 +35,6 @@
},
"pipes": {
"numClients": 2,
- "timeoutMillis": "TIMEOUT_MILLIS",
"emitIntermediateResults": false,
"forkedJvmArgs": [
"-Xmx512m"
@@ -53,7 +52,10 @@
{ "algorithm": "MD5" },
{ "algorithm": "SHA1", "encoding": "BASE32" }
]
- }
- },
+ },
+ "timeout-limits": {
+ "progressTimeoutMillis": "TIMEOUT_MILLIS"
+ }
+ },
"plugin-roots": "PLUGINS_PATHS"
}
diff --git a/tika-server/tika-server-core/src/test/resources/configs/cxf-unpack-test-template.json b/tika-server/tika-server-core/src/test/resources/configs/cxf-unpack-test-template.json
index f206e15199..29e27e005f 100644
--- a/tika-server/tika-server-core/src/test/resources/configs/cxf-unpack-test-template.json
+++ b/tika-server/tika-server-core/src/test/resources/configs/cxf-unpack-test-template.json
@@ -16,7 +16,6 @@
},
"pipes": {
"numClients": 2,
- "timeoutMillis": "TIMEOUT_MILLIS",
"emitIntermediateResults": false,
"forkedJvmArgs": [
"-Xmx512m"
@@ -32,6 +31,9 @@
{ "algorithm": "MD5" }
]
}
+ },
+ "timeout-limits": {
+ "progressTimeoutMillis": "TIMEOUT_MILLIS"
}
},
"plugin-roots": "PLUGINS_PATHS"
diff --git a/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-basic.json b/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-basic.json
index a4f631197c..a14eda47ae 100644
--- a/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-basic.json
+++ b/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-basic.json
@@ -14,9 +14,13 @@
"tika"
]
},
+ "parse-context": {
+ "timeout-limits": {
+ "progressTimeoutMillis": 120000
+ }
+ },
"pipes": {
"numClients": 2,
- "timeoutMillis": 120000,
"forkedJvmArgs": [
"-Xmx256m"
]
diff --git a/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-emitter.json b/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-emitter.json
index cb4c634466..ce5f4a6f51 100644
--- a/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-emitter.json
+++ b/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-emitter.json
@@ -15,9 +15,13 @@
"status"
]
},
+ "parse-context": {
+ "timeout-limits": {
+ "progressTimeoutMillis": 120000
+ }
+ },
"pipes": {
"numClients": 2,
- "timeoutMillis": 120000,
"forkedJvmArgs": [
"-Xmx256m"
]
diff --git a/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-fetcher-template.json b/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-fetcher-template.json
index 58b1051817..7348181239 100644
--- a/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-fetcher-template.json
+++ b/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-fetcher-template.json
@@ -13,9 +13,13 @@
"tika"
]
},
+ "parse-context": {
+ "timeout-limits": {
+ "progressTimeoutMillis": 120000
+ }
+ },
"pipes": {
"numClients": 2,
- "timeoutMillis": 120000,
"forkedJvmArgs": [
"-Xmx256m"
]
diff --git a/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-fetchers-emitters.json b/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-fetchers-emitters.json
index 128a9112a5..b500cdd21b 100644
--- a/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-fetchers-emitters.json
+++ b/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-fetchers-emitters.json
@@ -27,9 +27,13 @@
}
}
},
+ "parse-context": {
+ "timeout-limits": {
+ "progressTimeoutMillis": 120000
+ }
+ },
"pipes": {
"numClients": 2,
- "timeoutMillis": 120000,
"forkedJvmArgs": [
"-Xmx256m"
]
diff --git a/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-pipes-basic.json b/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-pipes-basic.json
index 63b2234197..86a24fa4c3 100644
--- a/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-pipes-basic.json
+++ b/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-pipes-basic.json
@@ -14,9 +14,13 @@
"tika"
]
},
+ "parse-context": {
+ "timeout-limits": {
+ "progressTimeoutMillis": 5000
+ }
+ },
"pipes": {
"numClients": 2,
- "timeoutMillis": 5000,
"forkedJvmArgs": [
"-Xmx256m"
]
diff --git a/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-tls-one-way-template.json b/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-tls-one-way-template.json
index e24d340462..e83dc807dd 100644
--- a/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-tls-one-way-template.json
+++ b/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-tls-one-way-template.json
@@ -20,9 +20,13 @@
"clientAuthenticationRequired": false
}
},
+ "parse-context": {
+ "timeout-limits": {
+ "progressTimeoutMillis": 120000
+ }
+ },
"pipes": {
"numClients": 2,
- "timeoutMillis": 120000,
"forkedJvmArgs": [
"-Xmx256m"
]
diff --git a/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-tls-two-way-template.json b/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-tls-two-way-template.json
index e7121e53a3..6cac23b3e4 100644
--- a/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-tls-two-way-template.json
+++ b/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-tls-two-way-template.json
@@ -23,9 +23,13 @@
"clientAuthenticationRequired": true
}
},
+ "parse-context": {
+ "timeout-limits": {
+ "progressTimeoutMillis": 120000
+ }
+ },
"pipes": {
"numClients": 2,
- "timeoutMillis": 120000,
"forkedJvmArgs": [
"-Xmx256m"
]
diff --git a/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-tls.json b/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-tls.json
index 933e7259ac..7c526aa906 100644
--- a/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-tls.json
+++ b/tika-server/tika-server-core/src/test/resources/configs/tika-config-server-tls.json
@@ -36,9 +36,13 @@
}
}
},
+ "parse-context": {
+ "timeout-limits": {
+ "progressTimeoutMillis": 120000
+ }
+ },
"pipes": {
"numClients": 2,
- "timeoutMillis": 120000,
"forkedJvmArgs": [
"-Xmx256m"
]
diff --git a/tika-server/tika-server-core/src/test/resources/configs/tika-config-server.json b/tika-server/tika-server-core/src/test/resources/configs/tika-config-server.json
index 128a9112a5..b500cdd21b 100644
--- a/tika-server/tika-server-core/src/test/resources/configs/tika-config-server.json
+++ b/tika-server/tika-server-core/src/test/resources/configs/tika-config-server.json
@@ -27,9 +27,13 @@
}
}
},
+ "parse-context": {
+ "timeout-limits": {
+ "progressTimeoutMillis": 120000
+ }
+ },
"pipes": {
"numClients": 2,
- "timeoutMillis": 120000,
"forkedJvmArgs": [
"-Xmx256m"
]
diff --git a/tika-server/tika-server-core/src/test/resources/configs/tika-config-timeout-100ms.json b/tika-server/tika-server-core/src/test/resources/configs/tika-config-timeout-100ms.json
index 7bc6c2ca80..8cf3bdc5e5 100644
--- a/tika-server/tika-server-core/src/test/resources/configs/tika-config-timeout-100ms.json
+++ b/tika-server/tika-server-core/src/test/resources/configs/tika-config-timeout-100ms.json
@@ -4,8 +4,8 @@
"enableLogFile": true
},
"parse-context": {
- "tika-task-timeout": {
- "timeoutMillis": 100
+ "timeout-limits": {
+ "progressTimeoutMillis": 100
}
}
}
diff --git a/tika-server/tika-server-core/src/test/resources/configs/tika-config-with-timeout.json b/tika-server/tika-server-core/src/test/resources/configs/tika-config-with-timeout.json
index ad7ed83dde..540b69f8f0 100644
--- a/tika-server/tika-server-core/src/test/resources/configs/tika-config-with-timeout.json
+++ b/tika-server/tika-server-core/src/test/resources/configs/tika-config-with-timeout.json
@@ -7,8 +7,8 @@
}
],
"parse-context": {
- "tika-task-timeout": {
- "timeoutMillis": 30000
+ "timeout-limits": {
+ "progressTimeoutMillis": 30000
}
}
}
diff --git a/tika-server/tika-server-standard/src/test/resources/configs/cxf-test-base-template.json b/tika-server/tika-server-standard/src/test/resources/configs/cxf-test-base-template.json
index 40bb34e201..afc750acab 100644
--- a/tika-server/tika-server-standard/src/test/resources/configs/cxf-test-base-template.json
+++ b/tika-server/tika-server-standard/src/test/resources/configs/cxf-test-base-template.json
@@ -37,7 +37,6 @@
},
"pipes": {
"numClients": 2,
- "timeoutMillis": "TIMEOUT_MILLIS",
"emitIntermediateResults": false,
"forkedJvmArgs": [
"-Xmx512m"
@@ -55,7 +54,10 @@
{ "algorithm": "MD5" },
{ "algorithm": "SHA1", "encoding": "BASE32" }
]
- }
- },
+ },
+ "timeout-limits": {
+ "progressTimeoutMillis": "TIMEOUT_MILLIS"
+ }
+ },
"plugin-roots": "PLUGINS_PATHS"
}
diff --git a/tika-server/tika-server-standard/src/test/resources/configs/tika-config-for-server-tests.json b/tika-server/tika-server-standard/src/test/resources/configs/tika-config-for-server-tests.json
index 174b340a78..649d215dc8 100644
--- a/tika-server/tika-server-standard/src/test/resources/configs/tika-config-for-server-tests.json
+++ b/tika-server/tika-server-standard/src/test/resources/configs/tika-config-for-server-tests.json
@@ -13,6 +13,9 @@
"throwOnZeroBytes": false
},
"parse-context": {
+ "timeout-limits": {
+ "progressTimeoutMillis": 30000
+ },
"commons-digester-factory": {
"digests": [
{ "algorithm": "MD5" },
@@ -28,8 +31,7 @@
}
},
"pipes": {
- "numClients": 2,
- "timeoutMillis": 30000
+ "numClients": 2
},
"plugin-roots": "target/plugins"
}
diff --git a/tika-server/tika-server-standard/src/test/resources/configs/tika-config-json.json b/tika-server/tika-server-standard/src/test/resources/configs/tika-config-json.json
index 2378b71062..1a66b64576 100644
--- a/tika-server/tika-server-standard/src/test/resources/configs/tika-config-json.json
+++ b/tika-server/tika-server-standard/src/test/resources/configs/tika-config-json.json
@@ -9,9 +9,13 @@
}
}
},
+ "parse-context": {
+ "timeout-limits": {
+ "progressTimeoutMillis": 120000
+ }
+ },
"pipes": {
"numClients": 2,
- "timeoutMillis": 120000,
"forkedJvmArgs": ["-Xmx1g"]
},
"plugin-roots": "target/plugins"
diff --git a/tika-server/tika-server-standard/src/test/resources/configs/tika-config-langdetect-opennlp-filter.json b/tika-server/tika-server-standard/src/test/resources/configs/tika-config-langdetect-opennlp-filter.json
index 9a6a9779a3..454f9d8fe9 100644
--- a/tika-server/tika-server-standard/src/test/resources/configs/tika-config-langdetect-opennlp-filter.json
+++ b/tika-server/tika-server-standard/src/test/resources/configs/tika-config-langdetect-opennlp-filter.json
@@ -18,6 +18,9 @@
"throwOnZeroBytes": false
},
"parse-context": {
+ "timeout-limits": {
+ "progressTimeoutMillis": 30000
+ },
"commons-digester-factory": {
"digests": [
{ "algorithm": "MD5" },
@@ -33,8 +36,7 @@
}
},
"pipes": {
- "numClients": 2,
- "timeoutMillis": 30000
+ "numClients": 2
},
"plugin-roots": "target/plugins"
}
diff --git a/tika-server/tika-server-standard/src/test/resources/configs/tika-config-langdetect-optimaize-filter.json b/tika-server/tika-server-standard/src/test/resources/configs/tika-config-langdetect-optimaize-filter.json
index ef02357640..367e0d2448 100644
--- a/tika-server/tika-server-standard/src/test/resources/configs/tika-config-langdetect-optimaize-filter.json
+++ b/tika-server/tika-server-standard/src/test/resources/configs/tika-config-langdetect-optimaize-filter.json
@@ -18,6 +18,9 @@
"throwOnZeroBytes": false
},
"parse-context": {
+ "timeout-limits": {
+ "progressTimeoutMillis": 30000
+ },
"commons-digester-factory": {
"digests": [
{ "algorithm": "MD5" },
@@ -33,8 +36,7 @@
}
},
"pipes": {
- "numClients": 2,
- "timeoutMillis": 30000
+ "numClients": 2
},
"plugin-roots": "target/plugins"
}