breaking: support use of codacy api token - PLUTO-1379 #58

franciscoovazevedo · 2025-04-07T13:12:09Z

Removed support for project-token (repository token).

Copilot

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

Comments suppressed due to low confidence (2)

.codacy/codacy.yaml:5

Verify that downgrading ESLint from 9.3.0 to 8.57.0 is intentional, as this may introduce compatibility issues if other parts of the project expect the newer version.

    - [email protected]

cmd/init.go:224

Consider including the HTTP status code or response details in the error message to improve debugging when the Codacy API call fails.

return errors.New("failed to get repository's configuration from Codacy API")

Copilot

Copilot reviewed 9 out of 11 changed files in this pull request and generated 2 comments.

Files not reviewed (2)

.codacy/cli-config.yaml: Language not supported
.codacy/codacy.yaml: Language not supported

Copilot · 2025-04-07T18:51:02Z

cmd/init.go


 	for _, tool := range tools {
-		if tool.Uuid == "f8b29663-2cb2-498d-b923-a10c6a8c05cd" {
+		switch tool.Uuid {


The switch on tool.Uuid compares against string(ESLint), but ESLint is defined as 'eslint' in domain/toolName.go, which is not a UUID. Use the proper UUID constants (e.g. those defined as ToolUiid) for accurate comparisons.

Copilot · 2025-04-07T18:51:02Z

cmd/init.go

+	case string(ESLint):
+		if len(patternConfiguration) > 0 {


This case statement compares tool.Uuid to string(ESLint) where the constant value 'eslint' does not match the expected UUID. Replace it with the correct UUID constant from ToolUiid to ensure proper matching.

Suggested change

case string(ESLint):

if len(patternConfiguration) > 0 {

case tools.ToolUuidESLint:

machadoit · 2025-04-08T09:33:33Z

cmd/init.go


 func init() {
-	initCmd.Flags().StringVar(&codacyRepositoryToken, "repository-token", "", "optional codacy repository token, if defined configurations will be fetched from codacy")
+	initCmd.Flags().StringVar(&codacyApiToken, "codacy-api-token", "", "optional codacy api token, if defined configurations will be fetched from codacy")


We can simplify it

Suggested change

initCmd.Flags().StringVar(&codacyApiToken, "codacy-api-token", "", "optional codacy api token, if defined configurations will be fetched from codacy")

initCmd.Flags().StringVar(&codacyApiToken, "api-token", "", "optional codacy api token, if defined configurations will be fetched from codacy")

machadoit · 2025-04-08T09:34:04Z

cmd/init.go

 func init() {
-	initCmd.Flags().StringVar(&codacyRepositoryToken, "repository-token", "", "optional codacy repository token, if defined configurations will be fetched from codacy")
+	initCmd.Flags().StringVar(&codacyApiToken, "codacy-api-token", "", "optional codacy api token, if defined configurations will be fetched from codacy")
+	initCmd.Flags().StringVar(&remoteProvider, "provider", "", "optional provider (gh/bb/gl), if defined configurations will be fetched from codacy")


We can focus on a semantic of 'mandatory when the api-token is defined. Will help users and the model

cmd/init.go

machadoit · 2025-04-08T09:47:28Z

cmd/init.go


-	// Create a new GET request
-	req, err := http.NewRequest("GET", url, nil)
+	apiTools, err := tools.GetRepositoryTools(CodacyApiBase, token, remoteProvider, remoteOrganizationName, remoteRepositoryName)


Can we make it something like repositoryTools. We aligned that GetRepositoryTools returns the tools for the repository in question (the ones that we are interested, meaning the enabled ones), already filtered by what is supported on the CLI.

//Concepts:
repositoryTools + supportedToolsOnCLI => configuredRepositoryTools

//supportedToolsOnCLI
Come from the tools on the configuration .tools (config is available globally, but in some places we also pass it)

machadoit · 2025-04-08T09:51:20Z

cmd/init.go

+			remoteRepositoryName,
+			tool.Uuid)
+
+		fmt.Printf("url: %q\n", url)


Probably debug and remove?

machadoit · 2025-04-08T09:52:48Z

cmd/init.go

-			},
-		)
+		createToolFileConfigurations(tool, apiToolConfigurations)
+		// TODO: Process the response and create configuration files for each tool


leftovers delete

machadoit · 2025-04-08T09:54:02Z

cmd/init.go


-	//ESLInt internal codacy uuid, to filter ot not ESLint tools
-	//"f8b29663-2cb2-498d-b923-a10c6a8c05cd"
+			eslintConfigFile, err := os.Create("eslint.config.mjs")


When rebasing the @andrzej-janczak PR (already merged) make sure you don't break the new path to create those config files

codacy-production · 2025-04-09T09:20:24Z

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ -0.25%	✅ 14.86%

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (`93219d2`)	2260	600	26.55%
Head commit (`eff63cf`)	2274 (+14)	598 (-2)	26.30% (-0.25%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#58)	222	33	14.86%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings Change summary preferences

support use of codacy api token

fc611e8

franciscoovazevedo requested a review from Copilot April 7, 2025 13:12

franciscoovazevedo marked this pull request as draft April 7, 2025 13:12

Copilot AI reviewed Apr 7, 2025

View reviewed changes

franciscoovazevedo force-pushed the api-token-pluto-1379 branch from 0d3187b to 9527ac8 Compare April 7, 2025 17:15

refactor and using only codacy-api-token

b8b9eae

franciscoovazevedo force-pushed the api-token-pluto-1379 branch from 9527ac8 to b8b9eae Compare April 7, 2025 17:20

franciscoovazevedo changed the title ~~feature: support use of codacy api token - PLUTO-1379~~ breaking: support use of codacy api token - PLUTO-1379 Apr 7, 2025

franciscoovazevedo requested a review from Copilot April 7, 2025 18:49

Copilot AI reviewed Apr 7, 2025

View reviewed changes

machadoit reviewed Apr 8, 2025

View reviewed changes

franciscoovazevedo added 3 commits April 8, 2025 17:05

code review changes applied

ed511ef

wip

e8fada6

merged main with success

26ba75c

franciscoovazevedo force-pushed the api-token-pluto-1379 branch 2 times, most recently from 429f844 to b908087 Compare April 9, 2025 09:19

franciscoovazevedo marked this pull request as ready for review April 9, 2025 09:24

merge issues fixed

b3932f5

franciscoovazevedo force-pushed the api-token-pluto-1379 branch from b908087 to b3932f5 Compare April 9, 2025 09:50

fixed problem with initializition due to tools processing

b4bfe46

franciscoovazevedo force-pushed the api-token-pluto-1379 branch from a015dce to b4bfe46 Compare April 9, 2025 10:35

deleted pmd-ruleset

eff63cf

machadoit approved these changes Apr 9, 2025

View reviewed changes

franciscoovazevedo merged commit dd841e6 into main Apr 9, 2025
7 checks passed

alerizzo deleted the api-token-pluto-1379 branch June 3, 2025 09:44

	case string(ESLint):
	if len(patternConfiguration) > 0 {
	case tools.ToolUuidESLint:

	initCmd.Flags().StringVar(&codacyApiToken, "codacy-api-token", "", "optional codacy api token, if defined configurations will be fetched from codacy")
	initCmd.Flags().StringVar(&codacyApiToken, "api-token", "", "optional codacy api token, if defined configurations will be fetched from codacy")

breaking: support use of codacy api token - PLUTO-1379 #58

breaking: support use of codacy api token - PLUTO-1379 #58

Uh oh!

Conversation

franciscoovazevedo commented Apr 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codacy-production bot commented Apr 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage summary from Codacy

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

franciscoovazevedo commented Apr 7, 2025 •

edited

Loading

codacy-production bot commented Apr 9, 2025 •

edited

Loading