Skip to content

Commit

Permalink
Merge pull request #14857 from nextcloud/backport/14398/stable15
Browse files Browse the repository at this point in the history 
[stable15] Add setup check for missing UTF8MB4 on mysql
  • Loading branch information
@MorrisJobke
MorrisJobke authored Mar 26, 2019
2 parents be8a82e + 31fb089 commit 087fa7f
Show file tree
Hide file tree
Showing 4 changed files with 148 additions and 13 deletions.
12 changes: 12 additions & 0 deletions core/js/setupchecks.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -450,6 +450,18 @@
type: OC.SetupChecks.MESSAGE_TYPE_WARNING
});
}
if (data.isMysqlUsedWithoutUTF8MB4) {
messages.push({
msg: t(
'core',
'MySQL is used as database but does not support 4-byte characters. To be able to handle 4-byte characters (like emojis) without issues in filenames or comments for example it is recommended to enable the 4-byte support in MySQL. For further details read <a target="_blank" rel="noreferrer noopener" href="{docLink}">the documentation page about this</a>.',
{
docLink: oc_defaults.docPlaceholderUrl.replace('PLACEHOLDER', 'admin-mysql-utf8mb4'),
}
),
type: OC.SetupChecks.MESSAGE_TYPE_WARNING
})
}

} else {
messages.push({
Expand Down
88 changes: 75 additions & 13 deletions core/js/tests/specs/setupchecksSpec.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,8 @@ describe('OC.SetupChecks tests', function() {
isMemoryLimitSufficient: true,
appDirsWithDifferentOwner: [],
recommendedPHPModules: [],
pendingBigIntConversionColumns: []
pendingBigIntConversionColumns: [],
isMysqlUsedWithoutUTF8MB4: false
})
);

Expand Down Expand Up @@ -299,7 +300,8 @@ describe('OC.SetupChecks tests', function() {
isMemoryLimitSufficient: true,
appDirsWithDifferentOwner: [],
recommendedPHPModules: [],
pendingBigIntConversionColumns: []
pendingBigIntConversionColumns: [],
isMysqlUsedWithoutUTF8MB4: false
})
);

Expand Down Expand Up @@ -351,7 +353,8 @@ describe('OC.SetupChecks tests', function() {
isMemoryLimitSufficient: true,
appDirsWithDifferentOwner: [],
recommendedPHPModules: [],
pendingBigIntConversionColumns: []
pendingBigIntConversionColumns: [],
isMysqlUsedWithoutUTF8MB4: false
})
);

Expand Down Expand Up @@ -401,7 +404,8 @@ describe('OC.SetupChecks tests', function() {
isMemoryLimitSufficient: true,
appDirsWithDifferentOwner: [],
recommendedPHPModules: [],
pendingBigIntConversionColumns: []
pendingBigIntConversionColumns: [],
isMysqlUsedWithoutUTF8MB4: false
})
);

Expand Down Expand Up @@ -449,7 +453,8 @@ describe('OC.SetupChecks tests', function() {
isMemoryLimitSufficient: true,
appDirsWithDifferentOwner: [],
recommendedPHPModules: [],
pendingBigIntConversionColumns: []
pendingBigIntConversionColumns: [],
isMysqlUsedWithoutUTF8MB4: false
})
);

Expand Down Expand Up @@ -499,7 +504,8 @@ describe('OC.SetupChecks tests', function() {
'/some/path'
],
recommendedPHPModules: [],
pendingBigIntConversionColumns: []
pendingBigIntConversionColumns: [],
isMysqlUsedWithoutUTF8MB4: false
})
);

Expand Down Expand Up @@ -547,7 +553,8 @@ describe('OC.SetupChecks tests', function() {
isMemoryLimitSufficient: true,
appDirsWithDifferentOwner: [],
recommendedPHPModules: [],
pendingBigIntConversionColumns: []
pendingBigIntConversionColumns: [],
isMysqlUsedWithoutUTF8MB4: false
})
);

