expo-network-addons 0.1.0

package/.eslintrc.js

@@ -0,0 +1,2 @@
+// @generated by expo-module-scripts
+module.exports = require('expo-module-scripts/eslintrc.base.js');

package/README.md

@@ -0,0 +1,24 @@
+# expo-network-addons
+
+**`expo-network-addons`** is a set of networking addons
+
+## Features
+
+### Brotli Compression on Android
+
+`expo-network-addons` provides automatic Brotli compression for all OkHttp requests made by your app. This can significantly reduce the size of network responses, resulting in faster load times and reduced data usage. The Brotli support is backed by [okhttp-brotli](https://github.com/square/okhttp/blob/master/okhttp-brotli/).
+
+## API documentation
+
+- [Documentation for the main branch][docs-main]
+- [Documentation for the latest stable release][docs-stable]
+
+### Installation
+
+```
+npx expo install expo-network-addons
+```
+
+## Contributing
+
+Contributions are very welcome! Please refer to guidelines described in the [contributing guide](https://github.com/expo/expo#contributing).

package/android/build.gradle

@@ -0,0 +1,93 @@
+apply plugin: 'com.android.library'
+apply plugin: 'kotlin-android'
+apply plugin: 'maven-publish'
+
+group = 'expo.modules.networkaddons'
+version = '0.1.0'
+
+buildscript {
+  def expoModulesCorePlugin = new File(project(":expo-modules-core").projectDir.absolutePath, "ExpoModulesCorePlugin.gradle")
+  if (expoModulesCorePlugin.exists()) {
+    apply from: expoModulesCorePlugin
+    applyKotlinExpoModulesCorePlugin()
+  }
+
+  // Simple helper that allows the root project to override versions declared by this library.
+  ext.safeExtGet = { prop, fallback ->
+    rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+  }
+
+  // Ensures backward compatibility
+  ext.getKotlinVersion = {
+    if (ext.has("kotlinVersion")) {
+      ext.kotlinVersion()
+    } else {
+      ext.safeExtGet("kotlinVersion", "1.8.10")
+    }
+  }
+
+  repositories {
+    mavenCentral()
+  }
+
+  dependencies {
+    classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:${getKotlinVersion()}")
+  }
+}
+
+afterEvaluate {
+  publishing {
+    publications {
+      release(MavenPublication) {
+        from components.release
+      }
+    }
+    repositories {
+      maven {
+        url = mavenLocal().url
+      }
+    }
+  }
+}
+
+android {
+  compileSdkVersion safeExtGet("compileSdkVersion", 31)
+
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_11
+    targetCompatibility JavaVersion.VERSION_11
+  }
+
+  kotlinOptions {
+    jvmTarget = JavaVersion.VERSION_11.majorVersion
+  }
+
+  namespace "expo.modules.networkaddons"
+  defaultConfig {
+    minSdkVersion safeExtGet("minSdkVersion", 21)
+    targetSdkVersion safeExtGet("targetSdkVersion", 31)
+    versionCode 1
+    versionName "0.1.0"
+    consumerProguardFiles("proguard-rules.pro")
+  }
+  lintOptions {
+    abortOnError false
+  }
+  publishing {
+    singleVariant("release") {
+      withSourcesJar()
+    }
+  }
+}
+
+repositories {
+  mavenCentral()
+}
+
+dependencies {
+  implementation project(':expo-modules-core')
+  implementation("com.squareup.okhttp3:okhttp:4.9.2")
+  implementation("com.squareup.okhttp3:okhttp-brotli:4.9.2")
+
+  implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:${getKotlinVersion()}"
+}

package/android/proguard-rules.pro

@@ -0,0 +1,11 @@
+#
+# NOTE: Keep the class names in sync with OkHttp and **ExpoOkHttpInterceptor.kt**
+#
+
+-keep class okhttp3.OkHttpClient$Builder {
+  *;
+}
+
+-keep class expo.modules.networkaddons.ExpoOkHttpInterceptor {
+  *;
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,2 @@
+<manifest>
+</manifest>

package/android/src/main/java/expo/modules/networkaddons/ExpoOkHttpInterceptor.kt

@@ -0,0 +1,13 @@
+// Copyright 2015-present 650 Industries. All rights reserved.
+
+package expo.modules.networkaddons
+
+import okhttp3.Interceptor
+import okhttp3.Response
+import okhttp3.brotli.BrotliInterceptor
+
+@Suppress("unused")
+class ExpoOkHttpInterceptor : Interceptor {
+  override fun intercept(chain: Interceptor.Chain): Response =
+    BrotliInterceptor.intercept(chain)
+}

package/build/index.d.ts

@@ -0,0 +1,3 @@
+declare const _default: {};
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,wBAAkB"}

package/build/index.js

@@ -0,0 +1,2 @@
+export default {};
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,eAAe,EAAE,CAAC","sourcesContent":["export default {};\n"]}

package/expo-module.config.json

@@ -0,0 +1,12 @@
+{
+  "platforms": ["android"],
+  "android": {
+    "gradlePlugins": [
+      {
+        "id": "expo-network-addons-gradle-plugin",
+        "group": "expo.modules",
+        "sourceDir": "expo-network-addons-gradle-plugin"
+      }
+    ]
+  }
+}

package/expo-network-addons-gradle-plugin/build.gradle.kts

@@ -0,0 +1,38 @@
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+
+plugins {
+  kotlin("jvm") version "1.8.10"
+  id("java-gradle-plugin")
+}
+
+repositories {
+  google()
+  mavenCentral()
+}
+
+dependencies {
+  implementation(gradleApi())
+  implementation("com.android.tools.build:gradle:7.4.2")
+}
+
+java {
+  sourceCompatibility = JavaVersion.VERSION_11
+  targetCompatibility = JavaVersion.VERSION_11
+}
+
+tasks.withType<KotlinCompile> {
+  kotlinOptions {
+    jvmTarget = JavaVersion.VERSION_11.toString()
+  }
+}
+
+group = "expo.modules"
+
+gradlePlugin {
+  plugins {
+    register("expoNetworkAddonsPlugin") {
+      id = "expo-network-addons-gradle-plugin"
+      implementationClass = "expo.modules.networkaddons.NetworkAddonsPlugin"
+    }
+  }
+}

package/expo-network-addons-gradle-plugin/src/main/kotlin/expo/modules/networkaddons/NetworkAddonsPlugin.kt

@@ -0,0 +1,135 @@
+// Copyright 2015-present 650 Industries. All rights reserved.
+
+package expo.modules.networkaddons
+
+import com.android.build.api.instrumentation.AsmClassVisitorFactory
+import com.android.build.api.instrumentation.ClassContext
+import com.android.build.api.instrumentation.ClassData
+import com.android.build.api.instrumentation.FramesComputationMode
+import com.android.build.api.instrumentation.InstrumentationParameters
+import com.android.build.api.instrumentation.InstrumentationScope
+import com.android.build.api.variant.AndroidComponentsExtension
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+import org.gradle.api.provider.Property
+import org.gradle.api.tasks.Input
+import org.gradle.api.tasks.Optional
+import org.objectweb.asm.ClassVisitor
+import org.objectweb.asm.MethodVisitor
+import org.objectweb.asm.Opcodes
+import org.slf4j.LoggerFactory
+
+abstract class NetworkAddonsPlugin : Plugin<Project> {
+
+  override fun apply(project: Project) {
+    val androidComponents = project.extensions.getByType(AndroidComponentsExtension::class.java)
+    val devLauncherInstalled = project.findProject(":expo-dev-launcher") != null
+
+    androidComponents.onVariants(androidComponents.selector().all()) { variant ->
+      variant.instrumentation.transformClassesWith(NetworkAddonsClassVisitorFactory::class.java, InstrumentationScope.ALL) {
+        it.enabled.set(true)
+        it.debugVariant.set(variant.buildType == "debug")
+        it.devLauncherInstalled.set(devLauncherInstalled)
+      }
+      variant.instrumentation.setAsmFramesComputationMode(FramesComputationMode.COMPUTE_FRAMES_FOR_INSTRUMENTED_METHODS)
+    }
+  }
+
+  interface NetworkAddonsPluginParameters : InstrumentationParameters {
+    @get:Input
+    @get:Optional
+    val enabled: Property<Boolean>
+
+    @get:Input
+    @get:Optional
+    val debugVariant: Property<Boolean>
+
+    @get:Input
+    @get:Optional
+    val devLauncherInstalled: Property<Boolean>
+  }
+
+  abstract class NetworkAddonsClassVisitorFactory : AsmClassVisitorFactory<NetworkAddonsPluginParameters> {
+    override fun createClassVisitor(
+      classContext: ClassContext,
+      nextClassVisitor: ClassVisitor
+    ): ClassVisitor {
+      if (parameters.get().enabled.getOrElse(false)) {
+        logger.debug("[NetworkAddonsPlugin] parameters: debugVariant[${parameters.get().debugVariant}] devLauncherInstalled[${parameters.get().devLauncherInstalled}]")
+        return OkHttpClassVisitor(classContext, instrumentationContext.apiVersion.get(), nextClassVisitor, parameters.get())
+      }
+      return nextClassVisitor
+    }
+
+    override fun isInstrumentable(classData: ClassData): Boolean {
+      if (parameters.get().enabled.getOrElse(false)) {
+        return classData.className in listOf("okhttp3.OkHttpClient\$Builder")
+      }
+      return false
+    }
+  }
+
+  class OkHttpClassVisitor(
+    private val classContext: ClassContext,
+    api: Int, classVisitor: ClassVisitor,
+    private val parameters: NetworkAddonsPluginParameters
+    ) : ClassVisitor(api, classVisitor) {
+    override fun visitMethod(access: Int, name: String?, descriptor: String?, signature: String?, exceptions: Array<out String>?): MethodVisitor {
+      val originalVisitor = super.visitMethod(access, name, descriptor, signature, exceptions)
+      if (name == "build") {
+        return OkHttpClientCustomBuildMethod(api, originalVisitor, parameters)
+      }
+      return originalVisitor
+    }
+  }
+
+  class OkHttpClientCustomBuildMethod(
+    api: Int, methodVisitor: MethodVisitor,
+    private val parameters: NetworkAddonsPluginParameters
+    ) : MethodVisitor(api, methodVisitor) {
+    override fun visitCode() {
+      // opcodes for `this.addInterceptor(expo.modules.kotlin.devtools.ExpoNetworkInspectOkHttpAppInterceptor())`
+      visitVarInsn(Opcodes.ALOAD, 0)
+      visitTypeInsn(Opcodes.NEW, "expo/modules/networkaddons/ExpoOkHttpInterceptor")
+      visitInsn(Opcodes.DUP)
+      visitMethodInsn(Opcodes.INVOKESPECIAL, "expo/modules/networkaddons/ExpoOkHttpInterceptor", "<init>", "()V", false)
+      visitTypeInsn(Opcodes.CHECKCAST, "okhttp3/Interceptor")
+      visitMethodInsn(Opcodes.INVOKEVIRTUAL, "okhttp3/OkHttpClient\$Builder", "addInterceptor", "(Lokhttp3/Interceptor;)Lokhttp3/OkHttpClient\$Builder;", false)
+
+      if (parameters.debugVariant.getOrElse(false) && parameters.devLauncherInstalled.getOrElse(false)) {
+        //
+        // NOTE: The following code should be kept in sync with **packages/expo-dev-launcher/expo-dev-launcher-gradle-plugin/src/main/kotlin/expo/modules/devlauncher/DevLauncherPlugin.kt**
+        //
+
+        // opcodes for `this.addInterceptor(expo.modules.kotlin.devtools.ExpoNetworkInspectOkHttpAppInterceptor())`
+        visitVarInsn(Opcodes.ALOAD, 0)
+        visitTypeInsn(Opcodes.NEW, "expo/modules/kotlin/devtools/ExpoNetworkInspectOkHttpAppInterceptor")
+        visitInsn(Opcodes.DUP)
+        visitMethodInsn(Opcodes.INVOKESPECIAL, "expo/modules/kotlin/devtools/ExpoNetworkInspectOkHttpAppInterceptor", "<init>", "()V", false)
+        visitTypeInsn(Opcodes.CHECKCAST, "okhttp3/Interceptor")
+        visitMethodInsn(Opcodes.INVOKEVIRTUAL, "okhttp3/OkHttpClient\$Builder", "addInterceptor", "(Lokhttp3/Interceptor;)Lokhttp3/OkHttpClient\$Builder;", false)
+
+        // opcodes for `this.addNetworkInterceptor(expo.modules.kotlin.devtools.ExpoNetworkInspectOkHttpNetworkInterceptor())`
+        visitVarInsn(Opcodes.ALOAD, 0)
+        visitTypeInsn(Opcodes.NEW, "expo/modules/kotlin/devtools/ExpoNetworkInspectOkHttpNetworkInterceptor")
+        visitInsn(Opcodes.DUP)
+        visitMethodInsn(Opcodes.INVOKESPECIAL, "expo/modules/kotlin/devtools/ExpoNetworkInspectOkHttpNetworkInterceptor", "<init>", "()V", false)
+        visitTypeInsn(Opcodes.CHECKCAST, "okhttp3/Interceptor")
+        visitMethodInsn(Opcodes.INVOKEVIRTUAL, "okhttp3/OkHttpClient\$Builder", "addNetworkInterceptor", "(Lokhttp3/Interceptor;)Lokhttp3/OkHttpClient\$Builder;", false)
+      }
+
+      // opcodes for `return OkHttpClient(this)`
+      visitTypeInsn(Opcodes.NEW, "okhttp3/OkHttpClient")
+      visitInsn(Opcodes.DUP)
+      visitVarInsn(Opcodes.ALOAD, 0)
+      visitMethodInsn(Opcodes.INVOKESPECIAL, "okhttp3/OkHttpClient", "<init>", "(Lokhttp3/OkHttpClient\$Builder;)V", false)
+      visitInsn(Opcodes.ARETURN)
+    }
+  }
+
+  companion object {
+    internal val logger by lazy {
+      LoggerFactory.getLogger(NetworkAddonsPlugin::class.java)
+    }
+  }
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "expo-network-addons",
+  "title": "Expo Networking Addons",
+  "version": "0.1.0",
+  "description": "Expo module that provides extra functionalities for networking",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "sideEffects": false,
+  "scripts": {
+    "build": "expo-module build",
+    "clean": "expo-module clean",
+    "lint": "expo-module lint",
+    "test": "expo-module test",
+    "prepare": "expo-module prepare",
+    "prepublishOnly": "expo-module prepublishOnly",
+    "expo-module": "expo-module"
+  },
+  "homepage": "https://docs.expo.dev/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/expo/expo.git",
+    "directory": "packages/expo-network-addons"
+  },
+  "keywords": [
+    "react-native",
+    "expo",
+    "expo-network-addons",
+    "ExpoNetworkAddons",
+    "network",
+    "addons",
+    "EAS"
+  ],
+  "author": "650 Industries, Inc.",
+  "license": "MIT",
+  "dependencies": {},
+  "devDependencies": {
+    "expo-module-scripts": "^3.0.4"
+  },
+  "peerDependencies": {
+    "expo": "*"
+  },
+  "gitHead": "73a47bb80ef6baac585af29383a92f312813f638"
+}

package/src/index.ts

@@ -0,0 +1 @@
+export default {};

package/tsconfig.json

@@ -0,0 +1,9 @@
+// @generated by expo-module-scripts
+{
+  "extends": "expo-module-scripts/tsconfig.base",
+  "compilerOptions": {
+    "outDir": "./build"
+  },
+  "include": ["./src"],
+  "exclude": ["**/__mocks__/*", "**/__tests__/*", "**/__stories__/*"]
+}