feat: [#576] add package manager functionality#920

almas-x · 2025-02-28T09:56:22Z

📑 Description

This feature introduces a package manager to handle the installation and uninstallation of packages within the framework. A setup folder is created in the package repository’s root directory, containing the setup.go file. The setup.go file handles key package management operations such as registering providers, adding configuration settings, and modifying Go files in the project.

The part of the package manager responsible for registering providers is automatically handled when creating a new package using the artisan make:package command. This ensures that the necessary providers are registered in the configuration files when installing a new package. For example, when installing the Redis package (github.com/goravel/redis), the ServiceProvider for Redis is added to config/app.go.

For example, using the Redis package (github.com/goravel/redis) as a case study, the package manager performs the following tasks:

Installation Process:

It modifies the config/app.go file to register the Redis service provider, ensuring that Redis is available for use throughout the application.
It updates config/cache.go and config/queue.go to include necessary imports, configuration options, and Redis drivers, enabling caching and queue functionalities powered by Redis.

Uninstallation Process:

It undoes the installation actions by removing the corresponding imports, provider registrations, and configurations from app.go, cache.go, and queue.go.

The installation and uninstallation processes are executed via command line, providing a simple and efficient way to manage packages. To install a package, run:

./artisan package:install github.com/goravel/redis

To uninstall the package, run:

./artisan package:uninstall github.com/goravel/redis

Additionally, the package manager supports a --force (-f) flag, which allows the installation process to proceed even if errors are encountered.

The setup.go file in the manager folder is responsible for managing the core functionality of the package manager. Below is the complete example code for the manager.go file:

package main

import (
	"os"

	pkgcontracts "github.com/goravel/framework/contracts/packages"
	"github.com/goravel/framework/packages"
	"github.com/goravel/framework/support/path"
)

func main() {
	setup := packages.Setup(os.Args)
	setup.Install(
		packages.ModifyGoFile{
			File: path.Config("app.go"),
			Modifiers: []pkgcontracts.GoNodeModifier{
				packages.AddImportSpec(setup.Module),
				packages.AddProviderSpecBefore(
					"&redis.ServiceProvider{}",
					"&cache.ServiceProvider{}",
				),
			},
		},
		packages.ModifyGoFile{
			File: path.Config("cache.go"),
			Modifiers: []pkgcontracts.GoNodeModifier{
				packages.AddImportSpec("github.com/goravel/framework/contracts/cache"),
				packages.AddImportSpec("github.com/goravel/redis/facades", "redisfacades"),
				packages.AddConfigSpec("cache.stores", "redis", `
map[string]any{
        "driver": "custom",
        "connection": "default",
        "via": func() (cache.Driver, error) {
                return redisfacades.Cache("redis")
        },
}
`),
			},
		},
		packages.ModifyGoFile{
			File: path.Config("queue.go"),
			Modifiers: []pkgcontracts.GoNodeModifier{
				packages.AddImportSpec("github.com/goravel/framework/contracts/queue"),
				packages.AddImportSpec("github.com/goravel/redis/facades", "redisfacades"),
				packages.AddConfigSpec("queue.connections", "redis", `
map[string]any{
        "driver": "custom",
        "connection": "default",
        "via": func() (queue.Driver, error) {
                return redisfacades.Queue("redis")
        },
}`),
			},
		})

	setup.Uninstall(
		packages.ModifyGoFile{
			File: path.Config("app.go"),
			Modifiers: []pkgcontracts.GoNodeModifier{
				packages.RemoveImportSpec(setup.Module),
				packages.RemoveProviderSpec("&redis.ServiceProvider{}"),
			},
		},
		packages.ModifyGoFile{
			File: path.Config("cache.go"),
			Modifiers: []pkgcontracts.GoNodeModifier{
				packages.RemoveImportSpec("github.com/goravel/framework/contracts/cache"),
				packages.RemoveImportSpec("github.com/goravel/redis/facades", "redisfacades"),
				packages.RemoveConfigSpec("cache.stores.redis"),
			},
		},
		packages.ModifyGoFile{
			File: path.Config("queue.go"),
			Modifiers: []pkgcontracts.GoNodeModifier{
				packages.RemoveImportSpec("github.com/goravel/framework/contracts/queue"),
				packages.RemoveImportSpec("github.com/goravel/redis/facades", "redisfacades"),
				packages.RemoveConfigSpec("queue.connections.redis"),
			},
		})

	setup.Execute()
}

Local Package Support

This feature also supports local package installation. For example, a local package can be created using:

./artisan make:package -m somepkg

Then, the package can be installed using the package manager:

./artisan package:install goravel/packages/somepkg

Closes goravel/goravel#576?

@coderabbitai summary

✅ Checks

Added test cases for my code

coderabbitai · 2025-02-28T09:56:29Z

Important

Review skipped

Auto reviews are limited to specific labels.

🏷️ Labels to auto review (1)

🚀 Review Ready

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

codecov · 2025-02-28T10:00:03Z

Codecov Report

Attention: Patch coverage is 66.71924% with 211 lines in your changes missing coverage. Please review.

Project coverage is 69.06%. Comparing base (f437993) to head (b1eab1c).
Report is 15 commits behind head on master.

Files with missing lines	Patch %	Lines
foundation/console/package_uninstall_command.go	0.00%	59 Missing ⚠️
foundation/console/package_install_command.go	0.00%	53 Missing ⚠️
packages/matcher.go	79.37%	33 Missing and 13 partials ⚠️
packages/setup.go	0.00%	39 Missing ⚠️
packages/modifier.go	89.09%	4 Missing and 2 partials ⚠️
packages/helper.go	97.52%	2 Missing and 1 partial ⚠️
support/console/execute.go	62.50%	2 Missing and 1 partial ⚠️
foundation/application.go	0.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #920      +/-   ##
==========================================
- Coverage   69.14%   69.06%   -0.09%     
==========================================
  Files         158      168      +10     
  Lines       10607    11364     +757     
==========================================
+ Hits         7334     7848     +514     
- Misses       2942     3163     +221     
- Partials      331      353      +22

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

github-actions

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.50.

Benchmark suite	Current: `72f4028`	Previous: `ab139f2`	Ratio
`BenchmarkFile_ReadWrite`	`332358` ns/op 2073 B/op 28 allocs/op	`212688` ns/op 2072 B/op 28 allocs/op	`1.56`
`BenchmarkFile_ReadWrite - ns/op`	`332358` ns/op	`212688` ns/op	`1.56`

This comment was automatically generated by workflow using github-action-benchmark.

Copilot

Pull Request Overview

This PR introduces package manager functionality to support installation and uninstallation of packages, along with updates to console commands and helper functions for managing Go source modifications. Key changes include:

New console commands for package:install and package:uninstall.
Enhancements to package helper logic (modifiers, matchers, and tests) used in configuration and provider registration.
Updates to the package make command to support a new “manager” flag that generates the package manager files.

Reviewed Changes

Copilot reviewed 21 out of 22 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
foundation/console/package_uninstall_command.go	Implements package uninstallation logic using Go commands.
foundation/console/package_install_command.go	Implements package installation logic with version handling and tidying.
packages/*	Introduces new helper, modifier, matcher functions and test cases.
foundation/console/package_make_command*.go	Adds support for the “manager” flag and updates file generation logic.
foundation/application.go	Registers new package management commands during application boot.

Files not reviewed (1)

go.mod: Language not supported

Comments suppressed due to low confidence (2)

foundation/console/package_make_command_test.go:45

[nitpick] The test error message for flag type assertions can be made more descriptive by clearly indicating whether the failure is for the manager flag or the root flag. This will help in debugging flag configuration issues.

managerFlag, ok := got.Flags[0].(*command.BoolFlag)

foundation/console/package_make_command.go:34

[nitpick] Consider enhancing the usage description for the 'manager' flag to more explicitly state its effect (for example, that it creates a manager folder with the necessary files) so that users immediately understand its functionality.

&command.BoolFlag{ Name: "manager", Aliases: []string{"m"}, Usage: "Create a package manager", DisableDefaultText: true, }

hwbrzzl

Amazing PR 👍

foundation/console/package_install_command.go

hwbrzzl · 2025-03-21T09:09:58Z

foundation/console/package_install_command.go

Can we add some test cases for this file? Although It may be a bit complex.

I will add test case in new PR after merged this one.

foundation/console/package_make_command.go

packages/modifier.go

packages/modifier_test.go

packages/matcher.go

packages/matcher_test.go

contracts/packages/manager.go

foundation/console/execute.go

foundation/console/package_install_command.go

foundation/console/package_make_command_stubs.go

packages/helper_test.go

packages/matcher_test.go

hwbrzzl · 2025-03-25T11:20:11Z

Please pin me if this PR is ready.

almas-x · 2025-03-25T12:48:25Z

Please pin me if this PR is ready.

Almost ready, but I still need to think about the streaming call we discussed last time 🤔

almas-x · 2025-03-26T07:53:56Z

I haven’t figured out a good approach for the streaming call yet. How about using a declarative approach for now and optimizing it later?

almas-x · 2025-03-28T01:53:39Z

I haven’t figured out a good approach for the streaming call yet. How about using a declarative approach for now and optimizing it later?

cc @hwbrzzl

hwbrzzl · 2025-03-28T03:23:20Z

I haven’t figured out a good approach for the streaming call yet. How about using a declarative approach for now and optimizing it later?

cc @hwbrzzl

Oh sorry, missed this message, sure, we can optimize it with #920 (comment) in another PR.

hwbrzzl

Awesome PR 👍

almas-x requested a review from a team as a code owner February 28, 2025 09:56

almas-x marked this pull request as draft February 28, 2025 09:56

almas-x force-pushed the almas/#576 branch from b90ff7c to 72f4028 Compare March 11, 2025 09:02

github-actions bot reviewed Mar 11, 2025

View reviewed changes

almas-x force-pushed the almas/#576 branch from f22480f to 70a1170 Compare March 12, 2025 02:44

almas-x marked this pull request as ready for review March 14, 2025 05:41

almas-x marked this pull request as draft March 14, 2025 05:42

almas-x force-pushed the almas/#576 branch 7 times, most recently from 0b08b3f to 2946b9b Compare March 20, 2025 07:47

almas-x marked this pull request as ready for review March 20, 2025 07:48

almas-x added the 🚀 Review Ready label Mar 20, 2025

almas-x force-pushed the almas/#576 branch from 2946b9b to 26eaa08 Compare March 20, 2025 08:04

feat: [#576] add package manager functionality

81ae831

almas-x force-pushed the almas/#576 branch from 26eaa08 to 81ae831 Compare March 20, 2025 08:21

hwbrzzl requested a review from Copilot March 21, 2025 08:30

Copilot AI reviewed Mar 21, 2025

View reviewed changes

hwbrzzl reviewed Mar 21, 2025

View reviewed changes

almas-x force-pushed the almas/#576 branch from f893d38 to a0f8da0 Compare March 21, 2025 18:23

hwbrzzl reviewed Mar 22, 2025

View reviewed changes

almas-x force-pushed the almas/#576 branch 4 times, most recently from 446e763 to da055d8 Compare March 24, 2025 05:06

almas-x force-pushed the almas/#576 branch 2 times, most recently from 56c478c to f5a081e Compare March 24, 2025 06:45

fix issues raised in the review

b1eab1c

almas-x force-pushed the almas/#576 branch from f5a081e to b1eab1c Compare March 25, 2025 01:46

hwbrzzl approved these changes Mar 28, 2025

View reviewed changes

almas-x merged commit 9fe0192 into master Mar 28, 2025
11 of 13 checks passed

almas-x deleted the almas/#576 branch March 28, 2025 05:07

This was referenced Mar 31, 2025

migration and seeder can be registered automatically when using commands create them goravel/goravel#649

Closed

Generate some fluent methods for package management goravel/goravel#650

Closed

Conversation

almas-x commented Feb 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📑 Description

✅ Checks

Uh oh!

coderabbitai bot commented Feb 28, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

codecov bot commented Feb 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

⚠️ Performance Alert ⚠️

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

hwbrzzl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

hwbrzzl Mar 21, 2025

Choose a reason for hiding this comment

Uh oh!

almas-x Mar 21, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hwbrzzl commented Mar 25, 2025

Uh oh!

almas-x commented Mar 25, 2025

Uh oh!

almas-x commented Mar 26, 2025

Uh oh!

almas-x commented Mar 28, 2025

Uh oh!

hwbrzzl commented Mar 28, 2025

Uh oh!

hwbrzzl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

almas-x commented Feb 28, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Feb 28, 2025 •

edited

Loading