Inline remotedev-serialize, stop using jsan.

.prettierignore

@@ -2,4 +2,4 @@
 src/emoji/__tests__/data-test.js
 
 # We're not allowing Prettier to touch some of our vendored code.
-src/third/redux-persist
+src/third/redux-persist

package.json

@@ -88,7 +88,6 @@
     "redux-batched-actions": "^0.3.0",
     "redux-logger": "^3.0.1",
     "redux-thunk": "^2.1.0",
-    "remotedev-serialize": "zulip/remotedev-serialize#5f9f759a4",
     "reselect": "^3.0.1",
     "rn-fetch-blob": "^0.11.0",
     "string.fromcodepoint": "^0.2.1",

src/boot/__tests__/__snapshots__/replaceRevive-test.js.snap

@@ -0,0 +1,17 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Stringify fallbackAvatarURL 1`] = `"{\\"data\\":\\"https://zulip.example.org/avatar/1\\",\\"__serializedType__\\":\\"FallbackAvatarURL\\"}"`;
+
+exports[`Stringify gravatarURL 1`] = `"{\\"data\\":\\"https://secure.gravatar.com/avatar/3b01d0f626dc6944ed45dbe6c86d3e30?d=identicon\\",\\"__serializedType__\\":\\"GravatarURL\\"}"`;
+
+exports[`Stringify map 1`] = `"{\\"data\\":{\\"a\\":1,\\"b\\":2,\\"c\\":3,\\"d\\":4},\\"__serializedType__\\":\\"ImmutableMap\\"}"`;
+
+exports[`Stringify mapWithTypeKey 1`] = `"{\\"data\\":{\\"__serializedType__\\":\\"Object\\",\\"data\\":{\\"a\\":1},\\"__serializedType__value\\":{\\"__serializedType__\\":\\"Object\\",\\"data\\":{\\"b\\":[2]},\\"__serializedType__value\\":{\\"c\\":[3]}}},\\"__serializedType__\\":\\"ImmutableMap\\"}"`;
+
+exports[`Stringify plainObjectWithTypeKey 1`] = `"{\\"__serializedType__\\":\\"Object\\",\\"data\\":{\\"a\\":1},\\"__serializedType__value\\":{\\"__serializedType__\\":\\"Object\\",\\"data\\":{\\"b\\":[2]},\\"__serializedType__value\\":{\\"c\\":[3]}}}"`;
+
+exports[`Stringify uploadedAvatarURL 1`] = `"{\\"data\\":\\"https://zulip.example.org/user_avatars/2/e35cdbc4771c5e4b94e705bf6ff7cca7fa1efcae.png?x=x&version=2\\",\\"__serializedType__\\":\\"UploadedAvatarURL\\"}"`;
+
+exports[`Stringify url 1`] = `"{\\"data\\":\\"https://chat.zulip.org/\\",\\"__serializedType__\\":\\"URL\\"}"`;
+
+exports[`Stringify zulipVersion 1`] = `"{\\"data\\":\\"3.0.0\\",\\"__serializedType__\\":\\"ZulipVersion\\"}"`;

src/boot/__tests__/replaceRevive-test.js

@@ -0,0 +1,76 @@
+/* @flow strict-local */
+/* eslint-disable id-match */
+/* eslint-disable no-underscore-dangle */
+
+import Immutable from 'immutable';
+
+import { FallbackAvatarURL, GravatarURL, UploadedAvatarURL } from '../../utils/avatar';
+import { ZulipVersion } from '../../utils/zulipVersion';
+import { stringify, parse, SERIALIZED_TYPE_FIELD_NAME } from '../replaceRevive';
+import * as eg from '../../__tests__/lib/exampleData';
+
+const data = {
+  map: Immutable.Map({ a: 1, b: 2, c: 3, d: 4 }),
+  mapWithTypeKey: Immutable.Map({
+    a: 1,
+    [SERIALIZED_TYPE_FIELD_NAME]: {
+      b: [2],
+      [SERIALIZED_TYPE_FIELD_NAME]: { c: [3] },
+    },
+  }),
+  zulipVersion: new ZulipVersion('3.0.0'),
+  url: new URL('https://chat.zulip.org'),
+  gravatarURL: GravatarURL.validateAndConstructInstance({ email: eg.selfUser.email }),
+  uploadedAvatarURL: UploadedAvatarURL.validateAndConstructInstance({
+    realm: eg.realm,
+    absoluteOrRelativeUrl:
+      '/user_avatars/2/e35cdbc4771c5e4b94e705bf6ff7cca7fa1efcae.png?x=x&version=2',
+  }),
+  fallbackAvatarURL: FallbackAvatarURL.validateAndConstructInstance({
+    realm: eg.realm,
+    userId: 1,
+  }),
+  plainObjectWithTypeKey: {
+    a: 1,
+    [SERIALIZED_TYPE_FIELD_NAME]: {
+      b: [2],
+      [SERIALIZED_TYPE_FIELD_NAME]: { c: [3] },
+    },
+  },
+};
+
+const stringified = {};
+describe('Stringify', () => {
+  Object.keys(data).forEach(key => {
+    it(key, () => {
+      stringified[key] = stringify(data[key]);
+      expect(stringified[key]).toMatchSnapshot();
+    });
+  });
+
+  test('catches an unexpectedly unhandled value with a `toJSON` method', () => {
+    expect(() => stringify(new Date())).toThrow();
+  });
+
+  test("catches a value that's definitely not serializable as-is", () => {
+    expect(() => stringify(() => 'foo')).toThrow();
+  });
+
+  test('catches an unexpectedly unhandled value of an interesting type', () => {
+    class Dog {
+      noise = 'woof';
+      makeNoise() {
+        console.log(this.noise); // eslint-disable-line no-console
+      }
+    }
+    expect(() => stringify(new Dog())).toThrow();
+  });
+});
+
+describe('Parse', () => {
+  Object.keys(data).forEach(key => {
+    it(key, () => {
+      expect(parse(stringified[key])).toEqual(data[key]);
+    });
+  });
+});

