Racer 2 #302

craigbeck · 2024-04-09T19:58:57Z

racer@2 breaking changes:

The Model class should no longer be directly constructed. Use createModel() instead.
- For example, new racer.Model() -> racer.createModel()
- Directly trying to construct Model can result in errors like Cannot set properties of undefined (setting 'socket') from Model.createConnection
racer no longer and instance. racer now a proper namespace
legacy event handlers not supported by typescript
Drop support for node 10-14
remove deprecated getModel() method form req object in modelMiddleware

…ources to lib

…tures

ericyhwang

Initial comments on several files, still a bunch more to go through

src/Model/collections.ts

src/Model/connection.ts

src/Model/events.ts

src/Model/filter.ts

…amed functions

…to have a value

ericyhwang · 2024-04-25T22:24:17Z

src/Model/mutators.ts

+      // (value, null)
+      value = arguments[0];
+      cb = arguments[1];


Are there cases where null is passed as a callback explicitly?

ericyhwang · 2024-04-25T22:26:30Z

src/Model/mutators.ts

@@ -167,7 +333,7 @@ Model.prototype._create = function(segments, value, cb) {
    var event = new ChangeEvent(value, previous, model._pass);
    model._emitMutation(segments, event);
  }
-  this._mutate(segments, create, cb);
+  return this._mutate(segments, create, cb);


The typing of model.create() indicates that it doesn't return anything (void return), so a technically more accurate thing to do would be:

Remove the return above in return this._create(segments, value, cb);

Then this new extra return here isn't needed

Same in _createNull, the new return is no longer needed either

src/Model/ref.ts

ericyhwang · 2024-04-25T22:31:57Z

src/Model/mutators.ts

+    pushPromised(value: any): Promise<number>;
+    pushPromised(subpath: Path, value: any): Promise<number>;


Yes I think so, since callback doesn't get invoked with any result

src/Model/types.ts

ericyhwang · 2024-04-25T22:53:39Z

src/Model/Doc.ts

+import { Collection } from './collections';
+import { Path } from '../types';

