mirror of
https://github.com/grafana/grafana.git
synced 2025-07-30 07:42:23 +08:00

* add isPublic to dashboard * refactor routes to use route group and add placeholder method for sharing apii * add sharing pane and utils for public dashboard config to sharing modal * Sharing modal now persists data through the api * moves ShareDashboard endpoint to new file and starts adding tests * generates mocks. Adds tests for public dashboard feature flag * Adds ability to pass in array of features to enable for the test * test to update public flag on dashboard WIP * Adds mock for SaveDashboardSharingConfig * Fixes tests. Had to use FakeDashboardService * Adds React tests for public dashboards toggle * removes semicolons * refactors SharePublic component to use hooks * rename from `share publicly` to `public dashboard config` * checkpoint. debugging tests. need to verify name changes * checkpoint. test bugs fixed. need to finish returning proper response codes * finish renaming. fix test * Update pkg/api/api.go Co-authored-by: Torkel Ödegaard <torkel@grafana.com> * update backend url * rename internal objects and commands. fix configuration modal labels * add endpoint for retrieving public dashboard configuration and populate the frontend state from it * add test for dashboardCanBePublic * adds backend routes * copy DashboardPage component into component for public dashboards. WIP * adds react routes, and doesnt render main nav bar when viewing a public route * removes extra react route from testing * updates component name * Wrap the original dashboard component so we can pass props relevant to public dashboards, turn kiosk mode on/off, etc * Wraps DashboardPage in PublicDashboardPage component. DashboardPage gets rendered in kiosk mode when public prop is passed. * removes commented out code from exploratory work * Makes public dashboard routes require no auth * extracts helper to own util file to check if were viewing a public page * Hides panel dropdown when its being viewed publicly * formatting * use function from utils file for determining if publicly viewed. If public, hides app notifications, searchwrapper, and commandpalette. * adds unit tests for util function used to see if page is being viewed publicly * cant added annotations to panel when being publicly viewed * removes useless comment * hides backend and frontend pubdash routes behind feature flag * consider feature flag when checking url path to see if on public dashboard * renames function * still render app notifications when in public view * Extract pubdash route logic into own file * fixes failing tests * Determines path using location locationUtils. This covers the case when grafana is being hosted on a subpath. Updates tests. * renames pubdash web route to be more understandable * rename route * fixes failing test * fixes failing test. Needed to update pubdash urls * sets flag on grafana boot config for if viewing public dashboard. Removes hacky check that looks at the url * fixes failing tests. Uses config to determine if viewing public dashboard * renders the blue panel timeInfo on public dashboard panel * Extracts conditional logic for rendering components out into their own functions * removes publicDashboardView check, and uses dashboard meta instead * the timeInfo is always displayed on the panel * After fetch of public dashboard dto, the meta isPublic flag gets set and used to determine if viewing public dashboard for child components. Fixes tests for PanelHeader. * Fixes failing test. Needed to add isPublic flag to dashboard meta. Co-authored-by: Jeff Levin <jeff@levinology.com> Co-authored-by: Torkel Ödegaard <torkel@grafana.com>
174 lines
4.4 KiB
TypeScript
174 lines
4.4 KiB
TypeScript
import { merge } from 'lodash';
|
|
|
|
import {
|
|
BootData,
|
|
BuildInfo,
|
|
createTheme,
|
|
DataSourceInstanceSettings,
|
|
FeatureToggles,
|
|
GrafanaConfig,
|
|
GrafanaTheme,
|
|
GrafanaTheme2,
|
|
LicenseInfo,
|
|
MapLayerOptions,
|
|
OAuthSettings,
|
|
PanelPluginMeta,
|
|
PreloadPlugin,
|
|
systemDateFormats,
|
|
SystemDateFormatSettings,
|
|
} from '@grafana/data';
|
|
|
|
export interface AzureSettings {
|
|
cloud?: string;
|
|
managedIdentityEnabled: boolean;
|
|
}
|
|
|
|
export class GrafanaBootConfig implements GrafanaConfig {
|
|
isPublicDashboardView: boolean;
|
|
datasources: { [str: string]: DataSourceInstanceSettings } = {};
|
|
panels: { [key: string]: PanelPluginMeta } = {};
|
|
minRefreshInterval = '';
|
|
appUrl = '';
|
|
appSubUrl = '';
|
|
windowTitlePrefix = '';
|
|
buildInfo: BuildInfo;
|
|
newPanelTitle = '';
|
|
bootData: BootData;
|
|
externalUserMngLinkUrl = '';
|
|
externalUserMngLinkName = '';
|
|
externalUserMngInfo = '';
|
|
allowOrgCreate = false;
|
|
feedbackLinksEnabled = true;
|
|
disableLoginForm = false;
|
|
defaultDatasource = ''; // UID
|
|
alertingEnabled = false;
|
|
alertingErrorOrTimeout = '';
|
|
alertingNoDataOrNullValues = '';
|
|
alertingMinInterval = 1;
|
|
angularSupportEnabled = false;
|
|
authProxyEnabled = false;
|
|
exploreEnabled = false;
|
|
queryHistoryEnabled = false;
|
|
helpEnabled = false;
|
|
profileEnabled = false;
|
|
ldapEnabled = false;
|
|
sigV4AuthEnabled = false;
|
|
samlEnabled = false;
|
|
samlName = '';
|
|
autoAssignOrg = true;
|
|
verifyEmailEnabled = false;
|
|
oauth: OAuthSettings = {};
|
|
rbacEnabled = true;
|
|
rbacBuiltInRoleAssignmentEnabled = false;
|
|
disableUserSignUp = false;
|
|
loginHint = '';
|
|
passwordHint = '';
|
|
loginError = undefined;
|
|
navTree: any;
|
|
viewersCanEdit = false;
|
|
editorsCanAdmin = false;
|
|
disableSanitizeHtml = false;
|
|
liveEnabled = true;
|
|
theme: GrafanaTheme;
|
|
theme2: GrafanaTheme2;
|
|
pluginsToPreload: PreloadPlugin[] = [];
|
|
featureToggles: FeatureToggles = {};
|
|
licenseInfo: LicenseInfo = {} as LicenseInfo;
|
|
rendererAvailable = false;
|
|
dashboardPreviews: {
|
|
systemRequirements: {
|
|
met: boolean;
|
|
requiredImageRendererPluginVersion: string;
|
|
};
|
|
thumbnailsExist: boolean;
|
|
} = { systemRequirements: { met: false, requiredImageRendererPluginVersion: '' }, thumbnailsExist: false };
|
|
rendererVersion = '';
|
|
http2Enabled = false;
|
|
dateFormats?: SystemDateFormatSettings;
|
|
sentry = {
|
|
enabled: false,
|
|
dsn: '',
|
|
customEndpoint: '',
|
|
sampleRate: 1,
|
|
};
|
|
pluginCatalogURL = 'https://grafana.com/grafana/plugins/';
|
|
pluginAdminEnabled = true;
|
|
pluginAdminExternalManageEnabled = false;
|
|
pluginCatalogHiddenPlugins: string[] = [];
|
|
expressionsEnabled = false;
|
|
customTheme?: any;
|
|
awsAllowedAuthProviders: string[] = [];
|
|
awsAssumeRoleEnabled = false;
|
|
azure: AzureSettings = {
|
|
managedIdentityEnabled: false,
|
|
};
|
|
caching = {
|
|
enabled: false,
|
|
};
|
|
geomapDefaultBaseLayerConfig?: MapLayerOptions;
|
|
geomapDisableCustomBaseLayer?: boolean;
|
|
unifiedAlertingEnabled = false;
|
|
applicationInsightsConnectionString?: string;
|
|
applicationInsightsEndpointUrl?: string;
|
|
recordedQueries = {
|
|
enabled: true,
|
|
};
|
|
featureHighlights = {
|
|
enabled: false,
|
|
};
|
|
reporting = {
|
|
enabled: true,
|
|
};
|
|
|
|
constructor(options: GrafanaBootConfig) {
|
|
const mode = options.bootData.user.lightTheme ? 'light' : 'dark';
|
|
this.theme2 = createTheme({ colors: { mode } });
|
|
this.theme = this.theme2.v1;
|
|
this.bootData = options.bootData;
|
|
this.isPublicDashboardView = options.bootData.settings.isPublicDashboardView;
|
|
|
|
const defaults = {
|
|
datasources: {},
|
|
windowTitlePrefix: 'Grafana - ',
|
|
panels: {},
|
|
newPanelTitle: 'Panel Title',
|
|
playlist_timespan: '1m',
|
|
unsaved_changes_warning: true,
|
|
appUrl: '',
|
|
appSubUrl: '',
|
|
buildInfo: {
|
|
version: '1.0',
|
|
commit: '1',
|
|
env: 'production',
|
|
},
|
|
viewersCanEdit: false,
|
|
editorsCanAdmin: false,
|
|
disableSanitizeHtml: false,
|
|
};
|
|
|
|
merge(this, defaults, options);
|
|
|
|
this.buildInfo = options.buildInfo || defaults.buildInfo;
|
|
|
|
if (this.dateFormats) {
|
|
systemDateFormats.update(this.dateFormats);
|
|
}
|
|
}
|
|
}
|
|
|
|
const bootData = (window as any).grafanaBootData || {
|
|
settings: {},
|
|
user: {},
|
|
navTree: [],
|
|
};
|
|
|
|
const options = bootData.settings;
|
|
options.bootData = bootData;
|
|
|
|
/**
|
|
* Use this to access the {@link GrafanaBootConfig} for the current running Grafana instance.
|
|
*
|
|
* @public
|
|
*/
|
|
export const config = new GrafanaBootConfig(options);
|