.travis.yml

@@ -24,21 +24,19 @@ jobs:
         - NODE=YES
         - PRODUCT=YES
         - RULES=YES
-        # ---- Remaining self deprecation notices (2911)
-        # 2911 ModuleHandlerInterface::getImplementations() is deprecated in drupal:9.4.0
+        # ---- Remaining self deprecation notices (0)
         # ---- Other deprecation notices (0)
-        - DEPRECATIONS=2911
+        - DEPRECATIONS=0
     - php: 8.1
       env:
         - DRUPAL_CORE=9.5.x
         - MEDIA=YES
         - TAXONOMY=YES
         # ---- Unsilenced deprecation notices (6)
-        #    6 strlen(): Passing null to parameter #1 ($string) is deprecated
-        # ---- Remaining self deprecation notices (1767)
-        # 1767 ModuleHandlerInterface::getImplementations() is deprecated in drupal:9.4.0
+        #    6 strlen(): Passing null to parameter #1 ($string) is deprecated (SchedulerDrushTest)
+        # ---- Remaining self deprecation notices (0)
         # ---- Other deprecation notices (0)
-        - DEPRECATIONS=1773
+        - DEPRECATIONS=6
     - php: 8.1
       env:
         # Run the Node tests only.

.tugboat/config.yml

 services:
   php:
-    image: q0rban/tugboat-drupal:9.3
+    image: q0rban/tugboat-drupal:10.0
     default: true
     http: false
     depends: mysql
@@ -8,6 +8,9 @@ services:
       init: |
         # Install the bcmath extension, required for commerce_product
         docker-php-ext-install bcmath
+        # JPEG support is not included by default, but it is needed when generating content.
+        docker-php-ext-configure gd --enable-gd --with-jpeg
+        docker-php-ext-install gd
 
       update: |
         set -eux
@@ -32,6 +35,21 @@ services:
         # above that uses the $TUGBOAT_REPO_ID environment variable.
         composer require drupal/scheduler:dev-$TUGBOAT_REPO_ID
 
+        # Install Drupal on the site.
+        vendor/bin/drush \
+          --yes \
+          --db-url=mysql://tugboat:tugboat@mysql:3306/tugboat \
+          --site-name="${TUGBOAT_PREVIEW_NAME}" \
+          --account-pass=admin \
+          site:install standard
+
+        # Show site status and GD image support status.
+        vendor/bin/drush status-report
+        vendor/bin/drush php:eval 'phpinfo()' | grep GD
+        vendor/bin/drush php:eval 'print "imagepng() " . (function_exists("imagepng") ? "--yes\n" : "--no\n"); '
+        vendor/bin/drush php:eval 'print "imagejpeg() " . (function_exists("imagejpeg") ? "--yes\n" : "--no\n"); '
+        vendor/bin/drush php:eval 'print_r(gd_info());'
+
         # Commerce 2.29 needs inline_entity_form which does not have a stable
         # version as at March 2022. Therefore get that package here allowing RC
         # to avoid the "does not match your minimum-stability" problem.
@@ -40,17 +58,13 @@ services:
 
         # Get other useful modules.
         composer require drupal/devel_generate
-        composer require drupal/module_filter
-        composer require drupal/workbench_moderation
-        composer require drupal/workbench_moderation_actions:dev-1.x
 
-        # Install Drupal on the site.
-        vendor/bin/drush \
-          --yes \
-          --db-url=mysql://tugboat:tugboat@mysql:3306/tugboat \
-          --site-name="Scheduler issue ${TUGBOAT_PREVIEW_NAME}" \
-          --account-pass=admin \
-          site:install standard
+        # These modules are not compatible with Drupal 10 (yet) so only get them
+        # when running Drupal 9.
+        vendor/bin/drush core:status | awk "NR==1{print \$2\$3\$4}"
+        vendor/bin/drush core:status | awk "NR==1{print \$2\$3\$4}" | \
+          grep version:9 && composer require drupal/module_filter drupal/workbench_moderation \
+          drupal/workbench_moderation_actions:1.x-dev drupal/admin_toolbar
 
         # Set up the files directory permissions.
         mkdir -p $DRUPAL_DOCROOT/sites/default/files
@@ -59,8 +73,11 @@ services:
         chmod -R g+w $DRUPAL_DOCROOT/sites/default/files
 
         # Enable modules.
-        vendor/bin/drush --yes pm:enable scheduler devel devel_generate \
-          module_filter media commerce_product
+        vendor/bin/drush --yes pm:enable scheduler devel devel_generate media commerce_product
+
+        # Enable modules that are only available at Drupal 9.
+        vendor/bin/drush core:status | awk "NR==1{print \$2\$3\$4}" | \
+          grep version:9 && vendor/bin/drush --yes pm:enable module_filter admin_toolbar
 
         # Show versions.
         composer show drupal/scheduler | egrep 'name |vers'
@@ -143,14 +160,17 @@ services:
         vendor/bin/drush user-add-role 'product_viewer' 'Proctor product viewer'
 
         # Generate content.
-        vendor/bin/drush devel-generate-content 2 --bundles=article --authors=1,2 --verbose
-        vendor/bin/drush devel-generate-content 2 --bundles=page --authors=1,2 --verbose
-        vendor/bin/drush devel-generate-media 4 --media-types=image --verbose
+        vendor/bin/drush devel-generate-content 3 --bundles=article --authors=1,2 --verbose
+        vendor/bin/drush devel-generate-content 3 --bundles=page --authors=1,2 --verbose
+        vendor/bin/drush devel-generate-media 3 --media-types=document --verbose
+        vendor/bin/drush devel-generate-media 3 --media-types=image --verbose
 
         # @todo Place the 'Switch users' block in first sidebar.
         # @todo Add 'content overview' and 'media overview' to tools menu.
         # @todo Create a store for products. Then create some products.
         # @todo Generate a vocabulary and some terms. Create users for taxonomy.
