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

Issue #83: Refactor wopi controller #84

Merged
merged 70 commits into from
Jan 20, 2025
Merged

Issue #83: Refactor wopi controller #84

merged 70 commits into from
Jan 20, 2025

Conversation

donquixote
Copy link
Collaborator

@donquixote donquixote commented Jan 8, 2025 •
edited
Loading

@donquixote donquixote force-pushed the issue-83-refactor-wopi-controller branch 3 times, most recently from 1883815 to 0a91f3a Compare January 9, 2025 14:23
AaronGilMartinez
AaronGilMartinez requested changes Jan 10, 2025
View reviewed changes
Copy link
Collaborator

@AaronGilMartinez AaronGilMartinez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think is going to the right direction, added some remarks just in case.

src/Access/WopiProofAccessCheck.php Show resolved Hide resolved
src/Controller/WopiController.php Outdated Show resolved Hide resolved
src/Controller/WopiController.php Show resolved Hide resolved
src/Util/IsoDateTime.php Outdated Show resolved Hide resolved
src/EventSubscriber/ExceptionWopiSubscriber.php Outdated Show resolved Hide resolved
tests/src/Kernel/Controller/WopiControllerTest.php Outdated Show resolved Hide resolved
tests/src/Kernel/Controller/WopiControllerTest.php Outdated Show resolved Hide resolved
tests/src/Kernel/Controller/WopiControllerTest.php Show resolved Hide resolved
tests/src/Kernel/Controller/WopiControllerTest.php Outdated Show resolved Hide resolved
tests/src/Kernel/Controller/WopiControllerTest.php Show resolved Hide resolved
@donquixote donquixote force-pushed the issue-83-refactor-wopi-controller branch 4 times, most recently from b0bd89d to 7819c85 Compare January 15, 2025 02:38
AaronGilMartinez
AaronGilMartinez requested changes Jan 15, 2025
View reviewed changes
tests/src/Traits/KernelTestLoggerTrait.php Show resolved Hide resolved
src/Controller/WopiController.php Outdated Show resolved Hide resolved
tests/src/Kernel/Controller/WopiControllerTest.php Show resolved Hide resolved
src/MediaHelper.php Show resolved Hide resolved
@donquixote donquixote force-pushed the issue-83-refactor-wopi-controller branch 2 times, most recently from dabead7 to 19b7ce9 Compare January 15, 2025 19:36
AaronGilMartinez
AaronGilMartinez requested changes Jan 17, 2025
View reviewed changes
Copy link
Collaborator

@AaronGilMartinez AaronGilMartinez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look good, but to be sure a rebase would be needed please.

@donquixote
Issue 83: Add some trailing commas on multi-line argument lists.
26b6df2
@donquixote
Issue 83: Return 404 instead of 403 for media not found.
1df2c48
@donquixote
Issue 83: Fix ExceptionWopiSubscriber service by adding autoconfigure…
aa7d28a 
… in services.yml, and setting Content-Type header.

Without that, the ExceptionWopiSubscriber was not actually registered as an event subscriber.
It did not matter because routes with any '_format' other than 'html' already behave in the desired way.
Now, to replicate the prior behavior, we must explicitly set the 'Content-Type' header to 'text/plain'.
@donquixote
Issue 83: Refactor ExceptionWopiSubscriber, introducing local vars.
cfca92f
@donquixote
Issue 83: Use wildcard loading for media entity in WopiController, bu…
9efebde 
…t keep 403.

Changes:
- Use wildcard loading for media entity in WopiController.
- Change 'not found' response code and message for WOPI requests, to replicate old behavior.

Subsequent commit will change to actual 404.
@donquixote
Issue 83: Pass the media entity directly to verifyTokenForMedia().
3ec3c87
@donquixote
Issue 83: Always fail if token is missing.
d431553
@donquixote
Issue 83: Remove pointless local var $returnCode.
0ac761b
@donquixote
Issue 83: Centralize the call to verifyTokenForMedia().
bc26320
@donquixote
Issue 83: Centralize the user loading.
a451d9a
@donquixote
Issue 83: Centralize the file loading.
f00e9fe
@donquixote
Issue 83: Centralize the can_write check.
3e07847
@donquixote
Issue 83: Drop pointless local var $mimetype.
13e7af9
@donquixote
Issue 83: Extract buildSaveReason() from wopiPutFile().
7516055
@donquixote
Issue 83: Rename $payload -> $response_data.
2b12a09
@donquixote
Issue 83: Rename $jsonPayload -> $response_json.
ba48462
@donquixote
Issue 83: Use JsonResponse.
0e4d406
@donquixote
Issue 83: Return the response directly, drop the local var.
6b33eea
@donquixote
Issue 83: Assert exact file uri on save.
2d88e46
@donquixote
Issue 83: Assert that file name does not change on save.
e337cb7
@donquixote
Issue 83: Assert that file owner is set correctly on save.
942ca91
@donquixote
Issue 83: Change log level to info.
d0205ab
@donquixote
Issue 83: Introduce WopiControllerTest::assertOnlyLogMessage().
bdff035
@donquixote
Issue 83: Change the log message on save to provide more detail.
bbf8ac9
@donquixote
Issue 83: Fix typo 'mesage' -> 'message'.
6729442
@donquixote
Issue 83: Add copyright in ExceptionWopiSubscriber.
a6f26f2
@donquixote
Issue 83: Assert that new file is permanent.
682c073
@donquixote
Issue 83: Test missing token.
b850900
@donquixote
Issue 83: Check and test if file entity missing.
176f315
@donquixote
Issue 83: Check and test if file missing in filesystem.
c217401
@donquixote
Issue 83: Test file size field value on save.
22129d7
@donquixote
Issue 83: Rely on core to update the file size field value.
ca665e4
@donquixote
Issue 83: Introduce CollaboraJwtKeyException, and clarify failure mes…
50746d0 
…sages for jwt-related problems.
@donquixote
Issue 83: Introduce KernelTestLoggerTrait.
04f2583
@donquixote
Issue 83: Assert core log messages in assertAccessDeniedResponse() an…
de45fa1 
…d assertNotFoundResponse().
@donquixote
Issue 83: Assert no log messages left in tearDown().
00d1113
@donquixote
Issue 83: Assert log message in testBadToken().
4e20afe
@donquixote
Issue 83: Test JWT key missing or empty.
d02baee
@donquixote
Issue 83: Test the user picture in wopi file info response.
830d47e
@donquixote
Issue 83: The 3 methods in WopiController don't need to be public.
c713571
@donquixote
Issue 83: Test wopiPutFile() without write access.
501c5f9
@donquixote
Issue 83: Always check user write permission if token says 'wri'.
ddc83e3
@donquixote
Issue 83: Test missing write permission.
b6b4a36
@donquixote donquixote force-pushed the issue-83-refactor-wopi-controller branch from 19b7ce9 to b6b4a36 Compare January 17, 2025 14:43
@donquixote donquixote marked this pull request as ready for review January 17, 2025 17:51
@AaronGilMartinez AaronGilMartinez merged commit aea55fb into main Jan 20, 2025
3 checks passed
@AaronGilMartinez AaronGilMartinez deleted the issue-83-refactor-wopi-controller branch January 20, 2025 10:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AaronGilMartinez AaronGilMartinez AaronGilMartinez approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Refactor WopiController
2 participants
@donquixote @AaronGilMartinez