Add Support for Custom Shareable Options

[handstandsam]

⚠️ Is your feature request related to a problem? Please describe

I would like to add an additional shareable item when I configure Chucker. I would like to be able to export to a custom format that wouldn't make sense to add to the chucker library itself as it's not a standard. In this case it's exporting a Kotlin file that is generated from HTTP data.

💡 Describe the solution you'd like

I'd like to be able to give a "Sharable" format option via the ChuckerInterceptor.Builder that would be shown on

chucker/library/src/main/java/com/chuckerteam/chucker/internal/ui/transaction/TransactionActivity.kt

Lines 77 to 99 in 218a997

	override fun onOptionsItemSelected(item: MenuItem) = when (item.itemId) {
	R.id.share_text -> shareTransactionAsText { transaction ->
	val encodeUrls = viewModel.encodeUrl.value!!
	TransactionDetailsSharable(transaction, encodeUrls)
	}
	R.id.share_curl -> shareTransactionAsText { transaction ->
	TransactionCurlCommandSharable(transaction)
	}
	R.id.share_file -> shareTransactionAsFile(EXPORT_TXT_FILE_NAME) { transaction ->
	val encodeUrls = viewModel.encodeUrl.value!!
	TransactionDetailsSharable(transaction, encodeUrls)
	}
	R.id.share_har -> shareTransactionAsFile(EXPORT_HAR_FILE_NAME) { transaction ->
	TransactionDetailsHarSharable(
	HarUtils.harStringFromTransactions(
	listOf(transaction),
	getString(R.string.chucker_name),
	getString(R.string.chucker_version)
	)
	)
	}
	else -> super.onOptionsItemSelected(item)
	}

Example Code

data class SharableOption(
  val name: String,
  val sharable: Sharable
)

val chuckerInterceptor = ChuckerInterceptor.Builder(context)
        .addSharableOption(sharableOption)
        .build()

📊 Describe alternatives you've considered

I am already doing this manually myself in my own library, but it would be nice to have a UI to do it, and yours is nice.

📄 Additional context

I could create a fork, but it seems like this would be fairly trivial to add to Chucker with the way your existing Sharables work today, and would allow this to be more extensible.

🙋 Do you want to develop this feature yourself?

• Yes
• No

[MiSikora]

Hey, thanks for creating this ticket. I agree that it would be a great addition, and it is something that I strive for. Unfortunately, I don't think it is as straightforward as it appears. Our Sharable implementations are internal and rely on the internal data model. Exposing them is tracked by #579, which is additionally "blocked" by #259.

It is something that I plan to prioritize in early 2022 when I have more free time on my hands. But if you (or anyone) would like to tackle this, it would be much appreciated for sure. :)

Unless you envisioned some other mechanism of sharing that doesn't rely on the internal data model?

[handstandsam]

That all makes sense. This would rely on the internal data model which would require a fork at this time if it wanted to get done. The benefit of chucker is that it has what I need as far as UI and persistence, just not the ability to export in my format.

I'll keep brainstorming, but might have to do it after those other changes happen. Thank you!

[cortinico]

Thanks for raising this point @handstandsam

Further sharing options were on our table for a while, as @MiSikora mentioned. Some months ago we merged HAR support #696. Ideally we would like to follow the approach already mentioned (i.e. #579 and #259) and allow users to plug in their "exporter" plugin.

HAR could be one of that and refactored outside the core of chucker.