@sentry/wizard
Version:
Sentry wizard helping you to configure your project
240 lines • 17.5 kB
JavaScript
"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
// @ts-ignore - magicast is ESM and TS complains about that. It works though
var magicast_1 = require("magicast");
var metro_1 = require("../../src/react-native/metro");
describe('patch metro config - sentry serializer', function () {
describe('patchMetroWithSentryConfigInMemory', function () {
it('patches react native 0.72 default metro config', function () { return __awaiter(void 0, void 0, void 0, function () {
var mod, result;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
mod = (0, magicast_1.parseModule)("const {getDefaultConfig, mergeConfig} = require('@react-native/metro-config');\n\n/**\n * Metro configuration\n * https://reactnative.dev/docs/metro\n *\n * @type {import('metro-config').MetroConfig}\n */\nconst config = {};\n\nmodule.exports = mergeConfig(getDefaultConfig(__dirname), config);");
return [4 /*yield*/, (0, metro_1.patchMetroWithSentryConfigInMemory)(mod, function () { return __awaiter(void 0, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/];
});
}); })];
case 1:
result = _a.sent();
expect(result).toBe(true);
expect((0, magicast_1.generateCode)(mod.$ast).code)
.toBe("const {getDefaultConfig, mergeConfig} = require('@react-native/metro-config');\n\nconst {\n withSentryConfig\n} = require(\"@sentry/react-native/metro\");\n\n/**\n * Metro configuration\n * https://reactnative.dev/docs/metro\n *\n * @type {import('metro-config').MetroConfig}\n */\nconst config = {};\n\nmodule.exports = withSentryConfig(mergeConfig(getDefaultConfig(__dirname), config));");
return [2 /*return*/];
}
});
}); });
it('patches react native 0.65 default metro config', function () { return __awaiter(void 0, void 0, void 0, function () {
var mod, result;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
mod = (0, magicast_1.parseModule)("/**\n* Metro configuration for React Native\n* https://github.com/facebook/react-native\n*\n* @format\n*/\n\nmodule.exports = {\n transformer: {\n getTransformOptions: async () => ({\n transform: {\n experimentalImportSupport: false,\n inlineRequires: true,\n },\n }),\n },\n};");
return [4 /*yield*/, (0, metro_1.patchMetroWithSentryConfigInMemory)(mod, function () { return __awaiter(void 0, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/];
});
}); })];
case 1:
result = _a.sent();
expect(result).toBe(true);
expect((0, magicast_1.generateCode)(mod.$ast).code).toBe("const {\n withSentryConfig\n} = require(\"@sentry/react-native/metro\");\n\n/**\n* Metro configuration for React Native\n* https://github.com/facebook/react-native\n*\n* @format\n*/\n\nmodule.exports = withSentryConfig({\n transformer: {\n getTransformOptions: async () => ({\n transform: {\n experimentalImportSupport: false,\n inlineRequires: true,\n },\n }),\n },\n});");
return [2 /*return*/];
}
});
}); });
it('patches react native metro config exported variable', function () { return __awaiter(void 0, void 0, void 0, function () {
var mod, result;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
mod = (0, magicast_1.parseModule)("const testConfig = {};\n\nmodule.exports = testConfig;");
return [4 /*yield*/, (0, metro_1.patchMetroWithSentryConfigInMemory)(mod, function () { return __awaiter(void 0, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/];
});
}); })];
case 1:
result = _a.sent();
expect(result).toBe(true);
expect((0, magicast_1.generateCode)(mod.$ast).code).toBe("const {\n withSentryConfig\n} = require(\"@sentry/react-native/metro\");\n\nconst testConfig = {};\n\nmodule.exports = withSentryConfig(testConfig);");
return [2 /*return*/];
}
});
}); });
it('does not patch react native metro config exported as factory function', function () { return __awaiter(void 0, void 0, void 0, function () {
var mod, result;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
mod = (0, magicast_1.parseModule)("module.exports = () => ({});");
return [4 /*yield*/, (0, metro_1.patchMetroWithSentryConfigInMemory)(mod, function () { return __awaiter(void 0, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/];
});
}); })];
case 1:
result = _a.sent();
expect(result).toBe(false);
expect((0, magicast_1.generateCode)(mod.$ast).code).toBe("module.exports = () => ({});");
return [2 /*return*/];
}
});
}); });
});
describe('addSentrySerializerToMetroConfig', function () {
it('add to empty config', function () {
var mod = (0, magicast_1.parseModule)("module.exports = {\n other: 'config'\n }");
var configObject = getModuleExportsObject(mod);
var result = (0, metro_1.addSentrySerializerToMetroConfig)(configObject);
expect(result).toBe(true);
expect((0, magicast_1.generateCode)(mod.$ast).code).toBe("module.exports = {\n other: 'config',\n\n serializer: {\n customSerializer: createSentryMetroSerializer()\n }\n}");
});
it('add to existing serializer config', function () {
var mod = (0, magicast_1.parseModule)("module.exports = {\n other: 'config',\n serializer: {\n other: 'config'\n }\n}");
var configObject = getModuleExportsObject(mod);
var result = (0, metro_1.addSentrySerializerToMetroConfig)(configObject);
expect(result).toBe(true);
expect((0, magicast_1.generateCode)(mod.$ast).code).toBe("module.exports = {\n other: 'config',\n serializer: {\n other: 'config',\n customSerializer: createSentryMetroSerializer()\n }\n}");
});
it('not add to existing customSerializer config', function () {
var mod = (0, magicast_1.parseModule)("module.exports = {\n other: 'config',\n serializer: {\n other: 'config',\n customSerializer: 'existing-serializer'\n }\n}");
var configObject = getModuleExportsObject(mod);
var result = (0, metro_1.addSentrySerializerToMetroConfig)(configObject);
expect(result).toBe(false);
expect((0, magicast_1.generateCode)(mod.$ast).code).toBe("module.exports = {\n other: 'config',\n serializer: {\n other: 'config',\n customSerializer: 'existing-serializer'\n }\n}");
});
});
describe('addSentrySerializerImportToMetroConfig', function () {
it('add import', function () {
var mod = (0, magicast_1.parseModule)("const { getDefaultConfig, mergeConfig } = require('@react-native/metro-config');\n\nmodule.exports = {\n other: 'config'\n}");
var result = (0, metro_1.addSentrySerializerRequireToMetroConfig)(mod.$ast);
expect(result).toBe(true);
expect((0, magicast_1.generateCode)(mod.$ast).code)
.toBe("const { getDefaultConfig, mergeConfig } = require('@react-native/metro-config');\n\nconst {\n createSentryMetroSerializer\n} = require(\"@sentry/react-native/dist/js/tools/sentryMetroSerializer\");\n\nmodule.exports = {\n other: 'config'\n}");
});
});
describe('getMetroConfigObject', function () {
it('get config object from variable called config', function () {
var mod = (0, magicast_1.parseModule)("var config = { some: 'config' };");
var configObject = (0, metro_1.getMetroConfigObject)(mod.$ast);
expect((configObject === null || configObject === void 0 ? void 0 : configObject.properties[0]).key
.name).toBe('some');
expect((configObject === null || configObject === void 0 ? void 0 : configObject.properties[0])
.value.value).toBe('config');
});
it('get config object from const called config', function () {
var mod = (0, magicast_1.parseModule)("const config = { some: 'config' };");
var configObject = (0, metro_1.getMetroConfigObject)(mod.$ast);
expect((configObject === null || configObject === void 0 ? void 0 : configObject.properties[0]).key
.name).toBe('some');
expect((configObject === null || configObject === void 0 ? void 0 : configObject.properties[0])
.value.value).toBe('config');
});
it('get config oject from let called config', function () {
var mod = (0, magicast_1.parseModule)("let config = { some: 'config' };");
var configObject = (0, metro_1.getMetroConfigObject)(mod.$ast);
expect((configObject === null || configObject === void 0 ? void 0 : configObject.properties[0]).key
.name).toBe('some');
expect((configObject === null || configObject === void 0 ? void 0 : configObject.properties[0])
.value.value).toBe('config');
});
it('get config object from module.exports', function () {
var mod = (0, magicast_1.parseModule)("module.exports = { some: 'config' };");
var configObject = (0, metro_1.getMetroConfigObject)(mod.$ast);
expect((configObject === null || configObject === void 0 ? void 0 : configObject.properties[0]).key
.name).toBe('some');
expect((configObject === null || configObject === void 0 ? void 0 : configObject.properties[0])
.value.value).toBe('config');
});
});
describe('remove require', function () {
it('nothing to remove', function () {
var mod = (0, magicast_1.parseModule)("let config = { some: 'config' };");
var result = (0, metro_1.removeSentryRequire)(mod.$ast);
expect(result).toBe(false);
expect((0, magicast_1.generateCode)(mod.$ast).code).toBe("let config = { some: 'config' };");
});
it('remove metro serializer import', function () {
var mod = (0, magicast_1.parseModule)("const {\n createSentryMetroSerializer,\n} = require('@sentry/react-native/dist/js/tools/sentryMetroSerializer');\nlet config = { some: 'config' };");
var result = (0, metro_1.removeSentryRequire)(mod.$ast);
expect(result).toBe(true);
expect((0, magicast_1.generateCode)(mod.$ast).code).toBe("let config = { some: 'config' };");
});
it('remove all sentry imports', function () {
var mod = (0, magicast_1.parseModule)("const {\n createSentryMetroSerializer,\n} = require('@sentry/react-native/dist/js/tools/sentryMetroSerializer');\nvar Sentry = require('@sentry/react-native');\nlet SentryIntegrations = require('@sentry/integrations');\n\nlet config = { some: 'config' };");
var result = (0, metro_1.removeSentryRequire)(mod.$ast);
expect(result).toBe(true);
expect((0, magicast_1.generateCode)(mod.$ast).code).toBe("let config = { some: 'config' };");
});
});
describe('remove sentryMetroSerializer', function () {
it('no custom serializer to remove', function () {
var mod = (0, magicast_1.parseModule)("let config = { some: 'config' };");
var result = (0, metro_1.removeSentrySerializerFromMetroConfig)(mod.$ast);
expect(result).toBe(false);
expect((0, magicast_1.generateCode)(mod.$ast).code).toBe("let config = { some: 'config' };");
});
it('no Sentry custom serializer to remove', function () {
var mod = (0, magicast_1.parseModule)("let config = {\n serializer: {\n customSerializer: 'existing-serializer',\n other: 'config',\n },\n other: 'config',\n};");
var result = (0, metro_1.removeSentrySerializerFromMetroConfig)(mod.$ast);
expect(result).toBe(false);
expect((0, magicast_1.generateCode)(mod.$ast).code).toBe("let config = {\n serializer: {\n customSerializer: 'existing-serializer',\n other: 'config',\n },\n other: 'config',\n};");
});
it('Sentry serializer to remove', function () {
var mod = (0, magicast_1.parseModule)("let config = {\n serializer: {\n customSerializer: createSentryMetroSerializer(),\n other: 'config',\n },\n other: 'config',\n};");
var result = (0, metro_1.removeSentrySerializerFromMetroConfig)(mod.$ast);
expect(result).toBe(true);
expect((0, magicast_1.generateCode)(mod.$ast).code).toBe("let config = {\n serializer: {\n other: 'config'\n },\n other: 'config',\n};");
});
it('Sentry serializer to remove with wrapped serializer', function () {
var mod = (0, magicast_1.parseModule)("let config = {\n serializer: {\n customSerializer: createSentryMetroSerializer(wrappedSerializer()),\n other: 'config',\n },\n other: 'config',\n};");
var result = (0, metro_1.removeSentrySerializerFromMetroConfig)(mod.$ast);
expect(result).toBe(true);
expect((0, magicast_1.generateCode)(mod.$ast).code).toBe("let config = {\n serializer: {\n customSerializer: wrappedSerializer(),\n other: 'config',\n },\n other: 'config',\n};");
});
});
});
function getModuleExportsObject(mod, index) {
if (index === void 0) { index = 0; }
return mod.$ast.body[index]
.expression.right;
}
//# sourceMappingURL=metro.test.js.map