Move comment for hide download controls to separate function

PR feedback Adam
cBioPortal · May 27, 2021 · 42617db · 42617db
1 parent b744a2f
commit 42617db
Show file tree

Hide file tree

Showing 18 changed files with 40 additions and 37 deletions.
diff --git a/src/pages/groupComparison/ClinicalDataEnrichmentsTable.tsx b/src/pages/groupComparison/ClinicalDataEnrichmentsTable.tsx
@@ -11,6 +11,7 @@ import { makeObservable, observable } from 'mobx';
 import { toggleColumnVisibility } from 'cbioportal-frontend-commons';
 import { IColumnVisibilityDef } from 'shared/components/columnVisibilityControls/ColumnVisibilityControls';
 import AppConfig from 'appConfig';
+import { shouldShowDownloadAndCopyControls } from 'shared/lib/DownloadControlsUtils';
 
 export interface IClinicalDataEnrichmentsTableProps {
     dataStore: ClinicalDataEnrichmentStore;
@@ -203,7 +204,7 @@ export default class ClinicalDataEnrichmentsTable extends React.Component<
                 paginationProps={{ itemsPerPageOptions: [20] }}
                 initialItemsPerPage={20}
                 copyDownloadProps={{
-                    showCopy: false, // note: under control of AppConfig.serverConfig.skin_hide_download_controls property
+                    showCopy: shouldShowDownloadAndCopyControls(),
                 }}
             />
         );

diff --git a/src/pages/patientView/patientHeader/PatientHeader.tsx b/src/pages/patientView/patientHeader/PatientHeader.tsx
@@ -10,6 +10,7 @@ import {
 } from 'cbioportal-frontend-commons';
 import SampleManager from '../SampleManager';
 import AppConfig from 'appConfig';
