unfoldingWord / translationCore

Repository for the desktop application translationCore

Home Page:https://www.translationcore.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Add ability to use QA server in tCore

PhotoNomad0 opened this issue · comments

Story Explanation

User Story

As a [type of user], I want [some goal] so that [some reason].

Features / Specifications

  • [ ]
  • [ ]
  • [ ]

Definition of Done

  • [ ]
  • [ ]
  • [ ]

Additional Context

Mockups

Notes:

In GWE here are the paths:

export const BASE_URL = 'https://git.door43.org'
export const QA_BASE_URL = 'https://qa.door43.org'

Notes:

  • a toggle for QA server in tCore is a bit involved - each tool is independent, and tc-source-content-downloader is independent.
  • qa server needs to work for:
    • login
    • resource downloads
    • catalog next queries
    • project uploads/downloads

@birchamp @elsylambert - We will need an easy way for user to remove downloaded QA content so that it does not impact operation of the regular tCore. Have a few options:

  1. use a different resource folder for QA (e.g. resource-QA). Will consume more disk space, but no chance of contamination of the resources in the regular app. Also add another button to bottom of resource download dialog to "Delete All QA resources" to free up disk space once they are done testing.
  2. add way of resetting resources to just the bundled resources
  3. flag qa downloaded resources in manifest so they can be removed easily. Also add another button to bottom of resource download dialog to "Delete All QA resources"

It seems that option one is the safest.

@PhotoNomad0 it also seems like option 1 is the simplest to develop. Since this isn't intended for every user, I think the disk space issue is a good compromise.

Also I think it should be obvious in the titlebar or a UI color or something that the user is on the QA server.

@PhotoNomad0 Yes Option 1, it looks similar to the way we have pre-released Resources deleted. And downloads in a separate folder like we have for USFM URLs
Screenshot 2022-11-11 at 8 55 40 AM

Since we are adding a way to toggle between QA and Prod servers, Would it make sense to add the option to toggle on the user login page.
Screenshot 2022-11-11 at 8 52 07 AM
Screenshot 2022-11-11 at 8 50 42 AM

Notes:

  • when in QA mode - tC will store data in ~/translationCore-QA

  • the safest way to enable QA mode is at startup. Trying this to enable QA mode before startup:

    • on Mac to enable QA mode before startup, in terminal window do echo "https://qa.door43.org" > ~/translationCore/QA_MODE to disable rm ~/translationCore/QA_MODE
    • on Windows to enable QA mode before startup, in command Prompt do echo https://qa.door43.org > %HOMEDRIVE%%HOMEPATH%\translationCore\QA_MODE to disable del %HOMEDRIVE%%HOMEPATH%\translationCore\QA_MODE
  • each time you switch in and out of QA mode, you will have to log out and log in again. <= Changed to save user credentials by server in QA mode. So the first time you switch servers, you will have to log in again.

This is how we are showing we are in QA mode:

Screenshot 2022-11-15 at 6 59 19 AM

@elsylambert - Have a test build for you to look at: translationCore 3.4.0-QA (da05ef4)

See Notes above on how to enable QA mode.

USFM import not preserving alignments - looks like folder naming problem.

@elsylambert This is in translationCore 3.4.0-QA (d482d09).

Looks good in translationCore 3.4.0-QA (d482d09).