@sentry/wizard 1.2.12 → 1.2.16

package/dist/lib/Steps/Integrations/NextJs.js

@@ -59,8 +59,16 @@ var __rest = (this && this.__rest) || function (s, e) {
         }
     return t;
 };
+var __spreadArrays = (this && this.__spreadArrays) || function () {
+    for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;
+    for (var r = Array(s), k = 0, i = 0; i < il; i++)
+        for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)
+            r[k] = a[j];
+    return r;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NextJs = void 0;
+/* eslint-disable max-lines */
 var fs = require("fs");
 var inquirer_1 = require("inquirer");
 var _ = require("lodash");
@@ -69,12 +77,20 @@ var semver_1 = require("semver");
 var Logging_1 = require("../../Helper/Logging");
 var SentryCli_1 = require("../../Helper/SentryCli");
 var BaseIntegration_1 = require("./BaseIntegration");
-var MIN_NEXTJS_VERSION = '10.0.8'; // Must be a fixed version: `X.Y.Z`
+var COMPATIBLE_NEXTJS_VERSIONS = '>=10.0.8 <12.0.0';
 var PROPERTIES_FILENAME = 'sentry.properties';
 var SENTRYCLIRC_FILENAME = '.sentryclirc';
 var GITIGNORE_FILENAME = '.gitignore';
 var CONFIG_DIR = 'configs/';
