Versions Compared

Version Old Version 89 New Version Current
Changes made by

Marco Marasca

Nick Grosenbacher

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Clarify URL of app in development, add commented dev stack property to settings.xml example

Table of Contents
minLevel3

Child pages

UI Development

Set up the Maven Build

  1. Fork the Sage-Bionetworks SynapseWebClient repository into your own GitHub account: https://help.github.com/articles/fork-a-repo

  2. Clone the SynapseWebClient project down to your computer: git clone https://github.com/[YOUR GITHUB NAME]/SynapseWebClient.git
  3. Change into the proper directory with: cd SynapseWebClient
  4. Set up upstream with: git remote add upstream https://github.com/Sage-Bionetworks/SynapseWebClient
  5. Fetch and merge changes from the Sage Bionetworks repo, which was named upstream: 
    git fetch upstream

Setup with Intellij

...

  1. If downloading Java for the first time then download Java 8 as well.

...

The template for the file needs to look like so-

...

languagexml
titlesettings.xml

...

Table of Contents
minLevel3
maxLevel6
outlinefalse
typelist
separatorbrackets
printabletrue
Child pages

UI Development

Prerequisite software to install

  • Java (Corretto JDK 11+ recommended)

  • Maven 3

  • Docker

  • pnpm v9

Set up your GitHub fork and a local repository

  1. Create a GitHub user account if you don't already have one.

  2. Set up your local git environment according to /wiki/spaces/IT/pages/802881544

  3. Fork the Sage-Bionetworks SynapseWebClient repository into your own GitHub account: https://help.github.com/articles/fork-a-repo

  4. Clone your fork of SynapseWebClient project to your local machine and enter the project root directory

    Code Block
    languagebash
    git clone https://github.com/[YOUR GITHUB NAME]/SynapseWebClient.git
cd SynapseWebClient

  5. If you didn't set up the global pre-commit hook in step #2, set up a local pre-commit hook to detect secrets (do this for all repos that you clone in the future!):

    Code Block
    git secrets --install
git secrets --register-aws

  6. Set up upstream with

    Code Block
    git remote add upstream https://github.com/Sage-Bionetworks/SynapseWebClient

  7. Fetch and merge changes from the Sage Bionetworks repo, which was named upstream: 

    Code Block
    git fetch upstream

  8. Configure or update your Maven configuration settings.xml

    1. The file needs to placed in $HOME/.m2/settings.xml (e.g. jane/.m2/settings.xml)

    2. This should be the content of this file:

      settings.xml

      Code Block
      languagexml
      <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                      http://maven.apache.org/xsd/settings-1.0.0.xsd">
  <localRepository/>
  <interactiveMode/>
  <usePluginRegistry/>
  <offline/>
  <pluginGroups/>
  <servers/>
  <mirrors/>
  <proxies/>
  <profiles>
    <profile>
      <id>dev-environment</id>
      <activation>
        <activeByDefault>true</activeByDefault>
      </activation>

...

    1. <properties>
		<org.sagebionetworks.portal.endpoint>http://127.0.0.

...

    1. 1:8888/Portal.html</org.sagebionetworks.portal.endpoint>

...

    1.

...

    1.

...

  1. Run 'mvn clean install'
  2. Run 'mvn gwt:run'

Set up the Eclipse Build

...

  1. Contributors should fork the repository and submit GitHub Pull Requests for code inclusion.

...

Set up Git: https://help.github.com/articles/set-up-git

...

  1. File → Import → Maven → Existing Maven Projects
  2. Next, in Root Directory enter the local path to your repository clone
  3. Next, Finish 

...

  1. Right-click on portal (project name) → Build Path → Configure Build Path...
  2. Remove the "Exclude" filter from the source tab on the src/main/resources and src/test/resources directories.

...

  1. From the resulting dialog make sure the "Use Google Web Toolkit" check box is selected.
  2. Also make sure you are using the GWT SDK from your local maven repository (.m2/repository/com/google/gwt)