src/boot/replaceRevive.js

@@ -0,0 +1,139 @@
+/* @flow strict-local */
+import invariant from 'invariant';
+import Immutable from 'immutable';
+
+import { ZulipVersion } from '../utils/zulipVersion';
+import { GravatarURL, UploadedAvatarURL, FallbackAvatarURL } from '../utils/avatar';
+
+/**
+ * PRIVATE: Exported only for tests.
+ *
+ * A special identifier for the type of thing to be replaced/revived.
+ *
+ * Use this in the replacer and reviver, below, to make it easier to
+ * be consistent between them and avoid costly typos.
+ */
+export const SERIALIZED_TYPE_FIELD_NAME: '__serializedType__' = '__serializedType__';
+
+/**
+ * Like SERIALIZED_TYPE_FIELD_NAME, but with a distinguishing mark.
+ *
+ * Used in our strategy to ensure successful round-tripping when data
+ * has a key identical to SERIALIZED_TYPE_FIELD_NAME.
+ */
+const SERIALIZED_TYPE_FIELD_NAME_ESCAPED: '__serializedType__value' = '__serializedType__value';
+
+// Don't make this an arrow function -- we need `this` to be a special
+// value; see
+// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter.
+const replacer = function replacer(key, value) {
+  // The value at the current path before JSON.stringify called its
+  // `toJSON` method, if present.
+  //
+  // When identifying what kind of thing we're working with, be sure
+  // to examine `origValue` instead of `value`, if calling `toJSON` on
+  // that kind of thing would remove its identifying features -- which
+  // is to say, if that kind of thing has a `toJSON` method.
+  //
+  // For things that have a `toJSON` method, it may be convenient to
+  // set `data` to `value`, if we trust that `toJSON` gives the output
+  // we want to store there. And it would mean we don't discard the
+  // work `JSON.stringify` did by calling `toJSON`.
+  const origValue = this[key];
+  if (value instanceof ZulipVersion) {
+    return { data: value.raw(), [SERIALIZED_TYPE_FIELD_NAME]: 'ZulipVersion' };
+  } else if (origValue instanceof URL) {
+    return { data: origValue.toString(), [SERIALIZED_TYPE_FIELD_NAME]: 'URL' };
+  } else if (value instanceof GravatarURL) {
+    return { data: GravatarURL.serialize(value), [SERIALIZED_TYPE_FIELD_NAME]: 'GravatarURL' };
+  } else if (value instanceof UploadedAvatarURL) {
+    return {
+      data: UploadedAvatarURL.serialize(value),
+      [SERIALIZED_TYPE_FIELD_NAME]: 'UploadedAvatarURL',
+    };
+  } else if (value instanceof FallbackAvatarURL) {
+    return {
+      data: FallbackAvatarURL.serialize(value),
+      [SERIALIZED_TYPE_FIELD_NAME]: 'FallbackAvatarURL',
+    };
+  } else if (Immutable.Map.isMap(origValue)) {
+    return { data: value, [SERIALIZED_TYPE_FIELD_NAME]: 'ImmutableMap' };
+  }
+
+  if (typeof origValue === 'object' && origValue !== null) {
+    // Don't forget to handle a value's `toJSON` method, if present, as
+    // described above.
+    invariant(typeof origValue.toJSON !== 'function', 'unexpected toJSON');
+
+    // If storing an interesting data type, don't forget to handle it
+    // here, and in `reviver`.
+    const origValuePrototype = Object.getPrototypeOf(origValue);
+    invariant(
+      // Flow bug: https://github.com/facebook/flow/issues/6110
+      origValuePrototype === (Object.prototype: $FlowFixMe)
+        || origValuePrototype === (Array.prototype: $FlowFixMe),
+      'unexpected class',
+    );
+  }
+
+  if (typeof value === 'object' && value !== null && SERIALIZED_TYPE_FIELD_NAME in value) {
+    const copy = { ...value };
+    delete copy[SERIALIZED_TYPE_FIELD_NAME];
+    return {
+      [SERIALIZED_TYPE_FIELD_NAME]: 'Object',
+      data: copy,
+      [SERIALIZED_TYPE_FIELD_NAME_ESCAPED]: value[SERIALIZED_TYPE_FIELD_NAME],
+    };
+  }
+
+  return value;
+};
+
+const reviver = function reviver(key, value) {
+  if (value !== null && typeof value === 'object' && SERIALIZED_TYPE_FIELD_NAME in value) {
+    const data = value.data;
+    switch (value[SERIALIZED_TYPE_FIELD_NAME]) {
+      case 'ZulipVersion':
+        return new ZulipVersion(data);
+      case 'URL':
+        return new URL(data);
+      case 'GravatarURL':
+        return GravatarURL.deserialize(data);
+      case 'UploadedAvatarURL':
+        return UploadedAvatarURL.deserialize(data);
+      case 'FallbackAvatarURL':
+        return FallbackAvatarURL.deserialize(data);
+      case 'ImmutableMap':
+        return Immutable.Map(data);
+      case 'Object':
+        return {
+          ...data,
+          [SERIALIZED_TYPE_FIELD_NAME]: value[SERIALIZED_TYPE_FIELD_NAME_ESCAPED],
+        };
+      default:
+        return data;
+    }
+  }
+  return value;
+};
+
+export const stringify = function stringify(data: mixed): string {
+  const result = JSON.stringify(data, replacer);
+  if (result === undefined) {
+    // Flow says that the output for JSON.stringify could be
+    // undefined. From MDN:
+    //
+    // `JSON.stringify()` can return `undefined` when passing in
+    // "pure" values like `JSON.stringify(function(){})` or
+    // `JSON.stringify(undefined)`.
+    //
+    // We don't expect any of those inputs, but we'd want to know if
+    // we get one, since it means something has gone quite wrong.
+    throw new Error('undefined result for stringify');
+  }
+  return result;
+};
+
+export const parse = function parse(data: string): mixed {
+  return JSON.parse(data, reviver);
+};

