[BUG]: Method .returning() working incorrect with .get() method

[Bulbang]

What version of drizzle-orm are you using?

0.17.4

Describe the Bug

Method .returning() is not working properly with method .get()

Full context you can find in these files:

schema.ts
SqliteJson.ts

schema.ts

import { sql } from 'drizzle-orm'
import { sqliteTable, integer, text } from 'drizzle-orm/sqlite-core'
import { json } from './SqliteJson'

export const articles = sqliteTable('articles', {
    id: integer('id').primaryKey(),
    slug: text('slug').notNull(),
    title: text('title').notNull(),
    meta_title: text('meta_title').notNull(),
    meta_description: text('meta_description').notNull(),
    blocks: json<{ [key: string]: unknown }>('blocks').notNull(),
    created_at: integer('created_at', { mode: 'timestamp' }).notNull(),
    updated_at: integer('updated_at', { mode: 'timestamp' }).notNull(),
    file_id: text('file_id'),
    hidden: integer('hidden').default(0),
    podcasts: json<{ [url: string]: string }>('podcasts').default(sql`NULL`),
})

SqliteJson.ts

import { ColumnConfig } from 'drizzle-orm'
import { AnySQLiteTable } from 'drizzle-orm/sqlite-core'
import {
    SQLiteColumn,
} from 'drizzle-orm/sqlite-core/columns'
import { ColumnBuilderConfig } from 'drizzle-orm/column-builder'
import { SQLiteColumnBuilder } from 'drizzle-orm/sqlite-core/columns/common';

export class SQLiteJsonBuilder<
    TData,
> extends SQLiteColumnBuilder<
    ColumnBuilderConfig<{ data: TData; driverParam: string }>
> {
    // protected override $sql!: 'SQLiteJsonBuilder';
    build<TTableName extends string>(
        table: AnySQLiteTable<{ name: TTableName }>,
    ): SQLiteJson<TTableName, TData> {
        return new SQLiteJson(table, this.config)
    }
}

export class SQLiteJson<
    TTableName extends string,
    TData,
> extends SQLiteColumn<
    ColumnConfig<{ tableName: TTableName; data: TData; driverParam: string }>
> {
    protected override $sqliteColumnBrand!: 'SQLiteJson'

    constructor(
        table: AnySQLiteTable<{ name: TTableName }>,
        builder: SQLiteJsonBuilder<TData>['config'],
    ) {
        super(table, builder)
    }

    getSQLType(): string {
        return 'json'
    }

    override mapFromDriverValue(value: string): TData {
        if (typeof value === 'string') {
			try {
				return JSON.parse(value);
			} catch (e) {
				return value as unknown as TData;
			}
		}
		return value;
    }

    override mapToDriverValue(value: TData): string {
        return JSON.stringify(value)
    }
}

export const json = <T>(name: string) => {
    return new SQLiteJsonBuilder<T>(name)
}

Code with bug

const newArticle = {
    title: 'no-img2',
    meta_title: 'biba',
    meta_description: 'sadasd',
    blocks: {
        props: {},
    },
    slug: 'cvbcvbc',
    created_at: new Date(),
    updated_at: new Date(),
}

const query = database
    .insert(articles)
    .values(newArticle)
    .returning()

const result = query.get()
console.log(result);

Log:

{
  id: undefined,
  slug: undefined,
  title: undefined,
  meta_title: undefined,
  meta_description: undefined,
  blocks: undefined,
  created_at: Invalid Date,
  updated_at: Invalid Date,
  file_id: undefined,
  hidden: undefined,
  podcasts: undefined
}

But when I changed const result = query.get() to const result = query.all() it seems to be working well

Log with .all() method:

[
  {
    id: 26,
    slug: 'cvbcvbc',
    title: 'no-img2',
    meta_title: 'biba',
    meta_description: 'sadasd',
    blocks: { props: {} },
    created_at: 2023-02-03T08:57:41.430Z,
    updated_at: 2023-02-03T08:57:41.430Z,
    file_id: null,
    hidden: 0,
    podcasts: null
  }
]

[Sandy-Garrido]

I can confirm, I was also seeing this issue! I have to .all()[0] for the equivalent

[AndriiSherman]

@Bulbang @Sandy-Garrido this issue was fixed and released in 0.17.7

Have added additional test cases for .returning().get() mappings, you can check them here

Please confirm it's worked for you and I'll close this issue

[Sandy-Garrido]

Hmm 🤔 it doesn't look to have been fixed. I triple checked the version etc.

export const createApiKey = (): ApiKey => {
  const uuid = uuidv4();
  const apiKey = db
    .insert(apiKeys)
    .values({
      apiKey: uuid,
      createdAt: new Date()
    })
    .returning();

  console.log(apiKey.all()[0]);
  console.log(apiKey.get());
  return apiKey.all()[0];
};

[
  {
    id: 76,
    apiKey: "2023-02-05T17:07:22.140Z",
    companyId: null,
    status: "draft",
    createdAt: 2023-02-05T17:07:22.140Z,
    lastUsedAt: null
  }
]
{
  id: undefined,
  apiKey: undefined,
  companyId: undefined,
  status: undefined,
  createdAt: ul,
  lastUsedAt: ul
}

[AndriiSherman]

@Sandy-Garrido is it better-sqlite3 driver?

[Sandy-Garrido]

@AndriiSherman That's a good point! No, this test repository is using bun-sqlite
I have so many test repo's around at the moment for drizzle 😂

[AndriiSherman]

Good, so I have fixed this one only for better-sqlite3 driver. I can do same for bun-sqlite

[AndriiSherman]

Will ping you here after release

[Bulbang]

@AndriiSherman Yep, it seems to be working well now. Thanks.