fallback to REST API to download repo #104

ericsciple · 2019-12-10T21:46:02Z

fixes https://github.com/actions/checkout/issues/97

ericsciple · 2019-12-10T22:56:38Z

src/git-command-manager.ts

@@ -150,22 +155,10 @@ class GitCommandManager {
      args.push(arg)
    }



Refactored most of the lines below into a retry helper. I needed to add retry logic to a new place.

ericsciple · 2019-12-10T22:56:52Z

src/git-command-manager.ts

@@ -188,22 +181,10 @@ class GitCommandManager {
  async lfsFetch(ref: string): Promise<void> {
    const args = ['lfs', 'fetch', 'origin', ref]



Refactored most of the lines below into a retry helper. I needed to add retry logic to a new place.

ericsciple · 2019-12-10T22:57:57Z

src/git-command-manager.ts

@@ -381,16 +358,6 @@ class GitCommandManager {
    core.debug(`Set git useragent to: ${gitHttpUserAgent}`)
    this.gitEnv['GIT_HTTP_USER_AGENT'] = gitHttpUserAgent
  }
-


these two functions were moved into the retry helper

ericsciple · 2019-12-10T22:59:13Z

src/git-command-manager.ts

@@ -338,13 +319,9 @@ class GitCommandManager {
    }

    // Minimum git version


This is just reaction because i needed to export MinimumGitVersion. The previous comments about minimumGitVersion moved to the new field that is exported (top of this file)

ericsciple · 2019-12-10T23:01:23Z

src/git-source-provider.ts

      git,
      settings.repositoryPath,
      repositoryUrl,
      settings.clean
-    ))
-  ) {


To simplify how this function reads, i moved the few lines below (to delete contents) into the prepareExistingDirectory function

ericsciple · 2019-12-10T23:03:29Z

src/git-source-provider.ts

-      await io.rmRF(path.join(settings.repositoryPath, file))
-    }
-  }
-


The rest of these red lines were just indented.

The new logic now:

if (!git) { download using REST } else { do the existing logic }

ericsciple · 2019-12-10T23:41:32Z

src/git-source-provider.ts

    )
  }

-  // Remove possible previous extraheader
-  await removeGitConfig(git, authConfigKey)
+  if (!git) {


this if (!git) { block is new and just calls the new helper to download the files using the REST API

ericsciple · 2019-12-10T23:42:26Z

src/git-source-provider.ts

+      settings.repositoryPath
+    )
+  } else {
+    // Save state for POST action


this save-state line was further below, i just moved it up a little and add a stateHelper abstraction

ericsciple · 2019-12-10T23:44:22Z

src/git-source-provider.ts

@@ -146,79 +149,110 @@ export async function cleanup(repositoryPath: string): Promise<void> {
  await removeGitConfig(git, authConfigKey)
 }

-async function tryPrepareExistingDirectory(
+async function getGitCommandManager(


i moved some existing logic into this function so the caller's function reads easier.

this function just instantiates the git command manager (wrapper over git executable)

ericsciple · 2019-12-10T23:45:01Z

src/git-source-provider.ts

+      settings.lfs
+    )
+  } catch (err) {
+    // Git is required for LFS


this try catch is new. As long as the user doesnt have lfs: true, then we can fallback to using the REST API instead

ericsciple · 2019-12-10T23:47:41Z

src/git-source-provider.ts

  git: IGitCommandManager,
  repositoryPath: string,
  repositoryUrl: string,
  clean: boolean
-): Promise<boolean> {
+): Promise<void> {


i refactored this function a little bit

it now handles the case where git is null (ie not using git executable, instead using REST API)

it also performs the delete now too, if the repo folder needs to be recreated. before, the caller function performed the delete (so responsibility just moved)

ericsciple · 2019-12-10T23:50:37Z

src/retry-helper.ts

+const defaultMaxAttempts = 3
+const defaultMinSeconds = 10
+const defaultMaxSeconds = 20
+


we had two places with retry logic, and i needed to add a third.

so i went ahead and added a helper class

ericsciple · 2019-12-10T23:51:32Z

src/retry-helper.ts

+    return new Promise(resolve => setTimeout(resolve, seconds * 1000))
+  }
+}
+


