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.

Sign up for GitHub

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

Jump to bottom

Replace KotlinInquirer #3483

Open
6 of 9 tasks
Nereboss opened this issue Jan 23, 2024 · 3 comments
Open
6 of 9 tasks

Replace KotlinInquirer #3483

Nereboss opened this issue Jan 23, 2024 · 3 comments
Assignees
@Nereboss
Labels
pr-analysis Issues that touch the analysis pr(oject). priority:high Set by PO tech For technical stories without user impact (=refactoring stories).

Comments

@Nereboss
Copy link
Contributor

Nereboss commented Jan 23, 2024 •
edited
Loading

Feature request

As already discussed, KotlinInquirer is an unmaintained repository, which is the source of some bugs and workarounds which cannot be adressed without replacing the tool. We therefore plan to use kotter to 'rebuild' the parts of KotlinInquirer that we used.

Description

As a developer, I want KotlinInquirer to be replaced so that we have more control over issues in the cli that occur because KotlinInquirer is an old, unmaintained repo.

Acceptance criteria

  • All questions from KotlinInquirer that we use is rebuilt
  • All parsers are refactored to use the new functions
  • KotlinInquirer is removed from all dependencies

Necessary refactoring

As all kotter questions need to be inside a 'session' block and only one session block can be used per executed command, the codes structure needs to be refactored, so that a session is only started in one single place.

Development notes (optional Task Breakdown)

  • Implement used functions of KotlinInquirer
    • confirm dialog
    • Input dialog
    • number-input dialog
    • select entry from list dialog
    • select multiple entries from list (checkbox) dialog
  • Test if all implemented functions behave like their counterparts
  • Write tests for new functions
  • Insert new functions into parsers

Open questions

  • Do we use this opportunity to improve the cli?
    • Autocomplete of filepaths
    • Handling of invalid inputs directly in the question -> Has to be done as normal logging does not work inside of a kotter session
    • Loading icons once a parser is started so user knows the program is still running
  • What workarounds did we have to do because of KotlinInquirers limitations and can we build them into our new functions?
  • Which bugs were caused by KotlinInquirer that can now be fixed?
@Nereboss Nereboss added pr-analysis Issues that touch the analysis pr(oject). tech For technical stories without user impact (=refactoring stories). labels Jan 23, 2024
Nereboss added a commit that referenced this issue Jan 23, 2024
@Nereboss
Refactor Inquirer into own module #3483
3194f3d
Nereboss added a commit that referenced this issue Jan 23, 2024
@Nereboss
Add inputNumber function #3483
b729818
Nereboss added a commit that referenced this issue Jan 23, 2024
@Nereboss
Add promptConfirm function #3483
47ab5d9
Nereboss added a commit that referenced this issue Jan 23, 2024
@Nereboss
Add promptList function #3483
ac3c7c0
Nereboss added a commit that referenced this issue Jan 23, 2024
@Nereboss
Add promptCheckbox function #3483
aeef242
Nereboss added a commit that referenced this issue Jan 24, 2024
@Nereboss
Refactor inquirer functions #3483
acad86c 
Class is no longer needed as all functions extend the Session class from Kotter and are applicable in the correct scope
@ce-bo
Copy link
Collaborator

ce-bo commented Jan 25, 2024 •
edited
Loading

Are there still open questions @Nereboss?

@ce-bo ce-bo mentioned this issue Jan 25, 2024
Open
Nereboss added a commit that referenced this issue Feb 2, 2024
@Nereboss
Test Inquirer on StructureModifier; WIP Commit #3483
d57166b 
Still a lot of todos that need to be closed and comments that need to be implemented, as well as finding a solution for the session problem
@Nereboss Nereboss added the blocked The issue or feature is blocked on another issue or PR that has to be resolved first label Feb 9, 2024
@Nereboss
Copy link
Contributor Author

Nereboss commented Feb 9, 2024

During integration we noticed a bug when calling kotter methods from different files. This bug has been reported to the developer who is working on a fix but until then this is blocked

Nereboss added a commit that referenced this issue Feb 20, 2024
@Nereboss
Update Kotter version #3483
3cad66c
@Nereboss Nereboss removed the blocked The issue or feature is blocked on another issue or PR that has to be resolved first label Feb 20, 2024
@Nereboss
Copy link
Contributor Author

The bug that blocked this issue has been fixed by the developer, we can continue working on this issue