+        # @todo page entity type should not be promoted to front page.
+        # @todo Create a menu of links to the pages?
 
       build: |
         set -eux

css/styling.css

@@ -2,3 +2,11 @@
 .scheduler-admin-form > .dropbutton-wrapper {
   width: 30%;
 }
+
+/* Add default background to dropbutton items in Claro theme. This should only
+   affect the non-link group title items, and avoid them being transparent.
+   See https://www.drupal.org/project/scheduler/issues/3316719
+   and https://www.drupal.org/project/drupal/issues/3317323 */
+.scheduler-admin-form .dropbutton__item:first-of-type ~ .dropbutton__item {
+  background-color: #f2f4f5;
+}

drupalci.yml

@@ -9,6 +9,7 @@ build:
       host_command:
         commands:
           # Apply patch from https://www.drupal.org/project/drupalci_testbot/issues/3251817
+          # @todo Remove this when Drupal 9.4.9 and 9.5.0 and 10.0.0 have been released.
           - "cd ${SOURCE_DIR} && sudo -u www-data curl https://www.drupal.org/files/issues/2021-11-30/3251817-4.run-tests-with-multiple-groups.patch | sudo -u www-data patch -p1 --verbose"
       csslint:
       eslint:
@@ -21,9 +22,9 @@ build:
           # Rule 3.0-alpha7 is not compatible with PHP8.1 but the dev version has been fixed.
           - "cd ${SOURCE_DIR} && sudo -u www-data composer require drupal/rules:3.x-dev"
           # Get workbench moderation modules when testing with Drupal 9.
-          # WBMA 1.0 cannot be installed with D9, so use * to allow the dev version.
-          - 'drush status | awk "NR==1{print \$2\$3\$4}"'
-          - 'drush status | awk "NR==1{print \$2\$3\$4}" | grep version:9 && sudo -u www-data composer require drupal/workbench_moderation:* drupal/workbench_moderation_actions:*'
+          # Use * because only the dev version of WBMA is compatible with D9.
+          - 'drush core:status | awk "NR==1{print \$2\$3\$4}"'
+          - 'drush core:status | awk "NR==1{print \$2\$3\$4}" | grep version:9 && sudo -u www-data composer require drupal/workbench_moderation drupal/workbench_moderation_actions:*'
           # Show the eslint version
           - "${SOURCE_DIR}/core/node_modules/.bin/eslint --version"
       run_tests.functional:

scheduler.install

@@ -78,6 +78,18 @@ function scheduler_install() {
     ->save();
 }
 
+/**
+ * Implements hook_uninstall().
+ */
+function scheduler_uninstall() {
+  // This should not be necessary but incase the entity db tables or config have
+  // got out-of-step with the Scheduler plugins make sure all is up to date so
+  // that uninstalling will run OK.
+  $scheduler_manager = \Drupal::service('scheduler.manager');
+  $scheduler_manager->entityUpdate();
+  $scheduler_manager->entityRevert();
+}
+
 /**
  * Reset date and time formats to default.
  */
