Problem/Motivation

Sometimes it is useful to get all the debugging information this module provides, but sometimes I want to debug the processing of just one field. This module gives me too much information (all the other fields) and not enough (only the source values for the process pipeline).

I sometimes want to see what is happening during each step in the process pipeline for a single field.

Proposed resolution

Add a debug process plugin, similar to the log plugin provided by core. Instead of saving messages, show them with print_r(). Then I can debug my process pipelines by adding

-
  plugin: debug

as needed.

This has a few advantages over using the core log plugin:

  • Using print_r() handles both arrays and strings gracefully.
  • It is easier to distinguish debugging code that should be removed from logging code that should stay.
  • It saves a step: no need to use drush mmsg my_migration to see the messages.

Remaining tasks

User interface changes

None

API changes

None

Data model changes

None

CommentFileSizeAuthor
#5 3021648-migrate_devel-plugin-5.patch3.54 KBbenjifisher
#5 interdiff-3021648-2-5.txt1.61 KBbenjifisher
#2 3021648-migrate_devel-plugin-2.patch3.22 KBbenjifisher

Comments

benjifisher created an issue. See original summary.

benjifisher’s picture

benjifisher
he/him or they/them
Primary language English
Location Boston area
commented
Assigned: benjifisher » Unassigned
Status: Active » Needs review
StatusFileSize
new 3021648-migrate_devel-plugin-2.patch3.22 KB

Here is a patch with the plugin I have been using. I just added the multiple option and have not tested it, yet.

selwynpolit’s picture

selwynpolit commented

@benjifisher, this seems like a very useful plugin. I noticed one small issue. The namespace line should be:

namespace Drupal\migrate_devel\Plugin\migrate\process;

Also I found it useful to add a little more to the output so the person using the plugin could clearly identify the "debug output: " 

  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
    print("debug output: ");
    print_r($value);
    if (!is_array($value)) {
      print_r(PHP_EOL);
    }

    return $value;
  }
selwynpolit’s picture

selwynpolit commented
Status: Needs review » Needs work
benjifisher’s picture

benjifisher
he/him or they/them
Primary language English
Location Boston area
commented
Status: Needs work » Needs review
StatusFileSize
new interdiff-3021648-2-5.txt1.61 KB
new 3021648-migrate_devel-plugin-5.patch3.54 KB

@selwynpolit:

Oops, thanks for catching the namespace problem.

Good idea for adding a label. Let's make it more flexible by adding a new (optional) label parameter. Then you can leave it off if you do not care, or distinguish between different steps in the pipeline (if you are adding the debug plugin in more than one place).

I have attached an updated patch.

selwynpolit’s picture

selwynpolit commented

@benjifisher That works great. I like the customizable label option.

selwynpolit’s picture

selwynpolit commented
Status: Needs review » Reviewed & tested by the community

  • Derimagia committed 4984acb on 8.x-1.x authored by benjifisher 
    Issue #3021648 by benjifisher, selwynpolit: Add a migrate plugin to...
Derimagia’s picture

Derimagia commented
Status: Reviewed & tested by the community » Fixed

Thanks - Sorry for the delay, commited

benjifisher’s picture

benjifisher
he/him or they/them
Primary language English
Location Boston area
commented

@Derimagia:

No worries. Thanks for the module!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.