JR59212: di-buildindex utility does not return correct exit code

APAR status

• Closed as program error.

Error description

• The client is seeing this in their logs:
  
  2018/02/15 07:48:34:040 EST] I Data import pre-processing
  ended:Thu Feb 15 07:48:34 EST 2018
  18:18:34              [2018/02/15 07:48:34:040 EST] I Data
  import pre-processing completed in 935.823 seconds.
  18:18:35        2. Run build index step   Feb 15, 2018 7:48:35
  AM
  com.ibm.commerce.foundation.dataimport.process.DataImportProcess
  orMain logStartDate(Date)
  18:18:35              INFO: Data import process started:Thu Feb
  15 07:48:35 EST 2018
  18:18:36              Feb 15, 2018 7:48:36 AM
  com.ibm.commerce.foundation.dataimport.process.DataImportProcess
  orMain main(String[])
  18:18:36              WARNING: CWXFS3201W: Another CatalogEntry
  indexing process is still in progress for master catalog
  "12,051".
  18:18:36              Feb 15, 2018 7:48:36 AM
  com.ibm.commerce.foundation.dataimport.process.DataImportProcess
  orMain main(String[])
  18:18:36              WARNING: CWXFS3202W: Another CatalogGroup
  indexing process is still in progress for master catalog
  "12,051".
  18:18:36              Feb 15, 2018 7:48:36 AM
  com.ibm.commerce.foundation.dataimport.process.DataImportProcess
  orMain logExitCode
  18:18:36              INFO:
  18:18:36
  18:18:36
  -----------------------------------------------
  18:18:36
  18:18:36              Feb 15, 2018 7:48:36 AM
  com.ibm.commerce.foundation.dataimport.process.DataImportProcess
  orMain logExitCode(int)
  18:18:36              INFO:
  18:18:36              The program exiting with exit code: 0.
  18:18:36              Data import process completed successfully
   with no errors.
  18:18:36
  18:18:36              Feb 15, 2018 7:48:36 AM
  com.ibm.commerce.foundation.dataimport.process.DataImportProcess
  orMain logExitCode
  18:18:36              INFO:
  18:18:36
  -----------------------------------------------
  18:18:36
  18:18:36
  18:18:36              Feb 15, 2018 7:48:36 AM
  com.ibm.commerce.foundation.dataimport.process.DataImportProcess
  orMain logEndDateAndTime
  18:18:36              INFO: Data import process ended:Thu Feb 15
   07:48:36 EST 2018
  18:18:36              Feb 15, 2018 7:48:36 AM
  com.ibm.commerce.foundation.dataimport.process.DataImportProcess
  orMain logEndDateAndTime
  18:18:36              INFO: Data import process completed in
  0.799 seconds.
  18:18:36              Build index runs successful.
  
  They are asking why is the build successful? Shouldn't it fail?
  I looked at the code for 804(the client's level) and saw this:
  
  if (actions != null && actions.size() == 1) {
                          Logger msgLogger =
  LoggingHelper.getLogger(SearchServiceSystemMessageKeys.class);
                          String defaultMessage = null;
                          String message = null;
                          if (processor.ibInventory) {
                              defaultMessage = "CWXFS3206W:
  Another indexing process for the {0} subtype is currently in
  progress for master catalog {1}.";
                              message =
  DataImportHelper.getLocalizedMessage(SearchServiceSystemMessageK
  eys.CATALOG_ENTRY_SUBTYPE_INDEXING_RUNNING, new Object[]
  {DataImportProcessConstants.INDEX_SUBTYPE_INVENTORY,
  masterCatalogId}, msgLogger, defaultMessage);
                          } else if
  (indexType.equals(DataImportPreProcessConstants.DI_INDEX_TYPE_CA
  TALOG_ENTRY)) {
                              defaultMessage = "CWXFS3201W:
  Another CatalogEntry indexing process is still in progress for
  master catalog {0}.";
                              message =
  DataImportHelper.getLocalizedMessage(SearchServiceSystemMessageK
  eys.CATALOG_ENTRY_INDEXING_RUNNING, new Object[]
  {masterCatalogId}, msgLogger, defaultMessage);
                          } else if
  (indexType.equals(DataImportPreProcessConstants.DI_INDEX_TYPE_CA
  TALOG_GROUP)) {
                              defaultMessage = "CWXFS3202W:
  Another CatalogGroup indexing process is still in progress for
  master catalog {0}.";
                              message =
  DataImportHelper.getLocalizedMessage(SearchServiceSystemMessageK
  eys.CATALOG_GROUP_INDEXING_RUNNING, new Object[]
  {masterCatalogId}, msgLogger, defaultMessage);
                          }
                          LOGGER.logp(Level.WARNING, CLASSNAME,
  METHODNAME, message);
                          exitCode =
  DataImportProcessConstants.PROCESSOR_EXIT_WITH_WARNING;
                      }
  
  When it prints the message the exit code should get
  PROCESSOR_EXIT_WITH_WARNING which is exit code 3. That means the
   utility should stop running.
  

Local fix

Problem summary

• USERS AFFECTED:
  WebSphere Commerce Version 8.
  
  PROBLEM ABSTRACT:
  di-buildindex utility does not return correct exit code
  
  BUSINESS IMPACT:
  Affects troubleshooting since the exit code is incorrect.
  
  RECOMMENDATION:
  

Problem conclusion

• - Build index process will cancel for the index type which has
  another indexing process still in progress.
  - Changed the exit code to 3 instead of 0 when building index
  exit without building any index.
  

Temporary fix

Comments

APAR Information

• APAR is sysrouted FROM one or more of the following:

• APAR is sysrouted TO one or more of the following:

Fix information

• Fixed component name

  WC BUS EDITION

• Fixed component ID

  5724I3800

Applicable component levels

• R800 PSY

     UP