-function Doc(model, collectionName, id) {
-  this.collectionName = collectionName;
-  this.id = id;
-  this.collectionData = model && model.data[collectionName];
-}
+export class Doc {
+  collectionData: Model;
+  collectionName: string;
+  data: any;


data only appears to be used by LocalDoc, not RemoteDoc. Might be possible to move it to the LocalDoc subclass, instead of having it here in the base class

ericyhwang · 2024-04-25T22:55:08Z

src/Model/Doc.ts

-  if (segments && segments.length) path += '.' + segments.join('.');
-  return path;
-};
+  constructor(model: Model, collectionName: string, id: string, data?: any, _collection?: Collection) {


Can probably remove the final unused _collection param

Used here https://github.com/derbyjs/racer/blob/racer-2/src/Model/collections.ts#L211

But cant see why this is passed 🤷

... oh.. used on RemoteDoc

Removing it leads to type errors where we pass it, then removing that leads to test errors. Looks like a rabbit hole for later

ericyhwang · 2024-04-25T23:03:36Z

src/Model/Model.ts

+}
+
+export class RootModel extends Model<ModelData> {
+  backend: RacerBackend;


Technically should be optional, as it's only present on server-side models created with backend.createModel(), but may cause type breakages if made optional. Could try it and see

src/Model/Query.ts

ericyhwang · 2024-04-25T23:11:09Z

src/index.ts

+export function createBackend(options?: BackendOptions) {
+  return new RacerBackend(racer, options);
+}


Good point, it might cause a bundler to bring in the backend code. We could change this to a stub implementation that throws, and switch the RacerBackend to a type import for type info

src/util.ts

…ay cases that don't actually occur

craigbeck added 30 commits June 22, 2023 16:38

Move lib to src

0a6788d

Add tsconfig and package scripts for typescript transpilation of js s…

2c74a81

…ources to lib

Change var name and remove jsdoc types to pass tsc build

82948ac

Add typescript as dev dependency

2573902

Update prepare script (missed "run")

84feb20

Remove useage of npx because node 10

ac8a897

Drop node 10 and 12 from test matrix

1df1ec0

Eslint to ignore compiler emitted lib files

d5f3c3c

Rename Model.js > Model.ts

6f1fc39

Convert Model and ChildModel to class syntax

d3d8979

Rename files, js => ts

aed59e9

Convert Racer to class; resolve circular require w Racer.server

1eabf56

Rename js -> ts

2caa481

Convert index, Racer, Backend to ts

0ee8c10

Rename util.js -> .ts

c25f2f3

Convert util to ts

13fb89e

Type intermediate var

0320c10

Rename unbundle.js -> .ts

5e9bb53

Use export of Model and ChildModel

ba2f002

Convert unbundle to ts

d8c93f9

Bulk rename Model/*.js to .ts

822eda0

Convert Model to typescript (3 errors)

72a23ff

Fix return type on removeListener

e6b5736

Do not extend EventEmitter as overridden methods have different signa…

31e997d

…tures

Resolve _getDocConstructor return error

39d7805

Fixes for promised returns and change requires to imports

b4eef54

Update requires for new exports

d922dea

Use prototype for type and _immediateType as expected by inits

adab971

Use exports and import defaultFns

664d58c

Fix type in method name

abc6285

craigbeck added 5 commits April 25, 2024 09:54

Make close callback optional

6aab996

Add generic param to filter.get()

ecf0e5f

Fix closePromised type

de7611c

Remove unused import; loosen QueryOptions type (db not required)

ff00e1f

2.0.0-beta.18

5b31ca2

ericyhwang reviewed Apr 25, 2024

View reviewed changes

craigbeck added 11 commits April 25, 2024 14:06

Remove unused import

39adda2

Type to and from

92350c3

Move on "all" (w/o path) and "error" handlers to RootModel

9fcfb6a

Remove EventCaptures type; update all path type

a4ae98c

Duplicate Model on signatures in RootModel to handle overrides

255213e

2.0.0-beta.19

8ba7f68

FilterFn required in all cases; additionally add string as type for n…

8139098

…amed functions

Return to previous implementation now that filter fn always required …

2a88194

…to have a value

Update doc links to new addresses

fbc1d05

Update doc url

147e1c9

Make fetch callback optional as is everywhere else

2d4a30e

ericyhwang reviewed Apr 25, 2024

View reviewed changes

src/util.ts Outdated Show resolved Hide resolved

craigbeck and others added 9 commits April 26, 2024 13:11

Ensure promised methods typed as Promise<void>

54628e5

Remove returns from create and createNull

d60661a

Consolidate types; remove Model/types

e63049f

2.0.0-beta.20

3e8fc8d

Add typings for *Immediate event listeners, mostly used by Derby

2908684

castSegments: Remove unnecessary handling of nested array and non-arr…

67745a3

…ay cases that don't actually occur

2.0.0-beta.21

4a2d06f

RacerBackend type-only export and serverRequire backend in createBackend

d106e83

2.0.0-beta.22

0a40f23

craigbeck merged commit 168d03d into master May 1, 2024
8 checks passed

craigbeck deleted the racer-2 branch May 1, 2024 18:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Racer 2 #302

Racer 2 #302

craigbeck commented Apr 9, 2024 •

edited

Loading

ericyhwang left a comment

ericyhwang Apr 25, 2024

ericyhwang Apr 25, 2024

ericyhwang Apr 25, 2024

ericyhwang Apr 25, 2024

ericyhwang Apr 25, 2024

craigbeck Apr 26, 2024 •

edited

Loading

craigbeck Apr 26, 2024

ericyhwang Apr 25, 2024

ericyhwang Apr 25, 2024

		pushPromised(value: any): Promise<number>;
		pushPromised(subpath: Path, value: any): Promise<number>;

Racer 2 #302

Racer 2 #302

Conversation

craigbeck commented Apr 9, 2024 • edited Loading

ericyhwang left a 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

craigbeck Apr 26, 2024 • 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

craigbeck commented Apr 9, 2024 •

edited

Loading

craigbeck Apr 26, 2024 •

edited

Loading