? Success

User tests: Successful: Unsuccessful:

avatar richard67
richard67
19 Mar 2016

Summary of Changes

This PR is relevant for mysql databases only, i.e. not for postgresql or sqlsrv/sqlazure.

It extends the table #__utf8_conversion by a column extension_id to make it possible for extensions to use this table, too, and changes the core to use extension ID 700 for accessing this table.

This makes it possible for extensions to use in their installation script the same code as we use in the Joomla! core's script.php in update packages to determine their utf8 or utf8mb4 conversion status and perform the neccessary conversions script whe updating, also after migration of their data from a non-utf8mb4 to a utf8mb4 db server, as it already is done for the Joomla! core.

Or it can be even the base for making Joomla! core be able to handle utf8 or utf8mb4 conversion status and execution of conversion script(s) if necessary.

It is a solution in addition to my other PR #9468 , not a replacement for that.

Testing Instructions

Overview

2 things have to be tested to make sure Joomla! core still works as before with the changes from this PR:

  1. New installation of latest staging + this PR
  2. Update of e.g. a 3.4.8 to latest staging + this PR

If possible, test this on both a database with and a database without utf8mb4 support, but if you have only 1 kind of database and client, tell in the test result which kind of database (with or without utf8mb4 support) you used.

Hint: utf8mb4 is not supported if either server version is lower than 5.5.3 or if msqlnd client api is used with version lower than 5.0.9 or if other mysql-related client is used with version lower than 5.5.3.

Test 1: New installation

Step 1: Make a new installation of Joomla! latest staging + this PR, using the branch of this PR as source package:

https://github.com/richard67/joomla-cms/archive/utf8-conversion-extension-id-1.zip

Step 2: Verify that the installation ends with success, not showing any SQL errors which are related to table #__utf8_conversion (if other errors, especially whe using strict mode for the mysql session then they are not related to this PR).

Step 3: Check that in "Extensions -> Manage -> Database" the database is shown as updated and no database problems are shown, especially not the one that utf8 conversion or utf8mb4 conversion has to be performed.

Step 4: Check with phpMyAdmin the content of the #__utf8_conversion table (replace #__ with your db prefix).

Result: One record with extension_id = 700 and converted = 1 if no utf8mb4 support or 2 if utf8mb4 support.

Test 2: Update

Step 1: Update e.g. a 3.4.8 to Joomla! latest staging + this PR, using Joomla! Update component with following custom URL:

http://test5.richard-fath.de/list_test1.xml

The zip you get offered after changing your update channel to this url should be named "Joomla_3.5.1-dev-Update_Package_pr9487.zip". Its md5sum is "e302bff4a8493952a9c73353f1fcfdd9" if you wanna donwload and check.

Step 2: Verify that the update ends with success, not showing any SQL errors which are related to table #__utf8_conversion (if other errors, especially whe using strict mode for the mysql session then they are not related to this PR).

Step 3: Same as step 3 of test 1.

Step 4: Same as step 4 of test 1.

Result: Same as after step 4 of test 1.

avatar richard67 richard67 - open - 19 Mar 2016
avatar richard67 richard67 - change - 19 Mar 2016
Status New Pending
avatar joomla-cms-bot joomla-cms-bot - change - 19 Mar 2016
Labels Added: ?
avatar richard67 richard67 - change - 19 Mar 2016
The description was changed
Title
Allow extensions to use the utf8_conversion table to save their conversion status
Allow extensions to use the utf8_conversion table to save their utf8 or utf8mb4 conversion status
avatar richard67 richard67 - change - 19 Mar 2016
Title
Allow extensions to use the utf8_conversion table to save their conversion status
Allow extensions to use the utf8_conversion table to save their utf8 or utf8mb4 conversion status
avatar richard67 richard67 - change - 19 Mar 2016
Category Installation SQL Updating
avatar richard67 richard67 - change - 19 Mar 2016
The description was changed
avatar richard67
richard67 - comment - 19 Mar 2016

Added link to custom url for update test and added info about the name of the update zip and its md5sum.


This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/9487.

avatar richard67
richard67 - comment - 19 Mar 2016

Sorry, test container not ready yet. Please wait with testing.


This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/9487.

avatar richard67 richard67 - change - 19 Mar 2016
The description was changed
avatar richard67
richard67 - comment - 19 Mar 2016

Now PR is ready to be tested.

@andrepereiradasilva @wilsonge A bit time and mood left for this PR here? Would be useful to have it in 3.5.0 release.


This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/9487.

avatar richard67
richard67 - comment - 19 Mar 2016

Hmm, wait, there is something wrong. Just am checking. Not test yet please.


This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/9487.

avatar richard67
richard67 - comment - 19 Mar 2016

Ah, no, I am just blind. Was all OK. Ready for being tested.


This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/9487.

avatar richard67
richard67 - comment - 19 Mar 2016

Closing this because it is obsolete if my other PR #9468 is accepted. With help of Andre I could successfully test that PR #9468 is sufficient to handle all cases for extensions, and so this one here is really not needed anymore.