@@ -228,13 +240,25 @@ function scheduler_update_8205() {
 /**
  * Remove Scheduler fields and third_party_settings for Paragraph entity types.
  */
-function scheduler_update_8206() {
-  $scheduler_manager = \Drupal::service('scheduler.manager');
+function scheduler_update_8207() {
+  // update_8206 had a typo, therefore replaced with update_8207.
   // Check the module is enabled, to avoid 'Unknown entity type' message.
-  if (\Drupal::moduleHandler()->moduleExists('paragraph') && ($result = $scheduler_manager->entityRevert(['paragraph']))) {
+  if (\Drupal::moduleHandler()->moduleExists('paragraphs') && ($result = \Drupal::service('scheduler.manager')->entityRevert(['paragraph']))) {
     return t('%updated.', ['%updated' => implode(', ', $result)]);
   }
   else {
-    return t('No Paragraph entity types require reverting.');
+    return t('No update required.');
+  }
+}
+
+/**
+ * Show/hide entity form fields to match Scheduling enabled/disabled settings.
+ */
+function scheduler_update_8208() {
+  if ($result = \Drupal::service('scheduler.manager')->resetFormDisplayFields()) {
+    return implode('</li><li>', $result);
+  }
+  else {
+    return t('No update required.');
   }
 }

scheduler.module

@@ -534,6 +534,9 @@ function _scheduler_entity_type_form_alter(&$form, FormStateInterface $form_stat
   ];
 
   $form['#entity_builders'][] = '_scheduler_form_entity_type_form_builder';
+
+  // Add a custom submit handler to adjust the fields in the form displays.
+  $form['actions']['submit']['#submit'][] = '_scheduler_form_entity_type_submit';
 }
 
 /**
@@ -554,6 +557,64 @@ function _scheduler_form_entity_type_form_builder($entity_type, $type, &$form, F
   $type->setThirdPartySetting('scheduler', 'unpublish_revision', $form_state->getValue('scheduler_unpublish_revision'));
 }
 
+/**
+ * Entity type form submit handler.
+ */
+function _scheduler_form_entity_type_submit($form, FormStateInterface $form_state) {
+  // Get the entity type id (node, media, taxonomy_term, etc.)
+  $entity_type_id = $form_state->getFormObject()->getEntity()->getEntityType()->getBundleOf();
+  // Get the entity bundle id (page, article, image, etc.)
+  $bundle_id = $form_state->getFormObject()->getEntity()->id();
+
+  /** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
+  $display_repository = \Drupal::service('entity_display.repository');
+
+  // Get all active display modes. getFormModes() returns the additional modes
+  // then add the default.
+  $all_display_modes = array_keys($display_repository->getFormModes($entity_type_id));
+  $all_display_modes[] = $display_repository::DEFAULT_DISPLAY_MODE;
+
+  $supported_display_modes = \Drupal::service('scheduler.manager')->getPlugin($entity_type_id)->entityFormDisplayModes();
+
+  // Each of the active form display modes may need to be adjusted to add or
+  // remove the scheduler fields depending on the 'enable' setting.
+  foreach ($all_display_modes as $display_mode) {
+    $form_display = $display_repository->getFormDisplay($entity_type_id, $bundle_id, $display_mode);
+
+    // If this bundle is not enabled for scheduled publishing or the form
+    // display mode is not supported then make sure the publish_on field is
+    // disabled in the form display.
+    if (!$form_state->getValue('scheduler_publish_enable') || !in_array($display_mode, $supported_display_modes)) {
+      $form_display->removeComponent('publish_on')->save();
+    }
+    // @todo Find a more robust way to detect that the checkbox was off before.
+    elseif (!$form['scheduler']['publish']['scheduler_publish_enable']['#default_value']) {
+      // If the entity bundle is now enabled for scheduled publishing but was
+      // not enabled before then set the publish_on field to be displayed and
+      // set the widget type to 'datetime_timestamp_no_default'. Only do this
+      // when the checkbox has been changed, because the widget could be altered
+      // or the field moved by a subsequent process or manually by admin.
+      $form_display->setComponent('scheduler_settings', ['weight' => 50])
+        ->setComponent('publish_on', ['type' => 'datetime_timestamp_no_default', 'weight' => 52])->save();
+    }
+
+    // Do the same for the unpublish_on field.
+    if (!$form_state->getValue('scheduler_unpublish_enable') || !in_array($display_mode, $supported_display_modes)) {
+      $form_display->removeComponent('unpublish_on')->save();
+    }
+    elseif (!$form['scheduler']['unpublish']['scheduler_unpublish_enable']['#default_value']) {
+      $form_display->setComponent('scheduler_settings', ['weight' => 50])
+        ->setComponent('unpublish_on', ['type' => 'datetime_timestamp_no_default', 'weight' => 54])->save();
+    }
+
+    // If the display mode is not supported then also remove the
+    // scheduler_settings group fieldset.
+    if (!in_array($display_mode, $supported_display_modes)) {
+      $form_display->removeComponent('scheduler_settings')->save();
+    }
+  }
+}
+
 /**
  * Form alter handling for Devel Generate forms.
  */
@@ -699,7 +760,7 @@ function scheduler_entity_base_field_info(EntityTypeInterface $entity_type) {
       ->setLabel(t('Publish on'))
       ->setDisplayOptions('form', [
         'type' => 'datetime_timestamp_no_default',
-        'weight' => 30,
+        'region' => 'hidden',
       ])
       ->setDisplayConfigurable('form', TRUE)
       ->setTranslatable(TRUE)
@@ -710,7 +771,7 @@ function scheduler_entity_base_field_info(EntityTypeInterface $entity_type) {
       ->setLabel(t('Unpublish on'))
       ->setDisplayOptions('form', [
         'type' => 'datetime_timestamp_no_default',
-        'weight' => 30,
+        'region' => 'hidden',
       ])
       ->setDisplayConfigurable('form', TRUE)
       ->setTranslatable(TRUE)
@@ -1016,11 +1077,11 @@ function scheduler_entity_extra_field_info() {
       $unpublishing_enabled = $type->getThirdPartySetting('scheduler', 'unpublish_enable', $config->get('default_unpublish_enable'));
 
       if ($publishing_enabled || $unpublishing_enabled) {
-        // Weight 20 puts this below the core fields by default.
+        // Weight 50 puts this below the core fields by default.
         $fields[$entityTypeId][$type->id()]['form']['scheduler_settings'] = [
           'label' => t('Scheduler Dates'),
           'description' => t('Fieldset containing Scheduler Publish-on and Unpublish-on date input fields'),
-          'weight' => 20,
+          'weight' => 50,
         ];
       }
     }
@@ -1175,6 +1236,11 @@ function scheduler_cache_flush() {
  * Implements hook_migrate_prepare_row().
  */
 function scheduler_migrate_prepare_row(Row $row, MigrateSourceInterface $source, MigrationInterface $migration) {
+  // getMigrationTags can return null for a custom migration, so skip these.
+  if (is_null($migration->getMigrationTags())) {
+    return;
+  }
+
   // Process node type third-party-settings.
   if (in_array('Scheduler Settings', $migration->getMigrationTags())) {
     $scheduler_config_name = [

src/SchedulerManager.php

@@ -15,6 +15,7 @@ use Drupal\Core\Entity\EntityInterface;
 use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\Core\Extension\ModuleHandlerInterface;
 use Drupal\Core\Link;
+use Drupal\Core\Messenger\MessengerInterface;
 use Drupal\Core\StringTranslation\StringTranslationTrait;
 use Drupal\Core\Url;
 use Psr\Log\LoggerInterface;
@@ -252,7 +253,7 @@ class SchedulerManager {
         $query->accessCheck(FALSE);
         // If the entity type is revisionable then make sure we look for the
         // latest revision. This is important for moderated entities.
-        if ($this->entityTypeManager->getDefinition($entityTypeId)->isRevisionable()) {
+        if ($plugin->entityTypeObject()->isRevisionable()) {
           $query->latestRevision();
         }
         $ids = $query->execute();
@@ -473,7 +474,7 @@ class SchedulerManager {
         $query->accessCheck(FALSE);
         // If the entity type is revisionable then make sure we look for the
         // latest revision. This is important for moderated entities.
-        if ($this->entityTypeManager->getDefinition($entityTypeId)->isRevisionable()) {
+        if ($plugin->entityTypeObject()->isRevisionable()) {
           $query->latestRevision();
         }
         $ids = $query->execute();
@@ -903,7 +904,7 @@ class SchedulerManager {
       // Avoid errors when an implementation of hook_scheduler_{type}_list has
       // added an id of the wrong type.
       if (!$entity = $storage->load($id)) {
-        $this->logger->notice('Entity id @id is not a @type entity. Processing skipped.', [
+        $this->logger->warning('Entity id @id is not a @type entity. Processing skipped.', [
           '@id' => $id,
           '@type' => $type,
         ]);
@@ -1001,15 +1002,15 @@ class SchedulerManager {
   /**
    * Get a plugin for a specific entity type.
    *
-   * @param string $entity_type
-   *   The entity type.
+   * @param string $entityTypeId
+   *   The entity type id, for example 'node' or 'media'.
    *
    * @return mixed
    *   The plugin object associated with a specific entity, or NULL if none.
    */
-  public function getPlugin($entity_type) {
+  public function getPlugin($entityTypeId) {
     $plugins = $this->getPlugins();
-    return $plugins[$entity_type] ?? NULL;
+    return $plugins[$entityTypeId] ?? NULL;
   }
 
   /**
@@ -1232,13 +1233,13 @@ class SchedulerManager {
         $view->set('_core', $core);
         $view->set('uuid', $uuid);
         $view->save();
-        $this->logger->notice('%view view updated.', ['%view' => $source['label']]);
+        $this->logger->info('%view view updated.', ['%view' => $source['label']]);
       }
       else {
         // The view does not exist in active storage so import it from source.
         $view = $view_storage->createFromStorageRecord($source);
         $view->save();
-        $this->logger->notice('%view view loaded from source.', ['%view' => $source['label']]);
+        $this->logger->info('%view view loaded from source.', ['%view' => $source['label']]);
       }
       $updated[] = $source['label'];
     }
@@ -1302,10 +1303,10 @@ class SchedulerManager {
           // If the field is marked as deleted then remove it.
           if ($change == $entityUpdateManager::DEFINITION_DELETED && $field = $entityUpdateManager->getFieldStorageDefinition($field_name, $entity_type_id)) {
             $entityUpdateManager->uninstallFieldStorageDefinition($field);
-            $output["$entity_type_id fields"] = $this->t('Scheduler fields removed from @entityType', [
+            $output["{$entity_type_id} fields"] = $this->t('Scheduler fields removed from @entityType', [
               '@entityType' => $entityType->getLabel(),
             ]);
-            $this->logger->notice('%field field removed from %entityType entity type', [
+            $this->logger->info('%field field removed from %entityType entity type', [
               '%field' => $field->getLabel(),
               '%entityType' => $entityType->getLabel(),
             ]);
@@ -1322,11 +1323,11 @@ class SchedulerManager {
           foreach (array_keys($third_party_settings) as $setting) {
             $bundle->unsetThirdPartySetting('scheduler', $setting)->save();
           }
-          $this->logger->notice('Scheduler settings removed from %entity %bundle', [
+          $this->logger->info('Scheduler settings removed from %entity %bundle', [
             '%entity' => $bundle->getEntityType()->getLabel(),
             '%bundle' => $bundle->label(),
           ]);
-          $output["{$bundle->id()} settings"] = $this->t('@bundle settings removed', [
+          $output["{$bundle->id()} settings"] = $this->t('Settings removed from @bundle', [
             '@bundle' => $bundle->label(),
           ]);
         }
@@ -1336,4 +1337,127 @@ class SchedulerManager {
     return $output;
   }
 
+  /**
+   * Reset the form display fields to match the Scheduler enabled settings.
+   *
+   * The Scheduler fields are disabled by default and only enabled in a form
+   * display when that entity bundle is enabled for scheduled publishing or
+   * unpublishing. See _scheduler_form_entity_type_submit() for details.
+   *
+   * This was a design change during the development of Scheduler 2.0 and any
+   * site that had installed Scheduler prior to 2.0-rc8 will have all fields
+   * enabled. Whilst this should not be a problem, it is preferrable to update
+   * the displays to match the scenario when the modules is freshly installed.
+   * Hence this function was added and called from scheduler_update_8208().
+   */
+  public function resetFormDisplayFields() {
+    /** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
+    $display_repository = \Drupal::service('entity_display.repository');
+    $fields_displayed = [];
+    $fields_hidden = [];
+
+    foreach ($this->getPlugins() as $entityTypeId => $plugin) {
+      // Get all active display modes. getFormModes() returns the additional
+      // modes then add the default.
+      $all_display_modes = array_keys($display_repository->getFormModes($entityTypeId));
+      $all_display_modes[] = $display_repository::DEFAULT_DISPLAY_MODE;
+
+      $supported_display_modes = $plugin->entityFormDisplayModes();
+
+      $bundles = $plugin->getTypes();
+      foreach ($bundles as $bundle_id => $bundle) {
+        foreach ($all_display_modes as $display_mode) {
+          $form_display = $display_repository->getFormDisplay($entityTypeId, $bundle_id, $display_mode);
+
+          foreach (['publish', 'unpublish'] as $value) {
+            $field = $value . '_on';
+            $setting = $value . '_enable';
+            // If this bundle is not enabled for scheduled (un)publishing or the
+            // form display mode is not supported then remove the field.
+            if (!$bundle->getThirdPartySetting('scheduler', $setting, FALSE) || !in_array($display_mode, $supported_display_modes)) {
+              $form_display->removeComponent($field)->save();
+              if ($display_mode == $display_repository::DEFAULT_DISPLAY_MODE) {
+                $fields_hidden[$field]["{$bundle->getEntityType()->getCollectionLabel()}"][] = $bundle->label();
+              }
+            }
+            else {
+              // Scheduling is enabled. Get the existing component to preserve
+              // any changed settings, but if the type is empty or set the to
+              // the core default 'datetime_timestamp' then change it to
+              // Scheduler's 'datetime_timestamp_no_default'.
+              $component = $form_display->getComponent($field);
+              if (empty($component['type']) || $component['type'] == 'datetime_timestamp') {
+                $component['type'] = 'datetime_timestamp_no_default';
+              }
+              $component['weight'] = ($field == 'publish_on' ? 52 : 54);
+              // Make sure the field and the settings group are displayed.
+              $form_display->setComponent('scheduler_settings', ['weight' => 50])
+                ->setComponent($field, $component)->save();
+              if ($display_mode == $display_repository::DEFAULT_DISPLAY_MODE) {
+                $fields_displayed[$field]["{$bundle->getEntityType()->getCollectionLabel()}"][] = $bundle->label();
+              }
+            }
+          }
+          // If the display mode is not supported remove the group fieldset.
+          if (!in_array($display_mode, $supported_display_modes)) {
+            $form_display->removeComponent('scheduler_settings')->save();
+          }
+        }
+      }
+    }
+
+    // It is not possible to determine whether a field on an enabled entity type
+    // had been manually hidden before this update. It is a rare scenario but
+    // inform the admin that there is potentially some manual work to do.
+    $uri = 'https://www.drupal.org/project/scheduler/issues/3320341';
+    $link = Link::fromTextAndUrl($this->t('Scheduler issue 3320341'), Url::fromUri($uri));
+    \Drupal::messenger()->addMessage($this->t(
+      'The Scheduler fields are now hidden by default and automatically changed to be displayed when an entity
+      bundle is enabled for scheduling. If you have previously manually hidden scheduler fields for enabled
+      entity types then these fields will now be displayed. You will need to manually hide them again or
+      implement hook_scheduler_hide_publish_date() or hook_scheduler_{TYPE}_hide_publish_date() and the
+      equivalent for unpublish_date. See @issue for details.',
+      ['@issue' => $link->toString()]), MessengerInterface::TYPE_STATUS, FALSE);
+    $this->logger->warning(
+      'The Scheduler fields are now hidden by default and automatically changed to be displayed when an entity
+      bundle is enabled for scheduling. If you have previously manually hidden scheduler fields for enabled
+      entity types then these fields will now be displayed. You will need to manually hide them again or
+      implement hook_scheduler_hide_publish_date() or hook_scheduler_{TYPE}_hide_publish_date() and the
+      equivalent for unpublish_date. See @issue for details.',
+      ['@issue' => $link->toString(), 'link' => $link->toString()]
+    );
+
+    /**
+     * Helper function to format the list of fields on bundles.
+     */
+    function formatOutputText($fields) {
+      return implode(', ', array_map(function ($name, $bundles) {
+        return "$name (" . implode(',', $bundles) . ")";
+      }, array_keys($fields), $fields));
+    }
+
+    $output = [];
+    if (isset($fields_displayed['publish_on'])) {
+      $output[] = $this->t('Publish On field displayed for: @list', [
+        '@list' => formatOutputText($fields_displayed['publish_on']),
+      ]);
+    }
+    if (isset($fields_displayed['unpublish_on'])) {
+      $output[] = $this->t('Unpublish On field displayed for: @list', [
+        '@list' => formatOutputText($fields_displayed['unpublish_on']),
+      ]);
+    }
+    if (isset($fields_hidden['publish_on'])) {
+      $output[] = $this->t('Publish On field hidden for: @list', [
+        '@list' => formatOutputText($fields_hidden['publish_on']),
+      ]);
+    }
+    if (isset($fields_hidden['unpublish_on'])) {
+      $output[] = $this->t('Unpublish On field hidden for: @list', [
+        '@list' => formatOutputText($fields_hidden['unpublish_on']),
+      ]);
+    }
+    return $output;
+  }
+
 }

src/SchedulerPluginBase.php

@@ -2,6 +2,7 @@
 
 namespace Drupal\scheduler;
 
+use Drupal\Core\Entity\EntityDisplayRepositoryInterface;
 use Drupal\Core\Plugin\PluginBase;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
@@ -17,6 +18,13 @@ abstract class SchedulerPluginBase extends PluginBase implements SchedulerPlugin
    */
   protected $entityTypeManager;
 
+  /**
+   * The entity type object for this plugin.
+   *
+   * @var Drupal\Core\Config\Entity\ConfigEntityType
+   */
+  protected $entityTypeObject;
+
   /**
    * A static cache of create/edit entity form IDs.
    *
@@ -37,6 +45,8 @@ abstract class SchedulerPluginBase extends PluginBase implements SchedulerPlugin
   public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
     $instance = new static($configuration, $plugin_id, $plugin_definition);
     $instance->entityTypeManager = $container->get('entity_type.manager');
+    $instance->entityTypeObject = $instance->entityTypeManager
+      ->getDefinition($plugin_definition['entityType']);
 
     return $instance;
   }
@@ -70,6 +80,16 @@ abstract class SchedulerPluginBase extends PluginBase implements SchedulerPlugin
     return $this->pluginDefinition['entityType'];
   }
 
+  /**
+   * Get the entity type object supported by this plugin.
+   *
+   * @return Drupal\Core\Config\Entity\ConfigEntityType
+   *   The entity type object.
+   */
+  public function entityTypeObject() {
+    return $this->entityTypeObject;
+  }
+
   /**
    * Get module dependency.
    *
@@ -159,9 +179,7 @@ abstract class SchedulerPluginBase extends PluginBase implements SchedulerPlugin
    *   The name of the type/bundle field for this entity type.
    */
   public function typeFieldName() {
-    return $this->entityTypeManager
-      ->getDefinition($this->entityType())
-      ->getKey('bundle');
+    return $this->entityTypeObject->getKey('bundle');
   }
 
   /**
@@ -171,12 +189,10 @@ abstract class SchedulerPluginBase extends PluginBase implements SchedulerPlugin
    *   The type/bundle objects, keyed by type/bundle name.
    */
   public function getTypes() {
-    $bundleDefinition = $this->entityTypeManager
-      ->getDefinition($this->entityType())
-      ->getBundleEntityType();
+    $bundleEntityType = $this->entityTypeObject->getBundleEntityType();
 
     return $this->entityTypeManager
-      ->getStorage($bundleDefinition)
+      ->getStorage($bundleEntityType)
       ->loadMultiple();
   }
 
@@ -199,9 +215,7 @@ abstract class SchedulerPluginBase extends PluginBase implements SchedulerPlugin
       return $this->entityTypeFormIds;
     }
 
-    $bundleEntityType = $this->entityTypeManager
-      ->getDefinition($this->entityType())
-      ->getBundleEntityType();
+    $bundleEntityType = $this->entityTypeObject->getBundleEntityType();
 
     return $this->entityTypeFormIds = $this->entityFormIdsByType($bundleEntityType, TRUE);
   }
@@ -258,4 +272,11 @@ abstract class SchedulerPluginBase extends PluginBase implements SchedulerPlugin
     return array_unique($ids);
   }
 
+  /**
+   * Return all supported entity form display modes.
+   */
+  public function entityFormDisplayModes() {
+    return [EntityDisplayRepositoryInterface::DEFAULT_DISPLAY_MODE];
+  }
+
 }

src/SchedulerPluginInterface.php

@@ -128,4 +128,21 @@ interface SchedulerPluginInterface {
    */
   public function entityTypeFormIds();
 
+  /**
+   * Return all supported entity edit form display modes.
+   *
+   * \Drupal\Core\Entity\EntityDisplayRepositoryInterface::DEFAULT_DISPLAY_MODE
+   * is the 'default' display mode and this is always supported. If there are no
+   * other supported modes then this function does not need to be implemented in
+   * the plugin. However if additional form display modes are provided by other
+   * modules and Scheduler has been updated to support these modes for editting
+   * the entity, then the plugin implementaion of this function should return
+   * all supported modes including 'default'. The implementation does not need
+   * to check if the third-party module is actually available or enabled.
+   *
+   * @return array
+   *   A list of entity form display mode ids.
+   */
+  public function entityFormDisplayModes();
+
 }

tests/src/Functional/SchedulerDevelGenerateTest.php

@@ -6,10 +6,6 @@ namespace Drupal\Tests\scheduler\Functional;
  * Tests the Scheduler interaction with Devel Generate module.
  *
  * @group scheduler
- * @group legacy
- * @todo Remove the 'legacy' tag when Devel no longer uses the deprecated
- * $published parameter for setPublished(), and does not use functions
- * drupal_set_message(), format_date() and db_query_range().
  */
 class SchedulerDevelGenerateTest extends SchedulerBrowserTestBase {
 

tests/src/Functional/SchedulerFieldsDisplayTest.php

@@ -7,6 +7,10 @@ use Drupal\Core\Url;
 /**
  * Tests the display of date entry fields and form elements.
  *
+ * @todo Extend these tests to cover form display processing when entity
+ * type is enabled/disabled.
+ * @see https://www.drupal.org/project/scheduler/issues/3320341
+ *
  * @group scheduler
  */
 class SchedulerFieldsDisplayTest extends SchedulerBrowserTestBase {
@@ -27,17 +31,7 @@ class SchedulerFieldsDisplayTest extends SchedulerBrowserTestBase {
    */
   public function testEntityTypeForm($entityTypeId, $bundle, $operation) {
     $this->drupalLogin($this->adminUser);
-    $entityType = $this->entityTypeObject($entityTypeId, $bundle);
-    $bundle_id = $entityType->bundle();
 
-    if ($operation == 'edit') {
-      $url = Url::fromRoute("entity.{$bundle_id}.edit_form", [$bundle_id => $bundle]);
-    }
-    else {
-      // The route for adding a 'node' entity type has a different format
-      // compared to the new standard for all other entity types.
-      $url = Url::fromRoute($entityTypeId == 'node' ? 'node.type_add' : "entity.{$bundle_id}.add_form");
-    }
     if ($operation == 'add first') {
       // Delete all the entity types for this bundle, to check that 'add'
       // works when it would be the first type being added.
@@ -45,6 +39,7 @@ class SchedulerFieldsDisplayTest extends SchedulerBrowserTestBase {
       $this->entityTypeObject($entityTypeId, 'non-enabled')->delete();
     }
 
+    $url = $this->adminUrl($operation == 'edit' ? 'bundle_edit' : 'bundle_add', $entityTypeId, $bundle);
     $this->drupalGet($url);
     $this->assertSession()->fieldExists('edit-scheduler-publish-enable');
     $this->assertSession()->fieldExists('edit-scheduler-unpublish-enable');
@@ -60,8 +55,8 @@ class SchedulerFieldsDisplayTest extends SchedulerBrowserTestBase {
     $types = $this->dataStandardEntityTypes();
     $data = [];
     foreach ($types as $key => $values) {
-      $data["$key-1"] = array_merge($values, ['add']);
-      $data["$key-2"] = array_merge($values, ['add first']);
+      $data["$key-1"] = array_merge($values, ['add first']);
+      $data["$key-2"] = array_merge($values, ['add']);
       $data["$key-3"] = array_merge($values, ['edit']);
     }
     return $data;

tests/src/Functional/SchedulerNonEnabledTypeTest.php

@@ -9,12 +9,22 @@ namespace Drupal\Tests\scheduler\Functional;
  */
 class SchedulerNonEnabledTypeTest extends SchedulerBrowserTestBase {
 
+  /**
+   * Additional core module field_ui is required for entity form display page.
+   *
+   * @var array
+   */
+  protected static $modules = ['field_ui'];
+
   /**
    * Tests the publish_enable and unpublish_enable entity type settings.
    *
    * @dataProvider dataNonEnabledScenarios()
    */
   public function testNonEnabledType($id, $entityTypeId, $bundle, $description, $publishing_enabled, $unpublishing_enabled) {
+    // Give adminUser the permissions to use the field_ui 'manage form display'
+    // tab for the entity type being tested.
+    $this->addPermissionsToUser($this->adminUser, ["administer {$entityTypeId} form display"]);
     $this->drupalLogin($this->adminUser);
     $entityType = $this->entityTypeObject($entityTypeId, $bundle);
     $storage = $this->entityStorageObject($entityTypeId);
@@ -23,6 +33,22 @@ class SchedulerNonEnabledTypeTest extends SchedulerBrowserTestBase {
     // The 'default' case specifically checks the behavior of the unchanged
     // settings, so only change these when not running the default test.
     if ($description != 'Default') {
+      // Set the enabled checkboxes via entity type admin form. This will also
+      // partially test the form display adjustments.
+      $this->drupalGet($this->adminUrl('bundle_edit', $entityTypeId, $bundle));
+      $edit = [
+        'scheduler_publish_enable' => $publishing_enabled,
+        'scheduler_unpublish_enable' => $unpublishing_enabled,
+      ];
+      $this->submitForm($edit, 'Save');
+
+      // Show the form display page for info.
+      $this->drupalGet($this->adminUrl('bundle_form_display', $entityTypeId, $bundle));
+
+      // ThirdPartySettings are set correctly by saving the entity type form,
+      // however this does not get replicated back to $entityType here (is this
+      // a bug is core test traits somewhere?). Thwerefore resort to setting the
+      // values here too.
       $entityType->setThirdPartySetting('scheduler', 'publish_enable', $publishing_enabled)
         ->setThirdPartySetting('scheduler', 'unpublish_enable', $unpublishing_enabled)
         ->save();

tests/src/Traits/SchedulerCommerceProductSetupTrait.php

@@ -94,6 +94,14 @@ trait SchedulerCommerceProductSetupTrait {
       ->setThirdPartySetting('scheduler', 'unpublish_enable', TRUE)
       ->save();
 
+    // Enable the scheduler fields in the default form display, mimicking what
+    // would be done if the entity bundle had been enabled via admin UI.
+    $this->container->get('entity_display.repository')
+      ->getFormDisplay('commerce_product', $this->productTypeName)
+      ->setComponent('publish_on', ['type' => 'datetime_timestamp_no_default'])
+      ->setComponent('unpublish_on', ['type' => 'datetime_timestamp_no_default'])
+      ->save();
+
     // Add the body field using the existing commerce_product function.
     commerce_product_add_body_field($this->productType);
 

tests/src/Traits/SchedulerMediaSetupTrait.php

@@ -79,6 +79,14 @@ trait SchedulerMediaSetupTrait {
       ->setThirdPartySetting('scheduler', 'unpublish_enable', TRUE)
       ->save();
 
+    // Enable the scheduler fields in the default form display, mimicking what
+    // would be done if the entity bundle had been enabled via admin UI.
+    $this->container->get('entity_display.repository')
+      ->getFormDisplay('media', $this->mediaTypeName)
+      ->setComponent('publish_on', ['type' => 'datetime_timestamp_no_default'])
+      ->setComponent('unpublish_on', ['type' => 'datetime_timestamp_no_default'])
+      ->save();
+
     // Create a test media type for audio which is not enabled for scheduling.
     /** @var \Drupal\media\Entity\MediaTypeInterface $nonSchedulerMediaType */
     $this->nonSchedulerMediaType = $this->createMediaType('audio_file', [

tests/src/Traits/SchedulerSetupTrait.php

@@ -131,6 +131,14 @@ trait SchedulerSetupTrait {
       ->setThirdPartySetting('scheduler', 'unpublish_enable', TRUE)
       ->save();
 
+    // Enable the scheduler fields in the default form display, mimicking what
+    // would be done if the entity bundle had been enabled via admin UI.
+    $this->container->get('entity_display.repository')
+      ->getFormDisplay('node', $this->type)
+      ->setComponent('publish_on', ['type' => 'datetime_timestamp_no_default'])
+      ->setComponent('unpublish_on', ['type' => 'datetime_timestamp_no_default'])
+      ->save();
+
     // The majority of tests use the standard Scheduler-enabled content type but
     // we also need a content type which is not enabled for Scheduler.
     $this->nonSchedulerNodeType = $this->drupalCreateContentType([
@@ -479,10 +487,10 @@ trait SchedulerSetupTrait {
   }
 
   /**
-   * Returns the url for a specified page and entity type.
+   * Returns the url for a specified page, entity type and optionally bundle.
    *
    * @param string $page
-   *   The page required - 'collection', 'scheduled' or 'generate'.
+   *   The page required - 'collection', 'scheduled', 'generate', etc.
    * @param string $entityTypeId
    *   The machine id of the entity type - 'node', 'media', 'commerce_product'.
    * @param string $bundle
@@ -492,28 +500,38 @@ trait SchedulerSetupTrait {
    *   The url for the required page.
    */
   public function adminUrl($page, $entityTypeId, $bundle = NULL) {
-    // @todo Could be changed to use a route and parameter like entityAddUrl().
+    // $bundle_id will be 'node_type', 'media_type', 'commerce_product_type',
+    // 'taxonomy_vocabulary' etc.
+    $bundle_id = $this->container->get('entity_type.manager')->getDefinition($entityTypeId)->getBundleEntityType();
+
     $urls = [
       'collection' => [
-        'node' => 'admin/content',
-        'media' => 'admin/content/media',
-        'commerce_product' => 'admin/commerce/products',
-        'taxonomy_term' => "admin/structure/taxonomy/manage/$bundle/overview",
+        'node' => Url::fromRoute('system.admin_content'),
+        'taxonomy_term' => Url::fromRoute('entity.taxonomy_vocabulary.overview_form', [$bundle_id => $bundle]),
+        'default' => Url::fromRoute("entity.{$entityTypeId}.collection"),
       ],
       'scheduled' => [
-        'node' => 'admin/content/scheduled',
-        'media' => 'admin/content/media/scheduled',
-        'commerce_product' => 'admin/commerce/products/scheduled',
-        'taxonomy_term' => 'admin/structure/taxonomy/scheduled',
+        'node' => Url::fromRoute('view.scheduler_scheduled_content.overview'),
+        'default' => Url::fromRoute("view.scheduler_scheduled_{$entityTypeId}.overview"),
       ],
       'generate' => [
-        'node' => 'admin/config/development/generate/content',
-        'media' => 'admin/config/development/generate/media',
-        'taxonomy_term' => 'admin/config/development/generate/term',
+        'node' => Url::fromRoute('devel_generate.content'),
+        'media' => Url::fromRoute('devel_generate.media'),
+        'taxonomy_term' => Url::fromRoute('devel_generate.term'),
+      ],
+      'bundle_add' => [
+        'node' => Url::fromRoute('node.type_add'),
+        'default' => Url::fromRoute("entity.{$bundle_id}.add_form"),
+      ],
+      'bundle_edit' => [
+        'default' => Url::fromRoute("entity.{$bundle_id}.edit_form", [$bundle_id => $bundle]),
+      ],
+      'bundle_form_display' => [
+        'default' => Url::fromRoute("entity.entity_form_display.{$entityTypeId}.default", [$bundle_id => $bundle]),
       ],
     ];
 
-    $url = $urls[$page][$entityTypeId] ?? NULL;
+    $url = $urls[$page][$entityTypeId] ?? ($urls[$page]['default'] ?? NULL);
     if (empty($url)) {
       // Incorrect parameter values.
       throw new \Exception(sprintf('Unrecognised combination of page "%s", entityTypeId "%s" and bundle "%s" passed to adminUrl()', $page, $entityTypeId, $bundle));

tests/src/Traits/SchedulerTaxonomyTermSetupTrait.php

@@ -79,6 +79,14 @@ trait SchedulerTaxonomyTermSetupTrait {
       ->setThirdPartySetting('scheduler', 'unpublish_enable', TRUE)
       ->save();
 
+    // Enable the scheduler fields in the default form display, mimicking what
+    // would be done if the entity bundle had been enabled via admin UI.
+    $this->container->get('entity_display.repository')
+      ->getFormDisplay('taxonomy_term', $this->vocabularyId)
+      ->setComponent('publish_on', ['type' => 'datetime_timestamp_no_default'])
+      ->setComponent('unpublish_on', ['type' => 'datetime_timestamp_no_default'])
+      ->save();
+
     // Create a vocabulary which is not enabled for scheduling.
     /** @var \Drupal\taxonomy\VocabularyInterface $nonSchedulerVocabulary */
     $this->nonSchedulerVocabulary = Vocabulary::create([