Merge branch 'release-516' of https://github.com/Sage-Bionetworks/Syn…

…apseWebClient into merge-516-develop

.github/workflows/main.yaml

@@ -31,6 +31,10 @@ jobs:
           MAVEN_USERNAME: ${{ secrets.PLATFORM_ARTIFACTORY_USER }}
           MAVEN_USERPWD: ${{ secrets.PLATFORM_ARTIFACTORY_PWD }}
 
+      - name: setup-job-summary
+        run: |
+          echo "| version | ${{ env.pomversion }} |" > $GITHUB_STEP_SUMMARY
+
   call-test:
     runs-on: ubuntu-latest
     if: ${{ github.event_name == 'pull_request' }}

src/main/java/org/sagebionetworks/web/client/FeatureFlagKey.java

@@ -37,6 +37,9 @@ public enum FeatureFlagKey {
   // If enabled, use the re-implemented ACL Editor for entities
   REACT_ENTITY_ACL_EDITOR("REACT_ENTITY_ACL_EDITOR"),
 
+  // If enabled, sharing settings will appear in a dialog immediately after uploading one or more files.
+  SHOW_SHARING_SETTINGS_AFTER_UPLOAD("SHOW_SHARING_SETTINGS_AFTER_UPLOAD"),
+
   // Last flag is used only for tests
   TEST_FLAG_ONLY("TEST_FLAG_ONLY");
 

src/main/java/org/sagebionetworks/web/client/SynapseJavascriptClient.java

@@ -3295,4 +3295,32 @@ public FluentFuture<Void> deleteSessionAccessToken() {
     String url = getAuthServiceUrl() + SESSION_ACCESS_TOKEN;
     return getFuture(cb -> doDelete(url, cb));
   }
+
+  public void getEntityBenefactorAcl(
+    String entityId,
+    AsyncCallback<AccessControlList> cb
+  ) {
+    // Retrieving the benefactor ACL is always permitted regardless of permissions, so only retrieve that part of the bundle.
+    EntityBundleRequest request = new EntityBundleRequest();
+    request.setIncludeBenefactorACL(true);
+    String url = getRepoServiceUrl() + ENTITY + "/" + entityId + BUNDLE2;
+
+    doPost(
+      url,
+      request,
+      OBJECT_TYPE.EntityBundle,
+      true,
+      new AsyncCallback<EntityBundle>() {
+        @Override
+        public void onSuccess(EntityBundle result) {
+          cb.onSuccess(result.getBenefactorAcl());
+        }
+
+        @Override
+        public void onFailure(Throwable caught) {
+          cb.onFailure(caught);
+        }
+      }
+    );
+  }
 }

src/main/java/org/sagebionetworks/web/client/widget/entity/download/UploadDialogWidget.java

@@ -4,6 +4,8 @@
 import com.google.gwt.user.client.ui.Widget;
 import com.google.inject.Inject;
 import org.sagebionetworks.repo.model.Entity;
+import org.sagebionetworks.web.client.FeatureFlagConfig;
+import org.sagebionetworks.web.client.FeatureFlagKey;
 import org.sagebionetworks.web.client.events.EntityUpdatedEvent;
 import org.sagebionetworks.web.client.utils.CallbackP;
 import org.sagebionetworks.web.client.widget.SynapseWidgetPresenter;
@@ -16,18 +18,21 @@ public class UploadDialogWidget
   private Uploader uploader;
   private final EventBus eventBus;
   private final EntityAccessControlListModalWidget entityAclEditor;
+  private final FeatureFlagConfig featureFlagConfig;
 
   @Inject
   public UploadDialogWidget(
     UploadDialogWidgetView view,
     Uploader uploader,
     EventBus eventBus,
-    EntityAccessControlListModalWidget entityAccessControlListModalWidget
+    EntityAccessControlListModalWidget entityAccessControlListModalWidget,
+    FeatureFlagConfig featureFlagConfig
   ) {
     this.view = view;
     this.uploader = uploader;
     this.eventBus = eventBus;
     this.entityAclEditor = entityAccessControlListModalWidget;
+    this.featureFlagConfig = featureFlagConfig;
     view.setPresenter(this);
   }
 
