Rudderstack: Add new config option for rudderstack v3 url (#115374)

conf/defaults.ini

@@ -335,6 +335,9 @@ rudderstack_data_plane_url =
 # Rudderstack SDK url, optional, only valid if rudderstack_write_key and rudderstack_data_plane_url is also set
 rudderstack_sdk_url =
 
+# Rudderstack v3 SDK, optional, defaults to false. If set, Rudderstack v3 SDK will be used instead of v1
+rudderstack_v3_sdk_url = 
+
 # Rudderstack Config url, optional, used by Rudderstack SDK to fetch source config
 rudderstack_config_url =
 

conf/sample.ini

@@ -322,6 +322,9 @@
 # Rudderstack SDK url, optional, only valid if rudderstack_write_key and rudderstack_data_plane_url is also set
 ;rudderstack_sdk_url =
 
+# Rudderstack v3 SDK, optional, defaults to false. If set, Rudderstack v3 SDK will be used instead of v1
+;rudderstack_v3_sdk_url = 
+
 # Rudderstack Config url, optional, used by Rudderstack SDK to fetch source config
 ;rudderstack_config_url =
 

docs/sources/setup-grafana/configure-grafana/_index.md

@@ -642,6 +642,12 @@ You must also provide the `rudderstack_write_key` to enable this feature.
 Optional.
 If tracking with RudderStack is enabled, you can provide a custom URL to load the RudderStack SDK.
 
+#### `rudderstack_v3_sdk_url`
+
+Optional.
+This is mirroring the old configuration option, which will be deprecated.
+If `rudderstack_sdk_url` and `rudderstack_v3_sdk_url` are both set, the feature toggle `rudderstackUpgrade` will control which one is loaded.
+
 #### `rudderstack_config_url`
 
 Optional.

packages/grafana-data/src/types/config.ts

@@ -289,6 +289,7 @@ export interface GrafanaConfig {
   rudderstackWriteKey: string;
   rudderstackDataPlaneUrl: string;
   rudderstackSdkUrl: string;
+  rudderstackV3SdkUrl: string;
   rudderstackConfigUrl: string;
   rudderstackIntegrationsUrl: string;
   applicationInsightsConnectionString: string;

packages/grafana-runtime/src/config.ts

@@ -224,6 +224,7 @@ export class GrafanaBootConfig {
   rudderstackWriteKey?: string;
   rudderstackDataPlaneUrl?: string;
   rudderstackSdkUrl?: string;
+  rudderstackV3SdkUrl?: string;
   rudderstackConfigUrl?: string;
   rudderstackIntegrationsUrl?: string;
   analyticsConsoleReporting = false;

pkg/api/dtos/frontend_settings.go

@@ -200,6 +200,7 @@ type FrontendSettingsDTO struct {
 	RudderstackWriteKey        string `json:"rudderstackWriteKey"`
 	RudderstackDataPlaneUrl    string `json:"rudderstackDataPlaneUrl"`
 	RudderstackSdkUrl          string `json:"rudderstackSdkUrl"`
+	RudderstackV3SdkUrl        string `json:"rudderstackV3SdkUrl"`
 	RudderstackConfigUrl       string `json:"rudderstackConfigUrl"`
 	RudderstackIntegrationsUrl string `json:"rudderstackIntegrationsUrl"`
 

pkg/api/frontendsettings.go

@@ -229,6 +229,7 @@ func (hs *HTTPServer) getFrontendSettings(c *contextmodel.ReqContext) (*dtos.Fro
 		RudderstackWriteKey:                  hs.Cfg.RudderstackWriteKey,
 		RudderstackDataPlaneUrl:              hs.Cfg.RudderstackDataPlaneURL,
 		RudderstackSdkUrl:                    hs.Cfg.RudderstackSDKURL,
+		RudderstackV3SdkUrl:                  hs.Cfg.RudderstackV3SDKURL,
 		RudderstackConfigUrl:                 hs.Cfg.RudderstackConfigURL,
 		RudderstackIntegrationsUrl:           hs.Cfg.RudderstackIntegrationsURL,
 		AnalyticsConsoleReporting:            hs.Cfg.FrontendAnalyticsConsoleReporting,

pkg/services/frontend/frontend_settings.go

@@ -32,6 +32,7 @@ type FSFrontendSettings struct {
 	RudderstackWriteKey        string `json:"rudderstackWriteKey,omitempty"`
 	RudderstackDataPlaneUrl    string `json:"rudderstackDataPlaneUrl,omitempty"`
 	RudderstackSdkUrl          string `json:"rudderstackSdkUrl,omitempty"`
+	RudderstackV3SdkUrl        string `json:"rudderstackV3SdkUrl,omitempty"`
 	RudderstackConfigUrl       string `json:"rudderstackConfigUrl,omitempty"`
 	RudderstackIntegrationsUrl string `json:"rudderstackIntegrationsUrl,omitempty"`
 

pkg/services/frontend/index.go

@@ -94,6 +94,7 @@ func NewIndexProvider(cfg *setting.Cfg, assetsManifest dtos.EntryPointAssets, li
 		RudderstackDataPlaneUrl:              cfg.RudderstackDataPlaneURL,
 		RudderstackIntegrationsUrl:           cfg.RudderstackIntegrationsURL,
 		RudderstackSdkUrl:                    cfg.RudderstackSDKURL,
+		RudderstackV3SdkUrl:                  cfg.RudderstackV3SDKURL,
 		RudderstackWriteKey:                  cfg.RudderstackWriteKey,
 		TrustedTypesDefaultPolicyEnabled:     (cfg.CSPEnabled && strings.Contains(cfg.CSPTemplate, "require-trusted-types-for")) || (cfg.CSPReportOnlyEnabled && strings.Contains(cfg.CSPReportOnlyTemplate, "require-trusted-types-for")),
 		VerifyEmailEnabled:                   cfg.VerifyEmailEnabled,

pkg/setting/setting.go

@@ -414,6 +414,7 @@ type Cfg struct {
 	RudderstackDataPlaneURL             string
 	RudderstackWriteKey                 string
 	RudderstackSDKURL                   string
+	RudderstackV3SDKURL                 string
 	RudderstackConfigURL                string
 	RudderstackIntegrationsURL          string
 	IntercomSecret                      string
@@ -1278,6 +1279,7 @@ func (cfg *Cfg) parseINIFile(iniFile *ini.File) error {
 	cfg.RudderstackWriteKey = analytics.Key("rudderstack_write_key").String()
 	cfg.RudderstackDataPlaneURL = analytics.Key("rudderstack_data_plane_url").String()
 	cfg.RudderstackSDKURL = analytics.Key("rudderstack_sdk_url").String()
+	cfg.RudderstackV3SDKURL = analytics.Key("rudderstack_v3_sdk_url").String()
 	cfg.RudderstackConfigURL = analytics.Key("rudderstack_config_url").String()
 	cfg.RudderstackIntegrationsURL = analytics.Key("rudderstack_integrations_url").String()
 	cfg.IntercomSecret = analytics.Key("intercom_secret").String()

public/app/core/services/echo/init.ts

@@ -146,17 +146,15 @@ async function initRudderstackBackend() {
     return;
   }
 
-  // this will need to be updated when rudderstackSdkV3Url is added
+  // Logic: if only one of the sdk urls is provided, use respective code
-  // Desired logic: if only one of the sdk urls is provided, use respective code
   // otherwise defer to the feature toggle.
-  const fakeConfigRudderstackSdkV3Url: string | undefined = undefined;
 
   const hasOldSdkUrl = Boolean(config.rudderstackSdkUrl);
-  const hasNewSdkUrl = Boolean(fakeConfigRudderstackSdkV3Url);
+  const hasNewSdkUrl = Boolean(config.rudderstackV3SdkUrl);
-  const onlyOneConfigURLSet = hasOldSdkUrl !== hasNewSdkUrl;
+  const onlyOneSdkUrlSet = hasOldSdkUrl !== hasNewSdkUrl;
-  const useNewRudderstack = onlyOneConfigURLSet ? hasNewSdkUrl : config.featureToggles.rudderstackUpgrade;
+  const useNewRudderstack = onlyOneSdkUrlSet ? hasNewSdkUrl : config.featureToggles.rudderstackUpgrade;
 
-  const configUrl = useNewRudderstack ? fakeConfigRudderstackSdkV3Url : config.rudderstackSdkUrl;
+  const sdkUrl = useNewRudderstack ? config.rudderstackV3SdkUrl : config.rudderstackSdkUrl;
 
   const modulePromise = useNewRudderstack
     ? import('./backends/analytics/RudderstackV3Backend')
@@ -168,8 +166,8 @@ async function initRudderstackBackend() {
       writeKey: config.rudderstackWriteKey,
       dataPlaneUrl: config.rudderstackDataPlaneUrl,
       user: contextSrv.user,
-      sdkUrl: config.rudderstackSdkUrl,
+      sdkUrl,
-      configUrl: configUrl,
+      configUrl: config.rudderstackConfigUrl,
       integrationsUrl: config.rudderstackIntegrationsUrl,
       buildInfo: config.buildInfo,
     })