Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Check [email protected] compatibility #104

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/popular-chefs-laugh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@grammarly/focal-atom": minor
"@grammarly/focal": minor
---

Update peer dependency to include rxjs versions up to 7.x
2 changes: 1 addition & 1 deletion packages/focal-atom/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,6 @@
"typescript": "^4.7.4"
},
"peerDependencies": {
"rxjs": ">= 6.3.3 < 7.0.0-0"
"rxjs": ">= 6.3.3 < 8.0.0-0"
}
}
41 changes: 34 additions & 7 deletions packages/focal-atom/src/atom/base.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,16 @@ import { Lens, Prism, PropExpr } from './../lens'
import { Option } from './../utils'
import { structEq } from './../equals'

import { Observable, Subscriber, Subscription, BehaviorSubject, combineLatest } from 'rxjs'
import { Observable, Subscription, BehaviorSubject, combineLatest, Observer } from 'rxjs'

/** Parameters of the implementation of the overloaded `Subscribable.subscribe` method. */
type SubscribeParameters<T> = readonly [
observerOrNext?: Partial<Observer<T>> | ((value: T) => void),
] | readonly [
next?: ((value: T) => void) | null,
error?: ((error: any) => void) | null,
complete?: (() => void) | null
]

/**
* Read-only atom.
Expand Down Expand Up @@ -371,7 +380,13 @@ class LensedAtom<TSource, TDest> extends AbstractAtom<TDest> {
private _refCount = 0

// Rx method overrides
_subscribe(subscriber: Subscriber<TDest>) {
subscribe(observerOrNext?: Partial<Observer<TDest>> | ((value: TDest) => void)): Subscription
subscribe(
next?: ((value: TDest) => void) | null,
error?: ((error: any) => void) | null,
complete?: (() => void) | null
): Subscription
subscribe(...args: SubscribeParameters<TDest>) {
if (!this._subscription) {
this._subscription = this._source.subscribe(x => this._onSourceValue(x))
}
Expand All @@ -383,7 +398,7 @@ class LensedAtom<TSource, TDest> extends AbstractAtom<TDest> {
this._subscription = null
}
})
sub.add(super._subscribe(subscriber))
sub.add(super.subscribe(...(args as [Observer<TDest>])))

return sub
}
Expand Down Expand Up @@ -440,7 +455,13 @@ class AtomViewImpl<TSource, TDest> extends AbstractReadOnlyAtom<TDest> {
private _refCount = 0

// Rx method overrides
_subscribe(subscriber: Subscriber<TDest>) {
subscribe(observerOrNext?: Partial<Observer<TDest>> | ((value: TDest) => void)): Subscription
subscribe(
next?: ((value: TDest) => void) | null,
error?: ((error: any) => void) | null,
complete?: (() => void) | null
): Subscription
subscribe(...args: SubscribeParameters<TDest>) {
if (!this._subscription) {
this._subscription = this._source.subscribe(x => this._onSourceValue(x))
}
Expand All @@ -452,7 +473,7 @@ class AtomViewImpl<TSource, TDest> extends AbstractReadOnlyAtom<TDest> {
this._subscription = null
}
})
sub.add(super._subscribe(subscriber))
sub.add(super.subscribe(...(args as [Observer<TDest>])))

return sub
}
Expand Down Expand Up @@ -510,7 +531,13 @@ export class CombinedAtomViewImpl<TResult> extends AbstractReadOnlyAtom<TResult>
private _refCount = 0

// Rx method overrides
_subscribe(subscriber: Subscriber<TResult>) {
subscribe(observerOrNext?: Partial<Observer<TResult>> | ((value: TResult) => void)): Subscription
subscribe(
next?: ((value: TResult) => void) | null,
error?: ((error: any) => void) | null,
complete?: (() => void) | null
): Subscription
subscribe(...args: SubscribeParameters<TResult>) {
if (!this._subscription) {
this._subscription = combineLatest(this._sources)
.subscribe(xs => this._onSourceValues(xs))
Expand All @@ -523,7 +550,7 @@ export class CombinedAtomViewImpl<TResult> extends AbstractReadOnlyAtom<TResult>
this._subscription = null
}
})
sub.add(super._subscribe(subscriber))
sub.add(super.subscribe(...(args as [Observer<TResult>])))

return sub
}
Expand Down
4 changes: 2 additions & 2 deletions packages/focal-atom/test/atom.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -744,7 +744,7 @@ describe('atom', () => {
describe('fromObservable', () => {
test('emits atom', async () => {
const a = await Atom.fromObservable(from([1])).pipe(take(1)).toPromise()
expect(a.get()).toEqual(1)
expect(a?.get()).toEqual(1)
})

test('emits atom once', async () => {
Expand All @@ -755,7 +755,7 @@ describe('atom', () => {
from(['hello'])
).pipe(take(2), toArray()).toPromise()

expect(a[1]).toEqual('hello')
expect(a?.[1]).toEqual('hello')
})

test('does not subscribe to source immediately', () => {
Expand Down
2 changes: 1 addition & 1 deletion packages/focal/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,6 @@
"@types/react-dom": ">= 18.0.0 < 19.0.0-0",
"react": ">= 18.0.0 < 19.0.0-0",
"react-dom": ">= 18.0.0 < 19.0.0-0",
"rxjs": ">= 6.3.3 < 7.0.0-0"
"rxjs": ">= 6.3.3 < 8.0.0-0"
}
}
7 changes: 5 additions & 2 deletions packages/focal/src/react/react.ts
Original file line number Diff line number Diff line change
Expand Up @@ -606,9 +606,12 @@ export function classes(
filterClassNames(cs || []).map(x =>
// @TODO optimize: unnecessary Observable.of
// can we actually already just remove this?
!(x instanceof Observable) ? of(x) : x

// we check if x is a string because after `filterClassNames`
// it can be only a string as non-observable value; otherwise it is an `ObservableInput`
typeof x === 'string' ? of(x) : x
),
(...cs: ClassNameLike[]) => {
(...cs) => {
const filtered = filterClassNames(cs || [])

return filtered.length > 0
Expand Down