...

  1.  From the tree on the left of the dialog navigate to Google → Web Application
  2. Check the the check box: "This project has a WAR directory"
  3. With the "Browse" button, select "src/main/webapp"
  4. UN-CHECK the "Launch and deploy from this directory"  This is very important, if you keep this checked then Maven will not be able to generate a clean WAR file.  If you see "GWT needs to recompile" when you deploy your WAR then you probably have this box checked.

...

  1. Right-Click on the project from the package explorer.
  2. Select Google→GWT Compile...
  3. Under the "Entry Point Modules" you should see "PortalDebug - org.sagebionetworks.web",  if not, then add it with the add button.
  4. Remove the "Portal - org.sagebionetworks.web" entry.
  5. The first time you run this you will be asked to select the output directory where GWT will compile the code. You want this to match the Maven WAR output directory, so use "target/portal-<VERSION>-SNAPSHOT"
  6. If you get compilation errors from the JavaScript validator (i.e. NullPointerException), navigate to the project's properties → JavaScript → Include Path → Source, and exclude all files from the source. If an OutOfMemoryError was thrown while compiling, you can click the "Advanced" tab towards the bottom of the Google → GWT Compile window and add "-Xms512M -Xmx1524M" to the VM arguments to increase heap space.

...

Set the following arguments (might vary according to the version):

Code Block
--unix-newlines
--sourcemap=none
--style compressed
--default-encoding=UTF-8
--stop-on-error
--no-cache
--update 
src/main/webapp/sass:target/portal-develop-SNAPSHOT

...

Code Block
--no-source-map
--style=compressed
--unicode
--stop-on-error
--update 
src/main/webapp/sass:target/portal-develop-SNAPSHOT

...

  1. Option 1: start from within Eclipse.
    1. Right-Click on the project in the package explorer
    2. Select: Run As → GWT Development Mode with Jetty, and select Portal.html
    3. Set the run configuration VM Arguments to the following: "-Xms512m -Xmx2048m -XstartOnFirstThread".
    4. Double-click on the link provided in the Development Mode window to view the portal in your browser. 
  2. Option 2: build and run from the command line.
    1. Run 'mvn clean install'
    2. Run 'mvn gwt:run'

Eclipse Workspace Settings

Set file encoding to UTF-8 and the line-endings (for new files) to Unix, so that text files are saved in a format that is not specific to the Windows or Mac OS and most easily shared across heterogeneous developer desktops:

  • Open Preferences
  • Navigate to the Workspace preferences: General → Workspace
  • Change the Text File Encoding to UTF-8
  • Change the New Text File Line Delimiter to Other and select Unix from the drop-down

Troubleshooting

  • Check your exclusion filters through configure build path in Eclipse to assure nothing is excluded, then refresh and clean the SWC project.
  • "Could not deserialize" or similar problems in Super Dev Mode are most often fixed by re-building through the command line (running 'mvn clean install')
  • (git) Pull the latest changes from the upstream repository.
  • Try to rebuild your Eclipse's Portal project and keep your files in place.
  • Perform a Maven update.  

...

    1. <org.sagebionetworks.repositoryservice.endpoint>https://repo-prod.prod.sagebase.org/repo/v1</org.sagebionetworks.repositoryservice.endpoint>
        <!-- insert properties described below here -->
        <!-- If you want to point to a different stack (staging, dev), comment out the above and uncomment one of the below -->
        <!-- <org.sagebionetworks.repositoryservice.endpoint>https://repo-staging.prod.sagebase.org/repo/v1</org.sagebionetworks.repositoryservice.endpoint> -->
        <!-- <org.sagebionetworks.repositoryservice.endpoint>https://repo-dev.dev.sagebase.org/repo/v1</org.sagebionetworks.repositoryservice.endpoint> -->
        <!-- Uncomment the property below to limit GWT permutations and speed up build time -->
        <!-- <gwt.module.suffix>Debug</gwt.module.suffix> -->
      </properties>
    </profile>
  </profiles>
  <activeProfiles/>
</settings>

  2. Verify you can build the project and run the unit tests:

    Code Block
    mvn clean install

Development

You may use an IDE of your choice. Instructions for setting up IntelliJ IDEA and Eclipse can be found below.

