Use `yiisoft/yii-console` with optional. #178

terabytesoftw · 2023-11-21T15:27:55Z

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

what-the-diff · 2023-11-21T15:28:39Z

PR Summary

Update to README.md for clearer usage instructions
- Instructions for usage with Yii Console and Symfony Console were added. Adding these equips users with more ways to use the product.
- An actionable code example for configuring a logger with yiisoft/log-target-file was provided, making it easier for users to set up logging functionalities.
- Instructions for adding aliases for the logger were given to allow users to use more convenient shortcuts for their tasks.
Addition new helper files
- Three new files were added (bin/definitions.php, bin/queue, bin/queue.bat). These files are likely aimed at expanding the functionality or streamlining the usage of the product.
Modification of composer.json for enhanced package setup
- "yiisoft/config" package was added to the dependencies. This aids in improved configuration management of the project
- "bin/queue" was included in the "bin" section. This implies the addition of new command-line functionalities.
Updates to src/Command/ListenCommand.php and src/Command/RunCommand.php for consistent return values
- Rather than using a symbolic constant (ExitCode::OK), the execute method in both files now consistently return 0 to signify success. This makes the code more straightforward to understand and follow.

codecov · 2023-11-22T14:23:58Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (eba0486) 94.31% compared to head (7910e61) 94.31%.

Additional details and impacted files

@@            Coverage Diff            @@
##             master     #178   +/-   ##
=========================================
  Coverage     94.31%   94.31%           
  Complexity      340      340           
=========================================
  Files            40       40           
  Lines           915      915           
=========================================
  Hits            863      863           
  Misses           52       52

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

composer.json

vjik · 2023-11-22T14:26:49Z

composer.json

@@ -58,6 +58,9 @@
            "Yiisoft\\Yii\\Queue\\Tests\\": "tests"
        }
    },
+    "bin": [
+        "bin/queue"


Suggested change

"bin/queue"

"bin/yii-queue"

It's global space, I suggest use prefix.

The idea when removing the console is to rename the package to yiisoft/queue, so queue makes sense.

I suggest rename utility only. Because it is global namespace

bin/queue.bat

vjik · 2023-11-22T14:32:41Z

bin/queue

+use Yiisoft\Di\Container;
+use Yiisoft\Di\ContainerConfig;
+
+require_once './vendor/autoload.php';


Could there be a problem if run utility from different places?
May be better use absoulte path via __DIR__ (see yii2)?

It is not necessary when using ./ it works well for commands, whether you install the package in an app or clone it.

I try it, and this do not work correclty.

As it fails, to reproduce it, since I use it in the app, and in the cloned directory, and it works correctly.

But you are inside the config directory, you must be root :)

Don't work. Add test.

It is a simple script, it works from the app's main directory, and from its own directory.

Utlitiy should work from any directory. Just use absolute path.

bin/queue

vjik · 2023-11-23T07:18:56Z

bin/queue

+use Yiisoft\Di\Container;
+use Yiisoft\Di\ContainerConfig;
+
+$autoload = $GLOBALS['_composer_autoload_path'] ?? './vendor/autoload.php';


Suggested change

$autoload = $GLOBALS['_composer_autoload_path'] ?? './vendor/autoload.php';

$autoload = $_composer_autoload_path ?? dirname(__DIR__, 3) . '/vendor/autoload.php';

https://getcomposer.org/doc/articles/vendor-binaries.md#finding-the-composer-autoloader-from-a-binary

vjik · 2023-11-23T07:19:13Z

bin/queue

+require_once $autoload;
+
+/** @var array $definitions */
+$definitions = require_once 'definitions.php';


Suggested change

$definitions = require_once 'definitions.php';

$definitions = require_once __DIR__ . 'definitions.php';

If you use the absolute path, when you copy the definitions to the ROOT Directory of the app, not work.

Not need copy definitions.

If necessary, suppose that i have a different configuration than the predetermined, for example, i used monolog, when updating new version will lose my changes, that is fine, only when your configuration is equal to the predetermine

vjik · 2023-11-23T07:20:58Z

README.md

+
+Just install `yiisoft/yii-console` package and you are ready to go.
+
+## Usage with Symfony Console


For use with Symfony Console we should add commands to Symfony Console and do not use files from bin.

https://symfony.com/doc/current/components/console.html#creating-a-console-application Well in the documents it clearly says that you must register a script and add the commands, it is what is done in this PR.

We should add instruction for use commands with symfony console that alreasy used in user app.

I have to investigate it, i suggest merging this PR, and do it in another.

https://symfony.com/doc/current/console.html#registering-the-command According to this they are already registered, and the Symfony console should recognize them.

README.md

terabytesoftw · 2023-11-23T17:39:23Z

yiisoft/actions#66 fix mutation actions.

vjik · 2023-11-24T07:50:34Z

README.md

@@ -37,6 +37,48 @@ or add

 to the `require` section of your `composer.json` file.

+## Usage with Queue utility
+
+1. Copy configuration file `./vendor/yiisoft/yii-queue/bin/QueueContainer.php` to `root` folder of your project.


