feat: Create codemod for v0.39.0 -> v0.40.0

codecov.yml

@@ -2,3 +2,4 @@ codecov:
   branch: main
 ignore:
   - "packages/entity-example"
+  - "packages/entity-codemod"

packages/entity-codemod/.eslintignore

@@ -0,0 +1 @@
+**/__testfixtures__/**

packages/entity-codemod/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+

packages/entity-codemod/README.md

@@ -0,0 +1,26 @@
+# @expo/entity-codemod
+
+A package containing jscodeshift codemods for @expo/entity upgrades.
+
+Codemods are transformations that run on your codebase programmatically. This allows for a large amount of changes to be applied without having to manually go through every file.
+
+## Usage
+
+These should be used via the [jscodeshift CLI](https://github.com/facebook/jscodeshift?tab=readme-ov-file#usage-cli).
+
+For example:
+
+```
+yarn add -D @expo/entity-codemod
+```
+
+Then, in package.json scripts:
+
+```json
+"jscodeshift": "jscodeshift --extensions=ts --parser=ts"
+```
+
+And finally:
+```sh
+yarn jscodeshift src -t node_modules/@expo/entity-codemod/build/v0.39.0-v0.40.0.js
+```

packages/entity-codemod/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@expo/entity-codemod",
+  "version": "0.39.0",
+  "description": "jscodeshift codemods for @expo/entity upgrades",
+  "files": [
+    "build",
+    "src"
+  ],
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "scripts": {
+    "tsc": "tsc",
+    "clean": "rm -rf build coverage coverage-integration",
+    "lint": "eslint src",
+    "lint-fix": "eslint src --fix",
+    "test": "jest --rootDir . --config ../../resources/jest.config.js"
+  },
+  "engines": {
+    "node": ">=16"
+  },
+  "keywords": [
+    "entity"
+  ],
+  "author": "Expo",
+  "license": "MIT",
+  "dependencies": {},
+  "devDependencies": {
+    "@types/jscodeshift": "^0.12.0",
+    "jscodeshift": "^17.1.2"
+  },
+  "peerDependencies": {
+    "@expo/entity": "*"
+  }
+}

packages/entity-codemod/src/transforms/__testfixtures__/v0.39.0-v0.40.0/test1.input.ts

@@ -0,0 +1,79 @@
+/* eslint-disable */
+
+import { ViewerContext } from '@expo/entity';
+
+async function testWithAuthorizationResults(viewerContext: ViewerContext): Promise<void> {
+  // creator
+  const entityResult = await TestEntity.creator(viewerContext).setField('wat', 2).createAsync();
+
+  // updater
+  const updatedEntityResult = await TestEntity.updater(entityResult.enforceValue()).setField('wat', 3).updateAsync();
+
+  // deleter
+  await TestEntity.deleteAsync(updatedEntityResult.enforceValue());
+}
+
+async function testEnforcing(viewerContext: ViewerContext): Promise<void> {
+  // creator
+  const entity = await TestEntity.creator(viewerContext).setField('wat', 2).enforceCreateAsync();
+  const entity2 = await TestEntity.creator(viewerContext).setField('wat', 2).setField('who', 3).enforceCreateAsync();
+  const entity3 = await TestEntity.creator(viewerContext)
+    .setField('wat', 2)
+    .setField('who', 3)
+    .setField('who', 4)
+    .setField('who', 5)
+    .setField('who', 6)
+    .setField('who', 7)
+    .setField('who', 8)
+    .setField('who', 9)
+    .enforceCreateAsync();
+
+  // updater
+  const updatedEntity = await TestEntity.updater(entity).setField('wat', 3).enforceUpdateAsync();
+  const updatedEntity2 = await TestEntity.updater(entity2).setField('wat', 3).setField('who', 4).enforceUpdateAsync();
+  const updatedEntity3 = await TestEntity.updater(entity3)
+    .setField('wat', 3)
+    .setField('who', 4)
+    .setField('who', 5)
+    .setField('who', 6)
+    .setField('who', 7)
+    .setField('who', 8)
+    .setField('who', 9)
+    .enforceUpdateAsync();
+
+  // deleter
+  await TestEntity.enforceDeleteAsync(entity);
+}
+
+async function testNoSetField(viewerContext: ViewerContext): Promise<void> {
+  // creator
+  const entity = await TestEntity.creator(viewerContext).enforceCreateAsync();
+
+  // updater
+  const updatedEntity = await TestEntity.updater(entity).enforceUpdateAsync();
+}
+
+async function testEnforcingWithQueryContext(viewerContext: ViewerContext): Promise<void> {
+  // creator
+  const entity = await TestEntity.creator(viewerContext, queryContext).setField('wat', 2).enforceCreateAsync();
+
+  // updater
+  const updatedEntity = await TestEntity.updater(entity, queryContext).setField('wat', 3).enforceUpdateAsync();
+
+  // deleter
+  await TestEntity.enforceDeleteAsync(entity, queryContext);
+}
+
+async function testAssociationLoader(): Promise<void> {
+  await this.associationLoader().loadAssociatedEntityAsync(
+    'another_id',
+    AnotherEntity,
+    queryContext
+  );
+
+  await entity.associationLoader().loadAssociatedEntityAsync(
+    'another_id',
+    AnotherEntity,
+    queryContext
+  )
+}

packages/entity-codemod/src/transforms/__testfixtures__/v0.39.0-v0.40.0/test1.output.ts