Running SynapseWebClient in development mode requires many different services, including the GWT Codeserver, a Vite codeserver, a Java servlet (Tomcat), and the Sage Bionetworks Account site (required to sign in via UI). For convenience, we maintain a few different ways to run SWC in development mode.

Expand
titleRunning all services in Docker containers (docker compose) [PREFERRED]

To run the app in development mode in a set of Docker containers, you can run pnpm start:<stack>, where stack is one of development,staging,production. This will invoke docker compose to instantiate a container for each service required to run the app in development mode. The latest version of the accounts site (SageAccountWeb) will also be launched on port 3000 as a convenience.

Expand
titleDevelopment mode using native Java/Maven installation

To run the app in development mode, run pnpm install then pnpm dev. This will launch three processes:

  • The GWT Codeserver, which compiles Java to JavaScript, and watches for source changes

  • The Vite codeserver, which bundles JavaScript assets and watches for source changes

  • A file watcher that monitors changes to static assets, and copies them to the deployed web application directory when they change

  • An Apache Tomcat Docker container that will host the web application

Note that this does NOT run the Sage account management application (SageAccountWeb), which is separate from SWC. If you want to log in through the UI, you must run SageAccountWeb on port 3000. You can either run SageAccountWeb in synapse-web-monorepo, or you can run the latest Docker image for SageAccountWeb.

Running the local version of SageAccountWeb

SynapseWebClient delegates authentication and account management to a separate web application. In order to sign in to a local instance of SynapseWebClient, you must also start a local instance of the account management application. Set up the synapse-web-monorepo project and run the following command.

Code Block
 pnpm nx run SageAccountWeb:start --port=3000 --host --mode=development

If your portal instance is configured to use to a different backend stack, you will need to configure SageAccountWeb to also use the same stack (i.e. --mode=production or --mode=staging).

Running the accounts site in a Docker image

You can run the latest version of the accounts site (synapse-web-monorepo/main) with the following command:

Code Block
docker run -it --rm -d -p 3000:80 --name SageAccountWeb ghcr.io/sage-bionetworks/sage-account-web:latest-development

If you want the site to point to staging/production, change development in the image tag to the stack you want to point to.

Alternative ways to run SynapseWebClient in development mode

Instead of running pnpm dev, you can alternatively directly use the GWT Maven plugin (e.g. mvn gwt:run) or an IDE integration. Please note that depending on your IDE/plugin configuration, your environment may be subtly different than the production system (e.g. many GWT plugins deploy a Jetty server, when we use Tomcat in production), which can result in subtle differences in behavior.

Once the service is started, you should be able to see the app at http://127.0.0.1:8888/ .

As you make changes to the source code and static assets, changes will be picked up in the app when you refresh the page.

JavaScript dependency development

If you have made changes to a JavaScript dependency (e.g. synapse-react-client), you can see those changes in your local development environment by “linking” the projects. As an example, we will link the synapse-react-client project.

  1. In the SynapseWebClient directory, run

    Code Block
    pnpm link ../path/to/synapse-web-monrepo/packages/synapse-react-client

    This will create a symlink on your machine so the node_modules/synapse-react-client directory points to your local synapse-react-client directory.

  2. Make desired changes in the synapse-react-client project

  3. Rebuild the JavaScript artifacts for synapse-react-client (in synapse-web-monorepo, run pnpm nx run synapse-react-client:build)

  4. If you’re running pnpm dev, the changed JavaScript file should automatically be picked up. Refresh your browser window to see the changes (you will likely need to open your browser dev tools → Network → Disable Cache, and leave the browser devtools open)

Info

If you’re using Docker Compose to run the development server, you must add your locally-linked package as a volume on the container. Instructions on how to do this are in compose-link.yml.

When you want to unlink synapse-react-client, in the SynapseWebClient directory you can run pnpm unlink synapse-react-client.

Note

Linking a package updates the lockfile to reference the local repository, so you must unlink the package before you commit changes to the lockfile.

IDE Setup Instructions

This section contains instructions for setting up various IDEs to develop SynapseWebClient.

