Ensure lockfile is updated after reset to pre-build state

SalmaSamy · copybara-github · commit 19c0c809abbe · 2023-08-30T03:25:50.000-07:00
The events that update the lockfile are important for incremental correctness and thus need to return `true` from `storeForReplay`. Before this change, if a build creates the lockfile because it didn't exist and the lockfile is then deleted, subsequent builds did not regenerate it as the relevant SkyFunctions wouldn't rerun and the events were not replayed. Closes #19343. PiperOrigin-RevId: 561287438 Change-Id: I549f99b896a0095e8ffc35b7bacc8a841a44219a
diff --git a/src/main/java/com/google/devtools/build/lib/bazel/bzlmod/BazelModuleResolutionEvent.java b/src/main/java/com/google/devtools/build/lib/bazel/bzlmod/BazelModuleResolutionEvent.java
@@ -36,4 +36,9 @@ public static BazelModuleResolutionEvent create(
 
   public abstract ImmutableTable<ModuleExtensionId, ModuleKey, ModuleExtensionUsage>
       getExtensionUsagesById();
+
+  @Override
+  public boolean storeForReplay() {
+    return true;
+  }
 }
diff --git a/src/main/java/com/google/devtools/build/lib/bazel/bzlmod/ModuleExtensionResolutionEvent.java b/src/main/java/com/google/devtools/build/lib/bazel/bzlmod/ModuleExtensionResolutionEvent.java
@@ -33,4 +33,9 @@ public static ModuleExtensionResolutionEvent create(
   public abstract ModuleExtensionId getExtensionId();
 
   public abstract LockFileModuleExtension getModuleExtension();
+
+  @Override
+  public boolean storeForReplay() {
+    return true;
+  }
 }
diff --git a/src/test/py/bazel/bzlmod/bazel_lockfile_test.py b/src/test/py/bazel/bzlmod/bazel_lockfile_test.py
@@ -964,6 +964,48 @@ def testExtensionEvaluationDoesNotRerunOnChangedImports(self):
         stderr,
     )
 
+  def testLockfileRecreatedAfterDeletion(self):
+    self.ScratchFile(
+        'MODULE.bazel',
+        [
+            'lockfile_ext = use_extension("extension.bzl", "lockfile_ext")',
+            'use_repo(lockfile_ext, "hello")',
+        ],
+    )
+    self.ScratchFile('BUILD.bazel')
+    self.ScratchFile(
+        'extension.bzl',
+        [
+            'def _repo_rule_impl(ctx):',
+            '    ctx.file("WORKSPACE")',
+            '    ctx.file("BUILD", "filegroup(name=\'lala\')")',
+            '',
+            'repo_rule = repository_rule(implementation=_repo_rule_impl)',
+            '',
+            'def _module_ext_impl(ctx):',
+            '    repo_rule(name="hello")',
+            '',
+            'lockfile_ext = module_extension(',
+            '    implementation=_module_ext_impl,',
+            ')',
+        ],
+    )
+
+    self.RunBazel(['build', '@hello//:all'])
+
+    # Return the lockfile to the state it had before the
+    # previous build: it didn't exist.
+    with open('MODULE.bazel.lock', 'r') as lock_file:
+      old_data = lock_file.read()
+    os.remove('MODULE.bazel.lock')
+
+    self.RunBazel(['build', '@hello//:all'])
+
+    with open('MODULE.bazel.lock', 'r') as lock_file:
+      new_data = lock_file.read()
+
+    self.assertEqual(old_data, new_data)
+
 
 if __name__ == '__main__':
   unittest.main()

Original file line number	Diff line number	Diff line change
`@@ -36,4 +36,9 @@ public static BazelModuleResolutionEvent create(`
`36`	`36`
`37`	`37`	`public abstract ImmutableTable<ModuleExtensionId, ModuleKey, ModuleExtensionUsage>`
`38`	`38`	`getExtensionUsagesById();`
	`39`	`+`
	`40`	`+ @Override`
	`41`	`+ public boolean storeForReplay() {`
	`42`	`+ return true;`
	`43`	`+ }`
`39`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,4 +33,9 @@ public static ModuleExtensionResolutionEvent create(`
`33`	`33`	`public abstract ModuleExtensionId getExtensionId();`
`34`	`34`
`35`	`35`	`public abstract LockFileModuleExtension getModuleExtension();`
	`36`	`+`
	`37`	`+ @Override`
	`38`	`+ public boolean storeForReplay() {`
	`39`	`+ return true;`
	`40`	`+ }`
`36`	`41`	`}`