Skip to content

V1-15: plugin-tika: reading PDF, Word and Excel #653

Open

Description

@kelvinkipruto

Type: AFK. Can be built and merged without a decision.

Owner: koechkevin. Order: 6 of 12 for this owner, after #652 and before #654. Track: pipeline. Build order: #672

Part of PromiseTracker v3, version 1. Specification: docs/spec/promisetracker-v3-system-specification.md. Section numbers below refer to it.

What to build

The tika content extractor, so documents in complex formats reach the extracted state.

Start here

  • Read first: sections 6.2, 9.3 and 16.3 of the specification.
  • Code goes in: a new plugins/tika package, shaped like plugins/site. A new plugin is also added to firstPartyPlugins in apps/cms/src/kernel.ts, to transpilePackages in apps/site/next.config.ts, and to the COPY lines for package.json files in docker/Dockerfile.
  • Already there: the ContentExtractor port in packages/kernel/src/ports.ts, the Tika container in docker/compose.yaml on PT_TIKA_PORT, and the health report in apps/cms/src/health.ts.
  • From v2: src/tasks/extractDocuments.ts, for how v2 called its extractor. Do not copy its cleanText, which strips accents. Read a v2 file with git show v2-final:<path>.
  • Migration: Only if the plugin declares settings, which adds the settings global.
  • How to work: AGENTS.md, section "Working on an issue".

Acceptance criteria

  • plugins/tika provides the tika extractor for PDF, Word, Excel, PowerPoint, OpenDocument,
    RTF and EPUB, chosen by file type
  • The Tika server address lives in the plugin's encrypted settings
  • Requests time out after two minutes and pass through the circuit breaker
  • Tika appears in /api/health only when the plugin is enabled, and never in
    /api/health/ready
  • A spreadsheet uploaded as a document, not as records, is read as text
  • Integration tests run against the Tika container in Compose and CI, with a sample PDF and
    Word file containing French text

Blocked by

Unblocks

Metadata

Metadata

Assignees

Labels

featureFeaturestatus: blockedWaits for the issues in its Blocked by sectiontrack: pipelineDocuments, extraction, AI and failure handlingv3PromiseTracker v3

Type

No type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions