fix: require immutable flag on entities (#1994)

Author: isum

.changeset/tangy-pants-buy.md

@@ -0,0 +1,5 @@
+---
+'@graphprotocol/graph-cli': minor
+---
+
+require immutable flag on entities

examples/arweave-blocks-transactions/schema.graphql

@@ -1,4 +1,4 @@
-type Block @entity {
+type Block @entity(immutable: true) {
   id: ID!
 
   timestamp: BigInt!
@@ -22,7 +22,7 @@ type Block @entity {
   poa: Poa
 }
 
-type Transaction @entity {
+type Transaction @entity(immutable: true) {
   id: ID!
 
   block: Block!
@@ -39,7 +39,7 @@ type Transaction @entity {
   reward: Bytes!
 }
 
-type Poa @entity {
+type Poa @entity(immutable: true) {
   id: ID!
 
   option: String!
@@ -48,7 +48,7 @@ type Poa @entity {
   chunk: Bytes!
 }
 
-type Tag @entity {
+type Tag @entity(immutable: true) {
   id: ID!
 
   name: Bytes!

examples/cosmos-block-filtering/schema.graphql

@@ -1,4 +1,4 @@
-type Block @entity {
+type Block @entity(immutable: true) {
   id: ID!
   number: BigInt
   timestamp: BigInt

examples/cosmos-osmosis-token-swaps/schema.graphql

@@ -1,10 +1,10 @@
-type Token @entity {
+type Token @entity(immutable: true) {
   id: ID!
   amount: String
   denom: String
 }
 
-type TokenSwap @entity {
+type TokenSwap @entity(immutable: true) {
   id: ID!
   sender: String
   poolId: String

examples/cosmos-validator-delegations/schema.graphql

@@ -1,11 +1,11 @@
-type Delegation @entity {
+type Delegation @entity(immutable: true) {
   id: ID!
   delegatorAddress: String
   validatorAddress: String
   amount: Coin
 }
 
-type Coin @entity {
+type Coin @entity(immutable: true) {
   id: ID!
   denom: String
   amount: String

examples/cosmos-validator-rewards/schema.graphql

@@ -1,4 +1,4 @@
-type Reward @entity {
+type Reward @entity(immutable: true) {
   id: ID!
   amount: String
   validator: String

examples/ethereum-basic-event-handlers/schema.graphql

@@ -1,11 +1,11 @@
-type NewGravatar @entity {
+type NewGravatar @entity(immutable: false) {
   id: ID!
   owner: Bytes!
   displayName: String!
   imageUrl: String!
 }
 
-type UpdatedGravatar @entity {
+type UpdatedGravatar @entity(immutable: false) {
   id: ID!
   owner: Bytes!
   displayName: String!

examples/ethereum-gravatar/schema.graphql

@@ -1,4 +1,4 @@
-type Gravatar @entity {
+type Gravatar @entity(immutable: false) {
   id: ID!
   owner: Bytes!
   displayName: String!

examples/example-subgraph/schema.graphql

@@ -1,4 +1,4 @@
-type ExampleEntity @entity {
+type ExampleEntity @entity(immutable: false) {
   id: ID!
 
   optionalBoolean: Boolean
@@ -32,6 +32,6 @@ type ExampleEntity @entity {
   requiredReferenceList: [OtherEntity!]!
 }
 
-type OtherEntity @entity {
+type OtherEntity @entity(immutable: true) {
   id: ID!
 }

examples/near-blocks/schema.graphql

@@ -1,4 +1,4 @@
-type BlockEvent @entity {
+type BlockEvent @entity(immutable: true) {
   id: ID!
   number: BigInt
   hash: Bytes

examples/near-receipts/schema.graphql

@@ -1,10 +1,10 @@
-type Greeter @entity {
+type Greeter @entity(immutable: true) {
   id: ID!
   name: String!
   greetings: [Greeting!] @derivedFrom(field: "greeter")
 }
 
-type Greeting @entity {
+type Greeting @entity(immutable: true) {
   id: ID!
   greeter: Greeter!
   timestamp: BigInt!

examples/substreams-powered-subgraph/schema.graphql

@@ -1,4 +1,4 @@
-type Contract @entity {
+type Contract @entity(immutable: true) {
   id: ID!
 
   "The timestamp when the contract was deployed"

packages/cli/src/scaffold/__snapshots__/cosmos.test.ts.snap

@@ -60,7 +60,7 @@ export function handleBlock(block: cosmos.Block): void {
 `;
 
 exports[`Cosmos subgraph scaffolding > Schema (default) 1`] = `
-"type ExampleEntity @entity {
+"type ExampleEntity @entity(immutable: true) {
   id: ID!
   block: Bytes!
   count: BigInt!

packages/cli/src/scaffold/__snapshots__/ethereum.test.ts.snap

@@ -227,7 +227,7 @@ export function handleTupleArrayEvent(event: TupleArrayEvent): void {}
 `;
 
 exports[`Ethereum subgraph scaffolding > Schema (default) 1`] = `
-"type ExampleEntity @entity {
+"type ExampleEntity @entity(immutable: true) {
   id: Bytes!
   count: BigInt!
   a: BigInt! # uint256

packages/cli/src/scaffold/__snapshots__/near.test.ts.snap

@@ -62,7 +62,7 @@ export function handleReceipt(
 `;
 
 exports[`NEAR subgraph scaffolding > Schema (default) 1`] = `
-"type ExampleEntity @entity {
+"type ExampleEntity @entity(immutable: true) {
   id: ID!
   block: Bytes!
   count: BigInt!

packages/cli/src/scaffold/schema.ts

@@ -85,7 +85,7 @@ export const generateEventType = (
 
 export const generateExampleEntityType = (protocol: Protocol, events: any[]) => {
   if (protocol.hasABIs() && events.length > 0) {
-    return `type ExampleEntity @entity {
+    return `type ExampleEntity @entity(immutable: true) {
   id: Bytes!
   count: BigInt!
   ${events[0].inputs
@@ -97,7 +97,7 @@ export const generateExampleEntityType = (protocol: Protocol, events: any[]) =>
     .join('\n')}
 }`;
   }
-  return `type ExampleEntity @entity {
+  return `type ExampleEntity @entity(immutable: true) {
   id: ID!
   block: Bytes!
   count: BigInt!

packages/cli/src/schema.ts

@@ -42,4 +42,31 @@ export default class Schema {
       )
       .map(entity => (entity as graphql.ObjectTypeDefinitionNode).name.value);
   }
+
+  immutableEntitiesCount(): number {
+    const isImmutable = (entity: graphql.ConstDirectiveNode) => {
+      return (
+        entity.arguments?.find(arg => {
+          return (
+            (arg.name.value === 'immutable' || arg.name.value === 'timeseries') &&
+            arg.value.kind === 'BooleanValue' &&
+            arg.value.value
+          );
+        }) !== undefined
+      );
+    };
+
+    return this.ast.definitions.filter(def => {
+      if (def.kind !== 'ObjectTypeDefinition') {
+        return false;
+      }
+
+      const entity = def.directives?.find(directive => directive.name.value === 'entity');
+      if (entity === undefined) {
+        return false;
+      }
+
+      return isImmutable(entity);
+    }).length;
+  }
 }

packages/cli/src/type-generator.ts

@@ -102,6 +102,14 @@ export default class TypeGenerator {
       typeGenDebug.extend('generateTypes')('Generating types for schema');
       await this.generateTypesForSchema({ schema });
 
+      if (schema.immutableEntitiesCount() === 0) {
+        toolbox.print.warning(
+          '\nThe GraphQL schema does not take advantage of using immutable entities. ' +
+            'Immutable entities can significantly improve subgraph performance.\n' +
+            'Learn more about using immutable entities: https://thegraph.com/docs/en/subgraphs/best-practices/immutable-entities-bytes-as-ids/#immutable-entities',
+        );
+      }
+
       if (this.options.subgraphSources.length > 0) {
         const ipfsClient = createIpfsClient({
           url: appendApiVersionForGraph(this.options.ipfsUrl.toString()),

packages/cli/src/validation/schema.ts

@@ -1,4 +1,5 @@
 import fs from 'node:fs';
+import { print } from 'gluegun';
 import * as graphql from 'graphql/language/index.js';
 import immutable from 'immutable';
 import debugFactory from '../debug.js';
@@ -99,6 +100,36 @@ const validateEntityDirective = (def: any) => {
       ]);
 };
 
+const validateEntityDirectiveImmutableArgument = (def: graphql.ObjectTypeDefinitionNode) => {
+  validateDebugger('Validating immutable argument on entity directive for %s', def?.name?.value);
+
+  const entity = def.directives?.find(directive => directive.name.value === 'entity');
+  if (entity === undefined) {
+    return List();
+  }
+
+  const hasImmutableArg =
+    entity.arguments?.find(arg => arg.name.value === 'immutable') !== undefined;
+  const hasTimeseriesArg =
+    entity.arguments?.find(arg => arg.name.value === 'timeseries') !== undefined;
+
+  if (hasImmutableArg || hasTimeseriesArg) {
+    return List();
+  }
+
+  return immutable.fromJS([
+    {
+      loc: def.loc,
+      entity: def.name?.value,
+      message:
+        `@entity directive requires \`immutable\` argument\n  ` +
+        print.colors.yellow(
+          `Hint: Try updating the entity definition with: @entity(immutable: true)`,
+        ),
+    },
+  ]);
+};
+
 const validateEntityID = (def: any) => {
   validateDebugger('Validating entity ID for %s', def?.name?.value);
   const idField = def.fields.find((field: any) => field.name.value === 'id');
@@ -986,6 +1017,7 @@ const typeDefinitionValidators = {
       ? List.of(...validateSubgraphSchemaDirectives(def), ...validateTypeHasNoFields(def))
       : List.of(
           ...validateEntityDirective(def),
+          ...validateEntityDirectiveImmutableArgument(def),
           ...validateEntityID(def),
           ...validateEntityFields(defs, def),
           ...validateNoImportDirective(def),

packages/cli/tests/cli/__snapshots__/validation.test.ts.snap

@@ -932,6 +932,20 @@ Types generated successfully
 "
 `;
 
+exports[`Validation > Should require immutable argument on entity directive 1`] = `
+"- Load subgraph from subgraph.yaml
+✖ Failed to load subgraph from subgraph.yaml: Error in schema.graphql:
+
+  EntityA:
+  - @entity directive requires \`immutable\` argument
+    Hint: Try updating the entity definition with: @entity(immutable: true)
+"
+`;
+
+exports[`Validation > Should require immutable argument on entity directive 2`] = `1`;
+
+exports[`Validation > Should require immutable argument on entity directive 3`] = `""`;
+
 exports[`Validation > Source without address is valid 1`] = `
 "- Load subgraph from subgraph.yaml
 ✔ Load subgraph from subgraph.yaml

packages/cli/tests/cli/add/subgraph/schema.graphql

@@ -1,11 +1,11 @@
-type NewGravatar @entity {
+type NewGravatar @entity(immutable: true) {
   id: ID!
   owner: Bytes!
   displayName: String!
   imageUrl: String!
 }
 
-type UpdatedGravatar @entity {
+type UpdatedGravatar @entity(immutable: true) {
   id: ID!
   owner: Bytes!
   displayName: String!

packages/cli/tests/cli/validation.test.ts

@@ -247,4 +247,13 @@ describe('Validation', { concurrent: true, timeout: 60_000 }, () => {
       exitCode: 0,
     },
   );
+
+  cliTest(
+    'Should require immutable argument on entity directive',
+    ['codegen', '--skip-migrations'],
+    'validation/require-immutable-argument',
+    {
+      exitCode: 1,
+    },
+  );
 });

packages/cli/tests/cli/validation/2d-array-is-valid/schema.graphql

@@ -1,4 +1,4 @@
-type MyEntity @entity {
+type MyEntity @entity(immutable: true) {
   id: ID!
   childTokenURIs: [[String!]!]! # string[][]
 }

packages/cli/tests/cli/validation/3d-array-is-valid/schema.graphql

@@ -1,4 +1,4 @@
-type MyEntity @entity {
+type MyEntity @entity(immutable: true) {
   id: ID!
   childTokenURIs: [[[String!]!]!]! # string[][][]
 }

packages/cli/tests/cli/validation/abi-not-found/schema.graphql

@@ -1,3 +1,3 @@
-type MyEntity @entity {
+type MyEntity @entity(immutable: true) {
   id: ID!
 }

packages/cli/tests/cli/validation/big-decimal-is-valid/schema.graphql

@@ -1,4 +1,4 @@
-type MyEntity @entity {
+type MyEntity @entity(immutable: true) {
   id: ID!
   x: BigDecimal!
 }

packages/cli/tests/cli/validation/block-handler-filters/schema.graphql

@@ -1,3 +1,3 @@
-type A @entity {
+type A @entity(immutable: true) {
   id: ID!
-}
+}

packages/cli/tests/cli/validation/call-function-not-found/schema.graphql

@@ -1,3 +1,3 @@
-type MyEntity @entity {
+type MyEntity @entity(immutable: true) {
   id: ID!
 }

packages/cli/tests/cli/validation/call-handler-with-tuple/schema.graphql

@@ -1,3 +1,3 @@
-type MyEntity @entity {
+type MyEntity @entity(immutable: true) {
   id: ID!
 }

packages/cli/tests/cli/validation/conflicting-network-names/schema.graphql

@@ -1,3 +1,3 @@
-type MyEntity @entity {
+type MyEntity @entity(immutable: true) {
   id: ID!
 }

packages/cli/tests/cli/validation/conflicting-protocol-names/schema.graphql

@@ -1,3 +1,3 @@
-type MyEntity @entity {
+type MyEntity @entity(immutable: true) {
   id: ID!
 }

packages/cli/tests/cli/validation/derived-from-target-type-missing/schema.graphql

@@ -1,4 +1,4 @@
-type Foo @entity {
+type Foo @entity(immutable: true) {
   id: ID!
   bars: [Bars!]! @derivedFrom(field: "foo")
 }

packages/cli/tests/cli/validation/derived-from-with-interface/schema.graphql

@@ -1,4 +1,4 @@
-type Gravatar @entity {
+type Gravatar @entity(immutable: false) {
   id: ID!
   # This field points at an interface; we allow that a derived field
   # in a type that implements the interface derives from this field
@@ -12,7 +12,7 @@ interface Account {
   gravatars: [Gravatar!]! @derivedFrom(field: "owner")
 }
 
-type UserAccount implements Account @entity {
+type UserAccount implements Account @entity(immutable: true) {
   id: ID!
   name: String!
   gravatars: [Gravatar!]! @derivedFrom(field: "owner")