Add update schema functionality (#5003)

packages/bindgen/spec.yml

@@ -667,6 +667,7 @@ classes:
       read_group: () -> Group&
       duplicate: () -> TransactionRef
 
+      update_schema: '(schema: std::vector<ObjectSchema>, version: uint64_t, migration_function: Nullable<std::function<(old_realm: SharedRealm, new_realm: SharedRealm, new_schema_handle: Schema&) -> void>>, initialization_function: Nullable<std::function<(realm: SharedRealm) -> void>>, in_transaction: bool) -> void'
       enable_wait_for_change: ()
       wait_for_change: () -> bool
       wait_for_change_release: ()

packages/realm/src/Realm.ts

@@ -367,8 +367,14 @@ export class Realm {
     throw new Error("Not yet implemented");
   }
 
-  _updateSchema(): unknown {
-    throw new Error("Not yet implemented");
+  _updateSchema(schema: Realm.ObjectSchema[]): void {
+    const normalizedSchema = schema && normalizeRealmSchema(schema);
+    const bindingSchema = normalizedSchema && toBindingSchema(normalizedSchema);
+    if (!this.isInTransaction) {
+      throw new Error("Can only create object schema within a transaction.");
+    }
+    this.internal.updateSchema(bindingSchema, this.internal.schemaVersion + 1n, null, null, true);
+    this.classes = new ClassMap(this, this.internal.schema, this.schemaExtras);
   }
 
   /**

packages/realm/src/tests/updateschema.test.ts

@@ -0,0 +1,51 @@
+////////////////////////////////////////////////////////////////////////////
+//
+// Copyright 2022 Realm Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+////////////////////////////////////////////////////////////////////////////
+
+import { ObjectSchema, Realm } from "../index";
+import { expect } from "chai";
+
+import { closeRealm, generateTempRealmPath, RealmContext } from "./utils";
+
+const oldSchema: ObjectSchema[] = [{ name: "Person", properties: { name: "string", age: "int" } }];
+const newSchema: ObjectSchema[] = [{ name: "Person2", properties: { title: "string", friends: "int" } }];
+
+describe("realm._updateSchema", () => {
+  beforeEach(function (this: RealmContext) {
+    this.realm = new Realm({
+      path: generateTempRealmPath(),
+      inMemory: true,
+      schema: oldSchema,
+    });
+  });
+  after(closeRealm);
+
+  it("can add new schema classes", function (this: RealmContext) {
+    this.realm.write(() => {
+      this.realm._updateSchema(newSchema);
+      this.realm.create("Person2", { title: "Good", friends: 3 });
+    });
+  });
+  it("can only be called in a transaction", function (this: RealmContext) {
+    this.realm = new Realm({
+      path: generateTempRealmPath(),
+      inMemory: true,
+      schema: [{ name: "Person", properties: { name: "string", age: "int" } }],
+    });
+    expect(() => this.realm._updateSchema(newSchema)).throw("Can only create object schema within a transaction.");
+  });
+});