Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[2778] Authorize empty string for direct edit #2781

Merged
merged 2 commits into from Dec 14, 2023

Conversation

frouene
Copy link
Contributor

@frouene frouene commented Dec 8, 2023

Bug: #2778

Pull request template

General purpose

What is the main goal of this pull request?

  • Bug fixes
  • New features
  • Documentation
  • Cleanup
  • Tests
  • Build / releng

Project management

  • Has the pull request been added to the relevant project and milestone? (Only if you know that your work is part of a specific iteration such as the current one)
  • Have the priority: and pr: labels been added to the pull request? (In case of doubt, start with the labels priority: low and pr: to review later)
  • Have the relevant issues been added to the pull request?
  • Have the relevant labels been added to the issues? (area:, difficulty:, type:)
  • Have the relevant issues been added to the same project and milestone as the pull request?
  • Has the CHANGELOG.adoc been updated to reference the relevant issues?
  • Have the relevant API breaks been described in the CHANGELOG.adoc? (Including changes in the GraphQL API)
  • In case of a change with a visual impact, are there any screenshots in the CHANGELOG.adoc? For example in doc/screenshots/2022.5.0-my-new-feature.png

Architectural decision records (ADR)

  • Does the title of the commit contributing the ADR start with [doc]?
  • Are the ADRs mentioned in the relevant section of the CHANGELOG.adoc?

Dependencies

  • Are the new / upgraded dependencies mentioned in the relevant section of the CHANGELOG.adoc?
  • Are the new dependencies justified in the CHANGELOG.adoc?

Frontend

This section is not relevant if your contribution does not come with changes to the frontend.

General purpose

  • Is the code properly tested? (Plain old JavaScript tests for business code and tests based on React Testing Library for the components)

Typing

We need to improve the typing of our code, as such, we require every contribution to come with proper TypeScript typing for both changes contributing new files and those modifying existing files.
Please ensure that the following statements are true for each file created or modified (this may require you to improve code outside of your contribution).

  • Variables have a proper type
  • Functions’ arguments have a proper type
  • Functions’ return type are specified
  • Hooks are properly typed:
    • useMutation<DATA_TYPE, VARIABLE_TYPE>(…)
    • useQuery<DATA_TYPE, VARIABLE_TYPE>(…)
    • useSubscription<DATA_TYPE, VARIABLE_TYPE>(…)
    • useMachine<CONTEXT_TYPE, EVENTS_TYPE>(…)
    • useState<STATE_TYPE>(…)
  • All components have a proper typing for their props
  • No useless optional chaining with ?. (if the GraphQL API specifies that a field cannot be null, do not treat it has potentially null for example)
  • Nullable values have a proper type (for example let diagram: Diagram | null = null;)

Backend

This section is not relevant if your contribution does not come with changes to the backend.

General purpose

  • Are all the event handlers tested?
  • Are the event processor tested?
  • Is the business code (services) tested?
  • Are diagram layout changes tested?

Architecture

  • Are data structure classes properly separated from behavioral classes?
  • Are all the relevant fields final?
  • Is any data structure mutable? If so, please write a comment indicating why
  • Are behavioral classes either stateless or side effect free?

Review

How to test this PR?

Please describe here the various use cases to test this pull request

  • Has the Kiwi TCMS test suite been updated with tests for this contribution?

Copy link
Member

@sbegaudeau sbegaudeau left a comment

Choose a reason for hiding this comment

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

I don't have any issue with the code, it looks exactly as it should but could you update the test suite project/diagrams/graphical-dnd.cy.js to our new standards and fix its flakiness.

<?xml version="1.0" encoding="UTF-8"?>
<testsuites name="Mocha Tests" time="24.036" tests="1" failures="1">
  <testsuite name="Root Suite" timestamp="2023-12-08T16:36:07" tests="0" file="cypress/e2e/project/diagrams/graphical-dnd.cy.js" time="0.000" failures="0">
  </testsuite>
  <testsuite name="/projects/:projectId/edit - graphical DnD" timestamp="2023-12-08T16:36:07" tests="1" time="24.022" failures="1">
    <testcase name="/projects/:projectId/edit - graphical DnD Check graphical Drag and Drop" time="0.000" classname="Check graphical Drag and Drop">
      <failure message="expected false to be true" type="AssertionError"><![CDATA[AssertionError: expected false to be true
    at Context.eval (webpack:///./cypress/support/reactFlowCommands.js:51:64)

      + expected - actual:  failed to generate Mocha diff
]]></failure>
    </testcase>
  </testsuite>
</testsuites>

Once you will have updated the pull request, I won't require you to update yet another test. Have a look at the explorer.cy.ts suite to see how you could improve it and don't hesitate to talk to me if you have any question. An improvement to our integration tests to help validate your contribution would be nice too.

I'm sorry to have to force everybody to help in this effort of improving our integration tests but it won't move forward otherwise.

Copy link
Member

@pcdavid pcdavid left a comment

Choose a reason for hiding this comment

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

This should probably also apply to TreeItemDirectEditInput?

@frouene frouene force-pushed the fro/fix/direct_edit_empty branch 2 times, most recently from 3ee5fea to 0b59514 Compare December 13, 2023 15:19
Copy link
Member

@pcdavid pcdavid left a comment

Choose a reason for hiding this comment

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

Only minor remarks.

integration-tests/cypress/workbench/Details.ts Outdated Show resolved Hide resolved
integration-tests/cypress/workbench/Details.ts Outdated Show resolved Hide resolved
@frouene frouene force-pushed the fro/fix/direct_edit_empty branch 2 times, most recently from e34fdad to 972cdd0 Compare December 14, 2023 08:31
Bug: #2778
Signed-off-by: Florian ROUËNÉ <florian.rouene@obeosoft.com>
Signed-off-by: Florian ROUËNÉ <florian.rouene@obeosoft.com>
@frouene frouene dismissed sbegaudeau’s stale review December 14, 2023 11:01

Cypress test has been changed

@frouene frouene merged commit 6cdcb2e into master Dec 14, 2023
3 of 4 checks passed
@frouene frouene deleted the fro/fix/direct_edit_empty branch December 14, 2023 11:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Leaving direct edit with empty text doesn't close the input
4 participants