Usage with TypeORM

[joanna-liana]

HI guys, could anyone share what is the recommended config to be used with TypeoORM? I'd like to use swc for tests only (@swc/jest) but I'm getting errors like this for all TypeORM entities:

ColumnTypeUndefinedError: Column type for SomeEntityName1#columnName is not defined and cannot be guessed. Make sure you have turned on an "emitDecoratorMetadata": true option in tsconfig.json. Also make sure you have imported "reflect-metadata" on top of the main entry file in your application (before any entity imported).If you are using JavaScript instead of TypeScript you must explicitly provide a column type.

Node: v12.19.0
TypeORM version: 0.2.31
Jest: 26.6.3
swc/jest: 0.1.4

The production code works fine, so do tests with ts-jest transformer. reflect-metadata is imported once in the main file, decorators are enabled in both TS and swc configs. Here is tsconfig.json:

{
  "compilerOptions": {
    "experimentalDecorators": true,
    "target": "es5",
    "module": "commonjs",
    "allowJs": true,
    "checkJs": true,
    "outDir": "./build",
    "resolveJsonModule": true,
    "strict": true,
    "esModuleInterop": true,
    "emitDecoratorMetadata": true,
    "forceConsistentCasingInFileNames": true,
    "skipLibCheck": true,
    "lib": [
      "ESNext",
      "dom"
    ],
    "typeRoots": [
      "./src/types",
      "node_modules/@types"
    ]
  },
  "include": [
    "src/**/*.ts"
  ],
  "exclude": [
    "node_modules",
    "**/*.spec.ts"
  ]
}

And here is .swcrc:

{
  "jsc": {
    "parser": {
      "syntax": "typescript",
      "tsx": false,
      "decorators": true
    },
    "target": "es5",
    "transform": {
      "legacyDecorator": true,
      "decoratorMetadata": true
    },
    "keepClassNames": true,
    "loose": true
  },
  "env": {
    "targets": {
      "node": "12"
    }
  },
  "module": {
    "type": "commonjs",
    "strict": false,
    "strictMode": true,
    "lazy": false,
    "noInterop": false
  }
}

I've already tried a number of swc configurations but none of them work 😞 I'd really appreciate it if someone could point me in the right direction.

[silverberrylog]

[odusseys]

I'm getting the same issue as above with this config as well.

[RyannGalea]

Does SWC support 'babel-plugin-transform-typescript-metadata'? the config above showing 'decoratorMetadata' suggests it does.

Looking to try and change over to swc from babel, as there are some typing issues with babel. 'babel-plugin-transform-typescript-metadata' is the only plugin I cannot find listed on the comparison page by swc.

I'm using a typescript project with type-graphql and typegoose which face similar issues as typeorm.

[RyannGalea]

So this a feature we can expect on the next release?

Btw thank you for the prompt replies, you have made this super easy for me to try out. very impressed with the speed. Just need this one issue resolved and I can move over to SWC

[kdy1]

So this a feature we can expect on the next release?

Yes, I think I will do it.

[RyannGalea]

To clarify, the reason it's an issue with Graphql projects is that the classes we write become the endpoints. So when they are renamed it breaks the link between server and client.

Appreciate it, I will keep my eyes peeled.

[RyannGalea]

Should we create an issue for this?

[kdy1]

I think #1600 is enough

[SantiMA10]

Any news here? Can anyone share the needed configuration to make TypeORM run with swc? Thanks in advice

[wi-ski]

Following up here - is there a work around possibly?

[wi-ski]

here's my swcrc:

{
    "jsc": {
        "target": "es2020",
        "keepClassNames": true,
        "transform": {
            "legacyDecorator": true,
            "decoratorMetadata": true
        },
        "externalHelpers": false,
        "parser": {
            "syntax": "typescript",
            "tsx": true,
            "decorators": true
        },
        "paths": {
            "@/*": [
                "./*"
            ]
        },
        "baseUrl": "./",
        "loose": true
    },
    "module": {
        "type": "commonjs"
    }
}

My tsconfig:

