long size varchar with long index size mysql #210

fogelito · 2022-10-20T19:39:57Z

No description provided.

eldadfux

There are a lot of leftovers, not sure if the PR is ready or not, but left some comments.

eldadfux · 2022-10-21T05:57:14Z

src/Database/Database.php

@@ -1184,7 +1185,10 @@ public function createIndex(string $collection, string $id, string $type, array
        }

        $collection = $this->silent(fn() => $this->getCollection($collection));
-
+        if($collection->isEmpty()){
+            throw new Exception('Not found');


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.

ok. I added some more checks like this where the collection was called.

eldadfux · 2022-10-21T05:58:06Z

src/Database/Database.php

@@ -1184,7 +1185,10 @@ public function createIndex(string $collection, string $id, string $type, array
        }

        $collection = $this->silent(fn() => $this->getCollection($collection));
-
+        if($collection->isEmpty()){
+            throw new Exception('Not found');


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.

Changed to
throw new Exception('Collection ' .$collectionName . ' Not found');
I added In a few more places we are called the collection object.

eldadfux · 2022-10-21T05:59:03Z

src/Database/Adapter/MariaDB.php

@@ -383,6 +396,18 @@ public function createIndex(string $collection, string $id, string $type, array
        }, $attributes);

        foreach ($attributes as $key => $attribute) {
+
+//            $size = (int)($lengths[$key] ?? 0);


Don't we need this part?
Should we throw an exception when index size is not set properly?

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.

eldadfux · 2022-10-21T06:00:46Z

src/Database/Adapter/MariaDB.php

@@ -148,34 +148,48 @@ public function createCollection(string $name, array $attributes = [], array $in
        $database = $this->getDefaultDatabase();
        $namespace = $this->getNamespace();
        $id = $this->filter($name);
+        $collectionAttributes = [];


Not sure what this variable name should indicate. The story of this new logic is not very clear.

I changed it for functions I think it is much clear now.

src/Database/Adapter.php

eldadfux · 2022-10-24T06:32:21Z

src/Database/Database.php

@@ -1578,12 +1612,11 @@ public function count(string $collection, array $queries = [], int $max = 0): in
     * @return int|float
     * @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)


Suggested change

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.

You can overwrite $collection internally and then use $collection->getId()

If the collection is empty will it return the name? I need to check

if $collection->isEmpty()
$collection->getId() is empty as well
throw new Exception('Collection ' .$collection->getId() . ' Not found');

eldadfux · 2022-10-24T06:35:08Z

src/Database/Adapter/MariaDB.php


-        foreach ($attributes as $key => $attribute) {
+        foreach ($attributes as $attribute) {


We have to explain this logic, not clear what is being achieved here. Please add a docblock.

eldadfux · 2022-10-24T06:45:20Z

src/Database/Adapter.php

+     * @return Document|null
+     * @throws Exception
+     */
+    public function findAttributeInList(string $attributeKey, array $attributes): ?Document


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.

eldadfux · 2022-10-25T06:02:06Z

src/Database/Adapter.php

+     * @return Document
+     * @throws Exception
+     */
+    public function fixIndex(Document $index, array $attributes): Document {


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.

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

abnegate · 2023-06-09T07:40:28Z

@fogelito Is this still relevant or is it solved by the index size validation?

fogelito · 2023-06-11T06:26:54Z

Yes, I will close this one.
Was taken care by a validation here:
#271

fogelito added 2 commits October 20, 2022 22:38

long size varchar with long index size mysql

534fb6b

mongo revert changes

6dfc741

eldadfux requested changes Oct 21, 2022

View reviewed changes

fogelito added 9 commits October 23, 2022 18:20

make pr more clear

fef0691

remove test comments

fa88dfb

some

ffe17f8

remove comment

ae14887

check is collection exist

8485a3c

put findAttributeInList in adapter

8eb5a44

put findAttributeInList in Database.php

fda4df6

back

f77cbbd

changes

c2a3354

TorstenDittmann requested changes Oct 24, 2022

View reviewed changes

src/Database/Adapter.php Outdated Show resolved Hide resolved

fogelito added 6 commits October 24, 2022 18:49

changing some logic

6a7e558

remove comments

a3ad9ca

remove comments

577751d

update hints

92054f4

Text fix

c96d008

description

f1ea80a

eldadfux reviewed Oct 24, 2022

View reviewed changes

eldadfux requested changes Oct 25, 2022

View reviewed changes

fogelito added 4 commits October 25, 2022 11:03

some fixes

a25f7d6

some fixes

c58ab07

some fixes

44b4eff

some fixes

a65d9e0

fogelito closed this Jun 11, 2023

stnguyen90 mentioned this pull request Jul 22, 2023

Create GH workflow to generate github metrics appwrite/.github#23

Merged

github-actions bot mentioned this pull request Jul 25, 2023

PRs Closed in June 2023 appwrite/.github#36

Closed

This was referenced Jul 25, 2023

PRs Closed in June 2023 appwrite/.github#42

Closed

PRs Closed in June 2023 appwrite/.github#48

Closed

PRs Closed in June 2023 appwrite/.github#55

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

long size varchar with long index size mysql #210

long size varchar with long index size mysql #210

fogelito commented Oct 20, 2022

eldadfux left a comment

eldadfux Oct 21, 2022

fogelito Oct 23, 2022

eldadfux Oct 21, 2022

fogelito Oct 23, 2022

eldadfux Oct 21, 2022

fogelito Oct 23, 2022

eldadfux Oct 21, 2022

fogelito Oct 23, 2022

eldadfux Oct 24, 2022

eldadfux Oct 24, 2022

fogelito Oct 25, 2022

fogelito Oct 26, 2022

eldadfux Oct 24, 2022

fogelito Oct 26, 2022

eldadfux Oct 24, 2022

eldadfux Oct 25, 2022

fogelito Oct 26, 2022

abnegate commented Jun 9, 2023

fogelito commented Jun 11, 2023

	public function sum(string $collectionName, string $attribute, array $queries = [], int $max = 0)
	public function sum(string $collection, string $attribute, array $queries = [], int $max = 0)


		foreach ($attributes as $key => $attribute) {
		foreach ($attributes as $attribute) {

long size varchar with long index size mysql #210

long size varchar with long index size mysql #210

Conversation

fogelito commented Oct 20, 2022

eldadfux left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abnegate commented Jun 9, 2023

fogelito commented Jun 11, 2023