CRM/Logging - Fix various bugs in schema parsing #13441
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Can one of the admins verify this patch? |
|
(Standard links)
|
|
Jenkins add to whitelist |
|
This looks promising! @aydun any chance you could take a look at this one? |
|
Ok, I'll take a look - hopefully later this week. |
|
That would be great @aydun - thanks. |
aydun
requested changes
Jan 25, 2019
|
Thanks @aydun! I added some code that should handle enums as well as tests for length/enum changes getting pushed through to log tables. |
|
@civicrm-builder retest this please |
This fixes a couple of bugs in the schema parsing methods used by Civi's extended logging feature: - CRM_Logging_Schema::getIndexesForTable only queried for constraints, not returning any indexes. - CRM_Logging_Schema::getIndexesForTable returned an array in the form [0 => ['constraint_name' => 'foo']] rather than the expected array of index names (i.e. ['foo']). - CRM_Logging_Schema::columnSpecsOf contained an off-by-one error and a wrongly used substr parameter causing column lengths to include surrounding parenthesis. This would result in a "varchar(42)" column returning a length of "(42)" instead of "42".
Instead of storing permitted enum values in the LENGTH array key when extracting column information, this adds a separate ENUM_VALUES key. When schema differences are calculated for enum columns, this value triggers a change when new permitted values are added.
pfigel
force-pushed
the
fix-schema-parsing
branch
from
ef30c9e
to
f34f504
Compare
|
I'm going to merge this - I feel like feedback has been responded to & test coverage is great. I would also note this code is accessed only when updating logging tables & has pretty reasonable coverage so that gives me some confidence |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
CRM_Logging_Schemacontains a number of helper methods for parsing table schemas. The results are then used to create or alter log tables.Before
Some of these methods contain bugs that produce incorrect or incomplete results:
CRM_Logging_Schema::getIndexesForTableonly queries for constraints, not returning any indexes.CRM_Logging_Schema::getIndexesForTablereturns an array in the form[0 => ['constraint_name' => 'foo']], meaning lookups viain_arraywon't work.CRM_Logging_Schema::columnSpecsOfcontains an off-by-one error and a wrongly used substr parameter causing column lengths to include surrounding parenthesis. This would result in avarchar(42)column returning a length of(42).After
CRM_Logging_Schema::getIndexesForTablereturns constraints as well as indexes.CRM_Logging_Schema::getIndexesForTablereturns an array in the form of['index1', 'index2', ...]CRM_Logging_Schema::columnSpecsOfreturns column lengths without surrounding parenthesis.