serialization.js 4.3 KB

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