@@ -54,7 +59,12 @@ public void configure(
     // add handlers for closing the window
     uploader.setSuccessHandler(benefactorId -> {
       view.hideDialog();
-      if (benefactorId != null) {
+      if (
+        benefactorId != null &&
+        featureFlagConfig.isFeatureEnabled(
+          FeatureFlagKey.SHOW_SHARING_SETTINGS_AFTER_UPLOAD
+        )
+      ) {
         entityAclEditor.configure(
           benefactorId,
           () -> eventBus.fireEvent(new EntityUpdatedEvent(benefactorId)),

src/main/java/org/sagebionetworks/web/client/widget/entity/download/Uploader.java

@@ -791,25 +791,30 @@ public void onSuccess(Entity result) {
         entity = result;
         view.showInfo(DisplayConstants.TEXT_LINK_SUCCESS);
         if (successHandler != null) {
-          synapseClient.getEntityBenefactorAcl(
+          jsClient.getEntityBenefactorAcl(
             result.getId(),
             new AsyncCallback<AccessControlList>() {
               @Override
               public void onSuccess(AccessControlList benefactorAcl) {
-                successHandler.onSuccessfulUpload(benefactorAcl.getId());
+                if (benefactorAcl.getId().equals(entity.getId())) {
+                  // Don't show the ACL modal if the entity is its own benefactor
+                  successHandler.onSuccessfulUpload(null);
+                } else {
+                  successHandler.onSuccessfulUpload(benefactorAcl.getId());
+                }
+                entityUpdated();
               }
 
               @Override
               public void onFailure(Throwable caught) {
                 view.showErrorMessage(caught.getMessage());
                 // Upload was still a success, benefactor ID is not required to continue
                 successHandler.onSuccessfulUpload(null);
+                entityUpdated();
               }
             }
           );
         }
-
-        entityUpdated();
       }
 
       @Override
@@ -1025,24 +1030,30 @@ private void uploadSuccess() {
     view.resetToInitialState();
     resetUploadProgress();
     if (successHandler != null) {
-      synapseClient.getEntityBenefactorAcl(
-        parentEntityId,
+      jsClient.getEntityBenefactorAcl(
+        entityId,
         new AsyncCallback<AccessControlList>() {
           @Override
           public void onSuccess(AccessControlList benefactorAcl) {
-            successHandler.onSuccessfulUpload(benefactorAcl.getId());
+            if (benefactorAcl.getId().equals(entityId)) {
+              // Don't show the ACL modal if the entity is its own benefactor
+              successHandler.onSuccessfulUpload(null);
+            } else {
+              successHandler.onSuccessfulUpload(benefactorAcl.getId());
+            }
+            entityUpdated();
           }
 
           @Override
           public void onFailure(Throwable caught) {
             view.showErrorMessage(caught.getMessage());
             // Upload was still a success, benefactor ID is not required to continue.
             successHandler.onSuccessfulUpload(null);
+            entityUpdated();
           }
         }
       );
     }
-    entityUpdated();
   }
 
   private void resetUploadProgress() {

src/test/java/org/sagebionetworks/web/unitclient/widget/entity/download/UploadDialogTest.java

@@ -1,9 +1,12 @@
 package org.sagebionetworks.web.unitclient.widget.entity.download;
 
+import static org.mockito.ArgumentMatchers.anyBoolean;
 import static org.mockito.Matchers.any;
 import static org.mockito.Matchers.eq;
 import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.never;
 import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
 
 import com.google.gwt.event.shared.EventBus;
 import org.junit.Before;
@@ -14,6 +17,8 @@
 import org.mockito.Mock;
 import org.mockito.junit.MockitoJUnitRunner;
 import org.sagebionetworks.repo.model.Entity;
+import org.sagebionetworks.web.client.FeatureFlagConfig;
+import org.sagebionetworks.web.client.FeatureFlagKey;
 import org.sagebionetworks.web.client.events.CancelHandler;
 import org.sagebionetworks.web.client.events.UploadSuccessHandler;
 import org.sagebionetworks.web.client.jsinterop.EntityAclEditorModalProps;
@@ -38,6 +43,9 @@ public class UploadDialogTest {
   @Mock
   EntityAccessControlListModalWidget mockEntityAccessControlListModalWidget;
 
+  @Mock
+  FeatureFlagConfig mockFeatureFlagConfig;
+
   @Captor
   ArgumentCaptor<UploadSuccessHandler> uploadSuccessCaptor;
 
@@ -55,12 +63,58 @@ public void before() throws Exception {
         view,
         mockUploader,
         mockEventBus,
-        mockEntityAccessControlListModalWidget
+        mockEntityAccessControlListModalWidget,
+        mockFeatureFlagConfig
       );
   }
 
   @Test
   public void testConfigure() {
+    when(
+      mockFeatureFlagConfig.isFeatureEnabled(
+        FeatureFlagKey.SHOW_SHARING_SETTINGS_AFTER_UPLOAD
+      )
+    )
+      .thenReturn(false);
+
+    String title = "dialog title";
+    Entity entity = mock(Entity.class);
+    String parentEntityId = "parent";
+    CallbackP<String> fileHandleIdCallback = mock(CallbackP.class);
+    boolean isEntity = true;
+    widget.configure(
+      title,
+      entity,
+      parentEntityId,
+      fileHandleIdCallback,
+      isEntity
+    );
+
+    verify(mockUploader)
+      .configure(entity, parentEntityId, fileHandleIdCallback, isEntity);
+    verify(view).configureDialog(eq(title), any());
+
+    verify(mockUploader).setSuccessHandler(uploadSuccessCaptor.capture());
+    verify(mockUploader).setCancelHandler(any(CancelHandler.class));
+
+    // simulate a successful upload
+    String benefactorId = "syn123";
+    uploadSuccessCaptor.getValue().onSuccessfulUpload(benefactorId);
+    verify(view).hideDialog();
+    verify(mockEntityAccessControlListModalWidget, never())
+      .configure(eq(benefactorId), any(), anyBoolean());
+    verify(mockEntityAccessControlListModalWidget, never()).setOpen(true);
+  }
+
+  @Test
+  public void testSharingSettingsFeatureEnabled() {
+    when(
+      mockFeatureFlagConfig.isFeatureEnabled(
+        FeatureFlagKey.SHOW_SHARING_SETTINGS_AFTER_UPLOAD
+      )
+    )
+      .thenReturn(true);
+
     String title = "dialog title";
     Entity entity = mock(Entity.class);
     String parentEntityId = "parent";

src/test/java/org/sagebionetworks/web/unitclient/widget/entity/download/UploaderTest.java

@@ -293,7 +293,7 @@ public void testSetNewExternalPath() throws Exception {
     // associate the path.
     AsyncMockStubber
       .callSuccessWith(new AccessControlList().setId(UPLOAD_BENEFACTOR_ID))
-      .when(mockSynapseClient)
+      .when(mockSynapseJavascriptClient)
       .getEntityBenefactorAcl(anyString(), any(AsyncCallback.class));
 
     uploader.setExternalFilePath(
@@ -312,7 +312,7 @@ public void testSetNewExternalPath() throws Exception {
         eq(storageLocationId),
         any()
       );
-    verify(mockSynapseClient)
+    verify(mockSynapseJavascriptClient)
       .getEntityBenefactorAcl(anyString(), any(AsyncCallback.class));
     verify(mockView).showInfo(anyString());
     verify(mockUploadSuccessHandler).onSuccessfulUpload(UPLOAD_BENEFACTOR_ID);
@@ -420,14 +420,14 @@ public void testDirectUploadHappyCase() throws Exception {
       .getEntity(anyString(), any(OBJECT_TYPE.class), any(AsyncCallback.class));
     AsyncMockStubber
       .callSuccessWith(new AccessControlList().setId(UPLOAD_BENEFACTOR_ID))
-      .when(mockSynapseClient)
+      .when(mockSynapseJavascriptClient)
       .getEntityBenefactorAcl(anyString(), any(AsyncCallback.class));
     uploader.handleUploads();
     verify(mockGlobalApplicationState).clearDropZoneHandler(); // SWC-5161 (cleared on handleUploads)
     verify(mockView).disableSelectionDuringUpload();
     verify(mockSynapseClient)
       .setFileEntityFileHandle(any(), any(), any(), any());
-    verify(mockSynapseClient)
+    verify(mockSynapseJavascriptClient)
       .getEntityBenefactorAcl(anyString(), any(AsyncCallback.class));
     verify(mockView).hideLoading();
     assertEquals(UploadType.S3, uploader.getCurrentUploadType());