ExApp routes (public/user/admin) support #327

andrey18106 · 2024-07-16T12:51:16Z

This PR introduces new (mandatory if you use the ExApp proxy) registration of the routes that are allowed to call on ExApp via AppAPI ExApp proxy.

In your ExApp info.xml - external-app add the routes declaration, e.g.:

<routes>
	<route>
		<url>.*</url>
		<verb>GET,POST,PUT,DELETE</verb>
		<access_level>USER</access_level>
		<headers_to_exclude>[]</headers_to_exclude>
	</route>
</routes>

allows all routes, or more specific:

<routes>
	<route>
		<url>img\/.*</url>
		<verb>GET</verb>
		<access_level>USER</access_level>
		<headers_to_exclude>[]</headers_to_exclude>
	</route>
	<route>
		<url>js\/.*</url>
		<verb>GET</verb>
		<access_level>USER</access_level>
		<headers_to_exclude>[]</headers_to_exclude>
	</route>
	<route>
		<url>css\/.*</url>
		<verb>GET</verb>
		<access_level>USER</access_level>
		<headers_to_exclude>[]</headers_to_exclude>
	</route>
	<route>
		<url>api\/.*</url>
		<verb>GET,POST,PUT,DELETE</verb>
		<access_level>USER</access_level>
		<headers_to_exclude>[]</headers_to_exclude>
	</route>
</routes>

appinfo/routes.php

docs/tech_details/api/routes.rst

This reverts commit ca4c14c. We need this to keep the #327 included in NC 27. We'll drop it's support after AppAPI 3.0.0. --------- Signed-off-by: Andrey Borysenko <[email protected]>

bigcat88 · 2024-07-25T10:13:13Z

Logs are full of errors:

