Skip to content

Commit

Permalink
Handle guards when inserting new transitions (#476)
Browse files Browse the repository at this point in the history
  • Loading branch information
@Andarist
Andarist authored Mar 5, 2024
1 parent 44ca622 commit 6290bfd
Show file tree
Hide file tree
Showing 4 changed files with 158 additions and 152 deletions.
260 changes: 124 additions & 136 deletions new-packages/ts-project/__tests__/source-edits/add-transition.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ test('should be possible to add a reentering self-transition to the root (explic
`);
});

test('should be possible to add a normal self-transition to the root (implicit ID)', async () => {
test('should be possible to add a non-reentering self-transition to the root (implicit ID)', async () => {
const tmpPath = await testdir({
'tsconfig.json': JSON.stringify({}),
'index.ts': ts`
Expand Down Expand Up @@ -266,7 +266,7 @@ test('should be possible to add a normal self-transition to the root (implicit I
`);
});

test('should be possible to add a normal self-transition to the root (explicit ID)', async () => {
test('should be possible to add a non-reentering self-transition to the root (explicit ID)', async () => {
const tmpPath = await testdir({
'tsconfig.json': JSON.stringify({}),
'index.ts': ts`
Expand Down Expand Up @@ -357,7 +357,7 @@ test('should be possible to add an external self-transition to a state', async (
`);
});

test('should be possible to add a normal self-transition to a state', async () => {
test('should be possible to add a non-reentering self-transition to a state', async () => {
const tmpPath = await testdir({
'tsconfig.json': JSON.stringify({}),
'index.ts': ts`
Expand Down Expand Up @@ -1605,41 +1605,39 @@ test(`should use the closest available ID from the target's ancestry path when a
`);
});

test.todo(
`should be possible to add a reentering transition with a guard`,
async () => {
const tmpPath = await testdir({
'tsconfig.json': JSON.stringify({}),
'index.ts': ts`
import { createMachine } from "xstate";
test(`should be possible to add a reentering transition with a guard`, async () => {
const tmpPath = await testdir({
'tsconfig.json': JSON.stringify({}),
'index.ts': ts`
import { createMachine } from "xstate";
createMachine({
initial: "foo",
states: {
foo: {},
bar: {},
},
});
`,
});
createMachine({
initial: "foo",
states: {
foo: {},
bar: {},
},
});
`,
});

const project = await createTestProject(tmpPath);
const project = await createTestProject(tmpPath);

const textEdits = project.editDigraph(
{
fileName: 'index.ts',
machineIndex: 0,
},
{
type: 'add_transition',
sourcePath: ['foo'],
targetPath: ['bar'],
transitionPath: ['on', 'NEXT', 0],
reenter: true,
guard: 'isItTooLate',
},
);
expect(await project.applyTextEdits(textEdits)).toMatchInlineSnapshot(`
const textEdits = project.editDigraph(
{
fileName: 'index.ts',
machineIndex: 0,
},
{
type: 'add_transition',
sourcePath: ['foo'],
targetPath: ['bar'],
transitionPath: ['on', 'NEXT', 0],
reenter: true,
guard: 'isItTooLate',
},
);
expect(await project.applyTextEdits(textEdits)).toMatchInlineSnapshot(`
{
"index.ts": "import { createMachine } from "xstate";
Expand All @@ -1660,43 +1658,40 @@ test.todo(
});",
}
`);
},
);
});

test.todo(
`should be possible to add a normal transition with a guard`,
async () => {
const tmpPath = await testdir({
'tsconfig.json': JSON.stringify({}),
'index.ts': ts`
import { createMachine } from "xstate";
test(`should be possible to add a non-reentering transition with a guard`, async () => {
const tmpPath = await testdir({
'tsconfig.json': JSON.stringify({}),
'index.ts': ts`
import { createMachine } from "xstate";
createMachine({
initial: "foo",
states: {
foo: {},
bar: {},
},
});
`,
});
createMachine({
initial: "foo",
states: {
foo: {},
bar: {},
},
});
`,
});

const project = await createTestProject(tmpPath);
const project = await createTestProject(tmpPath);

const textEdits = project.editDigraph(
{
fileName: 'index.ts',
machineIndex: 0,
},
{
type: 'add_transition',
sourcePath: [],
targetPath: ['bar'],
transitionPath: ['on', 'NEXT', 0],
guard: 'isItTooLate',
},
);
expect(await project.applyTextEdits(textEdits)).toMatchInlineSnapshot(`
const textEdits = project.editDigraph(
{
fileName: 'index.ts',
machineIndex: 0,
},
{
type: 'add_transition',
sourcePath: [],
targetPath: ['bar'],
transitionPath: ['on', 'NEXT', 0],
guard: 'isItTooLate',
},
);
expect(await project.applyTextEdits(textEdits)).toMatchInlineSnapshot(`
{
"index.ts": "import { createMachine } from "xstate";
Expand All @@ -1715,44 +1710,41 @@ test.todo(
});",
}
`);
},
);
});

test.todo(
`should be possible to add a reentering transition to a child with a guard`,
async () => {
const tmpPath = await testdir({
'tsconfig.json': JSON.stringify({}),
'index.ts': ts`
import { createMachine } from "xstate";
test(`should be possible to add a reentering transition to a child with a guard`, async () => {
const tmpPath = await testdir({
'tsconfig.json': JSON.stringify({}),
'index.ts': ts`
import { createMachine } from "xstate";
createMachine({
initial: "foo",
states: {
foo: {},
bar: {},
},
});
`,
});
createMachine({
initial: "foo",
states: {
foo: {},
bar: {},
},
});
`,
});

const project = await createTestProject(tmpPath);
const project = await createTestProject(tmpPath);

const textEdits = project.editDigraph(
{
fileName: 'index.ts',
machineIndex: 0,
},
{
type: 'add_transition',
sourcePath: [],
targetPath: ['bar'],
transitionPath: ['on', 'NEXT', 0],
reenter: true,
guard: 'isItTooLate',
},
);
expect(await project.applyTextEdits(textEdits)).toMatchInlineSnapshot(`
const textEdits = project.editDigraph(
{
fileName: 'index.ts',
machineIndex: 0,
},
{
type: 'add_transition',
sourcePath: [],
targetPath: ['bar'],
transitionPath: ['on', 'NEXT', 0],
reenter: true,
guard: 'isItTooLate',
},
);
expect(await project.applyTextEdits(textEdits)).toMatchInlineSnapshot(`
{
"index.ts": "import { createMachine } from "xstate";
Expand All @@ -1772,42 +1764,39 @@ test.todo(
});",
}
`);
},
);
});

test.todo(
`should be possible to add a targetless transition with a guard`,
async () => {
const tmpPath = await testdir({
'tsconfig.json': JSON.stringify({}),
'index.ts': ts`
import { createMachine } from "xstate";
test(`should be possible to add a targetless transition with a guard`, async () => {
const tmpPath = await testdir({
'tsconfig.json': JSON.stringify({}),
'index.ts': ts`
import { createMachine } from "xstate";
createMachine({
initial: "foo",
states: {
foo: {},
},
});
`,
});
createMachine({
initial: "foo",
states: {
foo: {},
},
});
`,
});

const project = await createTestProject(tmpPath);
const project = await createTestProject(tmpPath);

const textEdits = project.editDigraph(
{
fileName: 'index.ts',
machineIndex: 0,
},
{
type: 'add_transition',
sourcePath: ['foo'],
targetPath: null,
transitionPath: ['on', 'NEXT', 0],
guard: 'isItTooLate',
},
);
expect(await project.applyTextEdits(textEdits)).toMatchInlineSnapshot(`
const textEdits = project.editDigraph(
{
fileName: 'index.ts',
machineIndex: 0,
},
{
type: 'add_transition',
sourcePath: ['foo'],
targetPath: null,
transitionPath: ['on', 'NEXT', 0],
guard: 'isItTooLate',
},
);
expect(await project.applyTextEdits(textEdits)).toMatchInlineSnapshot(`
{
"index.ts": "import { createMachine } from "xstate";
Expand All @@ -1826,5 +1815,4 @@ test.todo(
});",
}
`);
},
);
});
10 changes: 10 additions & 0 deletions new-packages/ts-project/__tests__/utils.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import { onExit } from 'signal-exit';
import { temporaryDirectory } from 'tempy';
import typescript from 'typescript';
import { TSProjectOptions, XStateProject, createProject } from '../src/index';
import { createGuardBlock, registerGuardBlock } from '../src/state';
import {
ActorBlock,
Edge,
Expand Down Expand Up @@ -413,6 +414,15 @@ function produceNewDigraphUsingEdit(
typeof edit.reenter === 'boolean' ? !edit.reenter : undefined,
},
};

if (edit.guard) {
const block = createGuardBlock({
sourceId: edit.guard,
parentId: newEdge.uniqueId,
});
registerGuardBlock(digraphDraft, block, newEdge);
}

digraphDraft.edges[newEdge.uniqueId] = newEdge;
break;
case 'remove_transition':
Expand Down
Loading

0 comments on commit 6290bfd

Please sign in to comment.