Export specific workflow #11939

hyzx86 · 2022-07-02T14:48:04Z

Export the specified workflow from the workflow management interface

…qlui2

…flow

hyzx86 · 2022-07-02T14:49:45Z

@Skrypt Can you review this PR?

hishamco · 2022-07-02T15:49:08Z

Could you please share a GIF screenshot shows how to export the workflow and import it then

hyzx86 · 2022-07-02T16:10:59Z

hyzx86 · 2022-07-02T16:28:01Z

try mp4 file

msedge_qghN7nTjmh.mp4

hishamco

Please format the code, there are many things to fix

hishamco · 2022-07-02T16:59:32Z

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs

@@ -127,7 +131,7 @@ public async Task<IActionResult> Index(WorkflowTypeIndexOptions options, PagerPa

            var workflowTypeIds = workflowTypes.Select(x => x.WorkflowTypeId).ToList();
            var workflowGroups = (await _session.QueryIndex<WorkflowIndex>(x => x.WorkflowTypeId.IsIn(workflowTypeIds))
-                .ListAsync())
+                    .ListAsync())


Remove extra space

Still not reeolved, there's double tabs here

Strangely, I have fixed this problem on my branch, but it is still shown here

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs

hishamco · 2022-07-02T17:12:24Z

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs

+            var deploymentPlanResult = new DeploymentPlanResult(fileBuilder, recipeDescriptor);
+            var data = new JArray();
+            deploymentPlanResult.Steps.Add(new JObject(
+            new JProperty("name", "WorkflowType"),


Add intendation

hishamco · 2022-07-02T17:12:49Z

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs

+            foreach (var workflow in await _workflowTypeStore.GetAsync(itemIds))
+            {
+                var objectData = JObject.FromObject(workflow);
+


Remove the empty line

hishamco · 2022-07-02T17:12:59Z

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs

+                objectData.Remove(nameof(workflow.Id));
+                data.Add(objectData);
+            }
+            await deploymentPlanResult.FinalizeAsync();


Add new line before

hishamco · 2022-07-02T17:13:11Z

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs

+            }
+            await deploymentPlanResult.FinalizeAsync();
+            ZipFile.CreateFromDirectory(fileBuilder.Folder, archiveFileName);
+            return archiveFileName;


Add new line before

hishamco · 2022-07-02T17:13:24Z

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs

+            await deploymentPlanResult.FinalizeAsync();
+            ZipFile.CreateFromDirectory(fileBuilder.Folder, archiveFileName);
+            return archiveFileName;
+


Remove empty line

hishamco · 2022-07-02T17:13:58Z

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs

@@ -207,6 +218,44 @@ public async Task<IActionResult> BulkEdit(WorkflowTypeIndexOptions options, IEnu
            return RedirectToAction(nameof(Index));
        }

+        private async Task<string> ExportWorkflows(params int[] itemIds)


Remove the private methods at the end

hishamco · 2022-07-02T17:14:14Z

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs

+            {
+                return Forbid();
+            }
+            var resultFileName = await ExportWorkflows(id);


Add line before

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs

hishamco

Please double check the format for the entire PR before you request a review to save time

Thanks for your contribution again

hishamco · 2022-07-03T11:13:12Z

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs

@@ -127,7 +131,7 @@ public async Task<IActionResult> Index(WorkflowTypeIndexOptions options, PagerPa

            var workflowTypeIds = workflowTypes.Select(x => x.WorkflowTypeId).ToList();
            var workflowGroups = (await _session.QueryIndex<WorkflowIndex>(x => x.WorkflowTypeId.IsIn(workflowTypeIds))
-                .ListAsync())
+                    .ListAsync())


Still not reeolved, there's double tabs here

hishamco · 2022-07-03T11:15:18Z

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs

                : Url.IsLocalUrl(viewModel.ReturnUrl)
-                   ? (IActionResult)this.Redirect(viewModel.ReturnUrl, true)
-                   : RedirectToAction(nameof(Index));
+                    ? (IActionResult)this.Redirect(viewModel.ReturnUrl, true)


Extra space

The original version of this place has 3 spaces indented, and the automatic indent should be 4, right?

I think this space is extra, not resolved yet!

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs

src/OrchardCore.Modules/OrchardCore.Workflows/OrchardCore.Workflows.csproj

hishamco · 2022-07-03T11:16:59Z

src/OrchardCore.Modules/OrchardCore.Workflows/Views/WorkflowType/Index.cshtml

@@ -46,6 +46,7 @@
                                @T["Actions"]
                            </button>
                            <ul class="dropdown-menu dropdown-menu-end" aria-labelledby="bulk-action-menu-button">
+                                 <li><a class="dropdown-item" href="javascript:void(0)" data-action="Export" data-title="@T["Bulk Action"]" >Export</a></li>


Seems there's n extra space ;)

What are we going to do here?

src/OrchardCore.Modules/OrchardCore.Workflows/Views/WorkflowType/Index.cshtml

coderabbitai

Actionable comments posted: 3

src/OrchardCore.Modules/OrchardCore.Workflows/Deployment/AllWorkflowTypeDeploymentSource.cs

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs

Piedone

Some nitpicks, but almost done.

src/OrchardCore.Modules/OrchardCore.Workflows/Deployment/AllWorkflowTypeDeploymentSource.cs

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs

…rkflowTypeDeploymentSource.cs Co-authored-by: Zoltán Lehóczky <[email protected]>

…flowTypeController.cs Co-authored-by: Zoltán Lehóczky <[email protected]>

coderabbitai · 2024-04-25T06:43:19Z

@hyzx86, I've reviewed the changes related to the UserClaims processing logic and the associated unit test. Here are my observations:

Processing Logic for `UserClaims`

The processing logic for UserClaims is implemented in the DefaultUserClaimsPrincipalProviderFactory class. This class is marked as obsolete, suggesting a transition to using IUserClaimsProvider instead. The logic includes generating claims for the user's email and whether the email is verified. This is done by adding claims directly to the ClaimsIdentity object after fetching the email and its verification status from the user manager.

Unit Test

The unit test EnsurePrincipalHasExpectedClaims in DefaultUserClaimsPrincipalProviderFactoryTests checks the correctness of the claims added to the principal. It verifies:

The presence of the email claim and its correctness.
The presence of the email_verified claim, its type, and its correctness based on whether the email is verified.

Both the processing logic and the unit test appear to be correctly implemented based on the provided snippets. The test covers essential aspects of the functionality, ensuring that the claims are correctly added and have the expected values.

If there are no other specific areas you would like me to look into, this PR seems ready for further actions as per your project's workflow.

Analysis chain

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Find and display the changes related to `UserClaims` processing logic and the associated unit test.
# Assuming the changes might be in files related to user management or authentication, typically involving 'Claims'.

# Search for files that might contain changes related to UserClaims
fd 'UserClaims' --type f --exec cat {} +

# Search for unit tests possibly related to UserClaims
fd 'UserClaims' --type f --exec cat {} + | grep -i 'test'

Length of output: 6432

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Piedone

@hishamco up to you, please approve/merge if suitable.

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs

src/OrchardCore.Modules/OrchardCore.Workflows/Deployment/AllWorkflowTypeDeploymentSource.cs

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs

coderabbitai

Actionable comments posted: 4

src/OrchardCore.Modules/OrchardCore.Workflows/Deployment/AllWorkflowTypeDeploymentSource.cs

…flowTypeController.cs

coderabbitai

Actionable comments posted: 3

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs

…flowTypeController.cs

src/OrchardCore.Modules/OrchardCore.Workflows/Deployment/AllWorkflowTypeDeploymentSource.cs

…rkflowTypeDeploymentSource.cs

Piedone · 2024-04-25T21:15:59Z

@hishamco when you see this, you can just clone the fork and commit to it directly, no need to suffer through self-approved code suggestions.

coderabbitai

Actionable comments posted: 7

coderabbitai · 2024-04-25T21:16:29Z

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs

        private readonly IUpdateModelAccessor _updateModelAccessor;
        private readonly IShapeFactory _shapeFactory;
+        private readonly JsonSerializerOptions _documentJsonSerializerOptions;


The field _documentJsonSerializerOptions should be renamed to _jsonSerializerOptions to match its usage throughout the class.

- private readonly JsonSerializerOptions _documentJsonSerializerOptions; + private readonly JsonSerializerOptions _jsonSerializerOptions;

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

private readonly JsonSerializerOptions _documentJsonSerializerOptions;

private readonly JsonSerializerOptions _jsonSerializerOptions;

coderabbitai · 2024-04-25T21:16:29Z

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs

            IStringLocalizer<WorkflowTypeController> stringLocalizer,
            IHtmlLocalizer<WorkflowTypeController> htmlLocalizer,
-            IUpdateModelAccessor updateModelAccessor)
+            IUpdateModelAccessor updateModelAccessor,
+            IOptions<DocumentJsonSerializerOptions> jsonSerializerOptions)