Expand Down Expand Up @@ -595,7 +602,8 @@ describe('OC.SetupChecks tests', function() {
isMemoryLimitSufficient: true,
appDirsWithDifferentOwner: [],
recommendedPHPModules: [],
pendingBigIntConversionColumns: []
pendingBigIntConversionColumns: [],
isMysqlUsedWithoutUTF8MB4: false
})
);

Expand Down Expand Up @@ -643,7 +651,8 @@ describe('OC.SetupChecks tests', function() {
isMemoryLimitSufficient: false,
appDirsWithDifferentOwner: [],
recommendedPHPModules: [],
pendingBigIntConversionColumns: []
pendingBigIntConversionColumns: [],
isMysqlUsedWithoutUTF8MB4: false
})
);

Expand Down Expand Up @@ -712,7 +721,8 @@ describe('OC.SetupChecks tests', function() {
isMemoryLimitSufficient: true,
appDirsWithDifferentOwner: [],
recommendedPHPModules: [],
pendingBigIntConversionColumns: []
pendingBigIntConversionColumns: [],
isMysqlUsedWithoutUTF8MB4: false
})
);

Expand Down Expand Up @@ -761,7 +771,8 @@ describe('OC.SetupChecks tests', function() {
isMemoryLimitSufficient: true,
appDirsWithDifferentOwner: [],
recommendedPHPModules: [],
pendingBigIntConversionColumns: []
pendingBigIntConversionColumns: [],
isMysqlUsedWithoutUTF8MB4: false
})
);

Expand Down Expand Up @@ -810,7 +821,8 @@ describe('OC.SetupChecks tests', function() {
isMemoryLimitSufficient: true,
appDirsWithDifferentOwner: [],
recommendedPHPModules: [],
pendingBigIntConversionColumns: []
pendingBigIntConversionColumns: [],
isMysqlUsedWithoutUTF8MB4: false
})
);

Expand Down Expand Up @@ -859,7 +871,8 @@ describe('OC.SetupChecks tests', function() {
isMemoryLimitSufficient: true,
appDirsWithDifferentOwner: [],
recommendedPHPModules: [],
pendingBigIntConversionColumns: []
pendingBigIntConversionColumns: [],
isMysqlUsedWithoutUTF8MB4: false
})
);

Expand All @@ -871,6 +884,55 @@ describe('OC.SetupChecks tests', function() {
done();
});
});

it('should return an error if the php version is no longer supported', function(done) {
var async = OC.SetupChecks.checkSetup();

suite.server.requests[0].respond(
200,
{
'Content-Type': 'application/json',
},
JSON.stringify({
hasFileinfoInstalled: true,
isGetenvServerWorking: true,
isReadOnlyConfig: false,
hasWorkingFileLocking: true,
hasValidTransactionIsolationLevel: true,
suggestedOverwriteCliURL: '',
isRandomnessSecure: true,
securityDocs: 'https://docs.owncloud.org/myDocs.html',
serverHasInternetConnection: true,
isMemcacheConfigured: true,
forwardedForHeadersWorking: true,
isCorrectMemcachedPHPModuleInstalled: true,
hasPassedCodeIntegrityCheck: true,
isOpcacheProperlySetup: true,
hasOpcacheLoaded: true,
isSettimelimitAvailable: true,
hasFreeTypeSupport: true,
missingIndexes: [],
outdatedCaches: [],
cronErrors: [],
cronInfo: {
diffInSeconds: 0
},
isMemoryLimitSufficient: true,
appDirsWithDifferentOwner: [],
recommendedPHPModules: [],
pendingBigIntConversionColumns: [],
isMysqlUsedWithoutUTF8MB4: true
})
);

async.done(function( data, s, x ){
expect(data).toEqual([{
msg: 'MySQL is used as database but does not support 4-byte characters. To be able to handle 4-byte characters (like emojis) without issues in filenames or comments for example it is recommended to enable the 4-byte support in MySQL. For further details read <a href="https://docs.example.org/admin-mysql-utf8mb4" rel="noreferrer noopener">the documentation page about this</a>.',
type: OC.SetupChecks.MESSAGE_TYPE_WARNING
}]);
done();
});
});
});

