possible issues with token caching

Here is a scenario where the vid token value is not updating correctly.

I'm using the workflow_ng configuration found at http://drupal.org/node/204277.

When the action is fired, the user is redirected the second to last revision instead of the newly created one. I traced the code and found that the token list was compiled prior to the new revision being saved. When the "redirect to page" action is fired, even though the node object now has the new vid, the previous vid is used instead.

I found a fix by adding
token_get_values('global', NULL, TRUE);

to revision_moderation_nodeapi(), which seemed to do the trick.

(snippet)

  // Only do this logic for non-admin users on nodes with revision moderation
  // turned on.
  if ($node->nid && $node->revision_moderation == 1 && (!user_access('administer nodes') || !variable_get('revision_moderation_exempt', 1))) {
    switch ($op) {
      case 'prepare':
        ...
      case 'submit':
        ...
      case 'update':
        if (isset($node->original_node)) {
          // Update node table's vid to the original value.
          db_query("UPDATE {node} SET vid = %d, title = '%s', status = %d, moderate = %d WHERE nid = %d", $node->original_node->vid, $node->original_node->title, $node->original_node->status, $node->original_node->moderate, $node->nid);
          drupal_set_message(t('Your changes have been submitted for moderation.'));
        }

        //update token list so the vid token has the latest vid value
        token_get_values('global', NULL, TRUE);     

        break;
    }
  }

That solved my problem, but I realize there might be a better way.

Wouldn't this be up to the developer who is integrating workflow_ng into their module?

Providing a "clear token cache" action would require the user/admin to know that tokens are cached and that the problem they are encountering is a caching issue. In my humble opinion, the casual site admin (ie non-drupal developer) shouldn't be expected to deal with this kind of quirk.

I feel like this should be up to the module developers to be aware of the token cache and realize that if one of their tokens change half way, they'll need to update the token cache.

I guess we need the module developers who have integrated workflow_ng/tokens to weigh in. Come forth ye who write modules.

Subscribing.