Support document - #168
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the migration common library to support Backlog “Document” features by upgrading backlog4j and introducing new domain models, JSON formats, and service APIs to fetch documents, document trees, comments, and attachments.
Changes:
- Upgrade
backlog4jto2.10.0and adjust HTTP client initialization accordingly. - Add
DocumentService(+ implementation) and document-related domain models + JSON marshalling/unmarshalling. - Extend project creation and issue filtering to support new/backported backlog4j capabilities (documents, grandchild-related parent/child filtering).
Reviewed changes
Copilot reviewed 13 out of 14 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| core/src/main/scala/com/nulabinc/backlog/migration/common/services/MappingFileService.scala | Update Apache Commons CSV CSVFormat construction to builder API. |
| core/src/main/scala/com/nulabinc/backlog/migration/common/service/ProjectServiceImpl.scala | Enable document support when creating projects (documentEnabled). |
| core/src/main/scala/com/nulabinc/backlog/migration/common/service/IssueServiceImpl.scala | Update parentChild filter mapping to new backlog4j parent/child enum values. |
| core/src/main/scala/com/nulabinc/backlog/migration/common/service/DocumentServiceImpl.scala | New service implementation for listing documents, fetching document trees, comments, and attachments. |
| core/src/main/scala/com/nulabinc/backlog/migration/common/service/DocumentService.scala | New service trait defining document-related operations. |
| core/src/main/scala/com/nulabinc/backlog/migration/common/modules/DefaultModule.scala | Wire DocumentService into DI bindings. |
| core/src/main/scala/com/nulabinc/backlog/migration/common/formatters/BacklogJsonProtocol.scala | Add JSON formats for new document domain types and bump BacklogProject format arity. |
| core/src/main/scala/com/nulabinc/backlog/migration/common/domain/Backlog.scala | Add useDocument to BacklogProject and introduce document-related domain case classes. |
| core/src/main/scala/com/nulabinc/backlog/migration/common/convert/writes/ProjectWithVCSWrites.scala | Populate useDocument when converting project data from backlog4j. |
| core/src/main/scala/com/nulabinc/backlog/migration/common/convert/writes/DocumentWrites.scala | New converters from backlog4j document models to internal domain models. |
| core/src/main/scala/com/nulabinc/backlog/migration/common/convert/BacklogUnmarshaller.scala | Add unmarshalling helpers for BacklogDocument and BacklogDocumentTree. |
| core/src/main/scala/com/nulabinc/backlog/migration/common/conf/BacklogPaths.scala | Add filesystem paths for document exports (documents dir, attachments, tree JSON). |
| core/src/main/scala/com/nulabinc/backlog/migration/common/client/BacklogAPIClientImpl.scala | Switch HTTP client implementation to backlog4j’s HttpClientBacklogHttpClient. |
| build.sbt | Upgrade backlog4j version and update scalafix command aliases. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
No description provided.