Use a link to a resource in Instance detail page

@xiahua-guan,

If possible, could you please setup fieldsets as follows?

Instance
- Instance ID
- Instance State
- Instance Type
- AMI ID
- Virtualization
- Reservation
- Owner
- Launch Time

Network
- Public IP
- Private IPs
- Public DNS
- Private DNS
- Security Groups
- Key Pair Name
- VPC ID
- Subnet ID
- Availability Zone

Storage
- Root Device Type
- Root Device
- EBS Optimized

Options
- Monitoring
- AMI Launch Index
- Tenancy

Others (fieldsets closed)
- Authored by

@xiaohua-guan,

Yes, that's fine to setup for edit form page.

@xiaohua-guan,

Thank you for the patch!

In the detail page:

1. Could you please re-order each items like my comment #2 ?

In the edit form:

1. Also, could you follow the order of my comment #2 ?
2. Can you switch Network and Options?
3. Key Pair Name: [Key Pair Name] <= Put a colon and a while space in between the label and the link
4. And extra, can you add Instance ID above Name in Instance fieldset? (maybe we should put this as another issue)

@xiaohua-guan,

Thank you for the updated patch. I tried and tested it; it looks pretty good. One thing that I noticed is that as for entity_link_renderer, it looks quite generic service, therefore I assume that the namespace Drupal\cloud is the better place?

@baldwinlouie

How do you think about this patch other than my comment above?

@xiaohua-guan, @yas, Looks like a good patch! Below are my comments.

