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

Additional info in the welcome screen #613

Open
SCanzano opened this issue Oct 31, 2024 · 6 comments
Open

Additional info in the welcome screen #613

SCanzano opened this issue Oct 31, 2024 · 6 comments
Labels
customer enhancement New feature or request upstream Stems from an issue in IRIS (or another dependency)
Milestone

Comments

@SCanzano
Copy link

When you start ZPM you get something like

========================================
|| Welcome to the Package Manager Shell (ZPM). version 0.7.3 ||
|| Enter q/quit to exit the shell. Enter ?/help to view available commands ||
|| Current registry https://registry.readycomputing.com/registry ||

Often times I get issues reported to me about FAILURES that occur with an install.
I'm making a recommendation that the above screen show additional information like

  • the results of $ZV or if in a HealthShare installation the full HealthShare version string

  • whether or not this is the primary mirror member if part of a mirror or if on a backup

  • the results of what is found in Set $Namespace = "%SYS" $$$THROWONERROR(tSC, ##class(Config.Startup).Get(.tProperties)) Set pSystemMode = $Get(tProperties("SystemMode")) so that we could see if this is a TEST, STAGE or PROD environment.

  • Maybe some information about the %SYS("HealthShare","Instances" types so we can see if this might be an instance where HSANALYTICS, HSPI, the CV etc are currently installed. This is important because InterSystems does not deliver all of the code to each HealthShare instance but rather only the code that is appropriate for the instance type. Some of our modules have dependencies on things like HSPI_Data.Patient and can only compile if the instance has HSPI installed.

Having this information might prevent me from having to ask for additional informaiton if we make it easier for people to capture.

@isc-kiyer
Copy link
Collaborator

All of that sounds like very useful info! However, I think it makes more sense to have it be available when the terminal shell is started (can be done via the ZSTART routine I believe) and doesn't belong on the IPM side

@janihur
Copy link

janihur commented Nov 1, 2024

Related to the welcome screen. It reports only

Current registry https://pm.community.intersystems.com  

Even I have two other active registries:

zpm:IPMTEST1>repo -list


local
        Source:                 http://localhost:52773/registry/
        Enabled?                Yes
        Available?              Yes
        Use for Snapshots?      Yes
        Use for Prereleases?    Yes
        Is Read-Only?           No
        Deployment Enabled?     Yes

registry
        Source:                 https://pm.community.intersystems.com
        Enabled?                Yes
        Available?              Yes
        Use for Snapshots?      Yes
        Use for Prereleases?    Yes
        Is Read-Only?           No
        Deployment Enabled?     No

localfs
        Source:                 /home/irisowner/work/objectscript-ex/ipm/*/module.xml
        Enabled?                Yes
        Available?              Yes
        Use for Snapshots?      Yes
        Use for Prereleases?    Yes
        Is Read-Only?           No

zpm:IPMTEST1>

@SCanzano
Copy link
Author

SCanzano commented Nov 1, 2024

All of that sounds like very useful info! However, I think it makes more sense to have it be available when the terminal shell is started (can be done via the ZSTART routine I believe) and doesn't belong on the IPM side

The challenge is I end up supporting the module definitions and the folks that report issues either arent interested or dont know how to do such things. Certainly not a threat but I feel like I have to add custom
to all of my modules to output this information so that I can ensure that this is always done. I can do this but thought it could be more useful if ZPM did this.

@isc-tleavitt isc-tleavitt added enhancement New feature or request customer labels Nov 4, 2024
@isc-tleavitt
Copy link
Contributor

Ultimately I don't think the zpm welcome screen is the place for this. Really it all belongs in the InterSystems Diagnostic Report (https://docs.intersystems.com/iris20242/csp/docbook/Doc.View.cls?KEY=GCM_diagnostic) or your own equivalent; you should be able to just hit a button to get this rather than going into terminal.

At some point I'd imagine the InterSystems diagnostic report having IPM-related information in it as well.

cc @isc-rkuszews

@isc-tleavitt isc-tleavitt added the upstream Stems from an issue in IRIS (or another dependency) label Nov 4, 2024
@evshvarov
Copy link
Collaborator

@SCanzano , alternatively you can build your own terminal client dependent on zpm-client.
e.g. take a look what zapm on OEX https://openexchange.intersystems.com/package/zapm

@SCanzano
Copy link
Author

SCanzano commented Nov 4, 2024

Ultimately I don't think the zpm welcome screen is the place for this. Really it all belongs in the InterSystems Diagnostic Report (https://docs.intersystems.com/iris20242/csp/docbook/Doc.View.cls?KEY=GCM_diagnostic) or your own equivalent; you should be able to just hit a button to get this rather than going into terminal.

At some point I'd imagine the InterSystems diagnostic report having IPM-related information in it as well.

cc @isc-rkuszews

while it likely is good to have the diagnostic report show this information my original inquiry is because

Often times I get issues reported to me about FAILURES that occur with an install.
I just wanted to have this information so that maybe when someone runs the install command they could capture all of the output and send it to me. My alternatives are to

  1. add a Before Invoke for all of our modules that output this information

or
2. train all of the folks running the installs how to

Write !,$zv Set $Namespace = "%SYS" Set tSC=##class(Config.Startup).Get(.tProperties)) ,pSystemMode = $Get(tProperties("SystemMode")) Write !,"System Mode: ",pSystemMode
etc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
customer enhancement New feature or request upstream Stems from an issue in IRIS (or another dependency)
Projects
None yet
Development

No branches or pull requests

5 participants