The constructor parameter should be named documentJsonSerializerOptions to match the field it initializes.

- IOptions<DocumentJsonSerializerOptions> jsonSerializerOptions) + IOptions<DocumentJsonSerializerOptions> documentJsonSerializerOptions)

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

IOptions<DocumentJsonSerializerOptions> jsonSerializerOptions)

IOptions<DocumentJsonSerializerOptions> documentJsonSerializerOptions)

coderabbitai · 2024-04-25T21:16:29Z

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs

            _updateModelAccessor = updateModelAccessor;
            _shapeFactory = shapeFactory;
            S = stringLocalizer;
            H = htmlLocalizer;
+            _documentJsonSerializerOptions = jsonSerializerOptions.Value.SerializerOptions;


The assignment to _documentJsonSerializerOptions should use the corrected field name _jsonSerializerOptions.

- _documentJsonSerializerOptions = jsonSerializerOptions.Value.SerializerOptions; + _jsonSerializerOptions = documentJsonSerializerOptions.Value.SerializerOptions;

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

_documentJsonSerializerOptions = jsonSerializerOptions.Value.SerializerOptions;

_jsonSerializerOptions = documentJsonSerializerOptions.Value.SerializerOptions;

coderabbitai · 2024-04-25T21:16:29Z

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs

@@ -192,6 +198,9 @@ public async Task<IActionResult> BulkEdit(WorkflowTypeIndexOptions options, IEnu
                {
                    case WorkflowTypeBulkAction.None:
                        break;
+                    case WorkflowTypeBulkAction.Export:
+                        return await ExportWorkflows(itemIds.ToArray());


Avoid duplicate calls to ExportWorkflows. Ensure that the method is called only once per action to prevent performance issues.

- return await ExportWorkflows(itemIds.ToArray());

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

return await ExportWorkflows(itemIds.ToArray());

coderabbitai · 2024-04-25T21:16:29Z

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs

+        public async Task<IActionResult> Export(int id)
+        {
+            if (!await _authorizationService.AuthorizeAsync(User, Permissions.ManageWorkflows))
+            {
+                return Forbid();
+            }
+
+            return await ExportWorkflows(id);
+        }


The Export method should be decorated with the [HttpGet] attribute since it is handling a GET request, not a POST.

+ [HttpGet] public async Task<IActionResult> Export(int id)

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

public async Task<IActionResult> Export(int id)

{

if (!await _authorizationService.AuthorizeAsync(User, Permissions.ManageWorkflows))

{

return Forbid();

}

return await ExportWorkflows(id);

}

[HttpGet]

public async Task<IActionResult> Export(int id)

{

if (!await _authorizationService.AuthorizeAsync(User, Permissions.ManageWorkflows))

{

return Forbid();

}

return await ExportWorkflows(id);

}

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs

hishamco · 2024-04-25T21:18:15Z

@hishamco when you see this, you can just clone the fork and commit to it directly, no need to suffer through self-approved code suggestions.

I remember one time ago I accidentally overridden someone else commits :(

agriffard and others added 16 commits May 25, 2022 13:10

graphiql 1.9.3

9a11bf6

1.9.4

9b36d38

Merge branch 'main' into ag/graphiql1.9.3

8e174ab

fix graphql UI OrchardCMS#11831

daf2eb0

remove extra space

5b7496a

Merge branch 'main' into ag/graphiql1.9.3

3be2bf4

1.9.9

610c224

Merge branch 'main' into ag/graphiql1.9.3

2d7f3df

update build

cd23dd2

merge main

40d482a

rebuild graphql orchard

58bc7ff

Merge remote-tracking branch 'origin/ag/graphiql1.9.3' into fix_graph…

d6fbf96

…qlui2

fix graphql ui 1.9.9 OrchardCMS#11768

718ecdd

restore code format

22d5e7a

Merge remote-tracking branch 'origin/main' into Export_specified_Work…

c1ac8f2

…flow

Export the specified workflow

ab07997

hyzx86 requested a review from sfmskywalker as a code owner July 2, 2022 14:48

hishamco requested changes Jul 2, 2022

View reviewed changes

hyzx86 added 2 commits July 3, 2022 02:17

fix code format

ea0e561

move private to end

ba2353f

hyzx86 requested a review from hishamco July 3, 2022 05:12

hishamco requested changes Jul 3, 2022

View reviewed changes

hyzx86 added 3 commits July 3, 2022 22:47

fix code format

44b7e3b

fix code style

54462be

fix code style

55a1458

hyzx86 requested a review from hishamco July 3, 2022 15:16

coderabbitai bot reviewed Apr 24, 2024

View reviewed changes

Piedone mentioned this pull request Apr 24, 2024

Set up CodeRabbit for AI code reviews (Lombiq Technologies: OCORE-159) #15813

Merged

fix code

c82be47

Piedone requested changes Apr 24, 2024

View reviewed changes

hyzx86 and others added 4 commits April 25, 2024 09:24

Update src/OrchardCore.Modules/OrchardCore.Workflows/Deployment/AllWo…

4d2f4e9

…rkflowTypeDeploymentSource.cs Co-authored-by: Zoltán Lehóczky <[email protected]>

Update src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/Work…

d69fd8f

…flowTypeController.cs Co-authored-by: Zoltán Lehóczky <[email protected]>

update

e0fef27

Merge branch 'main' into Export_specified_Workflow

5a4bfa1

Piedone approved these changes Apr 25, 2024

View reviewed changes

Merge branch 'main' into Export_specified_Workflow

8c54c41

hishamco requested changes Apr 25, 2024

View reviewed changes

Apply suggestions from code review

1d04a0e

hishamco approved these changes Apr 25, 2024

View reviewed changes

hishamco requested changes Apr 25, 2024

View reviewed changes

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs Outdated Show resolved Hide resolved

coderabbitai bot reviewed Apr 25, 2024

View reviewed changes

src/OrchardCore.Modules/OrchardCore.Workflows/Deployment/AllWorkflowTypeDeploymentSource.cs Outdated Show resolved Hide resolved

src/OrchardCore.Modules/OrchardCore.Workflows/Deployment/AllWorkflowTypeDeploymentSource.cs Outdated Show resolved Hide resolved

hishamco added 2 commits April 25, 2024 23:44

Update src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/Work…

942e63f

…flowTypeController.cs

Merge branch 'main' into Export_specified_Workflow

4c04662

coderabbitai bot reviewed Apr 25, 2024

View reviewed changes

hishamco requested changes Apr 25, 2024

View reviewed changes

src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/WorkflowTypeController.cs Outdated Show resolved Hide resolved

Update src/OrchardCore.Modules/OrchardCore.Workflows/Controllers/Work…

3a8590d

…flowTypeController.cs

hishamco requested changes Apr 25, 2024

View reviewed changes

src/OrchardCore.Modules/OrchardCore.Workflows/Deployment/AllWorkflowTypeDeploymentSource.cs Outdated Show resolved Hide resolved

src/OrchardCore.Modules/OrchardCore.Workflows/Deployment/AllWorkflowTypeDeploymentSource.cs Outdated Show resolved Hide resolved

Apply suggestions from code review

92ab660

hishamco requested changes Apr 25, 2024

View reviewed changes

src/OrchardCore.Modules/OrchardCore.Workflows/Deployment/AllWorkflowTypeDeploymentSource.cs Outdated Show resolved Hide resolved

Update src/OrchardCore.Modules/OrchardCore.Workflows/Deployment/AllWo…

3495276

…rkflowTypeDeploymentSource.cs

coderabbitai bot reviewed Apr 25, 2024

View reviewed changes

hishamco merged commit f15ccb7 into OrchardCMS:main Apr 25, 2024
4 checks passed

hyzx86 deleted the Export_specified_Workflow branch May 13, 2024 08:41

	private readonly JsonSerializerOptions _documentJsonSerializerOptions;
	private readonly JsonSerializerOptions _jsonSerializerOptions;

	IOptions<DocumentJsonSerializerOptions> jsonSerializerOptions)
	IOptions<DocumentJsonSerializerOptions> documentJsonSerializerOptions)

	_documentJsonSerializerOptions = jsonSerializerOptions.Value.SerializerOptions;
	_jsonSerializerOptions = documentJsonSerializerOptions.Value.SerializerOptions;

Export specific workflow #11939

Export specific workflow #11939

Conversation

hyzx86 commented Jul 2, 2022

hyzx86 commented Jul 2, 2022

hishamco commented Jul 2, 2022

hyzx86 commented Jul 2, 2022

hyzx86 commented Jul 2, 2022

hishamco left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hishamco left a 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

coderabbitai bot left a comment

Choose a reason for hiding this comment

Piedone left a comment

Choose a reason for hiding this comment

coderabbitai bot commented Apr 25, 2024

Processing Logic for UserClaims

Unit Test

Piedone left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

Piedone commented Apr 25, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Apr 25, 2024

Choose a reason for hiding this comment

coderabbitai bot Apr 25, 2024

Choose a reason for hiding this comment

coderabbitai bot Apr 25, 2024

Choose a reason for hiding this comment

coderabbitai bot Apr 25, 2024

Choose a reason for hiding this comment

coderabbitai bot Apr 25, 2024

Choose a reason for hiding this comment

hishamco commented Apr 25, 2024

Processing Logic for `UserClaims`