NativeScript / NativeScript/nativescript-cli

Make `tns doctor` command readonly

Đang mở
#4,382 4 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

ci needs more info
Ngôn ngữ chính
JavaScript
Star
1.1k
Fork
204
Merge trung bình
1 ngày 9 giờ
Pull request đã merge (30 ngày)
8

Mô tả

Is your feature request related to a problem? Please describe.
We've been working with the nativescript CLI for the past few days trying to get a build up and running for iOS on CircleCI (circleci.com) using mostly the following resources as a reference.

The problem we keep running into is that when we log into the CI virtual machine to debug MacOS builds, the NativeScript CLI is always trying, seemingly whatever command we run, to throw up interactive prompts and write state and modify the system, when what we really need is a way to diagnose what exactly is going on.

For example, a call to tns doctor

  1. asks about whether we want to opt into data collection
  2. asks if we want to install XCode and other dependencies, and if so wants to dump
  3. prompts if we want to use cloud or local builds.
  4. Takes a very long time on resource constrained virtual machines.

This makes it very difficult to debug dependency problems on CI for MacOS (and CI in general really)

For example, this is a transcript of the tns doctor command on a Circle mac vm.

bash-3.2$ yarn tns doctor
yarn run v1.12.1
$ /Users/distiller/project/node_modules/.bin/tns doctor
Do you want to help us improve NativeScript by automatically sending anonymous usage statistics? We will not use this information to identify or contact you. You can read our official Privacy Policy at
? http://www.telerik.com/company/privacy-policy No
TIP: To avoid setting up the necessary environment variables, you can use the Homebrew package manager to install the Android SDK and its dependencies.

There seem to be issues with your configuration.
You are missing the nativescript-cloud extension and you will not be able to execute cloud builds. Your environment is not configured properly and you will not be able to execute local builds. To continue, choose one of the following options:
Select "Sync to Playground" to enjoy NativeScript without any local setup. All you need is a couple of companion apps installed on your devices.
Select "Configure for Cloud Builds" to install the nativescript-cloud extension and automatically configure your environment for cloud builds.
Select "Configure for Local Builds" to run the setup script and automatically configure your environment for local builds.
Select "Configure for Both Local and Cloud Builds" to automatically configure your environment for both options.
Select "Configure for Both Local and Cloud Builds" to automatically configure your environment for both options.
? To continue, choose one of the following options:
  Sync to Playground
  Configure for Cloud Builds
❯ Configure for Local Builds
  Configure for Both Local and Cloud Builds
  Skip Step and Configure Manually

? To continue, choose one of the following options:  Configure for Local Builds
Running the setup script to try and automatically configure your environment.
These scripts require sudo permissions
NativeScript requires Xcode.
If you do not have Xcode installed, download and install it from App Store and run it once to complete its setup.
Do you have Xcode installed? (y/n)

#(snip XCode license agreement)

By typing 'agree' you are agreeing to the terms of the software license agreements. Type 'print' to print them or anything else to cancel, [agree, print, cancel] agree

You can view the license agreements in Xcode's About Box, or at /Applications/Xcode-10.1.app/Contents/Resources/English.lproj/License.rtf

Allow the script to install Homebrew?
(Y)es/(N)o

It goes on from there, updating homebrew, asking to install the android SDK.... In other words, I can't get a diagnosis of the system without changing the system I'm trying to diagnose. Which means that overall, it is not friendly to working with CI.

Describe the solution you'd like

  1. I'd like first and foremost a command, whether tns doctor or otherwise that, only reads system state and produces a list of potential problems with its configuration.
  2. In general, never produce side-effects, or prompt for input unless the user is executing an inherently imperative command. For example, the opt-in dialog to collect metrics happens with every single command. IMHO it should only happen on tns init or tns create (and even in these cases have an option to disable it)
  3. Split commands into those that read state and those that write state and don't intertwine them.

Describe alternatives you've considered
I don't see that there is an alternative other than muddling through.

Additional context

I think NativeScript is a great project and that it could really benefit from a little more disentanglement of side-effects inside the CLI. Especially when it comes to using nativescript CLI as a general purpose build and deployment tool rather than just an individual developer tool.

Thank you for listening!

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu bằng cách theo dõi lệnh tns doctor và lời nhắc về chỉ số được mô tả trong issue, sau đó xác định nơi các bước kiểm tra chẩn đoán kích hoạt lời nhắc hoặc thay đổi hệ thống. So sánh hành vi của lệnh với trường hợp sử dụng CI chỉ đọc được yêu cầu. Được xem là hoàn thành khi một đường dẫn chẩn đoán báo cáo các vấn đề cấu hình mà không có lời nhắc hoặc tác dụng phụ, với phần thiết lập mang tính mệnh lệnh được tách khỏi việc kiểm tra trạng thái.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
javascript
Lĩnh vực
cli
Loại issue
Tính năng
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
28/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.