{"file":"/home/runner/work/app_api/app_api/lib/private/DB/QueryBuilder/QueryBuilder.php","line":270,"function":"executeQuery","class":"OC\\DB\\ConnectionAdapter","type":"->","args":["SELECT `exs`.* FROM `*PREFIX*ex_task_processing` `exs` INNER JOIN `*PREFIX*ex_apps` `exa` ON `exa`.`appid` = `exs`.`app_id` WHERE `exa`.`enabled` = :dcValue1",[1],[1]]},{"file":"/home/runner/work/app_api/app_api/apps/app_api/lib/Db/TaskProcessing/TaskProcessingProviderMapper.php","line":32,"function":"executeQuery","class":"OC\\DB\\QueryBuilder\\QueryBuilder","type":"->","args":[]},{"file":"/home/runner/work/app_api/app_api/apps/app_api/lib/Service/ProvidersAI/TaskProcessingService.php","line":44,"function":"findAllEnabled","class":"OCA\\AppAPI\\Db\\TaskProcessing\\TaskProcessingProviderMapper","type":"->","args":[]},{"file":"/home/runner/work/app_api/app_api/apps/app_api/lib/Service/ProvidersAI/TaskProcessingService.php","line":132,"function":"getRegisteredTaskProcessingProviders","class":"OCA\\AppAPI\\Service\\ProvidersAI\\TaskProcessingService","type":"->","args":[]},{"file":"/home/runner/work/app_api/app_api/apps/app_api/lib/AppInfo/Application.php","line":98,"function":"registerExAppTaskProcessingProviders","class":"OCA\\AppAPI\\Service\\ProvidersAI\\TaskProcessingService","type":"->","args":[["OCP\\AppFramework\\Bootstrap\\IRegistrationContext@anonymous\u0000/home/runner/work/app_api/app_api/lib/private/AppFramework/Bootstrap/RegistrationContext.php:161$5e"],["OC\\Server"]]},{"file":"/home/runner/work/app_api/app_api/lib/private/AppFramework/Bootstrap/Coordinator.php","line":99,"function":"register","class":"OCA\\AppAPI\\AppInfo\\Application","type":"->","args":[["OCP\\AppFramework\\Bootstrap\\IRegistrationContext@anonymous\u0000/home/runner/work/app_api/app_api/lib/private/AppFramework/Bootstrap/RegistrationContext.php:161$5e"]]},{"file":"/home/runner/work/app_api/app_api/lib/private/AppFramework/Bootstrap/Coordinator.php","line":52,"function":"registerApps","class":"OC\\AppFramework\\Bootstrap\\Coordinator","type":"->","args":[["app_api"]]},{"file":"/home/runner/work/app_api/app_api/lib/private/Installer.php","line":95,"function":"runLazyRegistration","class":"OC\\AppFramework\\Bootstrap\\Coordinator","type":"->","args":["app_api"]},{"file":"/home/runner/work/app_api/app_api/core/Command/App/Enable.php","line":93,"function":"installApp","class":"OC\\Installer","type":"->","args":["app_api",true]},{"file":"/home/runner/work/app_api/app_api/core/Command/App/Enable.php","line":63,"function":"enableApp","class":"OC\\Core\\Command\\App\\Enable","type":"->","args":["app_api",[],true,["Symfony\\Component\\Console\\Output\\ConsoleOutput"]]},{"file":"/home/runner/work/app_api/app_api/3rdparty/symfony/console/Command/Command.php","line":298,"function":"execute","class":"OC\\Core\\Command\\App\\Enable","type":"->","args":[["Symfony\\Component\\Console\\Input\\ArgvInput"],["Symfony\\Component\\Console\\Output\\ConsoleOutput"]]},{"file":"/home/runner/work/app_api/app_api/3rdparty/symfony/console/Application.php","line":1040,"function":"run","class":"Symfony\\Component\\Console\\Command\\Command","type":"->","args":[["Symfony\\Component\\Console\\Input\\ArgvInput"],["Symfony\\Component\\Console\\Output\\ConsoleOutput"]]},{"file":"/home/runner/work/app_api/app_api/3rdparty/symfony/console/Application.php","line":301,"function":"doRunCommand","class":"Symfony\\Component\\Console\\Application","type":"->","args":[["OC\\Core\\Command\\App\\Enable"],["Symfony\\Component\\Console\\Input\\ArgvInput"],["Symfony\\Component\\Console\\Output\\ConsoleOutput"]]},{"file":"/home/runner/work/app_api/app_api/3rdparty/symfony/console/Application.php","line":171,"function":"doRun","class":"Symfony\\Component\\Console\\Application","type":"->","args":[["Symfony\\Component\\Console\\Input\\ArgvInput"],["Symfony\\Component\\Console\\Output\\ConsoleOutput"]]},{"file":"/home/runner/work/app_api/app_api/lib/private/Console/Application.php","line":183,"function":"run","class":"Symfony\\Component\\Console\\Application","type":"->","args":[["Symfony\\Component\\Console\\Input\\ArgvInput"],["Symfony\\Component\\Console\\Output\\ConsoleOutput"]]},{"file":"/home/runner/work/app_api/app_api/console.php","line":87,"function":"run","class":"OC\\Console\\Application","type":"->","args":[["Symfony\\Component\\Console\\Input\\ArgvInput"]]},{"file":"/home/runner/work/app_api/app_api/occ","line":11,"args":["/home/runner/work/app_api/app_api/console.php"],"function":"require_once"}],"File":"/home/runner/work/app_api/app_api/3rdparty/doctrine/dbal/src/Driver/PDO/Statement.php","Line":130}}},"message":"An exception occurred while executing a query: SQLSTATE[42P01]: Undefined table: 7 ERROR:  relation \"oc_ex_task_processing\" does not exist\nLINE 1: SELECT \"exs\".* FROM \"oc_ex_task_processing\" \"exs\" INNER JOIN...\n                            ^","exception":{},"CustomMessage":"An exception occurred while executing a query: SQLSTATE[42P01]: Undefined table: 7 ERROR:  relation \"oc_ex_task_processing\" does not exist\nLINE 1: SELECT \"exs\".* FROM \"oc_ex_task_processing\" \"exs\" INNER JOIN...\n                            ^"}}

which is preventing to see clear why the DeployTests are failing when they should not...

