feat(apple): Add support for iOS

[brustolin]

Added the flow to add Sentry to an iOS project.

[github-actions]

	Messages
📖	Do not forget to update Sentry-docs with your feature once the pull request gets approved.

Generated by 🚫 dangerJS against efbdd1c

[brustolin]

This PR is big already, I will open for review and add support for cocoapod and fastlane in another one.

[smeubank]

@HazAT FYI

[Lms24]

Looks good to me from a JS dev perspective :) Can't say much about the code snippets/SDK configuration specifics but I think the general wizard flow looks good. I had some comments/suggestions.

[Lms24]

Thanks for adding my suggestions!

One more thing:

For folks who start the wizard without the -i arg, I think the grouping here isn't ideal. Wdyt about moving iOs to the top or below RN? I think we should sort the selection here roughly by platform (mobile, browser/JS + utilities like source maps).

At some point, depending on how many other wizards we add, we might want to somehow make these groups more apparent but for now I'd say moving iOS up should be good.

[Lms24]

Just to sanity-check (for someone who has no idea about xcode/ios apps): Is this a valid path?

wizard/wizard-apple/test.xcodeproj/project.pbxproj

Background: I briefly tried the wizard locally but couldn't get beyond the pbxproj step:

[brustolin]

Yes. The ".xcodeproj" is actually a folder that keeps project configuration files.

I think we should not show the "Successfully..." message in this case.

I briefly tried the wizard locally but couldn't get beyond the pbxproj step:

You just tried to run it, or you really have an xcode project to test it? Because it should have worked if you have a project.

[Lms24]

Yes. The ".xcodeproj" is actually a folder that keeps project configuration files.

Okay, all good then! I guess I was just confused by the xcodeProjectFile variable then 😅

You just tried to run it

Yeah, but not very methodically and without an actual xcode project. Just wanted to get over a few steps so I created some empty files 😅

[smeubank]

@brustolin do you know a repo which would be a example app to test this stuff with ourselves?

[brustolin]

I do 😁 https://github.com/brustolin/XcodeProjects

[brustolin]

Wdyt about moving iOs to the top or below RN?

Sound good. Can we try to find out which project exists to reorder the list?
Lets say there is a .xcodeproj directory, we know this may be an iOS or RN project, I guess we have other rules to indicate a RN project.

[philipphofmann]

Thanks for doing this, @brustolin 💪 . I added some comments.

[philipphofmann]

h: I don't think we should enable that by default. Especially the screenshots could contain sensitive data, even in a development build.

[smeubank]

we could also consider having them //commented out so it is easy enough for the user to decide themselves

[romtsn]

if I may, we could just add a comment to the snippet explaining that it can have sensitive data and turn it off in case you don't want it. Or we could add another step "Enable recommended features (could send PII to Sentry)"? and only after accepting it add the snippet

[brustolin]

I like the idea to show this options in the wizard and explain whats happening, but in another PR.

[philipphofmann]

I think adding a comment won't be sufficient. With the wizard, it can happen that some people don't check the code that much. They just hit compile and run after executing the wizard. We could add them //commented out, or an extra step would also be OK.

[Lms24]

Can we try to find out which project exists to reorder the list?

We sort of do this in the ChooseIntegration step for RN and Cordova:

sentry-wizard/lib/Steps/ChooseIntegration.ts

Lines 58 to 90 in ebb501e

	public tryDetectingIntegration(): Integration | undefined {
	if (_.has(projectPackage, 'dependencies.react-native')) {
	return Integration.reactNative;
	}
	if (_.has(projectPackage, 'dependencies.cordova')) {
	return Integration.cordova;
	}
	return;
	}
	private async _getIntegrationPromptSelection(): Promise<IntegrationPromptAnswer> {
	// If we receive project type as an arg we skip asking
	if (this._argv.integration) {
	return { integration: this._argv.integration };
	} else {
	if (this._argv.quiet) {
	throw new Error('You need to choose a integration');
	}
	const detectedDefaultSelection = this.tryDetectingIntegration();
	return prompt([
	{
	choices: getIntegrationChoices(),
	default: detectedDefaultSelection,
	message: 'What integration do you want to set up?',
	name: 'integration',
	type: 'list',
	},
	]);
	}
	}

However, this just influences the default selection in the list, not the order. I'd argue this should be enough.
Fwiw we didn't add detection for the JS frameworks (Next, SvelteKit) yet but it should be fairly straight-forward.

[smeubank]

This PR is big already, I will open for review and add support for cocoapod and fastlane in another one.

@brustolin sounds good 🚀 if you could link to the parent issue for those PRs when you get there just let us know.

only thing for me, before we make it customer facing is to ensure we have some telemetry with no PII, so we can track that it is working well. We identified a lot of simple edge cases with -sorucemaps wizard this way and are able to ship a lot of little improvements

#343

[philipphofmann]

LGTM from the Cocoa SDK perspective.