Expand
titleSetup with Eclipse

  1. Install the latest Eclipse (for Java Development)

  2. Install the Google Plug-in for Eclipse.  Do not include GWT SDK in the install (GWT SDK will be installed by the maven install).  Do not install the Google App Engine Maven Integration.

  3. Import the project as a maven project

    1. File → Import → Maven → Existing Maven Projects

    2. Next, in Root Directory enter the local path to your repository clone

    3. Next, Finish 

  4. You need to make sure the GWT xml files are on the classpath. All of these resources can be found in src/main/resources and src/test/resources directories. 

    1. Right-click on portal (project name) → Build Path → Configure Build Path...

    2. Remove the "Exclude" filter from the source tab on the src/main/resources and src/test/resources directories.

  5. We need to tell the GWT Eclipse-plugin that this is a GWT project. Do this by Right-Clicking on the project in the package explorer and select: Google → Web Toolkit Settings...

    1. From the resulting dialog make sure the "Use Google Web Toolkit" check box is selected.

    2. Also make sure you are using the GWT SDK from your local maven repository (.m2/repository/com/google/gwt)

  6. Verify GWT can compile your code

    1. Right-Click on the project from the package explorer.

    2. Select Google→GWT Compile...

    3. Under the "Entry Point Modules" you should see "PortalDebug - org.sagebionetworks.web",  if not, then add it with the add button.

    4. Remove the "Portal - org.sagebionetworks.web" entry.

    5. The first time you run this you will be asked to select the output directory where GWT will compile the code. You want this to match the Maven WAR output directory, so use "target/portal-<VERSION>-SNAPSHOT"

    6. If you get compilation errors from the JavaScript validator (i.e. NullPointerException), navigate to the project's properties → JavaScript → Include Path → Source, and exclude all files from the source. If an OutOfMemoryError was thrown while compiling, you can click the "Advanced" tab towards the bottom of the Google → GWT Compile window and add "-Xms512M -Xmx1524M" to the VM arguments to increase heap space.

  7. If the GWT Compile successfully compiled, then you're ready to run the application.

    1. Right-Click on the project in the package explorer

    2. Select: Run As → GWT Development Mode with Jetty, and select Portal.html

    3. Double-click on the link provided in the Development Mode window to view the portal in your browser. 

  8. To run the unit tests:

    1. Right-Click on the project from the package explorer.

    2. Select: Run As → JUnit Test

Eclipse Workspace Settings verification:

Set file encoding to UTF-8 and the line-endings (for new files) to Unix, so that text files are saved in a format that is not specific to the Windows or Mac OS and most easily shared across heterogeneous developer desktops:

  • Open Preferences

  • Navigate to the Workspace preferences: General → Workspace

  • Change the Text File Encoding to UTF-8

  • Change the New Text File Line Delimiter to Other and select Unix from the drop-down

Troubleshooting

  • Check your exclusion filters through configure build path in Eclipse to assure nothing is excluded, then refresh and clean the SWC project.

  • (git) Pull the latest changes from the upstream repository.

  • Try to rebuild your Eclipse's Portal project and keep your files in place.

  • Perform a Maven update.  

  1. Delete your project from Eclipse (leave "Delete project contents on disk" UNCHECKED)

  2. Go to the project root on your file system and delete .classpath, .project and the .settings/ folder

  3. Go to "Set up with Eclipse"

Verify the web app directory is correct. Right-click on the project in the package explorer and select Properties:

  1.  From the tree on the left of the dialog navigate to Google → Web Application

  2. Check the the check box: "This project has a WAR directory"

  3. With the "Browse" button, select "src/main/webapp"

  4. UN-CHECK the "Launch and deploy from this directory"  This is very important, if you keep this checked then Maven will not be able to generate a clean WAR file.  If you see "GWT needs to recompile" when you deploy your WAR then you probably have this box checked

If this still doesn't work, or your dev mode is broken for another reason, there are

...

some further steps you can take.

  1. Use the '-clean' argument.

    1. One way to do this is to add -clean on its own line as the first line on the eclipse.ini file, and restart Eclipse.

  2. Use a new workspace.

    1. I followed the instructions in the site linked above. The gist of it is:

      1. Export your preferences to somewhere outside your Eclipse environment environment