Signed-off-by: Andrey Borysenko <[email protected]>

lib/Controller/ExAppRoutesController.php

lib/Migration/Version3000Date20240715170800.php

lib/Service/ExAppService.php

Signed-off-by: Andrey Borysenko <[email protected]>

bigcat88 · 2024-07-31T17:59:32Z

what happens when ExApp get update - in which place routes get updated?

andrey18106 · 2024-07-31T18:03:20Z

what happens when ExApp get update - in which place routes get updated?

Before update the ExApp is being disabled, which should unregister the routes, after install of new ExApp container and enable procedure - the new ExApp routes then should be registered. This won'twork if it's already disabled though..

bigcat88 · 2024-07-31T18:05:08Z

after install of new ExApp container and enable procedure

does this will work even if ExApp defines routes only in info.xml file and not register them with API?

andrey18106 · 2024-07-31T18:06:56Z

after install of new ExApp container and enable procedure

does this will work even if ExApp defines routes only in info.xml file and not register them with API?

It must be registered via API, there is no routes in info.xml.

lib/Service/ExAppService.php

bigcat88 · 2024-07-31T18:08:11Z

It should be registered via API, there is no routes in info.xml.

there is, you implemented it.

$appInfo['external-app']['routes'] allow it to be in info.xml

Signed-off-by: Andrey Borysenko <[email protected]>

…tion Signed-off-by: Andrey Borysenko <[email protected]>

Signed-off-by: Andrey Borysenko <[email protected]>

bigcat88

tested a little, looks very great

bigcat88 reviewed Jul 16, 2024

View reviewed changes

appinfo/routes.php Outdated Show resolved Hide resolved

bigcat88 reviewed Jul 16, 2024

View reviewed changes

docs/tech_details/api/routes.rst Outdated Show resolved Hide resolved

andrey18106 mentioned this pull request Jul 23, 2024

Revert "drop support of Nextcloud 27 (#322)" #335

Merged

andrey18106 force-pushed the public-pages-routes-support branch from 1b4d4e4 to e7b6c9c Compare July 23, 2024 18:13

andrey18106 changed the title ~~WIP: ExApp routes draft~~ ExApp routes (public/user/admin) support Jul 24, 2024

andrey18106 force-pushed the public-pages-routes-support branch from 70d8892 to 70bc3f3 Compare July 26, 2024 19:13

andrey18106 added 10 commits July 30, 2024 19:38

WIP: ExApp routes draft

226a0fb

Signed-off-by: Andrey Borysenko <[email protected]>

WIP: fix typo

4e1ced6

Signed-off-by: Andrey Borysenko <[email protected]>

WIP: adjustments, update changelog

ef73130

Signed-off-by: Andrey Borysenko <[email protected]>

WIP: add headers_to_exclude

9d84b59

Signed-off-by: Andrey Borysenko <[email protected]>

fix: headers_to_include -> headers_to_exclude

814be1b

Signed-off-by: Andrey Borysenko <[email protected]>

fix: remove fallback set empty routes

425d35f

Signed-off-by: Andrey Borysenko <[email protected]>

WIP: fix routes check, other adjustments

0c7ba40

Signed-off-by: Andrey Borysenko <[email protected]>

WIP: add routes to Basic api scope

bfb0ffc

Signed-off-by: Andrey Borysenko <[email protected]>

WIP: minor corrections

2eb3249

Signed-off-by: Andrey Borysenko <[email protected]>

remove unused parts, fix psalm

3bcc649

Signed-off-by: Andrey Borysenko <[email protected]>

andrey18106 force-pushed the public-pages-routes-support branch from 70bc3f3 to 3bcc649 Compare July 30, 2024 16:51

andrey18106 marked this pull request as ready for review July 30, 2024 16:55

bigcat88 reviewed Jul 31, 2024

View reviewed changes

lib/Controller/ExAppRoutesController.php Outdated Show resolved Hide resolved

bigcat88 reviewed Jul 31, 2024

View reviewed changes

