Merge pull request #899 from effector/deprecate-get-type

Deprecate `getType`

packages/effector/index.d.ts

@@ -142,6 +142,9 @@ export interface Event<Payload> extends Unit<Payload> {
    * @deprecated use js pipe instead
    */
   thru<U>(fn: (event: Event<Payload>) => U): U
+  /**
+   * @deprecated use .compositeName.fullName instead
+   */
   getType(): string
   compositeName: CompositeName
   sid: string | null
@@ -188,6 +191,9 @@ export interface Effect<Params, Done, Fail = Error> extends Unit<Params> {
   map<T>(fn: (params: Params) => T): EventAsReturnType<T>
   prepend<Before>(fn: (_: Before) => Params): Event<Before>
   subscribe(observer: Observer<Params>): Subscription
+  /**
+   * @deprecated use .compositeName.fullName instead
+   */
   getType(): string
   compositeName: CompositeName
   sid: string | null
@@ -344,6 +350,9 @@ export class Domain implements Unit<any> {
   sid: string | null
   compositeName: CompositeName
   shortName: string
+  /**
+   * @deprecated use .compositeName.fullName instead
+   */
   getType(): string
   history: {
     domains: Set<Domain>

src/effector/__tests__/domain.test.ts

@@ -10,6 +10,19 @@ import {
 } from 'effector'
 import {argumentHistory} from 'effector/fixtures'
 
+const originalConsoleError = console.error
+
+beforeAll(() => {
+  console.error = (message, ...args) => {
+    if (String(message).includes('getType')) return
+    originalConsoleError(message, ...args)
+  }
+})
+
+afterAll(() => {
+  console.error = originalConsoleError
+})
+
 describe('domain hooks', () => {
   test('domain.onCreateEvent(fn)', () => {
     const fn = jest.fn()

src/effector/__tests__/effect/name.test.ts

@@ -1,5 +1,18 @@
 import {createEffect, createDomain} from 'effector'
 
+const originalConsoleError = console.error
+
+beforeAll(() => {
+  console.error = (message, ...args) => {
+    if (String(message).includes('getType')) return
+    originalConsoleError(message, ...args)
+  }
+})
+
+afterAll(() => {
+  console.error = originalConsoleError
+})
+
 test("should return it's own name on effect.getType()", () => {
   expect(createEffect('foo').getType()).toBe('foo')
   expect(createEffect('foo', {name: 'bar'}).getType()).toBe('foo')

src/effector/__tests__/event/name.test.ts

@@ -1,5 +1,18 @@
 import {createEvent, createDomain} from 'effector'
 
+const originalConsoleError = console.error
+
+beforeAll(() => {
+  console.error = (message, ...args) => {
+    if (String(message).includes('getType')) return
+    originalConsoleError(message, ...args)
+  }
+})
+
+afterAll(() => {
+  console.error = originalConsoleError
+})
+
 test("should return it's own name on event.getType()", () => {
   expect(createEvent('foo').getType()).toBe('foo')
   expect(createEvent({name: 'foo'}).getType()).toBe('foo')

src/effector/__tests__/naming.test.ts

@@ -1,4 +1,5 @@
 import {createEvent, createStore, createDomain, combine, sample} from 'effector'
+import {argumentHistory} from 'effector/fixtures'
 import {unitObjectName} from '../naming'
 
 const rootDomain = createDomain('')
@@ -114,3 +115,21 @@ describe('sample support', () => {
     expect(sampled.shortName).toBe('foo')
   })
 })
+
+describe('getType deprecation', () => {
+  const fn = jest.fn()
+  const originalConsoleError = console.error
+  beforeEach(() => {
+    console.error = fn
+  })
+  afterEach(() => {
+    console.error = originalConsoleError
+  })
+  test('getType deprecation', () => {
+    const event = createEvent()
+    event.getType()
+    expect(argumentHistory(fn)[0]).toMatchInlineSnapshot(
+      `"getType is deprecated, use compositeName.fullName instead"`,
+    )
+  })
+})

src/effector/createEffect.ts

@@ -92,7 +92,11 @@ export function createEffect<Params, Done, Fail = Error>(
     scope: {
       handler:
         instance.defaultConfig.handler ||
-        (() => assert(false, `no handler used in ${instance.getType()}`)),
+        (() =>
+          assert(
+            false,
+            `no handler used in ${instance.compositeName.fullName}`,
+          )),
     },
     node: [
       calc(

src/effector/createUnit.ts

@@ -78,7 +78,10 @@ export const initUnit = (kind: Kind, unit: any, rawConfig: any) => {
     deprecate(false, 'thru', 'js pipe')
     return fn(unit)
   }
-  unit.getType = () => compositeName.fullName
+  unit.getType = () => {
+    deprecate(false, 'getType', 'compositeName.fullName')
+    return compositeName.fullName
+  }
   if (!isDomain) {
     unit.subscribe = (observer: Subscriber<any>) => {
       assertObject(observer)