serialization.js 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153
  1. /*
  2. MIT License http://www.opensource.org/licenses/mit-license.php
  3. */
  4. "use strict";
  5. const memoize = require("./memoize");
  6. /** @typedef {import("../serialization/BinaryMiddleware").MEASURE_END_OPERATION_TYPE} MEASURE_END_OPERATION */
  7. /** @typedef {import("../serialization/BinaryMiddleware").MEASURE_START_OPERATION_TYPE} MEASURE_START_OPERATION */
  8. /** @typedef {import("../serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
  9. /** @typedef {import("../serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
  10. /** @typedef {import("../serialization/Serializer")} Serializer */
  11. /** @typedef {typeof import("../util/Hash")} Hash */
  12. /** @typedef {import("../util/fs").IntermediateFileSystem} IntermediateFileSystem */
  13. const getBinaryMiddleware = memoize(() =>
  14. require("../serialization/BinaryMiddleware")
  15. );
  16. const getObjectMiddleware = memoize(() =>
  17. require("../serialization/ObjectMiddleware")
  18. );
  19. const getSingleItemMiddleware = memoize(() =>
  20. require("../serialization/SingleItemMiddleware")
  21. );
  22. const getSerializer = memoize(() => require("../serialization/Serializer"));
  23. const getSerializerMiddleware = memoize(() =>
  24. require("../serialization/SerializerMiddleware")
  25. );
  26. const getBinaryMiddlewareInstance = memoize(
  27. () => new (getBinaryMiddleware())()
  28. );
  29. const registerSerializers = memoize(() => {
  30. require("./registerExternalSerializer");
  31. // Load internal paths with a relative require
  32. // This allows bundling all internal serializers
  33. const internalSerializables = require("./internalSerializables");
  34. getObjectMiddleware().registerLoader(/^webpack\/lib\//, req => {
  35. const loader =
  36. internalSerializables[
  37. /** @type {keyof import("./internalSerializables")} */
  38. (req.slice("webpack/lib/".length))
  39. ];
  40. if (loader) {
  41. loader();
  42. } else {
  43. console.warn(`${req} not found in internalSerializables`);
  44. }
  45. return true;
  46. });
  47. });
  48. /** @type {Serializer} */
  49. let buffersSerializer;
  50. // Expose serialization API
  51. module.exports = {
  52. get register() {
  53. return getObjectMiddleware().register;
  54. },
  55. get registerLoader() {
  56. return getObjectMiddleware().registerLoader;
  57. },
  58. get registerNotSerializable() {
  59. return getObjectMiddleware().registerNotSerializable;
  60. },
  61. get NOT_SERIALIZABLE() {
  62. return getObjectMiddleware().NOT_SERIALIZABLE;
  63. },
  64. /** @type {MEASURE_START_OPERATION} */
  65. get MEASURE_START_OPERATION() {
  66. return getBinaryMiddleware().MEASURE_START_OPERATION;
  67. },
  68. /** @type {MEASURE_END_OPERATION} */
  69. get MEASURE_END_OPERATION() {
  70. return getBinaryMiddleware().MEASURE_END_OPERATION;
  71. },
  72. /**
  73. * @returns {Serializer} buffer serializer
  74. */
  75. get buffersSerializer() {
  76. if (buffersSerializer !== undefined) return buffersSerializer;
  77. registerSerializers();
  78. const Serializer = getSerializer();
  79. const binaryMiddleware = getBinaryMiddlewareInstance();
  80. const SerializerMiddleware = getSerializerMiddleware();
  81. const SingleItemMiddleware = getSingleItemMiddleware();
  82. return (buffersSerializer = new Serializer([
  83. new SingleItemMiddleware(),
  84. new (getObjectMiddleware())(context => {
  85. if (context.write) {
  86. /**
  87. * @param {any} value value
  88. */
  89. context.writeLazy = value => {
  90. context.write(
  91. SerializerMiddleware.createLazy(value, binaryMiddleware)
  92. );
  93. };
  94. }
  95. }, "md4"),
  96. binaryMiddleware
  97. ]));
  98. },
  99. /**
  100. * @param {IntermediateFileSystem} fs filesystem
  101. * @param {string | Hash} hashFunction hash function to use
  102. * @returns {Serializer} file serializer
  103. */
  104. createFileSerializer: (fs, hashFunction) => {
  105. registerSerializers();
  106. const Serializer = getSerializer();
  107. const FileMiddleware = require("../serialization/FileMiddleware");
  108. const fileMiddleware = new FileMiddleware(fs, hashFunction);
  109. const binaryMiddleware = getBinaryMiddlewareInstance();
  110. const SerializerMiddleware = getSerializerMiddleware();
  111. const SingleItemMiddleware = getSingleItemMiddleware();
  112. return new Serializer([
  113. new SingleItemMiddleware(),
  114. new (getObjectMiddleware())(context => {
  115. if (context.write) {
  116. /**
  117. * @param {any} value value
  118. */
  119. context.writeLazy = value => {
  120. context.write(
  121. SerializerMiddleware.createLazy(value, binaryMiddleware)
  122. );
  123. };
  124. /**
  125. * @param {any} value value
  126. * @param {object=} options lazy options
  127. * @returns {function(): Promise<any> | any} lazy function
  128. */
  129. context.writeSeparate = (value, options) => {
  130. const lazy = SerializerMiddleware.createLazy(
  131. value,
  132. fileMiddleware,
  133. options
  134. );
  135. context.write(lazy);
  136. return lazy;
  137. };
  138. }
  139. }, hashFunction),
  140. binaryMiddleware,
  141. fileMiddleware
  142. ]);
  143. }
  144. };