Future add data source #489

evgenybukharev · 2022-06-23T13:40:28Z

Q	A
Is bugfix?	❌
New feature?	✔️
Breaks BC?	✔️

* add data storage * add data storage * add data storage * fix type hints

evgenybukharev · 2022-06-23T13:42:59Z

Another debug data storage support

yii-bot · 2022-06-23T14:51:10Z

Thank you for putting effort in the improvement of the Yii framework.
We have reviewed your pull request.

Unfortunately a use case is missing. It is required to get a better understanding of the pull request and helps us to determine the necessity and applicability of the suggested change to the framework.

Could you supply us with a use case please? Please be as detailed as possible and show some code!

Thanks!

This is an automated comment, triggered by adding the label pr:missing usecase.

evgenybukharev · 2022-06-23T15:15:15Z

The functionality of data storage of the debug panel is implemented not only in file storage, an interface has been added that allows users to implement any convenient storage for data, whether it is a database or redis. The cache data storage is also implemented

sorry for my english

#73

src/LogTarget.php

samdark

👍 Looks like a good thing but requires major release since public API changes. Need a line for CHANGELOG and UPGRADE instructions.

SamMousa · 2022-12-14T11:11:00Z

I like the idea of this PR but I'm not convinced on the architectural choices.

In my opinion storing data is the task of a log target. By limiting your changes only to a new LogTarget we don't have to break BC which is a big win.

Also I don't see the benefit of introducing a new interface, which will see few implementors.
Instead just tie this to our CacheInterface and any implementor can easily implement that.

My unfinished proof of concept: #495 achieves similar functionality with just a new target. Meaning no BC break.

Also this PR suffers from the same shortcoming as my PoC for mail files: they are still stored on disk.
For the mail files I'll create a new issue since maybe we can solve that outside of this one.

# Conflicts: # src/LogTarget.php # src/Module.php # src/controllers/DefaultController.php

# Conflicts: # src/LogTarget.php # src/Module.php # src/components/data/CacheDataStorage.php # src/components/data/FileDataStorage.php # src/controllers/DefaultController.php

…(T_STRING)

evgenybukharev · 2023-01-27T13:08:33Z

@samdark Hi, I added line to CHANGELOG and added instructions to README

src/Module.php

src/LogTarget.php

src/Module.php

bizley · 2023-01-28T09:44:13Z

src/components/data/CacheDataStorage.php