this is the convenience function. its just a tiny wrapper over the class.

the only reason i export the class is for unit testing

ericsciple · 2019-12-10T23:52:54Z

src/state-helper.ts

@@ -0,0 +1,29 @@
+import * as core from '@actions/core'
+import * as coreCommand from '@actions/core/lib/command'
+


this is a simple module to make the caller code read more cleanly

this module abstracts the intra-state stuff (pretty simple logic, but reads gross in the other files, so abstracted behind this file instead)

ericsciple · 2019-12-10T23:54:48Z

src/github-api-helper.ts

+import {ReposGetArchiveLinkParams} from '@octokit/rest'
+
+const IS_WINDOWS = process.platform === 'win32'
+


pretty simple function:

Download the archive

Write to disk

Extract

Move the files to the correct place (the archive contains an extra top level folder that we need to flatten)

src/github-api-helper.ts

.github/workflows/test.yml

src/github-api-helper.ts

src/retry-helper.ts

ericsciple force-pushed the users/ericsciple/m163tarball branch 2 times, most recently from a60eac9 to 1e6a918 Compare December 10, 2019 22:44

ericsciple commented Dec 10, 2019

View reviewed changes

src/github-api-helper.ts Show resolved Hide resolved

ericsciple commented Dec 11, 2019

View reviewed changes

.github/workflows/test.yml Show resolved Hide resolved

fallback to REST API to download repo

655bd49

ericsciple force-pushed the users/ericsciple/m163tarball branch from f24d417 to 655bd49 Compare December 11, 2019 02:47

TingluoHuang reviewed Dec 12, 2019

View reviewed changes

src/github-api-helper.ts Show resolved Hide resolved

TingluoHuang reviewed Dec 12, 2019

View reviewed changes

src/github-api-helper.ts Show resolved Hide resolved

TingluoHuang reviewed Dec 12, 2019

View reviewed changes

src/github-api-helper.ts Outdated Show resolved Hide resolved

TingluoHuang reviewed Dec 12, 2019

View reviewed changes

src/retry-helper.ts Show resolved Hide resolved

TingluoHuang approved these changes Dec 12, 2019

View reviewed changes

ericsciple added 3 commits December 12, 2019 12:54

.

bdbd8b8

.

cf03f7c

.

eac457d

ericsciple merged commit a572f64 into master Dec 12, 2019

sync-by-unito bot mentioned this pull request Sep 24, 2021

Bump actions/checkout from 2 to 2.3.4 datastax/terraform-provider-astra#21

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fallback to REST API to download repo #104

fallback to REST API to download repo #104

ericsciple commented Dec 10, 2019 •

edited

ericsciple Dec 10, 2019

ericsciple Dec 10, 2019

ericsciple Dec 10, 2019

ericsciple Dec 10, 2019

ericsciple Dec 10, 2019

ericsciple Dec 10, 2019 •

edited

ericsciple Dec 10, 2019

ericsciple Dec 10, 2019

ericsciple Dec 10, 2019

ericsciple Dec 10, 2019

ericsciple Dec 10, 2019 •

edited

ericsciple Dec 10, 2019

ericsciple Dec 10, 2019

ericsciple Dec 10, 2019

ericsciple Dec 10, 2019

		@@ -150,22 +155,10 @@ class GitCommandManager {
		args.push(arg)
		}

		@@ -188,22 +181,10 @@ class GitCommandManager {
		async lfsFetch(ref: string): Promise<void> {
		const args = ['lfs', 'fetch', 'origin', ref]

		@@ -338,13 +319,9 @@ class GitCommandManager {
		}

		// Minimum git version

		@@ -0,0 +1,29 @@
		import * as core from '@actions/core'
		import * as coreCommand from '@actions/core/lib/command'

		import {ReposGetArchiveLinkParams} from '@octokit/rest'

		const IS_WINDOWS = process.platform === 'win32'

fallback to REST API to download repo #104

fallback to REST API to download repo #104

Conversation

ericsciple commented Dec 10, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ericsciple Dec 10, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ericsciple Dec 10, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ericsciple commented Dec 10, 2019 •

edited

ericsciple Dec 10, 2019 •

edited

ericsciple Dec 10, 2019 •

edited