src/boot/store.js

@@ -5,12 +5,11 @@ import thunkMiddleware from 'redux-thunk';
 import { createLogger } from 'redux-logger';
 import createActionBuffer from 'redux-action-buffer';
 import Immutable from 'immutable';
-import * as Serialize from 'remotedev-serialize';
 import { persistStore, autoRehydrate } from '../third/redux-persist';
 import type { Config } from '../third/redux-persist';
 
 import { ZulipVersion } from '../utils/zulipVersion';
-import { GravatarURL, UploadedAvatarURL, FallbackAvatarURL } from '../utils/avatar';
+import { stringify, parse } from './replaceRevive';
 import type { Action, GlobalState } from '../types';
 import config from '../config';
 import { REHYDRATE } from '../actionConstants';
@@ -327,58 +326,6 @@ provideLoggingContext(() => ({
   serverVersion: tryGetActiveAccount(store.getState())?.zulipVersion ?? null,
 }));
 
-/**
- * A special identifier used by `remotedev-serialize`.
- *
- * Use this in the custom replacer and reviver, below, to make it
- * easier to be consistent between them and avoid costly typos.
- */
-const SERIALIZED_TYPE_FIELD_NAME: '__serializedType__' = '__serializedType__';
-
-const customReplacer = (key, value, defaultReplacer) => {
-  if (value instanceof ZulipVersion) {
-    return { data: value.raw(), [SERIALIZED_TYPE_FIELD_NAME]: 'ZulipVersion' };
-  } else if (value instanceof URL) {
-    return { data: value.toString(), [SERIALIZED_TYPE_FIELD_NAME]: 'URL' };
-  } else if (value instanceof GravatarURL) {
-    return { data: GravatarURL.serialize(value), [SERIALIZED_TYPE_FIELD_NAME]: 'GravatarURL' };
-  } else if (value instanceof UploadedAvatarURL) {
-    return {
-      data: UploadedAvatarURL.serialize(value),
-      [SERIALIZED_TYPE_FIELD_NAME]: 'UploadedAvatarURL',
-    };
-  } else if (value instanceof FallbackAvatarURL) {
-    return {
-      data: FallbackAvatarURL.serialize(value),
-      [SERIALIZED_TYPE_FIELD_NAME]: 'FallbackAvatarURL',
-    };
-  }
-  return defaultReplacer(key, value);
-};
-
-const customReviver = (key, value, defaultReviver) => {
-  if (value !== null && typeof value === 'object' && SERIALIZED_TYPE_FIELD_NAME in value) {
-    const data = value.data;
-    switch (value[SERIALIZED_TYPE_FIELD_NAME]) {
-      case 'ZulipVersion':
-        return new ZulipVersion(data);
-      case 'URL':
-        return new URL(data);
-      case 'GravatarURL':
-        return GravatarURL.deserialize(data);
-      case 'UploadedAvatarURL':
-        return UploadedAvatarURL.deserialize(data);
-      case 'FallbackAvatarURL':
-        return FallbackAvatarURL.deserialize(data);
-      default:
-      // Fall back to defaultReviver, below
-    }
-  }
-  return defaultReviver(key, value);
-};
-
-const { stringify, parse } = Serialize.immutable(Immutable, null, customReplacer, customReviver);
-
 /**
  * The config options to pass to redux-persist.
  *