When downloading external projects, provide GitHub token if available (#717)

jonsimantov · web-flow · commit 58dbf86c8b76 · 2021-11-01T19:33:34.000Z
When downloading external projects, if the GITHUB_TOKEN environment variable is set, pass it to the external download cmake function via HTTP_HEADER.

This will prevent GitHub throttling the HTTP requests. Unauthenticated requests are limited by GitHub to 60 per IP address per hour, whereas authenticated requests are limited to 5,000 per user per hour.

(GitHub Actions runners automatically have the GITHUB_TOKEN environment variable set.)
diff --git a/README.md b/README.md
@@ -51,7 +51,7 @@ git clone https://github.com/firebase/firebase-cpp-sdk.git
 The following prerequisites are required for all platforms.  Be sure to add any
 directories to your PATH as needed.
 
-- [CMake](https://cmake.org/), version 3.1, or newer
+- [CMake](https://cmake.org/), version 3.7, or newer
 - [Python](https://www.python.com/), version of 3.7, or newer
 - [Abseil-py](https://github.com/abseil/abseil-py)
 
diff --git a/cmake/external/boringssl.cmake b/cmake/external/boringssl.cmake
@@ -36,5 +36,6 @@ ExternalProject_Add(
   BUILD_COMMAND     ""
   INSTALL_COMMAND   ""
   TEST_COMMAND      ""
+  HTTP_HEADER	    "${EXTERNAL_PROJECT_HTTP_HEADER}"
 )
 
diff --git a/cmake/external/curl.cmake b/cmake/external/curl.cmake
@@ -32,4 +32,5 @@ ExternalProject_Add(
   BUILD_COMMAND ""
   INSTALL_COMMAND ""
   TEST_COMMAND ""
+  HTTP_HEADER "${EXTERNAL_PROJECT_HTTP_HEADER}"
 )
diff --git a/cmake/external/firebase_ios_sdk.cmake b/cmake/external/firebase_ios_sdk.cmake
@@ -39,7 +39,7 @@ set(OUTDIR "./firebase_ios_sdk/")
 if(FIREBASE_CPP_BUILD_TESTS OR FIREBASE_CPP_BUILD_STUB_TESTS)
   if(NOT EXISTS ${OUTDIR})
     if(NOT EXISTS ${ZIP_FILENAME})
-      file(DOWNLOAD ${URL} ${ZIP_FILENAME}) 
+      file(DOWNLOAD ${URL} ${ZIP_FILENAME} HTTPHEADER "${EXTERNAL_PROJECT_HTTP_HEADER}") 
     endif()
     execute_process(COMMAND mkdir ${OUTDIR})
     execute_process(COMMAND tar -xf ${ZIP_FILENAME} -C ${OUTDIR})
diff --git a/cmake/external/firestore.cmake b/cmake/external/firestore.cmake
@@ -31,4 +31,5 @@ ExternalProject_Add(
   BUILD_COMMAND ""
   INSTALL_COMMAND ""
   TEST_COMMAND ""
+  HTTP_HEADER "${EXTERNAL_PROJECT_HTTP_HEADER}"
 )
diff --git a/cmake/external/flatbuffers.cmake b/cmake/external/flatbuffers.cmake
@@ -33,4 +33,5 @@ ExternalProject_Add(
   BUILD_COMMAND ""
   INSTALL_COMMAND ""
   TEST_COMMAND ""
+  HTTP_HEADER "${EXTERNAL_PROJECT_HTTP_HEADER}"
 )
diff --git a/cmake/external/googletest.cmake b/cmake/external/googletest.cmake
@@ -34,4 +34,5 @@ ExternalProject_Add(
   BUILD_COMMAND ""
   INSTALL_COMMAND ""
   TEST_COMMAND ""
+  HTTP_HEADER "${EXTERNAL_PROJECT_HTTP_HEADER}"
 )
diff --git a/cmake/external/leveldb.cmake b/cmake/external/leveldb.cmake
@@ -33,4 +33,5 @@ ExternalProject_Add(
   BUILD_COMMAND     ""
   INSTALL_COMMAND   ""
   TEST_COMMAND      ""
+  HTTP_HEADER "${EXTERNAL_PROJECT_HTTP_HEADER}"
 )
diff --git a/cmake/external/libuv.cmake b/cmake/external/libuv.cmake
@@ -33,4 +33,5 @@ ExternalProject_Add(
   BUILD_COMMAND ""
   INSTALL_COMMAND ""
   TEST_COMMAND ""
+  HTTP_HEADER "${EXTERNAL_PROJECT_HTTP_HEADER}"
 )
diff --git a/cmake/external/nanopb.cmake b/cmake/external/nanopb.cmake
@@ -33,4 +33,5 @@ ExternalProject_Add(
   BUILD_COMMAND ""
   INSTALL_COMMAND ""
   TEST_COMMAND ""
+  HTTP_HEADER "${EXTERNAL_PROJECT_HTTP_HEADER}"
 )
diff --git a/cmake/external/uWebSockets.cmake b/cmake/external/uWebSockets.cmake
@@ -35,4 +35,5 @@ ExternalProject_Add(
   BUILD_COMMAND ""
   INSTALL_COMMAND ""
   TEST_COMMAND ""
+  HTTP_HEADER "${EXTERNAL_PROJECT_HTTP_HEADER}"
 )
diff --git a/cmake/external/zlib.cmake b/cmake/external/zlib.cmake
@@ -32,4 +32,5 @@ ExternalProject_Add(
   BUILD_COMMAND ""
   INSTALL_COMMAND ""
   TEST_COMMAND ""
+  HTTP_HEADER "${EXTERNAL_PROJECT_HTTP_HEADER}"
 )
diff --git a/cmake/external_rules.cmake b/cmake/external_rules.cmake
@@ -67,6 +67,15 @@ function(download_external_sources)
     set(FIREBASE_DOWNLOAD_GTEST OFF)
   endif()
 
+  # If a GITHUB_TOKEN is present, use it for all external project downloads.
+  # This will prevent GitHub runners from being throttled by GitHub.
+  if(DEFINED ENV{GITHUB_TOKEN})
+    set(EXTERNAL_PROJECT_HTTP_HEADER "Authorization: token $ENV{GITHUB_TOKEN}")
+    message("Adding GITHUB_TOKEN header to ExternalProject downloads.")
+  else()
+    set(EXTERNAL_PROJECT_HTTP_HEADER "")
+  endif()
+
   execute_process(
     COMMAND
       ${ENV_COMMAND} ${CMAKE_COMMAND}
@@ -86,6 +95,7 @@ function(download_external_sources)
       -DDOWNLOAD_UWEBSOCKETS=${DOWNLOAD_UWEBSOCKETS}
       -DDOWNLOAD_ZLIB=${DOWNLOAD_ZLIB}
       -DDOWNLOAD_FIREBASE_IOS_SDK=${DOWNLOAD_FIREBASE_IOS_SDK}
+      -DEXTERNAL_PROJECT_HTTP_HEADER=${EXTERNAL_PROJECT_HTTP_HEADER}
       -DFIREBASE_CPP_BUILD_TESTS=${FIREBASE_CPP_BUILD_TESTS}
       -DFIREBASE_CPP_BUILD_STUB_TESTS=${FIREBASE_CPP_BUILD_STUB_TESTS}
       ${PROJECT_SOURCE_DIR}/cmake/external

Original file line number	Diff line number	Diff line change
`@@ -36,5 +36,6 @@ ExternalProject_Add(`
`36`	`36`	`BUILD_COMMAND ""`
`37`	`37`	`INSTALL_COMMAND ""`
`38`	`38`	`TEST_COMMAND ""`
	`39`	`+ HTTP_HEADER "${EXTERNAL_PROJECT_HTTP_HEADER}"`
`39`	`40`	`)`
`40`	`41`
Original file line number	Diff line number	Diff line change
`@@ -32,4 +32,5 @@ ExternalProject_Add(`
`32`	`32`	`BUILD_COMMAND ""`
`33`	`33`	`INSTALL_COMMAND ""`
`34`	`34`	`TEST_COMMAND ""`
	`35`	`+ HTTP_HEADER "${EXTERNAL_PROJECT_HTTP_HEADER}"`
`35`	`36`	`)`
Original file line number	Diff line number	Diff line change
`@@ -31,4 +31,5 @@ ExternalProject_Add(`
`31`	`31`	`BUILD_COMMAND ""`
`32`	`32`	`INSTALL_COMMAND ""`
`33`	`33`	`TEST_COMMAND ""`
	`34`	`+ HTTP_HEADER "${EXTERNAL_PROJECT_HTTP_HEADER}"`
`34`	`35`	`)`
Original file line number	Diff line number	Diff line change
`@@ -33,4 +33,5 @@ ExternalProject_Add(`
`33`	`33`	`BUILD_COMMAND ""`
`34`	`34`	`INSTALL_COMMAND ""`
`35`	`35`	`TEST_COMMAND ""`
	`36`	`+ HTTP_HEADER "${EXTERNAL_PROJECT_HTTP_HEADER}"`
`36`	`37`	`)`
Original file line number	Diff line number	Diff line change
`@@ -34,4 +34,5 @@ ExternalProject_Add(`
`34`	`34`	`BUILD_COMMAND ""`
`35`	`35`	`INSTALL_COMMAND ""`
`36`	`36`	`TEST_COMMAND ""`
	`37`	`+ HTTP_HEADER "${EXTERNAL_PROJECT_HTTP_HEADER}"`
`37`	`38`	`)`