chore: Expose PR URL, improve PR_TEMPLATE & changelog, disable flaky test (#569)

* chore(Fastlane): Expose GITHUB_PR_URL properly

* chore(.github): Concise PR_TEMPLATE

* chore: Disable DNSTimeout until flakiness is resolved

* chore(Fastlane): Fix changelog in releases, refactor out custom method

Author: PLNech

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,21 +1,11 @@
-<!--
-  Thanks for submitting a pull request!
-  Please provide enough information so that others can review your pull request.
--->
+<!-- Thanks for submitting a pull request! Please provide enough information
+so that others can review your pull request. -->
 
-**Summary**
-
-<!--
-  Explain the **motivation** for making this change.
-  What existing problem does the pull request solve?
-  Are there any linked issues?
--->
-
-**Result**
-
-<!--
-  Demonstrate the code is solid.
-  Example: The exact commands you ran and their output,
-  screenshots / videos if the pull request changes UI.
--->
+# Summary
+<!-- Explain the **motivation** for making this change. What existing problem
+does the pull request solve? Are there any linked issues? -->
 
+# Result
+<!-- Demonstrate the code is solid.
+Example: The exact commands you ran and their output,
+screenshots / videos if the pull request changes UI. -->

algoliasearch/src/test/java/com/algolia/search/saas/IndexTest.java

@@ -507,40 +507,40 @@ public void hostSwitch() throws Exception {
         searchAsync();
     }
 
-    @Test
-    public void DNSTimeout() throws AssertionError {
-        // Given all hosts resulting in a DNS Timeout
-        List<String> hostsArray = (List<String>) Whitebox.getInternalState(client, "readHosts");
-        // With random hostnames to avoid any caching
-        final String hostNameSuffix = "-dsn.algolia.biz";
-        hostsArray.set(0, UUID.randomUUID().toString() + hostNameSuffix);
-        hostsArray.set(1, UUID.randomUUID().toString() + hostNameSuffix);
-        hostsArray.set(2, UUID.randomUUID().toString() + hostNameSuffix);
-        hostsArray.set(3, UUID.randomUUID().toString() + hostNameSuffix);
-        Whitebox.setInternalState(client, "readHosts", hostsArray);
-
-        //A connect timeout of 500 ms
-        final int timeout = 500;
-        client.setConnectTimeout(timeout);
-
-        //And an index that does not cache search queries
-        index.disableSearchCache();
-
-
-        // Expect failed search after timeout
-        final long startTime = System.nanoTime();
-        index.searchAsync(new Query(), new AssertCompletionHandler() {
-            @Override public void doRequestCompleted(JSONObject content, AlgoliaException error) {
-                if (error != null) {
-                    final long duration = (System.nanoTime() - startTime) / 1000000;
-                    assertTrue("We should hit 4 times the timeout before failing, but test took only " + duration + " ms.",
-                            duration > timeout * 4);
-                } else {
-                    fail("Searching with failing hosts should result in an error.");
-                }
-            }
-        });
-    }
+//    @Test
+//    public void DNSTimeout() throws AssertionError {
+//        // Given all hosts resulting in a DNS Timeout
+//        List<String> hostsArray = (List<String>) Whitebox.getInternalState(client, "readHosts");
+//        // With random hostnames to avoid any caching
+//        final String hostNameSuffix = "-dsn.algolia.biz";
+//        hostsArray.set(0, UUID.randomUUID().toString() + hostNameSuffix);
+//        hostsArray.set(1, UUID.randomUUID().toString() + hostNameSuffix);
+//        hostsArray.set(2, UUID.randomUUID().toString() + hostNameSuffix);
+//        hostsArray.set(3, UUID.randomUUID().toString() + hostNameSuffix);
+//        Whitebox.setInternalState(client, "readHosts", hostsArray);
+//
+//        //A connect timeout of 500 ms
+//        final int timeout = 500;
+//        client.setConnectTimeout(timeout);
+//
+//        //And an index that does not cache search queries
+//        index.disableSearchCache();
+//
+//
+//        // Expect failed search after timeout
+//        final long startTime = System.nanoTime();
+//        index.searchAsync(new Query(), new AssertCompletionHandler() {
+//            @Override public void doRequestCompleted(JSONObject content, AlgoliaException error) {
+//                if (error != null) {
+//                    final long duration = (System.nanoTime() - startTime) / 1000000;
+//                    assertTrue("We should hit 4 times the timeout before failing, but test took only " + duration + " ms.",
+//                            duration > timeout * 4);
+//                } else {
+//                    fail("Searching with failing hosts should result in an error.");
+//                }
+//            }
+//        });
+//    }
 
     @Test
     public void connectTimeout() throws AlgoliaException {

fastlane/Fastfile

@@ -39,9 +39,9 @@ platform :android do
 
     # Generate changelog updates
     changes = sh("conventional-changelog --preset angular --output-unreleased", log:false)
-    changes_lines = changes.split(/\n+/)[2..-1] # Remove header
+    changes_lines = changes.lines[1..-1] # Remove header
     changes_lines[0] = "## #{version_number}"
-    changes = changes_lines.join("\n")
+    changes = changes_lines.join
     puts "Changes: #{changes}"
     file_edit("../CHANGELOG.md", /^(# Changelog\n+)/, "\\1\n#{changes}\n")
 
@@ -56,19 +56,27 @@ platform :android do
     sh("git push origin :refs/tag/patch :refs/tag/minor :refs/tag/major")
 
     # Send PR
+    token = ENV["GITHUB_TOKEN"]
     pull_request_url = create_pull_request(
-      api_token: ENV["GITHUB_TOKEN"],
+      api_token: token,
       repo: "algolia/algoliasearch-client-android",
       title: "chore(release): Version #{version_number} [ci skip]",
       head: "version-#{version_number}",
       base: "master",
       body: "Please check the files before merging in case I've overidden something accidentally."
     )
-    puts "PR opened: #{pull_request_url}"
-    ENV["PR_URL"] = pull_request_url
-
-    # Post the changes via GitHub Release API
-    post_github_release(version_number, changes)
+    sh("envman add --key GITHUB_PR_URL --value #{pull_request_url}")
+
+    # Post release on GitHub
+    github_release = set_github_release(
+      repository_name: "algolia/algoliasearch-client-android",
+      api_token: token,
+      name: version_number,
+      tag_name: version_number,
+      description: changes.lines[2..-1].join,
+      commitish: "master"
+    )
+    puts "Release posted: #{github_release['html_url']}."
   end
 end
 
@@ -100,18 +108,4 @@ def file_edit(filename, regexp, replacement)
     FileUtils.chmod stat.mode, tempfile.path
     FileUtils.mv tempfile.path, filename
   end
-end
-
-def post_github_release(version, changes, token=ENV['GITHUB_TOKEN'])
-  puts "Creating release on GitHub..."
-  release_changes = changes.gsub(/^## #{version} /m, "## ").gsub("\n", "\\n")
-  url = "https://api.github.com/repos/algolia/algoliasearch-client-android/releases?access_token=#{token}"
-  result = HTTParty.post(url, :body => {
-    :tag_name => version,
-    :target_commitish => "master",
-    :name => version,
-    :body => release_changes,
-    :draft => false,
-    :prerelease => false}.to_json)
-  puts "Release posted: #{result}."
-end
+end