Babel plugin changes #4938

tomduncalf · 2022-09-21T10:53:11Z

What, How & Why?

This PR contains all additional changes I've made to Kraen's Babel Plugin branch, except the template app changes which are in a separate PR, because they can't be merged yet.

I've also created a separate PR containing the entire Babel plugin pointing to v11 if we'd prefer to review it all in one.

☑️ ToDos

📝 Changelog entry
📝 Compatibility label is updated or copied from previous entry
📝 Update COMPATIBILITY.md
🚦 Tests
🔀 Executed flexible sync tests locally if modifying flexible sync
📦 Updated internal package version in consuming package.jsons (if updating internal packages)
📱 Check the React Native/other sample apps work if necessary
📝 Public documentation PR created or is not necessary
💥 Breaking label has been applied or is not necessary

If this PR adds or changes public API's:

typescript definitions file is updated
jsdoc files updated
Chrome debug API is updated if API is available on React Native

cla-bot · 2022-09-27T13:50:16Z

Realm welcomes all contributions! The only requirement we have is that, like many other projects, we need to have a Contributor License Agreement (CLA) in place before we can accept any external code. Our own CLA is a modified version of the Apache Software Foundation’s CLA. Our records show that CLA has not been signed by @github-actions[bot]. Please submit your CLA electronically using our Google form so we can accept your submissions. After signing the CLA you can recheck this PR with a @cla-bot check comment. The GitHub usernames you file there will need to match that of your Pull Requests. If you have any questions or cannot file the CLA electronically, make a comment here and we will be happy to help you out.

cla-bot · 2022-09-29T10:26:59Z

Realm welcomes all contributions! The only requirement we have is that, like many other projects, we need to have a Contributor License Agreement (CLA) in place before we can accept any external code. Our own CLA is a modified version of the Apache Software Foundation’s CLA. Our records show that CLA has not been signed by @github-actions[bot]. Please submit your CLA electronically using our Google form so we can accept your submissions. After signing the CLA you can recheck this PR with a @cla-bot check comment. The GitHub usernames you file there will need to match that of your Pull Requests. If you have any questions or cannot file the CLA electronically, make a comment here and we will be happy to help you out.

cla-bot · 2022-09-29T14:39:02Z

Realm welcomes all contributions! The only requirement we have is that, like many other projects, we need to have a Contributor License Agreement (CLA) in place before we can accept any external code. Our own CLA is a modified version of the Apache Software Foundation’s CLA. Our records show that CLA has not been signed by @github-actions[bot]. Please submit your CLA electronically using our Google form so we can accept your submissions. After signing the CLA you can recheck this PR with a @cla-bot check comment. The GitHub usernames you file there will need to match that of your Pull Requests. If you have any questions or cannot file the CLA electronically, make a comment here and we will be happy to help you out.

kraenhansen · 2022-10-03T08:42:48Z

packages/babel-plugin/README.md

