feat: add coming-from parameter (#837)

Author: obostjancic

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Changelog
 
+- feat: Add `coming-from` parameter ([#837](https://github.com/getsentry/sentry-wizard/pull/837))
+
 ## 4.1.0
 
 - feat(nuxt): More granular error catching while modifying config ([#833](https://github.com/getsentry/sentry-wizard/pull/833))

README.md

@@ -71,6 +71,7 @@ The following CLI arguments are available:
 | `-s, --signup`        | Redirect to signup page if not logged in                          | boolean | `false`                                 |                                                                                                                        |                              |
 | `--disable-telemetry` | Don't send telemetry data to Sentry                               | boolean | `false`                                 |                                                                                                                        |                              |
 | `--force-install`     | Force install the SDK NPM package (use with caution!)             | boolean | `false`                                 |                                                                                                                        |                              |
+| `--coming-from`       | Specify the partner organization initiating this command.         | string  |                                         |                                                                                                                        |                              |
 
 ## Resources
 

lib/Constants.ts

@@ -113,6 +113,7 @@ export interface Args {
   signup: boolean;
   promoCode?: string;
   disableTelemetry?: boolean;
+  comingFrom?: string;
 }
 
 export const DEFAULT_URL = 'https://sentry.io/';

lib/Steps/OpenSentry.ts

@@ -51,6 +51,11 @@ export class OpenSentry extends BaseStep {
         }
       }
 
+      if (this._argv.comingFrom) {
+        // Used to display login/signup instructions when the user is coming from a partner site (e.g. Vercel)
+        urlObj.searchParams.set('partner', this._argv.comingFrom);
+      }
+
       const urlToOpen = urlObj.toString();
 
       // opn throws in environments that don't have a browser (e.g. remote shells) so we just noop here

src/run.ts

@@ -57,6 +57,7 @@ type Args = {
   project?: string;
   saas?: boolean;
   forceInstall?: boolean;
+  comingFrom?: string;
 };
 
 function preSelectedProjectArgsToObject(
@@ -134,6 +135,7 @@ export async function run(argv: Args) {
     saas: finalArgs.saas,
     preSelectedProject: preSelectedProjectArgsToObject(finalArgs),
     forceInstall: finalArgs.forceInstall,
+    comingFrom: finalArgs.comingFrom,
   };
 
   switch (integration) {

src/utils/clack-utils.ts

@@ -902,6 +902,7 @@ export async function getOrAskForProjectData(
       platform: platform,
       orgSlug: options.orgSlug,
       projectSlug: options.projectSlug,
+      comingFrom: options.comingFrom,
     }),
   );
 
@@ -1044,8 +1045,10 @@ export async function askForWizardLogin(options: {
     | 'flutter';
   orgSlug?: string;
   projectSlug?: string;
+  comingFrom?: string;
 }): Promise<WizardProjectData> {
-  const { orgSlug, projectSlug, url, platform, promoCode } = options;
+  const { orgSlug, projectSlug, url, platform, promoCode, comingFrom } =
+    options;
 
   Sentry.setTag('has-promo-code', !!promoCode);
 
@@ -1080,6 +1083,10 @@ export async function askForWizardLogin(options: {
     loginUrl.searchParams.set('code', promoCode);
   }
 
+  if (comingFrom) {
+    loginUrl.searchParams.set('partner', comingFrom);
+  }
+
   const urlToOpen = loginUrl.toString();
   clack.log.info(
     `${chalk.bold(

src/utils/types.ts

@@ -67,6 +67,13 @@ export type WizardOptions = {
    * Does not apply to all wizard flows (currently NPM only)
    */
   forceInstall?: boolean;
+
+  /**
+   * Used when the wizard command is copied from partner sites (e.g. Vercel)
+   * to display login/signup instructions specific to organizations provisioned
+   * through the partner.
+   */
+  comingFrom?: string;
 };
 
 export interface Feature {