lib/Migration/Version3000Date20240715170800.php Show resolved Hide resolved

bigcat88 reviewed Jul 31, 2024

View reviewed changes

lib/Service/ExAppService.php Outdated Show resolved Hide resolved

andrey18106 added 7 commits July 31, 2024 19:11

fix: correct logic to not throw an exception

7547c08

Signed-off-by: Andrey Borysenko <[email protected]>

fix: add index by appid for routes table

495e708

Signed-off-by: Andrey Borysenko <[email protected]>

fix: correct log level from debug to error

1d736e8

Signed-off-by: Andrey Borysenko <[email protected]>

fix(ci): suppress non-relevant psalm errors

53fe2cb

Signed-off-by: Andrey Borysenko <[email protected]>

fix: we don't need unique index

e33c343

Signed-off-by: Andrey Borysenko <[email protected]>

fix: remove old docstring

2afa2a6

Signed-off-by: Andrey Borysenko <[email protected]>

fix: php-cs

da6b956

Signed-off-by: Andrey Borysenko <[email protected]>

bigcat88 reviewed Jul 31, 2024

View reviewed changes

lib/Service/ExAppService.php Show resolved Hide resolved

andrey18106 and others added 11 commits August 1, 2024 21:20

WIP: remove API for routes registration to use only info.xml

7b0cb99

Signed-off-by: Andrey Borysenko <[email protected]>

WIP: add update of ExApp routes during ExApp update

92bf7da

Signed-off-by: Andrey Borysenko <[email protected]>

WIP: add pre-process of routes from info.xml, minor corrections

6051d5f

Signed-off-by: Andrey Borysenko <[email protected]>

WIP: remove unnecessary routes check, it's already done in registerExApp

3f8636e

Signed-off-by: Andrey Borysenko <[email protected]>

WIP: use string access_level names and map to numeric during registra…

1741a27

…tion Signed-off-by: Andrey Borysenko <[email protected]>

fix(ci): update baseline

aae57e4

Signed-off-by: Andrey Borysenko <[email protected]>

Merge branch 'main' into public-pages-routes-support

5de629c

fix: correct naming

d05f0e4

Signed-off-by: Andrey Borysenko <[email protected]>

fix: correct naming

9d24476

Signed-off-by: Andrey Borysenko <[email protected]>

fix: minor corrections in headers_to_exclude

452cdb4

Signed-off-by: Andrey Borysenko <[email protected]>

fix: minor corrections in headers_to_exclude

2f9a1fd

Signed-off-by: Andrey Borysenko <[email protected]>

bigcat88 approved these changes Aug 2, 2024

View reviewed changes

andrey18106 merged commit 65003cd into main Aug 2, 2024

andrey18106 deleted the public-pages-routes-support branch August 2, 2024 13:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

ExApp routes (public/user/admin) support #327

ExApp routes (public/user/admin) support #327

Uh oh!

andrey18106 commented Jul 16, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

bigcat88 commented Jul 25, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bigcat88 commented Jul 31, 2024

Uh oh!

andrey18106 commented Jul 31, 2024

Uh oh!

bigcat88 commented Jul 31, 2024 •

edited

Loading

Uh oh!

andrey18106 commented Jul 31, 2024 •

edited

Loading

Uh oh!

Uh oh!

bigcat88 commented Jul 31, 2024

Uh oh!

bigcat88 left a comment

Uh oh!

Uh oh!

ExApp routes (public/user/admin) support #327

ExApp routes (public/user/admin) support #327

Uh oh!

Conversation

andrey18106 commented Jul 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bigcat88 commented Jul 25, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bigcat88 commented Jul 31, 2024

Uh oh!

andrey18106 commented Jul 31, 2024

Uh oh!

bigcat88 commented Jul 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

andrey18106 commented Jul 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

bigcat88 commented Jul 31, 2024

Uh oh!

bigcat88 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

andrey18106 commented Jul 16, 2024 •

edited

Loading

bigcat88 commented Jul 31, 2024 •

edited

Loading

andrey18106 commented Jul 31, 2024 •

edited

Loading