@@ -0,0 +1,79 @@
+/* eslint-disable */
+
+import { ViewerContext } from '@expo/entity';
+
+async function testWithAuthorizationResults(viewerContext: ViewerContext): Promise<void> {
+  // creator
+  const entityResult = await TestEntity.creator(viewerContext).withAuthorizationResults().setField('wat', 2).createAsync();
+
+  // updater
+  const updatedEntityResult = await TestEntity.updater(entityResult.enforceValue()).withAuthorizationResults().setField('wat', 3).updateAsync();
+
+  // deleter
+  await TestEntity.deleter(updatedEntityResult.enforceValue()).withAuthorizationResults().deleteAsync();
+}
+
+async function testEnforcing(viewerContext: ViewerContext): Promise<void> {
+  // creator
+  const entity = await TestEntity.creator(viewerContext).enforcing().setField('wat', 2).createAsync();
+  const entity2 = await TestEntity.creator(viewerContext).enforcing().setField('wat', 2).setField('who', 3).createAsync();
+  const entity3 = await TestEntity.creator(viewerContext).enforcing()
+    .setField('wat', 2)
+    .setField('who', 3)
+    .setField('who', 4)
+    .setField('who', 5)
+    .setField('who', 6)
+    .setField('who', 7)
+    .setField('who', 8)
+    .setField('who', 9)
+    .createAsync();
+
+  // updater
+  const updatedEntity = await TestEntity.updater(entity).enforcing().setField('wat', 3).updateAsync();
+  const updatedEntity2 = await TestEntity.updater(entity2).enforcing().setField('wat', 3).setField('who', 4).updateAsync();
+  const updatedEntity3 = await TestEntity.updater(entity3).enforcing()
+    .setField('wat', 3)
+    .setField('who', 4)
+    .setField('who', 5)
+    .setField('who', 6)
+    .setField('who', 7)
+    .setField('who', 8)
+    .setField('who', 9)
+    .updateAsync();
+
+  // deleter
+  await TestEntity.deleter(entity).enforcing().deleteAsync();
+}
+
+async function testNoSetField(viewerContext: ViewerContext): Promise<void> {
+  // creator
+  const entity = await TestEntity.creator(viewerContext).enforcing().createAsync();
+
+  // updater
+  const updatedEntity = await TestEntity.updater(entity).enforcing().updateAsync();
+}
+
+async function testEnforcingWithQueryContext(viewerContext: ViewerContext): Promise<void> {
+  // creator
+  const entity = await TestEntity.creator(viewerContext, queryContext).enforcing().setField('wat', 2).createAsync();
+
+  // updater
+  const updatedEntity = await TestEntity.updater(entity, queryContext).enforcing().setField('wat', 3).updateAsync();
+
+  // deleter
+  await TestEntity.deleter(entity, queryContext).enforcing().deleteAsync();
+}
+
+async function testAssociationLoader(): Promise<void> {
+  await this.associationLoader().withAuthorizationResults().loadAssociatedEntityAsync(
+    'another_id',
+    AnotherEntity,
+    queryContext
+  );
+
+  await entity.associationLoader().withAuthorizationResults().loadAssociatedEntityAsync(
+    'another_id',
+    AnotherEntity,
+    queryContext
+  )
+}

packages/entity-codemod/src/transforms/__testfixtures__/v0.39.0-v0.40.0/test2.input.ts

@@ -0,0 +1,10 @@
+/* eslint-disable */
+
+async function testAsync(viewerContext: ViewerContext): Promise<void> {
+  const testTrigger = await TestTriggerEntity.createAsync(actorViewerContext, undefined, {
+    appId,
+  });
+
+  await TestTriggerEntity.enforceDeleteAsync(testTrigger);
+  return testTrigger;
+};

packages/entity-codemod/src/transforms/__testfixtures__/v0.39.0-v0.40.0/test2.output.ts

@@ -0,0 +1,10 @@
+/* eslint-disable */
+
+async function testAsync(viewerContext: ViewerContext): Promise<void> {
+  const testTrigger = await TestTriggerEntity.createAsync(actorViewerContext, undefined, {
+    appId,
+  });
+
+  await TestTriggerEntity.deleter(testTrigger).enforcing().deleteAsync();
+  return testTrigger;
+};

packages/entity-codemod/src/transforms/__testfixtures__/v0.39.0-v0.40.0/test3.input.ts

@@ -0,0 +1,5 @@
+/* eslint-disable */
+
+async function anotherCase(updater: any): Promise<any> {
+  return await updater.enforceUpdateAsync();
+}

packages/entity-codemod/src/transforms/__testfixtures__/v0.39.0-v0.40.0/test3.output.ts

@@ -0,0 +1,5 @@
+/* eslint-disable */
+
+async function anotherCase(updater: any): Promise<any> {
+  return await updater.enforceUpdateAsync();
+}

packages/entity-codemod/src/transforms/__tests__/v0.39.0-v0.40.0-test.ts

@@ -0,0 +1,16 @@
+import { readdirSync } from 'fs';
+import { join } from 'path';
+
+jest.autoMockOff();
+const defineTest = require('jscodeshift/dist/testUtils').defineTest;
+
+const fixtureDir = 'v0.39.0-v0.40.0';
+const fixtureDirPath = join(__dirname, '..', '__testfixtures__', fixtureDir);
+const fixtures = readdirSync(fixtureDirPath)
+  .filter((file) => file.endsWith('.input.ts'))
+  .map((file) => file.replace('.input.ts', ''));
+
+for (const fixture of fixtures) {
+  const prefix = `${fixtureDir}/${fixture}`;
+  defineTest(__dirname, 'v0.39.0-v0.40.0', null, prefix, { parser: 'ts' });
+}