+     // Add the following plugins:
+     plugins: [
+       '@realm/babel-plugin',
+       ['@babel/plugin-proposal-decorators', { legacy: true }],


I was thinking that we should also publish a @realm/babel-config which would check / add these plugins, to simplify consumption. Perhaps not right away, but eventually.

That is a nice idea! I can look into it

I have created #5009 to track it

kraenhansen · 2022-10-03T08:44:31Z

packages/babel-plugin/src/plugin/index.ts

+      !types.isClassProperty(classPropertyNode) ||
+      classPropertyNode.optional
+    ) {
+      throw new Error(getLinkingObjectsError("Properties of type LinkingObjects cannot be optional"));


🥇 for preconditions + errors ... Perhaps we're missing some elsewhere?

Yeah probably – I actually meant to ask your opinion on whether this is overkill or not? i.e. should we just rely on the type definitions?

I think throwing an explicit error is probably better though, as sometimes people will ignore TS errors

Would it be possible to send this to babel somehow, in a way that wouldn't make it completely unusable if a property is misconfigured, but simply error through to the bundler. I don't know what's available for babel plugins to report errors or warnings.

Yeah that is a good idea – I'll do some research.

Actually I think this should be a throw, as if you replace it with e.g. a console.warn, you then end up with Property 'xxx' of type 'linking objects' cannot be nullable. – so you are specifying an invalid schema.

However if you use throw path.buildCodeFrameError(errorMsg), you get a better error message which shows the source of the error, so I will switch to that.

I couldn't really think of any other good preconditions. The type argument for List/Dictionary/Set is optional and if they supply more than 1 type argument for some reason it will still work as intended... doesn't really seem worth checking. Can you think of anywhere else?

packages/babel-plugin/README.md

This reverts commit cefb8bd.

This reverts commit 5b1c627.

This reverts commit 7bb1e10.

This reverts commit 5c2b7e1.

tomduncalf · 2022-10-11T12:11:37Z

@kraenhansen I made the changes we talked about yesterday:

Split out into new PRs and remove from this:
- RequiredFields change (Allow specifying required fields on Realm.Object #5000)
- Default property function (Add support and test for function default properties #5001)
Decorators:
- Remove rollup and export decorators from realm
- Remove decorators from the babel output + make them throw if used at runtime
Readme:
- Copy paste error on ObjectId in readme
- Add the other types to Realm.Types in extensions.js
- Remove unknown from README.
- Note that provided by Realm are exported at the top level as well as in types

kneth · 2022-10-14T13:37:39Z

CHANGELOG.md

@@ -28,6 +28,7 @@ Based on Realm JS v10.21.1: See changelog below for details on enhancements and
    ```
 ### Enhancements
 * Small improvement to performance by caching JSI property String object [#4863](https://github.com/realm/realm-js/pull/4863)
+* Added new package `@realm/babel-plugin` to enable definining your Realm models using standard Typescript syntax [#4938](https://github.com/realm/realm-js/pull/4938)


The initial announcement of the plugin can be done here. For the future I suggest that plugin's package has its own changelog.

kneth · 2022-10-14T13:50:52Z

packages/babel-plugin/README.md

+
+## Introduction
+
+The Realm Babel plugin enables defining your Realm models using standard Typescript syntax - no need to define a separate schema.


Suggested change

The Realm Babel plugin enables defining your Realm models using standard Typescript syntax - no need to define a separate schema.

The Realm Babel plugin enables defining your Realm models using standard TypeScript syntax - no need to define a separate schema.

kneth · 2022-10-14T14:00:54Z

packages/babel-plugin/README.md

+     // Add the following plugins:
+     plugins: [
+       '@realm/babel-plugin',
+       ['@babel/plugin-proposal-decorators', { legacy: true }],


I have created #5009 to track it

kneth · 2022-10-14T14:07:45Z

packages/babel-plugin/src/plugin/index.ts

+    (d) =>
+      d.node &&
+      isRealmDecoratorWithName(d.node.expression, name) &&
+      // ((types.isIdentifier(d.node.expression) && d.node.expression.name === name) ||


Can it be removed?

kneth · 2022-10-14T14:08:00Z

packages/babel-plugin/src/plugin/index.ts

+      d.node &&
+      types.isCallExpression(d.node.expression) &&
+      isRealmDecoratorWithName(d.node.expression.callee, name) &&
+      // types.isIdentifier(d.node.expression.callee) &&


Can it be removed?

cla-bot bot added the cla: yes label Sep 21, 2022

tomduncalf force-pushed the td/kh-babel-plugin-2 branch 15 times, most recently from 26cda48 to 963fcdc Compare September 27, 2022 13:50

cla-bot bot removed the cla: yes label Sep 27, 2022

tomduncalf changed the base branch from kh/babel-plugin to td/kh-babel-plugin-orig September 29, 2022 14:40

Tom Duncalf added 9 commits September 29, 2022 15:40

Data and LinkingObjects types

3f85e81

Add support for static properties

54d29d2

Decorators support, needs tsc fixing

88a933a

Fix types for decorators

d19ae3a

Updated template app and added decorators

ca09443

Add decorators to full schema test

c53deb7

Add test for type precedence

4d71b49

Disable test

530b316

Add babel-plugin-decorators check

8eed123

Tom Duncalf added 3 commits September 30, 2022 12:19

Ignore generated types dir

e319fa0

PR tidy

0030310

More PR tidy

0a789a8

tomduncalf changed the title ~~Td/kh babel plugin 2~~ Babel plugin changes Sep 30, 2022

tomduncalf mentioned this pull request Sep 30, 2022

Babel plugin template app changes #4964

Closed

12 tasks

Tom Duncalf added 2 commits September 30, 2022 14:30

Fix lint

cefb8bd

Add workflow for babel plugin

facf2a9

tomduncalf marked this pull request as ready for review September 30, 2022 13:46

tomduncalf requested a review from kraenhansen September 30, 2022 13:46

kraenhansen reviewed Oct 3, 2022

View reviewed changes

Tom Duncalf added 2 commits October 3, 2022 13:19

Readme fix

e2a70a9

Update errors to use buildCodeFrameError

c5357d8

kneth approved these changes Oct 6, 2022

View reviewed changes

packages/babel-plugin/README.md Outdated Show resolved Hide resolved

packages/babel-plugin/README.md Show resolved Hide resolved

packages/babel-plugin/README.md Show resolved Hide resolved

Tom Duncalf added 10 commits October 11, 2022 11:24

Revert "Fix lint"

ae5d3c7

This reverts commit cefb8bd.

Revert "Add docblock and fix types"

c6627d8

This reverts commit 5b1c627.

Revert "Add type for RequiredFields on Realm.Object"

904b374

This reverts commit 7bb1e10.

Revert "Add support and test for function default properties"

f2b951f

This reverts commit 5c2b7e1.

PR changes

bedf559

Remove decorators from output

e131633

Move decorators into Realm package and throw if used at runtime

ec86219

Remove decorators from plugin and remove rollup in favour of tsc

358466c

Handle decorators imported from Realm

77286a3

Changelog

5190b15

tomduncalf force-pushed the td/kh-babel-plugin-2 branch from 1a0c9c6 to 5190b15 Compare October 11, 2022 12:10

kneth approved these changes Oct 14, 2022

View reviewed changes

Update pr-babel-plugin.yml

036fa7b

kraenhansen merged commit 0c5c99b into td/kh-babel-plugin-orig Oct 18, 2022

github-actions bot locked as resolved and limited conversation to collaborators Mar 15, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Babel plugin changes #4938

Babel plugin changes #4938

tomduncalf commented Sep 21, 2022 •

edited

Loading

cla-bot bot commented Sep 27, 2022

cla-bot bot commented Sep 29, 2022

cla-bot bot commented Sep 29, 2022

kraenhansen Oct 3, 2022

tomduncalf Oct 3, 2022 •

edited

Loading

kneth Oct 14, 2022

kraenhansen Oct 3, 2022

tomduncalf Oct 3, 2022

kraenhansen Oct 3, 2022

tomduncalf Oct 3, 2022

tomduncalf Oct 3, 2022

tomduncalf Oct 3, 2022

tomduncalf commented Oct 11, 2022 •

edited

Loading

kneth Oct 14, 2022

kneth Oct 14, 2022

kneth Oct 14, 2022

kneth Oct 14, 2022

kneth Oct 14, 2022


		## Introduction

		The Realm Babel plugin enables defining your Realm models using standard Typescript syntax - no need to define a separate schema.

Babel plugin changes #4938

Babel plugin changes #4938

Conversation

tomduncalf commented Sep 21, 2022 • edited Loading

What, How & Why?

☑️ ToDos

cla-bot bot commented Sep 27, 2022

cla-bot bot commented Sep 29, 2022

cla-bot bot commented Sep 29, 2022

Choose a reason for hiding this comment

tomduncalf Oct 3, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tomduncalf commented Oct 11, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tomduncalf commented Sep 21, 2022 •

edited

Loading

tomduncalf Oct 3, 2022 •

edited

Loading

tomduncalf commented Oct 11, 2022 •

edited

Loading