bazel: generate graphql operation interfaces, css module typings #45682

jbedard · 2022-12-14T23:32:18Z

This creates bazel rules and targets for generating these. The existing scripts are modified to support running from bazel and are run in the BUILDs.

Test plan

compile with bazel

kormide · 2022-12-15T01:45:19Z

client/shared/dev/tools.bzl

+load("@aspect_rules_js//js:defs.bzl", "js_library")
+load("@npm//:typed-scss-modules/package_json.bzl", types_scss_modules_bin = "bin")
+
+def module_style_typings(name = "module_style_typings", deps = []):


On second thought, it might be better to not hide the name as eventually these will be included in the frontend packages and it will be clearer if the name is visible in the BUILD file.

kormide · 2022-12-15T01:57:43Z

client/shared/dev/tools.bzl

+    types_scss_modules_bin.tsm(
+        name = name,
+        srcs = [":%s_sources" % name] + deps,
+        outs = outs,
+        args = [
+            "--logLevel",
+            "error",
+            "%s/**/*.module.scss" % native.package_name(),
+            "--includePaths",
+            "client",
+            "node_modules",
+        ],


This mimics what the gulp script did, but with rules_js we can invoke an npm package binary as a build action directly in a BUILD file.

Given the simplicity of this case, I didn't feel it was necessary to have Bazel and the legacy build share the same code path.

valerybugakov

For some reason, bazel build ... and bazel info hang for me locally without any output after switching to this branch. But they worked as expected on the previous PR. Any tips on how to mitigate that?

ESLint errors and GraphQL operations type imports cause multiple CI failures:

valerybugakov · 2022-12-15T04:48:42Z

client/shared/dev/generateGraphQlOperations.js

+// Bazel entry point to generate a single graphql operations file; the legacy build
+// continues to import `generateGraphQlOperations` and generate all operations files.
+async function main(args) {
+  await _generateGraphQlOperations([{ interfaceNameForOperations: args[0], outputPath: args[1] }])
+}
+
+;(async () => {
+  if (require.main === module) {
+    await main(process.argv.slice(2))
+  }
+})()


Can we use the same approach as we do for other scripts shared with Bazel? It would be easier to maintain these scripts if the follow the same structure, validate arguments and handle errors in the same way.

sourcegraph/client/shared/dev/generateSchema.js

Lines 53 to 71 in 5dec121

async function main(args) {

if (args.length !== 1) {

throw new Error('Usage: <schemaName>')

}

const schemaName = args[0]

await generateSchema(schemaName)

}

if (require.main === module) {

main(process.argv.slice(2)).catch(error => {

console.error(error)

process.exit(1)

})

}

module.exports = {

generateSchema,

}

9cd5709 look ok?

@jbedard, yeah, looks great! Can we also validate CLI arguments and throw an error similar to what we do in the generateSchema.js script?

I've done this in a fixup on the new PR: 7405f24

Thank you! 💜

client/shared/dev/generateGraphQlOperations.js

package.json

valerybugakov · 2022-12-15T05:20:59Z

client/shared/dev/BUILD.bazel

+        "//:node_modules/@graphql-codegen/cli",
+        "//:node_modules/@graphql-codegen/typescript",
+        "//:node_modules/@graphql-codegen/typescript-operations",
+        "//:node_modules/prettier",


Would it be possible to automate maintenance of the list of dependencies here somehow later?

jbedard · 2022-12-15T05:29:27Z

The issue with bazel hanging might be bazelbuild/bazel#16159 (comment) which occurs when the pnpm-lock is out of date, although I'm not sure if you'd be seeing that case. If you let it sit for a bit (I think mine is 30s) does it finish and then not occur again (until a package.json is updated...)?

valerybugakov · 2022-12-15T05:32:16Z

If you let it sit for a bit (I think mine is 30s)

Yeah, it took around 2.5 minutes for me. Now I see the output again. Is there a way to see what's happening under the hood or prevent this by manually running some commands?

jbedard · 2022-12-15T05:33:54Z

Yeah, it took around 2.5 minutes for me. Now I see the output again. Is there a way to see what's happening under the hood or prevent this by manually running some commands?

The issue I linked to is I think the reason there is no output during that time. The case where I see this ~30s is when the yarn lock changes and the pnpm one must be updated. I'm not sure if you should be seeing that case though? Does bazel output any info about what was consuming that time?

valerybugakov · 2022-12-15T05:40:30Z

Here's the bazel info output. Anything rings the bell here?

λ bazel info
Starting local Bazel server and connecting to it...
bazel-bin: /private/var/tmp/_bazel_val/b74f98c07c1f7901aeeb711da373452f/execroot/__main__/bazel-out/darwin_arm64-fastbuild/bin
bazel-genfiles: /private/var/tmp/_bazel_val/b74f98c07c1f7901aeeb711da373452f/execroot/__main__/bazel-out/darwin_arm64-fastbuild/bin
bazel-testlogs: /private/var/tmp/_bazel_val/b74f98c07c1f7901aeeb711da373452f/execroot/__main__/bazel-out/darwin_arm64-fastbuild/testlogs
character-encoding: file.encoding = ISO-8859-1, defaultCharset = ISO-8859-1
command_log: /private/var/tmp/_bazel_val/b74f98c07c1f7901aeeb711da373452f/command.log
committed-heap-size: 1073MB
execution_root: /private/var/tmp/_bazel_val/b74f98c07c1f7901aeeb711da373452f/execroot/__main__
gc-count: 11
gc-time: 60ms
install_base: /var/tmp/_bazel_val/install/b87d93deaab718fa4775f187d0b2caae
java-home: /private/var/tmp/_bazel_val/install/b87d93deaab718fa4775f187d0b2caae/embedded_tools/jdk
java-runtime: OpenJDK Runtime Environment (build 11.0.10+9-LTS) by Azul Systems, Inc.
java-vm: OpenJDK 64-Bit Server VM (build 11.0.10+9-LTS, mixed mode) by Azul Systems, Inc.
max-heap-size: 17179MB
output_base: /private/var/tmp/_bazel_val/b74f98c07c1f7901aeeb711da373452f
output_path: /private/var/tmp/_bazel_val/b74f98c07c1f7901aeeb711da373452f/execroot/__main__/bazel-out
package_path: %workspace%
release: release 6.0.0rc3
repository_cache: /var/tmp/_bazel_val/cache/repos/v1
server_log: /private/var/tmp/_bazel_val/b74f98c07c1f7901aeeb711da373452f/java.log.macbook-pro-2.val.log.java.20221215-132143.27883
server_pid: 27883
used-heap-size: 720MB

jbedard · 2022-12-15T05:45:00Z

No, nothing in there I recognize.

Does it happen 100% of the time? Even when just running the build twice? Maybe add a comment to a .ts file so it's not 100% cached and it should be super fast the second time.

jbedard · 2022-12-16T03:14:14Z

Replaced with #45756

valerybugakov · 2022-12-16T03:55:53Z

Does it happen 100% of the time? Even when just running the build twice?

@jbedard, no, it happens sometimes. For example, when I switched from your previous PR to this one. Running bazel info or bazel build ... on #45756 works without delay.

bazel: generate graphql operations interfaces

919d382

jbedard requested review from jhchabran and kormide December 14, 2022 23:32

cla-bot bot added the cla-signed label Dec 14, 2022

kormide reviewed Dec 15, 2022

View reviewed changes

bazel: generate css module typings

b3b4898

jbedard force-pushed the bazel-generate-typings branch from c35c718 to b3b4898 Compare December 15, 2022 02:39

valerybugakov reviewed Dec 15, 2022

View reviewed changes

jbedard added 4 commits December 14, 2022 21:48

fixup! bazel: generate graphql operations interfaces

b837a1a

fixup! bazel: generate graphql operations interfaces

ac9c6d3

fixup! bazel: generate graphql operations interfaces

ab975fa

fixup! bazel: generate graphql operations interfaces

9cd5709

jbedard mentioned this pull request Dec 16, 2022

bazel: generate graphql operation interfaces, css module typings #45756

Merged

jbedard closed this Dec 16, 2022

valerybugakov added the aspect-dev label Jan 5, 2023

sourcegraph-tracking-issue-bot mentioned this pull request Jan 5, 2023

Bazel Aspect-dev: building the frontend #44909

Closed

76 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

bazel: generate graphql operation interfaces, css module typings #45682

bazel: generate graphql operation interfaces, css module typings #45682

jbedard commented Dec 14, 2022 •

edited

kormide Dec 15, 2022 •

edited

kormide Dec 15, 2022

kormide Dec 15, 2022 •

edited

valerybugakov left a comment

valerybugakov Dec 15, 2022

jbedard Dec 15, 2022

valerybugakov Dec 16, 2022

jbedard Dec 16, 2022

valerybugakov Dec 16, 2022

valerybugakov Dec 15, 2022

jbedard commented Dec 15, 2022

valerybugakov commented Dec 15, 2022

jbedard commented Dec 15, 2022

valerybugakov commented Dec 15, 2022 •

edited

jbedard commented Dec 15, 2022

jbedard commented Dec 16, 2022

valerybugakov commented Dec 16, 2022

	async function main(args) {
	if (args.length !== 1) {
	throw new Error('Usage: <schemaName>')
	}

	const schemaName = args[0]
	await generateSchema(schemaName)
	}

	if (require.main === module) {
	main(process.argv.slice(2)).catch(error => {
	console.error(error)
	process.exit(1)
	})
	}

	module.exports = {
	generateSchema,
	}

bazel: generate graphql operation interfaces, css module typings #45682

bazel: generate graphql operation interfaces, css module typings #45682

Conversation

jbedard commented Dec 14, 2022 • edited

Test plan

kormide Dec 15, 2022 • edited

Choose a reason for hiding this comment

kormide Dec 15, 2022

Choose a reason for hiding this comment

kormide Dec 15, 2022 • edited

Choose a reason for hiding this comment

valerybugakov left a comment

Choose a reason for hiding this comment

valerybugakov Dec 15, 2022

Choose a reason for hiding this comment

jbedard Dec 15, 2022

Choose a reason for hiding this comment

valerybugakov Dec 16, 2022

Choose a reason for hiding this comment

jbedard Dec 16, 2022

Choose a reason for hiding this comment

valerybugakov Dec 16, 2022

Choose a reason for hiding this comment

valerybugakov Dec 15, 2022

Choose a reason for hiding this comment

jbedard commented Dec 15, 2022

valerybugakov commented Dec 15, 2022

jbedard commented Dec 15, 2022

valerybugakov commented Dec 15, 2022 • edited

jbedard commented Dec 15, 2022

jbedard commented Dec 16, 2022

valerybugakov commented Dec 16, 2022

jbedard commented Dec 14, 2022 •

edited

kormide Dec 15, 2022 •

edited

kormide Dec 15, 2022 •

edited

valerybugakov commented Dec 15, 2022 •

edited