...

      1. (Export → General → Preferences. Make sure that 'Export All' is checked.)

      2. Switch to a new workspace. (Switch Workspace → Other, then name your new workspace.)

      3. Import your preferences into this new workspace (Import → General → Preferences

...

      1. , make sure

...

      1. '

...

      1. Import All' is checked.)

...

Technologies used

There are several technologies that we are currently utilizing in the portal. The following is a list of primers for each:

Cross-browser testing

We have a shared account to use BrowserStack to test the website for cross browser compatibility issues.
Alternatively, for testing IE on Mac I use VirtualBox with an image provided by Microsoft from modern.IE.  For this to work, in your Windows VM, you will need to map an ip to outer in order to access your local machine (note, Windows UAC requires you to do this as an admin).

How to limit GWT build permutations

To speed up build time, add the following property to your local maven settings.xml file:

<gwt.module.suffix>Debug</gwt.module.suffix>

...

      2. Import trunk as usual.

Expand
titleSetup with Intellij IDEA

  1. Download IntelliJ IDEA 

    1. The community edition is free

    2. The Ultimate edition requires purchasing a license. It includes enhanced support for GWT, but it’s not necessary for development. 

  2. Import the SynapseWebClient project into IntelliJ by File → New Project From Existing Sources... <Select Path to SWC Location>

  3. Set up IntelliJ to directly call pnpm dev

    1. Run → Edit Configurations…

    2. Click “Add New Configuration” → npm

    3. Set the following options

      • Command: run

      • Script: dev

      • Package manager: pnpm

Technologies used

There are several technologies that we are currently utilizing in the portal. The following is a list of primers for each:

End-to-end testing

Instructions on running end-to-end tests are included in this README.

How to point to a local instance of the Synapse backend

  1. Follow the instructions on the Platform Bootstrap to set up a local backend stack. 

  2. Build and launch a local backend stack.  From an up-to-date clone of Synapse-Repository-Services on your local box:

    1. Build the local stack by running

...

    1. mvn clean install -Dorg.sagebionetworks.database.drop.schema=true

...

    1. .

    2. Now launch it:

      Code Block
      cd integration-test

...

    1. 
mvn cargo:run

    2. Verify the services are running correctly by visiting http://localhost:8080/services-repository-develop-SNAPSHOT/repo/v1/version

...

    1. . You should see something like this:

      Code Block
      {"version":"develop-SNAPSHOT"}

  2. In the SWC project root pom.xml, change the synapse.version tag to develop-SNAPSHOT

...

  1. , so that

...

  1. Maven utilizes artifacts that were built by running on your local stack

...

  1. .

...

  1. Update the repository

...

  1. endpoint property in your maven settings.xml file

...

  1. :

    Code Block
    <org.sagebionetworks.repositoryservice.

...

  1. endpoint>http://localhost:8080/services-repository-develop-SNAPSHOT/repo/v1</org.sagebionetworks.repositoryservice

...

  1. .endpoint>

  2. Restart the Portal app to load these properties from settings.xml.

Emails will not be sent when pointing to a local repo, the SynapseEmailService will instead write files to

...

the devdata.sagebase.

...

org s3 bucket in format <to_email_address>.json

...

Restart the Portal app to load these properties from settings.xml.

How to point to a remote stack

...

How to point to a remote stack

Set the repository endpoint parameters in your maven settings.xml file. 

To point to the development stack set:

Code Block
<org.sagebionetworks.repositoryservice.endpoint>https://repo-dev.dev.sagebase.org/repo/v1</org.sagebionetworks.repositoryservice.endpoint>

To point to staging set:

...

Code Block
<org.sagebionetworks.repositoryservice.

...

endpoint>https://repo-staging.prod.sagebase.org/repo/

...

v1</org.sagebionetworks.repositoryservice.

...

endpoint>

To point to production set:

Code Block
<org.sagebionetworks.repositoryservice.

...

endpoint>https://repo-prod.prod.sagebase.org/repo/v1</org.sagebionetworks.repositoryservice.

...

endpoint>

Restart the Portal app to load this property from settings.xml.

...

To get the big picture of widget relationships, sometimes it is helpful to have a picture.  We are testing the use of tools like httphttps://asciiflowmermaid.js.comorg/ to help in these situations.

...