Twitter: raymondcamden

Address: Lafayette, LA, USA

Issue with CFINDEX

07-11-2014 2,485 views ColdFusion 2 Comments

If you use cfindex to parse a directory of files, you should be aware of a serious issue that may hit you. As you know, you can ask cfindex to return a result structure that tells you how many files were added, removed, or deleted from an index. As an example, here is the result structure for a set of PDFs I added.

Cool, right? Except that I had more than one PDF in the directory. So, something went wrong, right? But the issue is that there is no feedback about what went wrong. I did some digging into the logs and didn't find anything. I was truly at a loss as to what it could be. Every PDF opened up in Acrobat so they were definitely valid PDFs, and of course, my assumption was that if they weren't valid PDFs I would have certainly gotten some feedback.

I was wrong.

So, luckily, I got some help from Uday Ogra on the ColdFusion team. Turns out it was logged, just not in the log I expected. When I checked server.log, I saw this:

WARNING: Could not index /lotsofpathstuff/pdftest/temp/I-9.pdf in SOLR. Check the exception for more details: An error occurred during EXTRACTTEXT operation in <CFPDF>.

I quickly wrote a new CFM file that used cfpdf and the extracttext operation and confirmed that the error indeed made sense for the PDF in question. I opened the PDF in Acrobat, checked the document properties, and confirmed that it was blocked.

Ok, all of this makes sense then. But the issue is that there was no feedback given at the request time about a document failing or why it failed. Unfortunately, this to me is a feature killer. To be clear, I'm not talking about ColdFusion Solr integration as a whole, but if your business process involves indexing dynamic files then you can't rely on knowing exactly what files are failing. Of course, they won't always fail. In theory you could replace the "index the directory" operation with indexes of each and every file one by one. As you don't get an exception you would need to check the status to see if the numbers add up. That's a workaround, but a poor one in my opinion.

I filed a bug report on this issue where I proposed that the result struct return an array of errors. Each item in the array (if any exist) would consist of the full path to the file in question as well as the exception thrown. Adam Cameron suggested an optional argument to throw an error, which to me is the preferred approach.

As a general FYI, "silent fail" is something that should never, ever, be done. I know a lot of times we say, "Hey, this is a guideline and exceptions exist, blah blah blah", but, no, sorry, I don't agree. Silent Fail is evil. It's the mushy green peas of development. Now - take that statement and argue with me in the comments. ;)

Image credit:

p.s. Also note this other cfindex bug Scott Stroz found:


These comments will soon be imported into Disqus. To add a comment, use Disqus above.
  • Commented on 07-16-2014 at 7:51 AM
    I totally agree about the "Silent Fail" thing but if I agreed with the mushy pea thing my wife would have my head on a platter! :)
  • Commented on 07-19-2014 at 1:14 PM
    It has been a little while since I worked with cfpdf coding. I must agree about the mushy pea soup thing. Barely like peas as is.