1. +++ b/modules/cloud_service_providers/aws_cloud/src/Form/Ec2/AwsCloudContentForm.php
   @@ -40,7 +50,8 @@ class AwsCloudContentForm extends CloudContentForm {
   +      $container->get('entity.repository'),
   +      $container->get('entity_link_renderer')
   

   Can "entity_link_renderer" follow the other services and look something like "entity.link_renderer"

2. +++ b/modules/cloud_service_providers/aws_cloud/src/Plugin/Field/FieldFormatter/EntityLinkFormatter.php
   @@ -0,0 +1,96 @@
   +      $element[$delta] = \Drupal::service('entity_link_renderer')
   +        ->renderViewElement($value, $target_type, $field_name);
   

   Can the "entity_link_renderer" be injected into the class using dependency injection?

3. +++ b/modules/cloud_service_providers/aws_cloud/src/Service/EntityLinkRenderer.php
   @@ -0,0 +1,106 @@
   +        $htmls[] = $this->linkGenerator->generate(
   +          $value,
   +          Url::fromRoute(
   +            "entity.$target_type.canonical",
   +            [
   +              'cloud_context' => $cloud_context,
   +              $target_type => array_values($entity_ids)[0],
   +            ]
   +          )
   +        );
   

   Since this is a fairly generic service, can we pass query parameters into the renderViewElement method and have them render with the Url?

   We might not need this at the moment, but if someone wants to use the service, it should be able to handle query parameters.

@xiaohua-guan,

Could you please refer to the following code for my comment for request #2 ?

The code can show fieldsets. Furthermore, I think you can find a way to generalize the class or its logic. Also, I'm afraid that it cannot show the multiple value such as Security Groups? (Maybe still needs to be improved -- by creating Ec2BaseViewBuilder as the parent class of InstanceViewBuilder)

cloud/modules/cloud_service_providers/aws_cloud/src/Entity/Ec2/Instance.php

/**
 * Defines the Instance entity.
 *
 * @ingroup aws_cloud
 *
 * @ContentEntityType(
 *   id = "aws_cloud_instance",
 *   label = @Translation("AWS Cloud Instance"),
 *   handlers = {
 *     "view_builder" = "Drupal\aws_cloud\Entity\Ec2\InstanceViewBuilder"    ,
 *     "list_builder" = "Drupal\aws_cloud\Controller\Ec2\InstanceListBuilder",
 *     "views_data"   = "Drupal\aws_cloud\Entity\Ec2\InstanceViewsData"      ,
 *
...

cloud/modules/cloud_service_providers/aws_cloud/src/Entity/Ec2/InstanceViewBuilder.php

// Created by yas 2019/01/07.
namespace Drupal\aws_cloud\Entity\Ec2;

use Drupal\Core\Entity\EntityViewBuilder;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Render\Element;

/**
 * Provides the views data for the CloudScripting entity type.
 */
class InstanceViewBuilder extends EntityViewBuilder {

  /**
   * {@inheritdoc}
   */
  public function view(EntityInterface $entity, $view_mode = 'full', $langcode = NULL) {

    $fieldset_defs = [
      [
        'name' => 'instance', 'title' => t('Instance'), 'open' => TRUE,
        'fields' => [
          'instance_id',
          'name',
          'instance_type',
          'instance_state',
          'image_id',
          'virtualization',
          'reservation',
          'owner',
          'launch_time',
        ],
      ],
      [
        'name' => 'network', 'title' => t('Network'), 'open' => TRUE,
        'fields' => [
          'public_ip',
          'private_ips',
          'public_dns',
          'security_groups',
          'key_pair_name',
          'vpc_id',
          'subnet_id',
          'availability_zone',
        ],
      ],
      [
        'name' => 'storage', 'title' => t('Storage'), 'open' => TRUE,
        'fields' => [
          'root_device_type',
          'root_device',
          'ebs_optimized',
        ],
      ],
      [
        'name' => 'options', 'title' => t('Options'), 'open' => TRUE,
        'fields' => [
          'is_monitoring',
          'ami_launch_index',
          'tenancy',
        ],
      ],
    ];
  
    $weight = -50;
    foreach ($fieldset_defs as $fieldset_def) {
      $fieldset_name = $fieldset_def['name'];
      $build[$fieldset_name] = [
        '#type' => 'details',
        '#title' => $fieldset_def['title'],
        '#weight' => $weight++,
        '#tree' => TRUE,
        '#open' => $fieldset_def['open'],
      ];
  
      $params = [];
      foreach ($fieldset_def['fields'] as $field_name) {
        $params[$field_name] = $entity->get($field_name);
      }
  
      $params['user_id'] = NULL;
      $instance = Instance::create($params);
      $build[$fieldset_name][] = parent::view($instance, $view_mode, $langcode);
    }
  
    $build['others'] = [
      '#type' => 'details',
      '#title' => 'Others',
      '#tree' => TRUE,
      '#open' => FALSE,
      '#weight' => $weight++,
    ];

    $instance = Instance::create([]);
    $build['others'][] = parent::view($instance, $view_mode, $langcode);
  
    return $build;
  }

}

@xiaohua-guan,

1. In InstanceEditForm , I suggest the following:

  public function buildForm(array $form, FormStateInterface $form_state, $cloud_context = '') {
    /* @var $entity \Drupal\aws_cloud\Entity\Ec2\Instance */
    $form = parent::buildForm($form, $form_state);

    $entity = $this->entity;

    $weight = -50;

    $form['instance'] = [
      '#type' => 'details',
      '#title' => $this->t('Instance'),
      '#open' => TRUE,
      '#weight' => $weight++,
    ];

    $form['instance']['name'] = [
      '#type'          => 'textfield',
      '#title'         => $this->t('Name'),
      '#maxlength'     => 255,
      '#size'          => 60,
      '#default_value' => $entity->label(),
      '#required'      => FALSE,
    ];

    $form['instance']['instance_id'] = [
      '#type'          => 'item',
      '#title'         => $this->t('Instance ID: '),
      '#maxlength'     => 255,
      '#size'          => 60,
      '#markup'        => $entity->getInstanceId(),
      '#required'      => FALSE,
      '#attributes'    => ['readonly' => 'readonly'],
      '#disabled'      => TRUE,
    ];

    $form['instance']['instance_type'] = [
      '#type'          => 'select',
      '#title'         => $this->t('Instance Type'),
      '#wrapped_label' => TRUE,
      '#default_value' => $entity->getInstanceType(),
      '#required'      => FALSE,
      '#options'       => $this->getInstanceTypeOptions(),
    ];

    if ($entity->getInstanceState() !== 'stopped') {
      $form['instance']['instance_type'] += [
        '#attributes'  => ['readonly' => 'readonly'],
        '#disabled'    => TRUE,
      ];
    }

    $form['instance']['image_id'] = [
      '#type'          => 'item',
      '#title'         => $this->t('AMI Image: '),
      '#markup'        => $entity->getImageId(),
      '#required'      => FALSE,
      '#attributes'    => ['readonly' => 'readonly'],
      '#disabled'      => TRUE,
    ];

    $form['instance']['kernel_id'] = [
      '#type'          => 'item',
      '#title'         => $this->t('Kernel Image: '),
      '#markup'        => $entity->getKernelId(),
      '#required'      => FALSE,
      '#attributes'    => ['readonly' => 'readonly'],
      '#disabled'      => TRUE,
    ];

    $form['instance']['ramdisk_id'] = [
      '#type'          => 'item',
      '#title'         => $this->t('Ramdisk Image: '),
      '#markup'        => $entity->getRamdiskId(),
      '#required'      => FALSE,
      '#attributes'    => ['readonly' => 'readonly'],
      '#disabled'      => TRUE,
    ];

    $form['network'] = [
      '#type' => 'details',
      '#title' => $this->t('Network'),
      '#open' => TRUE,
      '#weight' => $weight++,
    ];

    $form['network']['security_groups'] = [
      '#type'          => 'select',
      '#title'         => $this->t('Security Groups'),
      '#default_value' => explode(self::SECURITY_GROUP_DELIMITER,
                                  $entity->getSecurityGroups()),
      '#required'      => TRUE,
      '#multiple'      => TRUE,
      '#options'       => $this->getSecurityGroupsOptions(),
    ];
    $this->entityLinkRenderer->renderFormElements(
      $entity->getKeyPairName(),
      'aws_cloud_key_pair',
      'key_pair_name',
      $form['network'],
      ['#title' => $this->t('Key Pair Name: ')],
      'key_pair_name'
    );

    $form['network']['availability_zone'] = [
      '#type'          => 'item',
      '#title'         => $this->t('Availability Zone: '),
      '#markup'        => $entity->getAvailabilityZone(),
      '#attributes'    => ['readonly' => 'readonly'],
      '#disabled'      => TRUE,
    ];

    $form['options'] = [
      '#type'          => 'details',
      '#title'         => $this->t('Options'),
      '#open'          => TRUE,
      '#weight'        => $weight++,
    ];

    $form['options']['user_data'] = [
      '#type'          => 'textarea',
      '#title'         => $this->t('User Data'),
      '#maxlength'     => 4096,
      '#cols'          => 60,
      '#rows'          => 3,
      '#default_value' => $entity->getUserData(),
      '#required'      => FALSE,
      '#attributes'    => ['readonly' => 'readonly'],
      '#disabled'      => TRUE,
      '#weight'        => $weight++,
    ];

    $form['options']['is_monitoring'] = [
      '#type'          => 'item',
      '#title'         => $this->t('Monitoring Enabled: '),
      '#markup'        => $entity->isMonitoring()
                        ? $this->t('Enabled') : $this->t('Disabled'),
      '#weight'        => $weight++,
    ];

    $form['options']['login_username'] = [
      '#type'          => 'textfield',
      '#title'         => $this->t('Login Username'),
      '#size'          => 60,
      '#default_value' => $entity->getLoginUsername() ?: 'ec2-user',
      '#weight'        => $weight++,
      '#required'      => FALSE,
    ];

    // Set a message for termination timestamp.
    $date_format = DateFormat::load('html_date')->getPattern();
    $time_format = DateFormat::load('html_time')->getPattern();

    $form['termination_timestamp']['widget'][0]['value']['#description']
      = $this->t('Format: %format. Leave blank for no automatic termination.',
                        ['%format' =>
                          Datetime::formatExample($date_format . ' ' . $time_format)
                        ]
      );
    $form['termination_timestamp']['#weight'] = $weight++;
    $form['options']['termination_timestamp'] = $form['termination_timestamp'];
    unset($form['termination_timestamp']);

    $schedule = $entity->getSchedule();
    $form['options']['schedule'] = [
      '#title' => t('Schedule'),
      '#type' => 'select',
      '#default_value' => isset($schedule) ? $entity->getSchedule() : '',
      '#options'       => aws_cloud_get_schedule(),
      '#description'   => t('Specify a start/stop schedule. This helps reduce server hosting costs.'),
      '#weight'        => $weight++,
    ];

    $form['others'] = [
      '#type'          => 'details',
      '#title'         => $this->t('Others'),
      '#open'          => FALSE,
      '#weight'        => $weight++,
    ];

    $form['others']['cloud_context'] = [
      '#type'          => 'item',
      '#title'         => $this->t('Cloud ID: '),
      '#markup'        => !$entity->isNew()
        ? $entity->getCloudContext()
        : $cloud_context,
    ];

    $form['others']['langcode'] = [
      '#title'         => t('Language'),
      '#type'          => 'language_select',
      '#default_value' => $entity->getUntranslated()->language()->getId(),
      '#languages'     => Language::STATE_ALL,
      '#attributes'    => ['readonly' => 'readonly'],
      '#disabled'      => FALSE,
    ];

    $form['others']['user_id'] = $form['user_id'];
    unset($form['user_id']);

    $form['actions'] = $this->actions($form, $form_state, $cloud_context);
    $form['actions']['#weight'] = $weight++;

    return $form;
  }

2. In my comment #19 No.3, In the edit form,

3. Key Pair Name: [Key Pair Name] <= Put a colon and a while space in between the label and the link

Please find the attached screen shot. I searched Google a lot but I couldn't find the solution, though.

3. In EntityLinkRenderer , let's align with renderFormElements

  public function renderViewElement(
    $value,
    $target_type,
    $field_name) {

4. In my comment #22,

One thing that I noticed is that as for entity_link_renderer , it looks quite generic service, therefore I assume that the namespace Drupal\cloud is the better place?

5. In EntityLinkFormatter ,

FROM:

* Constructs a EntityLinkFormatter instance.

TO:

* Constructs an EntityLinkFormatter instance.

@xiaohua-guan,

Thank you for the updated patch, it looks fairly good！

1. Correct me if I'm wrong, did you also move EntityLinkRenderer into cloud module?
2. Please put a colon (:) at Login Username in the form.

@xiaohua-guan,

One thing that I noticed is that it shows Monitoring: Off in the Instance detail view page, which is expected Monitoring: Disabled like in Instance Edit Page, that includes explicitly implemented, however it can be refactored later.

I'll merge the updated patch. Thank you for your hard work!