+import { shouldShowDownloadAndCopyControls } from 'shared/lib/DownloadControlsUtils';
 
 export type IPatientHeaderProps = {
     patient: any;
@@ -69,9 +70,7 @@ export default class PatientHeader extends React.Component<
                     <h5>{patient.id}</h5>
                     <ClinicalInformationPatientTable
                         showFilter={false}
-                        showCopyDownload={
-                            false // note: under control of AppConfig.serverConfig.skin_hide_download_controls property
-                        }
+                        showCopyDownload={shouldShowDownloadAndCopyControls()}
                         showTitleBar={false}
                         data={patient.clinicalData}
                     />

diff --git a/src/pages/patientView/patientHeader/SampleInline.tsx b/src/pages/patientView/patientHeader/SampleInline.tsx
@@ -8,6 +8,7 @@ import { ClinicalDataBySampleId } from 'cbioportal-ts-api-client';
 import ClinicalInformationPatientTable from '../clinicalInformation/ClinicalInformationPatientTable';
 import './styles.scss';
 import AppConfig from 'appConfig';
+import { shouldShowDownloadAndCopyControls } from 'shared/lib/DownloadControlsUtils';
 
 interface ISampleInlineProps {
     sample: ClinicalDataBySampleId;
@@ -53,9 +54,7 @@ export default class SampleInline extends React.Component<
                 {!this.props.hideClinicalTable && (
                     <ClinicalInformationPatientTable
                         showFilter={false}
-                        showCopyDownload={
-                            false // note: under control of AppConfig.serverConfig.skin_hide_download_controls property
-                        }
+                        showCopyDownload={shouldShowDownloadAndCopyControls()}
                         showTitleBar={false}
                         data={sample.clinicalData}
                         onSelectGenePanel={this.props.onSelectGenePanel}

diff --git a/src/pages/patientView/trialMatch/TrialMatchTable.tsx b/src/pages/patientView/trialMatch/TrialMatchTable.tsx
@@ -22,6 +22,7 @@ import { getAgeRangeDisplay } from './TrialMatchTableUtils';
 import TrialMatchFeedback from './TrialMatchFeedback';
 import AppConfig from 'appConfig';
 import { Button } from 'react-bootstrap';
+import { shouldShowDownloadAndCopyControls } from 'shared/lib/DownloadControlsUtils';
 
 export type ITrialMatchProps = {
     sampleManager: SampleManager | null;
@@ -656,9 +657,7 @@ export default class TrialMatchTable extends React.Component<ITrialMatchProps> {
                 <TrialMatchTableComponent
                     data={this.props.detailedTrialMatches}
                     columns={this._columns}
-                    showCopyDownload={
-                        false // note: under control of AppConfig.serverConfig.skin_hide_download_controls property
-                    }
+                    showCopyDownload={shouldShowDownloadAndCopyControls()}
                 />
                 <div className={styles.powered}>
                     Powered by{' '}

diff --git a/src/pages/resultsView/ResultsViewPage.tsx b/src/pages/resultsView/ResultsViewPage.tsx
@@ -61,6 +61,7 @@ import OQLTextArea, {
 import browser from 'bowser';
 import { QueryStore } from '../../shared/components/query/QueryStore';
 import UserMessager from 'shared/components/userMessager/UserMessage';
+import { shouldShowDownloadAndCopyControls } from 'shared/lib/DownloadControlsUtils';
 
 export function initStore(
     appStore: AppStore,
@@ -600,9 +601,7 @@ export default class ResultsViewPage extends React.Component<
                     <QueryAndDownloadTabs
                         forkedMode={false}
                         showQuickSearchTab={false}
-                        showDownloadTab={
-                            false // note: under control of AppConfig.serverConfig.skin_hide_download_controls property
-                        }
+                        showDownloadTab={shouldShowDownloadAndCopyControls()}
                         showAlerts={true}
                         getQueryStore={() =>
                             createQueryStore(

diff --git a/src/pages/resultsView/coExpression/CoExpressionTableGenes.tsx b/src/pages/resultsView/coExpression/CoExpressionTableGenes.tsx
@@ -16,6 +16,7 @@ import { cytobandFilter } from 'pages/resultsView/ResultsViewTableUtils';
 import { toConditionalPrecision } from 'shared/lib/NumberUtils';
 import { formatSignificanceValueWithStyle } from 'shared/lib/FormatUtils';
 import AppConfig from 'appConfig';
+import { shouldShowDownloadAndCopyControls } from 'shared/lib/DownloadControlsUtils';
 
 export interface ICoExpressionTableGenesProps {
     referenceGeneticEntity: Gene | Geneset;
@@ -180,7 +181,7 @@ export default class CoExpressionTableGenes extends React.Component<
                     paginationProps={this.paginationProps}
                     initialItemsPerPage={25}
                     copyDownloadProps={{
-                        showCopy: false, // note: under control of AppConfig.serverConfig.skin_hide_download_controls property
+                        showCopy: shouldShowDownloadAndCopyControls(),
                     }}
                 />
             </div>

diff --git a/src/pages/resultsView/coExpression/CoExpressionTableGenesets.tsx b/src/pages/resultsView/coExpression/CoExpressionTableGenesets.tsx
@@ -15,6 +15,7 @@ import { bind } from 'bind-decorator';
 import { toConditionalPrecision } from 'shared/lib/NumberUtils';
 import { formatSignificanceValueWithStyle } from 'shared/lib/FormatUtils';
 import AppConfig from 'appConfig';
+import { shouldShowDownloadAndCopyControls } from 'shared/lib/DownloadControlsUtils';
 
 export interface ICoExpressionTableGenesetsProps {
     referenceGeneticEntity: Gene | Geneset;
@@ -163,7 +164,7 @@ export default class CoExpressionTableGenesets extends React.Component<
                     paginationProps={this.paginationProps}
                     initialItemsPerPage={25}
                     copyDownloadProps={{
-                        showCopy: false, // note: under control of AppConfig.serverConfig.skin_hide_download_controls property
+                        showCopy: shouldShowDownloadAndCopyControls(),
                     }}
                 />
             </div>

diff --git a/src/pages/resultsView/querySummary/QuerySummary.tsx b/src/pages/resultsView/querySummary/QuerySummary.tsx
@@ -34,6 +34,7 @@ import ResultsPageSettings from '../settings/ResultsPageSettings';
 import { createQueryStore } from 'shared/lib/createQueryStore';
 import _ from 'lodash';
 import { mixedReferenceGenomeWarning } from 'shared/lib/referenceGenomeUtils';
+import { shouldShowDownloadAndCopyControls } from 'shared/lib/DownloadControlsUtils';
 
 interface QuerySummaryProps {
     routingStore: ExtendedRouterStore;
@@ -261,9 +262,7 @@ export default class QuerySummary extends React.Component<
                     onSubmit={this.onSubmit}
                     forkedMode={false}
                     showQuickSearchTab={false}
-                    showDownloadTab={
-                        false // note: under control of AppConfig.serverConfig.skin_hide_download_controls property
-                    }
+                    showDownloadTab={shouldShowDownloadAndCopyControls()}
                     showAlerts={true}
                     modifyQueryParams={this.props.store.modifyQueryParams}
                     getQueryStore={() =>

diff --git a/src/pages/resultsView/survival/SurvivalDescriptionTable.tsx b/src/pages/resultsView/survival/SurvivalDescriptionTable.tsx
@@ -2,6 +2,7 @@ import { observer } from 'mobx-react';
 import * as React from 'react';
 import LazyMobXTable from 'shared/components/lazyMobXTable/LazyMobXTable';
 import AppConfig from 'appConfig';
+import { shouldShowDownloadAndCopyControls } from 'shared/lib/DownloadControlsUtils';
 
 export interface ISurvivalDescription {
     studyName: string;
@@ -49,9 +50,7 @@ export default class SurvivalDescriptionTable extends React.Component<
                 initialItemsPerPage={10}
                 showColumnVisibility={false}
                 showFilter={false}
-                showCopyDownload={
-                    false // note: under control of AppConfig.serverConfig.skin_hide_download_controls property
-                }
+                showCopyDownload={shouldShowDownloadAndCopyControls()}
             />
         );
     }

diff --git a/src/pages/resultsView/survival/SurvivalPrefixTable.tsx b/src/pages/resultsView/survival/SurvivalPrefixTable.tsx
@@ -24,6 +24,7 @@ import { observable, computed, makeObservable, action } from 'mobx';
 import AppConfig from 'appConfig';
 import Slider from 'react-rangeslider';
 import styles from 'pages/resultsView/survival/styles.module.scss';
+import { shouldShowDownloadAndCopyControls } from 'shared/lib/DownloadControlsUtils';
 
 export interface ISurvivalPrefixTableProps {
     survivalPrefixes: SurvivalPrefixSummary[];
@@ -361,7 +362,7 @@ export default class SurvivalPrefixTable extends React.Component<
                 paginationProps={{ itemsPerPageOptions: [15] }}
                 initialItemsPerPage={15}
                 copyDownloadProps={{
-                    showCopy: false, // note: under control of AppConfig.serverConfig.skin_hide_download_controls property
+                    showCopy: shouldShowDownloadAndCopyControls(),
                 }}
                 filterBoxWidth={120}
             />

diff --git a/src/pages/staticPages/datasetView/DatasetList.tsx b/src/pages/staticPages/datasetView/DatasetList.tsx
@@ -9,6 +9,7 @@ import { getBrowserWindow, getNCBIlink } from 'cbioportal-frontend-commons';
 import { StudyLink } from '../../../shared/components/StudyLink/StudyLink';
 import { StudyDataDownloadLink } from '../../../shared/components/StudyDataDownloadLink/StudyDataDownloadLink';
 import AppConfig from 'appConfig';
+import { shouldShowDownloadAndCopyControls } from 'shared/lib/DownloadControlsUtils';
 
 interface IDataTableRow {
     name: string;
@@ -229,9 +230,7 @@ export default class DataSetsPageTable extends React.Component<
                         showColumnVisibility={true}
                         showFilter={true}
                         showFilterClearButton={true}
-                        showCopyDownload={
-                            false // note: under control of AppConfig.serverConfig.skin_hide_download_controls property
-                        }
+                        showCopyDownload={shouldShowDownloadAndCopyControls()}
                         initialItemsPerPage={this.props.datasets.length}
                     />
                 </div>

diff --git a/src/pages/studyView/tabs/ClinicalDataTab.tsx b/src/pages/studyView/tabs/ClinicalDataTab.tsx
@@ -24,6 +24,7 @@ import ProgressIndicator, {
 import autobind from 'autobind-decorator';
 import { WindowWidthBox } from '../../../shared/components/WindowWidthBox/WindowWidthBox';
 import AppConfig from 'appConfig';
+import { shouldShowDownloadAndCopyControls } from 'shared/lib/DownloadControlsUtils';
 
 export interface IClinicalDataTabTable {
     store: StudyViewPageStore;
@@ -217,7 +218,7 @@ export class ClinicalDataTab extends React.Component<
                                 }
                                 columns={this.columns.result}
                                 copyDownloadProps={{
-                                    showCopy: false, // note: under control of AppConfig.serverConfig.skin_hide_download_controls property
+                                    showCopy: shouldShowDownloadAndCopyControls(),
                                     downloadFilename: this.props.store
                                         .clinicalDataDownloadFilename,
                                 }}

diff --git a/src/shared/components/cosmic/CosmicMutationTable.tsx b/src/shared/components/cosmic/CosmicMutationTable.tsx
@@ -6,6 +6,7 @@ import {
     default as LazyMobXTable,
 } from '../lazyMobXTable/LazyMobXTable';
 import AppConfig from 'appConfig';
+import { shouldShowDownloadAndCopyControls } from 'shared/lib/DownloadControlsUtils';
 
 // TODO interface ICosmicTableProps extends IMSKTableProps<CosmicMutation>
 // To avoid duplication, it would be nice here to have an extendable interface for LazyMobXTableProps
@@ -93,9 +94,7 @@ export default class CosmicMutationTable extends React.Component<
                     initialSortColumn={initialSortColumn}
                     initialSortDirection={initialSortDirection}
                     initialItemsPerPage={initialItemsPerPage}
-                    showCopyDownload={
-                        false // note: under control of AppConfig.serverConfig.skin_hide_download_controls property
-                    }
+                    showCopyDownload={shouldShowDownloadAndCopyControls()}
                     showColumnVisibility={false}
                     showFilter={false}
                     showPagination={showPagination}

diff --git a/src/shared/components/proteinChainPanel/PdbChainTable.tsx b/src/shared/components/proteinChainPanel/PdbChainTable.tsx
@@ -11,6 +11,7 @@ import OrganismColumnFormatter from './column/OrganismColumnFormatter';
 import LazyLoadedTableCell from 'shared/lib/LazyLoadedTableCell';
 import { generatePdbInfoSummary } from '../../lib/PdbUtils';
 import AppConfig from 'appConfig';
+import { shouldShowDownloadAndCopyControls } from 'shared/lib/DownloadControlsUtils';
 
 class PdbChainTableComponent extends LazyMobXTable<IPdbChain> {}
 
@@ -201,9 +202,7 @@ export default class PdbChainTable extends React.Component<
         return (
             <PdbChainTableComponent
                 showColumnVisibility={false}
-                showCopyDownload={
-                    false // note: under control of AppConfig.serverConfig.skin_hide_download_controls property
-                }
+                showCopyDownload={shouldShowDownloadAndCopyControls()}
                 itemsLabel="PDB chain"
                 itemsLabelPlural="PDB chains"
                 paginationProps={{

diff --git a/src/shared/components/query/GenesetsVolcanoSelector.tsx b/src/shared/components/query/GenesetsVolcanoSelector.tsx
@@ -20,6 +20,7 @@ import {
 import { QueryStoreComponent } from './QueryStore';
 import { CBIOPORTAL_VICTORY_THEME } from 'cbioportal-frontend-commons';
 import AppConfig from 'appConfig';
+import { shouldShowDownloadAndCopyControls } from 'shared/lib/DownloadControlsUtils';
 
 class GenesetsVolcanoTable extends LazyMobXTable<Geneset> {}
 
@@ -346,9 +347,7 @@ export default class GenesetsVolcanoSelector extends QueryStoreComponent<
                                 initialItemsPerPage={100}
                                 showColumnVisibility={false}
                                 showFilter={true}
-                                showCopyDownload={
-                                    false // note: under control of AppConfig.serverConfig.skin_hide_download_controls property
-                                }
+                                showCopyDownload={shouldShowDownloadAndCopyControls()}
                             />
                         )}
                 </div>

diff --git a/src/shared/components/query/GisticGeneSelector.tsx b/src/shared/components/query/GisticGeneSelector.tsx
@@ -18,6 +18,7 @@ import { IColumnDefMap } from '../enhancedReactTable/IEnhancedReactTableProps';
 import { toPrecision } from '../../lib/FormatUtils';
 import { getGeneSymbols, sortByCytoband } from '../../lib/GisticUtils';
 import AppConfig from 'appConfig';
+import { shouldShowDownloadAndCopyControls } from 'shared/lib/DownloadControlsUtils';
 
 const DEFAULT_NUM_GENES_SHOWN = 5;
 
@@ -170,7 +171,7 @@ export default class GisticGeneSelector extends React.Component<
                     columns={this.columns}
                     rawData={this.props.data}
                     headerControlsProps={{
-                        showCopyAndDownload: false, // note: under control of AppConfig.serverConfig.skin_hide_download_controls property
+                        showCopyAndDownload: shouldShowDownloadAndCopyControls(),
                         showHideShowColumnButton: false,
                         showPagination: true,
                     }}

diff --git a/src/shared/components/query/MutSigGeneSelector.tsx b/src/shared/components/query/MutSigGeneSelector.tsx
@@ -19,6 +19,7 @@ import { IColumnDefMap } from '../enhancedReactTable/IEnhancedReactTableProps';
 import { Td } from 'reactable';
 import { toPrecision } from '../../lib/FormatUtils';
 import AppConfig from 'appConfig';
+import { shouldShowDownloadAndCopyControls } from 'shared/lib/DownloadControlsUtils';
 
 class MutSigTable extends EnhancedReactTable<MutSig> {}
 
@@ -156,7 +157,7 @@ export default class MutSigGeneSelector extends React.Component<
                     columns={this.columns}
                     rawData={this.props.data}
                     headerControlsProps={{
-                        showCopyAndDownload: false, // note: under control of AppConfig.serverConfig.skin_hide_download_controls property
+                        showCopyAndDownload: shouldShowDownloadAndCopyControls(),
                         showHideShowColumnButton: false,
                         showPagination: true,
                     }}

diff --git a/src/shared/lib/DownloadControlsUtils.ts b/src/shared/lib/DownloadControlsUtils.ts
@@ -0,0 +1,6 @@
+export function shouldShowDownloadAndCopyControls() {
+    // for now, we are always hiding copy controls, but in the future we will use the
+    //    app config to determine whether we show them:
+    // return !AppConfig.serverConfig.skin_hide_download_controls
+    return false;
+}