Skip to content
Closed
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: 4 additions & 2 deletions cfds/base/schema.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,9 @@ import type { RichText } from '../richtext/tree.ts';
import type { ValueType } from './types/index.ts';

/**
* A mapping between a schema type and its native variable type.
* A mapping between a schema type and its native variable type. The final
* `never` makes an unmapped ValueType a compile error instead of silently
* widening the field to `CoreValue`.
* @group Schema
*/
export type FieldValue<T extends ValueType> = T extends 'string' ? string
Expand All @@ -64,7 +66,7 @@ export type FieldValue<T extends ValueType> = T extends 'string' ? string
: T extends 'set' ? Set<CoreValue>
: T extends 'map' ? Dictionary<string, CoreValue>
: T extends 'richtext' ? RichText
: CoreValue;
: never;

/**
* A definition of a single field in a schema.
Expand Down
11 changes: 4 additions & 7 deletions cfds/base/types/core-type.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
import type {
IValueTypeOperations,
ValueType,
ValueTypeOptions,
} from './index.ts';
import type { IValueTypeOperations, ValueTypeOptions } from './index.ts';
import { kValueTypeCoreTypes, type ValueType } from './value-type.ts';
import type { DecodedValue } from '../../../base/core-types/encoding/index.ts';
import type { Change, EncodedChange } from '../../change/index.ts';
import { FieldChange } from '../../change/field-change.ts';
Expand All @@ -21,8 +18,8 @@ export abstract class CoreTypeOperations<
private _coreType: CoreType;
private _valueType: ValueType;

constructor(encType: CoreType, valueType: ValueType) {
this._coreType = encType;
constructor(valueType: ValueType) {
this._coreType = kValueTypeCoreTypes[valueType];
this._valueType = valueType;
}

Expand Down
3 changes: 1 addition & 2 deletions cfds/base/types/date-type.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import { PrimitiveTypeOperations } from './primitive-type.ts';
import { CoreType } from '../../../base/core-types/index.ts';
import type { DecodedValue } from '../../../base/core-types/encoding/index.ts';
import { assert } from '../../../base/error.ts';

Expand All @@ -12,7 +11,7 @@ import { assert } from '../../../base/error.ts';
*/
export class DateTypeOperations extends PrimitiveTypeOperations<Date> {
constructor() {
super(CoreType.Date, 'date');
super('date');
}

/**
Expand Down
22 changes: 6 additions & 16 deletions cfds/base/types/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,11 @@ import { MapTypeOperations } from './map-type.ts';
import { PrimitiveTypeOperations } from './primitive-type.ts';
import { SetTypeOperations } from './set-type.ts';
import { RichText3TypeOperations } from './richtext3-type.ts';
import {
CoreType,
type CoreValue,
type Encoder,
} from '../../../base/core-types/index.ts';
import type { CoreValue, Encoder } from '../../../base/core-types/index.ts';
import { DateTypeOperations } from './date-type.ts';

export type ValueType =
| 'string'
| 'number'
| 'boolean'
| 'date'
| 'set'
| 'map'
| 'richtext';
export { kValueTypeCoreTypes, type ValueType } from './value-type.ts';
import type { ValueType } from './value-type.ts';

/**
* Options common to value-type operations. `local`/`byCharacter` describe
Expand Down Expand Up @@ -101,9 +91,9 @@ export interface IValueTypeOperations<T extends CoreValue = CoreValue> {
/** Every `ValueType` has exactly one op set. `satisfies` + `Object.freeze`
* make this exhaustive and immutable at compile time. */
const kTypeOperations = Object.freeze({
string: new PrimitiveTypeOperations(CoreType.String, 'string'),
number: new PrimitiveTypeOperations(CoreType.Number, 'number'),
boolean: new PrimitiveTypeOperations(CoreType.Boolean, 'boolean'),
string: new PrimitiveTypeOperations('string'),
number: new PrimitiveTypeOperations('number'),
boolean: new PrimitiveTypeOperations('boolean'),
date: new DateTypeOperations(),
set: new SetTypeOperations('set'),
map: new MapTypeOperations('map'),
Expand Down
3 changes: 1 addition & 2 deletions cfds/base/types/map-type.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,14 @@ import { FieldChange, FieldOperation } from '../../change/field-change.ts';
import {
type ConcreteCoreValue,
type CoreKey,
CoreType,
coreValueEquals,
} from '../../../base/core-types/index.ts';

export class MapTypeOperations extends CoreTypeOperations<
Dictionary<CoreKey, ConcreteCoreValue>
> {
constructor(valueType: ValueType) {
super(CoreType.Dictionary, valueType);
super(valueType);
}

patch(
Expand Down
4 changes: 4 additions & 0 deletions cfds/base/types/primitive-type.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { valueTypeEquals, ValueTypeOptions } from './index.ts';
import type { ValueType } from './value-type.ts';
import { CoreTypeOperations } from './core-type.ts';
import { Change, EncodedChange } from '../../change/index.ts';
import { FieldChange, FieldOperation } from '../../change/field-change.ts';
Expand All @@ -7,6 +8,9 @@ import { ConcreteCoreValue } from '../../../base/core-types/index.ts';
export class PrimitiveTypeOperations<
TValue extends ConcreteCoreValue,
> extends CoreTypeOperations<TValue> {
constructor(valueType: ValueType) {
super(valueType);
}
patch(
curValue: TValue | undefined,
changes: Change<EncodedChange>[],
Expand Down
3 changes: 1 addition & 2 deletions cfds/base/types/richtext3-type.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ import type { Change, EncodedChange } from '../../change/index.ts';
import type { RichTextChange } from '../../change/richtext-change.ts';
import {
type CoreOptions,
CoreType,
type CoreValue,
coreValueClone,
coreValueEquals,
Expand Down Expand Up @@ -38,7 +37,7 @@ export interface RichTextSerializeOptions extends SerializeValueTypeOptions {

export class RichText3TypeOperations extends CoreTypeOperations<RichText> {
constructor() {
super(CoreType.Object, 'richtext');
super('richtext');
}
patch(
curValue: RichText | undefined,
Expand Down
7 changes: 2 additions & 5 deletions cfds/base/types/set-type.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,14 @@ import type { ValueType, ValueTypeOptions } from './index.ts';
import type { Change, EncodedChange } from '../../change/index.ts';
import { CoreTypeOperations } from './core-type.ts';
import { FieldChange, FieldOperation } from '../../change/field-change.ts';
import {
type ConcreteCoreValue,
CoreType,
} from '../../../base/core-types/index.ts';
import type { ConcreteCoreValue } from '../../../base/core-types/index.ts';
import * as SetUtils from '../../../base/set.ts';

export class SetTypeOperations extends CoreTypeOperations<
Set<ConcreteCoreValue>
> {
constructor(valueType: ValueType) {
super(CoreType.Set, valueType);
super(valueType);
}

patch(
Expand Down
47 changes: 47 additions & 0 deletions cfds/base/types/value-type.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
import { assert } from '../../../base/error.ts';
import { CoreType } from '../../../base/core-types/index.ts';

/**
* Schema-facing value types. Kept in a dependency-free leaf so the
* ValueType -> CoreType table can be shared without an import cycle:
* `index.ts` imports the operation classes, and those classes import the map.
*/
export type ValueType =
| 'string'
| 'number'
| 'boolean'
| 'date'
| 'set'
| 'map'
| 'richtext';

/**
* Single source of truth linking every schema ValueType to its CoreType.
*
* WHY: the CFD operation table used to take both values as constructor
* arguments, so a new ValueType could compile without a CoreType mapping and
* silently fall back to `CoreValue`. `satisfies Record<ValueType, CoreType>`
* makes a missing entry a compile error; the operation constructors now take
* only a ValueType and derive the CoreType here.
*/
export const kValueTypeCoreTypes = Object.freeze({
string: CoreType.String,
number: CoreType.Number,
boolean: CoreType.Boolean,
date: CoreType.Date,
set: CoreType.Set,
map: CoreType.Dictionary,
richtext: CoreType.Object,
}) satisfies Record<ValueType, CoreType>;

// Guard against two ValueTypes claiming the same CoreType: the reverse lookup
// below would silently keep one of them.
const gSeenCoreTypes = new Map<CoreType, ValueType>();
for (const [valueType, coreType] of Object.entries(kValueTypeCoreTypes)) {
assert(
!gSeenCoreTypes.has(coreType),
`CoreType ${coreType} is mapped from both ` +
`"${gSeenCoreTypes.get(coreType)}" and "${valueType}"`,
);
gSeenCoreTypes.set(coreType, valueType as ValueType);
}
1 change: 1 addition & 0 deletions deno.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
"./link": "./cli/link.ts"
},
"tasks": {
"check": "deno check mod.ts server.ts server-build.ts && deno check --node-modules-dir=none base/json-log/json-log-worker.ts",
"build": "deno run -A system-assets/build-sys-assets.ts",
"test": "deno run -A tests/run.ts",
"test:smoke": "deno run -A tests/run.ts --runtime=deno --suite=SecurityBoundaries",
Expand Down
47 changes: 46 additions & 1 deletion tests/core-value-serialization.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import { deserialize } from '../cfds/base/object.ts';
import { kChecksumSerOptions } from '../cfds/base/item.ts';
import { getTypeOperations } from '../cfds/base/types/index.ts';
import {
getTypeOperations,
kValueTypeCoreTypes,
type ValueType,
} from '../cfds/base/types/index.ts';
import { assertNoLegacyRefs } from '../cfds/richtext/legacy-ref.ts';
import { kTypeOps } from '../base/core-types/type-ops.ts';
import { CoreType } from '../base/core-types/base.ts';
Expand Down Expand Up @@ -95,6 +99,47 @@ function assertLegacyIngress(doc: RichText): void {
}

export default function setup(): void {
TEST(
'CoreValueSerialization',
'kTypeOperations is frozen and exhaustive',
() => {
// WHY: `kValueTypeCoreTypes` satisfies Record<ValueType, CoreType>, so
// deriving the key list from it keeps this test honest when a new
// ValueType is added. A missing operation makes the lookup fail.
for (const t of Object.keys(kValueTypeCoreTypes) as ValueType[]) {
const ops = getTypeOperations(t);
assertExists(ops, `getTypeOperations missing for: ${t}`);
assertEquals(ops.valueType, t);
}
},
);

TEST(
'CoreValueSerialization',
'ValueType to CoreType map is total and bijective',
() => {
const reps: Record<ValueType, CoreValue> = {
string: 's',
number: 1,
boolean: true,
date: new Date(0),
set: new Set([1]),
map: mkDict([['k', 1]]),
richtext: { root: { tagName: 'div', children: [] } } as never,
};
const valueTypes = Object.keys(kValueTypeCoreTypes) as ValueType[];
// A shared CoreType would make the reverse lookup ambiguous.
assertEquals(
new Set(Object.values(kValueTypeCoreTypes)).size,
valueTypes.length,
);
for (const t of valueTypes) {
assertEquals(getCoreType(reps[t]), kValueTypeCoreTypes[t]);
assertTrue(getTypeOperations(t).validate(reps[t]));
}
},
);

TEST(
'CoreValueSerialization',
'rejects legacy refs in pointers without stripping',
Expand Down
4 changes: 2 additions & 2 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"compilerOptions": {
"target": "ES2020",
"target": "ES2024",
"module": "ESNext",
"moduleResolution": "bundler",
"allowImportingTsExtensions": true,
"noEmit": true,
"strict": false,
"skipLibCheck": true,
"downlevelIteration": true,
"lib": ["ES2020", "DOM", "DOM.Iterable", "ESNext.Disposable"],
"lib": ["ES2024", "DOM", "DOM.Iterable", "ESNext.Disposable"],
"resolveJsonModule": true,
"allowSyntheticDefaultImports": true,
"esModuleInterop": true,
Expand Down
Loading