feat: env management commands #37

35C4n0r · 2024-11-24T11:34:51Z

Closes #18
/claim #18

# Conflicts: # source/commands/login.tsx # source/lib/api.ts

gemanor · 2024-11-25T08:14:31Z

@35C4n0r the lint has some errors..

gemanor · 2024-11-29T08:10:08Z

Hey, some functional comments:

When running env select commands, and there's only one workspace or one project, it should skip the selection. For now, even if one project/environment is presented, it let's the user choose between them. Please ensure if there's only one element in a select step, it gets skipped.
In copy command, it is hard to get the env id. We should keep it in the same way we did with other commands. Using the select element. Please use the same SelectEnvironment that allows the user to select the environment they want to copy from a select element. Then, just ask for the name of the new environment and copy it.
In general, this ink-form makes things complex. The default should be copied to a new environment, and the form is just a wizard, the same as we do with other commands. Only in case that --existing argument is passed will the existing ID be asked for and copied.
Also, in the member command, please just use a wizard as we did in the login and such. The form is making the experience complex. If someone want's a form, then they can use it in the UI.

gemanor · 2024-11-29T08:34:16Z

Please merge from main

# Conflicts: # .gitignore # package-lock.json # package.json

gemanor · 2024-12-01T06:03:59Z

Hey, @35C4n0r, the copy command does not work for me. Can you please test that?

35C4n0r · 2024-12-01T06:44:07Z

@gemanor, pushed a change that fixes the issue, It now handles the case when --env-name is not passed as a cli option

gemanor · 2024-12-01T11:17:58Z

@35C4n0r, the scope is redundnat (just use the default), and the description/strategy should be also in the wizard, not only as variables

35C4n0r · 2024-12-01T14:43:50Z

@gemanor done!

gemanor · 2024-12-02T07:01:48Z

The tests are failing now. Also, the success message is missing from the copy command.
Please make sure it is all passed and that you're running sanity tests on all the commands before asking review.

gemanor · 2024-12-02T07:02:56Z

There are also many linting warning. Please ensure you're fixing the useEffect dependencies problems. Just use the standard practices like useCallback/useMemo and pure functions to avoid such.

35C4n0r · 2024-12-02T09:14:02Z

@gemanor fixed the error

35C4n0r · 2024-12-02T09:15:33Z

As for the warnings, if I don't want something to be the dependency of a useEffect, why should I add it in the dependency array?

35C4n0r · 2024-12-02T11:41:48Z

@gemanor, fixed the warnings

gemanor

Great job! Appreciate the effort!

Please address the comments and attach a sanity test video for the following flows after addressing them)

Environment copy
- To new one with a wizard
- To a new one with variables provided (all provided, and partially provided - see CR)
- To an existing environment that exists
- To an existing environment that does not exist (fail)
Invite member
- With organization-level key
- With project-level key
- With wrong key
- With environment-level key
- With provided project/environment variables (see CR)
- With an email that is already a member
Environment select
- With all optional values as variables
Login flow on Windows (you said something about the port?)

gemanor · 2024-12-09T09:26:36Z

source/commands/env/copy.tsx

