Bug 189822 – Apache can return a corrupt manifest file while ManifestGenerator::store is running

• Status: RESOLVED
• Resolution: FIXED
• Component: New Bugs

Generating manifest.json should be transactional.

Created attachment 350341 [details]
Patch

[Ryosuke Niwa]

Comment on attachment 350341 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=350341&action=review

r-. There are enough problems in this patch that I'd like to see another iteration.

> Websites/perf.webkit.org/ChangeLog:3
> +        Updating file on perf-safari should be transactional between php and apache.

We shouldn't mention perf-safari. I've updated the bug title. Please update the change log as well.

> Websites/perf.webkit.org/public/api/measurement-set.php:41
> +    $json = NULL;

Please declare these variables inside the loop.
Also, there is no point in declaring $json.

> Websites/perf.webkit.org/public/api/measurement-set.php:55
> +        $content['elapsedTime'] = $elapsed_time;
> +        $json = json_encode($content);
> +        generate_json_data_conditionally($cache_filename, $json, 'elapsedTime');

I don't think we want to rely on elapsedTime being the last item like this.
Pass in $elapsed_time as the last argument to generate_json_data_conditionally instead:
generate_json_data_conditionally($cache_filename, $content, $elapsed_time);
It's better to invoke json_encode in generate_json_data_conditionally instead.
Also, we should probably call this generate_json_data_if_needed to match the naming convention used elsewhere in WebKit.

> Websites/perf.webkit.org/public/include/db.php:65
> +    $target_file_path = config_path('dataDirectory', $filename);
> +    $temp_file_path = tempnam(config_path('dataDirectory', ''), $filename . '-temp-');

Why do we need to make a temporary file before comparing the content?

> Websites/perf.webkit.org/public/include/json-header.php:17
> +function set_success(&$details = array()) {

This should be set_successful instead.

Comment on attachment 350341 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=350341&action=review

>> Websites/perf.webkit.org/public/api/measurement-set.php:55
>> +        generate_json_data_conditionally($cache_filename, $json, 'elapsedTime');
> 
> I don't think we want to rely on elapsedTime being the last item like this.
> Pass in $elapsed_time as the last argument to generate_json_data_conditionally instead:
> generate_json_data_conditionally($cache_filename, $content, $elapsed_time);
> It's better to invoke json_encode in generate_json_data_conditionally instead.
> Also, we should probably call this generate_json_data_if_needed to match the naming convention used elsewhere in WebKit.

If do so, we need to make generate_json_date_conditinally returns an encoded json to void calling json_encode twice as it is needed in Lin 58.

[Ryosuke Niwa]

Comment on attachment 350341 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=350341&action=review

>>> Websites/perf.webkit.org/public/api/measurement-set.php:55
>>> +        generate_json_data_conditionally($cache_filename, $json, 'elapsedTime');
>> 
>> I don't think we want to rely on elapsedTime being the last item like this.
>> Pass in $elapsed_time as the last argument to generate_json_data_conditionally instead:
>> generate_json_data_conditionally($cache_filename, $content, $elapsed_time);
>> It's better to invoke json_encode in generate_json_data_conditionally instead.
>> Also, we should probably call this generate_json_data_if_needed to match the naming convention used elsewhere in WebKit.
> 
> If do so, we need to make generate_json_date_conditinally returns an encoded json to void calling json_encode twice as it is needed in Lin 58.

Yeah, that's fine.

Created attachment 350736 [details]
Patch

[Ryosuke Niwa]

Comment on attachment 350736 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=350736&action=review

> Websites/perf.webkit.org/ChangeLog:8
> +        Updating a file on should be transactional between php and apache.

Updating a file *on* what??

> Websites/perf.webkit.org/ChangeLog:11
> +        * public/api/measurement-set.php: Adapted invocation of 'generate_json_date_with_elapsed_time_if needed'.

Nit: Somehow the function name has a space instead of _ between if and needed.

> Websites/perf.webkit.org/ChangeLog:12
> +        * public/api/runs.php: Adapted invocation of 'generate_json_date_with_elapsed_time_if needed'.

Ditto.

Landed in r236454.