long size varchar with long index size mysql #210
Conversation
eldadfux
left a comment
eldadfux
left a comment
There was a problem hiding this comment.
There are a lot of leftovers, not sure if the PR is ready or not, but left some comments.
src/Database/Database.php
Outdated
| $collection = $this->silent(fn() => $this->getCollection($collection)); | ||
|
|
||
| if($collection->isEmpty()){ | ||
| throw new Exception('Not found'); |
There was a problem hiding this comment.
Are we missing this check from other methods? We should make sure we keep a consistent behavior across the library. Please add this check in other places when absolutely needed.
There was a problem hiding this comment.
ok. I added some more checks like this where the collection was called.
src/Database/Database.php
Outdated
| $collection = $this->silent(fn() => $this->getCollection($collection)); | ||
|
|
||
| if($collection->isEmpty()){ | ||
| throw new Exception('Not found'); |
There was a problem hiding this comment.
Not found is very generic and not helpful at all for other devs who might be using the library. Our errors should be as verbose, useful, and consistent as possible.
There was a problem hiding this comment.
Changed to
throw new Exception('Collection ' .$collectionName . ' Not found');
I added In a few more places we are called the collection object.
src/Database/Adapter/MariaDB.php
Outdated
|
|
||
| foreach ($attributes as $key => $attribute) { | ||
|
|
||
| // $size = (int)($lengths[$key] ?? 0); |
There was a problem hiding this comment.
Don't we need this part?
Should we throw an exception when index size is not set properly?
There was a problem hiding this comment.
This is the Index size, not the attribute size, it is not mandatory.
I commend out this part since I have questions. This is another place we have to fix regardless of the current bug.
src/Database/Adapter/MariaDB.php
Outdated
| $database = $this->getDefaultDatabase(); | ||
| $namespace = $this->getNamespace(); | ||
| $id = $this->filter($name); | ||
| $collectionAttributes = []; |
There was a problem hiding this comment.
Not sure what this variable name should indicate. The story of this new logic is not very clear.
There was a problem hiding this comment.
I changed it for functions I think it is much clear now.
| * @throws Exception | ||
| */ | ||
| public function sum(string $collection, string $attribute, array $queries = [], int $max = 0) | ||
| public function sum(string $collectionName, string $attribute, array $queries = [], int $max = 0) |
There was a problem hiding this comment.
| public function sum(string $collectionName, string $attribute, array $queries = [], int $max = 0) | |
| public function sum(string $collection, string $attribute, array $queries = [], int $max = 0) |
Let's prioritize naming in the signatures, to keep the external API of the library consistent.
There was a problem hiding this comment.
You can overwrite $collection internally and then use $collection->getId()
There was a problem hiding this comment.
If the collection is empty will it return the name? I need to check
There was a problem hiding this comment.
if $collection->isEmpty()
$collection->getId() is empty as well
throw new Exception('Collection ' .$collection->getId() . ' Not found');
| $schemaAttributes = []; | ||
|
|
||
| foreach ($attributes as $key => $attribute) { | ||
| foreach ($attributes as $attribute) { |
There was a problem hiding this comment.
We have to explain this logic, not clear what is being achieved here. Please add a docblock.
src/Database/Adapter.php
Outdated
| * @return Document|null | ||
| * @throws Exception | ||
| */ | ||
| public function findAttributeInList(string $attributeKey, array $attributes): ?Document |
There was a problem hiding this comment.
This add unnecessary pollution to the API. This method should not be exposed to consumers of this library as it add unnecessary complexity, and noise.
We can move it to the MariaDB adapter as no other adapter uses it. This location can be reconsidered when we will need it in other places.
The method name doesn't seem to apply to any existing name pattern of the current API. I would vote to call it findAttribute and mark it protected.
src/Database/Adapter.php
Outdated
| * @return Document | ||
| * @throws Exception | ||
| */ | ||
| public function fixIndex(Document $index, array $attributes): Document { |
There was a problem hiding this comment.
This shouldn't be part of the adapter interface as this issue is specific to MariaDB/MySQL.
Also, the name suggest this is a bug fix and might encourage future maintainer to use this as a generic place for adding patches that will increase technical debt.
This method should be designed for enforcing the required behavior for the relevant adapter. getSQLIndexLimit(int $length): int might better explain what we do, and work better with the existing patterns of getSQLIndex() and getSQLIndexType(). Very important we keep consistency and predictability across the library.
There was a problem hiding this comment.
I Do not think this is relevant since now it moved to the MariaDB.
Please give me a better name for fixIndex
This function returns the index after checking and overwriting bad values
|
@fogelito Is this still relevant or is it solved by the index size validation? |
|
Yes, I will close this one. |
No description provided.