Map Chunks to Sentry Projects

[dan-kez]

Thanks for the awesome plugin!

I'd love to have the ability to map webpack generated chunks to separate sentry projects.

My application is split into multiple chunks that are asynchronously loaded and some their own own instance of Raven (see getsentry/sentry-javascript#1272). This is really helpful for a complex application as we can chunk each section of the webapp and load dependencies / pages gradually.

Right now I have to have multiple configFiles for each project just to pass in a different project name. I'd rather be able to share 1 config file for things like auth & organization and pass in the project name as an option.

Proposed interface:

 new SentryCliPlugin({
            include: 'dist',
            configFile: '.sentryclirc',
            ignoreFile: '.gitignore',
            configOptions: { project: 'some-project' },
            ignore: ['node_modules', 'webpack.config.js'],
}),

or

 new SentryCliPlugin({
            include: 'dist',
            ignoreFile: '.gitignore',
            configOptions: { project: 'some-project', organization: 'organization-value-here' },
            ignore: ['node_modules', 'webpack.config.js'],
}),

what I currently do:

[
 new SentryCliPlugin({
            include: 'dist',
            configFile: '.sentryclirc.project_1',
            ignoreFile: '.gitignore',
            ignore: ['node_modules', 'webpack.config.js'],
}),
 new SentryCliPlugin({
            include: 'dist',
            configFile: '.sentryclirc.project_2,
            ignoreFile: '.gitignore',
            ignore: ['node_modules', 'webpack.config.js'],
}),
 new SentryCliPlugin({
            include: 'dist',
            configFile: '.sentryclirc.project_3',
            ignoreFile: '.gitignore',
            ignore: ['node_modules', 'webpack.config.js'],
}),
]

[jan-auer]

Hi @dmk255, this is a great idea. Based on your proposal, there are three points we have to work out:

1. Multiple instances of the plugin should be able to run side by side. This is not entirely possible, since the configFile option causes SentryCli to override process.env.SENTRY_PROPERTIES. I am wondering, whether your solution actually even works. This will have to be fixed here in @sentry/cli by explicitly providing the env in execute.
2. Allowing to override certain options via an options object. There is no canonical way to provide these "global" options to sentry-cli other than environment. I think we should use a nested object just like in sentry.properties: configOptions: { defaults: { project: 'slug', org: 'slug' } }. We could inject this via env vars just like above.
3. You probably also want to split source map uploads between certain projects (only upload those that are relevant) and then instrument the corresponding entry point. We've just released a new version that allows this via the entries option:

[
    new SentryCliPlugin({
        include: 'dist/app',  // <-- this is a folder
        entries: ['app'],
        configOptions: { defaults: { project: 'my-project-app' } },
    }),
    new SentryCliPlugin({
        include: 'dist/admin',
        entries: ['admin'],
        configOptions: { defaults: { project: 'my-project-admin' } },
    }),
]

Bringing in @HazAT for a second opinion here.

[kamilogorek]

Closing the issue as a part of large repository cleanup, due to it being inactive and/or outdated.
Please do not hesitate to ping me if it is still relevant, and I will happily reopen it.
Cheers!