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

DYN-5901: Player CLI fixes #13965

Merged
merged 3 commits into from
May 4, 2023
Merged

DYN-5901: Player CLI fixes #13965

merged 3 commits into from
May 4, 2023

Conversation

twastvedt
Copy link
Contributor

@twastvedt twastvedt commented May 3, 2023

Please Note:

  1. Before submitting the PR, please review How to Contribute to Dynamo
  2. Dynamo Team will meet 1x a month to review PRs found on Github (Issues will be handled separately)
  3. PRs will be reviewed from oldest to newest
  4. If a reviewed PR requires changes by the owner, the owner of the PR has 30 days to respond. If the PR has seen no activity by the next session, it will be either closed by the team or depending on its utility will be taken over by someone on the team
  5. PRs should use either Dynamo's default PR template or one of these other template options in order to be considered for review.
  6. PRs that do not have one of the Dynamo PR templates completely filled out with all declarations satisfied will not be reviewed by the Dynamo team.
  7. PRs made to the DynamoRevit repo will need to be cherry-picked into all the DynamoRevit Release branches that Dynamo supports. Contributors will be responsible for cherry-picking their reviewed commits to the other branches after a LGTM label is added to the PR.

Purpose

Three issues that we've come across when testing the new Player:

  1. The new (in .net 6 builds) CLI arguments parser, CommandLineParser, by default fails on unknown arguments. Previously we allowed unknown arguments, which is required to allow Player to parse its own additional arguments. With the old parser, NDesk.Options, it is possible to check for invalid arguments but we were not doing that. This PR adds the option IgnoreUnknownArguments, which replicates previous behavior.
  2. A change for service mode changed when we enable file logging. Previously file logging was enabled in CLI mode, now it is not, regardless of whether we're in service mode. This PR fixes that.
  3. In service mode, replaced a reference to ConsoleWriter, which will be null, with Console.WriteLine.

Declarations

Check these if you believe they are true

  • The codebase is in a better state after this PR
  • Is documented according to the standards
  • The level of testing this PR includes is appropriate
  • User facing strings, if any, are extracted into *.resx files
  • All tests pass using the self-service CI.
  • Snapshot of UI changes, if any.
  • Changes to the API follow Semantic Versioning and are documented in the API Changes document.
  • This PR modifies some build requirements and the readme is updated
  • This PR contains no files larger than 50 MB

Release Notes

(FILL ME IN) Brief description of the fix / enhancement. Mandatory section

Reviewers

(FILL ME IN) Reviewer 1 (If possible, assign the Reviewer for the PR)

(FILL ME IN, optional) Any additional notes to reviewers or testers.

FYIs

(FILL ME IN, Optional) Names of anyone else you wish to be notified of

@twastvedt twastvedt requested a review from BogdanZavu May 3, 2023 20:36
@twastvedt twastvedt merged commit 82c622f into master May 4, 2023
@twastvedt twastvedt deleted the AGD-2953-command-line-parser branch May 4, 2023 13:05
twastvedt added a commit that referenced this pull request May 9, 2023
* Ignore unknown arguments in CLI.

* Enable file logging in cli mode.

* Fix missing ConsoleWriter reference in service mode.

(cherry picked from commit 82c622f)
QilongTang pushed a commit that referenced this pull request May 11, 2023
* Ignore unknown arguments in CLI.

* Enable file logging in cli mode.

* Fix missing ConsoleWriter reference in service mode.

(cherry picked from commit 82c622f)
@twastvedt twastvedt changed the title AGD-2953: Player CLI fixes AGD-5901: Player CLI fixes May 18, 2023
@twastvedt twastvedt changed the title AGD-5901: Player CLI fixes DYN-5901: Player CLI fixes May 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants