fix: sync/refresh ordering

Author: galargh

scripts/__tests__/sync.test.ts

@@ -9,6 +9,7 @@ import {GitHub} from '../src/github'
 import env from '../src/env'
 import {Resource} from '../src/resources/resource'
 import {RepositoryFile} from '../src/resources/repository-file'
+import {refresh} from '../src/refresh'
 
 test('sync', async () => {
   const yamlConfig = new config.Config('{}')
@@ -77,8 +78,10 @@ test('sync new repository file', async () => {
   const expectedYamlConfig = new config.Config(YAML.stringify(yamlSource))
 
   await sync(tfConfig, yamlConfig)
-
   yamlConfig.format()
+  expect(yamlConfig.toString().trim()).toEqual('{}')
 
+  await refresh(tfConfig, yamlConfig)
+  yamlConfig.format()
   expect(yamlConfig.toString()).toEqual(expectedYamlConfig.toString())
 })

scripts/src/actions/fix-yaml-config.ts

@@ -11,8 +11,9 @@ const uninitialisedRepositoryNames = [
 ]
 
 addFileToAllRepos(
-  '.github/workflows/stale.yml', 
   '.github/workflows/stale.yml',
-  (repository: Repository) => !uninitialisedRepositoryNames.includes(repository.name)
+  '.github/workflows/stale.yml',
+  (repository: Repository) =>
+    !uninitialisedRepositoryNames.includes(repository.name)
 )
 format()

scripts/src/main.ts

@@ -1,14 +1,24 @@
 import 'reflect-metadata'
 import {sync} from './sync'
+import {refresh} from './refresh'
 import {State} from './terraform/state'
 import {Config} from './yaml/config'
 
 async function run(): Promise<void> {
   const state = await State.New()
   const config = Config.FromPath()
 
+  // This step calls GitHub API to get the latest state of the world
+  // and updates the TF state to match. It only updates the resources,
+  // not their attributes.
   await sync(state, config)
+  config.save()
 
+  // This step calls Terraform to get the latest state of the world
+  // and updates the TF state to match. It updates the resource attributes.
+  // It requires config to be saved first because it needs to know about
+  // all the resources.
+  await refresh(state, config)
   config.save()
 }
 

scripts/src/refresh.ts

@@ -0,0 +1,9 @@
+import {State} from './terraform/state'
+import {Config} from './yaml/config'
+
+export async function refresh(state: State, config: Config): Promise<void> {
+  await state.refresh()
+
+  const refreshedResources = state.getAllResources()
+  config.sync(refreshedResources)
+}

scripts/src/sync.ts

@@ -14,7 +14,6 @@ export async function sync(state: State, config: Config): Promise<void> {
   }
 
   await state.sync(resources)
-  await state.refresh()
 
   const syncedResources = state.getAllResources()
   config.sync(syncedResources)