refactor: datetime field support timezone, defaultToCurrentTime, and onUpdateToCurrentTime (#5012)

* refactor: date field support timezone, defaultToCurrentTime, and onUpdateToCurrentTime

* refactor: availableTypes unixTimestamp

* chore: defaultToCurrentTime

* chore: unix timestamp field

* fix: bug

* chore: field type map

* refactor: local improve

* fix: bug

* fix: bug

* chore: timezone test

* chore: test

* fix: test

* fix: test

* chore: field setter

* chore: test

* chore: date only field

* chore: test

* chore: test

* fix: bug

* fix: unixTimestamp

* fix: unixTimestamp

* chore: accuracy

* fix: bug

* fix: bug

* fix: unixTimestamp

* fix: unixTimestamp

* fix: date & datetime

* refactor:  add DateFieldInterface

* fix: bug

* chore: test

* chore: test

* chore: test

* refactor: locale improve

* refactor: local improve

* fix: bug

* refactor: unixTimestamp not support default value

---------

Co-authored-by: Chareice <chareice@live.com>
This commit is contained in:
Katherine 2024-08-16 16:50:51 +08:00 committed by GitHub
parent b9d1604eb8
commit e232ed7582
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
24 changed files with 674 additions and 158 deletions

View File

@ -52,6 +52,7 @@ import {
UUIDFieldInterface,
NanoidFieldInterface,
UnixTimestampFieldInterface,
DateFieldInterface,
} from './interfaces';
import {
GeneralCollectionTemplate,
@ -173,6 +174,7 @@ export class CollectionPlugin extends Plugin {
UUIDFieldInterface,
NanoidFieldInterface,
UnixTimestampFieldInterface,
DateFieldInterface,
]);
}

View File

@ -7,8 +7,8 @@
* For more information, please refer to: https://www.nocobase.com/agreement.
*/
import { Switch } from 'antd';
import React from 'react';
import { Switch, Radio, Input } from 'antd';
import React, { useEffect, useState } from 'react';
export const TargetKey = () => {
return <div>Target key</div>;
@ -50,3 +50,37 @@ export const ForeignKey2 = () => {
</div>
);
};
// 自定义 Radio 组件
export const CustomRadio = (props) => {
const { options, onChange } = props;
const [value, setValue] = useState(props.value);
useEffect(() => {
setValue(['server', 'client'].includes(props.value) ? props.value : 'custom');
}, [props.value]);
const handleRadioChange = (e) => {
setValue(e.target.value);
if (e.target.value !== 'custom') {
onChange?.(e.target.value);
}
};
return (
<Radio.Group onChange={handleRadioChange} value={value}>
{options.map((option) => (
<Radio key={option.value} value={option.value}>
{option.label}
{option.value === 'custom' && value === 'custom' ? (
<Input
style={{ width: 200, marginLeft: 10 }}
onChange={(e) => {
onChange?.(e.target.value);
}}
value={['server', 'client', 'custom'].includes(props.value) ? null : props.value}
/>
) : null}
</Radio>
))}
</Radio.Group>
);
};

View File

@ -0,0 +1,60 @@
/**
* This file is part of the NocoBase (R) project.
* Copyright (c) 2020-2024 NocoBase Co., Ltd.
* Authors: NocoBase Team.
*
* This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
* For more information, please refer to: https://www.nocobase.com/agreement.
*/
import { CollectionFieldInterface } from '../../data-source/collection-field-interface/CollectionFieldInterface';
import { dateTimeProps, defaultProps, operators } from './properties';
export class DateFieldInterface extends CollectionFieldInterface {
name = 'date';
type = 'object';
group = 'datetime';
order = 1;
title = '{{t("Date")}}';
sortable = true;
default = {
type: 'dateOnly',
uiSchema: {
type: 'string',
'x-component': 'DatePicker',
'x-component-props': {
dateOnly: true,
},
},
};
availableTypes = ['date', 'dateOnly', 'string'];
hasDefaultValue = true;
properties = {
...defaultProps,
'uiSchema.x-component-props.dateFormat': {
type: 'string',
title: '{{t("Date format")}}',
'x-component': 'Radio.Group',
'x-decorator': 'FormItem',
default: 'YYYY-MM-DD',
enum: [
{
label: '{{t("Year/Month/Day")}}',
value: 'YYYY/MM/DD',
},
{
label: '{{t("Year-Month-Day")}}',
value: 'YYYY-MM-DD',
},
{
label: '{{t("Day/Month/Year")}}',
value: 'DD/MM/YYYY',
},
],
},
};
filterable = {
operators: operators.datetime,
};
titleUsable = true;
}

