New "Content by owner" View

[MariosORION]

This is for issue #85.

Changes:

• Adding new View page /admin/content/localgov-content-by-owner that lists content by owner (relationship to service contact required):

• Adding dynamic menu link that only gets placed if the View above is present:

• Adding dynamic local task that only gets generated if the View above is present (see below for screenshot).

I've tested this with a new user, service contact tied to that user and a service page with that service contact assigned; here's how the new View looks like (some columns are sortable just like the vanilla content View):

To add the View when localgov_workflow_notifications is already enabled, Councils can manually import the View's YML configuration (views.view.localgov_content_by_owner.yml) into their site:
views.view.localgov_content_by_owner.yml.zip

Benefits of this approach:

• No additional module required (verf). There is also a patch required for this module to avoid a fatal error when a VERF select exposed filter is added to the View (issue https://www.drupal.org/project/verf/issues/3113519)
• The "Content by owner" View can be optionally enabled and only comes to play when the localgov_workflow_notifications sub-module is enabled
  Possible cons of this approach:
• The new "Content by owner" View is on its own distinct path and not integrated with the default Content View (which might be appealing for some Councils as it also keeps the main Content View clean)

[markconroy]

@MariosORION can you check the merge conflict issue here, and I can give it a test then. Thanks.

[MariosORION]

@markconroy thanks for reviewing - Conflicts resolved but some tests are failing - do we resolve these on the main repo?

[stephen-cox]

@MariosORION All tests are passing in the 1.x branch so it's likely that something in the PR is breaking them. Unfortunately, Paratest is not giving a nice error message so the tests will need to be run locally to find what is breaking.

If you want a hand looking at this, are you able to run the tests for this module and post error here? This should allow us to debug it.

[MariosORION]

@stephen-cox I tried to set up tests to run them locally with no luck. I'll give it another go but if you have any hints on how to configure them locally with PHPStorm feel free to share...

[stephen-cox]

@MariosORION Are you using Lando or DDev for development? These should both be setup to run tests out of the box.

For Lando, you can run PHPUnit tests just for this module with: lando phpunit web/modules/contrib/localgov_workflows

[stephen-cox]

@MariosORION I have run the PHPUnit tests locally and (as I suspected) the errors are due to schema errors on the view configuration. There are a number of these errors

Drupal\Core\Config\Schema\SchemaIncompleteException: Schema errors for views.view.localgov_content_by_owner with the following errors: views.view.localgov_content_by_owner:display.default.display_options.fields.changed.settings.time_diff.description missing schema

/app/web/core/lib/Drupal/Core/Config/Development/ConfigSchemaChecker.php:98
/app/web/core/lib/Drupal/Component/EventDispatcher/ContainerAwareEventDispatcher.php:111
/app/web/core/lib/Drupal/Core/Config/Config.php:230
/app/web/core/lib/Drupal/Core/Config/Entity/ConfigEntityStorage.php:278
/app/web/core/lib/Drupal/Core/Entity/EntityStorageBase.php:486
/app/web/core/lib/Drupal/Core/Config/Entity/ConfigEntityStorage.php:257
/app/web/core/lib/Drupal/Core/Entity/EntityBase.php:354
/app/web/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:614
/app/web/core/lib/Drupal/Core/Config/ConfigInstaller.php:389
/app/web/core/lib/Drupal/Core/Config/ConfigInstaller.php:149
/app/web/core/lib/Drupal/Core/ProxyClass/Config/ConfigInstaller.php:75
/app/web/core/lib/Drupal/Core/Extension/ModuleInstaller.php:326
/app/web/core/lib/Drupal/Core/ProxyClass/Extension/ModuleInstaller.php:83
/app/web/core/lib/Drupal/Core/Test/FunctionalTestSetupTrait.php:500
/app/web/core/tests/Drupal/Tests/BrowserTestBase.php:575
/app/web/core/tests/Drupal/Tests/BrowserTestBase.php:370
/app/web/modules/contrib/localgov_workflows/modules/localgov_workflows_notifications/tests/src/Functional/ServiceContactWidgetTest.php:59
/app/vendor/phpunit/phpunit/src/Framework/TestResult.php:729

There's also an error coming from the kernel test as the view is in the install directory. As it's a view that provides extra functionality I suggest moving it into the optional directory.

[stephen-cox]

I've made a couple of suggestions that should fix the failing tests.

[MariosORION]

Thanks for reviewing @stephen-cox , I'll put in some time this afternoon to clear this up.

[stephen-cox]

This now works fine. There are no filters on the view, but there's further discussion on this on the issue, but for this it comes down to whether this is required sooner rather than later. If we want this sooner we can merge this now, but when the filters are ready we will need an update hook to apply them to existing installs.

One further thought is the content tasks are now a bit busy and don't look good at medium screen widths

Should the link for this be moved under the content task?

Do you have thoughts on these things @willguv?

[willguv]

@stephen-cox @MariosORION I've got a slight change to this. We also need to be vary about calling these contacts "owners" as they don't own the content, just check it

So how about:

1. Put "Content by owner" in the "Service Contacts" menu

• Tab 1 is labelled "Contacts"and shows the service contact view
• Tab 2 is labelled "Content" and shows the content by owner view

2. On the "Contacts" view, provide a "View content" option in the edit menu of each contact. Links to a view of content checked by that person

[finnlewis]

@MariosORION would you be able to address the changes suggested by @willguv in the last comment?

[MariosORION]

I'll be working on these @finnlewis @willguv.

[MariosORION]

@willguv

Admin menu addition:

Local tasks added to provide two tabs: "Contacts" (/admin/content/localgov-service-contact) and "Content" (/admin/content/localgov-service-contact/content-by-owner):

Operation link added for every row on the Service contacts screen:

Each "View content" operation link contains a dynamic parameter, the service contact's ID which has also been added to the View as a contextual link, allowing for linking to a filtered version of the content by owner View (/admin/content/localgov-service-contact/content-by-owner?service-contact-id=1):

[stephen-cox]

@MariosORION This looks to work well for new installs!

@willguv Do we want to add this to existing installs?

From the looks of the code we just need to add an update hook to install the view configuration

[MariosORION]

@stephen-cox thanks for reviewing!
(Yes, the View is the only thing that needs importing as the custom code only runs if the View is enabled).

[willguv]

Lovely job @MariosORION thanks for doing this

@stephen-cox would be great to include for existing installs please

[willguv]

@MariosORION could you do an update hook for this please?

[MariosORION]

@willguv sure, @stephen-cox can you please give the added update hook a go?