[OP#49859] add create work package form

[SwikritiT]

Related work package [OP#49859]: https://community.openproject.org/projects/nextcloud-integration/work_packages/49859
This PR implements the creation of the work package through nextcloud

[SwikritiT]

Note that the CI is failing currently because of: https://community.openproject.org/projects/nextcloud-integration/work_packages/50501

[individual-it]

first quick review

[SagarGi]

I have gone through UI following figma.

Some changes can be made to it to make it look nicer.

1. For Project* selection by default a place holder can be added as in figma.
2. The input height of the Subject* could be adjusted as same height as select element to make it look nice and also place holder could also be added.

[SagarGi]

createWP.mp4

Also Try this in your machine.
I tried to add type of REquired FC and the validation gives error but after some inputs in the form the create button is enabled and the error is gone and then i create the WP it does not do anything.

[SwikritiT]

createWP.mp4
Also Try this in your machine. I tried to add type of REquired FC and the validation gives error but after some inputs in the form the create button is enabled and the error is gone and then i create the WP it does not do anything.

Thanks. should be fixed now. Can you please recheck?

[SwikritiT]

I've also updated the PR with alphabetical sorting @SagarGi @individual-it please recheck

[SagarGi]

LGTM 👍

[SwikritiT]

@SagarGi @individual-it I've also updated this PR by fixing the auto-focus/auto-opening of the project selection dropdown menu when the work package creation/linking form is opened.

@wielinde Whenever you have time you can test this PR.

[SwikritiT]

@SagarGi @individual-it this is sort of the workaround for disabling the autofocus when the modal comes into view. I know this is a "hack" but I also couldn't manage to do it in a very conventional way. I'm open to suggestion if anyone has a better way to do this.

[wielinde]

Hey @SagarGi, while I was trying to debug why on my machine this PR does not work, I found that the current approach to fetch projects does not work well. The extra requests for fetching the storages per project were making troubles. When thinking about what you want to achieve it became apparent, that you should use the correct filters on the projects query in the first place and not fetch the storages at all.

• You can simply use the storageUrl filter on the projects endpoint

Further, you want to make sure that the current user has the correct permissions on the selected projects.

• the user should have the permission to create work packages in the project AND
• the user should have the permission to create file links

We can filter on the available permission of a user in project with userAction filter.

Unfortunately, we currently cannot filter for a condition that requires ALL permissions to be present (Equals All "&="). We only have an operator that hits when any of the permissions is present (Equals "="). We will provide that extra filter soon (@Kharonus is working on it). For the time being you can work with the "Equals" operator. It will show more projects than actually good, but we can change that quickly once we provide the "EqualsAll" operator.

The new code could look somewhat like this:

	public function getAvailableOpenProjectProjects(string $userId): array {
		$resultsById = [];
            $result = $this->request(
                $userId,
                'projects?filters=' .
                urlencode(
                    '[{"storageUrl":{"operator":"=","values":["' .
                    $this->getBaseUrl() .
                    '"]}},{"userAction":{"operator":"=","values":["file_links/manage", "work_packages/create"]}}]'
                )
            );
            if (isset($result['error'])) {
                throw new OpenprojectErrorException($result['error'], $result['statusCode']);
            }
            if (
                !isset($result['_embedded']) ||
                !isset($result['_embedded']['elements'])
            ) {
                $this->logger->error(
                    "getAvailableOpenProjectProjects " . $result,
                    ['app' => $this->appName]
                );
                throw new OpenprojectResponseException('Malformed response');
            }
            foreach ($result['_embedded']['elements'] as $project) {
                $resultsById[$project['id']] = $project;
            }
            return $resultsById;
        }

And the function getProjectStorages can probably completely deleted as we do not need it anymore.

[SwikritiT]

@wielinde I've updated the PR as per your comment can you please re-check and ensure that the recent changes are working as expected for you?

[wielinde]

Hey @SwikritiT, I played around with the work package creation form and it looked all pretty solid. I could not break it. Well done.

One tiny detail: The submit button looks pretty "disabled"/"inactive" in dark mode. I looked at other places where and I think the caption text color "should" be white. Could it be that there is a wrong class applied? That style is also visible when the form is fully filled out.

Apart from that, from a QA perspective that PR is good be merged into "master".

[github-actions]

JS Code Coverage

Coverage after merging feat/add-create-work-package-form into master will be

87.38%

Coverage Report

File	Stmts	Branches	Funcs	Lines	Uncovered Lines
src
adminSettings.js	0%	0%	0%	0%	1, 1, 10–19, 2, 20–25, 3–9
bootstrap.js	0%	0%	0%	0%	1, 1–7
dashboard.js	0%	0%	0%	0%	1, 1, 10–19, 2, 20–25, 3–9
fileActions.js	0%	0%	0%	0%	1, 1, 10–17, 2–9
personalSettings.js	0%	0%	0%	0%	1, 1, 10–19, 2, 20–25, 3–9
projectTab.js	0%	0%	0%	0%	1, 1, 10–19, 2, 20–29, 3, 30–39, 4, 40–49, 5, 50–59, 6, 60–66, 7–9
reference.js	0%	0%	0%	0%	1, 1, 10–19, 2, 20–29, 3, 30–39, 4, 40–49, 5, 50–59, 6, 60, 7–9
utils.js	66.67%	33.33%	50%	69.09%	10–14, 17–26, 6–9
src/components
AdminSettings.vue	99.29%	95.60%	85.19%	99.91%	1, 1, 1, 1, 1
OAuthConnectButton.vue	99.19%	87.50%	100%	100%	1
PersonalSettings.vue	98.87%	93.33%	85.71%	100%	1
src/components/admin
FieldValue.vue	92.08%	33.33%	100%	97.78%	1, 1, 1, 1, 1, 1, 23, 23
FormHeading.vue	97.66%	75%	100%	99.36%	1, 1, 34, 34
ProjectFolderError.vue	96.83%	80%	100%	98.21%	1, 1
TextInput.vue	99.25%	95%	88.89%	100%	1
src/components/icons
ClippyIcon.vue	93.18%	50%	50%	97.50%	1, 1
OpenProjectIcon.vue	93.75%	100%	0%	96.77%	1
src/components/settings
CheckBox.vue	92.45%	80%	66.67%	97.62%	1, 1
SettingsTitle.vue	94.74%	50%	100%	97.14%	1, 1
src/components/tab
EmptyContent.vue	97.14%	78.95%	100%	99.35%	1, 1, 1, 33, 33
SearchInput.vue	99.22%	94.74%	77.78%	100%	1
WorkPackage.vue	98.42%	40%	100%	99.35%	1, 1, 1, 43, 43
src/filesPlugin
filesPlugin.js	0%	0%	0%	0%	1, 1, 10, 100–104, 11–19, 2, 20–29, 3, 30–39, 4, 40–49, 5, 50–59, 6, 60–69, 7, 70–79, 8, 80–89, 9, 90–99
filesPluginLessThan28.js	0%	0%	0%	0%	1, 1, 10–19, 2, 20–29, 3, 30–39, 4, 40–49, 5, 50–59, 6, 60–69, 7, 70–78, 8–9
src/utils
workpackageHelper.js	93.39%	91.11%	88.89%	94.15%	153–154, 18–20, 49, 49–51, 94–99
src/views
CreateWorkPackageModal.vue	98.22%	92.59%	40%	99.84%	1, 1, 1
Dashboard.vue	98.97%	71.43%	100%	99.65%	1, 1, 1
LinkMultipleFilesModal.vue	99.67%	94.12%	100%	100%	1
ProjectsTab.vue	99.74%	93.75%	100%	100%	23
WorkPackagePickerElement.vue	0%	0%	0%	0%	1, 1, 10–19, 2, 20–29, 3, 30–39, 4, 40–49, 5, 50–59, 6, 60–69, 7, 70–79, 8, 80–89, 9, 90–96
WorkPackageReferenceWidget.vue	0%	0%	0%	0%	1, 1, 10, 100–109, 11, 110–119, 12, 120–129, 13, 130–134, 14–19, 2, 20–29, 3, 30–39, 4, 40–49, 5, 50–59, 6, 60–69, 7, 70–79, 8, 80–89, 9, 90–99

[github-actions]

PHP Code Coverage

Coverage after merging feat/add-create-work-package-form into master will be

59.17%

Coverage Report

File	Stmts	Branches	Funcs	Lines	Uncovered Lines
server/apps/integration_openproject/lib
Capabilities.php	0%	100%	0%	0%	19, 26–29
server/apps/integration_openproject/lib/AppInfo
Application.php	11.43%	100%	25%	9.68%	101–104, 108–111, 113, 117–122, 133, 137, 70–72, 75, 79, 81, 84, 88, 90, 94, 99
server/apps/integration_openproject/lib/BackgroundJob
RemoveExpiredDirectUploadTokens.php	0%	100%	0%	0%	42, 44–46, 55–56
server/apps/integration_openproject/lib/Controller
ConfigController.php	62.69%	100%	50%	63.39%	134, 151–152, 154, 156–158, 160–161, 166–167, 169, 217, 278, 367–368, 371–372, 378–380, 506–509, 511–512, 515, 523, 534, 548–550, 565–569, 571–572, 574–577, 579–581, 583–585, 587–589, 607–612, 614–615, 617–619, 622, 624–627, 629–631, 633–635, 637–639, 653, 662–665, 667–670, 680–685
DirectDownloadController.php	0%	100%	0%	0%	36–38, 53–55, 57, 60–61
DirectUploadController.php	71.43%	100%	100%	70.43%	131–132, 177, 190, 194–197, 199, 209, 216, 232–234, 236–237, 240–242, 248, 250, 255–256, 263–264, 267–268, 271–272, 288–289, 309, 314, 320
FilesController.php	77%	100%	85.71%	76.34%	223–224, 277, 283, 285–287, 289, 291, 302–304, 307–308, 310–311, 315–318, 321, 327
OpenProjectAPIController.php	87.31%	100%	84.21%	87.55%	139, 180, 204, 230–233, 236, 238, 240–243, 245–246, 251, 263, 272, 290, 299, 367, 369, 419, 421, 441, 443, 490, 492, 712, 714, 96
server/apps/integration_openproject/lib/Dashboard
OpenProjectWidget.php	0%	100%	0%	0%	101–102, 104–108, 116, 123–124, 126, 128–129, 131–132, 134, 137–138, 140–141, 143, 69–73, 80, 87, 94
server/apps/integration_openproject/lib/Exception
OpenprojectErrorException.php	100%	100%	100%	100%
OpenprojectFileNotUploadedException.php	100%	100%	100%	100%
OpenprojectGroupfolderSetupConflictException.php	100%	100%	100%	100%
OpenprojectResponseException.php	100%	100%	100%	100%
OpenprojectUnauthorizedUserException.php	0%	100%	0%	0%	16
server/apps/integration_openproject/lib/Listener
BeforeGroupDeletedListener.php	0%	100%	0%	0%	48, 56–57, 60–63
BeforeNodeInsideOpenProjectGroupfilderChangedListener.php	0%	100%	0%	0%	41–43, 47–52, 55–56, 58–63, 65, 67, 71
BeforeUserDeletedListener.php	0%	100%	0%	0%	48, 55–56, 58–61
LoadAdditionalScriptsListener.php	0%	100%	0%	0%	17–18, 21–25
LoadSidebarScript.php	0%	100%	0%	0%	100, 102, 104, 106–108, 110, 112, 114–115, 117–118, 120, 122, 75–81, 83–84, 86–87, 89–90, 96–97, 99
OpenProjectReferenceListener.php	0%	100%	0%	0%	53–54, 58–59, 62–63, 65, 67
UserChangedListener.php	0%	100%	0%	0%	52, 59–60, 63–68
server/apps/integration_openproject/lib/Migration
Version2001Date20221213083550.php	0%	100%	0%	0%	47, 57, 60, 63, 67, 70, 73, 77–79, 81
Version2310Date20230116153411.php	0%	100%	0%	0%	46, 49–52, 54–56, 60, 64, 68, 72, 76, 81–82, 84
Version2400Date20230504144300.php	0%	100%	0%	0%	47, 57, 60
server/apps/integration_openproject/lib/Reference
WorkPackageReferenceProvider.php	17.02%	100%	10%	18.92%	102, 109–112, 115–117, 120, 127–130, 132, 134–136, 138, 140, 142, 146, 155, 163–164, 172, 52, 59, 66, 73–74
server/apps/integration_openproject/lib/Search
OpenProjectSearchProvider.php	0%	100%	0%	0%	103–104, 107–114, 116–118, 121–122, 124–125, 129–134, 140–141, 143, 66–69, 76, 83, 91, 93, 96
OpenProjectSearchResultEntry.php	100%	100%	100%	100%
server/apps/integration_openproject/lib/Service
DatabaseService.php	43.90%	100%	60%	41.67%	125–128, 131, 80–87, 89–93, 95–97
DirectDownloadService.php	88%	100%	100%	86.96%	65–66, 68
DirectUploadService.php	54.55%	100%	66.67%	52.63%	112, 118, 79–82, 84, 89, 91
OauthService.php	0%	100%	0%	0%	108–115, 45–47, 56–66, 68, 70–72, 75–78, 89, 91–94, 96–97
OpenProjectAPIService.php	74.42%	100%	73.33%	74.53%	1002, 1020, 1022, 1028, 1033, 1037, 1048–1049, 1180–1187, 1189, 1197–1201, 1209–1216, 1233–1240, 1249–1254, 165–169, 240,

[SagarGi]

LGTM 👍