Suggest require the user to create yii-queue-params.php in root directory with queue params only and don't require copy full container configuration. It's more cleary...

xepozz · 2023-12-25T07:33:38Z

bin/QueueContainer.php

@@ -0,0 +1,83 @@
+<?php


Emm, why do we need it?
Isn't it better to use all users' configs instead?

samdark · 2023-12-25T14:07:14Z

I think we need to adjust it the same way as yiisoft/db-migration@e0e4e49

Use yiisoft/yii-console with optional.

9289565

Remove yiisoft/config.

e1f76cd

terabytesoftw marked this pull request as ready for review November 22, 2023 10:37

terabytesoftw requested review from viktorprogger and s1lver November 22, 2023 10:41

vjik added 2 commits November 22, 2023 17:03

Merge branch 'master' into use-yii-console-optional

d4b979e

Merge branch 'master' into use-yii-console-optional

869a548

vjik requested changes Nov 22, 2023

View reviewed changes

terabytesoftw added 8 commits November 22, 2023 12:51

Remove yiisoft/yii-console in tests.

239da6c

Remove YII_PATH.

ffb4cab

Use NullLogger:.class for default.

3ee2b20

Allow running the command from any directory.

81fc0d2

Add simple tests.

d6563e7

Fix script again.

3f7b78c

Fix run any directory,

5216463

Remove check logger.

2fe344d

vjik requested changes Nov 23, 2023

View reviewed changes

samdark reviewed Nov 23, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

Apply suggest review.

c854a14

terabytesoftw added 3 commits November 23, 2023 15:19

Uase attribute for register commands.

73df35d

Improve config.

ed418eb

Update README.md.

5d77c41

vjik reviewed Nov 24, 2023

View reviewed changes

xepozz reviewed Dec 25, 2023

View reviewed changes

bin/QueueContainer.php

@@ -0,0 +1,83 @@

<?php

Copy link

Contributor

xepozz Dec 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Emm, why do we need it?
Isn't it better to use all users' configs instead?

Merge branch 'master' into use-yii-console-optional.

7910e61

vjik added the status:under development Someone is working on a pull request. label Jan 5, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use `yiisoft/yii-console` with optional. #178

Use `yiisoft/yii-console` with optional. #178

terabytesoftw commented Nov 21, 2023

what-the-diff bot commented Nov 21, 2023

codecov bot commented Nov 22, 2023 •

edited

Loading

vjik Nov 22, 2023

terabytesoftw Nov 22, 2023

vjik Nov 22, 2023

vjik Nov 22, 2023

terabytesoftw Nov 22, 2023 •

edited

Loading

vjik Nov 22, 2023

terabytesoftw Nov 22, 2023

vjik Nov 22, 2023

terabytesoftw Nov 22, 2023

terabytesoftw Nov 22, 2023

vjik Nov 22, 2023

terabytesoftw Nov 22, 2023

vjik Nov 22, 2023

vjik Nov 23, 2023

vjik Nov 23, 2023

terabytesoftw Nov 23, 2023 •

edited

Loading

vjik Nov 23, 2023

terabytesoftw Nov 23, 2023 •

edited

Loading

vjik Nov 23, 2023

terabytesoftw Nov 23, 2023

vjik Nov 23, 2023

terabytesoftw Nov 23, 2023 •

edited

Loading

terabytesoftw Nov 23, 2023

terabytesoftw commented Nov 23, 2023

vjik Nov 24, 2023

xepozz Dec 25, 2023

samdark commented Dec 25, 2023

	$autoload = $GLOBALS['_composer_autoload_path'] ?? './vendor/autoload.php';
	$autoload = $_composer_autoload_path ?? dirname(__DIR__, 3) . '/vendor/autoload.php';

	$definitions = require_once 'definitions.php';
	$definitions = require_once __DIR__ . 'definitions.php';


		Just install `yiisoft/yii-console` package and you are ready to go.

		## Usage with Symfony Console

Use yiisoft/yii-console with optional. #178

Are you sure you want to change the base?

Use yiisoft/yii-console with optional. #178

Conversation

terabytesoftw commented Nov 21, 2023

what-the-diff bot commented Nov 21, 2023

PR Summary

codecov bot commented Nov 22, 2023 • edited Loading

Codecov Report

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

terabytesoftw Nov 22, 2023 • edited Loading

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

terabytesoftw Nov 23, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

terabytesoftw Nov 23, 2023 • edited Loading

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

terabytesoftw Nov 23, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

terabytesoftw commented Nov 23, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

samdark commented Dec 25, 2023

Use `yiisoft/yii-console` with optional. #178

Use `yiisoft/yii-console` with optional. #178

codecov bot commented Nov 22, 2023 •

edited

Loading

terabytesoftw Nov 22, 2023 •

edited

Loading

terabytesoftw Nov 23, 2023 •

edited

Loading

terabytesoftw Nov 23, 2023 •

edited

Loading

terabytesoftw Nov 23, 2023 •

edited

Loading