Nereboss added a commit that referenced this issue Feb 21, 2024
@Nereboss
Add text for invalid input in checkbox-function #3483
57183fa
Nereboss added a commit that referenced this issue Feb 21, 2024
@Nereboss
Changed PromptConfirm to color-code the selection #3483
b2a28dd
Nereboss added a commit that referenced this issue Feb 21, 2024
@Nereboss
Improve error handling for promptInput #3483
880dbb6
Nereboss added a commit that referenced this issue Mar 11, 2024
@Nereboss
Small improvements in the dev start guide #3483
250f0d1
Nereboss added a commit that referenced this issue Mar 11, 2024
@Nereboss
Add test file for Inquirer #3483
c16edf0
fritschldwg pushed a commit that referenced this issue Mar 11, 2024
@Nereboss @fritschldwg
Small improvements in the dev start guide #3483
686c9c8
Nereboss added a commit that referenced this issue Mar 14, 2024
@Nereboss
Refactor Inquirer and add testing module for it #3483
8cdf80d
Nereboss added a commit that referenced this issue Mar 14, 2024
@Nereboss
Fix a bug that invalidInputMessages were not displayed anymore #3483
fea3e61
Nereboss added a commit that referenced this issue Mar 15, 2024
@Nereboss
Add callback for promptConfirm and write first test #3483
a32066b
Nereboss added a commit that referenced this issue Apr 8, 2024
@Nereboss
Fix test for warning message in promptInput #3483
7b6fe64
Nereboss added a commit that referenced this issue Apr 11, 2024
@Nereboss
Refactor test for warning message and add more #3483
a770021
Nereboss added a commit that referenced this issue Apr 11, 2024
@Nereboss
Add last remaining test #3483
5e86ce8
@phanlezz phanlezz mentioned this issue Apr 30, 2024
Open
@Nereboss Nereboss mentioned this issue May 6, 2024
Open
6 tasks
phanlezz pushed a commit that referenced this issue May 6, 2024
@Nereboss @phanlezz
Refactor Inquirer into own module #3483
c5c51cf
phanlezz pushed a commit that referenced this issue May 6, 2024
@Nereboss @phanlezz
Add inputNumber function #3483
d68cb18
phanlezz pushed a commit that referenced this issue May 6, 2024
@Nereboss @phanlezz
Add promptConfirm function #3483
543fab1
phanlezz pushed a commit that referenced this issue May 6, 2024
@Nereboss @phanlezz
Add promptList function #3483
95a3622
phanlezz pushed a commit that referenced this issue May 6, 2024
@Nereboss @phanlezz
Add promptCheckbox function #3483
299e3ae
phanlezz pushed a commit that referenced this issue May 6, 2024
@Nereboss @phanlezz
Refactor inquirer functions #3483
5be202f 
Class is no longer needed as all functions extend the Session class from Kotter and are applicable in the correct scope
phanlezz pushed a commit that referenced this issue May 6, 2024
@Nereboss @phanlezz
Test Inquirer on StructureModifier; WIP Commit #3483
99d9a49 
Still a lot of todos that need to be closed and comments that need to be implemented, as well as finding a solution for the session problem
phanlezz pushed a commit that referenced this issue May 6, 2024
@Nereboss @phanlezz
Update Kotter version #3483
1407f45
phanlezz pushed a commit that referenced this issue May 6, 2024
@Nereboss @phanlezz
Add text for invalid input in checkbox-function #3483
c2f66ef
phanlezz pushed a commit that referenced this issue May 6, 2024
@Nereboss @phanlezz
Changed PromptConfirm to color-code the selection #3483
8dad8fa
phanlezz pushed a commit that referenced this issue May 6, 2024
@Nereboss @phanlezz
Improve error handling for promptInput #3483
6921374
phanlezz pushed a commit that referenced this issue May 6, 2024
@Nereboss @phanlezz
Add test file for Inquirer #3483
6b2f9fb
phanlezz pushed a commit that referenced this issue May 6, 2024
@Nereboss @phanlezz
Refactor Inquirer and add testing module for it #3483
c27c0b3
phanlezz pushed a commit that referenced this issue May 6, 2024
@Nereboss @phanlezz
Fix a bug that invalidInputMessages were not displayed anymore #3483
0ee393f
phanlezz pushed a commit that referenced this issue May 6, 2024
@Nereboss @phanlezz
Add callback for promptConfirm and write first test #3483
7ce8c04
phanlezz pushed a commit that referenced this issue May 6, 2024
@Nereboss @phanlezz
Fix test for warning message in promptInput #3483
458f4be
phanlezz pushed a commit that referenced this issue May 6, 2024
@Nereboss @phanlezz
Refactor test for warning message and add more #3483
dad62c5
phanlezz pushed a commit that referenced this issue May 6, 2024
@Nereboss @phanlezz
Add last remaining test #3483
5857aa3
Nereboss added a commit that referenced this issue May 10, 2024
@Nereboss
Add test functions and tests to help debug flaky tests #3483
24af888
@ChristianHuehn ChristianHuehn added the priority:high Set by PO label Jun 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Nereboss Nereboss

Labels
pr-analysis Issues that touch the analysis pr(oject). priority:high Set by PO tech For technical stories without user impact (=refactoring stories).
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ce-bo @Nereboss @ChristianHuehn