fix remove-unused-fields command (#636)

* fix remove-unused-fields command

- make it use rescript-tools from the installed rescript package
instead of relying on the outdated @rescript/tools package
- get the artifact directory from relay config
- do not analyze files in relay config `excludes`

* fix typo

* update rescript to v12.3.0

* add E2E test for remove-unused-fields

Author: tsnobip

.github/workflows/cli.yml

@@ -15,17 +15,35 @@ jobs:
         working-directory: packages/rescript-relay-cli
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: "true"
       - uses: actions/setup-node@v4
         with:
           node-version: 23
         env:
           CI: true
+      - name: Set up OCaml
+        uses: ocaml/setup-ocaml@v3
+        with:
+          ocaml-compiler: "4.14"
+          dune-cache: true
+          cache-prefix: "v1"
+      - name: Install PPX dependencies
+        working-directory: packages/rescript-relay/rescript-relay-ppx
+        run: opam install . --deps-only
+      - name: Build PPX
+        working-directory: packages/rescript-relay/rescript-relay-ppx
+        run: opam exec -- dune build bin/RescriptRelayPpxApp.exe
       - name: Install
         run: |
           yarn --frozen-lockfile
       - name: Build
         run: |
           yarn build
+      - name: Build local Relay compiler
+        working-directory: packages/rescript-relay
+        run: |
+          ./build-compiler-dev.sh
       - name: Test
         run: |
           yarn test

CHANGELOG.md

@@ -1,3 +1,7 @@
+# master
+
+- fix remove-unused-fields command. https://github.com/zth/rescript-relay/pull/636
+
 # 4.5.1
 
 - Fix `traverse` exiting after a custom-scalar field (single array-backed `c`, or `ca`), leaving subsequent fields on the same parent uncoerced. Surfaced as raw `null` for nullable response fields, raw ReScript values for unserialized variables, and (in nested input objects) silently skipped converters. Closes #582; extends #434's #407 fix so trailing fields are preserved.

packages/rescript-relay-cli/__tests__/fixtures/remove-unused-fields-monorepo/.gitignore

@@ -0,0 +1,9 @@
+.cli-dist/
+.yarn/
+.pnp.*
+lib/
+node_modules/
+packages/*/lib/
+packages/*/node_modules/
+packages/web/src/__relay__/*
+!.gitkeep

packages/rescript-relay-cli/__tests__/fixtures/remove-unused-fields-monorepo/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "remove-unused-fields-monorepo",
+  "version": "1.0.0",
+  "private": true,
+  "workspaces": [
+    "packages/*"
+  ],
+  "scripts": {
+    "relay": "yarn --cwd packages/web relay",
+    "rescript:build": "rescript build",
+    "reanalyze": "rescript-tools reanalyze -dce"
+  },
+  "dependencies": {
+    "fixture-web": "1.0.0"
+  },
+  "devDependencies": {
+    "@rescript/react": "0.14.0",
+    "graphql": "15.8.0",
+    "react": "18.2.0",
+    "react-relay": "20.1.1",
+    "relay-runtime": "20.1.1",
+    "rescript": "12.3.0",
+    "rescript-relay": "file:../../../../rescript-relay"
+  }
+}

packages/rescript-relay-cli/__tests__/fixtures/remove-unused-fields-monorepo/packages/web/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "fixture-web",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "relay": "rescript-relay-compiler"
+  },
+  "dependencies": {
+    "@rescript/react": "0.14.0",
+    "react": "18.2.0",
+    "react-relay": "20.1.1",
+    "relay-runtime": "20.1.1",
+    "rescript": "12.3.0",
+    "rescript-relay": "file:../../../../../../rescript-relay"
+  }
+}

packages/rescript-relay-cli/__tests__/fixtures/remove-unused-fields-monorepo/packages/web/relay.config.cjs

@@ -0,0 +1,7 @@
+module.exports = {
+  src: "./src",
+  schema: "./schema.graphql",
+  artifactDirectory: "./src/__relay__",
+  language: "rescript",
+  excludes: ["**/lib/**"],
+};

packages/rescript-relay-cli/__tests__/fixtures/remove-unused-fields-monorepo/packages/web/rescript.json

@@ -0,0 +1,22 @@
+{
+  "name": "fixture-web",
+  "sources": [
+    {
+      "dir": "compiled",
+      "subdirs": true
+    },
+    {
+      "dir": "src/__relay__",
+      "subdirs": true
+    }
+  ],
+  "dependencies": [
+    "rescript-relay"
+  ],
+  "package-specs": {
+    "module": "commonjs",
+    "in-source": false
+  },
+  "suffix": ".js",
+  "namespace": true
+}

packages/rescript-relay-cli/__tests__/fixtures/remove-unused-fields-monorepo/packages/web/schema.graphql

@@ -0,0 +1,18 @@
+schema {
+  query: Query
+}
+
+interface Node {
+  id: ID!
+}
+
+type Query {
+  organization(id: ID!): Organization
+  currentOrg: Organization!
+}
+
+type Organization implements Node {
+  id: ID!
+  name: String!
+  currentUserIsAdmin: Boolean!
+}

packages/rescript-relay-cli/__tests__/fixtures/remove-unused-fields-monorepo/packages/web/src/Index.res

@@ -0,0 +1,14 @@
+module Query = %relay(`
+query IndexQuery {
+  currentOrg {
+    ...OrganizationCard
+  }
+}
+`)
+
+@react.component
+let make = () => {
+  let {currentOrg: {fragmentRefs}} = Query.use()
+
+  <OrganizationCard fragmentRefs />
+}

packages/rescript-relay-cli/__tests__/fixtures/remove-unused-fields-monorepo/packages/web/src/OrganizationCard.res

@@ -0,0 +1,14 @@
+module Fragment = %relay(`
+fragment OrganizationCard on Organization {
+  id
+  name
+  currentUserIsAdmin
+}
+`)
+
+@react.component
+let make = (~fragmentRefs) => {
+  let {name} = Fragment.use(fragmentRefs)
+
+  React.string(name)
+}