+        $data = $this->cache->get($this->cacheDebugDataKey . $tag);
+        if (empty($data)) {
+            return [];
+        } else {


This is new component, let's stop this nonsense with returns in the if-else.

bizley · 2023-01-28T09:44:29Z

src/components/data/CacheDataStorage.php

+        $manifest = $this->cache->get($this->cacheDebugManifestKey);
+        if (empty($manifest)) {
+            return [];
+        } else {


This is new component, let's stop this nonsense with returns in the if-else.

src/components/data/DataStorage.php

src/components/data/FileDataStorage.php

bizley · 2023-01-28T10:15:06Z

And we need tests.

# Conflicts: # CHANGELOG.md

yii-bot · 2023-05-22T19:23:25Z

Thank you for putting effort in the improvement of the Yii framework.
We have reviewed your pull request.

In order for the framework and your solution to remain stable in the future, we have a unit test requirement in place. Therefore we can only accept your pull request if it is covered by unit tests.

Could you add these please?

Thanks!

P.S. If you have any questions about the creation of unit tests? Don't hesitate to ask for support. More information about unit tests

This is an automated comment, triggered by adding the label pr:request for unit tests.

samdark · 2024-02-27T06:52:44Z

src/Module.php


 /**
 * The Yii Debug Module provides the debug toolbar and debugger
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
- * @since 2.0
+ * @since  2.0


Suggested change

* @since 2.0

* @since 2.0

samdark · 2024-02-27T06:53:14Z

README.md

+Data Storage
+-----
+
+You can save debug data in any storage, for this you need to implement the yii\debug\components\data\DataStorage interface, and configure the module.


Suggested change

You can save debug data in any storage, for this you need to implement the yii\debug\components\data\DataStorage interface, and configure the module.

You can save debug data in any storage, for this you need to implement the `yii\debug\components\data\DataStorage` interface, and configure the module.

samdark · 2024-02-27T06:54:29Z

src/Module.php

@@ -226,7 +220,8 @@ public static function setYiiLogo($logo)
    public function init()
    {
        parent::init();
-        $this->dataPath = Yii::getAlias($this->dataPath);
+
+        $this->dataStorage = Instance::ensure($this->dataStorageConfig + ['module' => $this],'yii\debug\components\data\DataStorage');


Suggested change

$this->dataStorage = Instance::ensure($this->dataStorageConfig + ['module' => $this],'yii\debug\components\data\DataStorage');

$this->dataStorage = Instance::ensure($this->dataStorageConfig + ['module' => $this], 'yii\debug\components\data\DataStorage');

samdark · 2024-02-27T07:00:58Z

src/components/data/CacheDataStorage.php

+    }
+
+    /**
+     * @param string $tag


Need phpdoc here and in every other method.

evgenybukharev added 4 commits June 23, 2022 13:57

Future add data source (#1)

fe7b7fc

* add data storage * add data storage * add data storage * fix type hints

add data storage

c95f6cc

add data storage

d7a8ed1

add data storage

593157b

evgenybukharev marked this pull request as ready for review June 23, 2022 13:43

bizley added the pr:missing usecase It is not clear what is the use case for the pull request. label Jun 23, 2022

bizley removed the pr:missing usecase It is not clear what is the use case for the pull request. label Jun 23, 2022

bizley requested a review from samdark June 23, 2022 16:28

samdark added the type:enhancement Enhancement label Jun 30, 2022

samdark reviewed Jun 30, 2022

View reviewed changes

src/LogTarget.php Outdated Show resolved Hide resolved

evgenybukharev added 2 commits July 5, 2022 14:07

codestyle fix

e8a6dfb

restore

f1480b0

samdark approved these changes Jul 14, 2022

View reviewed changes

samdark mentioned this pull request Nov 18, 2022

Store data in a cache #495

Closed

5 tasks

SamMousa mentioned this pull request Dec 14, 2022

Mailpanel should store message in request data #497

Open

evgenybukharev added 11 commits January 27, 2023 14:38

Merge remote-tracking branch 'yiisoft/master'

d946f93

# Conflicts: # src/LogTarget.php # src/Module.php # src/controllers/DefaultController.php

fix

8c2d360

fix

f464387

fix

4af6b3b

fix

abbf63b

Merge remote-tracking branch 'origin/master' into future_add_data_source

8215da0

# Conflicts: # src/LogTarget.php # src/Module.php # src/components/data/CacheDataStorage.php # src/components/data/FileDataStorage.php # src/controllers/DefaultController.php

add yii\helpers\IpHelper

5516465

fix syntax error, unexpected 'class' (T_CLASS), expecting identifier …

ae8afbf

…(T_STRING)

fix syntax error, unexpected 'class' (T_CLASS), expecting identifier …

7ecfedc

…(T_STRING)

fix syntax error, unexpected 'class' (T_CLASS), expecting identifier …

f6c8f54

…(T_STRING)

add data storage info to CHANGELOG and README

36a7605

bizley requested changes Jan 28, 2023

View reviewed changes

evgenybukharev and others added 8 commits January 28, 2023 13:24

recover merge bugs

274a9d6

codestyle

a4c1775

recover merge bugs

6ca168f

add Instance::ensure

d259c64

refactor if/else

6ea0f29

add Instance::ensure

9946fa2

make CacheDataStorage properties

61b3ff0

Update CHANGELOG.md

309ddf7

samdark added this to the 2.2.0 milestone Feb 20, 2023

evgenybukharev added 3 commits April 6, 2023 17:51

Merge remote-tracking branch 'yiisoft/master'

0d8759b

Fix isset data exceptions

72488bc

Merge branch 'master' into future_add_data_source

98eb846

# Conflicts: # CHANGELOG.md

samdark removed this from the 2.2.0 milestone May 22, 2023

samdark added the pr:request for unit tests Unit tests are needed. label May 22, 2023

samdark added 3 commits February 20, 2024 16:37

Merge branch 'master' into future_add_data_source

611eed6

Update CHANGELOG.md

cdb69db

Update CHANGELOG.md

e7d9eaf

samdark reviewed Feb 27, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Future add data source #489

Future add data source #489

evgenybukharev commented Jun 23, 2022 •

edited

Loading

evgenybukharev commented Jun 23, 2022

yii-bot commented Jun 23, 2022

evgenybukharev commented Jun 23, 2022 •

edited

Loading

samdark left a comment

SamMousa commented Dec 14, 2022

evgenybukharev commented Jan 27, 2023

bizley Jan 28, 2023

bizley Jan 28, 2023

bizley commented Jan 28, 2023

yii-bot commented May 22, 2023

samdark Feb 27, 2024

samdark Feb 27, 2024

samdark Feb 27, 2024

samdark Feb 27, 2024

	You can save debug data in any storage, for this you need to implement the yii\debug\components\data\DataStorage interface, and configure the module.
	You can save debug data in any storage, for this you need to implement the `yii\debug\components\data\DataStorage` interface, and configure the module.

	$this->dataStorage = Instance::ensure($this->dataStorageConfig + ['module' => $this],'yii\debug\components\data\DataStorage');
	$this->dataStorage = Instance::ensure($this->dataStorageConfig + ['module' => $this], 'yii\debug\components\data\DataStorage');

Future add data source #489

Are you sure you want to change the base?

Future add data source #489

Conversation

evgenybukharev commented Jun 23, 2022 • edited Loading

evgenybukharev commented Jun 23, 2022

yii-bot commented Jun 23, 2022

evgenybukharev commented Jun 23, 2022 • edited Loading

samdark left a comment

Choose a reason for hiding this comment

SamMousa commented Dec 14, 2022

evgenybukharev commented Jan 27, 2023

bizley Jan 28, 2023

Choose a reason for hiding this comment

bizley Jan 28, 2023

Choose a reason for hiding this comment

bizley commented Jan 28, 2023

yii-bot commented May 22, 2023

samdark Feb 27, 2024

Choose a reason for hiding this comment

samdark Feb 27, 2024

Choose a reason for hiding this comment

samdark Feb 27, 2024

Choose a reason for hiding this comment

samdark Feb 27, 2024

Choose a reason for hiding this comment

evgenybukharev commented Jun 23, 2022 •

edited

Loading

evgenybukharev commented Jun 23, 2022 •

edited

Loading