Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Enhancement: symmetric document links #4907

Merged
merged 6 commits into from Dec 19, 2023
Merged

Enhancement: symmetric document links #4907

merged 6 commits into from Dec 19, 2023

Conversation

shamoon
Copy link
Member

@shamoon shamoon commented Dec 9, 2023 •
edited

Proposed change

I guess folks that wanted this feature feel this is pretty important. PR is all in the backend so welcome feedback. Notes:

  • We have to support link added, link removed and when the entire field is removed
  • For links added and removed we can use CustomFieldInstanceSerializer. I did find that the custom_fields field seems to only use create, not update, I couldn't find any docs or info about that, but basically an update method didnt seem to run ever and create always does.
  • I also couldn't find much documentation about when the entire field is removed (there's no e.g. delete on a nested field I guess) so I implemented it on the DocumentSerializer by checking if the incoming data is going to remove a doc link field.

Fixes #4871

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Other (please explain):

Checklist:

  • I have read & agree with the contributing guidelines.
  • If applicable, I have included testing coverage for new code in this PR, for backend and / or front-end changes.
  • If applicable, I have tested my code for new features & regressions on both mobile & desktop devices, using the latest version of major browsers.
  • If applicable, I have checked that all tests pass, see documentation.
  • I have run all pre-commit hooks, see documentation.
  • I have made corresponding changes to the documentation as needed.
  • I have checked my modifications for any breaking changes.

@shamoon shamoon requested a review from a team as a code owner December 9, 2023 08:51
@paperless-ngx-secretary paperless-ngx-secretary bot added backend documentation Improvements or additions to documentation non-trivial Requires approval by several team members labels Dec 9, 2023
@github-actions github-actions bot added the enhancement New feature label Dec 9, 2023
@codecov Codecov
Copy link

codecov bot commented Dec 9, 2023 •
edited

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (5e8de4c) 96.19% compared to head (146a362) 96.20%.

Additional details and impacted files 
@@           Coverage Diff           @@
##              dev    #4907   +/-   ##
=======================================
  Coverage   96.19%   96.20%           
=======================================
  Files         382      382           
  Lines       14651    14683   +32     
  Branches     1161     1161           
=======================================
+ Hits        14094    14126   +32     
  Misses        553      553           
  Partials        4        4
Flag Coverage Δ
backend 94.78% <100.00%> (+0.02%) ⬆️
frontend 97.82% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@shamoon shamoon force-pushed the feature-symmetric-doclinks branch 2 times, most recently from f1ad8c9 to 77d06d2 Compare December 12, 2023 08:33
stumpylog
stumpylog requested changes Dec 19, 2023
View reviewed changes
src/documents/serialisers.py Outdated Show resolved Hide resolved
src/documents/serialisers.py Outdated Show resolved Hide resolved
@shamoon shamoon enabled auto-merge (squash) December 19, 2023 20:47
@shamoon shamoon merged commit 638d997 into dev Dec 19, 2023
30 checks passed
@shamoon shamoon deleted the feature-symmetric-doclinks branch December 19, 2023 21:43
shamoon added a commit that referenced this pull request Dec 20, 2023
@shamoon
Squashed commit of the following:
3e1a3ae 
commit 8a0a49d
Author: shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Tue Dec 19 23:02:47 2023 -0800

    Fix formatting

commit 66b2d90
Author: shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Tue Dec 19 22:36:35 2023 -0800

    Refactor frontend data models

commit 5723bd8
Author: Adam Bogdał <adam@bogdal.pl>
Date:   Wed Dec 20 01:17:43 2023 +0100

    Fix: speed up admin panel for installs with a large number of documents (#5052)

commit 9b08ce1
Author: shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Tue Dec 19 15:18:51 2023 -0800

    Update PULL_REQUEST_TEMPLATE.md

commit a6248be
Author: shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Tue Dec 19 15:02:05 2023 -0800

    Chore: Update Angular to v17 (#4980)

commit b1f6f52
Author: shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Tue Dec 19 13:53:56 2023 -0800

    Fix: Dont allow null custom_fields property via API (#5063)

commit 638d997
Author: shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Tue Dec 19 13:43:50 2023 -0800

    Enhancement: symmetric document links (#4907)

commit 5e8de4c
Author: shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Tue Dec 19 12:45:04 2023 -0800

    Enhancement: shared icon & shared by me filter (#4859)

commit 088bad9
Author: Trenton H <797416+stumpylog@users.noreply.github.com>
Date:   Tue Dec 19 12:04:03 2023 -0800

    Bulk updates all the backend libraries (#5061)
stumpylog added a commit that referenced this pull request Dec 29, 2023
@stumpylog @shamoon
Feature: Allow setting backend configuration settings via the UI (#5126)
061f33f 
* Saving some start on this

* At least partially working for the tesseract parser

* Problems with migration testing need to figure out

* Work around that error

* Fixes max m_pixels

* Moving the settings to main paperless application

* Starting some consumer options

* More fixes and work

* Fixes these last tests

* Fix max_length on OcrSettings.mode field

* Fix all fields on Common & Ocr settings serializers

* Umbrellla config view

* Revert "Umbrellla config view"

This reverts commit fbaf9f4.

* Updates to use a single configuration object for all settings

* Squashed commit of the following:

commit 8a0a49d
Author: shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Tue Dec 19 23:02:47 2023 -0800

    Fix formatting

commit 66b2d90
Author: shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Tue Dec 19 22:36:35 2023 -0800

    Refactor frontend data models

commit 5723bd8
Author: Adam Bogdał <adam@bogdal.pl>
Date:   Wed Dec 20 01:17:43 2023 +0100

    Fix: speed up admin panel for installs with a large number of documents (#5052)

commit 9b08ce1
Author: shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Tue Dec 19 15:18:51 2023 -0800

    Update PULL_REQUEST_TEMPLATE.md

commit a6248be
Author: shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Tue Dec 19 15:02:05 2023 -0800

    Chore: Update Angular to v17 (#4980)

commit b1f6f52
Author: shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Tue Dec 19 13:53:56 2023 -0800

    Fix: Dont allow null custom_fields property via API (#5063)

commit 638d997
Author: shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Tue Dec 19 13:43:50 2023 -0800

    Enhancement: symmetric document links (#4907)

commit 5e8de4c
Author: shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Tue Dec 19 12:45:04 2023 -0800

    Enhancement: shared icon & shared by me filter (#4859)

commit 088bad9
Author: Trenton H <797416+stumpylog@users.noreply.github.com>
Date:   Tue Dec 19 12:04:03 2023 -0800

    Bulk updates all the backend libraries (#5061)

* Saving some work on frontend config

* Very basic but dynamically-generated config form

* Saving work on slightly less ugly frontend config

* JSON validation for user_args field

* Fully dynamic config form

* Adds in some additional validators for a nicer error message

* Cleaning up the testing and coverage more

* Reverts unintentional change

* Adds documentation about the settings and the precedence

* Couple more commenting and style fixes

---------

Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>
@github-actions GitHub Actions
Copy link
Contributor

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new discussion or issue for related concerns.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 19, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@bogdal bogdal bogdal left review comments

@stumpylog stumpylog stumpylog approved these changes

Assignees
No one assigned
Labels
backend documentation Improvements or additions to documentation enhancement New feature non-trivial Requires approval by several team members
Projects
None yet
Milestone
v2.2.0
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@shamoon @stumpylog @bogdal