Releases: facebook/relay
v1.7.0-rc1
1.7.0-rc.1
This release doesn't contain many commits, but comes with two exciting additions from external contributors:
Language Plugins
While we at Facebook only support JS and Flow flavored JS and generate optional Flow types, supporting TypeScript had been difficult. #2293 by @alloy does the required refactoring to allow other developers to write plugins to add this missing support.
Create React App support
Create React App tries to minimize dependencies, so including Relay's Babel plugin for everyone didn't make much sense. This meant that using Relay with Create React App wasn't possible without ejecting.
This release adds babel-plugin-relay/macro
(@apalm, #2171) which in the upcoming react-scripts@2.0.0
will make it possible to use Relay without ejecting powered by babel-plugin-macros
.
Added
- Support for language plugins (@alloy, #2293)
- Support for babel-plugin-macros (@apalm, #2171)
- Updated to babel@7.0.0-beta.56 to extract GraphQL strings for the compiler
- Pagination and Refetch containers now warn when a request is triggered when they're unmounted. (@alunyov)
Fixed
- Fix double fetch in React Async development mode (@flarnie)
relay-compiler
is no longer a peerDependency ofrelay-runtime
as it's not needed during deployment. Make sure to keep all Relay packages at the same version! (@kassens)
Removed
- Removed long deprecated
RelayNetwork.streamQuery
andRelayNetwork.sendSubscription
v1.6.2
v1.6.1
Commits: v1.6.0...master
Potentially Breaking:
- Bump
graphql
peer dependency to^0.13.0
- Use
React.forwardRef
. This is a breaking change for people relying on therelayContainer.refs.component
implementation detail.
New:
- Introduce
@relay
(mask: false)
directive for fragment *definitions: *Applied to a fragment definition, @relay(mask: false)
changes the generated Flow types to be more usable when the fragment is spread with the same directive; The Flow types will no longer be exact objects and no longer contain internal marker fields.
Fixed:
- Fix pagination after using
refetchConnection
in Pagination Container - Use aliases for __typename generated fields in the union (#2465)
- Fix issue in React Async mode where container would render inconsistent data if rendering was interrupted.
RelayConnectionHandler
now properly writespage_info
after refetching a connection- Fix issue where
RelayContainerUtils
didn't recognizeReact.forwardRef
asReact.Component
- Properly guard agains errors thrown inside
mutation
orsubscription
updater functions
Improved:
- De-hastify
relay-runtime
, set main entry in relay-runtimepackage.json
. dedupeJSONStringify
is now more effective- Speed up
relay-compiler
by caching client schema extensions. - Expose
applyOptimisticUpdate
on RelayModern. relay-compiler
can now compile JS files withoptionalChaining
syntax.relay-compiler
can now compile JS files withnullishCoalescingOperator
syntax.relay-compiler
can now compile JS files withoptionalCatchBinding
syntax.relay-compiler
has better warnings when required variables are not passed in.relay-compiler
now generates operation Flow types: 5d83328.- Bump
fbjs
dependency to0.8.17
. - Bump
fast-glob
dependency to2.2.2
. - Several documentation improvements.
v1.6.0
1.6.0
Commits: v1.5.0...v1.6.0
Breaking:
- The minimum React dependency was raised to
^16.3.0
Potentially Breaking:
- Remove some usages of deprecated React lifecycle methods and changes to make containers React Async safe.
- Remove support for legacy
__type__
fields - Remove support for parsinglegacy interfaces(51c5761)
Fixed:
- Make
jest --watch
work with React 16 - Fix flow type generation for recursive Input types
Improved:
- Move
graphql-compiler
out ofrelay-compiler
as its own independent package - Make
graphql
a peer dependency - Upgrade
graphql-js
to v0.13.2 - Support batch queries in Refetch and Pagination containers
relay-compiler
: Makes flow generated'%future added value'
for enums optional
v1.5.0
This release introduces several changes, some of the most relevant ones are highlighted here.
New:
- Relay Containers are now Flow typed, however Flow types are not yet exported (#2284).
- Relay Compiler now generates Flow types for GraphQL enum values.
- Add undocumented support for client-only schema extensions using
.graphql
files. Extensions only work on existing types, and does not currently support adding client-only types to the schema. - Add experimental and undocumented support for QueryRenderer to render directly from store if data is available using new
dataFrom
prop. - Add hooks to enable and disable Relay GC in the store.
- New
ConcreteNode
format supporting Batch requests.
Potentially Breaking:
- Support for client-only schema extensions requires that your GraphQL schema not be inside your the directory you specify as
src
to therelay-compiler
(#2346). - Changes the type of
RelayNetwork.execute
to return aRelayObservable
withvariables
andnode
, in addition to theQueryPayload
. However,RelayNetwork.create
maintains the same API (c058ffc).
Fixed:
- Fix passing a single item to a "list" input argument (42c1119).
- Fix end cursor when fetch returned zero edges in Pagination Container (a17b462).
- No longer throw false alarm error in
RelayConcreteVariables
(0398585). - Properly handle complex GraphQL argument literals in the compiler (bb02769).
- Calling viewer handler multiple times should not accidentally cause viewer to be null (f442fcd).
- Fix issue when using multiple connectionInfo for
RANGE_ADD
mutation (7f2013d). - Fix issue in Relay Compiler when parsing non-null input (4baa970).
- Fix pagination on empty connections (62c8b43).
Improved:
- Ensure the Relay build has run and is not using outdated GraphQL fragments. Optionally this can be turned off in the babel plugin settings (a628637).
- Update all callers of react-relay to use CommonJS requires.
- Speed up
getIdentifierForSelection
. - Compiler doesn't warn on missing fields with abstract types anymore.
- Relay Compiler now de-duplicates identical objects when generating JSON artifacts which decreases size of artifacts and improves compressability.
- Disable
NoFragmentCyclesRule
; can now use Fragments recursively. - Remove
RecordSourceInspector
which is of marginal value, especially now that we have a useful devtools app. - Print timing information in compiler —verbose mode.
- Add option to Compiler to be
—quiet
. - Upgrade to graphql-js v0.13.0.
- Upgrade to latest version of fast-glob.
- Upgrade to babylon7 in Relay Compiler to support new JSX Fragment syntax.
- Remove
graphql.experimental
. - Several Flow typing improvements.
- Several documentation fixes.
- Move test utils to their own package: relay-test-utils.
- Add support for accessing Components wrapped in a Container in tests.
- Use jest snapshots for relay-compiler tests.
v1.4.1
v1.4.0
New:
- Full support for returning Observable from Relay Network implementations. Use
const {Observable} = require('relay-runtime')
to use Relay's lightweight Observable implementation which seeks to follow the Observable specification. - Support for the new Relay DevTools beta (install with
yarn add relay-devtools
) (86b63d4) - Support for latest version of Flow
- Deprecated
graphql.experimental
All features now supported directly ingraphql
literal tags. (9afd764) - Pagination container now accepts an
Observer
when loading more data (ef7aa5b)
Potentially Breaking:
- Relay Network and Environment internal APIs renamed to
execute()
andexecuteMutation()
(0202673) - Removed legacy flow type generation (8cf10b9)
Fixed:
- Case where callback might not be called after mutation (980de6d)
- Improved printing of queries with
@include
in classic/compat mode (d652911) - Improved error messages (d8eb6d4)
- Fix case where compiler might not place
__typename
andid
in the correct order (95319d1) - Fix deferred queries when root arguments are not of type ‘ID’ (5ac9271)
- Fixed remaining issues for compatibility with React v16.
- Fix passing default arguments to
@arguments
in compat mode (1ce348a) - Fix issues in QueryRenderer when queries resolve synchronously and immediately (87bfc91)
- Fix case where
@argumentDefinitions
would not be validated first (50803a5) - Change readyState to getDefaultState value after retry (beaf5c2)
v1.3.0
A small update since 1.2.0 that mainly exposes a few new internals.
New:
graphql
tags now supportnull
literal values (@nkohari e7962fb)- Refactored
RelayEnvironment
to use Observables instead of Promises to prepare for streaming and other advanced usages (@leebyron) - Expose
formatGeneratedModule
onrelay-compiler
to allow more customization of the compiler (@robrichard 7b44013) - New CLI flag
--validate
torelay-compiler
to validate without writing files (@ajhyndman af35c30) RelayConnectionInterface
is now injectable for legacy clients (@kassens d9c1eb0)
Fixed:
- Various documentation fixes (@mattleff)
- Some exceptions in the compiler were only printing to console, but not causing an error code (@kassens 14e28dd)
RelayRecordProxy#setValue
now accepts arrays of scalar values (@kassens 7a2b27e)- Removed
eslint-config-fbjs
dependency fromrelay-compiler
(@mwalkerwells 7b914f0)
v1.2.0
In addition to all of the changes in v1.2.0-rc1, v1.2.0 includes:
New:
- Unmasked fragment spreads introduced in the RC have been renamed from
@inline
to@relay(mask: false)
(c7235ab) and can be used in both Relay modern and Relay compat (20327fd) - Full queries are generated in development builds for easier debugging (9a81b3f)
- Relay compiler now allows disabling watchman for typical builds (@robrichard 4f80e02)
- No longer explicitly need to include
pageInfo
when using pagination controllers (9686119) - Experimental support for returning Observable from provided fetch and subscribe Network functions (bfc7f7f)
Fixed:
- Ensure Relay compiler generates the right kinds (db6ef37)
- Edge cases when Network cache returns synchronously (2ffb5c6)
- Incorrect error handling in Networking (63ca3ae)
- Ensure logging for each response from a GraphQL Subscription (777bcf6)
- Ensure the same edge is not added twice during pagination (d0aff0f)
Improved:
- Full support for React v16
- Support root level types that aren't named "Query" in Relay Compat (@robrichard 1544f59)
- Improved generated flow types (0d4cf95)
- Support for customized logging (a82a417)
- Included a
peerDep
between relay-runtime and relay-compiler to create early warnings if dependencies are misaligned (2582646) - Support for flow types for custom scalars (9488a51)
v1.2.0-rc.1
This release is another massive collection of some exciting new features, fixed bugs and improved error messages and warnings. Thanks to our external contributors, summer interns and anyone helping with code or bug reports.
New
- Experimental
@inline
directive to inline fragments verbatim for use in utility functions (1b19ee0) - The compiler now supports
--exclude
and--include
for more control over what files are parsed (94c8b20) - PaginationContainer can now refetch with new variables, useful for server filtered, paginated lists (6bc9127)
Fixed
- Relay context is set correctly inside pagination containers (@pranaygp, b09bba4)
- Fixed an issue where fragments didn't update correctly when the last item of a plural field was deleted (08336c6)
- Fixed a bug where query files weren't re-generated if only the flow type changed (697c6ee)
Improved
- Faster parsing in the compiler by caching the extracted
graphql
tags (7e1065f) - Improved error handling in the compiler (cb7680f)
- The callback to
loadMore
andrefetch
of the pagination and refetch container is now consistently called after render (e316b6e) - The compiler now parses
.js.flow
files (3e0266c) - A new warning on pagination container helps avoid bugs (3fe68c8)
- Better error when unknown directories are inside the generated output directories (9766201)
- Line numbers of parse errors are now correct (ca15340)
- Updated graphql dependency to
^0.10.5
(beba407)