View File

@ -19,6 +19,9 @@ export class DatetimeFieldInterface extends CollectionFieldInterface {
sortable = true;
default = {
type: 'date',
defaultToCurrentTime: false,
onUpdateToCurrentTime: false,
timezone: 'server',
uiSchema: {
type: 'string',
'x-component': 'DatePicker',

View File

@ -46,3 +46,4 @@ export * from './sort';
export * from './uuid';
export * from './nanoid';
export * from './unixTimestamp';
export * from './date';

View File

@ -10,6 +10,7 @@
import { Field } from '@formily/core';
import { ISchema } from '@formily/react';
import { uid } from '@formily/shared';
import { CustomRadio } from '../components';
export * as operators from './operators';
export const type: ISchema = {
@ -225,6 +226,29 @@ export const reverseFieldProperties: Record<string, ISchema> = {
};
export const dateTimeProps: { [key: string]: ISchema } = {
timezone: {
type: 'string',
title: '{{t("Timezone")}}',
'x-component': CustomRadio,
'x-decorator': 'FormItem',
default: 'server',
'x-component-props': {
options: [
{
label: '{{t("None")}}',
value: 'server',
},
{
label: '{{t("Client\'s time zone")}}',
value: 'client',
},
{
label: '{{t("Custom")}}',
value: 'custom',
},
],
},
},
'uiSchema.x-component-props.dateFormat': {
type: 'string',
title: '{{t("Date format")}}',
@ -253,10 +277,10 @@ export const dateTimeProps: { [key: string]: ISchema } = {
'x-content': '{{t("Show time")}}',
'x-reactions': [
`{{(field) => {
field.query('..[].timeFormat').take(f => {
f.display = field.value ? 'visible' : 'none';
});
}}}`,
field.query('..[].timeFormat').take(f => {
f.display = field.value ? 'visible' : 'none';
});
}}}`,
],
},
'uiSchema.x-component-props.timeFormat': {
@ -276,6 +300,18 @@ export const dateTimeProps: { [key: string]: ISchema } = {
},
],
},
defaultToCurrentTime: {
type: 'boolean',
'x-decorator': 'FormItem',
'x-component': 'Checkbox',
'x-content': '{{t("Default value to current time")}}',
},
onUpdateToCurrentTime: {
type: 'boolean',
'x-decorator': 'FormItem',
'x-component': 'Checkbox',
'x-content': '{{t("Automatically update timestamp on update")}}',
},
};
export const dataSource: ISchema = {

View File

@ -8,8 +8,8 @@
*/
import { CollectionFieldInterface } from '../../data-source/collection-field-interface/CollectionFieldInterface';
import { dateTimeProps, defaultProps, operators } from './properties';
import { defaultProps, operators } from './properties';
import { CustomRadio } from './components';
export class UnixTimestampFieldInterface extends CollectionFieldInterface {
name = 'unixTimestamp';
type = 'object';
@ -18,21 +18,47 @@ export class UnixTimestampFieldInterface extends CollectionFieldInterface {
title = '{{t("Unix Timestamp")}}';
sortable = true;
default = {
type: 'bigInt',
type: 'unixTimestamp',
accuracy: 'second',
timezone: 'server',
defaultToCurrentTime: false,
onUpdateToCurrentTime: false,
uiSchema: {
type: 'number',
'x-component': 'UnixTimestamp',
'x-component-props': {
accuracy: 'second',
showTime: true,
},
},
};
availableTypes = ['integer', 'bigInt'];
hasDefaultValue = true;
availableTypes = ['integer', 'bigInt', 'unixTimestamp'];
hasDefaultValue = false;
properties = {
...defaultProps,
'uiSchema.x-component-props.accuracy': {
timezone: {
type: 'string',
title: '{{t("Timezone")}}',
'x-component': CustomRadio,
'x-decorator': 'FormItem',
default: 'server',
'x-component-props': {
options: [
{
label: '{{t("None")}}',
value: 'server',
},
{
label: '{{t("Client\'s time zone")}}',
value: 'client',
},
{
label: 'custom',
value: 'custom',
},
],
},
},
accuracy: {
type: 'string',
title: '{{t("Accuracy")}}',
'x-component': 'Radio.Group',
@ -43,6 +69,20 @@ export class UnixTimestampFieldInterface extends CollectionFieldInterface {
{ value: 'second', label: '{{t("Second")}}' },
],
},
defaultToCurrentTime: {
type: 'boolean',
'x-decorator': 'FormItem',
'x-component': 'Checkbox',
'x-content': '{{t("Default value to current time")}}',
default: true,
},
onUpdateToCurrentTime: {
type: 'boolean',
'x-decorator': 'FormItem',
'x-component': 'Checkbox',
'x-content': '{{t("Automatically update timestamp on update")}}',
default: true,
},
};
filterable = {
operators: operators.number,

View File

@ -283,7 +283,7 @@
"Checkbox group": "复选框",
"China region": "中国行政区",
"Date & Time": "日期 & 时间",
"Datetime": "日期",
"Datetime": "日期时间",
"Relation": "关系类型",
"Link to": "关联",
"Link to description": "用于快速创建表关系,可兼容大多数普通场景。适合非开发人员使用。作为字段存在时,它是一个下拉选择用于选择目标数据表的数据。创建后,将同时在目标数据表中生成当前数据表的关联字段。",
@ -967,5 +967,8 @@
"Clear default value": "清除默认值",
"Open in new window": "新窗口打开",
"Sorry, the page you visited does not exist.": "抱歉,你访问的页面不存在。",
"Set Template Engine": "设置模板引擎"
"Set Template Engine": "设置模板引擎",
"Default value to current time":"设置字段默认值为当前时间",
"Automatically update timestamp on update":"当记录更新时自动设置字段值为当前时间",
"Client's time zone":"客户端时区"
}

View File

@ -78,17 +78,20 @@ export const mapDatePicker = function () {
return (props: any) => {
const format = getDefaultFormat(props) as any;
const onChange = props.onChange;
return {
...props,
format: format,
value: str2moment(props.value, props),
onChange: (value: Dayjs | null) => {
onChange: (value: Dayjs | null, dateString) => {
if (onChange) {
if (!props.showTime && value) {
value = value.startOf('day');
}
onChange(moment2str(value, props));
if (props.dateOnly) {
onChange(dateString);
} else {
onChange(moment2str(value, props));
}
}
},
};

View File

@ -8,57 +8,32 @@
*/
import { connect, mapReadPretty } from '@formily/react';
import React, { useMemo } from 'react';
import React from 'react';
import { DatePicker } from '../date-picker';
import dayjs from 'dayjs';
const toValue = (value: any, accuracy) => {
if (value) {
return timestampToDate(value, accuracy);
}
return null;
};
function timestampToDate(timestamp, accuracy = 'millisecond') {
if (accuracy === 'second') {
timestamp *= 1000; // 如果精确度是秒级则将时间戳乘以1000转换为毫秒级
}
return dayjs(timestamp);
}
function getTimestamp(date, accuracy = 'millisecond') {
if (accuracy === 'second') {
return dayjs(date).unix();
} else {
return dayjs(date).valueOf(); // 默认返回毫秒级时间戳
}
}
interface UnixTimestampProps {
value?: number;
accuracy?: 'millisecond' | 'second';
value?: any;
onChange?: (value: number) => void;
}
export const UnixTimestamp = connect(
(props: UnixTimestampProps) => {
const { value, onChange, accuracy = 'second' } = props;
const v = useMemo(() => toValue(value, accuracy), [value, accuracy]);
const { value, onChange } = props;
return (
<DatePicker
{...props}
value={v}
value={value}
onChange={(v: any) => {
if (onChange) {
onChange(getTimestamp(v, accuracy));
onChange(v);
}
}}
/>
);
},
mapReadPretty((props) => {
const { value, accuracy = 'second' } = props;
const v = useMemo(() => toValue(value, accuracy), [value, accuracy]);
return <DatePicker.ReadPretty {...props} value={v} />;
const { value } = props;
return <DatePicker.ReadPretty {...props} value={value} />;
}),
);

View File

@ -13,11 +13,9 @@ import { UnixTimestamp } from '@nocobase/client';
describe('UnixTimestamp', () => {
it('renders without errors', async () => {
const { container } = await renderAppOptions({
Component: UnixTimestamp,
props: {
accuracy: 'millisecond',
},
value: 0,
Component: UnixTimestamp as any,
props: {},
value: null,
});
expect(container).toMatchInlineSnapshot(`
<div>
@ -69,78 +67,10 @@ describe('UnixTimestamp', () => {
`);
});
it('millisecond', async () => {
await renderAppOptions({
Component: UnixTimestamp,
value: 1712819630000,
props: {
accuracy: 'millisecond',
},
});
await waitFor(() => {
expect(screen.getByRole('textbox')).toHaveValue('2024-04-11');
});
});
it('second', async () => {
await renderAppOptions({
Component: UnixTimestamp,
value: 1712819630,
props: {
accuracy: 'second',
},
});
await waitFor(() => {
expect(screen.getByRole('textbox')).toHaveValue('2024-04-11');
});
});
it('string', async () => {
await renderAppOptions({
Component: UnixTimestamp,
value: '2024-04-11',
props: {
accuracy: 'millisecond',
},
});
await waitFor(() => {
expect(screen.getByRole('textbox')).toHaveValue('2024-04-11');
});
});
it('change', async () => {
const onChange = vitest.fn();
await renderAppOptions({
Component: UnixTimestamp,
value: '2024-04-11',
onChange,
props: {
accuracy: 'millisecond',
},
});
await userEvent.click(screen.getByRole('textbox'));
await waitFor(() => {
expect(screen.queryByRole('table')).toBeInTheDocument();
});
await userEvent.click(document.querySelector('td[title="2024-04-12"]'));
await waitFor(() => {
expect(screen.getByRole('textbox')).toHaveValue('2024-04-12');
});
expect(onChange).toBeCalledWith(1712880000000);
});
it('read pretty', async () => {
const { container } = await renderReadPrettyApp({
Component: UnixTimestamp,
Component: UnixTimestamp as any,
value: '2024-04-11',
props: {
accuracy: 'millisecond',
},
});
expect(screen.getByText('2024-04-11')).toBeInTheDocument();

View File

@ -0,0 +1,42 @@
/**
* This file is part of the NocoBase (R) project.
* Copyright (c) 2020-2024 NocoBase Co., Ltd.
* Authors: NocoBase Team.
*
* This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
* For more information, please refer to: https://www.nocobase.com/agreement.
*/
import { Database, mockDatabase } from '@nocobase/database';
describe('date only', () => {
let db: Database;
beforeEach(async () => {
db = mockDatabase({
timezone: '+08:00',
});
await db.clean({ drop: true });
});
afterEach(async () => {
await db.close();
});
it('should set date field with dateOnly', async () => {
db.collection({
name: 'tests',
fields: [{ name: 'date1', type: 'dateOnly' }],
});
await db.sync();
const item = await db.getRepository('tests').create({
values: {
date1: '2023-03-24',
},
});
expect(item.get('date1')).toBe('2023-03-24');
});
});

View File

@ -11,6 +11,69 @@ import { mockDatabase } from '../';
import { Database } from '../../database';
import { Repository } from '../../repository';
describe('timezone', () => {
let db: Database;
beforeEach(async () => {
db = mockDatabase({
timezone: '+08:00',
});
await db.clean({ drop: true });
});
afterEach(async () => {
await db.close();
});
describe('timezone', () => {
test('custom', async () => {
db.collection({
name: 'tests',
timestamps: false,
fields: [{ name: 'date1', type: 'date', timezone: '+06:00' }],
});
await db.sync();
const repository = db.getRepository('tests');
const instance = await repository.create({ values: { date1: '2023-03-24 00:00:00' } });
const date1 = instance.get('date1');
expect(date1.toISOString()).toEqual('2023-03-23T18:00:00.000Z');
});
test('client', async () => {
db.collection({
name: 'tests',
timestamps: false,
fields: [{ name: 'date1', type: 'date', timezone: 'client' }],
});
await db.sync();
const repository = db.getRepository('tests');
const instance = await repository.create({
values: { date1: '2023-03-24 01:00:00' },
context: {
timezone: '+01:00',
},
});
const date1 = instance.get('date1');
expect(date1.toISOString()).toEqual('2023-03-24T00:00:00.000Z');
});
test('server', async () => {
db.collection({
name: 'tests',
fields: [{ name: 'date1', type: 'date', timezone: 'server' }],
});
await db.sync();
const repository = db.getRepository('tests');
const instance = await repository.create({ values: { date1: '2023-03-24 08:00:00' } });
const date1 = instance.get('date1');
expect(date1.toISOString()).toEqual('2023-03-24T00:00:00.000Z');
});
});
});
describe('date-field', () => {
let db: Database;
let repository: Repository;
@ -30,16 +93,80 @@ describe('date-field', () => {
await db.close();
});
const createExpectToBe = async (key, actual, expected) => {
const instance = await repository.create({
it('should set default to current time', async () => {
const c1 = db.collection({
name: 'test11',
fields: [
{
name: 'date1',
type: 'date',
defaultToCurrentTime: true,
},
],
});
await db.sync();
const instance = await c1.repository.create({});
const date1 = instance.get('date1');
expect(date1).toBeDefined();
});
it('should set to current time when update', async () => {
const c1 = db.collection({
name: 'test11',
fields: [
{
name: 'date1',
type: 'date',
onUpdateToCurrentTime: true,
},
{
name: 'title',
type: 'string',
},
],
});
await db.sync();
const instance = await c1.repository.create({
values: {
[key]: actual,
title: 'test',
},
});
return expect(instance.get(key).toISOString()).toEqual(expected);
};
const date1Val = instance.get('date1');
expect(date1Val).toBeDefined();
console.log('update');
await c1.repository.update({
values: {
title: 'test2',
},
filter: {
id: instance.get('id'),
},
});
await instance.reload();
const date1Val2 = instance.get('date1');
expect(date1Val2).toBeDefined();
expect(date1Val2.getTime()).toBeGreaterThan(date1Val.getTime());
});
test('create', async () => {
const createExpectToBe = async (key, actual, expected) => {
const instance = await repository.create({
values: {
[key]: actual,
},
});
return expect(instance.get(key).toISOString()).toEqual(expected);
};
// sqlite 时区不能自定义,只有 +00:00postgres 和 mysql 可以自定义 DB_TIMEZONE
await createExpectToBe('date1', '2023-03-24', '2023-03-24T00:00:00.000Z');
await createExpectToBe('date1', '2023-03-24T16:00:00.000Z', '2023-03-24T16:00:00.000Z');

View File

@ -0,0 +1,86 @@
/**
* This file is part of the NocoBase (R) project.
* Copyright (c) 2020-2024 NocoBase Co., Ltd.
* Authors: NocoBase Team.
*
* This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
* For more information, please refer to: https://www.nocobase.com/agreement.
*/
import { Database, mockDatabase } from '@nocobase/database';
import moment from 'moment';
describe('unix timestamp field', () => {
let db: Database;
beforeEach(async () => {
db = mockDatabase();
await db.clean({ drop: true });
});
afterEach(async () => {
await db.close();
});
it('should set default to current time', async () => {
const c1 = db.collection({
name: 'test11',
fields: [
{
name: 'date1',
type: 'unixTimestamp',
defaultToCurrentTime: true,
},
],
});
await db.sync();
const instance = await c1.repository.create({});
const date1 = instance.get('date1');
expect(date1).toBeDefined();
console.log(instance.toJSON());
});
it('should set date value', async () => {
const c1 = db.collection({
name: 'test12',
fields: [
{
name: 'date1',
type: 'unixTimestamp',
},
],
});
await db.sync();
await c1.repository.create({
values: {
date1: '2021-01-01T00:00:00Z',
},
});
const item = await c1.repository.findOne();
const val = item.get('date1');
const date = moment(val).utc().format('YYYY-MM-DD HH:mm:ss');
expect(date).toBe('2021-01-01 00:00:00');
});
describe('timezone', () => {
test('custom', async () => {
db.collection({
name: 'tests',
timestamps: false,
fields: [{ name: 'date1', type: 'unixTimestamp', timezone: '+06:00' }],
});
await db.sync();
const repository = db.getRepository('tests');
const instance = await repository.create({ values: { date1: '2023-03-24 00:00:00' } });
const date1 = instance.get('date1');
expect(date1.toISOString()).toEqual('2023-03-23T18:00:00.000Z');
});
});
});

View File

@ -34,7 +34,6 @@ import {
import { SequelizeStorage, Umzug } from 'umzug';
import { Collection, CollectionOptions, RepositoryType } from './collection';
import { CollectionFactory } from './collection-factory';
import { CollectionGroupManager } from './collection-group-manager';
import { ImporterReader, ImportFileExtension } from './collection-importer';
import DatabaseUtils from './database-utils';
import ReferencesMap from './features/references-map';
@ -42,7 +41,6 @@ import { referentialIntegrityCheck } from './features/referential-integrity-chec
import { ArrayFieldRepository } from './field-repository/array-field-repository';
import * as FieldTypes from './fields';
import { Field, FieldContext, RelationField } from './fields';
import { checkDatabaseVersion } from './helpers';
import { InheritedCollection } from './inherited-collection';
import InheritanceMap from './inherited-map';
import { InterfaceManager } from './interface-manager';
@ -221,6 +219,9 @@ export class Database extends EventEmitter implements AsyncEmitter {
}
}
// @ts-ignore
opts.rawTimezone = opts.timezone;
if (options.dialect === 'sqlite') {
delete opts.timezone;
} else if (!opts.timezone) {
@ -848,7 +849,8 @@ export class Database extends EventEmitter implements AsyncEmitter {
* @internal
*/
async checkVersion() {
return await checkDatabaseVersion(this);
return true;
// return await checkDatabaseVersion(this);
}
/**

View File

@ -10,8 +10,14 @@
import { DataTypes } from 'sequelize';
import { BaseColumnFieldOptions, Field } from './field';
const datetimeRegex = /^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/;
function isValidDatetime(str) {
return datetimeRegex.test(str);
}
export class DateField extends Field {
get dataType() {
get dataType(): any {
return DataTypes.DATE(3);
}
@ -33,6 +39,59 @@ export class DateField extends Field {
return props.gmt;
}
init() {
const { name, defaultToCurrentTime, onUpdateToCurrentTime, timezone } = this.options;
this.resolveTimeZone = (context) => {
// @ts-ignore
const serverTimeZone = this.database.options.rawTimezone;
if (timezone === 'server') {
return serverTimeZone;
}
if (timezone === 'client') {
return context?.timezone || serverTimeZone;
}
if (timezone) {
return timezone;
}
return serverTimeZone;
};
this.beforeSave = async (instance, options) => {
const value = instance.get(name);
if (!value && instance.isNewRecord && defaultToCurrentTime) {
instance.set(name, new Date());
return;
}
if (onUpdateToCurrentTime) {
instance.set(name, new Date());
return;
}
};
}
setter(value, options) {
if (value === null) {
return value;
}
if (value instanceof Date) {
return value;
}
if (typeof value === 'string' && isValidDatetime(value)) {
const dateTimezone = this.resolveTimeZone(options?.context);
const dateString = `${value} ${dateTimezone}`;
return new Date(dateString);
}
return value;
}
bind() {
super.bind();
@ -51,6 +110,13 @@ export class DateField extends Field {
// @ts-ignore
model.refreshAttributes();
}
this.on('beforeSave', this.beforeSave);
}
unbind() {
super.unbind();
this.off('beforeSave', this.beforeSave);
}
}

View File

@ -0,0 +1,21 @@
/**
* This file is part of the NocoBase (R) project.
* Copyright (c) 2020-2024 NocoBase Co., Ltd.
* Authors: NocoBase Team.
*
* This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
* For more information, please refer to: https://www.nocobase.com/agreement.
*/
import { BaseColumnFieldOptions, Field } from './field';
import { DataTypes } from 'sequelize';
export class DateOnlyField extends Field {
get dataType(): any {
return DataTypes.DATEONLY;
}
}
export interface DateOnlyFieldOptions extends BaseColumnFieldOptions {
type: 'dateOnly';
}

View File

@ -56,7 +56,7 @@ export abstract class Field {
return this.options.type;
}
abstract get dataType();
abstract get dataType(): any;
isRelationField() {
return false;
@ -171,11 +171,13 @@ export abstract class Field {
Object.assign(opts, { type: this.database.sequelize.normalizeDataType(this.dataType) });
}
Object.assign(opts, this.additionalSequelizeOptions());
return opts;
}
isSqlite() {
return this.database.sequelize.getDialect() === 'sqlite';
additionalSequelizeOptions() {
return {};
}
typeToString() {

View File

@ -36,6 +36,8 @@ import { UUIDFieldOptions } from './uuid-field';
import { VirtualFieldOptions } from './virtual-field';
import { NanoidFieldOptions } from './nanoid-field';
import { EncryptionField } from './encryption-field';
import { UnixTimestampFieldOptions } from './unix-timestamp-field';
import { DateOnlyFieldOptions } from './date-only-field';
export * from './array-field';
export * from './belongs-to-field';
@ -43,6 +45,7 @@ export * from './belongs-to-many-field';
export * from './boolean-field';
export * from './context-field';
export * from './date-field';
export * from './date-only-field';
export * from './field';
export * from './has-many-field';
export * from './has-one-field';
@ -61,6 +64,7 @@ export * from './uuid-field';
export * from './virtual-field';
export * from './nanoid-field';
export * from './encryption-field';
export * from './unix-timestamp-field';
export type FieldOptions =
| BaseFieldOptions
@ -81,6 +85,8 @@ export type FieldOptions =
| SetFieldOptions
| TimeFieldOptions
| DateFieldOptions
| DateOnlyFieldOptions
| UnixTimestampFieldOptions
| UidFieldOptions
| UUIDFieldOptions
| NanoidFieldOptions

View File

@ -0,0 +1,60 @@
/**
* This file is part of the NocoBase (R) project.
* Copyright (c) 2020-2024 NocoBase Co., Ltd.
* Authors: NocoBase Team.
*
* This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
* For more information, please refer to: https://www.nocobase.com/agreement.
*/
import { DataTypes } from 'sequelize';
import { DateField } from './date-field';
import { BaseColumnFieldOptions } from './field';
export class UnixTimestampField extends DateField {
get dataType() {
return DataTypes.BIGINT;
}
additionalSequelizeOptions(): {} {
const { name } = this.options;
let { accuracy } = this.options;
if (this.options?.uiSchema['x-component-props']?.accuracy) {
accuracy = this.options?.uiSchema['x-component-props']?.accuracy;
}
if (!accuracy) {
accuracy = 'second';
}
let rationalNumber = 1000;
if (accuracy === 'millisecond') {
rationalNumber = 1;
}
return {
get() {
const value = this.getDataValue(name);
if (value === null || value === undefined) {
return value;
}
return new Date(value * rationalNumber);
},
set(value) {
if (value === null || value === undefined) {
this.setDataValue(name, value);
} else {
// date to unix timestamp
this.setDataValue(name, Math.floor(new Date(value).getTime() / rationalNumber));
}
},
};
}
}
export interface UnixTimestampFieldOptions extends BaseColumnFieldOptions {
type: 'unix-timestamp';
}

View File

@ -7,7 +7,7 @@
* For more information, please refer to: https://www.nocobase.com/agreement.
*/
import lodash, { isPlainObject } from 'lodash';
import lodash from 'lodash';
import { Model as SequelizeModel, ModelStatic } from 'sequelize';
import { Collection } from './collection';
import { Database } from './database';
@ -30,7 +30,8 @@ interface JSONTransformerOptions {
export class Model<TModelAttributes extends {} = any, TCreationAttributes extends {} = TModelAttributes>
extends SequelizeModel<TModelAttributes, TCreationAttributes>
implements IModel {
implements IModel
{
public static database: Database;
public static collection: Collection;
@ -49,6 +50,21 @@ export class Model<TModelAttributes extends {} = any, TCreationAttributes extend
return await runner.runSync(options);
}
static callSetters(values, options) {
// map values
const result = {};
for (const key of Object.keys(values)) {
const field = this.collection.getField(key);
if (field && field.setter) {
result[key] = field.setter.call(field, values[key], options, values, key);
} else {
result[key] = values[key];
}
}
return result;
}
// TODO
public toChangedWithAssociations() {
// @ts-ignore

View File

@ -573,7 +573,7 @@ export class Repository<TModelAttributes extends {} = any, TCreationAttributes e
underscored: this.collection.options.underscored,
});
const values = guard.sanitize(options.values || {});
const values = (this.model as typeof Model).callSetters(guard.sanitize(options.values || {}), options);
const instance = await this.model.create<any>(values, {
...options,
@ -645,7 +645,7 @@ export class Repository<TModelAttributes extends {} = any, TCreationAttributes e
const guard = UpdateGuard.fromOptions(this.model, { ...options, underscored: this.collection.options.underscored });
const values = guard.sanitize(options.values);
const values = (this.model as typeof Model).callSetters(guard.sanitize(options.values || {}), options);
// NOTE:
// 1. better to be moved to separated API like bulkUpdate/updateMany

View File

@ -18,8 +18,8 @@ const postgres = {
name: 'string',
smallint: ['integer', 'sort'],
integer: ['integer', 'sort'],
bigint: ['bigInt', 'sort'],
integer: ['integer', 'unixTimestamp', 'sort'],
bigint: ['bigInt', 'unixTimestamp', 'sort'],
decimal: 'decimal',
numeric: 'float',
real: 'float',
@ -61,11 +61,11 @@ const mysql = {
text: 'text',
mediumtext: 'text',
longtext: 'text',
int: ['integer', 'sort'],
'int unsigned': ['integer', 'sort'],
integer: ['integer', 'sort'],
bigint: ['bigInt', 'sort'],
'bigint unsigned': ['bigInt', 'sort'],
int: ['integer', 'unixTimestamp', 'sort'],
'int unsigned': ['integer', 'unixTimestamp', 'sort'],
integer: ['integer', 'unixTimestamp', 'sort'],
bigint: ['bigInt', 'unixTimestamp', 'sort'],
'bigint unsigned': ['bigInt', 'unixTimestamp', 'sort'],
float: 'float',
double: 'float',
boolean: 'boolean',

View File

@ -213,22 +213,19 @@ export class Application<StateT = DefaultState, ContextT = DefaultContext> exten
* @internal
*/
public perfHistograms = new Map<string, RecordableHistogram>();
protected plugins = new Map<string, Plugin>();
protected _appSupervisor: AppSupervisor = AppSupervisor.getInstance();
protected _started: Date | null = null;
private _authenticated = false;
private _maintaining = false;
private _maintainingCommandStatus: MaintainingCommandStatus;
private _maintainingStatusBeforeCommand: MaintainingCommandStatus | null;
private _actionCommand: Command;
/**
* @internal
*/
public syncManager: SyncManager;
public requestLogger: Logger;
protected plugins = new Map<string, Plugin>();
protected _appSupervisor: AppSupervisor = AppSupervisor.getInstance();
private _authenticated = false;
private _maintaining = false;
private _maintainingCommandStatus: MaintainingCommandStatus;
private _maintainingStatusBeforeCommand: MaintainingCommandStatus | null;
private _actionCommand: Command;
private sqlLogger: Logger;
protected _logger: SystemLogger;
constructor(public options: ApplicationOptions) {
super();
@ -241,6 +238,8 @@ export class Application<StateT = DefaultState, ContextT = DefaultContext> exten
}
}
protected _started: Date | null = null;
/**
* @experimental
*/
@ -248,6 +247,8 @@ export class Application<StateT = DefaultState, ContextT = DefaultContext> exten
return this._started;
}
protected _logger: SystemLogger;
get logger() {
return this._logger;
}