Contrib.social

Provide relevant tokens to migrate events

Open on Drupal.org →
Created on 21 July 2023, 11 months ago
Updated 5 June 2024, 25 days ago

Problem/Motivation

The `migrate` ECA sub-module provides useful migration related events, but it doesn't appear that the relevant migration data is exposed as tokens. Things like information about the running migration, the migration row being processed, and the migrate message being saved, are some examples.

Proposed resolution

Exposed relative migration data as tokens for migration events.

Remaining tasks

N/A

User interface changes

N/A

API changes

N/A

Data model changes

N/A

✨ Feature request
Status

Fixed

Version

2.0

Component

Code

Created by

🇺🇸United States PCate

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @PCate
  • Comment 11 months ago →
    🇩🇪Germany jurgenhaas Gottmadingen

    Can we get a list of tokens for each event? That's required to move forward with this one.

  • Comment 4 months ago →
    🇩🇪Germany jurgenhaas Gottmadingen

    @PCate I'd be happy to address this for the forthcoming ECA 2 release. However, I'd need your help as I don't have an overview of which data would be required for which of the migration events. Could you please provide me with some input on this?

  • Comment 4 months ago →
    🇺🇸United States PCate

    @jurgenhaas happy to help if I can. Would something like the following be helpful?

    Name: migrate.pre_import
    Description: Fired when beginning a migration import operation.
    Tokens:
    migration: The migration entity being run.

    Name: migrate.idmap_message
    Description: Fired when saving a message to the ID map.
    Tokens:
    migration: The migration entity being run.
    source_id_values: The source ID values.
    message: The message to be logged.
    level: The severity level of the message.

    If this is the information you are looking for, I should be able to provide a list of these.

  • Comment 4 months ago →
    🇩🇪Germany jurgenhaas Gottmadingen

    @PCate yes, that looks like what's needed. I guess, most of the "tokens" are read-only and a few (e.g. "row") might be modifiable, right?

  • Comment 2 months ago →
    🇺🇸United States PCate

    @jurgenhaas below is the list of relevent tokens/events.

    Name: migrate.pre_import
    Description: Fired when beginning a migration import
    operation.
    Tokens:
    • migration: The migration entity being run.

    Name: migrate.post_import
    Description: Fired when finishing a migration import
    operation.
    Tokens:
    • migration: The migration entity being run.

    Name: migrate.map_save
    Description: Fired when saving to a migration's map.
    Tokens:
    • map: The map plugin that caused the event to fire.
    • fields: Array of map fields, keyed by field name.

    Name: migrate.map_delete
    Description: Fired when removing an entry from a
    migration's map.
    Tokens:
    • map: The map plugin that caused the event to fire.
    • source_id: The source ID values.

    Name: migrate.pre_row_save
    Description: Fired when about to import a single item.
    Tokens:
    • migration: The migration entity being run.
    • row: The row about to be imported.

    Name: migrate.post_row_save
    Description: Fired just after a single item has been
    imported.
    Tokens:
    • migration: The migration entity being run.
    • row: The row just saved.
    • destination_id_values: The row's destination ID.

    Name: migrate.pre_rollback
    Description: Fired when beginning a migration rollback
    operation.
    Tokens:
    • migration: The migration entity that will be rolled back.

    Name: migrate.post_rollback
    Description: Fired when finishing a migration rollback
    operation.
    Tokens:
    • migration: The migration entity that was just rolled
      back.

    Name: migrate.pre_row_delete
    Description: Fired when about to delete a single item.
    Tokens:
    • migration: The migration entity that was just rolled
      back.
    • row: The row to be deleted.

    Name: migrate.post_row_delete
    Description: Fired just after a single item has been
    deleted.
    Tokens:
    • migration: The migration entity being run.
    • destination_id_values: The row's destination ID.

    Name: migrate.idmap_message
    Description: Fired when saving a message to the ID map.
    Tokens:
    • migration: The migration entity being run.
    • source_id_values: The source ID values.
    • message: The message to be logged.
    • level: The severity level of the message.
  • Comment 2 months ago →
    🇺🇸United States PCate

    I guess, most of the "tokens" are read-only and a few (e.g. "row") might be modifiable, right?

    @jurgenhaas, I would expect the "pre/save" events would have modifiable tokens, but the "post/delete" ones would not?

  • Comment 2 months ago →
    🇩🇪Germany jurgenhaas Gottmadingen

    I would expect the "pre/save" events would have modifiable tokens, but the "post/delete" ones would not?

    That sounds reasonable, yes.

  • Comment 2 months ago →
    🇩🇪Germany jurgenhaas Gottmadingen
  • Comment about 1 month ago →
    System Message
    • jurgenhaas → committed 95345be8 on 2.0.x 
      Issue #3376172 by PCate, jurgenhaas: Provide relevant tokens to migrate...
  • Status changed to Needs review about 1 month ago
  • Comment about 1 month ago →
    🇩🇪Germany jurgenhaas Gottmadingen

    I have implemented support for those tokens, please review.

  • Status changed to RTBC about 1 month ago
  • Comment about 1 month ago →
    🇩🇪Germany danielspeicher Steisslingen

    Works perfectly fine.

  • Status changed to Fixed about 1 month ago
  • Comment about 1 month ago →
    🇩🇪Germany jurgenhaas Gottmadingen

    Perfect, thank you. Now we're down to just 1 issue before we can go beta ;-) I'm on it.

  • Comment 25 days ago →
    System Message

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

contrib.social Blog FAQ Discussions
Production build 0.69.0 2024