avatar richard67 richard67 - change - 19 Mar 2016
Status Pending Closed
Closed_Date 0000-00-00 00:00:00 2016-03-19 20:19:20
Closed_By richard67
avatar richard67 richard67 - close - 19 Mar 2016
avatar richard67 richard67 - close - 19 Mar 2016
avatar richard67
richard67 - comment - 20 Mar 2016

Reopening because it could be a useful thing in addition to PR #9468 , e.g. for extension developers who not want to maintain sql scripts for utf8mb4 conversion with each new version of their extension but have own php scripts to handle conversion and data migration.

avatar richard67 richard67 - change - 20 Mar 2016
Status Closed New
Closed_Date 2016-03-19 20:19:20
Closed_By richard67
avatar richard67 richard67 - change - 20 Mar 2016
Status New Pending
avatar richard67 richard67 - reopen - 20 Mar 2016
avatar richard67 richard67 - reopen - 20 Mar 2016
avatar richard67 richard67 - change - 20 Mar 2016
The description was changed
avatar mahagr
mahagr - comment - 21 Mar 2016

FYI: This change, if accepted will break upgrades between RC4 and stable.

I know that upgrades between RC releases aren't supported, but that doesn't stop people installing RC releases to their live sites...

avatar Bakual
Bakual - comment - 21 Mar 2016

As you said, we don't support updating from Betas and RCs to stable, so that's a moot point.
If people are installing RCs on their life site, that's what they get for doing so. There is a big warning in the release announcement for that reason.

As for this PR, I like the idea to make that table useable for other extensions as well. It's the right thing to do.
However I would love to see a step further. Currently extensions have to run their own script to migrate the tables to utf8mb4. As an extension developer I would love to see an API where I can pass in my table name and it does the converting for me. So I don't have to search for the code that does it for Joomla and copy-pasting it without knowing what it does. Or even worse do something stupid myself.

avatar mahagr
mahagr - comment - 21 Mar 2016

@Bakual My point was just an observation while I was looking to the change, and I agree with you.

As shown in the comment I referenced from #9468 (see above), this change is very much needed in order to even enable components to change their collation in a reliable and easy way.

But even more than needing an API, we need to allow extensions to do the conversion without writing custom PHP installer script. Having a good API would be a nice side effect of having that even simpler solution.

I agree, I do not want to copy-paste Joomla internals or do something stupid myself in order to support Joomla! 3.5 in my extensions. Both ways are just too error prone, especially when you need to take into account older versions of Joomla and the fact that even J! 3.5 may still use utf8 if the database doesn't support anything better.

We also need to remember that most of the extension developers aren't as experienced developers than we are, especially when it comes to Joomla internals. Even I have hard time to fully understand the change as I've not paid too much attention into it until a few days ago when I noticed in my PHP7 testing that all components still had the old utf8 collation in the database.

Using utf8mb4 will be a great change, but its also something that needs to be supported by every 3rd party extension. In addition there needs to be an easy way for admins to change their DB collation without needing to install newest version of every single extension manually in order to trigger the collation change.

I guess that Joomla 3.5 could be released without these features, but at the same time automating collation change is something that needs to be implemented soon, together with documentation for both developers and administrators alike.

avatar richard67
richard67 - comment - 21 Mar 2016

If people were as willing with testing as they are with writing comments ...

avatar wilsonge
wilsonge - comment - 21 Mar 2016

@Bakual that's impossible - the only way core could do this is by accessing the system information table to get detailed index information (I mean more than what's given by SHOW INDEXES) and on many shared hosts this is not given. Therefore it will always be down to extensions to do this upgrade I'm afraid

avatar mahagr
mahagr - comment - 21 Mar 2016

I did kind of test it, and the discussion above is the direct result from that attempt to test. The change is a great start, but it just raises the question "What I'm supposed to do with all of this?". I agree that without API or some automated logic, this change will not help anyone on anything.

avatar mahagr
mahagr - comment - 21 Mar 2016

@wilsonge It is possible to automate collation change with the help of this table. We do not need to get any information from the database; we just need to know if the collation change has been performed or not.

avatar richard67
richard67 - comment - 21 Mar 2016

What it is good for? Well, extensions still will have to provide conversion sql script(s), but they could be handled separately from their schema updates.

The xml manifests of extensions could be extended a path to conversion scripts, like it is for schema updates but separate from them, e.g. "utf8conversionpath".

Wheneever the core now detects that a conversion is necessary because the expected conversion status according to server and client versions is not equal to the one saved in the database (0 = not converted, 1 = converted to utf8_unicode_ci except the utf8_bin columns, 2 = converted to utf8mb4), the core will run conversion scripts again if necessary.

This scenario would cater for data migration from old db not supporting utf8mb4 to newer db supporting it.

Like the core, each extension package would contain a conversion script for latest version of the extension (which is the package where the script is in).

