Extend P4 Code Review to use P4 Search

Standard P4 Code Review searches can be extended to search file content and changelist description by using the P4 Search API.

Configure P4 Code Review search to use your P4 Search service with the following configuration block in the SWARM_ROOT/data/config.php file:

<?php
    // this block should be a peer of 'p4'
    'search' => array(
        'p4_search_host'  => 'http://myp4search.mydomain.com:1601', // optional URL to P4 Search host
        'maxlocktime'     => 5000, // 5 seconds, in milliseconds
    ),

p4_search_host

The p4_search_host configurable specifies the URL of your P4 Search server. When configured, P4 Code Review issues API calls to P4 Search to take advantage of its file content and description indexing.

maxlocktime

The maxlocktime key specifies the maximum amount of time, in milliseconds, that any table within the P4 Server should be locked while performing fstat command searching. Increasing this value might allow better search results at the expense of potentially blocking other queries on the P4 Server. Decreasing this value impacts the P4 Server less, but may be insufficient for returning the desired search results.

Comment attachment thumbnail/preview and blur generation

P4 Code Review generates the blur and thumbnail/preview images for P4 Code Review comment attachments and stores them in the comment attachment depot.

To prevent P4 Code Review clashing with P4 Search thumbnail/preview and blur generation, set the P4 Server protections for the P4 Code Review comment attachments depot directory so only the swarm user has access to it.

P4 Code Review 2022.1 Patch 1 and later: By default, the P4 Code Review package and OVA post-installation configuration script offers to create the comment attachment depot directory as //.swarm and set the protections so only the swarm user has access to it.

For example, if the comment attachment depot directory is //.swarm, set P4 Server protections for //.swarm to:

list user * * -//.swarm/...

admin user swarm * //.swarm/...

super user super * //.swarm/...

This prevents P4 Search creating thumbnails/previews and blurs for files stored in the comment attachment depot directory.

Related topics