-var MERGEABLE_CONFIG_PREFIX = '_';
+var MERGEABLE_CONFIG_INFIX = 'wizardcopy';
+// for those files which can go in more than one place, the list of places they
+// could go (the first one which works will be used)
+var TEMPLATE_DESTINATIONS = {
+    '_error.js': ['pages', 'src/pages'],
+    'next.config.js': ['.'],
+    'sentry.server.config.js': ['.'],
+    'sentry.client.config.js': ['.'],
+};
 var appPackage = {};
 try {
     appPackage = require(path.join(process.cwd(), 'package.json'));
@@ -107,7 +123,7 @@ var NextJs = /** @class */ (function (_super) {
                             this._createNextConfig(configDirectory, dsn);
                         }
                         else {
-                            Logging_1.debug("Couldn't find " + configDirectory + ", probably because you run from src");
+                            Logging_1.debug("Couldn't find " + configDirectory + ", probably because you ran this from inside of `/lib` rather than `/dist`");
                             Logging_1.nl();
                         }
                         Logging_1.l('For more information, see https://docs.sentry.io/platforms/javascript/guides/nextjs/');
@@ -128,7 +144,7 @@ var NextJs = /** @class */ (function (_super) {
                         }
                         Logging_1.nl();
                         userAnswers = { continue: true };
-                        if (!(!this._checkDep('next', true) && !this._argv.quiet)) return [3 /*break*/, 2];
+                        if (!(!this._checkUserNextVersion('next') && !this._argv.quiet)) return [3 /*break*/, 2];
                         return [4 /*yield*/, inquirer_1.prompt({
                                 message: 'There were errors during your project checkup, do you still want to continue?',
                                 name: 'continue',
@@ -161,7 +177,7 @@ var NextJs = /** @class */ (function (_super) {
                         _c.label = 1;
                     case 1:
                         _c.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, fs.promises.appendFile(SENTRYCLIRC_FILENAME, this._sentryCli.dumpProperties({ 'auth/token': authToken }))];
+                        return [4 /*yield*/, fs.promises.appendFile(SENTRYCLIRC_FILENAME, this._sentryCli.dumpConfig({ auth: { token: authToken } }))];
                     case 2:
                         _c.sent();
                         Logging_1.green("\u2713 Successfully added the auth token to " + SENTRYCLIRC_FILENAME);
@@ -228,78 +244,92 @@ var NextJs = /** @class */ (function (_super) {
         var templates = fs.readdirSync(configDirectory);
         for (var _i = 0, templates_1 = templates; _i < templates_1.length; _i++) {
             var template = templates_1[_i];
-            this._setTemplate(configDirectory, template, dsn);
+            this._setTemplate(configDirectory, template, TEMPLATE_DESTINATIONS[template], dsn);
         }
         Logging_1.red('⚠ Performance monitoring is enabled capturing 100% of transactions.\n' +
             '  Learn more in https://docs.sentry.io/product/performance/');
         Logging_1.nl();
     };
-    NextJs.prototype._setTemplate = function (configDirectory, template, dsn) {
-        var templatePath = path.join(configDirectory, template);
-        var mergeableFile = MERGEABLE_CONFIG_PREFIX + template;
-        if (!fs.existsSync(template)) {
-            this._fillAndCopyTemplate(templatePath, template, dsn);
-        }
-        else if (!fs.existsSync(mergeableFile)) {
-            this._fillAndCopyTemplate(templatePath, mergeableFile, dsn);
-            Logging_1.red("File " + template + " already exists, so created " + mergeableFile + ".\n" +
-                "Please, merge those files.");
-            Logging_1.nl();
-        }
-        else {
-            Logging_1.red("File " + template + " already exists, and " + mergeableFile + " also exists.\n" +
-                'Please, merge those files.');
-            Logging_1.nl();
+    NextJs.prototype._setTemplate = function (configDirectory, templateFile, destinationOptions, dsn) {
+        var templatePath = path.join(configDirectory, templateFile);
+        for (var _i = 0, destinationOptions_1 = destinationOptions; _i < destinationOptions_1.length; _i++) {
+            var destinationDir = destinationOptions_1[_i];
+            if (!fs.existsSync(destinationDir)) {
+                continue;
+            }
+            var destinationPath = path.join(destinationDir, templateFile);
+            // in case the file in question already exists, we'll make a copy with
+            // `MERGEABLE_CONFIG_INFIX` inserted just before the extension, so as not
+            // to overwrite the existing file
+            var mergeableFilePath = path.join(destinationDir, this._spliceInPlace(templateFile.split('.'), -1, 0, MERGEABLE_CONFIG_INFIX).join('.'));
+            if (!fs.existsSync(destinationPath)) {
+                this._fillAndCopyTemplate(templatePath, destinationPath, dsn);
+            }
+            else if (!fs.existsSync(mergeableFilePath)) {
+                this._fillAndCopyTemplate(templatePath, mergeableFilePath, dsn);
+                Logging_1.red("File `" + templateFile + "` already exists, so created `" + mergeableFilePath + "`.\n" +
+                    'Please merge those files.');
+                Logging_1.nl();
+            }
+            else {
+                Logging_1.red("Both `" + templateFile + "` and `" + mergeableFilePath + "` already exist.\n" +
+                    'Please merge those files.');
+                Logging_1.nl();
+            }
+            return;
         }
+        Logging_1.red("Could not find appropriate destination for `" + templateFile + "`. Tried: " + destinationOptions + ".");
+        Logging_1.nl();
     };
     NextJs.prototype._fillAndCopyTemplate = function (sourcePath, targetPath, dsn) {
         var templateContent = fs.readFileSync(sourcePath).toString();
         var filledTemplate = templateContent.replace('___DSN___', dsn);
         fs.writeFileSync(targetPath, filledTemplate);
     };
-    NextJs.prototype._checkDep = function (packageName, minVersion) {
-        var depVersion = _.get(appPackage, ['dependencies', packageName], '0.0.0');
-        var devDepVersion = _.get(appPackage, ['devDependencies', packageName], '0.0.0');
-        if (!_.get(appPackage, "dependencies." + packageName, false) &&
-            !_.get(appPackage, "devDependencies." + packageName, false)) {
-            Logging_1.red("\u2717 " + packageName + " isn't in your dependencies");
-            Logging_1.red("  please install it with yarn/npm");
+    NextJs.prototype._checkUserNextVersion = function (packageName) {
+        var depsVersion = _.get(appPackage, ['dependencies', packageName]);
+        var devDepsVersion = _.get(appPackage, ['devDependencies', packageName]);
+        if (!depsVersion && !devDepsVersion) {
+            Logging_1.red("\u2717 " + packageName + " isn't in your dependencies.");
+            Logging_1.red('  Please install it with yarn/npm.');
             return false;
         }
-        else if (!this._fulfillsMinVersion(depVersion) &&
-            !this._fulfillsMinVersion(devDepVersion)) {
-            Logging_1.red("\u2717 Your installed version of `" + packageName + "` is not supported, >=" + MIN_NEXTJS_VERSION + " needed.");
+        else if (!this._fulfillsVersionRange(depsVersion) &&
+            !this._fulfillsVersionRange(devDepsVersion)) {
+            Logging_1.red("\u2717 Your `package.json` specifies a version of `" + packageName + "` outside of the compatible version range " + COMPATIBLE_NEXTJS_VERSIONS + ".\n");
             return false;
         }
         else {
-            if (minVersion) {
-                Logging_1.green("\u2713 " + packageName + " >= " + MIN_NEXTJS_VERSION + " is installed");
-            }
-            else {
-                Logging_1.green("\u2713 " + packageName + " is installed");
-            }
+            Logging_1.green("\u2713 A compatible version of `" + packageName + "` is specified in `package.json`.");
             return true;
         }
     };
-    NextJs.prototype._fulfillsMinVersion = function (version) {
-        // The latest version, which at the moment is greater than the minimum
-        // version, shouldn't be a blocker in the wizard.
+    NextJs.prototype._fulfillsVersionRange = function (version) {
+        // The latest version is currently 12.x, which is not yet supported.
         if (version === 'latest') {
-            return true;
+            return false;
         }
-        var cleanedVersion = semver_1.clean(version);
-        if (cleanedVersion) {
-            // gte(x, y) : true if x >= y
-            return semver_1.gte(cleanedVersion, MIN_NEXTJS_VERSION);
+        var cleanedUserVersion, isRange;
+        if (semver_1.valid(version)) {
+            cleanedUserVersion = semver_1.valid(version);
+            isRange = false;
         }
-        var minVersionRange = ">=" + MIN_NEXTJS_VERSION;
-        var userVersionRange = semver_1.validRange(version);
-        var minUserVersion = semver_1.minVersion(userVersionRange);
-        if (minUserVersion == null) {
-            // This should never happen
-            return false;
+        else if (semver_1.validRange(version)) {
+            cleanedUserVersion = semver_1.validRange(version);
+            isRange = true;
+        }
+        return (!!cleanedUserVersion &&
+            (isRange
+                ? semver_1.subset(cleanedUserVersion, COMPATIBLE_NEXTJS_VERSIONS)
+                : semver_1.satisfies(cleanedUserVersion, COMPATIBLE_NEXTJS_VERSIONS)));
+    };
+    NextJs.prototype._spliceInPlace = function (arr, start, deleteCount) {
+        var inserts = [];
+        for (var _i = 3; _i < arguments.length; _i++) {
+            inserts[_i - 3] = arguments[_i];
         }
-        return semver_1.satisfies(minUserVersion, minVersionRange);
+        arr.splice.apply(arr, __spreadArrays([start, deleteCount], inserts));
+        return arr;
     };
     return NextJs;
 }(BaseIntegration_1.BaseIntegration));

package/dist/lib/Steps/Integrations/NextJs.js.map

@@ -1 +1 @@
-{"version":3,"file":"NextJs.js","sourceRoot":"","sources":["../../../../lib/Steps/Integrations/NextJs.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uBAAyB;AACzB,qCAA2C;AAC3C,0BAA4B;AAC5B,2BAA6B;AAC7B,iCAAuE;AAGvE,gDAAgE;AAChE,oDAAmE;AACnE,qDAAoD;AAEpD,IAAM,kBAAkB,GAAG,QAAQ,CAAC,CAAC,mCAAmC;AACxE,IAAM,mBAAmB,GAAG,mBAAmB,CAAC;AAChD,IAAM,oBAAoB,GAAG,cAAc,CAAC;AAC5C,IAAM,kBAAkB,GAAG,YAAY,CAAC;AACxC,IAAM,UAAU,GAAG,UAAU,CAAC;AAC9B,IAAM,uBAAuB,GAAG,GAAG,CAAC;AAEpC,IAAI,UAAU,GAAQ,EAAE,CAAC;AAEzB,IAAI;IACF,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC,CAAC;CAChE;AAAC,WAAM;IACN,6BAA6B;CAC9B;AAED;IAA4B,0BAAe;IAGzC,gBAAsB,KAAW;QAAjC,YACE,kBAAM,KAAK,CAAC,SAEb;QAHqB,WAAK,GAAL,KAAK,CAAM;QAE/B,KAAI,CAAC,UAAU,GAAG,IAAI,qBAAS,CAAC,KAAI,CAAC,KAAK,CAAC,CAAC;;IAC9C,CAAC;IAEY,qBAAI,GAAjB,UAAkB,OAAgB;;;;;;wBAC1B,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAC;wBAC9D,YAAE,EAAE,CAAC;wBAEC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC;wBAC3E,qBAAM,IAAI,CAAC,sBAAsB,CAAC,cAAc,CAAC,EAAA;;wBAAjD,SAAiD,CAAC;wBAE5C,eAAe,GAAG,IAAI,CAAC,IAAI,CAC/B,SAAS,EACT,IAAI,EACJ,IAAI,EACJ,IAAI,EACJ,QAAQ,EACR,UAAU,CACX,CAAC;wBAEF,IAAI,EAAE,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE;4BAClC,IAAI,CAAC,iBAAiB,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;yBAC9C;6BAAM;4BACL,eAAK,CACH,mBAAiB,eAAe,wCAAqC,CACtE,CAAC;4BACF,YAAE,EAAE,CAAC;yBACN;wBAED,WAAC,CACC,sFAAsF,CACvF,CAAC;wBACF,YAAE,EAAE,CAAC;wBAEL,sBAAO,EAAE,EAAC;;;;KACX;IAEY,gCAAe,GAA5B,UAA6B,QAAiB;;;;;;wBAC5C,IAAI,IAAI,CAAC,gBAAgB,EAAE;4BACzB,sBAAO,IAAI,CAAC,gBAAgB,EAAC;yBAC9B;wBAED,YAAE,EAAE,CAAC;wBAED,WAAW,GAAY,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;6BAC1C,CAAA,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAA,EAAlD,wBAAkD;wBACtC,qBAAM,iBAAM,CAAC;gCACzB,OAAO,EACL,+EAA+E;gCACjF,IAAI,EAAE,UAAU;gCAChB,OAAO,EAAE,KAAK;gCACd,IAAI,EAAE,SAAS;6BAChB,CAAC,EAAA;;wBANF,WAAW,GAAG,SAMZ,CAAC;;;wBAGL,YAAE,EAAE,CAAC;wBAEL,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE;4BAC5B,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;yBAC1E;wBAED,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;wBAC1D,6DAA6D;wBAC7D,sBAAO,IAAI,CAAC,eAAe,EAAC;;;;KAC7B;IAEa,uCAAsB,GAApC,UACE,QAAwB;;;;;;wBAEF,SAAS,GAAyB,QAAQ,cAAjC,EAAK,eAAe,UAAK,QAAQ,EAA1D,cAA+C,CAAF,CAAc;6BAQ7D,SAAS,EAAT,wBAAS;;;;wBAET,qBAAM,EAAE,CAAC,QAAQ,CAAC,UAAU,CAC1B,oBAAoB,EACpB,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,YAAY,EAAE,SAAS,EAAE,CAAC,CAC5D,EAAA;;wBAHD,SAGC,CAAC;wBACF,eAAK,CAAC,iDAA0C,oBAAsB,CAAC,CAAC;;;;wBAExE,aAAG,CACD,4CAAqC,oBAAoB,OAAI;6BAC3D,mDAAiD,SAAW,CAAA,CAC/D,CAAC;wBACF,YAAE,EAAE,CAAC;;;;wBAGP,aAAG,CACD,iEAA0D,oBAAsB,CACjF,CAAC;wBACF,WAAC,CACC,sFAAsF,CACvF,CAAC;wBACF,WAAC,CACC,8CAA8C;4BAC5C,8FAA8F,CACjG,CAAC;;4BAGJ,qBAAM,IAAI,CAAC,eAAe,CACxB,oBAAoB,EACpB,0BAAmB,oBAAoB,YAAO,kBAAkB,OAAI;4BAClE,4CAA4C,CAC/C,EAAA;;wBAJD,SAIC,CAAC;;;;wBAGA,qBAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,CACzB,OAAK,mBAAqB,EAC1B,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,eAAe,CAAC,CAChD,EAAA;;wBAHD,SAGC,CAAC;wBACF,eAAK,CAAC,+CAA0C,CAAC,CAAC;;;;wBAElD,aAAG,CAAC,kDAA2C,mBAAqB,CAAC,CAAC;wBACtE,WAAC,CACC,2HAA2H,CAC5H,CAAC;;;wBAEJ,YAAE,EAAE,CAAC;;;;;KACN;IAEa,gCAAe,GAA7B,UACE,QAAgB,EAChB,QAAgB;;;;;;;wBAgBd,qBAAM,EAAE,CAAC,QAAQ,CAAC,UAAU,CAC1B,kBAAkB,EAClB,iBAAe,QAAQ,OAAI,CAC5B,EAAA;;wBAHD,SAGC,CAAC;wBACF,eAAK,CAAC,YAAK,QAAQ,kBAAa,kBAAoB,CAAC,CAAC;;;;wBAEtD,aAAG,CAAC,QAAQ,CAAC,CAAC;;;;;;KAEjB;IAEO,kCAAiB,GAAzB,UAA0B,eAAuB,EAAE,GAAQ;QACzD,IAAM,SAAS,GAAG,EAAE,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;QAClD,KAAuB,UAAS,EAAT,uBAAS,EAAT,uBAAS,EAAT,IAAS,EAAE;YAA7B,IAAM,QAAQ,kBAAA;YACjB,IAAI,CAAC,YAAY,CAAC,eAAe,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;SACnD;QACD,aAAG,CACD,uEAAuE;YACrE,6DAA6D,CAChE,CAAC;QACF,YAAE,EAAE,CAAC;IACP,CAAC;IAEO,6BAAY,GAApB,UACE,eAAuB,EACvB,QAAgB,EAChB,GAAW;QAEX,IAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;QAC1D,IAAM,aAAa,GAAG,uBAAuB,GAAG,QAAQ,CAAC;QACzD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;YAC5B,IAAI,CAAC,oBAAoB,CAAC,YAAY,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;SACxD;aAAM,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE;YACxC,IAAI,CAAC,oBAAoB,CAAC,YAAY,EAAE,aAAa,EAAE,GAAG,CAAC,CAAC;YAC5D,aAAG,CACD,UAAQ,QAAQ,oCAA+B,aAAa,QAAK;gBAC/D,4BAA4B,CAC/B,CAAC;YACF,YAAE,EAAE,CAAC;SACN;aAAM;YACL,aAAG,CACD,UAAQ,QAAQ,6BAAwB,aAAa,oBAAiB;gBACpE,4BAA4B,CAC/B,CAAC;YACF,YAAE,EAAE,CAAC;SACN;IACH,CAAC;IAEO,qCAAoB,GAA5B,UACE,UAAkB,EAClB,UAAkB,EAClB,GAAW;QAEX,IAAM,eAAe,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,QAAQ,EAAE,CAAC;QAC/D,IAAM,cAAc,GAAG,eAAe,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;QACjE,EAAE,CAAC,aAAa,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IAC/C,CAAC;IAEO,0BAAS,GAAjB,UAAkB,WAAmB,EAAE,UAAoB;QACzD,IAAM,UAAU,GAAG,CAAC,CAAC,GAAG,CACtB,UAAU,EACV,CAAC,cAAc,EAAE,WAAW,CAAC,EAC7B,OAAO,CACR,CAAC;QACF,IAAM,aAAa,GAAG,CAAC,CAAC,GAAG,CACzB,UAAU,EACV,CAAC,iBAAiB,EAAE,WAAW,CAAC,EAChC,OAAO,CACR,CAAC;QAEF,IACE,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,EAAE,kBAAgB,WAAa,EAAE,KAAK,CAAC;YACxD,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,EAAE,qBAAmB,WAAa,EAAE,KAAK,CAAC,EAC3D;YACA,aAAG,CAAC,YAAK,WAAW,gCAA6B,CAAC,CAAC;YACnD,aAAG,CAAC,mCAAmC,CAAC,CAAC;YACzC,OAAO,KAAK,CAAC;SACd;aAAM,IACL,CAAC,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC;YACrC,CAAC,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,EACxC;YACA,aAAG,CACD,uCAAiC,WAAW,8BAA0B,kBAAkB,aAAU,CACnG,CAAC;YACF,OAAO,KAAK,CAAC;SACd;aAAM;YACL,IAAI,UAAU,EAAE;gBACd,eAAK,CAAC,YAAK,WAAW,YAAO,kBAAkB,kBAAe,CAAC,CAAC;aACjE;iBAAM;gBACL,eAAK,CAAC,YAAK,WAAW,kBAAe,CAAC,CAAC;aACxC;YACD,OAAO,IAAI,CAAC;SACb;IACH,CAAC;IAEO,oCAAmB,GAA3B,UAA4B,OAAe;QACzC,sEAAsE;QACtE,iDAAiD;QACjD,IAAI,OAAO,KAAK,QAAQ,EAAE;YACxB,OAAO,IAAI,CAAC;SACb;QAED,IAAM,cAAc,GAAG,cAAK,CAAC,OAAO,CAAC,CAAC;QACtC,IAAI,cAAc,EAAE;YAClB,6BAA6B;YAC7B,OAAO,YAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;SAChD;QAED,IAAM,eAAe,GAAG,OAAK,kBAAoB,CAAC;QAClD,IAAM,gBAAgB,GAAG,mBAAU,CAAC,OAAO,CAAC,CAAC;QAC7C,IAAM,cAAc,GAAG,mBAAU,CAAC,gBAAgB,CAAC,CAAC;QACpD,IAAI,cAAc,IAAI,IAAI,EAAE;YAC1B,2BAA2B;YAC3B,OAAO,KAAK,CAAC;SACd;QACD,OAAO,kBAAS,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;IACpD,CAAC;IACH,aAAC;AAAD,CAAC,AAvQD,CAA4B,iCAAe,GAuQ1C;AAvQY,wBAAM","sourcesContent":["import * as fs from 'fs';\nimport { Answers, prompt } from 'inquirer';\nimport * as _ from 'lodash';\nimport * as path from 'path';\nimport { clean, gte, minVersion, satisfies, validRange } from 'semver';\n\nimport { Args } from '../../Constants';\nimport { debug, green, l, nl, red } from '../../Helper/Logging';\nimport { SentryCli, SentryCliProps } from '../../Helper/SentryCli';\nimport { BaseIntegration } from './BaseIntegration';\n\nconst MIN_NEXTJS_VERSION = '10.0.8'; // Must be a fixed version: `X.Y.Z`\nconst PROPERTIES_FILENAME = 'sentry.properties';\nconst SENTRYCLIRC_FILENAME = '.sentryclirc';\nconst GITIGNORE_FILENAME = '.gitignore';\nconst CONFIG_DIR = 'configs/';\nconst MERGEABLE_CONFIG_PREFIX = '_';\n\nlet appPackage: any = {};\n\ntry {\n  appPackage = require(path.join(process.cwd(), 'package.json'));\n} catch {\n  // We don't need to have this\n}\n\nexport class NextJs extends BaseIntegration {\n  protected _sentryCli: SentryCli;\n\n  constructor(protected _argv: Args) {\n    super(_argv);\n    this._sentryCli = new SentryCli(this._argv);\n  }\n\n  public async emit(answers: Answers): Promise<Answers> {\n    const dsn = _.get(answers, ['config', 'dsn', 'public'], null);\n    nl();\n\n    const sentryCliProps = this._sentryCli.convertAnswersToProperties(answers);\n    await this._createSentryCliConfig(sentryCliProps);\n\n    const configDirectory = path.join(\n      __dirname,\n      '..',\n      '..',\n      '..',\n      'NextJs',\n      CONFIG_DIR,\n    );\n\n    if (fs.existsSync(configDirectory)) {\n      this._createNextConfig(configDirectory, dsn);\n    } else {\n      debug(\n        `Couldn't find ${configDirectory}, probably because you run from src`,\n      );\n      nl();\n    }\n\n    l(\n      'For more information, see https://docs.sentry.io/platforms/javascript/guides/nextjs/',\n    );\n    nl();\n\n    return {};\n  }\n\n  public async shouldConfigure(_answers: Answers): Promise<Answers> {\n    if (this._shouldConfigure) {\n      return this._shouldConfigure;\n    }\n\n    nl();\n\n    let userAnswers: Answers = { continue: true };\n    if (!this._checkDep('next', true) && !this._argv.quiet) {\n      userAnswers = await prompt({\n        message:\n          'There were errors during your project checkup, do you still want to continue?',\n        name: 'continue',\n        default: false,\n        type: 'confirm',\n      });\n    }\n\n    nl();\n\n    if (!userAnswers['continue']) {\n      throw new Error('Please install the required dependencies to continue.');\n    }\n\n    this._shouldConfigure = Promise.resolve({ nextjs: true });\n    // eslint-disable-next-line @typescript-eslint/unbound-method\n    return this.shouldConfigure;\n  }\n\n  private async _createSentryCliConfig(\n    cliProps: SentryCliProps,\n  ): Promise<void> {\n    const { 'auth/token': authToken, ...cliPropsToWrite } = cliProps;\n\n    /**\n     * To not commit the auth token to the VCS, instead of adding it to the\n     * properties file (like the rest of props), it's added to the Sentry CLI\n     * config, which is added to the gitignore. This way makes the properties\n     * file safe to commit without exposing any auth tokens.\n     */\n    if (authToken) {\n      try {\n        await fs.promises.appendFile(\n          SENTRYCLIRC_FILENAME,\n          this._sentryCli.dumpProperties({ 'auth/token': authToken }),\n        );\n        green(`✓ Successfully added the auth token to ${SENTRYCLIRC_FILENAME}`);\n      } catch {\n        red(\n          `⚠ Could not add the auth token to ${SENTRYCLIRC_FILENAME}, ` +\n            `please add it to identify your user account:\\n${authToken}`,\n        );\n        nl();\n      }\n    } else {\n      red(\n        `⚠ Did not find an auth token, please add your token to ${SENTRYCLIRC_FILENAME}`,\n      );\n      l(\n        'To generate an auth token, visit https://sentry.io/settings/account/api/auth-tokens/',\n      );\n      l(\n        'To learn how to configure Sentry CLI, visit ' +\n          'https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/#configure-sentry-cli',\n      );\n    }\n\n    await this._addToGitignore(\n      SENTRYCLIRC_FILENAME,\n      `⚠ Could not add ${SENTRYCLIRC_FILENAME} to ${GITIGNORE_FILENAME}, ` +\n        'please add it to not commit your auth key.',\n    );\n\n    try {\n      await fs.promises.writeFile(\n        `./${PROPERTIES_FILENAME}`,\n        this._sentryCli.dumpProperties(cliPropsToWrite),\n      );\n      green(`✓ Successfully created sentry.properties`);\n    } catch {\n      red(`⚠ Could not add org and project data to ${PROPERTIES_FILENAME}`);\n      l(\n        'See docs for a manual setup: https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/#configure-sentry-cli',\n      );\n    }\n    nl();\n  }\n\n  private async _addToGitignore(\n    filepath: string,\n    errorMsg: string,\n  ): Promise<void> {\n    /**\n     * Don't check whether the given file is ignored because:\n     * 1. It's tricky to check it without git.\n     * 2. Git might not be installed or accessible.\n     * 3. It's convenient to use a module to interact with git, but it would\n     *    increase the size x2 approximately. Docs say to run the Wizard without\n     *    installing it, and duplicating the size would slow the set-up down.\n     * 4. The Wizard is meant to be run once.\n     * 5. A message is logged informing users it's been added to the gitignore.\n     * 6. It will be added to the gitignore as many times as it runs - not a big\n     *    deal.\n     * 7. It's straightforward to remove it from the gitignore.\n     */\n    try {\n      await fs.promises.appendFile(\n        GITIGNORE_FILENAME,\n        `\\n# Sentry\\n${filepath}\\n`,\n      );\n      green(`✓ ${filepath} added to ${GITIGNORE_FILENAME}`);\n    } catch {\n      red(errorMsg);\n    }\n  }\n\n  private _createNextConfig(configDirectory: string, dsn: any): void {\n    const templates = fs.readdirSync(configDirectory);\n    for (const template of templates) {\n      this._setTemplate(configDirectory, template, dsn);\n    }\n    red(\n      '⚠ Performance monitoring is enabled capturing 100% of transactions.\\n' +\n        '  Learn more in https://docs.sentry.io/product/performance/',\n    );\n    nl();\n  }\n\n  private _setTemplate(\n    configDirectory: string,\n    template: string,\n    dsn: string,\n  ): void {\n    const templatePath = path.join(configDirectory, template);\n    const mergeableFile = MERGEABLE_CONFIG_PREFIX + template;\n    if (!fs.existsSync(template)) {\n      this._fillAndCopyTemplate(templatePath, template, dsn);\n    } else if (!fs.existsSync(mergeableFile)) {\n      this._fillAndCopyTemplate(templatePath, mergeableFile, dsn);\n      red(\n        `File ${template} already exists, so created ${mergeableFile}.\\n` +\n          `Please, merge those files.`,\n      );\n      nl();\n    } else {\n      red(\n        `File ${template} already exists, and ${mergeableFile} also exists.\\n` +\n          'Please, merge those files.',\n      );\n      nl();\n    }\n  }\n\n  private _fillAndCopyTemplate(\n    sourcePath: string,\n    targetPath: string,\n    dsn: string,\n  ): void {\n    const templateContent = fs.readFileSync(sourcePath).toString();\n    const filledTemplate = templateContent.replace('___DSN___', dsn);\n    fs.writeFileSync(targetPath, filledTemplate);\n  }\n\n  private _checkDep(packageName: string, minVersion?: boolean): boolean {\n    const depVersion = _.get(\n      appPackage,\n      ['dependencies', packageName],\n      '0.0.0',\n    );\n    const devDepVersion = _.get(\n      appPackage,\n      ['devDependencies', packageName],\n      '0.0.0',\n    );\n\n    if (\n      !_.get(appPackage, `dependencies.${packageName}`, false) &&\n      !_.get(appPackage, `devDependencies.${packageName}`, false)\n    ) {\n      red(`✗ ${packageName} isn't in your dependencies`);\n      red(`  please install it with yarn/npm`);\n      return false;\n    } else if (\n      !this._fulfillsMinVersion(depVersion) &&\n      !this._fulfillsMinVersion(devDepVersion)\n    ) {\n      red(\n        `✗ Your installed version of \\`${packageName}\\` is not supported, >=${MIN_NEXTJS_VERSION} needed.`,\n      );\n      return false;\n    } else {\n      if (minVersion) {\n        green(`✓ ${packageName} >= ${MIN_NEXTJS_VERSION} is installed`);\n      } else {\n        green(`✓ ${packageName} is installed`);\n      }\n      return true;\n    }\n  }\n\n  private _fulfillsMinVersion(version: string): boolean {\n    // The latest version, which at the moment is greater than the minimum\n    // version, shouldn't be a blocker in the wizard.\n    if (version === 'latest') {\n      return true;\n    }\n\n    const cleanedVersion = clean(version);\n    if (cleanedVersion) {\n      // gte(x, y) : true if x >= y\n      return gte(cleanedVersion, MIN_NEXTJS_VERSION);\n    }\n\n    const minVersionRange = `>=${MIN_NEXTJS_VERSION}`;\n    const userVersionRange = validRange(version);\n    const minUserVersion = minVersion(userVersionRange);\n    if (minUserVersion == null) {\n      // This should never happen\n      return false;\n    }\n    return satisfies(minUserVersion, minVersionRange);\n  }\n}\n"]}
+{"version":3,"file":"NextJs.js","sourceRoot":"","sources":["../../../../lib/Steps/Integrations/NextJs.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,8BAA8B;AAC9B,uBAAyB;AACzB,qCAA2C;AAC3C,0BAA4B;AAC5B,2BAA6B;AAC7B,iCAA8D;AAG9D,gDAAgE;AAChE,oDAAmE;AACnE,qDAAoD;AAEpD,IAAM,0BAA0B,GAAG,kBAAkB,CAAC;AACtD,IAAM,mBAAmB,GAAG,mBAAmB,CAAC;AAChD,IAAM,oBAAoB,GAAG,cAAc,CAAC;AAC5C,IAAM,kBAAkB,GAAG,YAAY,CAAC;AACxC,IAAM,UAAU,GAAG,UAAU,CAAC;AAC9B,IAAM,sBAAsB,GAAG,YAAY,CAAC;AAE5C,+EAA+E;AAC/E,oDAAoD;AACpD,IAAM,qBAAqB,GAAgC;IACzD,WAAW,EAAE,CAAC,OAAO,EAAE,WAAW,CAAC;IACnC,gBAAgB,EAAE,CAAC,GAAG,CAAC;IACvB,yBAAyB,EAAE,CAAC,GAAG,CAAC;IAChC,yBAAyB,EAAE,CAAC,GAAG,CAAC;CACjC,CAAC;AAEF,IAAI,UAAU,GAAQ,EAAE,CAAC;AAEzB,IAAI;IACF,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC,CAAC;CAChE;AAAC,WAAM;IACN,6BAA6B;CAC9B;AAED;IAA4B,0BAAe;IAGzC,gBAAsB,KAAW;QAAjC,YACE,kBAAM,KAAK,CAAC,SAEb;QAHqB,WAAK,GAAL,KAAK,CAAM;QAE/B,KAAI,CAAC,UAAU,GAAG,IAAI,qBAAS,CAAC,KAAI,CAAC,KAAK,CAAC,CAAC;;IAC9C,CAAC;IAEY,qBAAI,GAAjB,UAAkB,OAAgB;;;;;;wBAC1B,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAC;wBAC9D,YAAE,EAAE,CAAC;wBAEC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC;wBAC3E,qBAAM,IAAI,CAAC,sBAAsB,CAAC,cAAc,CAAC,EAAA;;wBAAjD,SAAiD,CAAC;wBAE5C,eAAe,GAAG,IAAI,CAAC,IAAI,CAC/B,SAAS,EACT,IAAI,EACJ,IAAI,EACJ,IAAI,EACJ,QAAQ,EACR,UAAU,CACX,CAAC;wBAEF,IAAI,EAAE,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE;4BAClC,IAAI,CAAC,iBAAiB,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;yBAC9C;6BAAM;4BACL,eAAK,CACH,mBAAiB,eAAe,8EAA+E,CAChH,CAAC;4BACF,YAAE,EAAE,CAAC;yBACN;wBAED,WAAC,CACC,sFAAsF,CACvF,CAAC;wBACF,YAAE,EAAE,CAAC;wBAEL,sBAAO,EAAE,EAAC;;;;KACX;IAEY,gCAAe,GAA5B,UAA6B,QAAiB;;;;;;wBAC5C,IAAI,IAAI,CAAC,gBAAgB,EAAE;4BACzB,sBAAO,IAAI,CAAC,gBAAgB,EAAC;yBAC9B;wBAED,YAAE,EAAE,CAAC;wBAED,WAAW,GAAY,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;6BAC1C,CAAA,CAAC,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAA,EAAxD,wBAAwD;wBAC5C,qBAAM,iBAAM,CAAC;gCACzB,OAAO,EACL,+EAA+E;gCACjF,IAAI,EAAE,UAAU;gCAChB,OAAO,EAAE,KAAK;gCACd,IAAI,EAAE,SAAS;6BAChB,CAAC,EAAA;;wBANF,WAAW,GAAG,SAMZ,CAAC;;;wBAGL,YAAE,EAAE,CAAC;wBAEL,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE;4BAC5B,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;yBAC1E;wBAED,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;wBAC1D,6DAA6D;wBAC7D,sBAAO,IAAI,CAAC,eAAe,EAAC;;;;KAC7B;IAEa,uCAAsB,GAApC,UACE,QAAwB;;;;;;wBAEF,SAAS,GAAyB,QAAQ,cAAjC,EAAK,eAAe,UAAK,QAAQ,EAA1D,cAA+C,CAAF,CAAc;6BAQ7D,SAAS,EAAT,wBAAS;;;;wBAET,qBAAM,EAAE,CAAC,QAAQ,CAAC,UAAU,CAC1B,oBAAoB,EACpB,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,CAAC,CAC3D,EAAA;;wBAHD,SAGC,CAAC;wBACF,eAAK,CAAC,iDAA0C,oBAAsB,CAAC,CAAC;;;;wBAExE,aAAG,CACD,4CAAqC,oBAAoB,OAAI;6BAC3D,mDAAiD,SAAW,CAAA,CAC/D,CAAC;wBACF,YAAE,EAAE,CAAC;;;;wBAGP,aAAG,CACD,iEAA0D,oBAAsB,CACjF,CAAC;wBACF,WAAC,CACC,sFAAsF,CACvF,CAAC;wBACF,WAAC,CACC,8CAA8C;4BAC5C,8FAA8F,CACjG,CAAC;;4BAGJ,qBAAM,IAAI,CAAC,eAAe,CACxB,oBAAoB,EACpB,0BAAmB,oBAAoB,YAAO,kBAAkB,OAAI;4BAClE,4CAA4C,CAC/C,EAAA;;wBAJD,SAIC,CAAC;;;;wBAGA,qBAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,CACzB,OAAK,mBAAqB,EAC1B,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,eAAe,CAAC,CAChD,EAAA;;wBAHD,SAGC,CAAC;wBACF,eAAK,CAAC,+CAA0C,CAAC,CAAC;;;;wBAElD,aAAG,CAAC,kDAA2C,mBAAqB,CAAC,CAAC;wBACtE,WAAC,CACC,2HAA2H,CAC5H,CAAC;;;wBAEJ,YAAE,EAAE,CAAC;;;;;KACN;IAEa,gCAAe,GAA7B,UACE,QAAgB,EAChB,QAAgB;;;;;;;wBAgBd,qBAAM,EAAE,CAAC,QAAQ,CAAC,UAAU,CAC1B,kBAAkB,EAClB,iBAAe,QAAQ,OAAI,CAC5B,EAAA;;wBAHD,SAGC,CAAC;wBACF,eAAK,CAAC,YAAK,QAAQ,kBAAa,kBAAoB,CAAC,CAAC;;;;wBAEtD,aAAG,CAAC,QAAQ,CAAC,CAAC;;;;;;KAEjB;IAEO,kCAAiB,GAAzB,UAA0B,eAAuB,EAAE,GAAQ;QACzD,IAAM,SAAS,GAAG,EAAE,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;QAClD,KAAuB,UAAS,EAAT,uBAAS,EAAT,uBAAS,EAAT,IAAS,EAAE;YAA7B,IAAM,QAAQ,kBAAA;YACjB,IAAI,CAAC,YAAY,CACf,eAAe,EACf,QAAQ,EACR,qBAAqB,CAAC,QAAQ,CAAC,EAC/B,GAAG,CACJ,CAAC;SACH;QACD,aAAG,CACD,uEAAuE;YACrE,6DAA6D,CAChE,CAAC;QACF,YAAE,EAAE,CAAC;IACP,CAAC;IAEO,6BAAY,GAApB,UACE,eAAuB,EACvB,YAAoB,EACpB,kBAA4B,EAC5B,GAAW;QAEX,IAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC;QAE9D,KAA6B,UAAkB,EAAlB,yCAAkB,EAAlB,gCAAkB,EAAlB,IAAkB,EAAE;YAA5C,IAAM,cAAc,2BAAA;YACvB,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE;gBAClC,SAAS;aACV;YAED,IAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;YAChE,sEAAsE;YACtE,yEAAyE;YACzE,iCAAiC;YACjC,IAAM,iBAAiB,GAAG,IAAI,CAAC,IAAI,CACjC,cAAc,EACd,IAAI,CAAC,cAAc,CACjB,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,EACvB,CAAC,CAAC,EACF,CAAC,EACD,sBAAsB,CACvB,CAAC,IAAI,CAAC,GAAG,CAAC,CACZ,CAAC;YAEF,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE;gBACnC,IAAI,CAAC,oBAAoB,CAAC,YAAY,EAAE,eAAe,EAAE,GAAG,CAAC,CAAC;aAC/D;iBAAM,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,iBAAiB,CAAC,EAAE;gBAC5C,IAAI,CAAC,oBAAoB,CAAC,YAAY,EAAE,iBAAiB,EAAE,GAAG,CAAC,CAAC;gBAChE,aAAG,CACD,WAAU,YAAY,sCAAmC,iBAAiB,SAAO;oBAC/E,2BAA2B,CAC9B,CAAC;gBACF,YAAE,EAAE,CAAC;aACN;iBAAM;gBACL,aAAG,CACD,WAAU,YAAY,eAAY,iBAAiB,uBAAqB;oBACtE,2BAA2B,CAC9B,CAAC;gBACF,YAAE,EAAE,CAAC;aACN;YACD,OAAO;SACR;QAED,aAAG,CACD,iDAAgD,YAAY,kBAAc,kBAAkB,MAAG,CAChG,CAAC;QACF,YAAE,EAAE,CAAC;IACP,CAAC;IAEO,qCAAoB,GAA5B,UACE,UAAkB,EAClB,UAAkB,EAClB,GAAW;QAEX,IAAM,eAAe,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,QAAQ,EAAE,CAAC;QAC/D,IAAM,cAAc,GAAG,eAAe,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;QACjE,EAAE,CAAC,aAAa,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IAC/C,CAAC;IAEO,sCAAqB,GAA7B,UAA8B,WAAmB;QAC/C,IAAM,WAAW,GAAG,CAAC,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC,CAAC;QACrE,IAAM,cAAc,GAAG,CAAC,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC,CAAC;QAE3E,IAAI,CAAC,WAAW,IAAI,CAAC,cAAc,EAAE;YACnC,aAAG,CAAC,YAAK,WAAW,iCAA8B,CAAC,CAAC;YACpD,aAAG,CAAC,oCAAoC,CAAC,CAAC;YAC1C,OAAO,KAAK,CAAC;SACd;aAAM,IACL,CAAC,IAAI,CAAC,qBAAqB,CAAC,WAAW,CAAC;YACxC,CAAC,IAAI,CAAC,qBAAqB,CAAC,cAAc,CAAC,EAC3C;YACA,aAAG,CACD,wDAAoD,WAAW,kDAA8C,0BAA0B,QAAK,CAC7I,CAAC;YACF,OAAO,KAAK,CAAC;SACd;aAAM;YACL,eAAK,CACH,qCAA+B,WAAW,sCAAsC,CACjF,CAAC;YACF,OAAO,IAAI,CAAC;SACb;IACH,CAAC;IAEO,sCAAqB,GAA7B,UAA8B,OAAe;QAC3C,oEAAoE;QACpE,IAAI,OAAO,KAAK,QAAQ,EAAE;YACxB,OAAO,KAAK,CAAC;SACd;QAED,IAAI,kBAAkB,EAAE,OAAO,CAAC;QAEhC,IAAI,cAAK,CAAC,OAAO,CAAC,EAAE;YAClB,kBAAkB,GAAG,cAAK,CAAC,OAAO,CAAC,CAAC;YACpC,OAAO,GAAG,KAAK,CAAC;SACjB;aAAM,IAAI,mBAAU,CAAC,OAAO,CAAC,EAAE;YAC9B,kBAAkB,GAAG,mBAAU,CAAC,OAAO,CAAC,CAAC;YACzC,OAAO,GAAG,IAAI,CAAC;SAChB;QAED,OAAO,CACL,CAAC,CAAC,kBAAkB;YACpB,CAAC,OAAO;gBACN,CAAC,CAAC,eAAM,CAAC,kBAAkB,EAAE,0BAA0B,CAAC;gBACxD,CAAC,CAAC,kBAAS,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,CAAC,CAC/D,CAAC;IACJ,CAAC;IAEO,+BAAc,GAAtB,UACE,GAAe,EACf,KAAa,EACb,WAAmB;QACnB,iBAAiB;aAAjB,UAAiB,EAAjB,qBAAiB,EAAjB,IAAiB;YAAjB,gCAAiB;;QAEjB,GAAG,CAAC,MAAM,OAAV,GAAG,kBAAQ,KAAK,EAAE,WAAW,GAAK,OAAO,GAAE;QAC3C,OAAO,GAAG,CAAC;IACb,CAAC;IACH,aAAC;AAAD,CAAC,AArSD,CAA4B,iCAAe,GAqS1C;AArSY,wBAAM","sourcesContent":["/* eslint-disable max-lines */\nimport * as fs from 'fs';\nimport { Answers, prompt } from 'inquirer';\nimport * as _ from 'lodash';\nimport * as path from 'path';\nimport { satisfies, subset, valid, validRange } from 'semver';\n\nimport { Args } from '../../Constants';\nimport { debug, green, l, nl, red } from '../../Helper/Logging';\nimport { SentryCli, SentryCliProps } from '../../Helper/SentryCli';\nimport { BaseIntegration } from './BaseIntegration';\n\nconst COMPATIBLE_NEXTJS_VERSIONS = '>=10.0.8 <12.0.0';\nconst PROPERTIES_FILENAME = 'sentry.properties';\nconst SENTRYCLIRC_FILENAME = '.sentryclirc';\nconst GITIGNORE_FILENAME = '.gitignore';\nconst CONFIG_DIR = 'configs/';\nconst MERGEABLE_CONFIG_INFIX = 'wizardcopy';\n\n// for those files which can go in more than one place, the list of places they\n// could go (the first one which works will be used)\nconst TEMPLATE_DESTINATIONS: { [key: string]: string[] } = {\n  '_error.js': ['pages', 'src/pages'],\n  'next.config.js': ['.'],\n  'sentry.server.config.js': ['.'],\n  'sentry.client.config.js': ['.'],\n};\n\nlet appPackage: any = {};\n\ntry {\n  appPackage = require(path.join(process.cwd(), 'package.json'));\n} catch {\n  // We don't need to have this\n}\n\nexport class NextJs extends BaseIntegration {\n  protected _sentryCli: SentryCli;\n\n  constructor(protected _argv: Args) {\n    super(_argv);\n    this._sentryCli = new SentryCli(this._argv);\n  }\n\n  public async emit(answers: Answers): Promise<Answers> {\n    const dsn = _.get(answers, ['config', 'dsn', 'public'], null);\n    nl();\n\n    const sentryCliProps = this._sentryCli.convertAnswersToProperties(answers);\n    await this._createSentryCliConfig(sentryCliProps);\n\n    const configDirectory = path.join(\n      __dirname,\n      '..',\n      '..',\n      '..',\n      'NextJs',\n      CONFIG_DIR,\n    );\n\n    if (fs.existsSync(configDirectory)) {\n      this._createNextConfig(configDirectory, dsn);\n    } else {\n      debug(\n        `Couldn't find ${configDirectory}, probably because you ran this from inside of \\`/lib\\` rather than \\`/dist\\``,\n      );\n      nl();\n    }\n\n    l(\n      'For more information, see https://docs.sentry.io/platforms/javascript/guides/nextjs/',\n    );\n    nl();\n\n    return {};\n  }\n\n  public async shouldConfigure(_answers: Answers): Promise<Answers> {\n    if (this._shouldConfigure) {\n      return this._shouldConfigure;\n    }\n\n    nl();\n\n    let userAnswers: Answers = { continue: true };\n    if (!this._checkUserNextVersion('next') && !this._argv.quiet) {\n      userAnswers = await prompt({\n        message:\n          'There were errors during your project checkup, do you still want to continue?',\n        name: 'continue',\n        default: false,\n        type: 'confirm',\n      });\n    }\n\n    nl();\n\n    if (!userAnswers['continue']) {\n      throw new Error('Please install the required dependencies to continue.');\n    }\n\n    this._shouldConfigure = Promise.resolve({ nextjs: true });\n    // eslint-disable-next-line @typescript-eslint/unbound-method\n    return this.shouldConfigure;\n  }\n\n  private async _createSentryCliConfig(\n    cliProps: SentryCliProps,\n  ): Promise<void> {\n    const { 'auth/token': authToken, ...cliPropsToWrite } = cliProps;\n\n    /**\n     * To not commit the auth token to the VCS, instead of adding it to the\n     * properties file (like the rest of props), it's added to the Sentry CLI\n     * config, which is added to the gitignore. This way makes the properties\n     * file safe to commit without exposing any auth tokens.\n     */\n    if (authToken) {\n      try {\n        await fs.promises.appendFile(\n          SENTRYCLIRC_FILENAME,\n          this._sentryCli.dumpConfig({ auth: { token: authToken } }),\n        );\n        green(`✓ Successfully added the auth token to ${SENTRYCLIRC_FILENAME}`);\n      } catch {\n        red(\n          `⚠ Could not add the auth token to ${SENTRYCLIRC_FILENAME}, ` +\n            `please add it to identify your user account:\\n${authToken}`,\n        );\n        nl();\n      }\n    } else {\n      red(\n        `⚠ Did not find an auth token, please add your token to ${SENTRYCLIRC_FILENAME}`,\n      );\n      l(\n        'To generate an auth token, visit https://sentry.io/settings/account/api/auth-tokens/',\n      );\n      l(\n        'To learn how to configure Sentry CLI, visit ' +\n          'https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/#configure-sentry-cli',\n      );\n    }\n\n    await this._addToGitignore(\n      SENTRYCLIRC_FILENAME,\n      `⚠ Could not add ${SENTRYCLIRC_FILENAME} to ${GITIGNORE_FILENAME}, ` +\n        'please add it to not commit your auth key.',\n    );\n\n    try {\n      await fs.promises.writeFile(\n        `./${PROPERTIES_FILENAME}`,\n        this._sentryCli.dumpProperties(cliPropsToWrite),\n      );\n      green(`✓ Successfully created sentry.properties`);\n    } catch {\n      red(`⚠ Could not add org and project data to ${PROPERTIES_FILENAME}`);\n      l(\n        'See docs for a manual setup: https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/#configure-sentry-cli',\n      );\n    }\n    nl();\n  }\n\n  private async _addToGitignore(\n    filepath: string,\n    errorMsg: string,\n  ): Promise<void> {\n    /**\n     * Don't check whether the given file is ignored because:\n     * 1. It's tricky to check it without git.\n     * 2. Git might not be installed or accessible.\n     * 3. It's convenient to use a module to interact with git, but it would\n     *    increase the size x2 approximately. Docs say to run the Wizard without\n     *    installing it, and duplicating the size would slow the set-up down.\n     * 4. The Wizard is meant to be run once.\n     * 5. A message is logged informing users it's been added to the gitignore.\n     * 6. It will be added to the gitignore as many times as it runs - not a big\n     *    deal.\n     * 7. It's straightforward to remove it from the gitignore.\n     */\n    try {\n      await fs.promises.appendFile(\n        GITIGNORE_FILENAME,\n        `\\n# Sentry\\n${filepath}\\n`,\n      );\n      green(`✓ ${filepath} added to ${GITIGNORE_FILENAME}`);\n    } catch {\n      red(errorMsg);\n    }\n  }\n\n  private _createNextConfig(configDirectory: string, dsn: any): void {\n    const templates = fs.readdirSync(configDirectory);\n    for (const template of templates) {\n      this._setTemplate(\n        configDirectory,\n        template,\n        TEMPLATE_DESTINATIONS[template],\n        dsn,\n      );\n    }\n    red(\n      '⚠ Performance monitoring is enabled capturing 100% of transactions.\\n' +\n        '  Learn more in https://docs.sentry.io/product/performance/',\n    );\n    nl();\n  }\n\n  private _setTemplate(\n    configDirectory: string,\n    templateFile: string,\n    destinationOptions: string[],\n    dsn: string,\n  ): void {\n    const templatePath = path.join(configDirectory, templateFile);\n\n    for (const destinationDir of destinationOptions) {\n      if (!fs.existsSync(destinationDir)) {\n        continue;\n      }\n\n      const destinationPath = path.join(destinationDir, templateFile);\n      // in case the file in question already exists, we'll make a copy with\n      // `MERGEABLE_CONFIG_INFIX` inserted just before the extension, so as not\n      // to overwrite the existing file\n      const mergeableFilePath = path.join(\n        destinationDir,\n        this._spliceInPlace(\n          templateFile.split('.'),\n          -1,\n          0,\n          MERGEABLE_CONFIG_INFIX,\n        ).join('.'),\n      );\n\n      if (!fs.existsSync(destinationPath)) {\n        this._fillAndCopyTemplate(templatePath, destinationPath, dsn);\n      } else if (!fs.existsSync(mergeableFilePath)) {\n        this._fillAndCopyTemplate(templatePath, mergeableFilePath, dsn);\n        red(\n          `File \\`${templateFile}\\` already exists, so created \\`${mergeableFilePath}\\`.\\n` +\n            'Please merge those files.',\n        );\n        nl();\n      } else {\n        red(\n          `Both \\`${templateFile}\\` and \\`${mergeableFilePath}\\` already exist.\\n` +\n            'Please merge those files.',\n        );\n        nl();\n      }\n      return;\n    }\n\n    red(\n      `Could not find appropriate destination for \\`${templateFile}\\`. Tried: ${destinationOptions}.`,\n    );\n    nl();\n  }\n\n  private _fillAndCopyTemplate(\n    sourcePath: string,\n    targetPath: string,\n    dsn: string,\n  ): void {\n    const templateContent = fs.readFileSync(sourcePath).toString();\n    const filledTemplate = templateContent.replace('___DSN___', dsn);\n    fs.writeFileSync(targetPath, filledTemplate);\n  }\n\n  private _checkUserNextVersion(packageName: string): boolean {\n    const depsVersion = _.get(appPackage, ['dependencies', packageName]);\n    const devDepsVersion = _.get(appPackage, ['devDependencies', packageName]);\n\n    if (!depsVersion && !devDepsVersion) {\n      red(`✗ ${packageName} isn't in your dependencies.`);\n      red('  Please install it with yarn/npm.');\n      return false;\n    } else if (\n      !this._fulfillsVersionRange(depsVersion) &&\n      !this._fulfillsVersionRange(devDepsVersion)\n    ) {\n      red(\n        `✗ Your \\`package.json\\` specifies a version of \\`${packageName}\\` outside of the compatible version range ${COMPATIBLE_NEXTJS_VERSIONS}.\\n`,\n      );\n      return false;\n    } else {\n      green(\n        `✓ A compatible version of \\`${packageName}\\` is specified in \\`package.json\\`.`,\n      );\n      return true;\n    }\n  }\n\n  private _fulfillsVersionRange(version: string): boolean {\n    // The latest version is currently 12.x, which is not yet supported.\n    if (version === 'latest') {\n      return false;\n    }\n\n    let cleanedUserVersion, isRange;\n\n    if (valid(version)) {\n      cleanedUserVersion = valid(version);\n      isRange = false;\n    } else if (validRange(version)) {\n      cleanedUserVersion = validRange(version);\n      isRange = true;\n    }\n\n    return (\n      !!cleanedUserVersion &&\n      (isRange\n        ? subset(cleanedUserVersion, COMPATIBLE_NEXTJS_VERSIONS)\n        : satisfies(cleanedUserVersion, COMPATIBLE_NEXTJS_VERSIONS))\n    );\n  }\n\n  private _spliceInPlace(\n    arr: Array<any>,\n    start: number,\n    deleteCount: number,\n    ...inserts: any[]\n  ): Array<any> {\n    arr.splice(start, deleteCount, ...inserts);\n    return arr;\n  }\n}\n"]}

package/lib/Helper/SentryCli.ts

@@ -8,6 +8,8 @@ export interface SentryCliProps {
   [s: string]: string;
 }
 
+type SentryCliConfig = Record<string, SentryCliProps>;
+
 export class SentryCli {
   // eslint-disable-next-line @typescript-eslint/typedef
   private _resolve = require.resolve;
@@ -35,6 +37,7 @@ export class SentryCli {
     return props;
   }
 
+  /** Create the contents of a `sentry.properties` file */
   public dumpProperties(props: SentryCliProps): string {
     const rv = [];
     for (let key in props) {
@@ -43,6 +46,7 @@ export class SentryCli {
         const value = props[key];
         key = key.replace(/\//g, '.');
         if (value === undefined || value === null) {
+          // comment that property out since it has no value
           rv.push(`#${key}=`);
         } else {
           rv.push(`${key}=${value}`);
@@ -52,4 +56,17 @@ export class SentryCli {
     // eslint-disable-next-line prefer-template
     return rv.join('\n') + '\n';
   }
+
+  public dumpConfig(config: SentryCliConfig): string {
+    const dumpedSections: string[] = [];
+    for (const sectionName in config) {
+      // eslint-disable-next-line no-prototype-builtins
+      if (config.hasOwnProperty(sectionName)) {
+        const props = this.dumpProperties(config[sectionName]);
+        const section = `[${sectionName}]\n${props}`;
+        dumpedSections.push(section);
+      }
+    }
+    return dumpedSections.join('\n');
+  }
 }

package/lib/Steps/Integrations/BaseIntegration.ts

@@ -21,7 +21,7 @@ export abstract class BaseIntegration extends BaseStep {
   /**
    * This can be used for example for platform:boolean to determine
    * if we should configure iOS/Android.
-   * Basically this will be merged into answers so it can be check by a later step.
+   * Basically this will be merged into answers so it can be checked by a later step.
    */
   public async shouldConfigure(_answers: Answers): Promise<Answers> {
     if (this._shouldConfigure) {
@@ -34,7 +34,10 @@ export abstract class BaseIntegration extends BaseStep {
   public async shouldEmit(_answers: Answers): Promise<boolean> {
     return (
       _.keys(
-        _.pickBy(await this.shouldConfigure(_answers), (active: boolean) => active),
+        _.pickBy(
+          await this.shouldConfigure(_answers),
+          (active: boolean) => active,
+        ),
       ).length > 0
     );
   }

package/lib/Steps/Integrations/NextJs.ts

@@ -1,20 +1,30 @@
+/* eslint-disable max-lines */
 import * as fs from 'fs';
 import { Answers, prompt } from 'inquirer';
 import * as _ from 'lodash';
 import * as path from 'path';
-import { clean, gte, minVersion, satisfies, validRange } from 'semver';
+import { satisfies, subset, valid, validRange } from 'semver';
 
 import { Args } from '../../Constants';
 import { debug, green, l, nl, red } from '../../Helper/Logging';
 import { SentryCli, SentryCliProps } from '../../Helper/SentryCli';
 import { BaseIntegration } from './BaseIntegration';
 
-const MIN_NEXTJS_VERSION = '10.0.8'; // Must be a fixed version: `X.Y.Z`
+const COMPATIBLE_NEXTJS_VERSIONS = '>=10.0.8 <12.0.0';
 const PROPERTIES_FILENAME = 'sentry.properties';
 const SENTRYCLIRC_FILENAME = '.sentryclirc';
 const GITIGNORE_FILENAME = '.gitignore';
 const CONFIG_DIR = 'configs/';
-const MERGEABLE_CONFIG_PREFIX = '_';
+const MERGEABLE_CONFIG_INFIX = 'wizardcopy';
+
+// for those files which can go in more than one place, the list of places they
+// could go (the first one which works will be used)
+const TEMPLATE_DESTINATIONS: { [key: string]: string[] } = {
+  '_error.js': ['pages', 'src/pages'],
+  'next.config.js': ['.'],
+  'sentry.server.config.js': ['.'],
+  'sentry.client.config.js': ['.'],
+};
 
 let appPackage: any = {};
 
@@ -52,7 +62,7 @@ export class NextJs extends BaseIntegration {
       this._createNextConfig(configDirectory, dsn);
     } else {
       debug(
-        `Couldn't find ${configDirectory}, probably because you run from src`,
+        `Couldn't find ${configDirectory}, probably because you ran this from inside of \`/lib\` rather than \`/dist\``,
       );
       nl();
     }
@@ -73,7 +83,7 @@ export class NextJs extends BaseIntegration {
     nl();
 
     let userAnswers: Answers = { continue: true };
-    if (!this._checkDep('next', true) && !this._argv.quiet) {
+    if (!this._checkUserNextVersion('next') && !this._argv.quiet) {
       userAnswers = await prompt({
         message:
           'There were errors during your project checkup, do you still want to continue?',
@@ -109,7 +119,7 @@ export class NextJs extends BaseIntegration {
       try {
         await fs.promises.appendFile(
           SENTRYCLIRC_FILENAME,
-          this._sentryCli.dumpProperties({ 'auth/token': authToken }),
+          this._sentryCli.dumpConfig({ auth: { token: authToken } }),
         );
         green(`✓ Successfully added the auth token to ${SENTRYCLIRC_FILENAME}`);
       } catch {
@@ -184,7 +194,12 @@ export class NextJs extends BaseIntegration {
   private _createNextConfig(configDirectory: string, dsn: any): void {
     const templates = fs.readdirSync(configDirectory);
     for (const template of templates) {
-      this._setTemplate(configDirectory, template, dsn);
+      this._setTemplate(
+        configDirectory,
+        template,
+        TEMPLATE_DESTINATIONS[template],
+        dsn,
+      );
     }
     red(
       '⚠ Performance monitoring is enabled capturing 100% of transactions.\n' +
@@ -195,27 +210,54 @@ export class NextJs extends BaseIntegration {
 
   private _setTemplate(
     configDirectory: string,
-    template: string,
+    templateFile: string,
+    destinationOptions: string[],
     dsn: string,
   ): void {
-    const templatePath = path.join(configDirectory, template);
-    const mergeableFile = MERGEABLE_CONFIG_PREFIX + template;
-    if (!fs.existsSync(template)) {
-      this._fillAndCopyTemplate(templatePath, template, dsn);
-    } else if (!fs.existsSync(mergeableFile)) {
-      this._fillAndCopyTemplate(templatePath, mergeableFile, dsn);
-      red(
-        `File ${template} already exists, so created ${mergeableFile}.\n` +
-          `Please, merge those files.`,
-      );
-      nl();
-    } else {
-      red(
-        `File ${template} already exists, and ${mergeableFile} also exists.\n` +
-          'Please, merge those files.',
+    const templatePath = path.join(configDirectory, templateFile);
+
+    for (const destinationDir of destinationOptions) {
+      if (!fs.existsSync(destinationDir)) {
+        continue;
+      }
+
+      const destinationPath = path.join(destinationDir, templateFile);
+      // in case the file in question already exists, we'll make a copy with
+      // `MERGEABLE_CONFIG_INFIX` inserted just before the extension, so as not
+      // to overwrite the existing file
+      const mergeableFilePath = path.join(
+        destinationDir,
+        this._spliceInPlace(
+          templateFile.split('.'),
+          -1,
+          0,
+          MERGEABLE_CONFIG_INFIX,
+        ).join('.'),
       );
-      nl();
+
+      if (!fs.existsSync(destinationPath)) {
+        this._fillAndCopyTemplate(templatePath, destinationPath, dsn);
+      } else if (!fs.existsSync(mergeableFilePath)) {
+        this._fillAndCopyTemplate(templatePath, mergeableFilePath, dsn);
+        red(
+          `File \`${templateFile}\` already exists, so created \`${mergeableFilePath}\`.\n` +
+            'Please merge those files.',
+        );
+        nl();
+      } else {
+        red(
+          `Both \`${templateFile}\` and \`${mergeableFilePath}\` already exist.\n` +
+            'Please merge those files.',
+        );
+        nl();
+      }
+      return;
     }
+
+    red(
+      `Could not find appropriate destination for \`${templateFile}\`. Tried: ${destinationOptions}.`,
+    );
+    nl();
   }
 
   private _fillAndCopyTemplate(
@@ -228,63 +270,61 @@ export class NextJs extends BaseIntegration {
     fs.writeFileSync(targetPath, filledTemplate);
   }
 
-  private _checkDep(packageName: string, minVersion?: boolean): boolean {
-    const depVersion = _.get(
-      appPackage,
-      ['dependencies', packageName],
-      '0.0.0',
-    );
-    const devDepVersion = _.get(
-      appPackage,
-      ['devDependencies', packageName],
-      '0.0.0',
-    );
+  private _checkUserNextVersion(packageName: string): boolean {
+    const depsVersion = _.get(appPackage, ['dependencies', packageName]);
+    const devDepsVersion = _.get(appPackage, ['devDependencies', packageName]);
 
-    if (
-      !_.get(appPackage, `dependencies.${packageName}`, false) &&
-      !_.get(appPackage, `devDependencies.${packageName}`, false)
-    ) {
-      red(`✗ ${packageName} isn't in your dependencies`);
-      red(`  please install it with yarn/npm`);
+    if (!depsVersion && !devDepsVersion) {
+      red(`✗ ${packageName} isn't in your dependencies.`);
+      red('  Please install it with yarn/npm.');
       return false;
     } else if (
-      !this._fulfillsMinVersion(depVersion) &&
-      !this._fulfillsMinVersion(devDepVersion)
+      !this._fulfillsVersionRange(depsVersion) &&
+      !this._fulfillsVersionRange(devDepsVersion)
     ) {
       red(
-        `✗ Your installed version of \`${packageName}\` is not supported, >=${MIN_NEXTJS_VERSION} needed.`,
+        `✗ Your \`package.json\` specifies a version of \`${packageName}\` outside of the compatible version range ${COMPATIBLE_NEXTJS_VERSIONS}.\n`,
       );
       return false;
     } else {
-      if (minVersion) {
-        green(`✓ ${packageName} >= ${MIN_NEXTJS_VERSION} is installed`);
-      } else {
-        green(`✓ ${packageName} is installed`);
-      }
+      green(
+        `✓ A compatible version of \`${packageName}\` is specified in \`package.json\`.`,
+      );
       return true;
     }
   }
 
-  private _fulfillsMinVersion(version: string): boolean {
-    // The latest version, which at the moment is greater than the minimum
-    // version, shouldn't be a blocker in the wizard.
+  private _fulfillsVersionRange(version: string): boolean {
+    // The latest version is currently 12.x, which is not yet supported.
     if (version === 'latest') {
-      return true;
+      return false;
     }
 
-    const cleanedVersion = clean(version);
-    if (cleanedVersion) {
-      // gte(x, y) : true if x >= y
-      return gte(cleanedVersion, MIN_NEXTJS_VERSION);
-    }
+    let cleanedUserVersion, isRange;
 
-    const minVersionRange = `>=${MIN_NEXTJS_VERSION}`;
-    const userVersionRange = validRange(version);
-    const minUserVersion = minVersion(userVersionRange);
-    if (minUserVersion == null) {
-      // This should never happen
-      return false;
+    if (valid(version)) {
+      cleanedUserVersion = valid(version);
+      isRange = false;
+    } else if (validRange(version)) {
+      cleanedUserVersion = validRange(version);
+      isRange = true;
     }
-    return satisfies(minUserVersion, minVersionRange);
+
+    return (
+      !!cleanedUserVersion &&
+      (isRange
+        ? subset(cleanedUserVersion, COMPATIBLE_NEXTJS_VERSIONS)
+        : satisfies(cleanedUserVersion, COMPATIBLE_NEXTJS_VERSIONS))
+    );
+  }
+
+  private _spliceInPlace(
+    arr: Array<any>,
+    start: number,
+    deleteCount: number,
+    ...inserts: any[]
+  ): Array<any> {
+    arr.splice(start, deleteCount, ...inserts);
+    return arr;
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/wizard",
-  "version": "1.2.12",
+  "version": "1.2.16",
   "homepage": "https://github.com/getsentry/sentry-wizard",
   "repository": "https://github.com/getsentry/sentry-wizard",
   "description": "Sentry wizard helping you to configure your project",