relay-compiler 9.0.0 → 10.1.0

package/core/GraphQLCompilerProfiler.js.flow

@@ -0,0 +1,341 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ * @format
+ */
+
+// flowlint ambiguous-object-type:error
+
+'use strict';
+
+const invariant = require('invariant');
+
+/**
+ * The compiler profiler builds a "call graph" of high level operations as a
+ * means of tracking time spent over the course of running the compiler.
+ */
+
+type Trace =
+  | MetadataTrace
+  | BeginDurationTrace
+  | EndDurationTrace
+  | EventTrace
+  | BeginAsyncTrace
+  | EndAsyncTrace;
+
+type MetadataTrace = {|
+  ph: 'M',
+  pid: number, // Process ID
+  tid: number, // Thread ID
+  name: 'process_name' | 'thread_name',
+  args: {|name: string|},
+|};
+
+type BeginDurationTrace = {|
+  ph: 'B',
+  name: string, // Event name
+  pid: number, // Process ID
+  tid: number, // Thread ID
+  ts: number, // Relative timestamp integer microseconds
+|};
+
+type EndDurationTrace = {|
+  ph: 'E',
+  name: string, // Event name
+  pid: number, // Process ID
+  tid: number, // Thread ID
+  ts: number, // Relative timestamp integer microseconds
+|};
+
+type EventTrace = {|
+  ph: 'X',
+  name: string, // Event name
+  pid: number, // Process ID
+  tid: number, // Thread ID
+  ts: number, // Relative timestamp integer in microseconds
+  dur: number, // Duration timestamp integer in microseconds
+|};
+
+type BeginAsyncTrace = {|
+  ph: 'b',
+  name: string, // Async event name
+  cat: string, // Async category
+  id: number, // Async tree ID
+  pid: number, // Process ID
+  tid: number, // Thread ID
+  ts: number, // Relative timestamp integer microseconds
+|};
+
+type EndAsyncTrace = {|
+  ph: 'e',
+  name: string, // Async event name
+  cat: string, // Async category
+  id: number, // Async tree ID
+  pid: number, // Process ID
+  tid: number, // Thread ID
+  ts: number, // Relative timestamp integer microseconds
+|};
+
+let enabled = false;
+const traces: Array<Trace> = [
+  {
+    ph: 'M',
+    pid: 0,
+    tid: 0,
+    name: 'process_name',
+    args: {name: 'relay-compiler'},
+  },
+  {
+    ph: 'M',
+    pid: 0,
+    tid: 0,
+    name: 'thread_name',
+    args: {name: 'relay-compiler'},
+  },
+];
+const stack: Array<BeginDurationTrace> = [];
+
+function enable(): void {
+  enabled = true;
+}
+
+function getTraces(): Array<Trace> {
+  return traces;
+}
+
+/**
+ * Run the provided function as part of a stack profile.
+ */
+function run<T>(name: string, fn: () => T): T {
+  return instrument(fn, name)();
+}
+
+/**
+ * Run the provided async function as part context in a stack profile.
+ * See instrumentAsyncContext() for limitations and usage notes.
+ */
+function asyncContext<T: Promise<$FlowFixMe>>(name: string, fn: () => T): T {
+  return instrumentAsyncContext(fn, name)();
+}
+
+/**
+ * Wait for the provided async operation as an async profile.
+ */
+function waitFor<T: Promise<$FlowFixMe>>(name: string, fn: () => T): T {
+  return instrumentWait(fn, name)();
+}
+
+/**
+ * Return a new instrumented sync function to be part of a stack profile.
+ *
+ * This instruments synchronous functions to be displayed in a stack
+ * visualization. To instrument async functions, see instrumentAsyncContext()
+ * and instrumentWait().
+ */
+function instrument<F: (...$FlowFixMe) => mixed>(fn: F, name?: string): F {
+  if (!enabled) {
+    return fn;
+  }
+  const profileName =
+    name ??
+    // $FlowFixMe[prop-missing] - Flow no longer considers statics of functions as any
+    fn.displayName ??
+    fn.name;
+  const instrumented = function() {
+    const traceId = start(profileName);
+    try {
+      return fn.apply(this, arguments);
+    } finally {
+      end(traceId);
+    }
+  };
+  instrumented.displayName = profileName;
+  return (instrumented: $FlowFixMe);
+}
+
+/**
+ * Return a new instrumented async function which provides context for a stack.
+ *
+ * Because the resulting profiling information will be incorporated into a
+ * stack visualization, the instrumented function must represent a distinct
+ * region of time which does not overlap with any other async context.
+ *
+ * In other words, functions instrumented with instrumentAsyncContext must not
+ * run in parallel via Promise.all().
+ *
+ * To instrument functions which will run in parallel, use instrumentWait().
+ */
+function instrumentAsyncContext<F: (...$FlowFixMe) => Promise<$FlowFixMe>>(
+  fn: F,
+  name?: string,
+): F {
+  if (!enabled) {
+    return fn;
+  }
+
+  const profileName: string =
+    name ??
+    // $FlowFixMe[prop-missing] - Flow no longer considers statics of functions as any
+    fn.displayName ??
+    fn.name;
+  const instrumented = async function() {
+    const traceId = start(profileName);
+    try {
+      return await fn.apply(this, arguments);
+    } finally {
+      end(traceId);
+    }
+  };
+  instrumented.displayName = profileName;
+  return (instrumented: $FlowFixMe);
+}
+
+/**
+ * Return a new instrumented function which performs an awaited async operation.
+ *
+ * The instrumented function is not included in the overall run time of the
+ * compiler, instead it captures the time waiting on some asynchronous external
+ * resource such as network or filesystem which are often run in parallel.
+ */
+function instrumentWait<F: (...$FlowFixMe) => Promise<$FlowFixMe>>(
+  fn: F,
+  name?: string,
+): F {
+  if (!enabled) {
+    return fn;
+  }
+  const profileName: string =
+    name ??
+    // $FlowFixMe[prop-missing] - Flow no longer considers statics of functions as any
+    fn.displayName ??
+    fn.name;
+  const instrumented = async function() {
+    const traceId = startWait(profileName);
+    try {
+      return await fn.apply(this, arguments);
+    } finally {
+      end(traceId);
+    }
+  };
+  instrumented.displayName = profileName;
+  return (instrumented: $FlowFixMe);
+}
+
+const T_ZERO = process.hrtime();
+
+// Return a Uint32 of microtime duration since program start.
+function microtime(): number {
+  const hrtime = process.hrtime(T_ZERO);
+  // eslint-disable-next-line no-bitwise
+  return 0 | (hrtime[0] * 1e6 + Math.round(hrtime[1] / 1e3));
+}
+
+/**
+ * Start a stack profile with a particular name, returns an ID to pass to end().
+ *
+ * Other profiles may start before this one ends, which will be represented as
+ * nested operations, however all nested operations must end before this ends.
+ *
+ * In particular, be careful to end after errors.
+ */
+function start(name: string): number {
+  const beginTrace = {
+    ph: 'B',
+    name,
+    pid: 0,
+    tid: 0,
+    ts: microtime(),
+  };
+  traces.push(beginTrace);
+  stack.push(beginTrace);
+  return traces.length - 1;
+}
+
+let asyncID = 0;
+
+/**
+ * Start an async wait profile with a particular name, returns an ID to pass
+ * to end().
+ *
+ * Other profiles may start before this one ends, which will be represented as
+ * nested operations, however all nested operations must end before this ends.
+ *
+ * In particular, be careful to end after errors.
+ */
+function startWait(name: string): number {
+  traces.push({
+    ph: 'b',
+    name,
+    cat: 'wait',
+    id: asyncID++,
+    pid: 0,
+    tid: 0,
+    ts: microtime(),
+  });
+  return traces.length - 1;
+}
+
+function end(traceIdx: number): void {
+  const trace = traces[traceIdx];
+
+  if (trace.ph === 'b') {
+    traces.push({
+      ph: 'e',
+      cat: trace.cat,
+      name: trace.name,
+      id: trace.id,
+      pid: trace.pid,
+      tid: trace.tid,
+      ts: microtime(),
+    });
+    return;
+  }
+
+  invariant(trace.ph === 'B', 'Begin trace phase');
+  invariant(
+    stack.pop() === trace,
+    'GraphQLCompilerProfiler: The profile trace %s ended before nested traces. ' +
+      'If it is async, try using Profile.waitFor or Profile.profileWait.',
+    trace.name,
+  );
+
+  const prevTrace = traces[traces.length - 1];
+
+  if (trace === prevTrace) {
+    traces[traceIdx] = {
+      ph: 'X',
+      name: trace.name,
+      pid: trace.pid,
+      tid: trace.tid,
+      ts: trace.ts,
+      dur: microtime() - trace.ts,
+    };
+    return;
+  }
+
+  traces.push({
+    ph: 'E',
+    name: trace.name,
+    pid: trace.pid,
+    tid: trace.tid,
+    ts: microtime(),
+  });
+}
+
+module.exports = {
+  enable,
+  getTraces,
+  run,
+  asyncContext,
+  waitFor,
+  instrument,
+  instrumentAsyncContext,
+  instrumentWait,
+  start,
+  startWait,
+  end,
+};