+} from '../../components/EnvironmentSelection.js';
+import SelectInput from 'ink-select-input';
+
+export const options = zod.object({


The structure of the inputs needs to make true sense for consistent flow.

Here are the following variables that should be supported:

key(string) - API Key to be used for the environment copying (should be at least a project level key)

from(string) - Optional: set the environment ID to copy from. In case not set, the CLI lets you select one.

name(string) - Optional: The environment name to copy to. In case not set, the CLI will ask you for one.

description(string) - Optional: The new environment description. In case not set, the CLI will ask you for it.

to(string) - Optional: copy the environment to an existing environment. In case this variable is set, the 'name' and 'description' variables will be ignored'

conflictStrategy(enum | "fail" "overwrite") - Optional: Set the environment conflict strategy. In case not set, will use "fail"

The logic should be:

If all variables are provided (name/description or existing), just perform the copy

If any of the variables are provided, skip the step of configuring it

If the existing provided together with name/description, show an error

If the existing id is provided and it's not exist, show an error

Two steps now are redundant:

Choose existing environment (should be provided as variable, if not its mean the wizard should copy the new one)

Choose conflict strategy (default should be fail, if someone wants to change it, they need to pass it as a variable)

source/commands/env/copy.tsx

gemanor · 2024-12-09T09:27:59Z

source/commands/env/copy.tsx

+		// checks if the api_key scope >= project_level &
+		// sets the apiKey and sets the projectFrom
+
+		const validateApiKeyScope = async () => {


This hook should be external and be shared with other project-level commands such as select

source/commands/env/member.tsx

gemanor · 2024-12-09T09:42:08Z

source/commands/env/member.tsx

+	}, [error, state]);
+
+	useEffect(() => {
+		if (apiKey && tokenType(apiKey) === TokenType.APIToken) {


See comment in the previous component. This function should be an external hook as it's share logic between many components.

source/commands/login.tsx

source/components/EnvironmentSelection.tsx

gemanor · 2024-12-09T10:04:05Z

source/hooks/useApiKeyApi.ts

+	environment_id: string | null;
+}
+
+export const useApiKeyApi = () => {


Could be use for all the API Key level errors etc.

gemanor · 2024-12-09T10:05:58Z

source/hooks/useRolesApi.ts

@@ -0,0 +1,40 @@
+import { apiCall } from '../lib/api.js';


This file is not being used anywhere

gemanor · 2024-12-11T07:55:30Z

@35C4n0r any updates on that?

35C4n0r added 12 commits November 6, 2024 11:55

feat: refactored login flow and hooks

c382463

feat: more verbose errors

197314f

fix: LoginFlow when apiKey is given.

6f59601

chore: remove comments

b9ec416

ref: refactor hooks

7136f13

feat: ApiKey hook

29c2ac3

feat: api-key validation

bb162b0

fix: fix bugs

d98af59

Merge branch 'refs/heads/main' into ref-login-components

9f66f7f

# Conflicts: # source/commands/login.tsx # source/lib/api.ts

chore: remove log statements

00c9edf

chore: minor imporvs

125ea84

feat: env management commands

c957917

algora-pbc bot mentioned this pull request Nov 24, 2024

Permit Environment Management Commands #18

Open

algora-pbc bot added the 🙋 Bounty claim label Nov 24, 2024

35C4n0r added 4 commits November 25, 2024 00:31

Merge branch 'refs/heads/main' into feat-env-command

8b7cab5

chore: lint

573c523

chore: lint

4d99de8

chore: lint

76c0cbe

35C4n0r added 2 commits November 26, 2024 00:27

chore: fix lint issues

72c5837

chore: add tests

b896855

35C4n0r added 3 commits November 30, 2024 00:30

fix: minor updates

98103aa

Merge branch 'refs/heads/main' into feat-env-command

ecab4bb

# Conflicts: # .gitignore # package-lock.json # package.json

chore: update package-lock.json

0745d26

gemanor mentioned this pull request Nov 30, 2024

Unit test for the components #43

Open

fix: take env name in input

02875e8

fix: small fixes

286561a

fix: small fixes

1026d3e

chore: eslint fixes

9293499

35C4n0r added 2 commits December 3, 2024 11:04

fix: browser login.tsx

f30fead

chore: minor changes

93300c0

gemanor requested changes Dec 9, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: env management commands #37

feat: env management commands #37

35C4n0r commented Nov 24, 2024

gemanor commented Nov 25, 2024

gemanor commented Nov 29, 2024

gemanor commented Nov 29, 2024

gemanor commented Dec 1, 2024

35C4n0r commented Dec 1, 2024

gemanor commented Dec 1, 2024

35C4n0r commented Dec 1, 2024

gemanor commented Dec 2, 2024

gemanor commented Dec 2, 2024

35C4n0r commented Dec 2, 2024

35C4n0r commented Dec 2, 2024

35C4n0r commented Dec 2, 2024

gemanor left a comment

gemanor Dec 9, 2024

gemanor Dec 9, 2024

gemanor Dec 9, 2024

gemanor Dec 9, 2024

gemanor Dec 9, 2024

gemanor commented Dec 11, 2024

feat: env management commands #37

Are you sure you want to change the base?

feat: env management commands #37

Conversation

35C4n0r commented Nov 24, 2024

gemanor commented Nov 25, 2024

gemanor commented Nov 29, 2024

gemanor commented Nov 29, 2024

gemanor commented Dec 1, 2024

35C4n0r commented Dec 1, 2024

gemanor commented Dec 1, 2024

35C4n0r commented Dec 1, 2024

gemanor commented Dec 2, 2024

gemanor commented Dec 2, 2024

35C4n0r commented Dec 2, 2024

35C4n0r commented Dec 2, 2024

35C4n0r commented Dec 2, 2024

gemanor left a comment

Choose a reason for hiding this comment

gemanor Dec 9, 2024

Choose a reason for hiding this comment

gemanor Dec 9, 2024

Choose a reason for hiding this comment

gemanor Dec 9, 2024

Choose a reason for hiding this comment

gemanor Dec 9, 2024

Choose a reason for hiding this comment

gemanor Dec 9, 2024

Choose a reason for hiding this comment

gemanor commented Dec 11, 2024