Repository navigation
docs: Add import/export architecture concept for project portability - #312
Open
jankapunkt with Copilot wants to merge 4 commits into
Open
jankapunkt with Copilot wants to merge 4 commits into
jankapunkt with Copilot wants to merge 4 commits into
Conversation
Co-authored-by: jankapunkt <1135285+jankapunkt@users.noreply.github.com>
Co-authored-by: jankapunkt <1135285+jankapunkt@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Draft comprehensive concept for project import and export
docs: Add import/export architecture concept for project portability
Mar 20, 2026
jankapunkt
approved these changes
Mar 21, 2026
jankapunkt
marked this pull request as ready for review
March 21, 2026 07:01
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
OpenQDA needs to support five import/export channels (full archive, REFI-QDA, publication data, import full archive, import REFI), each varying significantly in data scope and transformation logic, while sharing infrastructure. This document proposes the architecture before implementation begins.
Architecture Overview
Layered design:
HTTP Layer → Queue Job → Pipeline (Pipes) → Format Strategy → Data AccessExporterInterface/ImporterInterfaceper format; aExporterRegistry(bound inImportExportServiceProvider) resolves format strings to concrete handlers. New formats = new class + one registration, no existing code changes (OCP).Pipeclasses via Laravel'sPipelinefacade (SRP; steps are independently testable and reorderable).ExportContext/ExportResultDTOs instead of raw arrays flowing between layers.BaseExporterfor sharedprepareTempDir → writeContent → packageOutput → cleanupskeleton, only if that skeleton stabilises.Resource & Consistency Concerns
ShouldQueuejobs on a dedicatedexportsqueue — web processes never block.Cache::lock) prevent duplicate concurrent exports of the same project+format.REPEATABLE READtransactions for point-in-time snapshot consistency.DB::transaction()— atomic or nothing.cursor()/chunk()to keep memory O(1) relative to project size.REFI-QDA
Mapping logic isolated in a
RefiMapperclass (not inside the exporter/importer).openqda/refi-toolsrecommended as the XML schema dependency before writing custom XML handling.Changes
docs/installation/preparations.md— concept document added as a new top-level section (# Import and Export Architecture Concept) covering: architecture diagram, all design patterns, queue setup, DB strategy, proposed directory layout, REFI specifics, publication export, HTTP API sketch, testing strategy, and dependency evaluation.docs/.vitepress/config.mts— sidebar entry added linking to the new section.✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.