graphql-engine/.hlint.yaml

285 lines
12 KiB
YAML
Raw Normal View History

# HLint configuration file
# https://github.com/ndmitchell/hlint
##########################
# This file contains a template configuration file, which is typically
# placed as .hlint.yaml in the root of your project
# Specify additional command line arguments
#
# - arguments: [--color, --cpp-simple, -XQuasiQuotes]
- arguments: -XQuasiQuotes
# Control which extensions/flags/modules/functions can be used
#
# - extensions:
# - default: false # all extension are banned by default
# - name: [PatternGuards, ViewPatterns] # only these listed extensions can be used
# - {name: CPP, within: CrossPlatform} # CPP can only be used in a given module
#
# - flags:
# - {name: -w, within: []} # -w is allowed nowhere
#
# - modules:
# - {name: [Data.Set, Data.HashSet], as: Set} # if you import Data.Set qualified, it must be as 'Set'
# - {name: Control.Arrow, within: []} # Certain modules are banned entirely
#
# - functions:
# - {name: unsafePerformIO, within: []} # unsafePerformIO can only appear in no modules
- functions:
- name: "Test.Hspec.focus"
within: []
message: "Specs with focusing should only be used during development"
- name: "Test.Hspec.fit"
within: []
message: "Specs with focusing should only be used during development"
- name: "Test.Hspec.fspecify"
within: []
message: "Specs with focusing should only be used during development"
- name: "Test.Hspec.fdescribe"
within: []
message: "Specs with focusing should only be used during development"
- name: "Test.Hspec.fcontext"
within: []
message: "Specs with focusing should only be used during development"
- name: "Harness.TestEnvironment.testLogHarness"
within: []
message: "testLogHarness should only be ad-hoc during development. Please define proper log message data types for published code"
- name: "Harness.Logging.LogHarness"
within: []
message: "LogHarness should only be ad-hoc during development. Please define proper log message data types for published code"
- name: "Harness.Logging.Messages.LogHarness"
within: []
message: "LogHarness should only be ad-hoc during development. Please define proper log message data types for published code"
- name: "Harness.TestEnvironment.testLogTrace"
within: ["Test.**"]
message: "testLogTrace should only be used outside the test-harness package"
- name: "Harness.Logging.LogTrace"
within: ["Test.**"]
message: "LogTrace should only be used outside the test-harness package"
- name: "Harness.Logging.Messages.LogTrace"
within: ["Test.**"]
message: "LogTrace should only be used outside the test-harness package"
- name: "Harness.Logging.logTrace"
within: ["Test.**"]
message: "logTrace should only be used outside the test-harness package"
- name: "Harness.Logging.Messages.logTrace"
within: ["Test.**"]
message: "logTrace should only be used outside the test-harness package"
# Add custom hints for this project
#
# Will suggest replacing "wibbleMany [myvar]" with "wibbleOne myvar"
# - error: {lhs: "wibbleMany [x]", rhs: wibbleOne x}
# Turn on hints that are off by default
#
# Ban "module X(module X) where", to require a real export list
# - warn: {name: Use explicit module export list}
#
# Replace a $ b $ c with a . b $ c
# - group: {name: dollar, enabled: true}
#
# Generalise map to fmap, ++ to <>
# - group: {name: generalise, enabled: true}
# Ignore some builtin hints
# - ignore: {name: Use let}
# - ignore: {name: Use const, within: SpecialModule} # Only within certain modules
- ignore: {name: Reduce duplication}
- ignore: {name: Redundant $}
- ignore: {name: Redundant bracket}
- ignore: {name: Use fmap}
- ignore: {name: Use first}
- ignore: {name: Use if}
- ignore: {name: Redundant <$>}
- ignore: {name: Use ++}
- ignore: {name: Use const}
- ignore: {name: Eta reduce}
- ignore: {name: Redundant multi-way if}
- ignore: {name: Use newtype instead of data}
- ignore: {name: Use bimap}
- ignore: {name: Use fromRight}
- ignore: {name: Use $>}
- ignore: {name: Use <$>}
- ignore: {name: "Use ?~"}
- ignore: {name: Use <=<}
- ignore: {name: Use sequenceA}
- ignore: {name: Use camelCase}
- ignore: {name: Redundant return}
- ignore: {name: Use <$>, within: [Hasura.RQL.DDL.Metadata, Hasura.Backends.MSSQL.Types.Instances]}
- ignore: {name: Functor law, within: Hasura.Server.AuthSpec}
- ignore: {name: Use underscore} # suggests to format port numbers
# These three need to be disabled under 'simplified subsumption' unfortunately.
# If we want to use -XDeepSubsumption these can be reenabled and lints fixed
# See: https://github.com/mpickering/ghc-proposals/blob/deep-subsumption/proposals/0000-deep-subsumption.rst
- ignore: {name: Avoid lambda}
- ignore: {name: Redundant lambda}
- ignore: {name: Avoid lambda using `infix`}
# Define some custom infix operators
# - fixity: infixr 3 ~^#^~
# To generate a suitable file for HLint do:
# $ hlint --default > .hlint.yaml
- error: {lhs: maybe False, rhs: any}
- error: {lhs: maybe True, rhs: all}
- error: {lhs: either (const False), rhs: any}
- error: {lhs: either (const True), rhs: all}
- suggest: {lhs: onJust, rhs: for_}
- group:
name: hasura-prelude
enabled: true
imports:
- package base
rules:
- error: {lhs: "a == []", rhs: "null a"}
- error: {lhs: "a /= []", rhs: "not (null a)"}
- error: {lhs: "maybe b return a", rhs: "onNothing a b"}
- error: {lhs: "maybe b pure a", rhs: "onNothing a b"}
- error: {lhs: "maybe (return ()) b a", rhs: "for_ a b"}
- error: {lhs: "maybe (pure ()) b a", rhs: "for_ a b"}
- error: {lhs: "either b return a", rhs: "onLeft a b"}
- error: {lhs: "either b pure a", rhs: "onLeft a b"}
- error: {lhs: "maybe (f x) f", rhs: "f . fromMaybe x"}
- error: {lhs: "maybe (f x) f", rhs: "f . fromMaybe x"}
- error: {lhs: "either (f . g) (f . h)", rhs: "f . either g h"}
- error: {lhs: "either (f . g) (f . h)", rhs: "f . either g h"}
- error: {lhs: "onNothing x (return y)", rhs: "return (fromMaybe y x)"}
- error: {lhs: "onNothing x (pure y)", rhs: "pure (fromMaybe y x)"}
- error: {lhs: "onLeft x (return . f)", rhs: "return (either f id x)"}
- error: {lhs: "onLeft x (pure . f)", rhs: "pure (either f id x)"}
- error: {lhs: "case x of {Right a -> pure a; Left c -> d}", rhs: "onLeft x (\\ c -> d)"}
- error: {lhs: "case x of {Left c -> d; Right a -> pure a}", rhs: "onLeft x (\\ c -> d)"}
- error: {lhs: "case x of {Right a -> return a; Left c -> d}", rhs: "onLeft x (\\ c -> d)"}
- error: {lhs: "case x of {Left c -> d; Right a -> return a}", rhs: "onLeft x (\\ c -> d)"}
- error: {lhs: "case x of {Nothing -> a; Just b -> pure b}", rhs: "onNothing x a"}
- error: {lhs: "case x of {Just b -> pure b; Nothing -> a}", rhs: "onNothing x a"}
- error: {lhs: "case x of {Nothing -> a; Just b -> return b}", rhs: "onNothing x a"}
- error: {lhs: "case x of {Just b -> return b; Nothing -> a}", rhs: "onNothing x a"}
- error: {lhs: "if x then pure (); else y", rhs: "unless x y"}
- error: {lhs: "if x then return (); else y", rhs: "unless x y"}
- error: {lhs: "if x then y; else pure ()", rhs: "when x y"}
- error: {lhs: "if x then y; else return ()", rhs: "when x y"}
- error: {lhs: "unless (not x)", rhs: "when x"}
- error: {lhs: "when (not x)", rhs: "unless x"}
Avoid GraphQL schema rebuild when changing irrelevant Metadata This increases the speed of `create_query_collection` and `add_collection_to_allowlist` by a factor ~~10~~ 65, by caching the in-memory GraphQL schema. This speedup also applies more broadly to Metadata changes relating to: - allowlists - query collections - cron triggers - REST endpoints - API limits - metrics config - GraphQL introspection options - TLS allow lists - OpenTelemetry When is construction of the in-memory GraphQL schema cached between Metadata operations? Before this PR, **never**! It's rebuilt fully, for every role, on every Metadata operation. However, there are many Metadata operations that don't influence the GraphQL schema. So we should be caching its construction. The `Hasura.Incremental` framework allows us to cache such constructions: whenever we have an arrow `Rule m a b`, where `a` is the input to the arrow and `b` the output, we can use the `Inc.cache` combinator to obtain a new arrow which is only re-executed when the input `a` changes in a material way. To test this, `a` needs an `Eq` instance. (Before hasura/graphql-engine-mono#6877, this was a `Cacheable` type class which has now been removed.) We can't simply apply `Inc.cache` to the "Steps 3 and 4" in `buildSchemaCacheRule`, because the inputs (components of `BuildOutputs` such as `SourceCache`) don't have an `Eq` instance. So the changes to `buildSchemaCacheRule` restructure the code so that the input to "Step 1", namely the Metadata, can be used as a caching key instead, so that `Inc.cache` can be applied to the whole sequence of steps. That works to cache construction of the GraphQL schema, but it means that now only those Metadata operations that _don't_ influence any of the products of steps 1-4 can use a cached build of the GraphQL schema. The most important intermediate product is `BuildOutputs`. So now the exercise becomes to minimize the amount of stuff stored in `BuildOutputs`, so that as many Metadata operations as possible can be handled outside of the codepath that produces a GraphQL schema. Per hasura/graphql-engine-mono#6609, the `BuildOutputs` structure is too big, and stores things unnecessarily. Refer to the PR description there for reasoning - the same logic applies to this PR, and simply goes a few steps further. In doing so, it can benefit from hasura/graphql-engine-mono#6765, which allows us to verify at compile time that certain Schema Cache building steps _don't_ generate "Metadata dependencies". If a certain Metadata dependency is never generated, we don't need to handle that case in `deleteMetadataObject`. Thus such intermediate products don't need to be passed through `resolveDependencies`, and thus they don't need to be stored in `BuildOutputs`, and thus their rebuild won't trigger a GraphQL schema rebuild. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/6613 GitOrigin-RevId: 27d2e69d3461bd4c32f08febef9995c0369fab3a
2022-11-22 15:11:32 +03:00
- error: {lhs: "arr id", rhs: "returnA"}
- suggest: {lhs: "not x && not y", rhs: "not (x || y)"}
- suggest: {lhs: "not x || not y", rhs: "not (x && y)"}
- error: {lhs: "Data.Text.pack (Prelude.show x)", rhs: "Hasura.Prelude.tshow x"}
- error: {lhs: "map f xs == map f ys", rhs: "liftEq ((==) `on` f)", note: "This is liable to be faster"}
- suggest: {lhs: "fmap f xs == fmap f ys", rhs: "liftEq ((==) `on` f)", note: "This is liable to be faster"}
# mapKeys:
- error: {lhs: "Data.HashMap.Strict.Extended.fromList . map (first f) . Data.HashMap.Strict.Extended.toList", rhs: "mapKeys f"}
- error: {lhs: "Data.HashMap.Strict.fromList . map (first f) . Data.HashMap.Strict.toList", rhs: "mapKeys f"}
- error: {lhs: "Data.HashMap.Strict.Extended.fromList $ map (first f) $ Data.HashMap.Strict.Extended.toList x", rhs: "mapKeys f x"}
- error: {lhs: "Data.HashMap.Strict.fromList $ map (first f) $ Data.HashMap.Strict.toList x", rhs: "mapKeys f x"}
# MaybeT
- error: {lhs: "MaybeT (pure x)", rhs: "hoistMaybe x"}
- error: {lhs: "MaybeT (return x)", rhs: "hoistMaybe x"}
- error: {lhs: "MaybeT (pure Nothing)", rhs: "Control.Applicative.empty"}
- error: {lhs: "MaybeT (return Nothing)", rhs: "Control.Applicative.empty"}
# catMaybes
- error: {lhs: "Data.HashMap.Strict.mapMaybe id", rhs: "Data.HashMap.Strict.Extended.catMaybes"}
- error: {lhs: "Data.HashMap.Strict.Extended.mapMaybe id", rhs: "Data.HashMap.Strict.Extended.catMaybes"}
- error: {lhs: "Data.HashMap.Strict.InsOrd.mapMaybe id", rhs: "Data.HashMap.Strict.InsOrd.Extended.catMaybes"}
- error: {lhs: "Data.HashMap.Strict.InsOrd.Extended.mapMaybe id", rhs: "Data.HashMap.Strict.InsOrd.Extended.catMaybes"}
- error: {lhs: "Data.IntMap.Strict.mapMaybe id", rhs: "Data.HashMap.Strict.Extended.catMaybes"}
- error: {lhs: "Data.IntMap.Strict.Extended.mapMaybe id", rhs: "Data.HashMap.Strict.Extended.catMaybes"}
- group:
name: data-text-extended
enabled: true
imports:
- package base
rules:
- error: {lhs: "Data.Text.intercalate \", \" x", rhs: "commaSeparated x", note: "From Data.Text.Extended"}
- error: {lhs: "Data.Text.Extended.intercalate \", \" x", rhs: "commaSeparated x"}
- group:
name: mssql-transaction
enabled: true
imports:
- package base
rules:
- error: {lhs: "Database.MSSQL.runTxE id tx pool", rhs: "Database.MSSQL.runTx tx pool"}
- error: {lhs: "Database.MSSQL.unitQueryE id q", rhs: "Database.MSSQL.unitQuery q"}
- error: {lhs: "Database.MSSQL.singleRowQueryE id tx pool", rhs: "Database.MSSQL.singleRowQuery tx pool"}
- error: {lhs: "Database.MSSQL.multiRowQueryE id tx pool", rhs: "Database.MSSQL.multiRowQuery tx pool"}
- group:
name: unsafe
enabled: true
imports:
- package base
rules:
- error: {lhs: "Language.GraphQL.Draft.Syntax.unsafeMkName", rhs: "Language.GraphQL.Draft.Syntax.mkName", note: "avoid unsafeMkName if possible"}
- error: {lhs: "Control.Concurrent.threadDelay", rhs: "Control.Concurrent.Extended.sleep", note: "Please use `sleep` instead (and read the docs!)"}
- suggest: {lhs: "Control.Concurrent.Async.Lifted.Safe.async", rhs: "Control.Concurrent.Async.Lifted.Safe.withAsync", note: "Please use 'Control.Control.Concurrent.Async.Lifted.Safe.withAsync' or our 'forkImmortal' instead for more robust threading."}
- suggest: {lhs: "Control.Concurrent.forkIO", rhs: "Control.Concurrent.Async.Lifted.Safe.withAsync", note: "Please use 'Control.Control.Concurrent.Async.Lifted.Safe.withAsync' or our 'forkImmortal' instead for more robust threading."}
- suggest: {
lhs: "System.Environment.getEnvironment",
rhs: "env_from_function_argument",
note: "Instead of 'getEnvironment', use the environment from the server context, typically accessible as a function argument"
}
- suggest: {
lhs: "Data.Environment.getEnvironment",
rhs: "env_from_function_argument",
note: "Instead of 'getEnvironment', use the environment from the server context, typically accessible as a function argument"
}
- ignore: {
group: {name: "unsafe"},
within: ["Harness.**", "Spec", "Spec.**", "SpecHook", "Test.**"]
}
# Glorious import restrictions
# We limit the place where the module `Hasura.RQL.Types.Instances` can be
# imported in order to make it easier to avoid module cycles.
#
# This check is initially quite limited, and will need to be extended to cover
# other instance-defining modules as well:
#
# * RQL.Types.Metadata.Instances
# * Hasura.GraphQL.Transport.Instances
# * Hasura.GraphQL.Execute.Instances
# * Hasura.GraphQL.Schema.Instances
# * Hasura.Server.API.Instances
# * Hasura.RQL.Types.SchemaCache.Instances
- modules:
- name: Hasura.RQL.Types.Instances
within: [
Hasura.RQL.IR.Select,
Hasura.RQL.Types.Metadata.Object,
Hasura.RQL.Types.Relationships.Remote,
Hasura.RQL.Types.SchemaCacheTypes,
Hasura.RQL.Types.Source,
Hasura.GraphQL.Schema.Build.UpdateSpec
]