All this will be fully B/C. Because we have RC here, I did not make a schema update for adding the new column to the table, but if this change will not come with 3.5.0 but with 3.5.1, I will do so and add it to this PR. But it would be much easier if it would go in to 3.5.0 so the utf8_conversion table not needs a schema update.

Regarding updating live sites to Betas and RCs I think about making another PR which detects this scenario and if detected, deletes their site and formats their harddisk and sends their site email address to known spammer companies, just to give them what they deserve!!! (joke)

avatar wilsonge
wilsonge - comment - 21 Mar 2016

You can find out if it's happened for sure - but you cannot automate the collation change because you have to check index lengths and ensure that if you have unique keys people's data can be migrated without loss etc. This is not something core can do for all extensions

avatar richard67
richard67 - comment - 21 Mar 2016

@mahagr Please read my previous comment, it explains what it is good for and why it does not break B/C (because when coming with 3.5.1 and not 3.5.0 there will be a schema update sql adding the new column).

Guys please test.

And @wilsonge , if possible please consider this one and my other one which already is RTC for 3.5.0 if there is still enough time.

avatar wilsonge
wilsonge - comment - 21 Mar 2016

I'm not merging either for 3.5.0 stable :( Sorry - I'd rather we spend more time and get it merged in one go with a good workflow for extension developers than rush it on the day of release

avatar richard67
richard67 - comment - 21 Mar 2016

@wilsonge Means you wanna release today?

Ok, then it would be too little time for merging.

After you released 3.5.0 I have to make my patched update package behind my custom url for the update test be a faked 3.5.1 then, so there is something to be updated. Maybe I will need your help for that. And I have to include schema update into the update package for adding the new extension_id column to the utf8_conversion table, and also same schema update to the core, means a new commit for this in this PR.

I did not want to provide the final all in one solution with 1 single PR because 1. it was not 100% clear which way to go when I made my 2 PRs, means if we need one only or both, and 2. I want to keep the particular changes in small testable portions, so the particular portions can be tested separately.

avatar wilsonge
wilsonge - comment - 21 Mar 2016

Yup as per the RC4 release info - release day is today

avatar richard67
richard67 - comment - 21 Mar 2016

Did not see that ... was still busy with reading release info for RC1 :tongue:

avatar mahagr
mahagr - comment - 21 Mar 2016

Tested successfully both installation and upgrade. Everything looks good.

Do not get me wrong; I'm just trying to help by considering real life use cases and I agree that while this PR is really important, its just a start. I agree with @wilsonge that its better to get J3.5 out today and after that take the time needed to really solve the whole issue by giving extension developers something they can use without paying too much attention to the details.

I think we also need to inform extension developers that Joomla team is working for an easy way to update extension specific tables, asking them to be tuned.. :)

avatar richard67
richard67 - comment - 21 Mar 2016

Sure, and I appreceate your help. Only I think updating a live site to Betas or RCs is not a real life use case to be considered. :tongue:

avatar richard67
richard67 - comment - 21 Mar 2016

@wilsonge Maybe give this PR here a milestone 3.5.1 so people can see it is scheduled somehow?

avatar richard67 richard67 - change - 21 Mar 2016
Title
Allow extensions to use the utf8_conversion table to save their utf8 or utf8mb4 conversion status
Make it possible to use the utf8_conversion table to save utf8 or utf8mb4 conversion status of extensions
avatar richard67 richard67 - change - 21 Mar 2016
The description was changed
avatar richard67 richard67 - change - 21 Mar 2016
The description was changed
avatar richard67 richard67 - change - 21 Mar 2016
The description was changed
avatar richard67
richard67 - comment - 21 Mar 2016

Adapted this PR to the fact that meanwhile 3.5.0 is released, so it needs a new schema update script for adding the new column to the meanwhile existing table.

Updated also the XMLs and the zip container behind the custom update URL for Test 2, so you can update also a 3.5.0 (or even a 3.5.0 RC).

PR can be tested now.

@mahagr If you test this again, could you this time mark the test result on the issue tracker after your test?

Just go to https://issues.joomla.org/tracker/joomla-cms/9487 and use the "test this" button.


This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/9487.

avatar richard67 richard67 - change - 22 Mar 2016
The description was changed
avatar richard67
richard67 - comment - 25 Mar 2016

I meanwhile noticed this PR will not work as it is, because it does not create the new column when being updated from 3.5.0 to e.g. 3.5.1 (with this PR in) with the files copy and database fix method. It will use the new column in the query for conversion status when it does not exist yet. We have to add the new column also in the function prepareUtf8mb4StatusTable() to check and repair the table in database.php, and we need such function too in script.php.

Because there is more stuff to be done for automatic conversion also for extensions than only adding this new column, I am closing this PR now, and I will prepare a new PR solving all this.

avatar richard67 richard67 - change - 25 Mar 2016
Status Pending Closed
Closed_Date 0000-00-00 00:00:00 2016-03-25 10:07:00
Closed_By richard67
avatar richard67 richard67 - close - 25 Mar 2016

Add a Comment

Login with GitHub to post a comment