{
  "compilerOptions": {
    "importHelpers": true,
    "removeComments": true,
    "noImplicitAny": true,
    "typeRoots": [],
    "types": [
      "node",
      "@types/jest",
      "@types/enzyme"
    ],
    "baseUrl": ".",
    "assumeChangesOnlyAffectDirectDependencies": true,
    "paths": {
      "@/server": [
        "./server"
      ],
      "@/handlers/*": [
        "./handlers/*"
      ],
      "@/handlers": [
        "./handlers"
      ],
      "@/events/*": [
        "./events/*"
      ],
      "@/events": [
        "./events"
      ],
      "@/lib/*": [
        "./lib/*"
      ],
      "@/lib": [
        "./lib"
      ],
      "@/components/*": [
        "./components/*"
      ],
      "@/components": [
        "./components"
      ],
      "@/client-state/*": [
        "./client-state/*"
      ],
      "@/client-state": [
        "./client-state"
      ],
      "@/services/*": [
        "./services/*"
      ],
      "@/services": [
        "./services"
      ],
      "@/repositories/*": [
        "./repositories/*"
      ],
      "@/repositories": [
        "./repositories"
      ],
      "@/domains": [
        "./domains"
      ],
      "@/domains/*": [
        "./domains/*"
      ],
      "@/use-cases": [
        "./use-cases"
      ],
      "@/use-cases/*": [
        "./use-cases/*"
      ],
      "@/utils": [
        "./utils"
      ],
      "@/utils/*": [
        "./utils/*"
      ],
      "@/__test-utils__/*": [
        "./__test-utils__/*"
      ],
      "@/__test-utils__": [
        "./__test-utils__"
      ],
      "@/workers/*": [
        "./workers/*"
      ],
      "@/workers": [
        "./workers"
      ]
    },
    "target": "es2017",
    "module": "CommonJS",
    "lib": [
      "dom",
      "dom.iterable",
      "esnext",
      "es5",
      "es6"
    ],
    "allowJs": true,
    "skipLibCheck": true,
    "strict": false,
    "forceConsistentCasingInFileNames": true,
    "noEmit": true,
    "esModuleInterop": true,
    "moduleResolution": "node",
    "resolveJsonModule": true,
    "isolatedModules": true,
    "jsx": "preserve",
    "emitDecoratorMetadata": true,
    "experimentalDecorators": true,
    "sourceMap": true
  },
  "include": [
    "./lib/types.ts",
    "./lib/**/*.ts",
    "./repositories/**/*.ts",
    "next-env.d.ts",
    "**/*.ts",
    "**/*.tsx"
  ],
  "exclude": [
    "build",
    "coverage",
    ".github",
    ".next",
    ".vscode",
    "*jest*",
    "coverage",
    "db-setup",
    "generator-seso-domain",
    "migrations",
    "node_modules",
    "scripts*",
    "scratch*"
  ]
}

[iannotian]

I imported reflect-metadata in each *.entity.ts file, and it gets past those ColumnTypeUndefinedErrors. Now my new issue is:

Details:

    /Users/.../class-that-is-injected-with-repository-by-nestjs.service.ts:69
        @(0, _typeorm).InjectRepository(_classThatIsInjectedWithRepositoryByNestJs.ClassThatIsInjectedWithRepositoryByNestJs)
        ^

    SyntaxError: Invalid or unexpected token

[kdy1]

Oh, it seems like a bug of swc.
Can you file an issue?

[iannotian]

Just saw this. I'll have to make a minimal repo showcasing the bug, and I'll create the issue.

[elliotaplant]

Does anyone have a working example using TypeORM and SWC?

[John98Zakaria]

Have you figured it out?

[elliotaplant]

I have not, unfortunately

[hjf]

use the decoratorMetadata: true

and wrap all your relations in Relation<>
example:

@OneTomany( ()=>DestType, dt=>dt.col)
name: DestType

to

@OneTomany( ()=>DestType, dt=>dt.col)
name: Relation<DestType>

Do this for all OneToMany, ManyToOne,OneToOne, ManyToMany...

[John98Zakaria]

I upgraded typeorm because of you to get that Relation wrapper and it finally worked !

[matheustrres]

This tip was definitely the point. Thanks for it, I did it and worked like a charm.

[John98Zakaria]

Thanks to @hjf comment I got everything running in my NestJS application.

1. I had to upgrade TypeOrm to the newest version "typeorm": "0.3.11"
2. I wrapped all my relations with Relation as mentioned above.

Here is my .swcrc

{
    "$schema": "https://json.schemastore.org/swcrc",
    "jsc": {
        "parser": {
            "syntax": "typescript",
            "tsx": false,
            "decorators": true,
            "dynamicImport": true
        },
        "transform": {
            "legacyDecorator": true,
            "decoratorMetadata": true

        },
        "target": "es2022",
        "loose": false,
        "paths": {
            "@/*": [
                "./*"
            ]
        },
        "baseUrl": "./",
        "externalHelpers": false,
        "keepClassNames": true
    },
    "module": {
        "type": "commonjs",
        "strict": true,
        "noInterop": false
    },
    "minify": false,
    "sourceMaps": true
}

I am also using it with jest where I added to my jest.config.js

transform: {
        '^.+\\.(t|j)sx?$': ['@swc/jest'],
    }

[weilinzung]

"loose": true did fix my ColumnMetadata.setEntityValue type error issue.

❌  Could not save entity
TypeError: Cannot set properties of undefined (setting 'id')