OpenCue Windows Setup: Documentation Suggestions

[Dewdskii]

Documentation in Question:
Documentation Link: https://www.opencue.io/contributing/opencue/getting-started/getting-started-windows/

Describe the documentation issue

1.

Add a note when creating the "opencue" role in pgAdmin to set the new user's "Can login?" option to True at Stage "Using the pgAdmin GUI": Step 5.
https://www.opencue.io/contributing/opencue/getting-started/getting-started-windows/#using-the-pgadmin-gui
It appears the default configuration is False, and user's will receive the following error at Stage "Running Cuebot": Step 6.
https://www.opencue.io/contributing/opencue/getting-started/getting-started-windows/#running-cuebot
FATAL: role "opencue" is not permitted to log in

2.

Mislabeled IntelliJ IDEA option (Potentially a version difference.) at Stage "Running Cuebot": Step 3
https://www.opencue.io/contributing/opencue/getting-started/getting-started-windows/#running-cuebot
The "Edit 'CubotApplicat...main()'" option when Right-Clicking, appears to be named: "Modify Run Configuration"
IntelliJ IDEA 2021.2.3 (Community Edition)
Build #IC-212.5457.46, built on October 12, 2021

Potential User Setup Issues

Issues that could be related to personal user environments, previous installation setups or and overall less clear in reproducibility.

1.

Had issue running the "seed_data-.sql" in Stage "Using the pgAdmin GUI": Step 9
https://www.opencue.io/contributing/opencue/getting-started/getting-started-windows/#using-the-pgadmin-gui
No issues running the schema-.sql from the Query Tool, however I used the same Query Tab to then load the seed_data-*.sql and it failed complaining with

ERROR: relation "show" does not exist.
LINE 1: Insert into SHOW (...

I re-loaded the schema-*.sql and reran it, to where it informed me:

ERROR: type "jobstattype" already exists

And then I opened the seed_data-*sql in a NEW Query Tool Tab.
Tried running it again, and it ran without issue the second time.
I believe running it in a new Query Tool Tab, is what resolved the issue, but not entirely sure.

2.

I had issues with Stage "Running Cuebot": Step 6
https://www.opencue.io/contributing/opencue/getting-started/getting-started-windows/#running-cuebot
Regarding the following line:
java/com/imageworks/spcue/dao/postgres/NestedWhiteboardDaoJdbc.java Line 195:

"String spacing = " ".repeat(Math.max(0, this.level + 1));"

It was raising the following error:

String spacing = " ".repeat(Math.max(0, this.level + 1));
                                ^
  symbol:   method repeat(int)
  location: class String

This appears to be related to the version of the JDK you are running, which to my knowledge and configuration of the Project, should have been the latest. (17) (JDK-17.0.1)
My temporary fix was to replace the line with an older syntax

String spacing = String.join("", Collections.nCopies(Math.max(0, this.level + 1), " "));

3.

Ran into an issue when trying to submit the test Job via CueSubmit, Phase "Verify your installation": Step 6.
https://www.opencue.io/contributing/opencue/getting-started/getting-started-windows/#verify-your-installation

Error: "ModuleNotFoundError: No module named 'packaging'"

It seems the virtual env didn't install it correctly upon opening the project in PyCharm,
Resolved by:

1. Opening File > Settings > Project: cuesubmit > Python Interpreter
2. Selecting the Venv python intrepeter.
3. This displayed a url at the bottom of the list of installed packages, indicating that packaging was missing, Click to install.
4. Still didn't seem to work after this, (however this did fix the venv pip3 command which was also erroring) so ended up loading up the venv in a shell, and manually installing the package via pip3
5. pip3 install packaging

Describe the enhancement

Clearer messaging regarding the installation of PyCharm and IntelliJ IDEA as required by the later steps of this documentation.
Was partially through the documentation before realizing I'd be better off using the aforementioned IDE tools over my own preferred ones per how the later instructions are written.

Additional context

Windows 10
Installed the latest of all linked software
ideaIC-2021.2.3.exe
pycharm-community-2021.2.3.exe
postgresql-14.1-1-windows-x64.exe
jdk-17_windows-x64_bin.exe
schema-0.14.5.sql
seed_data-0.14.5.sql

Ran with python 3.7.6

Additional Notes

Thanks for the documentation! I was able to get things working within a few hours, after making the above mentioned changes to the instructions. Super cool to see.

[bcipriano]

Great notes, thanks for these. I'll take a run through a fresh Windows install soon and get these fixed up.