describe('checkGeneric', function() {
Expand Down
5 changes: 5 additions & 0 deletions settings/Controller/CheckSetupController.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -605,6 +605,10 @@ protected function hasRecommendedPHPModules(): array {
return $recommendedPHPModules;
}

protected function isMysqlUsedWithoutUTF8MB4(): bool {
return ($this->config->getSystemValue('dbtype', 'sqlite') === 'mysql') && ($this->config->getSystemValue('mysql.utf8mb4', false) === false);
}

protected function hasBigIntConversionPendingColumns(): array {
// copy of ConvertFilecacheBigInt::getColumnsByTable()
$tables = [
Expand Down Expand Up @@ -679,6 +683,7 @@ public function check() {
'appDirsWithDifferentOwner' => $this->getAppDirsWithDifferentOwner(),
'recommendedPHPModules' => $this->hasRecommendedPHPModules(),
'pendingBigIntConversionColumns' => $this->hasBigIntConversionPendingColumns(),
'isMysqlUsedWithoutUTF8MB4' => $this->isMysqlUsedWithoutUTF8MB4(),
]
);
}
Expand Down
56 changes: 56 additions & 0 deletions tests/Settings/Controller/CheckSetupControllerTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@ public function setUp() {
'getAppDirsWithDifferentOwner',
'hasRecommendedPHPModules',
'hasBigIntConversionPendingColumns',
'isMysqlUsedWithoutUTF8MB4',
])->getMock();
}

Expand Down Expand Up @@ -499,6 +500,11 @@ public function testCheck() {
->method('hasBigIntConversionPendingColumns')
->willReturn([]);

$this->checkSetupController
->expects($this->once())
->method('isMysqlUsedWithoutUTF8MB4')
->willReturn(false);

$expected = new DataResponse(
[
'isGetenvServerWorking' => true,
Expand Down Expand Up @@ -543,6 +549,7 @@ public function testCheck() {
'appDirsWithDifferentOwner' => [],
'recommendedPHPModules' => [],
'pendingBigIntConversionColumns' => [],
'isMysqlUsedWithoutUTF8MB4' => false,
]
);
$this->assertEquals($expected, $this->checkSetupController->check());
Expand Down Expand Up @@ -1324,4 +1331,53 @@ public function testGetFailedIntegrityCheckFilesWithSomeErrorsFound() {
);
$this->assertEquals($expected, $this->checkSetupController->getFailedIntegrityCheckFiles());
}

public function dataForIsMysqlUsedWithoutUTF8MB4() {
return [
['sqlite', false, false],
['sqlite', true, false],
['postgres', false, false],
['postgres', true, false],
['oci', false, false],
['oci', true, false],
['mysql', false, true],
['mysql', true, false],
];
}

/**
* @dataProvider dataForIsMysqlUsedWithoutUTF8MB4
*/
public function testIsMysqlUsedWithoutUTF8MB4(string $db, bool $useUTF8MB4, bool $expected) {
$this->config->method('getSystemValue')
->will($this->returnCallback(function($key, $default) use ($db, $useUTF8MB4) {
if ($key === 'dbtype') {
return $db;
}
if ($key === 'mysql.utf8mb4') {
return $useUTF8MB4;
}
return $default;
}));

$checkSetupController = new CheckSetupController(
'settings',
$this->request,
$this->config,
$this->clientService,
$this->urlGenerator,
$this->util,
$this->l10n,
$this->checker,
$this->logger,
$this->dispatcher,
$this->db,
$this->lockingProvider,
$this->dateTimeFormatter,
$this->memoryInfo,
$this->secureRandom
);

$this->assertSame($expected, $this->invokePrivate($checkSetupController, 'isMysqlUsedWithoutUTF8MB4'));
}
}

0 comments on commit 087fa7f

Please sign in to comment.