Added the feature to allowCommenting on a preprint document (#2082)

* Added a min-height to the data-column for the preprint details page * Fixed a typo in the template file * Updated the file renderer to send a message to the iframe
CenterForOpenScience · Dec 8, 2023 · b0c2ab2 · b0c2ab2
1 parent 1cd8253
commit b0c2ab2
Show file tree

Hide file tree

Showing 8 changed files with 33 additions and 5 deletions.
diff --git a/app/config/environment.d.ts b/app/config/environment.d.ts
@@ -72,6 +72,7 @@ declare const config: {
         learnMoreUrl: string;
         donateUrl: string;
         renderUrl: string;
+        mfrUrl: string;
         waterbutlerUrl: string;
         helpUrl: string;
         shareBaseUrl: string;

diff --git a/app/preprints/detail/styles.scss b/app/preprints/detail/styles.scss
@@ -71,6 +71,7 @@
     .data-container {
         padding: 30px;
         width: 100%;
+        min-height: 1250px;
         display: flex;
         flex-direction: row;
         justify-content: flex-start;

diff --git a/app/preprints/detail/template.hbs b/app/preprints/detail/template.hbs
@@ -164,7 +164,7 @@
                             <OsfLink
                                 data-test-supplemental-materials
                                 data-analytics-name='supplemental material'
-                                @href={{this.model.prepint.node.links.html}}
+                                @href={{this.model.preprint.node.links.html}}
                             >
                                 {{this.model.preprint.node.links.html}}
                                 <FaIcon @icon='external-link-alt' />

diff --git a/config/environment.js b/config/environment.js
@@ -46,6 +46,7 @@ const {
     OSF_API_URL: apiUrl = 'http://localhost:8000',
     OSF_API_VERSION: apiVersion = '2.20',
     OSF_RENDER_URL: renderUrl = 'http://localhost:7778/render',
+    OSF_MFR_URL: mfrUrl = 'http://localhost:4200',
     OSF_FILE_URL: waterbutlerUrl = 'http://localhost:7777/',
     OSF_HELP_URL: helpUrl = 'http://localhost:4200/help',
     OSF_AUTHENTICATOR: osfAuthenticator = 'osf-cookie',
@@ -151,6 +152,7 @@ module.exports = function(environment) {
             learnMoreUrl: 'https://cos.io/our-products/osf/',
             donateUrl: 'https://cos.io/donate',
             renderUrl,
+            mfrUrl,
             waterbutlerUrl,
             helpUrl,
             shareBaseUrl,

diff --git a/lib/osf-components/addon/components/file-renderer/component.ts b/lib/osf-components/addon/components/file-renderer/component.ts
@@ -9,7 +9,7 @@ import { tracked } from 'tracked-built-ins';
 
 import template from './template';
 
-const { OSF: { renderUrl } } = config;
+const { OSF: { renderUrl, mfrUrl } } = config;
 
 interface Params {
     direct?: '';
@@ -46,6 +46,7 @@ export default class FileRenderer extends Component {
     height = '100%';
     allowfullscreen = true;
     version?: number;
+    allowCommenting = false;
     @tracked isLoading = true;
 
     @computed('download', 'params', 'version')
@@ -64,7 +65,7 @@ export default class FileRenderer extends Component {
     }
 
     @computed('downloadUrl', 'isLoading')
-    get mfrUrl(): string {
+    get getMfrUrl(): string {
         // Waiting until the iframe is loaded then changing the URL avoids a race condition in the MFR iframe
         // This is most apparent in 3D files
         const urlWithParams = new URL(renderUrl);
@@ -88,4 +89,26 @@ export default class FileRenderer extends Component {
             next(this, () => this.set('isLoading', false));
         }
     }
+
+    private mfrOrigin(): string {
+        const urlParts = mfrUrl.split('/');
+        if (urlParts.length < 3) {
+            // if unable to extract mfr origin, just return config mfrUrl
+            return mfrUrl;
+        }
+
+        return `${urlParts[0]}//${urlParts[2]}`;
+    }
+
+    didRender() {
+        if (this.allowCommenting) {
+            const iframeElement = window.document.getElementsByTagName('iframe')[0];
+            iframeElement.addEventListener('load', () => {
+                iframeElement.contentWindow?.postMessage(
+                    {type: 'startHypothesis', parentUrl: window.location.toString()},
+                    this.mfrOrigin(),
+                );
+            });
+        }
+    }
 }
diff --git a/lib/osf-components/addon/components/file-renderer/template.hbs b/lib/osf-components/addon/components/file-renderer/template.hbs
@@ -3,7 +3,7 @@
         <LoadingIndicator @dark={{true}}/>
     {{/if}}
     <iframe
-        src={{this.mfrUrl}}
+        src={{this.getMfrUrl}}
         width={{this.width}}
         title={{t 'file-detail.mfr-iframe-title'}}
         height={{this.height}}

diff --git a/mirage/fixtures/preprint-providers.ts b/mirage/fixtures/preprint-providers.ts
@@ -20,6 +20,7 @@ const preprintProviders: Array<Partial<PreprintProvider>> = [
         assets: randomAssets(1),
         footerLinks: 'fake footer links',
         reviewsWorkflow: PreprintProviderReviewsWorkFlow.PRE_MODERATION,
+        allowCommenting: true,
     },
     {
         id: 'thesiscommons',

diff --git a/mirage/scenarios/preprints.ts b/mirage/scenarios/preprints.ts
@@ -133,7 +133,7 @@ function buildOSF(
         public: true,
         hasCoi: false,
         isPreprintDoi: false,
-        isPublished: false,
+        isPublished: true,
     }), 'isContributor');
 
     const notPublishedPreprint = server.create('preprint', {