package/core/GraphQLDerivedFromMetadata.js.flow

@@ -0,0 +1,36 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict-local
+ * @format
+ */
+
+// flowlint ambiguous-object-type:error
+
+'use strict';
+
+import type {GeneratedNode} from 'relay-runtime';
+
+/**
+ * Helpers to retieve the name of the document from which the input derives:
+ * this is either the name of the input itself (if it is not a derived node)
+ * or the metadata.derivedFrom property for derived nodes.
+ */
+
+// Version for generated nodes
+function getReaderSourceDefinitionName(node: GeneratedNode): string {
+  const [name, derivedFrom] =
+    node.kind === 'Request'
+      ? [node.params.name, node.params.metadata?.derivedFrom]
+      : node.kind === 'SplitOperation'
+      ? [node.name, node.metadata?.derivedFrom]
+      : [node.name, null];
+  return typeof derivedFrom === 'string' ? derivedFrom : name;
+}
+
+module.exports = {
+  getReaderSourceDefinitionName,
+};

package/core/GraphQLWatchmanClient.js.flow

@@ -0,0 +1,111 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow
+ * @format
+ * @emails oncall+relay
+ */
+
+// flowlint ambiguous-object-type:error
+
+'use strict';
+
+const childProcess = require('child_process');
+const watchman = require('fb-watchman');
+
+const MAX_ATTEMPT_LIMIT = 5;
+
+function delay(delayMs: number): Promise<void> {
+  return new Promise(resolve => setTimeout(resolve, delayMs));
+}
+
+class GraphQLWatchmanClient {
+  _client: any;
+  _attemptLimit: number;
+
+  static isAvailable(): Promise<boolean> {
+    return new Promise(resolve => {
+      // This command not only will verify that watchman CLI is available
+      // More than that `watchman version` is a command that runs on the server.
+      // And it can tell us that watchman is up and running
+      // Also `watchman version` check ``relative_root`` capability
+      // under the covers
+      const proc = childProcess.spawn('watchman', ['version']);
+      proc.on('error', () => {
+        resolve(false);
+      });
+      proc.on('close', code => {
+        resolve(code === 0);
+      });
+    });
+  }
+
+  constructor(attemptLimit: number = 0) {
+    this._client = new watchman.Client();
+    this._attemptLimit = Math.max(Math.min(MAX_ATTEMPT_LIMIT, attemptLimit), 0);
+  }
+
+  _command(...args: Array<mixed>): Promise<any> {
+    return new Promise((resolve, reject) => {
+      this._client.command(args, (error, response) => {
+        if (error) {
+          reject(error);
+        } else {
+          resolve(response);
+        }
+      });
+    });
+  }
+
+  async command(...args: Array<mixed>): Promise<any> {
+    let attempt = 0;
+    while (true) {
+      try {
+        attempt++;
+        return await this._command(...args);
+      } catch (error) {
+        if (attempt > this._attemptLimit) {
+          throw error;
+        }
+        await delay(Math.pow(2, attempt) * 500);
+        this._client.end();
+        this._client = new watchman.Client();
+      }
+    }
+  }
+
+  async hasCapability(capability: string): Promise<boolean> {
+    const resp = await this.command('list-capabilities');
+    return resp.capabilities.includes(capability);
+  }
+
+  async watchProject(
+    baseDir: string,
+  ): Promise<{
+    root: string,
+    relativePath: string,
+    ...
+  }> {
+    const resp = await this.command('watch-project', baseDir);
+    if ('warning' in resp) {
+      console.error('Warning:', resp.warning);
+    }
+    return {
+      root: resp.watch,
+      relativePath: resp.relative_path,
+    };
+  }
+
+  on(event: string, callback: Function): void {
+    this._client.on(event, callback);
+  }
+
+  end(): void {
+    this._client.end();
+  }
+}
+
+module.exports = GraphQLWatchmanClient;